Reuse Items in a List

In technical publications, it is quite common to have list items and steps that are repeated in various different topics. For example, if you are documenting software, it is likely that you will use a 'Save' step in lots of different procedures.

In Paligo, there are two different ways to reuse steps. You can use:

  • The reuse text feature for single list items or steps

  • An informal topic to reuse a sequence of list items or steps.

Note

If you want to reuse an entire list or procedure, add the list/procedure to an informal topic. You can then add the informal topic to other topics where appropriate.

To find out how to reuse items in lists, see the following sections.

If you only want to reuse a single item or step in a list, you can use the Reuse text feature. This works in the same way as reusing a text fragment.

The text in a step or list item is enclosed in a para element. For example, a step in a procedure looks like this: <step><para>The text for the step.</para></step>. So to reuse a single step, you should first create a new step, and then reuse a para element inside it.

To find out how to reuse a single step, watch the video or read the following instructions:

  1. Open the topic that you will insert the reused step into.

  2. Add an extra step for the list or procedure. You can add an extra step by clicking at the end of the previous step and pressing Enter. Alternatively, position the cursor at the appropriate position and use the Element Context Menu to add a new step or listitem element.

  3. Click in the para element that is created for the new step.

    create-extra-step.png
  4. In the Reuse text section, search for the text of the step/listitem that you want to reuse.

    reuse-text-list.png
  5. When Paligo finds the step/listitem, select it and choose the Reuse fragment option.

    reuse-fragment-list.png

    Paligo adds the text into the step.

    fragment-added-list.png

    The text is a reused fragment and is locked. If you want to edit it, you will need to unlock it, but be aware that any changes you make will apply wherever that text is used, not just in your topic.

If you want to reuse a sequence of items or steps in a list, you can add the sequence to an informal topic. You can then insert the informal topic inside a list in a regular topic. This is useful when you have multiple steps that are the same in many different topics.

Of course, you will also want to make sure that any numbering flows with the rest of the list. Paligo has a role attribute called reuse-range that makes this possible.

To find out how to reuse a sequence of steps in a list, watch the video or follow the instructions:

  1. Create an informal topic.

    To do this, select the options menu ( ... ) on a group folder, and select Create content. On the Create content dialog, give the informal topic a name, select the Informal topic option. Select the language you want to support and then select ok.

    informal-topic-list-create.png
  2. Open the informal topic in the editor and add the list or procedure steps you want to reuse in other topics. You can add a bullet list, number list, or procedure by using the toolbar icons in the Edit menu.

  3. In the Element Structure Menu, select the top-level element for the list (itemized list, orderedlist, or procedure, depending on the type of list). Select the Go to element option.

    informal-list-goto-element.png
  4. In the Element attributes section, add the role attribute and set its attribute value to reuse-range. This allows Paligo to apply the correct sequence of numbering before and after the informal topic.

    reuse-range.png
  5. Save the informal topic.

  6. Open the topic that contains the list you are going to add the sequence to.

  7. If the topic does not already contain the list or procedure, insert one.

  8. Position the cursor at the position where you want the steps in the informal topic to appear.

    The cursor position is very important, as if it is an incorrect position, the informal topic cannot be added.

    If you want the informal topic steps to appear between other steps in a list, position the cursor between the steps. Use the Element Structure Menu to make sure that the cursor position is at the top-level item for the list (itemized list, orderedlist, or procedure, depending on the type of list).

    insert-inside-list.png

    If you want the informal topic steps to appear at the start or end of an existing list, position the cursor above the first step or below the last step. Use the Element Structure Menu to make sure that the cursor position is at the top-level item for the list (itemized list, orderedlist, or procedure, depending on the type of list).

    insert-top-of-list.png
  9. Select Insert > Component and browse to the informal topic.

    Paligo adds the informal topic at the selected position (as long as you selected a valid position in step 8). The numbers of the steps in the informal topic adjust to fit in with the sequence of numbers in the existing list. If you add steps before or after the informal topic, they will also continue the correct numbering sequence.