Use Pre-Established Table of Contents Template

If the customer provides a pre-established XLS template to use on a project, you can use it instead of using the default template. To use the XLS template, values will need to be replaced with general and/or section title page variables from the "TYPE=Comp Section Title" tab of the template variables sheet. For more information about template preparation, see section below.

Select a Section Title Page Template

First, you will need to prepare the template and upload it the DocBoss (see article for instructions: Upload Templates into DocBoss). For the template type, select "Compilation Section Title Page."  

Once uploaded, select this template to be used on the compilation editing screen (Project Menu > Index Reports & Compilations > [Compilation Name] > Templates).

Manage Document Codes and Sections 

Because a customer-provided template is being used, the system-generated table of contents will need to be removed. From the "Document Codes and Sections" area of the compilation editing screen, delete the table of contents from the compilation structure.

Once the table of contents is removed, create a new section by clicking the "+ Section" button above the grid. Give the new section a name, and leave the "Put inside another section?" option to "No".

3. Add Section.png

The section name will not appear in the table of contents but will be included in the bookmarks of the generated compilation.

Once the section is created, move the entire compilation structure (cards, sections, etc.) into the new section. To do this, hold CTRL (or SHIFT) and use the left mouse click to select multiple items. Once selected, click and drag the selected items into the section.

Update Depth of TOC 

With the new section introducing an additional depth level to the compilation structure, the TOC depth should be increased to ensure all information is displayed in the output.

Generate Compilation (Result)

Because the separate system-generated table of contents is no longer in the compilation structure, the entire compilation must be generated to see the result of the above steps.

To see specific card details (e.g., doc numbers, etc.), the compilation must be linked to the doc code. For instructions on linking a compilation to a doc code, see this article: Attach Compilation/TOC to a Doc Code.

Variables

To prepare a pre-established TOC template, general and/or section title page variables from the "TYPE=Comp Section Title" tab can be used.

Content Layout Options

1. Full Hierarchy Tree arrays

The TOC Number and TOC Header variables included within the <Start_Section_FullHierarchyTree> and <End_Section_FullHierarchyTree> arrays will display the included document codes and section. 

Result (Example):

2. Section Documents arrays

The variables included within the <Start_Section_Documents> and <End_Section_Documents> arrays will display the compilation structure hierarchy (including the cards). 

Result (Example):


3. Order Data Source arrays

The variables included within the <Start_AllUnits|highOrderDataSource(Section_Documents)> and <End_AllUnits> arrays will list information related to all equipment data. These arrays should be used within the <Start_Section_Documents> and <End_Section_Documents> arrays in order to cross-reference card variables with the equipment units.

Result (Example):9. Order data - result.png

This layout is helpful for creating an index for packages of engineering documents (e.g., drawings, data sheets, calculations, etc.) to list the equipment units with the applicable page number of each document.