# Glossary

Paligo is based on the Topic-Based Authoring paradigm. This type of authoring has its own terminology, and Paligo adds some of its own. It can therefore be useful to get familiar with some of these concepts.

### Glossary

An umbrella term for elements that are specifically made to contain safety content or information that needs to stand out in some way. It covers

• note

• notice

• caution

• warning

• danger

• important

• tip

An admonition with no title will by default output an automatic label, "Note", "Warning" etc. You therefore do not have to enter such text manually. The label is automatically translated when publishing to other languages.

Admonitions can also be created as separate topic types to be reused.

Appendix

An appendix topic is much like a regular topic, but will behave differently when it comes to numbering, using the established letter numbering for appendices.

### Note

Appendix topics should always come last in a publication, and must always be on the top level. If you want child topics for your appendix, use regular topics for that.

Attribute

This is a type of metadata that can be additionally set on an element to provide more information that can be used for processing the content. For example one attribute you may often use on images: width.

Attributes are also what you use to filter content.

Attributes panel

The Attributes panel is located to the right in the editor. It allows you to select and set element attributes, such as width for images, filter attributes for conditional content and much more.

Back recto

The inner side of a back cover.

Back verso

The outer side of a back cover.

Branch

With a branch, you create a new version of a publication or topic. The new version (the branch) acts like a copy, but Paligo understands it is related to the original version. This means that the original and the branch can be used separately as parallel versions, or, if needed, they can be merged back into a single version later.

• The original file gets a symbol that shows that there is a branch available.

• The branched file gets a green symbol that shows that it is a branch.

Component

An umbrella term for any type of text content resource in Paligo, e.g topics, admonitions, and publications.

Element

This means an XML element, sometimes also called a "tag". Elements are highlighted like this in this help guide: procedure

The menu is displayed with Alt + Enter, with which you can add any element in your topics, apart from the ones available in the toolbar or by shortcuts.

The "breadcrumbs menu" at the top of the editor, allowing you to see which element is selected in the topic, see the hierarchical structure of the elements, and to manipulate elements in different ways.

Fork

A "fork" is a reference to a topic, usually in a publication. This means, it's not the topic itself, but a reference (link) to it where it's reused.

1. Fork, only a reference (link) to the actual topic

2. Actual origin topic, where you write your content

Front recto

The front side of a front cover.

Front verso

The inner side of a front cover.

Image

As the name implies, an image resource. Note however, that in the topic editing list of elements, image is called "mediaobject". So when inserting an image, select mediaobject. This will automatically insert the imageobject where you can import the image from the image library.

Informal topic

A flexible type of component that can be used as a wrapper to reuse almost any block of content within another topic.

Publication

A Publication is like your "table of contents", a type of component that should only hold other components, such as topics and safety messages.

Usually publications will form the structure of entire manuals, knowledge bases, or the like, but can also be used for smaller structures, like chapters or web site categories/sections.

You do not write your content in the publication itself, the content is in the topics reused by the publication.

Template

Templates are components with predefined content that you first create in the Templates library. Any topic created from a template will have that predefined content.

Topic

The main building block for publications. It may be quite small, containing just a description (a title and a paragraph or two), an instruction, etc, or it may be a bit larger. But usually the aim is to make it a self-contained piece of content to build larger publications.

Variable

A variable is a container for a changeable value or text. The content for the variable is stored in a variable set, which contains all of the possible values. When you publish, you choose which of the values should be used. For example, you could have a product name variable, and then you choose a different product name, depending on what user guide you are publishing.