Shorter Titles in the Table of Contents

Abstract

Use the titleabbrev element to give your topics a shorter, alternative title for use in the contents bar (TOC).

You can use the titleabbrev element to give your topics a shorter, alternative title for use in the contents bar (TOC). This is useful when you have a long topic title that you want to keep for search purposes, but would prefer to use a shorter version for the TOC.

For example, let's say you have a long title for a topic, such as "Configure the Wifi Connections for your ACME 100". You want to keep that title, as it provides a good level of detail for when it appears as a result in a search. But the title is quite long, and so can make the HTML5 contents appear cluttered. For a neater look, you want to shorten the title in the contents to just "Wifi". To do this, you can use the titleabbrev element.

To use the titleabbrev element for shorter TOC titles:

  1. In Paligo, open the topic that you want to give an alternative title.

  2. Position the cursor below the title element but before the first para element.

    Topic showing "Configure the WiFi Connections for your ACME 100" as a title. The cursor is positioned below the title, but above the first paragraph in the topic.
  3. Press Alt and Enter (Windows) or Option ⌥ and Enter (Mac) to display the Element Context Menu.

  4. Select titleabbrev to add a titleabbrev element.

    Topic showing "Configure the WiFi Connections for your ACME 100" as a title. A titleabbrev element has been added after the main title and before the first paragraph.
  5. Enter the text for your alternative title in the titleabbrev element.

    Topic showing a title with a titleabbrev element below it. The title is "Configure the WiFi Connections for your ACME 100". The titleabbrev is "WiFi".
  6. Select Save.

When you publish your HTML5 content, the contents bar will use the titleabbrev text as the title, but the main topic will continue to use the topic's title.

Published HTML5 page showing the table of contents has "WiFi" as the title. But in the main topic, the title is the longer title of "Configure the WiFi Connections for your ACME 100".

Note

The titleabbrev also applies to PDF outputs. With those, the titleabbrev will be used instead of the title in the table of contents.