Elements

When you write in Paligo, you will use elements to create the structure in your topics and add meaning to selected parts of your content.

Elements are tags that contain your content, and there are many different types of element that you can use, for example, there is a para element for paragraphs and a procedure element for process lists. Paligo uses a customization of the DocBook 5.0 XML standard and you can use any element included in that standard.

The elements that you use to build the structure are "block elements". There are also "inline elements" which you can use to mark up content inside a block element.

Block Elements

In a topic, you will add block elements to define the structure, and then you can add your content inside the elements. Think of the block elements as "building blocks" that represent different types of information.

The following images show how block elements form the flow and structure of a topic. The first image shows how the topic looks in the Paligo editor. The second image shows the underlying code of the topic, and we have color-coded the elements to show you the block structure (for illustration purposes only).

There is a block element for each different type of content and the elements are arranged in a hierarchy. For example, the procedure tag contains all of the steps in the procedure list, and for each step, there is a para element for the paragraph text.

simple-topic.png
block-structure-1.svg

There are rules about where you can add each element, and this is how Paligo makes sure your content has a consistent structure. You do not need to know the rules as Paligo will advise you if you add an element in an invalid position.

To learn how to add block elements to a topic, see Add Content to Topics.

Inline Elements

Inline elements allow you to add meaning to content that is inside a block element. For example, if you are writing about software, you might want to use the guilabel inline element on the names of user interface options in your text. Another common example of an inline element is the emphasis element, which you can use to italicize one or more words.

inline-element.svg

There are many different inline elements available for use. We recommend that you look at the full list and identify the ones that are most useful for your content and then agree to use them consistently. You do not have to use them all.

To learn how to add inline elements to a topic, see Add Content to Topics.