This page is part of a static HTML representation of the TiddlyWiki at http://tiddlywiki.com/

Table-of-Contents Macros

21st February 2015 at 10:40pm
Core Macros Macros

TiddlyWiki provides several macros for generating a tree of tiddler links by analysing tags:

toc
A simple tree
toc-expandable
A tree in which all the branches can be expanded and collapsed
toc-selective-expandable
A tree in which the non-empty branches can be expanded and collapsed
toc-tabbed-internal-nav and toc-tabbed-external-nav
A two-panel browser:
  • on the left, a selectively expandable tree that behaves like a set of vertical tabs
  • on the right, the content of whichever tiddler the user selects in the tree

The difference between the last two has to do with what happens when the user clicks a link in the right-hand panel:

toc-tabbed-internal-nav
The target tiddler appears in the right-hand panel, replacing the tiddler that contained the link
toc-tabbed-external-nav
The target tiddler appears in the normal way (which depends on the user's configured storyview)

Structure

The top level of the tree consists of the tiddlers that carry a particular tag, known as the root tag. Tiddlers tagged with any of those make up the next level down, and so on.

At each level, the tiddlers can be ordered by means of the list field of the parent tag tiddler. They can also be ordered by the macro's sort parameter.

The tree displays the caption field of a tiddler if it has one, or the tiddler's title otherwise.

Each tiddler in the tree is normally displayed as a link. To suppress this, give the tiddler a toc-link field with the the value no. In the examples, the SecondThree tiddler is set up like this. Clicking such a tiddler in the tree causes its branch to expand or collapse.

The table of contents is generated as an HTML ordered list. The <ol> elements always have the class tc-toc. Expandable trees have the additional class tc-toc-expandable. Selectively expandable trees (including those in the two-panel browser) have tc-toc-selective-expandable.

To make a table of contents appear in the sidebar, see How to add a new tab to the sidebar.

Parameters

tag
The root tag that identifies the top level of the tree
sort
An optional extra filter step, e.g. sort[title]

These two parameters are combined into a single filter expression like this:

[tag[$tag$]$sort$]

toc-tabbed-internal-nav and toc-tabbed-external-nav take additional parameters:

selectedTiddler
The title of the state tiddler for noting the currently selected tiddler, defaulting to $:/temp/toc/selectedTiddler. It is recommended that this be a system tiddler
unselectedText
The text to display when no tiddler is selected in the tree
missingText
The text to display if the selected tiddler doesn't exist
template
Optionally, the title of a tiddler to use as a template for transcluding the selected tiddler into the right-hand panel

Examples