Writerside Help

Reuse a single topic

To reuse a single topic, add it as the toc-element to your tree. You can either do it through the UI or manually edit the .tree file of your help instance.

Add through the UI

  1. In the Table of Contents area of the Writerside tool window, select the node you want to add the new topic and click Add or press Alt+Insert.

    TOC with a place chosen for the new topic
  2. In a popup, click Link Topic Files to TOC to reuse the topic from other instances.

    Reuse from another instance

    Then select an element you want to include. If the selected toc-element does not have an include-id attribute, you will be asked to specify it.

    The topic appears in the TOC. Double-click it to open in the editor.

Add manually

  1. In the Table of Contents area of the Writerside tool window, select the node you want to add the new topic, right-click, and select Go to TOC Element in <instance-id>.tree.

  2. In the editor, you can see the .tree file of your project. By default, the cursor is on the line with the toc-element tag you selected in the previous step.

    <toc-element topic="Getting_Started.topic"> <toc-element topic="Installation.topic"/> <toc-element topic="Setting_up.topic"/> ...

    On the next line, add a toc-element tag referring to the existing topic file.

    For example, to add New_topic.topic, enter the following code:

    <toc-element topic="New-topic.topic"/>

    To include Some_topic.topic from another instance, first add the include-id attribute to the toc-element in the target instance:

    <toc-element topic="Some-topic.topic" include-id="some-topic"/>

    Then use the following code in the .tree file:

    <include from="cd" target="some-topic"/>

    In from attribute specify the instance id, in target — the include-id of the target topic.

    The topic appears in the Writerside tool window in the Table of Contents.

Last modified: 19 April 2024