Publications

In Paligo, you write your content in topics and then organize the topics in a publication. You can think of a publication as a "table of contents", as it is where you choose which topics are going to be included and what order they will appear in.

Example of a structure in a publication. Topics are organized into a structure similar to a table of contents.

Example of a multi-level structure in a publication.

You do not write anything in the publication, it is only for organizing the topics into a logical structure. For example, if you were creating a PDF output for a user guide, you would use a publication to choose which topics are included in the guide, and the order they appear in.

Typically, you will create a publication for each "document" that you want to publish. For example, you could create a publication for a user guide or a help center. But a publication does not have to represent an entire user guide or online help system, it could be a smaller collection of topics, such as a chapter.

In the following sections, you can learn how to create a new publication, add content to it, and organize the content. You can also learn how to include content in your publication, but exclude it from the "table of contents" structure.

To create a new publication that you can use to build the structure ( "table of contents") for a document:

  1. Select the options menu ( ... ) for the folder that is going to contain the publication.

    create-content.png
  2. Select Create content.

    create-content-default.png
  3. In the Document Title field, enter the title for your publication.

    Note

    The characters you can use for titles are: numbers, language characters, punctuation characters, and spaces. The punctuation characters are:

    ! " # $ % / & ' ( ) * + , - . : ; < = > ? @ [ \ ] ^ _ ` { | } ~

  4. In the Document Type section, select Publication.

  5. (Optional) Choose any additional languages that you want to translate to later, and then select OK.

Paligo creates the publication and adds it in the Content Manager. It is shown with a briefcase symbol.

publication-added.jpg

When you have a publication, you can open it in structure view and from there, you can add content to it and organize the topics.

When your publication is ready for release, you can publish it.

Use a publication in Paligo to create the "table of contents" of the content that you want to publish. You create the "table of contents" by opening the publication's structure view and then adding content to it.

plain-toc.jpg

A publication with topics added to form a "table of contents".

You can add:

  • Topics

  • Other publications (which includes the topics in those publications).

When you add content to a publication, you need to include every topic or publication that you want to appear in the published output. By default, all of the topics and publications that you add will appear in the table of contents in the output. But you can add topics and prevent them from being included in the table of contents if you prefer.

To add content to a publication:

  1. Open the publication in structure view. To do this, find the publication in the Content Manager and select it. Alternatively, you can select its options menu ( ... ) and then select Edit> Open structure.

  2. Now you can:

    • Drag and drop topics from the Content Manager into the publication structure.

    • Create new topics that are added to the publication structure automatically. To do this, select the New Topic button at the bottom of the structure view, and then enter the topic's name.

    • Drag and drop other publications from the Content Manager into the publication structure. When you add a publication to your publication, you add the entire publication, including its topics.

  3. Select Save.

Note

Paligo does not create new topics in a publication structure until you select Save.

When you have added content to a publication, you can organize it into the structure that you want.

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 1. 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.

    Image showing Paligo editor with the Element Structure Menu shown below the toolbar options. The section element is selected and there is a drop-down menu. The Go to Element option is selected.
  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.