Appendix Topic
An appendix is a section that provides useful context or background material in your publication. The appendix topic is created the same way as a normal topic, except that you select the document type Appendix.
Appendix titles, when published, are automatically lettered (Appendix A, Appendix B, Appendix C). This lettering continues for every appendix that follows.
The most common use cases for appendices are to insert elements like glossaries, bibliographies, indices and Table of Contents (TOC). All these elements can be placed inside a normal topic, but you will not get the automatic title lettering that comes with appendices.
If an appendix title is "Specifications" and it is the first appendix in the publication, it will be published as Appendix A. Specifications.
 |
To create an appendix topic:
-
Select the Dotted menu (... ) to the right of the folder that is to contain the appendix in the Content Manager.
If a suitable folder does not already exist, you can create a new one (Create Folder).
-
Select Create content.
-
Name the content.
Note
The characters you can use for titles are: numbers, language characters, punctuation characters and spaces. The punctuation characters are:
! " # $ % / & ' ( ) * + , - . : ; < = > ? @ [ \ ] ^ _` { | } ~ -
Select the checkbox in front of Appendix.
The checkbox for topic is preselected.
-
Select Open in editor in the lower left corner to start editing.
-
Select OK.
-
Position the cursor straight under the title.
-
Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.
-
Insert elements like:
-
toc- Add a table of contents. It must be placed straight under the section title. When you publish to PDF, Paligo will automatically create the TOC. -
glossary- See Create a Glossary Topic -
bibliography -
index- See Create an Index Topic -
section- To add subtopics.
Tip
It is also possible to use existing topics in your appendix, see Insert Component.
-
-
Add the index to your publication.
Note
An important rule of thumb is that appendices must always be at the top level of your publication. Appendices cannot be nested under other topics.
The best practice is to place appendices at the very end of your publication, though Paligo will not prevent you from doing otherwise.
-
Select Save.
-
Publish your publication.
To apply appendix labels to subsection titles, use the setting Appendix section labeling. It is available in the Layout Editor for:
-
HTML5 - Located under TOC and chunking.
-
PDF - Located under Section Titles / General.
 |
Important
The following must be activated for the appendix labels to work:
-
Section numbering must be activated.
-
Appendix section labeling must be activated.
-
Section numbering max depth must be set.
To activate appendix labels for HTML5:
-
Select Layout in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select TOC and chunking in the sidebar.
-
Set the Section numbering to:
-
Enable to activate section numbering.
-
Disable to deactivate section numbering. Default
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Set the Appendix section labeling to:
-
Enable to activate appendix labels for subsections.
-
Disable to deactivate appendix labels for subsections. Default
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Use Section numbering max depth to control how many levels down the labels are applied:
-
Select between level 1 to 8.
-
Default to inherit the value for this setting from the base Layout. The base Layout is either a built-in Layout provided by Paligo or another custom Layout, see Layout Relationships - Base, New, Duplicate.
-
-
Select Save.
To set page breaks for appendix topics, use the page break settings in the PDF Layout.
-
Select Layout in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select the PDF Layout you are going to use for publishing. Alternatively, create a new one (see Create a Layout).
-
Select Section titles.
-
Select Appendix.
-
To control whether an appendix topic starts on a new page, use the Ensure a page break before Appendix topics setting.
-
To control whether content that appears after an appendix has to be on a new page, use the Ensure a page break after Appendix topics setting. In most cases, you can leave this set to auto.
If for some reason you do have content that must come after the appendix, you could choose column, page, even-page, or odd-page. These work in the same way as in the previous step, except that they push the content that comes after the appendix on to a new page or column. If you choose Default, the setting will inherit its value from the base Layout (see Layout Relationships - Base, New, Duplicate).
-
Select Save.
When you publish with this Layout, Paligo will apply your chosen page breaks to the appendix.