Setting Table of Contents Text

In the Book Editor, the “”Display Text“” column reflects the text for each artifact entry in the table of contents. The default text in the table of contents is the artifact name or, in the case of a member, the member name. For example, if the artifact in the book is a report, the report name is shown. If the artifact in the book is an external file (for example, a Microsoft Word document), the file name, as it exists in the repository is shown.

A panel, located at the bottom of the Book Editor, displays the default properties of the book where you can change and artifact's textual and processing settings for the table of contents. For example, you can change the selected artifact name (as it exists in the repository) to the artifact's description, to customized text, or you can choose to not display any text for the selected artifact. Other properties are read only.

  To set the table of contents text for an artifact:

  1. From Explore repository, right-click a book and select Open In, then Editor to open the Book Editor.

  2. In the Book Editor, highlight an artifact and scroll to the bottom panel. Edit the following:

    • Display. From the drop-down, if you want the artifact to display in the table of contents, select by Name (artifact name), Description (as it exists in the repository), or Custom Text. To hide the text, select Do Not Display.


      If youselect “”Custom Text“”, the “”Display Text“” field is enabled where you can add your custom text.


      A “Value” function can be included in the custom text to inset a member label of a dimension in the Custom Text.

      The syntax: <<value(dimension-name)>>

      For example: <<Value(Product)>> or <<Value(Year)>>

      Using the “Value” function the book designer can create a cleaner, more streamlined Table of Contents. For example, the Book can contain two reports which are run for the children of Qtr1. In your Custom Text, you can include a <<Value(Year)>> function, then hide the member selections. In the following example, “Period” and “Year” are added to the Profit & Loss and Balance Sheet reports:

      Profit and Loss for <<Value(Period)>> <<Value(Year)>> and Balance Sheet for <<Value(Period)>> <<Value(Year)>> which will change the appearance in the Table of contents from (Before):This “Before” example shows Custom Text on one line and Period and Year indented on following lines.

      to (After):This “After” example shows Custom Text and Period and Year on one line (not indented)

    • Display Text. Type the custom text

    • Include Related Content in HTML Table of Contents. This option is available when you select a report in the Book Editor. For processing behavior with FRExecute and hyperlinks, see Processing Behavior of Hyperlinks and FRExecute.

    • Member Selection. This option is available when you select a member in the Book Editor. To change the member for the Point of View, click the entry field to display the Preview User Point of View dialog, select a member, and click OK.