Getting Started with Paligo

Table of Contents

Terminology and conventions

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.

Term

Definition

Topic

The main building block for publications. A small piece of content such as a description (a title and a paragraph or two), an instruction, etc

Component

A sort of "umbrella" term for any type of text content resource in Paligo, e.g topics, safety messages and publications.

Safety Message/Admonition

A special type of topic (component) which is specifically made to contain safety content, such as Warning, Caution, Danger, Notice type statements. Sometimes also called "hazard statement".

Publication/Project

Publication or Project is a type of component that should only hold other components, such as topics and safety messages. Usually these components will be publications such as manuals, but can also be used for smaller structures, like chapters, which is why they are sometimes referred to as "projects" as well.

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.

Conventions

In this guide we use some writing conventions to indicate certain types of content. Because the content in Paligo is XML-based for structured authoring, we will sometimes refer to elements and attributes. These are indicated as follows:

  • Element - this means an XML element, sometimes also called a "tag". This is indicated by a blue color and courier font, for example: procedure

  • 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. It is indicated by the same blue color and font, and an @ character. The @ character is not part of the actual attribute name. For example one attribute you may often use on images: width