Adding a Table of Contents Page

How to:

Reference:

You may generate a Table of Contents (TOC) page in Document Composer that shows a summary of the contents of the document, along with page numbers, and that can be printed with the document. The entries in the Table of Contents enable you to easily navigate to a particular section while viewing the document online.

The actual content of the Table of Contents is represented as a text element in Document Composer. When using a Table of Contents page, you may:

The following image is an example of the Table of Contents page shown at run time:

Note: If the Table of Contents overflows to more than one page at run time, then the remaining content is executed with the same size and dimensions as the first page until the entire TOC has been output.


Top of page

x
Procedure: How to Create a Table of Contents Page in Document Composer
  1. Select Add Table of Contents Page from the Insert menu of Document Composer.

    or

    Select this option from the New Page Layout button from the Positioning toolbar.

    The Table of Contents page appears in the Design View.

    Table of Contents appears as the default title for the page. To customize the title of the Table of Contents, simply edit the text. Double-click to go into edit mode and type your new text.

    Note: The text will not wrap and must fit within the width of the overall text element.

  2. Optionally, you may edit the TOC numbering and tab leading options for the Table of Contents by using the Properties window.
  3. Click Run to load your document.

    The Table of Contents appears as the first page in your output.

  4. Click a hypertext link on the Table of Contents page to jump to that section within the document.


Top of page

x
Procedure: How to Control Which Objects Appear in the Table of Contents

Note: The objects that appear in the Table of Contents depend on whether the document is coordinated or uncoordinated. For details, see Controlling Which Objects Appear in the Table of Contents.

The following is an example of how to control which objects appear in the Table of Contents:

  1. Select a report, graph, or page layout object by selecting the object in Design View, or by using the Properties drop-down list to select the object.

    Each report, graph, and page layout object has a TOC description, TOC level option, and TOC Number of sort levels in the Properties window.

    Note: By default, all report, graph, and page layout objects are shown in the Table of Contents for uncoordinated documents. For details about which objects appear in the Table of Contents, see Controlling Which Objects Appear in the Table of Contents.

  2. To change the name of the description for the object, type over the TOC description in Properties window.

    This description appears in the Table of Contents at run time.

  3. To change the hierarchical order of how the object appears in the Table of Contents, type in a TOC level.

    For example:

    0 = the object is not shown in the Table of Contents.

    1 = the object is shown as a first level item in the Table of Contents.

    2 = the object is shown as a second level item in the Table of Contents.

    Follow this sequence for additional levels.

    These levels appear in the Table of Contents at run time.

  4. To change the number of vertical sort fields (TOC levels) that appear in the Table of Contents for the component, use the up or down arrow to adjust TOC Number of sort levels in the Properties window. If the value designated is greater than the count of BY fields in the component report, then the value defaults to the total count of available BY fields. Note: Coordinated reports do not support TOC Number of sort levels within a compound TOC. Those entries are ignored for coordinated reports.
  5. Run the procedure to see the updated TOC description and TOC levels.

The following image is an example of a Table of Contents with two levels: Regional Balance Analysis as a TOC level 1 Page Layout, Regional Fund Balance Report as a TOC level 2 report, and Regional Balance Chart as a TOC level 2 graph.


Top of page

x
Reference: Controlling Which Objects Appear in the Table of Contents

The objects that appear in the Table of Contents depend on whether the document is coordinated or uncoordinated.

Note: The Coordinate report option is available from the Compound document Properties window in Document Composer. See How to Create a Coordinated Compound Layout for more information about creating coordinated documents.

For an uncoordinated document, the TOC presents all of the page layouts and components designated in the TOC parameters. For example, a TOC might contain a list of all objects on the page:

For a coordinated document, the TOC presents a reference to each of the coordinated sort fields, with a link to the first page of the associated pages for that common sort field. For example, the TOC might contain a list of countries:

Note: If using a coordinated document with ReportCaster, the coordinated document is burst to create individual reports for each instance of the common sort field. These individual reports are then handled as uncoordinated reports and a TOC is generated to represent the page layouts and components within the sort field, resulting in a list of all objects on the page.


Top of page

x
Reference: Properties for the Table of Contents Text Element

The following image is an example of the Table of Contents element and its properties:

Note: You can edit the size and position of the Table of Contents text element by clicking and dragging the text element on the page.

The properties for the Table of Contents text element consist of:

Name

The descriptive text that represents how the content within the Table of Contents appears at run time. You may edit the font and style of this text.

Position: Left

The left margin position of the Table of Contents text element on the page.

Position: Top

The top margin position of the Table of Contents text element on the page.

Size: Height

The dimension height of the Table of Contents text element on the page.

Size: Width

The dimension width of the Table of Contents text element on the page.

Styling: Font

Opens the Font dialog box enabling you to edit the Font, Font Style, Color, and Font size for the contents within the Table of Contents.

Styling: Z-Index

Defines the Z-Index property of an object.

TOC numbering

Adds section numbers to the left of the TOC description for each entry within the Table of Contents.

Note: TOC numbering is ON by default.

TOC tab leader

Adds leading dots to the content within the Table of Contents.

Note: DOTS is OFF by default.


WebFOCUS