HotDocs Toolbar Buttons

Since HotDocs works inside your word processor, you use word processor commands for many basic tasks, such as typing text in the template, assigning font attributes and page formatting, and printing. Tasks that are specific to HotDocs are performed by using the HotDocs buttons. To access these buttons in Word, click the HotDocs tab on the Word ribbon. Using the drop-down menu below the HotDocs button on the tool bar you can access more options.

HotDocs Tab

Button Name Description
HotDocs
Either starts HotDocs and opens the HotDocs library window, or brings it to the front if it is already open. (This button is always in the word processor toolbar, regardless of whether HotDocs is running.)
Save Template and Component File
Saves the template and component file you are currently editing.
Save and Close Template
Saves and closes the template and component file you are currently editing.
Test Assemble
Test assembles the document or a selected portion of the document.
Variable Field Opens the Variable Field dialog box where you can select the type of variable field you want to create and insert. If the cursor is in a variable reference, HotDocs opens the Variable Field dialog box with that information already appearing.
IF Field
Opens the IF Field dialog box where you can create a true/false test for conditional text. If you need a more complex test, click IF Expression at the IF Field dialog box.
REPEAT Field Opens the REPEAT Field dialog box where you can specify a dialog to gather information for a list. At this dialog box, you can also specify a sort order, filter, and format for merging the list of answers into the document. You can also REPEAT a database component.
INSERT Field
Opens the INSERT Field dialog box where you can choose to insert a clause, clause library, or template. You can also convert a selected section of template text into an inserted template or clause component.
ASK Field
Opens the ASK Field dialog box where you can create and insert an ASK instruction in the template. An ASK instruction causes either a dialog or a database to be asked at a specific place in the template.
Other Fields
Opens the Other Field dialog box where you can choose to insert an ASSEMBLE, PLAY, LANGUAGE, DEBUG, or SPAN field. The options will change depending which of these four options you select. Clicking on the drop-down menu button next to the Other Fields button will display a list of options. Clicking on the drop-down menu you can select Other Field, or from a list of Dot Codes. See the table below for more information on Dot Codes.
Edit Component
Opens the Component Editor where you can modify the properties of an existing component. (If your cursor is outside a component field, HotDocs will allow you to create a new component. However, if you create a new component, it will only be saved to the component file—it will not be inserted into the template.)
Component Manager
Opens the Component Manager window where you can create, edit, delete, rename, and copy components.
Create Markup
Opens a Markup document in a new window. This document can then be saved and distributed to non-HotDocs users who needs access to the template. You will notice the HotDocs tab has changed to show the HotDocs Markup Tools only.
Clause Library
Opens a clause library where you can create new clauses or add existing clauses.
HotDocs Help
Displays the HotDocs Help viewer, which contains information on automating templates and assembling documents.
Apply Colors
Assigns custom colors to the different field types in the template. This can help you more quickly identify sections or parts of your template as you are automating. (You can choose the colors at HotDocs Options.)
Label Fields
Opens the Label Fields dialog box where you can choose to label matching IF and END IF instructions, REPEAT and END REPEAT instructions, and SPAN and END SPAN instructions. Additionally, where you've nested these instructions, you can identify the level of nesting. Finally, you can assign the word processor's hidden text property to these comments and labels so that you can show and hide them during automation.
Match Fields
Moves your cursor between opening IF, REPEAT, and SPAN instructions and closing END IF, END REPEAT, and END SPAN instructions. This can help you troubleshoot problems where one of the instructions is accidentally moved or deleted.
Go to Field
Moves you cursor to a specific variable or instruction field in the template. This can be useful when you receive errors and need to quickly locate the field in the template containing the error.
Previous Field / Next Field
/
Allows you to navigate through the template, field by field. This may be useful if you have several pages in a template without any variable fields—navigating by fields allows you to skip these pages, rather than scrolling through them until you find the next field.

HotDocs buttons not on the Word Ribbon

HotDocs buttons not available on the Word Ribbon can be accessed from the drop-down menu below the HotDocs button. They are:

Button Name Description
Dot Codes Under the Dot Codes heading, you can select from four sections: Character Format, Character Insertion, Sentence Punctuation, and List Punctuation. Clicking on any of the options within those sections will insert the corresponding dot code into the template.
Markup View / Developer View
/
Switches the look of the template between Markup View and Developer View. Markup View provides a simpler view of the template (which can then be saved and shared with a non-HotDocs user who needs to review the content of the template, for example). Developer View is the mode in which you automate the template.

Switching between Markup and Developer Views is only supported for RTF templates.

HotDocs Outliner
Opens the HotDocs Outliner so you can review an outline of scripting (and variables) used in the template.

You should always use the HotDocs Save and Save and Close buttons to save and close a template rather than the word processor's buttons. The HotDocs buttons ensure the template and component files are properly saved and closed.

If Word opens to the default HOME tab, click on the HotDocs tab to start using HotDocs commands.