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

[DOCS] Make it more obvious that $:/DefaultTiddlers setting can handle filter-expressions #8729

Open
wants to merge 2 commits into
base: tiddlywiki-com
Choose a base branch
from

Conversation

pmario
Copy link
Member

@pmario pmario commented Nov 4, 2024

Make it more obvious that $:/DefaultTiddlers setting can handle filter-expressions

Edit: Fixing some typos

Copy link

github-actions bot commented Nov 4, 2024

Confirmed: pmario has already signed the Contributor License Agreement (see contributing.md)

Copy link
Member

@Jermolene Jermolene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @pmario sorry for so many comments on a small PR but it touches on some tricky issues about how we teach the fundamentals of TW.

There are two ways default tiddlers can be defined:

* A [[title-list|Title List]] eg: `TiddlerTitles` and `[[Titles with spaces]]`
* Filter expressions, using [[filter operators|Filter Operators]] eg: `[tag[HelloThere]]`

At startup, the text of the system tiddler [[$:/DefaultTiddlers]] is retrieved and evaluated as a [[filter expression|Filter Expression]]. The resulting list of titles is then inserted into the [[story river|Story River]].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel that we already explain here that a filter expression can be used to specify the default tiddlers. Perhaps we should consider rewriting this paragraph to further emphasize that, rather than add the paragraph above?

Copy link
Member Author

@pmario pmario Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should consider rewriting this paragraph to further emphasize that, rather than add the paragraph above?

The paragraph has been there for years and extracting the information that DefaultTiddlers can handle filter expressions is not obvious and hard to find, as can be seen at the discussion at Talk

A bullet-list attracts attention to the points that are important. I did not want to remove the paragraph, because I think its OK to explain functions in different ways for different users.

But English is not my main language. So I would be happy for an example.

@pmario pmario force-pushed the docs-make-it-more-obvious-that-defaulttiddlers-setting-can-handle-filter-expressions-20241104160223730 branch from 0466011 to 7aacf9b Compare November 4, 2024 20:49
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.

3 participants