Working with the Element Context Menu

The element context menu is one of the features of the Paligo editor. It is a pop-up menu that you can access when you are creating or editing a topic and it provides access to the various Paligo XML elements that you can use.

Display the Element Context Menu

To display the element context menu:

  1. Edit a topic and select the position where you want to add the new element.

  2. Use a keyboard shortcut to display the element context menu:

    • Press Alt and Enter (Windows)

    • Press Option ⌥ and Enter (Mac).

Paligo displays the element context menu. It contains a list of the elements that are valid at the current position.

A topic in the Paligo editor. The element context menu is displayed and has a search at the top followed by a list of elements that are valid at the selected position.

By default, the element context menu has two sections: a section that contains commonly used elements and a section that contains all of the other valid elements. It also has a search feature at the top, so that you can search for an element by name.

You can mark elements as your favorites and these are shown in a "favorites" section. The "favorites" section is only shown if you have set up your favorites (see Mark Elements as Favorites for the Element Structure Menu).

Mark Elements as Favorites for the Element Structure Menu

If you use certain elements a lot, you can add them as favorites and make them easier to access on the element structure menu. Any element that you mark as a favorite is shown with a black star next to its name, in a section at the top of the element context menu. It appears above the "commonly used elements" section and the section for all of the other elements.

element-context-menu-favorites-at-top.png

To mark elements as your favorites:

  1. Edit a topic and position the cursor at the position where your favorite element could appear.

  2. Display the Element Context Menu.

    To access the element context menu, press Alt and Enter (Windows) or Option ⌥ and Enter (Mac).

  3. Find the element of interest and position the cursor over it to reveal a star icon. Select the star icon to change its status:

    Element context menu showing a search for elements beginning with gui. The guilabel element is selected and it has a black star next to it.
    • Set the star to black to add the element to your favorites

    • Set the star to clear to remove the element from your favorites.

  4. Close the element context menu.

  5. Display the element context menu again and the favorites section updates with your choices.

    Element context menu. It has a favorites section at the top containing the guilabel element. Below that, there is a list of commonly used elements. Below that is a list of all the other elements that are valid at this position.

Note

The favorites section can only contain elements that are valid at the position you have selected. You can set up different favorites for different positions in the structure. See the example for details.

Example 1. Different favorites for different structures

Let's say that you are going to use the guilabel element for UI names in your content. As you will be using it a lot, you want to add it to your element context menu favorites. To do that:

  1. Position the cursor inside a para element or any other element where guilabel is valid.

    Topic with a procedure. The cursor is positioned inside the text of a step. A callout arrow points at the position of the cursor.
  2. Display the element context menu.

  3. Search for guilabel.

    The element context menu is displayed. There is a search field at the top and the letters gui are being searched for. A list below shows the elements beginning with gui and guilabel is selected.
  4. Position the cursor on the guilabel option to display its favorites star.

    Element context menu showing a list of search results. The cursor is positioned over the guilabel option, revealing a star icon.
  5. Select the star so that it goes black.

    Element context menu showing a search for elements beginning with gui. The guilabel element is selected and it has a black star next to it.
  6. Close the element context menu and re-open it. Now the guilabel is shown at the top, in your favorites.

    Element context menu. It has a favorites section at the top containing the guilabel element. Below that, there is a list of commonly used elements. Below that is a list of all the other elements that are valid at this position.

You continue to work on your content. Every time you need to use the guilabel, you position the cursor in a valid position, access the element context menu, and select the guilabel from your favorites.

You then select a position between two paragraphs.

Topic in the Paligo editor. The cursor is at a position after a procedure, where a para element is valid. A callout arrow points to the position.

You access the element context menu and guilabel is not shown in your favorites. This is because guilabel is not valid at the selected position.

You decide to add the itemizedlist element as a favorite. The itemizedlist element is valid at the selected position. You access the element context menu, search for itemizedlist and set its favorite star to black.

Element context menu. A user has searched for item. The list shows itemized list as the only result. The itemized list option has a black star icon.

You then close and reopen the element context menu. It now shows the itemized list element in your favorites, as it is valid at the selected position.

itemizedlist-in-favorites.png

You select a word inside a para element and display the element context menu. The guilabel is shown in your favorites, as it is valid at the selected position. The itemizedlist favorite is not shown as it is not valid at the selected position.


Why is Element Missing from Element Context Menu?

The element context menu only shows elements that are valid at the currently selected position in the topic structure.

If the element you want is not included in the element context menu, make sure that you are selecting a valid position for that element. Typically, some elements are valid inside a structure, such as inside a paragraph or list, and others have to be a the top level, directly inside the section for the topic.

This also applies for any favorites you have set up. Paligo can show different favorites for different parts of a topic's structure. For details, see the example in Mark Elements as Favorites for the Element Structure Menu.