Skip to main content


The built-in XML editor provides professional technical writers with all the tools they need to be in full control of their structured content. To find out how to use the various editor features, see Authoring in Paligo.


From the editor you reach the Math Editor, Profiling Tab and Source Code Editor.


Areas surrounded by a blue dotted line shows that Variables are applied.


If you prefer, you can also use the Oxygen XML Editor.

A topic or component is by default opened in the Editor. There are two ways to display the Editor:

  • By clicking the name of the topic or component in the Content Manager.

  • Using the menu option Open in editor.


You can open multiple Paligo windows in the same web browser, but be careful when editing and saving, because there is potential to overwrite changes you have made.

The Toolbar has been divided in three tabs to make it easier to overview. The Edit and Insert tab contain most of the elements and actions you need for creating and reusing content. The Preview tab shows how your content will look when it is published. You can choose to preview the output as PDF, HTML or HTML5.

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



Find useful keyboard shortcuts, see Keyboard Shortcuts

The Element Structure Menu is shown at the top of Editor below the Toolbar. It shows the content hierarchy and provides access to options for working with specific elements.


In the image above, the currently selected element is a para. You can see this by looking at the Element Structure Menu, which shows: section > note > itemizedlist > listitem > para. This means the cursor is currently on a para that is inside a listitem. The listitem is inside an itemizedlist which is inside a note. The note is inside the section element, which represents the topic as a whole.

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.

You can customize the element context menu so that certain elements appear in a favorites section at the top. This can make it quicker and easier to apply regularly used elements. For details, see Working with the Element Context Menu.

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

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 Content.

The Element Attributes Panel is one of the Editor features. It shows the attributes that are in place for the currently selected element. It is used to add, remove, edit and profile / filter an attribute and set its value.

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.

It is only possible to choose attributes that are valid for the type of element selected, for example, an imagedata element can have a width attribute. By adjusting the value of the width attribute, the size of the image is set. By using a percent sign (%) after the value, the image can be scaled. A width attribute cannot be set on a para element.


The Reuse Text panel is where you can search for existing text fragments in the database. If you are writing a paragraph or an instruction that you think may exist, you can search for it and reuse the existing version. Rather than repeatedly recreating recurring phrases, you write it once and reuse it wherever needed. Then, if the text ever needs to change, you can make the change once and it will apply to every instance automatically. To learn more, see Find Reusable Content and Reuse Text Fragments.

When a term is entered in the search field, a list of exact and close matches is presented in the Reuse Text panel. You can insert a match or access information about it via the cog icon. To the right of each match, the xml id is shown.

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.

The xml id is shown to the right of each match.


If you want to reuse both text and image or perhaps a procedure, see Create an Informal Topic.

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.

To add an equation or math phrase in your Paligo content, you use the element inlineequation, see Mathematics. Paligo supports two different math editors:

When using variables and / or filters, you can configure settings to view specific variants of your content via the Profiling tab. You can reach the Profiling tab from Editor, Review View and Translation View. The filters you set in the Profiling tab will also apply when you preview content in PDF, HTML5 or HTML from within the editor. This is a very useful way to see how the profiled content will actually come out.


In the Options tab under Profile Settings, you can select whether to completely hide filtered content or to show it as a placeholder only (as in the image below). Profile_Settings_Options_small.png

In Editor you set the profiling by clicking the Profile Settings under the Preview tab. Profile_settings_button_small.png


Example of variant view of a topic in the Editor with variable value filled in and profiled content filtered out.

In Review View and Translation View you set the profiling by clicking the cog icon at the top right corner. Cog icon.


To the left - Profile settings in Review view. To the right - Profile settings in Translation view.

While the Paligo Editor is made to make structured authoring as natural as possible, there may be times when you need to edit the actual source XML. You can also Search and Replace with Source Code Editor.



Please note that while convenient editing XML directly in plain code view, it requires that you are sure of what you are doing. As long as you have the auto-validation turned on, Paligo will prevent you from saving invalid XML. However you still have to be careful not make unintentional changes.

If you are not absolutely sure of what the result will be, you should be especially careful not to edit attributes such as xinfo:text and xml:id, since these are Paligo id:s.

To edit the XML in Paligo, you have to open the Source Code Editor.


This can also be done during an assignment in the Contributor Editor, see Edit the Source Code.

  1. Select the topic or component in the Content Manager.


    Paligo opens the content in the Editor.

  2. Select the Edit tab in the toolbar.

  3. Select Edit source code. Edit_Source_Code_small.png

  4. Edit the source XML.

  5. Select Update to save the changes or Cancel to ignore the changes.


    Note that this does not save the topic, it just updates the content just as if you had made any regular edit directly in the main editor view.

    You can still undo any changes back in the main editor. The changes to the source code will be saved when you save the topic.

  6. Close the Source Code Editor with the X in the top right corner.

  7. Select Save. Save icon.

If you copy an element in the code editor and paste it in another place, you will by default get the text content as "Reuse text". The same as if you had used the Reuse text search feature or used the Copy as reuse keyboard shortcut.

If you do not want the text reused, this is one time where it can be useful to touch the xinfo:text attribute. To not have the text reused, simply remove the xinfo:text attributes:



If you do this, it only changes it on the copied element, not the original. Otherwise you will create a completely new text fragment for the original text as well. If you for example have translated it before, that translation will be lost.

By default, the Source Code Editor uses the Monokai theme, a dark theme easy on the eyes. It has a black background with cerise, green, yellow and white color-coding for the XML elements, attributes, values and text.

You can set the source code editor to use a different theme. For example, the Chrome theme has a white background with red, blue, cerise and black color-coding.

But you can use any of a number of themes for the look and feel of the Source Code Editor, whatever is more comfortable for you. Just click the cog wheel icon in the toolbar, and select Code Editor.

source code editor set to use the monokai theme. It has a black background with code in cerise, yellow, green and white.
source code editor set to use the chrome theme. It has a white background with code in cerise, blue, red and black.

To the left, the Monokai theme. To the right, the Chrome theme.

To change the theme for the source code editor:

  1. Select the Dotted menu ( ... ) for a topic in the Content Manager.

  2. Select Edit and choose Open in editor.

  3. Select Settings in the Toolbar. Cog icon.

  4. Select the Code editor tab.

    The editor settings dialog. It has general, editing, preview, code editor, and global settings tabs.
  5. Select a theme from the dropdown menu in the Theme for the code editor section.

    Code editor tab. In the theme for the code editor section, the dropdown menu has been selected to reveal a list of themes to choose from.
  6. Select Save Settings.

    The next time you open the source editor in the main editor, it will use the theme you have chosen.

Paligo is made for easy authoring and the Paligo Editor is normally the first choice for most editing. However, the focus on user-friendliness in Paligo also means that the Paligo editor is intentionally kept as uncluttered and easy to use as possible, and targets the most common editing functionality. If you find yourself needing to perform something that you cannot find a way to do in the Paligo editor, you have the option of using the Oxygen XML Editor.

. Recommended use of the Oxygen XML Editor
  • Publishing to web help if you want a different kind of HTML output than the default HTML or HTML5 Responsive Design, you have the option of publishing to web help in Oxygen. This is very similar to the traditional kind of "three-pane help" used in software. See Publish to Web Help from Oxygen XML Editor for more information.

  • Advanced XML editing if you need to manipulate the XML more directly than the Paligo editor is intended for.

  • Advanced imports of certain formats, read more in the Importing section.


Note that you will need an Oxygen license (3rd party) if you want to use it. The plugin for integration to Paligo is however included in your Paligo license.

Paligo supports integration with both Oxygen XML Author and Oxygen XML Editor. The difference between these is that both work for topic editing, but Oxygen XML Editor also works for development of XSLT and more.

If you have no need to do advanced XSLT development, Oxygen XML Author is more than enough, and you should choose that if you just need to use it to edit topics in Paligo offline.

Since both are supported, we use the terms interchangeably below.

  1. Download the Oxygen Author (the one with the red icon) from the Oxygen web site: Oxygen Author.


    If you are on Mac OS X, you should scroll down on the page and select the version that includes Java SE 8 or later, or click this link: Mac version for Java SE 8).

  2. Install the Oxygen Author by following the installation wizard.

  3. The first time you open Oxygen Author you will get the option to register it.

    If you haven't purchased it yet, you can get a trial license from Oxygen.

  1. Start Oxygen XML Editor.

  2. Go to Help - Install new add-ons...

  3. Paste the url in the field Show add-ons from:

  4. The Paligo plugin and the Configuration add-on will appear. Check the boxes next to these two installations.

  5. Check the box to accept the License Agreement, and click Finish.

  6. A panel called Content Manager should have appeared on the left. If it doesn't, go to Window - Show view - Content Manager.

  7. Restart Oxygen.

When running the plugin for the first time, the Content Manager panel will ask you for hostname, username, and password. Do the following:

  1. Type in as the hostname (no https://), your username and your password. (Of course, replace the companyname part with your actual domain name, usually the same as your company name.

  2. Click Test (Connection succeeded should appear).

  3. Click Save to save the plugin configuration. Nothing appears to happen, but the configuration will be saved.

  4. Restart Oxygen.


When you restart, if the Content Manager view isn't open, open it by Window - Show View - Content Manager. It will show you a view similar to the Content Manager in the Paligo web interface.

  1. Start the Oxygen client on your computer. Make sure you have already installed the Oxygen Paligo plugin.

  2. If it's not already open, open the Content Manager view under Window > Show View > Content Manager.

  3. Browse to the folder and the topic that you want to open, and double-click to open it.

    Oxygen XML Editor
  4. After you are done editing, save the topic and close it. If you need to check it in, go to Paligo to do so.

Besides opening and editing Paligo topics in Oxygen, you can also browse, preview, and insert images in topics, right from your Paligo image library.

To browse for images in the Paligo image library, simply use the file browser and preview any image by double-clicking it:


To insert images, do as follows:

  1. Open a Paligo topic in Oxygen, using the Paligo file browser.

  2. Put the cursor in a valid position where you want the image.

  3. Click the image icon in the toolbar: ImageIcon.png

  4. In the image dialog, you will see that Paligo is available as a place to find images. Click to select the image.


    Note that you must select the image from the Paligo library. Local hard drive images will not work, and if you have local images you want to use, you need to upload them to Paligo first.

  5. Select the image you want from the Paligo library.

  6. The image will be inserted as a figure element. If you just want a mediaobject, just select the mediaobject element and drag it to where you want it outside of the figure element, and then delete the figure element.

  7. Set the width for the element using the Attributes view.


If you have content in Word, Excel or HTML, you can easily get it into a Paligo topic by opening the topic in Oxygen XML Author, using the Paligo plugin file browser.

This can be quite convenient, especially if you have long tables or Excel sheets that you want to turn into tables in a topic.


Please note that this procedure presumes you have Oxygen XML Author client, and that you have the Paligo plugin installed for it. 

  1. Open a Paligo topic in Oxygen using the file browser.

  2. Open the Word or Excel document, or open a web page in a browser.

  3. Copy the content you want to insert in your topic.

  4. Paste it anywhere it would be valid, e.g directly inside a section element. If it's not a valid position, Oxygen will alert you to this, and give you the option to insert it in a valid position.

Your content will automatically be converted to the correct XML structure, and you can save the topic to Paligo.


To create a very modern type of web help in HTML5, you can publish directly to that just using the HTML5 format available directly in the publishing dialog. The below alternative is just an option in case you prefer more traditional 3-pane format in standard XHTML.

Using the Oxygen XML Editor, you can create standard XHTML web help output. The first time you do this, you may want to customize the output a bit. Although this can get a bit technical, this is something you normally only have to do once, and if you follow the instructions here it should not be a problem. If you do need help, please contact support and we'll walk you through it.

  1. Start by publishing to XML.

  2. Download the finished result, and go to the folder. Open the Publication XML file (It will have publication in its name) in Oxygen XML Editor. You need to have this file open before you can do the next step.

  3. Create a Transformation Scenario:

    Either use the toolbar:


    Or the menu:

  4. The Transformation Scenario dialog opens. We will use the DocBook webhelp scenario (since Paligo exports to DocBook format). Create a duplicate by clicking Duplicate.

  5. A new dialog is opened for your new scenario. Give it any suitable name you wish ("WebHelp - Paligo" e.g.

  6. If you want to customize the styling of your web help, do the following:

    1. Select the tab <emphasis xmlns="">Parameters</emphasis>. Then type "css" in the filter text field. That will narrow down the choice of parameters.

    2. Select the one called html.stylesheet. Double-click the Value field.

    3. Type the full path, or browse to the custom css file you want to use. There is an example css with some basic customization in the Getting Started area of the Paligo support site.

  7. Click Ok, make sure your new scenario is checked, and then Save and close.

  8. Run the publishing process (Transformation Scenario) by clicking the little "play" button in the toolbar, or select Document > Transformation > Apply Transformation Scenario(s)...


    Next time you need to transform to web help, you just need to publish to XML from Paligo as in step 1, and then select your saved scenario and run the publishing directly.

Your content is automatically validated by Paligo before it is saved to the database. You can turn this feature on and off, see Turn Validation On or Off. It is also possible to validate the content manually, see Validate Content Manually.

If your content have broken any of the Validation Rules, Paligo displays an error message and adds a red highlight to the element. The Validation Panel provides information about the error to help you solve it, see Invalid Content.