Getting Started

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

Admonition

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.

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 widget

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

attributeswidget.png
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

To learn more about elements, see the Basic Element Reference.

Element Context Menu

The context menu that pops up on AltEnter, with which you can add any element in your topics, apart from the ones available in the toolbar or by shortcuts.

elementcontextmenu.png
Element Structure Menu

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.

elementstructuremenu.png
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.

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

  2. Actual origin topic, where you write your content

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.

Informaltopic

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.

publication.png

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.

Search results

    No results found