Index Title

Abstract

Learn how to add a title element to an Index in Paligo. Typically, index titles are used when you what to give the index topic a different name than "Index".

By default, the index element does not include a title (PDF). This is because we recommend that for an index, you create a topic called "Index" and add the index element to that. In that scenario, there is no need for the index to have a separate title to the topic.

index-traditional.jpg

But it is also possible to add an index to a topic that is not called "Index". For example, you could add an index to a topic called "Reference".

index-inside-different-topic.jpg

In this scenario, it can be a good idea to include an index title as well. The title will make it easier for your readers to find your index, as there is no "Index" topic. In the following image, an index has been added to a "References" topic, and the index has a title called "Index".

index-inside-topic.jpg

If you are going to use an index title, you should consider:

Add an Index Title

When you add an index element to a topic, it does not include an index title. If you want to add an index title, you can either:

  • Add the title element inside the index element

  • Set Paligo to automatically generate an index title for you, when you publish.

    If you want an automatic index title, see Automatic Index Title for PDF Outputs . For HTML5 outputs, an index title is included by default - if you have added a title manually, Paligo will use that. Otherwise, it will create an automatic title for you.

    Note

    The index title is shown in HTML5 outputs by default. But you can hide it by using CSS (see Index Title for HTML5 Outputs).

To add your own index title to a topic:

  1. Open the index topic in the Paligo editor.

  2. Select the index element.

    A topic with a title set to "Index" and below that, it contains an index element.
  3. Use the element context menu to add the the title element.

    select-index-title.jpg
  4. Enter the text for your index title inside the title element.

  5. Select Save.

Automatic Index Title for PDF Outputs

Paligo can automatically add a title to your index. The automatic title has the text "Index" and if you publish to other languages, a translation of "Index" is provided as well.

To use an automatic index title for PDF outputs:

  1. Create a PDF layout. Alternatively, you can edit an existing PDF layout.

  2. In the PDF layout, select General > Glossary and Index.

  3. Set Index auto title to Enable.

    When you publish, Paligo will check to see if your index has a title.

    • If the index already has a title, Paligo will use that title. It will not generate an automatic title.

    • If the index does not have a title, Paligo will add a title element with "Index" as the title text.

    If you set Index auto title to Disable, Paligo will not create an automatic index title.

  4. Select Save.

When you publish to PDF with this layout, the output will include/exclude an automatic index title.

Index Title included in PDF Bookmarks

PDFs can have bookmarks that act like a table of contents in a side panel, where your topics are shown in order. If you have an index, it's likely that you will want a link to the index to appear here.

If your index is inside a topic called "Index", you will not need to take any action. The "Index" topic will appear in the bookmarks by default.

But if your index is inside a topic with a different title, there will be no obvious way for the reader to access the index. For example, let's say you have added your index to a topic called "references". In the published PDF, the bookmarks will only show "References", which makes it harder for your readers to find the index.

references-index.jpg

To fix this, you can set Paligo to include the index's title in the bookmarks as well. If your index does not have a title, you can add one or you can set Paligo to generate one automatically.

  1. Create a PDF layout. Alternatively, you can edit an existing PDF layout.

  2. In the PDF layout, select General > Glossary and Index.

  3. Enable the Index title or auto title in bookmarks setting to get Paligo to include the title of the index element in the bookmarks.

    index-title-or-auto-title-bookmarks.jpg

    Note

    This setting will only work if your index has a title, or you have set Paligo to generate a title automatically.

  4. Select Save.

When you publish to PDF with this layout, Paligo includes the index title in the bookmarks. It is a subsection of its parent topic.

A PDF output that shows a references topic. There is an index inside the references topic. In the bookmarks sidebar, there is a link for the references topic, and at a lower level, a link for the index title.

Index Title for HTML5 Outputs

Your HTML5 output will show your index title by default if:

  • Your index contains a title element

  • Your index has no title element, but your HTML5 layout is set to generate an index title automatically. The automatic title is called "Index" (or a translation of Index for other languages).

This can mean that your HTML index has two "Index" titles, one for the topic and one for the index element. To hide the title for the index element, use CSS:

  1. Create or edit an existing custom CSS file and add the following code:

    .index .titlepage{
        display: none;
    }

    To learn more about creating custom CSS, see Branding your HTML Outputs with CSS.

  2. Create an HTML5 Help Center layout. Alternatively, you can edit an existing HTML5 Help Center layout.

  3. Upload your custom CSS to the HTML5 layout.

  4. Select Save.

When you publish to HTML5 using this layout, the index element's title is hidden.

If you want to show the index title again, change the CSS to:

.index .titlepage{
    display: block;
}