Indexing: Table of Contents, Figure lists, Table lists

Parent Previous Next

Generating Report Indices: Tables of Contents, Lists of Figures, Lists of Tables

The Nexus system provides basic support for the dynamic generation of report 'index' features.  These features include a traditional 'table of contents', 'lists of figures' and 'lists of tables. The entries for the table of contents and the lists are collected as the report is generated and can be inserted into the final, output report using the Table of Contents Layout. Entries can be generated for layout templates and for data items.


There are five properties that are used to generate the entries for the table of contents and lists.  As with all properties, they are inherited by layout children.  It is not uncommon to set TOCItem on a upper-level template and disable it on lower-level templates to scope the hierarchical generation of table of contents entries.


When generating entries, three macros are available for use when creating things like custom HTML headers or even properties for things like plot titles, etc.  These three macros expand to the current number for the Item, Figure and Table lists.  They are:

In a custom HTML header they can be used like this:

<h2>{{toc_item_number}} Data</h2>

or in a table property to dynamically label the table (plots) within a layout:


There are several exceptions from the basic inheritance rules. Generator layouts cannot be added to the lists. Some report layouts do not allow their children (layouts or items) to generate entities. The carousel, tab and slider layouts are three examples. This is because they do not support links pointing to their specific children.