mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-04 23:39:57 +00:00
Code Issues Releases Wiki Activity

docs - move exclude parameter into Parameters section

Browse Source
This commit is contained in:
pmario 2024-02-06 18:51:36 +01:00
parent 5510e226bb
commit 7771383fca
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid
View File

@ -1,5 +1,5 @@
created: 20140919155729620 created: 20140919155729620
modified: 20240202110108027 modified: 20240206175037389
tags: Macros [[Core Macros]] tags: Macros [[Core Macros]]
title: Table-of-Contents Macros title: Table-of-Contents Macros
type: text/vnd.tiddlywiki 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 ; toc-tabbed-external-nav
: The target tiddler appears in the normal way in the story river, which depends on the user's configured storyview : The target tiddler appears in the normal way in the story river, which depends on the user's configured storyview
!! Parameters !! Parameters
; tag ; tag
@ -40,9 +41,13 @@ The difference between the last two has to do with what happens when the user cl
; sort ; sort
: An optional extra [[filter step|Filter Step]], e.g. `sort[title]` : 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<tag>!has[draft.of]$(sort)$] -[<tag>] -[subfilter<exclude>]`>``
; 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.<br>''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<tag>!has[draft.of]$(sort)$] -[<tag>] -[subfilter<exclude>]`>``
!! Additional Tabbed TOC Parameters !! Additional Tabbed TOC Parameters
@ -60,9 +65,6 @@ The sort parameter substituted into a single [[filter expression|Filter Expressi
; template ; template
: Optionally, the title of a tiddler to use as a [[template|TemplateTiddlers]] for transcluding the selected tiddler into the right-hand panel : 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.<br>''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 !! 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. 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.