Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify handling of title lists in ActionListopsWidget documentation #8184

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

yaisog
Copy link
Contributor

@yaisog yaisog commented May 9, 2024

Based on this discussion on Talk TW
https://talk.tiddlywiki.org/t/possible-error-in-action-listops-widget-documentation/9762
the Note on subfilter expressions has been corrected so that the given example works as intended.
Also, an info box was added describing how titles with spaces or multiple titles can be handled, with references for further reading.

Copy link

vercel bot commented May 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
tiddlywiki5 ✅ Ready (Inspect) Visit Preview May 9, 2024 1:56pm

@bluepenguindeveloper
Copy link

"To remove titles containing spaces, or to remove multiple titles, the individual titles must be wrapped in double square brackets, usually via a variable assignment."

The "or to remove multiple titles" part isn't correct; if none of the titles in the list contain spaces, then +[remove[Item1 Item2]] works because that's a valid title list containing "Item1" and "Item2".

Additionally, elsewhere in the documentation, the term "soft parameter" is used to denote variable or transcluded filter parameters, usually linking here: https://tiddlywiki.com/#Filter%20Parameter. So perhaps the above portion could be restated as:

"To remove titles containing spaces, a soft parameter must be used to enable the individual titles to be wrapped in double square brackets as required by the title list format."

And the extended listops operators page seems like another good place to link to for more details. It says: "These filters are best used with a reference to an array, stored in a field or data index elsewhere in the wiki (they may be used with a simple list of items, provided the items do not include white space.)"

@yaisog
Copy link
Contributor Author

yaisog commented May 9, 2024

@bluepenguindeveloper Thanks for your input. I have rephrased the part about multiple titles to explicitly mention that it applies to titles with spaces. If one wanted to be pedantic, this would mention that only one of multiple titles needed to contain a space to make a soft parameter necessary.
I also added a link to the Filter Parameters tiddler for the explanation of soft parameters.
I did not add the link to the extended listops operators, because this tiddler refers to a parameter "array", which might be confusing in this situation. Since I don't want to update all the listops pages in the context of this PR, I would defer mentioning that tiddler for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants