ClickHelp Documentation

Merging Lists Using Snippets


ClickHelp offers a feature for convenient merging of several lists into one using snippets. Read more on working with snippets here.

The approach works for both numbered and bulleted lists.

This feature is really helpful when, for example, you have some default set of steps that you repeatedly use in your instructions. The method described below takes care of auto-numbering - the inserted steps will be recognized as part of the list they are inserted into and numbered accordingly.

Merging Lists in a Help Topic

Follow these steps to merge lists using a snippet:

  • Create a topic to store the list that you are going to insert as a snippet to other lists.

    Its HTML code should look somewhat like this:
    <li>Snippet Item</li>
    <li>Snippet Item</li>
    <li>Snippet Item</li>
    Information Note: the snippet should contain nothing but the list itself.
  • Open the help topic with the list where you want the snippet inserted.

  • Create an empty list item after the number where you want to insert the snippet list.

  • Find the Topic title or URL field in the Snippets section on the Single-Sourcing tab.

  • Select the name of the list snippet topic in the field from the drop-down box, then click Insert Snippet.

  • The snippet will be inserted into the list.

  • Click Unlock & View to check how the list will look in the topic, and see how auto numbering works.

Information The <li> container (target list item), where you insert a Snippet to, should be empty - it can only have the <br/> tag or empty <p> tags inside. 
<li>Main List Item</li>
<li><ch:snippet .../>
<li>Main List Item</li>
<li>Main List Item</li>

This is how you can insert some list items that get repeated multiple times in your help topics into other lists with the help of snippets.