Doc-O-Matic - Documentation Web Help

You are here: What's New in V6 > Snippets

Doc-O-Matic 6

Snippets

Doc-O-Matic 6 provides a new method for including information from other sources in your topics: documentation snippets. Using snippets you can reuse sentences, paragraphs, sections or whole topic text in your documentation. In addition, you can insert a snippet in all topics in your documentation. You can use this feature to label topics in a pre-release.

To insert snippets

Do one of the following:
- Click Snippet .
- Right-click, and then point to InsertSnippet .
- Click Menu , and then point to InsertSnippet .
- Enter CTRL+ALT+<SPACE>.
In the Snippet list, select the snippet you want to insert.
When building your documentation the content of the snippet is inserted in your topic.

To add snippets to your project

Click Snippet .
In the Add Files to the project dialog box, find the folder that contains the snippet that you want to add to your project.
Select the documentation snippet that you want to add, and then click OK.
All snippets are displayed in the Templates, Snippets & Special Topics Folder at the bottom of the topic hierarchy on the left side of your screen and in the snippet list.

To insert snippets in all topics

On the Views Bar, click Settings.
Click the General Settings tab.
Select DocumentationAutomatic Text.
Click , and then browse for the documentation snippet that you want to include in all topics.

To create a new snippet

On the Content Manager menu, click the New Topic arrow.
Select New Snippet.
In the Editor click Save .
In the Add Files to the project dialog box, find the folder where you want to save your new snippet to.
In the Name box enter a name for your snippet and save it.
All snippets are displayed in the Templates, Snippets & Special Topics Folder at the bottom of the topic hierarchy on the left side of your screen and in the snippet list.