TableOfContentsTag

Michalis Kamburelis edited this page Jan 8, 2017 · 6 revisions

Within introduction / conclusion files you can use tag @tableOfContents. This inserts table of contents at the given place. Table of contents is automatically constructed by pasdoc, based on the @sections you used.

As a parameter to @tableOfContents tag you can pass an integer value, this specifies the desired depth of table of contents. E.g. @tableOfContents(1) tells to show only sections with level 1 in the table of contents. If you will not give any parameter then the resulting table of contents will show all the sections that you created in your introduction or conclusion file.

Table of contents is inserted only in HtmlOutput. In LatexOutput @tableOfContents tag is simply ignored because LaTeX documents will always contain full table of contents anyway (generated by LaTeX tools).

Examples:

PasDoc, documentation generator for Pascal:
Features:
Supported Tags:
Command Line:
Development:
Developers pages:
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.