Reuse content
Write something once and use it in many places: variables for short text, templates for new topics, and linked topics for whole pages.
Sonat has three ways to reuse content. Pick by how much you want to reuse:
| You want to reuse | Use | Stays in sync? |
|---|---|---|
| A word or phrase, such as a product name, version number or support email | Variables | Yes. Change it once and every topic shows the new value. |
| A starting structure for new topics | Topic templates | No. Each new topic gets its own copy to edit. |
| A whole topic in several documents | Linked topics | Yes. Every document shows the same topic. |
Variables
Create a variable
- In the left menu, select Variables.
- Select New variable.
- Enter a Title you'll recognize, for example Product name.
- Enter the Value: the text readers will see, for example Acme Router X2.
- Select Save.
Sonat gives each variable a code made from its title, such as {{product-name}}. The code stays the same even if you rename the variable later.

Insert a variable in a topic
- In a Rich Text topic, click where the text should appear.
- Select Variable in the toolbar.
- In Insert variable, search for the variable, check its value under Preview, and select Insert.
You can also type or paste the variable's code, such as {{product-name}}, into the topic. It turns into the variable. On the Variables page, select Copy next to the code to copy it.
Variables work in Design Canvas and Whiteboard topics too. Use the Variable button in their toolbar.
Change or delete a variable
- To change the value everywhere, open Variables, select the variable, edit the Value and select Save. Every topic that uses it shows the new value.
- To delete it, select the variable and choose Delete. Topics that use it show nothing in its place, so remove it from those topics first.
Topic templates
A template is a published standalone topic (a topic outside any document) that you mark as a template. New topics can start as a copy of it. This needs the Topic Templates addon. See Addons.
Make a template
- On Home, create a topic outside any document and write the structure you want to reuse, for example headings for Overview, Steps and Troubleshooting.
- Publish it.
- Go to Organization Settings and open the Topic Templates tab.
- Turn on the switch next to the topic. It's now marked Template.
Start a topic from a template
- On Home, open the create menu and pick a topic type, for example Rich Text.
- In the New topic dialog, under Start from, pick the template. Pick Blank to start empty.
- Enter a Title and select Create topic.
Only templates of the same topic type appear. Changes to the template later don't affect topics already created from it.

Linked topics
A linked topic shows the same standalone topic inside a document. Link one topic, such as a safety notice or a contact page, into every manual that needs it. When you edit the original, every document shows the change.
Link a topic into a document
- Open the document.
- Select the arrow next to New, then Link Existing Topic.
- Search for the standalone topic and select it. It appears in the topic tree as a shortcut.
- Move it to the right spot in the tree, then publish it.

Edit a linked topic
The content of a linked topic is read-only inside the document. Open its menu and select Go to source to edit the original. When you publish the original, every document that links it shows the update.
To see where a topic is linked, open the original and check the Shortcuts tab in the side panel. With the Linked Topics Matrix addon, you can see every link across your organization in one table. See Linked topics matrix.
If something goes wrong
Typing a variable's code doesn't turn it into a variable
Check the spelling against the code on the Variables page. Codes that don't match an existing variable stay as plain text.
My template doesn't show under Start from
Check that the template is published, that its switch is on in Topic Templates, and that you're creating the same topic type as the template.
Link Existing Topic shows "No standalone topics found"
Only topics created outside a document can be linked. Create the topic from Home first.