Table Of Contents

Also available in Deutsch, Español, Française, Русский, 简体中文

With this action one provides a table of contents (arrangement) to the respective side. This table of contents is provided automatically on basis of the headings existing in the text (===, see text formatting). This table of contents refers by anchors (<h[2-6] id="..."> and <a href="#...">) to the respective place in the text.


The greatest possible heading (<h1>, and/or == in the Wiki syntax) is not included into the table of content, the Primary Heading is intended for the lemma (comparable with the title of a book) and not for individual chapters. The page title usually represents the Primary Heading by default.


1. Syntax


{{toc page="pagename" title="titelname" numerate=1 from="h2" to="h6" nomark=1}}


Parameter:

page The parameter page contains the Wikiname of the page, for which the table of contents is provided. If page is empty or is not at all indicated, the listing for the current side is provided.
legend The heading for the table of contents gives on (default value: Contents)
numerate The chapters are numerated automatically, even if in the text no numbering were indicated.
start Sets a specific start denominator for Chapters numbering.
from to Indicates, which headings in the table of contents are to be indicated.

Note:

All parameters are optional, i.e. it is possible to only use {{toc}}.
If you want to change depth use parameters from and to.


{{toc from="h2" to="h4"}} are default parameters


anything with a headline value will be listed with anchors to specific parts of your page.


If you are using this with the 'include' action, but don't want the headers from the included page to be listed in the generated table of contents, use the notoc option like:


{{include page="/Formatting/Headlines" notoc=1}}

2. Examples


a) Table of contents for this Page:


Invoke: {{toc}}



b) For another page:


Invoke: {{toc page="/Doc/English/Formatting"}}



c) like b), however with title and autonumbering:


Invoke: {{toc page="/Doc/English/Formatting" legend="Formatting with title and auto numbering" numerate=1}}



d) like c), however with title and the defined level (here "h2" to "h3"):


Invoke: {{toc page="/Doc/English/Actions" title="Actions" numerate=0 from="h2" to="h3"}}