Publications and Topics

In Paligo, you write content in "topics" and you organize your topics in a publication. If you think of your content as a traditional printed user guide, the publication represents the entire guide and its structure is where you organize the table of contents. You create the structure by adding topics to it. Each topic is a container for text, images, etc., and is one "section" in your user guide. For best practice, each topic should focus on one subject or task.

mission-control-center-pub.jpg

A Publication is a collection of topics.

mission-control-center-topic.jpg

A topic is a container for your content such as text, images, etc.

When you have a publication and you have added topics to it, you can organize them into a logical order. When you publish, the structure of the publication is what the reader will see as the table of contents or navigation menu.

To organize the content in a publication, you can either:

  • Drag and drop the references in the publication.

  • Use the arrow icons to move content up and down in the structure, and also to different levels in the structure hierarchy. The arrow icons appear when you move the cursor over a reference in the structure.

    arrow-icons-organize.jpg
  • Use keyboard shortcuts to move content in the structure hierarchy.

    The keyboard shortcuts are:

    • Move left is Shift and Tab

    • Move right is Tab

    • Move up is Alt and on Windows and Option ⌥ and  on Mac

    • Move down is Alt and on Windows and Option ⌥ and on Mac

Tip

You can move several adjacent topics at the same time by pressing down Shift and then selecting the topics you want to move in the structure.

Note

You can create a hierarchy of content so that there are sections and subsections. You can also control how many levels of the content are shown in the table of contents by using the chunking feature.

Example 2. Organize a publication

Let's say you have a publication and you add a "Pair with another device" topic and a "Turn Bluetooth on/off" topic. When you add the topics to the publication structure, they appear at the bottom of the structure. You want to move them so that they are subsections of a "Connecting via Bluetooth" topic.

move-topics-up-and-in.jpg

To move them, you press and hold the Shift key and then select both topics in the structure. Then you use the up arrow icon on the "Pair with another device" topic to move both topics up until they are directly below the "Connecting via Bluetooth" topic.

Note that you could use keyboard shortcuts or drag and drop instead of the arrow icons if you wanted to.

both-topics-moved-up-in-structure.jpg

With the topics selected, click the right arrow icon (or hit Tab) to move the topics so that they are sub-sections of the "Connecting via Bluetooth" topic.

both-topics-moved-inside-in-structure.jpg

With the topics now arranged in the structure you want, click Save to store the changes.


On some projects, you may want to include topics in a publication, but stop them from appearing in the table of contents (TOC). For example, if you have a high number of topics, that could result in a large TOC that becomes a little overwhelming for people who are using your help center. So you might want to prevent some topics from being in the TOC, but still have them in the help center so that people can search for them.

To hide topics so that they are not in the publication's TOC, but are still searchable in the help:

  1. Edit the topic that you want to exclude from the TOC.

  2. In the Element Structure Menu, select the top section element and then select Go to element.

    section-go-to-element.jpg
  3. In the Element attributes, add the role attribute.

    role-attribute.jpg
  4. Set the value of the role attribute to: notintoc

    role-notintoc.jpg
  5. Select Save.

When you publish the content, topics with role = notintoc are included in the publication, but will not appear in the table of contents.