Getting Started

Reusing Content within a Topic

There are several ways to reuse large or small chunks of content within a topic.

The Component button in the Insert tab in the Editor allows you to reuse whole chunks of content (components) within a topic. The inserted content may be of different kinds, it could be a whole topic (section), a paragraph (para), a procedure or, very commonly, a Safety Message.

Topics within Topics

Reusing an entire topic within another topic is an option to reusing it by nesting it in the Structure View. This may be useful either if you want to work on it as a larger whole, but first and foremost, because you intend it to come out as a whole in the output. In that case, you may also want to utilize the chunking features. See more in Chunking the size of your output topics.

Informaltopics - Reusing any element or a sequence of elements

There is also one component type that is very flexible for reusing any combination of content, the informaltopic. This is like a wrapper component that you can create for instance if you want to reuse a para and a procedure always together, or an image and a list, etc. You can then reuse that informaltopic within another topic.

So remember that you can use the Insert Component feature for all kinds of content you want to reuse within a topic, but we will use safety messages as an example here.

Reusing a range of steps or list items

If you have a few steps or listitems that you want to reuse in the middle of another procedure or list, you can do that too, using informaltopics: 

  1. Create an informaltopic.

  2. Add a procedure, itemizedlist or orderedlist, depending on what you need and where you are going to reuse it.

  3. On the list element in question (e.g the procedure element), add a role attribute with the value reuse-range.

  4. In the target topic where you want to reuse it, in a list element (as a direct child of the list element between any of the steps or listitems) of any of the above types, select Insert component and select the informaltopic you created.

  5. The list will now come out as one consecutive sequence of items, including the reused ones.

Reusing safety messages

Safety messages are special pieces of content (topics), such as warning, caution, danger  and note messages. They are often indicated by a special icon in technical documentation:

warning.png

Safety Message Icon

This type of content is often highly repetitive and therefore reusable. In Paligo, you can create a library of such safety messages and just reuse them wherever they are needed, without the need for copy and paste or unnecessary duplication.

Creating safety messages

  1. Create a safety message, just like you do any other component, but select one of the safety message types.

  2. Write the safety message, if necessary according to any writing guidelines you may have for such content (e.g adhering to the ANSI Z535 standard or the like).

Reusing the component in a topic

  1. When you have one or more safety messages, you can open a topic where you need it.

  2. In the Editor, under the Insert tab, click the Component icon ImportIcon.png.

  3. Search or browse for the safety message you want to reuse.

    reusecomponent.png

The safety message will be inserted and reused in your topic.

reusedcomponent.png

Note

  • When you have reused a component within a topic, and you view this topic or a publication in which it is reused in the Structure View, the internal component reuse will be indicated by a link icon:

    internalcomponentreuse.png
  • Make sure the component you reuse inside a topic is valid at that point. Because these elements are just wrapper elements, validation is only partial.

Convert Element to Reusable Component

If you have a section or admonition (note, warning, etc) directly inside a topic as regular elements, you can always convert them into separate reusable components later if you need to. Just click the element name in the Structure Menu:

createreusablecomponent.png

You will have the option to automatically reuse the new component in the same place where you had the element (which you would in most cases want).

Search results

    No results found