Editor

You create and edit your content in the Editor. In this section, we explain how to display the editor and provide an overview of its features. To find out how to use the various editor features, see Authoring in Paligo.

To display the editor:

  1. In the Content Manager, find the topic or other component that you want to edit.

  2. Select its options menu ( ... ) and then select Edit > Open in Editor.

Note

Alternatively, you can click the name of the topic or component in the Content Manager. The topic/component will open in the editor by default.

The Paligo main editor. Each section has a numbered callout.

The editor has several features that you will use as you create structured content in Paligo:

  1. Navigation Menu

  2. Toolbar

  3. The Element Structure Menu shows the hierarchy of your content and provides access to options for working with specific elements. To find out more, see Element Structure Menu.

  4. Currently Selected Element

  5. Element Context Menu

  6. XML Tree View

  7. Element Attributes

  8. Reuse Text

  9. Documentation.

The Toolbar contains several tabs. The Edit and Insert tab contain options for adding structures such as lists and tables, and also for adding images and videos. You will find most of the elements and actions you need for creating and reusing content on these tabs.

Paligo edit toolbar. It shows a row of icons, each one providing access to a different editing feature.

The Preview tab provides a quick preview of your content. It gives you an idea of how your content will look when it is published, and you can choose different previews, such as PDF, HTML5, etc.

To find out how to use the various editor features, see Authoring in Paligo.

The cursor location is what determines what is the currently selected element. When you move the cursor and select another part of the topic, you will see that the Element Structure Menu changes to show you the structure.

The Element Structure Menu also provides a list of options for working with specific elements. If you select an element in the Element Structure Menu, the options that are available for that element are shown.

The Element Context Menu contains all of the elements that you can insert at the current location. You open it by pressing Alt Enter on Windows or Enter on Mac.

The Element Context Menu. At the top, there is a search field for searching for specific elements. Below that, there is a list of elements that are valid for the current cursor position.

To find out more about using the element context menu to add content, see Add Content to Topics

The XML tree view shows the structure of the topic that you have open in the main Paligo editor. For writers, it is especially useful as it means you can see the elements you have in place all at once, and it also makes it much easier to move blocks of content to new positions. You can drag an element from one position in the XML tree to another and your topic will update automatically to match.

XML Structure view shows your content in a tree structure. On the left, there are blue tags for each element in your topic and these are nested to show the different levels of content.

To find out more about the XML Structure view, see Move Block Elements.

Each element, such as a para, has its own properties, which are called attributes. When you add an attribute to an element and set its value, it only affects the specific element you selected. For example, if you add a filter element such as xinfo:country to a paragraph, it only applies to that paragraph and will not affect any other para elements.

The Element Attributes panel shows the attributes that are in place for the currently selected element. You can also choose to add an attribute and set its value. For example, each image has an imagedata element, and the imagedata element can have a width attribute. This is how you set the width of an image - you add the width attribute and then set the width attribute value to the size you want.

Element attributes section. It shows the imagedata element is selected and then below, the attributes that are currently in place for that element. It has a width element set to 600 and an xinfo:image element with a unique ID (UUID).

You can use the Element Attributes panel to add or remove attributes and to set the values. You can only choose attributes that are valid for the type of element you have selected, for example, you can set a width attribute on an imagedata element but you cannot set a width attribute on a para element.

The Reuse Text section is where you can search for text fragments that already exist in the database. So if you are writing a paragraph or an instruction that you think may already exist, you can search for it and then reuse the existing version.

Reuse text section. There is a search field at the bottom and someone has searched for Select Save. Above that, there are the results of the search. The results show a Select Save fragment and a Select Save Data fragment.

For example, in software documentation, it is quite common to have a "Select Save." step that is used in many procedures. Rather than recreate that "Select Save" text repeatedly, you can create it once and reuse it wherever it is needed. Then, if the text ever needs to change, you can make the change once and it will apply to every instance of "Select Save" automatically.

You can enter a term and Paligo will find any close matches. You can then select a result and choose to insert it or you can select the cog icon to access more information about the text fragment.

To find out more, see Reuse Paragraphs (Text Fragments).

The Documentation panel provides information about the currently selected element. It shows a list of Common Attributes that are often used with that element, with a brief description of each attribute. There is also a Description of the selected element, which is shown at the bottom of the documentation section.

The Documentation section. This shows a brief explanation of the elements.