Introduce new subfilter operator

[Jermolene]

Fixes #3505

Needs better examples.

[Jermolene]

Hi @abesamma I've just triggered a build of this new branch that should fix your TOC problem in #3505. Could you kindly give it a try? (It'll take 10 minutes to appear -- you'll know it's the right one if you don't see the "single tiddler mode" demo material at the top of the page).

[pmario]

@kookma see: https://tiddlywiki.com/prerelease/

[kookma]

Thank you Jeremy! Thanks Mario
Here I made a try on https://tiddlywiki.com/prerelease/ for TW5.1.18

Example

Assume you have several macros tagged with myTag and you want to build a table of contents but you want to exclude few tiddlers e.g tid-a, tid-b, tid-c

<<toc-selective-expandable 
tag:"myTag" 
exclude:"[subfilter[tid-a tid-b tid-e]]">>

Another example

Assume you have several tiddlers tagged with tt and there are some of them ALSO have been tagged with tts, how to build a TOC excluding those tagged with tts"

<$set name="myFilter" value="[tag[tts]]">
  <<toc-selective-expandable 
    tag:"tt" 
    exclude:"[subfilter<myFilter>]">>
</$set>

References

The main discussion
https://groups.google.com/d/msg/tiddlywiki/8QxnwHzaRLg/UzO90F9TAgAJ

Further talk
https://groups.google.com/d/msg/tiddlywiki/x3HVIjJrbx8/iof9Ml7KAgAJ

A bad news

I tried some previous examples of toc macro included in TW 5.1.18pre, some of them broken! For example see: https://tiddlywiki.com/prerelease/#Example%20Table%20of%20Contents%3A%20Simple

It seems the toc macro has some issues. Using it raise the red local widow with this error:

Uncaught RangeError: Maximum call stack size exceeded

toc-selective-expandable

This macro is also returns the Javascript error you can check it on tiddlywiki.com/prerelease
see: https://tiddlywiki.com/prerelease/#Example%20Table%20of%20Contents%3A%20Expandable

[pmario]

@kookma ... be aware, that the exclude parameter is for internal use only!!!!! If you use it wrong it will blow up your TOC.

[pmario]

The exclude parameter MUST have -[[something]]. Where the "-" is important. If it is missing it won't work

[pmario]

@Jermolene ... I propose to rethink the TOC macros ... again. IMO it's starting to be a mess.

The exclude parameter was introduced 2 years ago with "Toc recursion protection #2650" .. Now everyone seems to use it completely wrong!! ... We need to fix this.

[kookma]

@kookma ... be aware, that the exclude parameter is for internal use only!!!!! If you use it wrong it will blow up your TOC.

Okay Mario! I will remain and will stop using it for now! In my case I want to use toc-selective-expandable to make table of contents of tiddlers tagged by say myTag but exclude those have also ignored as tag! That's all

Thank you

[Jermolene]

Thank you @pmario, I had forgotten that the exclude parameter was internal. Apologies @kookma!

I'll remove the modifications to the TOC macro from this PR but go ahead with the subfilter operator, it's something I've wanted to add for some time.

[kookma]

The exclude parameter MUST have -[[something]]. Where the "-" is important. If it is missing it won't work

@pmario But what is in the revised code does not requite - sign! Check it on prerelease!
By the way I remain for next revised code and I will give you my feedback!

[kookma]

ove the modifications to the TOC macro from this PR but go ahead with

@Jermolene
Do you mean a subfilter will be added to be able to exclude some tiddlers from TOC? This is really demanding! Suppose you wish to build a TOC from all tiddlers tagged with say 'myBookand there are some footnote tiddlers havemyBooktag but alsofootnotetag and you want to exclude those tiddler tagged withfootnote` from table of contents!

Thank you Jeremy!

[Jermolene]

Hi @kookma

The revised code didn't need a - sign because the alterations changed the way that the exclude parameter worked.

In terms of the subfilter operator, I meant that the new subfilter operator built for this fix will go ahead into 5.1.18. I've reverted the changes to the TOC macro.

[kookma]

@Jermolene

Thank you! I hope you could also update the documentation when it appeared in TW 5.1.18

[pmario]

@pmario But what is in the revised code does not requite - sign! Check it on prerelease!

@kookma ... Yea .. and that's the problem. It only looks like, as if there is no - but how the code works atm. There is one. Trust me ;)

The name: "exclude" indicates that if you specify [tag[test]] will exclude every tiddler tagged test ... But in reality the filter that needs to be programmatically calculated is -[tag[text]] ... Which is a new filter run.

One more problem is, that the existing logic can only exclude "tiddler titles" and no "tiddler sets" like [tag[xxx]]

As I wrote. The "exclude" parameter was not intended to be publicly visible. ... but the "usecase" to have one is valid.

[pmario]

IMO OT for the PR, but on topic for the discussion here. See: About existing TOC vs. prerelease TOC performance degrading #3517

[kookma]

@pmario Thanks for clarification. For me, I cloned the toc-selective-expandable from TW5.1.17 and changed its name and use it and wait for the final release of 5.1.18