Getting Started with Paligo

Table of Contents

The Basics of Topic Editing

The Paligo editor is made to be as easy to use as possible, more or less like a word processor. But in fact it is an XML editor. The structure of the underlying XML is what enables a lot of the power for single-sourcing and reuse.

This means, that although Paligo does not clutter the interface with lots of XML tags, there is still a strict structure underneath the surface. So if you haven't authored in a structured environment before, you need to at least get used to the basic concepts of adding and using "elements". The following procedure shows you how to do that.

Note

Paligo's content model is based on DocBook, but a customized topic-based version of it. But even with the customization, it is close enough so you can in most cases refer to this reference for a list of the elements, and what they are used for: Element reference.

You can also check out this video showing the basics of editing topics:

In-context editing

Sometimes you may be working on topics in a specific publication (for example for a certain product), and may prefer to be able to browse it in context while editing the various topics. Paligo has a built-in way to do this in the Review view. It also doubles as an "In-context editing" feature. You can browse the publication and open each topic in the editor to work on using the Edit icon:

This allows you to see the full publication in one view, while being able to open each topic for editing from right there. See more in Review Navigation.

  1. In the Content manager, open a topic in one of the following ways:

    • Click on the topic name

    • Select Open in editor in the context menu of the topic

    The topic is opened in the editor.

  2. By default, you get a title (same as the topic name) and an empty paragraph (para element) to start with.

    Note

    Note that in most cases you should only have one title/heading in a topic. Subheadings are created automatically by the nesting when you build your publication structure in the Structure View. See Headings and Subheadings for more details on this.

  3. In the editor, place the cursor where you want to add content (insert an element) and do one of the following:

    • Use the toolbar icons to insert the type of content (element) you want.

    • Press Alt/Cmd+Enter to show a list of available elements (types of content) at that place.

      Tip

      Start typing to narrow down the list of elements. E.g if you start typing "par"... you will see the element para only, which will create a paragraph.

  4. To add a new element of the same kind that you just inserted, e.g a paragraph (para), listitem or step in a procedure, just press Enter.

    Tip

    See Shortcut Keys and Commands for more tips on speeding up your authoring in the editor.

  5. To delete an element:

    1. Place the cursor in the document element you want to delete.

    2. The Element structure menu (also called "breadcrumbs") at the top of the editor, shows hierarchic in which element you are. Place the cursor over the element name you want to delete and click to open a pop-up-menu.

    3. Place the cursor (without clicking) over the Delete menu item. Result: The element to be deleted is highlighted with yellow background and text that is crossed with red bars.

    4. Click Delete to delete the selected element.

  6. Use the Element structure menu in a similar way to manipulate your content with full control, for example:

    • Highlight elements in the Editor

    • Cut, copy and paste elements

    • Move elements up and down (needs to be elements on the same level in the structure)

Splitting elements

If you have started writing content into a para or a step, for example, and you want to turn that content into two separate elements, just place the cursor where you want to split the element, and press Enter. This splits the element into two elements of the same type. A paragraph for instance will then be split into two paragraphs at the place where you had the cursor.

Removing bold or italic

If you have used the bold or italic elements to format text, and you want to change it, simply place the cursor in the formatted text and click the Eraser icon, or use the keyboard shortcuts. You can also toggle the common ones just using the same shortcut again (like CtrlB to toggle bold)

Making comments in your topics

There are two ways to make comments in your topics:

  1. Use the Review widget, by either opening the editor in Distraction-free mode or clicking the Show comments speech bubble icon in the toolbar:

    This would be the recommended way of commenting if you want it to be part of the conversation with reviewers.

  2. Use the remark element. This is a type of comment that is part of the topic itself, not part of the review conversations. It will still not be output when you publish, but you can choose to do so by using a layout where you set it to be a draft.