From 7771383fcab878db7645278ba4d098c4265367d2 Mon Sep 17 00:00:00 2001 From: pmario Date: Tue, 6 Feb 2024 18:51:36 +0100 Subject: [PATCH] docs - move exclude parameter into Parameters section --- .../tiddlers/macros/TableOfContentsMacro.tid | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid b/editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid index 0bec78269..675a469be 100644 --- a/editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid +++ b/editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid @@ -1,5 +1,5 @@ created: 20140919155729620 -modified: 20240202110108027 +modified: 20240206175037389 tags: Macros [[Core Macros]] title: Table-of-Contents Macros type: text/vnd.tiddlywiki @@ -32,6 +32,7 @@ The difference between the last two has to do with what happens when the user cl ; toc-tabbed-external-nav : The target tiddler appears in the normal way in the story river, which depends on the user's configured storyview + !! Parameters ; tag @@ -40,9 +41,13 @@ The difference between the last two has to do with what happens when the user cl ; sort : An optional extra [[filter step|Filter Step]], e.g. `sort[title]` -The sort parameter substituted into a single [[filter expression|Filter Expression]] like this. For backwards compatibility it is done as follows: +:The sort parameter substituted into a single [[filter expression|Filter Expression]] like this. For backwards compatibility it is done as follows: + +:> ``<$list filter=`[all[shadows+tiddlers]tag!has[draft.of]$(sort)$] -[] -[subfilter]`>`` + +; exclude <<.from-version "5.3.0">> +: This optional parameter can be used to exclude tiddlers from the TOC list. It allows a [[Title List]] or a <<.olink subfilter>>. Eg: `exclude:"HelloThere [[Title with spaces]]"` or `exclude:"[has[excludeTOC]]"`. Where the former will exclude two tiddlers and the later would exclude every tiddler that has a field <<.field excludeTOC>> independent of its value.
''Be aware'' that eg: `[prefix[H]]` is a shortcut for `[all[tiddlers]prefix[H]]`, which can have a performance impact, if used carelessly. So use $:/AdvancedSearch -> ''Filters'' tab to test the <<.param exclude>> parameter -> ``<$list filter=`[all[shadows+tiddlers]tag!has[draft.of]$(sort)$] -[] -[subfilter]`>`` !! Additional Tabbed TOC Parameters @@ -60,9 +65,6 @@ The sort parameter substituted into a single [[filter expression|Filter Expressi ; template : Optionally, the title of a tiddler to use as a [[template|TemplateTiddlers]] for transcluding the selected tiddler into the right-hand panel -; exclude <<.from-version "5.3.0">> -: This optional parameter can be used to exclude tiddlers from the TOC list. It allows a [[Title List]] or a <<.olink subfilter>>. Eg: `exclude:"HelloThere [[Title with spaces]]"` or `exclude:"[has[excludeTOC]]"`. Where the former will exclude two tiddlers and the later would exclude every tiddler that has a field <<.field excludeTOC>> independent of its value.
''Be aware'' that eg: `[prefix[H]]` is a shortcut for `[all[tiddlers]prefix[H]]`, which can have a performance impact, if used carelessly. So use $:/AdvancedSearch -> ''Filters'' tab to test the <<.param exclude>> parameter - !! Structure The top level of the tree consists of the tiddlers that carry a particular tag, known as the <<.def "root tag">>. Tiddlers tagged with any of those make up the next level down, and so on.