Getting Started

Editor Toolbar and keyboard shortcuts

This section describes the toolbar commands and keyboard shortcuts available in the editor.

The toolbar

The toolbar is divided into several tabs with groups of commands:

Edit
toolbar-edit.png
Insert
toolbar-insert.png
Preview
toolbar-preview.png

Each of these are referenced in the table below together with their keyboard shortcuts (if applicable).

Keyboard Shortcut Quick Reference

Paligo has many keyboard shortcuts to make working with structured content as fast and efficient as possible. The action of a key combination depends on the context, as described below.

Tip

Also check out this video for using keyboard shortcuts and working with lists easily:

Toolbar icon

Action

Mac

Windows

Context/Description

Edit tab

1

Insert a new para element

Option ⌥ P

Alt P

Where para is available to select

N/A

New para, new step, etc.

Enter

Enter

At the end of a paragraph, a procedure step, or a list item, creates a new element of the same kind.

For example if the cursor is at the end of a paragraph element, Enter creates a new paragraph, but in a list item or step it creates new list items or steps. You can also split the text in a paragraph or list by placing the cursor in the middle of the text.

At the end of titles (or bridgehead), a new para is created.

2

Toggle title on figures, tables, examples.

Option ⌥ Shift ⇧ H

Alt Shift H

On figure/informalfigure, table/informaltable, example/informalexample.

Note

Note that this also automatically converts the element to the proper one. E.g a figure becomes an informalfigure if you toggle to remove the title and vice versa.

3

Toggle bold text.

Command ⌘ B

Ctrl B

With text selected.

4

Toggle italic text.

Command ⌘ I

Ctrl I

With text selected

5

Toggle underlined text.id

Command ⌘ U

Ctrl U

With text selected

6

Superscript

N/A

N/A

Raise the selected text

7

Subscript

N/A

N/A

Lower the selected text

8

Create (or convert to) an itemizedlist

Option ⌥ L

Alt L

Depending on the context:

  1. Where itemizedlist is valid: Creates a new itemizedlist.

  2. With a list of any other type selected: Converts to an itemizedlist.

  3. Inside a separate para: Converts to an itemizedlist (the para becomes a listitem).

    The cursor will automatically move to a subsequent para if there is one, so you can easily turn a number of paragraphs into an itemizedlist.

9

Create (or convert to) an orderedlist

Option ⌥ Shift ⇧ L

Alt Shift L

Depending on the context:

  1. Where orderedlist is valid: Creates a new orderedlist.

  2. With a list of any other type selected: Converts to a orderedlist.

  3. Inside a separate para: Converts to an orderedlist (the para becomes a listitem).

    The cursor will automatically move to a subsequent para if there is one, so you can easily turn a number of paragraphs into an orderedlist.

10

Create (or convert to) a procedure.

Option ⌥ Shift ⇧ P

Alt Shift P

Depending on the context:

  1. Where procedure is valid: Creates a new procedure.

  2. With a list of any other type selected: Converts to a procedure.

  3. Inside a separate para: Converts to a procedure (the para becomes a step).

    The cursor will automatically move to a subsequent para if there is one, so you can easily turn a number of paragraphs into a procedure.

11

Split list

N/A

N/A

Splits a list in two lists of the same kind.

12

Merge list

N/A

N/A

Merges one list into the next one.

13

Indent the listitem or step

Option ⌥ T

Alt T

In a listitem of an itemizedlist or orderedlist, or in a step in a procedure

14

Outdent the nested list (of any of the named types)

Option ⌥ Shift ⇧ T

Alt Shift T

In a nested itemizedlist or orderedlist, or in a nested procedure or substeps

15

Remove formatting/inline tags.

Option ⌥ Shift ⇧ F

Alt Shift F

Inside an inline element. Will remove common inline formatting tags like bold and italic, but also any other inline tag available.

16

Copy "formatting" (inline element but without content)

Option ⌥ Control ^ C

Alt Ctrl C

This is a function similar to a "format painter" in word processors, but copies the inline element without its text content, so that it can be pasted onto another text string.

N/A

Paste "formatting" (inline element but without content)

Option ⌥ Control ^ V

Alt Ctrl V

Paste (or "paint") the format/inline element copied with the command above.

17

Edit Source Code

N/A

N/A

Open the Source Code Editor to edit the XML directly.

18

Allow contributors to edit topic

N/A

N/A

The Markdown editor is intended for drafting new content only. But if you want a Contributor to edit content you have pre-prepared in the main editor, you need to enable the topic for editing in the Markdown editor.

Insert tab

19

Insert a table.

Option ⌥ Shift ⇧ A

Alt Shift A

Where a table or informaltable is valid.

The toolbar icon opens a menu with table editing choices as well.

20

Reuse a component.

Option ⌥ Shift ⇧ R

Alt Shift R

Where the type of component is valid (e.g a section, warning, etc).

You can reuse other topics, informaltopics, admonitions, and more inside a topic.

21

Insert a cross-reference or other link.

Option ⌥ R

Alt R

Current text element where cross-reference is allowed.

The keyboard shortcut opens the cross-reference dialog. The toolbar menu also has options for links to external web sites and email links.

22

Insert a variable.

Option ⌥ Shift ⇧ I

Alt Shift I

Where the type of variable is valid.

23

Insert an image.

Option ⌥ I

Alt I

Where image or inlineimage is available to select

If the cursor is inside a text element, such as a para or a title, an inlineimage will be inserted.

23

Insert a side-by-side image

Option ⌥ J

Alt J

For inserting images side by side. The feature is responsive for HTML5, so if on a smaller screen the images will stack vertically to fit.

23

Convert image to thumbnail

Option ⌥ Shift ⇧ Q

Alt Shift Q

With imagedata selected (clicking on the image itself).

24

Insert a video

N/A

N/A

Where a video is valid.

25

Insert character

N/A

N/A

Inserts a special character from a character map inside text elements.

26

Insert (or convert to) a note.

Option ⌥ Shift ⇧ N

Alt Shift N

Where a note is valid.

Converts the admonition if another admonition type element is selected.

26

Insert (or convert to) a warning.

Option ⌥ Shift W

Alt Shift W

Where a warning is valid.

Converts the admonition if another admonition type element is selected.

26

Insert (or convert to) a caution.

Option ⌥ Shift ⇧ C

Alt Shift C

Where a caution is valid.

Converts the admonition if another admonition type element is selected.

26

Insert (or convert to) a tip.

Command ⌘ Option ⌥ T

Ctrl Alt T

Where a tip is valid.

Converts the admonition if another admonition type element is selected.

Preview tab

27

Preview PDF

N/A

N/A

Preview a PDF of the currently open topic.

You can select to use your own layout when previewing content, in the Editor settings.

28

Preview plain HTML

N/A

N/A

Preview a plain (X)HTML version of the currently open topic.

You can select to use your own layout when previewing content, in the Editor settings.

29

Preview HTML5

N/A

N/A

Preview an HTML5 version of the currently open topic.

You can select to use your own layout when previewing content, in the Editor settings.

30

Profile settings

N/A

N/A

Set profile filter and variable settings to view the effect of these directly in the editor. 

These settings will also be used when previewing in different output formats.

Other commands

N/A

Toggle guilabel tag.

Option ⌥ G

Alt G

Element guilabel, commonly used for highlighting UI components when documenting software.

N/A

Toggle keycap tag.

Option ⌥ K

Alt K

Element keycap, commonly used for indicating keyboard key combinations (like the ones in this topic).

N/A

Show the Element list. to insert elements.

Command ⌘ Enter or

Option ⌥ Enter

Alt Enter

Valid anywhere in the topic. This is the main command for viewing all available elements at a certain position in your document.

N/A

Move from one cell to the next in a table.

Tab

Tab

In tables

N/A

Navigate between elements.

Anywhere

Top ribbon

Save the topic.

Command ⌘ S

Ctrl S

Anywhere

N/A

Undo the last action.

Command ⌘ Z

Ctrl Z

Anywhere

N/A

Redo the last action.

Command ⌘ Y

Ctrl Y

Anywhere

The Element Structure Menu

Copy element.

Option ⌥ C

Alt C

Copies the current element the cursor is in.

The Element Structure Menu

Cut element.

Option ⌥ X

Alt X

Cuts the current element the cursor is in.

The Element Structure Menu

Paste element.

Option ⌥ V

Alt V

Pastes a copied or cut element in the current element the cursor is in.

The Element Structure Menu

Paste element as reuse.

Option ⌥ Shift ⇧ V

Alt Shift V

Pastes a copied or cut element in the current element the cursor is in, reusing any text fragment(s) in the element.

The Table context menu (right-click in table)

Insert column right

Option ⌥ Control ^ 

Alt Ctrl 

Inserts a new column to the right of the column where the cursor is.

See also Editing Tables.

The Table context menu (right-click in table)

Insert row after

Option ⌥ Control ^ 

Alt Ctrl 

Inserts a new row after the row where the cursor is.

See also Editing Tables.

The Table context menu (right-click in table)

Merge the selected cells in a table.

Option ⌥ M

Alt M

In a table, with multiple table cells selected using the Shift key

See also Editing Tables.

The Table context menu (right-click in table)

Split the cell into two cells.

Option ⌥ Shift ⇧ M

Alt Shift M

In a table, with cursor in previously merged table cell

See also Editing Tables.

N/A

Deletes the element where the cursor is

Option ⌥ Shift ⇧ D

Alt Shift D

With any element

Note

This is a very convenient shortcut to quickly delete an element, but use with caution, and make sure to check the Structure menu to see that the current element is the one you want to delete.

The Element Structure Menu or the Table context menu (for moving table rows)

Move current element down.

Option ⌥ Shift ⇧

Alt Shift

Current element

Note

When moving a table row with the Table context menu, the cursor can be anywhere inside the table cell, within a para, for example.

But when using the keyboard shortcut, the cursor should be directly inside the table cell element (td).

The Element Structure Menu or the Table context menu (for moving table rows)

Move current element up.

Option ⌥ Shift ⇧

Alt Shift

Current element

Note

When moving a table row with the Table context menu, the cursor can be anywhere inside the table cell, within a para, for example.

But when using the keyboard shortcut, the cursor should be directly inside the table cell element (td).

N/A

Insert a programlisting or code element

Option ⌥ .

Alt .

If your cursor location is where a block element is valid, a programlisting will be inserted. If it's inside text, like a para, an inline code element will be inserted.

N/A

Insert a tag (e.g the name of an HTML or XML tag)

Option ⌥ E

Alt E

In a text element, such as a para.

N/A

Convert section to accordion

Option ⌥ Shift ⇧ Y

Alt Shift Y

With a section or sidebar selected.

N/A

Convert bridgehead to a section, nesting the content after the bridgehead in the new section.

Control ^Option ⌥ Shift ⇧ W

CtrlAlt Shift W

With a bridgehead selected.

Note

Internal section elements in a topic must always come last. I.e there must not be other bridgeheads or para elements or similar content after a section.

So when converting, consider this, and for example if you have several bridgheads to convert, start with the last one.

Default click behavior for topics and publications

Clicking on topics or publications will cause different views to open:

  1. Clicking a topic opens it in the Editor, since you are most likely to want to edit a topic most of the time.

  2. Clicking a publication opens it in the Structure View, since it is generally a much more common task to build a publication by reusing topics in it in the Structure View, rather than edit it in the editor.

If you need to open a topic in the Structure View, or a publication in the Editor, you always have the commands in the context menu of the Content Manager.

Note

Many of the keyboard shortcuts apply to the "current" or "selected" element, i.e the one the cursor is located in.

You can check what the current element is in the Structure Menu at the top of the editor. The last element in the hierarchical path is the current element:

StructureMenuList.png

Search results

    No results found