Page Types

Table of Contents

Previous | Top | Next

Table of Contents

The table of contents page is the entry point to your documentation. It can be detected using [IF PAGE IS TABLE_OF_CONTENTS].

 

You can use the built-in [TABLE_OF_CONTENTS] tag to output an automatically generated table of contents. The table of contents is limited to 5 levels of nesting. If you would like more control over the table of contents, you could generate it manually using the following markup as a starting point.

 

<a href="[TOP_LEVEL_ELEMENT.LINK]">[TOP_LEVEL_ELEMENT.NAME]</a>

[FOREACH ELEMENT IN TOP_LEVEL_ELEMENT]

 <ul>

         <li>

                 <a href="[ELEMENT.LINK]">[ELEMENT.NAME]</a>

                 [IF ELEMENT.ARE_CHILDREN_INCLUDED]

                         [REPEAT]

                 [/IF]

         </li>

 </ul>

[/FOREACH]

 

It may be desirable to link to the table of contents page from deeper levels in the documentation. This can be done using the [TABLE_OF_CONTENTS.LINK] placeholder.

 

Solution

Solution pages can be detected using [IF PAGE IS SOLUTION].

 

Project

Project pages can be detected using [IF PAGE IS PROJECT].

 

Code File

Code File pages can be detected using [IF PAGE IS CODEFILE].

 

Attribute

Attribute pages can be detected using [IF PAGE IS ATTRIBUTE].

 

Code Line

Code Line pages can be detected using [IF PAGE IS CODELINE].

 

Comment Line

Comment Line pages can be detected using [IF PAGE IS COMMENTLINE].

 

Class

Class pages can be detected using [IF PAGE IS CLASS].

 

Enum

Enum pages can be detected using [IF PAGE IS ENUM] and Enum Value pages can be detected using [IF PAGE IS ENUMVALUE].

 

Interface

Interface pages can be detected using [IF PAGE IS INTERFACE].

 

Namespace

Namespace pages can be detected using [IF PAGE IS NAMESPACE].

 

Procedure

Procedure pages can be detected using [IF PAGE IS PROCEDURE].

 

Constructor

Constructor pages can be detected using [IF PAGE IS CONSTRUCTOR].

 

Destructor

Destructor pages can be detected using [IF PAGE IS DESTRUCTOR].

 

Property

Property pages can be detected using [IF PAGE IS PROPERTY].

 

Structure

Structure pages can be detected using [IF PAGE IS STRUCTURE].