TiddlyWiki5/editions/tw5.com/tiddlers/macros/TableOfContentsMacro.tid

title: TableOfContentsMacro
tags: macros
modified: 20140818180307785

The table of contents macro produces a hierarchical tree of tiddlers based on their tags.

The top level entries of the table of contents are defined by a root tag. The subentries under each of those entries are tagged with the title of the entry. Entries can be ordered using the `list` field as described in TiddlerTags.

There are several variants of the macro:

* `<<toc>>` produces a simple hierarchical tree of links
* `<<toc-expandable>>` produces an expandable tree of links
* `<<toc-selective-expandable>>` produces an expandable tree of links where the expand/contract buttons are only shown for entries that possess child nodes

! Parameters

|!Position |!Name |!Description |!Default |
|1st |tag |The root tag that identifies the top level of the hierarchy | |

! Examples

<<tabs "[tag[table-of-contents-example]]" "TableOfContentsMacro Simple Example">>
First pass at table of contents macros Introduce macros for automatically generating table of contents 2014-08-18 19:52:36 +00:00			`title: TableOfContentsMacro`
			`tags: macros`
			`modified: 20140818180307785`

			`The table of contents macro produces a hierarchical tree of tiddlers based on their tags.`

More table of content macro docs 2014-08-18 20:44:31 +00:00			The top level entries of the table of contents are defined by a root tag. The subentries under each of those entries are tagged with the title of the entry. Entries can be ordered using the `list` field as described in TiddlerTags.

First pass at table of contents macros Introduce macros for automatically generating table of contents 2014-08-18 19:52:36 +00:00			`There are several variants of the macro:`

			* `<<toc>>` produces a simple hierarchical tree of links
			* `<<toc-expandable>>` produces an expandable tree of links
Add selective expandable table of contents macro And improve the layout of the examples 2014-08-19 11:30:22 +00:00			* `<<toc-selective-expandable>>` produces an expandable tree of links where the expand/contract buttons are only shown for entries that possess child nodes
First pass at table of contents macros Introduce macros for automatically generating table of contents 2014-08-18 19:52:36 +00:00
			`! Parameters`

			`\|!Position \|!Name \|!Description \|!Default \|`
More table of content macro docs 2014-08-18 20:44:31 +00:00			`\|1st \|tag \|The root tag that identifies the top level of the hierarchy \| \|`
First pass at table of contents macros Introduce macros for automatically generating table of contents 2014-08-18 19:52:36 +00:00
			`! Examples`

Add selective expandable table of contents macro And improve the layout of the examples 2014-08-19 11:30:22 +00:00			`<<tabs "[tag[table-of-contents-example]]" "TableOfContentsMacro Simple Example">>`