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

Improve Filters doc and add "Learn more about how to use Filters" link to every operator reference tiddler #6533

Merged

Conversation

pmario
Copy link
Contributor

@pmario pmario commented Mar 16, 2022

This PR adds a link [[Learn more about how to use Filters|Filters]] to every operator reference tiddler. Some users think, filter expressions can be used similar to links.

In reality they would need Filtered Transclusions, which is now linked in the Filters tiddler under "Find out more".

The Filters tiddler also contains a "copy to clipboard" element with the <<list-links "[tag[Filters]]">> example, that reveals additional info about Filters.

So in sum, the whole thing is better "interconnected" and should provide more relevant info.

https://talk.tiddlywiki.org/t/getting-tiddler-field-isnt-working/2746 triggered this PR.

The AdvancedSearch link now opens the AdvancedSearch tiddler, selects the "Filter" tab and adds the right text to the search field.

The "tagged" link opens the "tag Operator" tiddler. ..

@pmario
Copy link
Contributor Author

pmario commented Mar 16, 2022

Filters -- now looks like that:

grafik

@pmario
Copy link
Contributor Author

pmario commented Mar 16, 2022

Operator references have a link to Filters tiddler now

grafik

@Jermolene
Copy link
Owner

Thanks @pmario

@Jermolene Jermolene merged commit 22fd1ca into Jermolene:tiddlywiki-com Mar 16, 2022
@pmario pmario deleted the improve-filters-doc--1647432800 branch March 16, 2022 12:40
@twMat
Copy link
Contributor

twMat commented Mar 16, 2022

Good idea @pmario and well written. Just one thing:

I would like for the text to give a sense of where filters are used by including a quick overview of this and where your list-links example serves as an illustration of this. Something like this following the second paragraph:

Filters are typically used as //arguments// in the following contexts:

* [[widgets|Widgets in WikiText]] that have a `filter` attribute
* [[filtered transclusions|Transclusion in WikiText]] -- which always, and only, take a filter as argument
* macros -- depending on implementation

For example, the following passes a filter [....etc with Marios text...]

Thoughts?

@pmario
Copy link
Contributor Author

pmario commented Mar 16, 2022

Sorry Mat ... I'm not really sure, where you want to have your text.
You did mention For example, the following passes a filter [....etc with Marios text...] ... It contains an "etc"... How should I know, what you exactly you want to tell me. ...

@twMat ... You already have a GitHub account and you did sign the CLA in 2017

It's not possible to break anything. I did create some videos, that describe every step https://www.youtube.com/playlist?list=PLuiC_HFhI4Owy3oY_dZpYe7MGlW5JRGIY

@twMat
Copy link
Contributor

twMat commented Mar 16, 2022

@pmario

Sorry Mat ... I'm not really sure, where you want to have your text.

Well, I did say: "Something like this following the second paragraph" - so there. And the initial words in your third paragraph would be somewhat modified per my proposal.

Anyway, I believe I jumped through all needed hoops but end up with this:

image
[snip]
image


Also, in your bullet list in the post here above, your first bullet instructs:

-- but why? I don't see any link or button there to the form so it is good you provided the last bullet in your list with the link so I could access the actual PR form. (And what do you mean with the second last bullet about making backups. How? Save the whole wiki?)

By the way, it would be desirable that the PR form could somehow show the tiddler text that I want to modify.

@saqimtiaz
Copy link
Contributor

This PR adds a link [[Learn more about how to use Filters|Filters]] to every operator reference tiddler. Some users think, filter expressions can be used similar to links.

Hi @pmario, can you please have a look to see if we have had a regression in how this is displayed? On tiddlywiki.com and the pre-release, the link is appearing on the same line as "New in 5.2.0" message, which is quite confusing.

See https://tiddlywiki5-4omqgzl9p-jermolene.vercel.app/#deserialize%20Operator

Screenshot:
image

@pmario
Copy link
Contributor Author

pmario commented Jun 2, 2023

@saqimtiaz ... I think it has always been like this. The PR adds a link, which in turn creates an inline HTML A element. The <<.from-version macro also creates an inline element.

It's an oversight. I'll create a new PR, which will cover the template link into a block-element.

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

4 participants