The Table of Contents is always included in DocBoss compilations (databooks) and the good news is not only are they easy to assemble, you can customize them, too.

Here’s how to start:

  1. In your project – Click Main Project Drop Down
  2. Click Index Reports & Compilations
  3. In Compilations List Grid, click the edit icon of applicable Compilation
  4. Scroll to section “Table of Contents and Bookmarks sections options”

Configuration

TOC.png

Depth of TOC 

The depth of information to be displayed. In all layouts, there are at least 2 levels available: the doc code and the document. If you have added a section into the layout, there are 3 levels of data.

Section

Doc Code

Document

If you choose 3, the TOC will display all levels. If you set this value to 1, the system would only show the Section information in the TOC.

Depth of TOC numbering 

Likewise with display of information, the TOC numbering patterns can be controlled by the same level concept. If set to “3” then it will auto-number to 3 levels. e.g.

1. Section

1.1. Doc Code

1. 1.1 Document

1. 1.2 Document

If you leave it blank (or set to 1) it only applies numbering to the first level

1. Section

Doc Code

Document

Document

If you don’t want to see any auto-numbering you must enter “0”

Depth of Bookmarking 

The depth of bookmarking that will be set in your pdf. Similar to Depth of TOC, but this is what will be shown on the bookmarks

Hide first level of TOC numbers 

Mark the check box if you do not want first level of TOC numbers to be shown (ie. if you added sections to your Compilation, do you want the sections to be numbered? If not, check this box)

Bookmark pattern for coversheet entry 

Select variable or type text to show on the coversheet bookmark. For details on using an IF statement, see our article here.

Bookmark pattern for TOC entry 

Select variable or type text to show on the TOC bookmark. For details on using an IF statement, see our article here.

TOC / Bookmark pattern for cards 

If you are showing each card in the TOC, this will apply a naming convention. Often the doc number, revision, title and tag list variables are used here. The layout is similar to other variable based conventions in DocBoss. For details on using an IF statement, see our article here.

Suffix for NON-PDF files 

What will be shown with any non-pdf files in the compilation.

Append secondary codes (if they exist) to each card with suffix 

Add secondary codes to the line on the TOC

Snag_6fafcf8a.png

If card has secondary codes, replicate the card TOC entry under EVERY secondary code with suffix 

Lists the card under the primary code, and EVERY secondary doc code (result is one card with multiple listings on the TOC)

Snag_6fb2386c.png

Suppress Cards in TOC

If you want to EXCLUDE the individual documents from your TOC, but want to show all levels of hierarchy enable this checkbox. This is particularly useful if you have differing levels of hierarchy, so you cannot simply limit the levels on display (via TOC level).

Show page numbers on the TOC 

This allows you to select if you want to display the page numbering or not. In many cases, customers want a copy of the TOC at project initiation. While page numbers don’t really make much sense without documents, some customers like to see these numbers on the TOC. We extrapolate the expected page numbering from any docs inside the included cards, or the page number estimates as defined on the code list.

TOC/Bookmark pattern for doc code 

Select variables for the pattern you wish to appear for each doc code on both the TOC and bookmarks

Append Included In Codes to Primary Code (if applicable) using suffix: 

Snag_5116b8d9.png

A list of “Included In Codes” will be added to the Primary Code if selected, for all doc codes that were marked as included in another doc code in the Code List.

Snag_6fb2fb00.png

To see the “Included In Codes” you must check the “Show N/A and Included In Codes”, then add the code(s) to the grid. 

Snag_5112125b.png

When Included In Codes are added to the compilation layout, add suffix to TOC/Code: 

Select the suffix as you want it shown on the TOC

Snag_51171e2a.png

The result on the TOC once applied is: 

Snag_65ce977f.png

When Not Applicable Codes are added to the compilation layout, add suffix to TOC/Code: 

This will be shown beside any Doc Codes that were set as N/A. See example below

Snag_5119ea2b.png

Other notable TOC options

To Hide a Doc Code from the TOC entirely

2-Managing_Sections.png

Once the first icon [1] is disabled, the second icon will appear. 

The second icon [2] shows that the doc code is STILL treated as a section in the TOC.

If you want to HIDE the doc code from the TOC entirely, you will disable the second icon [3].

Snag_4c014a0a.png

To see how these changes are reflected on the TOC, see below.

Snag_4c148ff0.png
Snag_4c14c5d5.png

To start a section or doc code on a new page of the TOC – click the mceclip0.png icon beside the section or doc code name

Snag_4c2ace65.png

To change the naming convention for SPECIFIC sections – [1] click the mceclip1.png icon and [2] edit the TOC/Bookmark pattern for each doc code

Snag_4c3d38df.png

Sorting Options

For more information regarding sorting options please see the following article: Sorting Options in Compilations

New TOC Templates

Because of the level of control available for the table of contents, new templates must be created by the DocBoss staff using LaTeX. Reach out to support if you have a very specific customer template required for the project’s compilation. 

Attach the Table of Contents to a Document Code

When generating the Compilation or TOC, if this template contains information related to the Card as Document number, Revision and Title, these will be added to the TOC only if the Compilation has been ATTACHED to a Doc Code.

If the Compilation is not yet attached to any Doc Code the file will be generated with the layout and the sections that have been selected, but will not contain the information related to the Card.

TOC layout of a Compilation that has not been attached to a Doc Code: 

Image_101.jpg

TOC layout of a Compilation that has been attached to a Doc Code

Image_102.jpg
Share This