Template Fundamentals

In This Topic

Creating a New Custom Template

On the Tools Ribbon tab click the Options button.
In the Options editor select the Custom Templates Page Menu Item.
Click on the New toolbar button.
In the New Template dialog:
1. Select Topics \ Classic from the Base on combobox.
  The custom template will initially contain all of the files & settings of the template selected in the Base on combobox (this will also define which template type the custom template will be).
2. Enter New Topics Template for the Template Name.
3. Click OK.

After creating a new custom template you will need to assign it to the relevant template type in your Project's Build Profile.

Double click on the Build Profile in the Project Explorer.
Select the Template Page Menu Item.
Select your custom template from the relevant template type's Template combobox (in this example the "New Topics Template" for the Topics template type).

Creating and Editing a Page Type

This example uses the custom template created in the example above, though this example can be applied to any custom template.

On the Tools Ribbon tab click the Options button.
In the Options editor click on the Custom Templates Page Menu Item.
Select the New Topics Template from the template list and click the Edit toolbar button.
Select the Page Type Page Menu Item.
Click the New toolbar button.
In the New Page Type dialog:
1. Enter New Page Type.html for the New File Name.
2. Select the Create a new Page Type derived from option.
3. Select the "standard.html" Page Type from the combobox. ("standard.html is the default Page Type in the Topics template.
  If you are creating a custom Template for another documentation type, e.g. .NET documentiation, then you would choose the appropriate page type you want to use as the starting point for your new page type).
4. Click OK.
Select New Page Type.html in the Page Types list and click the Edit toolbar button.

A specific a Page Type can be selected for a given Topic from the Page Type combobox in the Properties window after selecting the Topic in the Project Explorer.

Add a new Phrase

This example uses the custom template created in the example above, though this example can be applied to any custom template.

On the Tools Ribbon tab click the Options button.
In the Options editor click on the Custom Templates Page Menu Item.
Select the New Topics Template from the template list and click the Edit toolbar button.
Select the Phrases Page Menu Item.
Click the New toolbar button.
At this point a new Phrase named NEW_PHRASE will be created and selected for editing.
Click the > button to the left of the Language label.
Enter New Phrase English in the Language: (English (United States)) field.
Enter New Phrase Dutch in the Language: (Dutch (Netherlands)) field.

Phrases can be inserted into a Page Type using the following DXMETADTA element:

Document! X and HelpStudio ships with 9 localized languages for the included Phrases. New Languages can be added by clicking on the Add Language button.

Add a new Scrap

This example uses the custom template created in the example above, though this example can be applied to any custom template.

On the Tools Ribbon tab click the Options button.
In the Options editor click on the Custom Templates Page Menu Item.
Select the New Topics Template from the template list and click the Edit toolbar button.
Select the Scraps Page Menu Item.
Click the New toolbar button.
At this point a new Scrap named _NEW_SCRAP will be created and selected for editing.
In the Content section of the new Scrap enter New Scrap Content

Scraps can be inserted into a Page Type using the following DXMETADTA element:

Send Feedback