HotDocs Glossary of Terms

This glossary contains template development terms as well as document assembly terms. To view a definition for a specific term, click a letter to jump to that section of the glossary.

A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z

A

.ANS

File name extension that designates that the file is a HotDocs answer file. Starting with the release of HotDocs 2009, all answers files (even those with the .ANS file name extension) are saved in XML format. The .ANS file name extension is retained to ensure backwards compatibility with HotDocs 2008.

.ANX

File name extension that designates a HotDocs answer file.

accelerator

A key or key combination that quickly performs routine tasks in HotDocs. For example, rather than click the Print button, a user can press Ctrl+P and the document will be printed. Accelerators are useful when users don't want to use the mouse.

addendum

The last section of a form document that contains answers that don't fit in their allotted fields on the actual form. (See also overflow.)

additional text

See dialog element.

ADO

Short for ActiveX Data Objects, it's a data presentation layer that lets HotDocs communicate with a database so HotDocs can retrieve data from it and use it to assemble a document. (See also ODBC.)

answer

Data users enter during an interview. Answers are usually merged into the document, but sometimes they are used to calculate other answers that are used in the document.

answer file

A saved file that contains the answers entered during an interview. Often users save their answers in a file so they can use them to assemble other similar documents.

Answer File Manager

The library used to manage answer files. With Answer File Manager, users can group answer files, view histories of their usage, and so forth. (The alternative is using Windows Explorer to find, view, and use answer files.)

answer library

See library and Answer File Manager.

answer management

The system of using Answer File Manager to store and manage answer files. (The alternative is using Windows Explorer to find, view, and use answer files.)

answer sharing

The process of creating and using same-named variables in multiple templates so that a user can use the same answer file to assemble multiple documents. (Can also be called variable flow-through.)

Answer Summary

A brief report HotDocs generates that lists the questions asked during an interview, followed by the answers that were entered. (See also Question Summary.)

answer wizard

A button attached to a form field that users can click during direct-fill assembly. When they click this button (Answer Wizard), a pop-up interview appears, asking one or more questions that are required in order for an answer to be merged in the field. Frequently, answer wizards are assigned to inactive fields in a form.

ascend

The process of sorting answers in alphanumeric order, from 1 to 9, and from A to Z. (See also descend.) You can also sort items in a template library, clause library, and answer library.

ASK instruction

An instruction that forces a dialog to be asked at a specific location in the script or template. Frequently, ASK instructions are used when creating an interview component. They allow developers to control the order in which dialogs are asked during the interview.

assemble, assembly

See document assembly.

Assembly Queue

A dialog box that shows a list of assemblies—pending, current, and completed. Users can open the Assembly Queue by clicking its button (Assembly Queue) in the assembly window toolbar. It is most useful when users have selected multiple templates for assembly.

assembly window

The window that appears when a user selects a template to assemble. By default, it includes the Interview tab, the Document tab, the Question Summary tab, and Answer Summary tab. Each of these tabs displays something unique about the document being assembled, such as the questions that are required to customize the document or the assembled document itself.

auto-assemble file

A self-executable file that contains one or more templates and their related files. When packaged in an auto-assemble file (or HDA), the files are temporarily extracted and used to assemble the document. Once assembly is complete, the extracted files are deleted. Auto-assemble files are useful if template developers don't want users to have editing access to the template files themselves.

auto-install file

A self-executable file that contains one or more templates and their related files. When extracted, the files are saved to disk and references to them are added to a library. Auto-install files provide a useful way to distribute templates or updates to template sets.

automate, automation

The process of converting any document (text or form) into an interactive template. At its very core, automation is replacing changeable text in the document with variables. Additional automation steps include making text in the template conditional, repeating sections of the template so multiple answers can be entered, and inserting other boilerplate text into the template.

Automator

See HotDocs Automator.

[Top]

B

bar code

A format for an answer or a group of answers so that data can be quickly scanned using an optical scanner. Bar codes are supported in both form templates and text templates.

binary files

In versions of HotDocs prior to HotDocs 2009, represents the format HotDocs-specific files—such as library files, component files, and so forth—were saved in. Binary file formats are common in most software applications. They allow information about the files to be encoded for storage and processing purposes. However, one limitation of storing information in HotDocs in binary format is that third-party application developers aren't able to inspect, edit, or otherwise make use of information contained in the files. Another limitation is that the binary formats used in HotDocs do not support the use of foreign characters (for example, international characters that are not represented in your computer system's default language).

browser

A window that allows users to view HTML documents.

built-in variable

A predefined variable that performs a special function in a template, such as inserting either today's date or the name of the current answer file. Built-in variables include TODAY, PN#, ANSWER FILE NAME, and COUNTER.

[Top]

C

.CMP

File name extension that designates that the file is a component file.

century rollover

A HotDocs setting that controls whether years entered as two digits appear as 1900-century years or 2000-century years.

check-box field

A type of form template field that represents some sort of pre-existing option a user must select.

chevrons

The double-angle brackets (« ») that surround a variable in a text template. Together, the chevrons and variable name make up the variable field, for example, «Client Name».

child dialog

A dialog that is inserted within another dialog. When it's inserted, it becomes linked to that dialog—users can't answer questions in it without first viewing the parent dialog. Usually the two dialogs are related in content or purpose.

clause

Predefined sections of text that can be selected and added to an assembled document. Usually clauses are grouped together in a clause library so users can choose which ones they want to insert, although some clauses are merged in the document automatically.

clause archive

A compressed file that contains all of the clauses for a given template or clause library. During assembly, clauses in the archive are extracted so they can be selected and added to an assembled document.

clause library

A file that contains a listing of available clauses. Users can select the clauses they want to use from the library, designate the order they should be merged in the document, and then answer any questions contained in the clauses. The clauses are then merged in the document.

command-line option

An instruction used to control the operation of HotDocs. These instructions, or commands, are added to any command line that causes HotDocs to run. They can alter the operation of specific templates, or they can affect the overall operation of HotDocs.

comments

Notes or thoughts entered by the template developer either in a script or in a template. Comments are one way to document processes within the template. If entered correctly, they will not be visible to users in the assembled document.

component

An element in a HotDocs template that displays or stores information about the answers that are merged. Examples of components include variables, dialogs, dialog elements, merge text groups, and formats.

component file

The file that stores all of the components used in a template. The component file and template file are both necessary for template development and document assembly to work correctly. Developers use Component Manager to work with components.

Component Manager

The tool used to coordinate component usage in a template. Component Manager shows all of the components used in the template and provides options for working with those components.

Computation variable

A type of component that performs calculations or executes other instructions within the template. Computation variable scripts are created using the HotDocs scripting language.

conditional text

Text in the template that should be included in the assembled document only under certain circumstances. Conditions are controlled using IF instructions and expressions.

COUNTER

An expression that keeps track of the current number of repetitions in a repeated dialog. Each time a new repetition is added, the COUNTER is increased.

custom interview

A script that controls how and the order in which variables and dialogs are asked during an interview. The template developer creates this script.

[Top]

D

.DOC

File name extension that designates that the file is a Microsoft Word document. (See text document.)

.DOT

File name extension that designates that the file is a Microsoft Word DOT template. (See text document.)

database

A file that contains a collection of data. Template developers can map variables in templates to fields in a database table so that answers can be retrieved from it and merged in the assembled document.

Database Connection

See HotDocs Database Connection.

date detection

The HotDocs setting that controls how HotDocs interprets and merges dates entered during the interview—for example, whether the date appears as DAY MONTH YEAR (British), or MONTH DAY YEAR (United States).

Date variable

A type of component that merges a date in the document.

default interview

The interview HotDocs automatically generates based on the order variables are asked in the template.

default word processor

When multiple word processors (for example, Word and WordPerfect) or when multiple versions of a single word processor (for example, Word 2000 and Word XP) are installed, the word processor HotDocs uses by default for automation and document assembly.

delimiter

A character, such as a tilde (~) or vertical bar (|), that delineates answers or values in a script or instruction.

descend

The process of sorting answers in reverse alphanumeric order, from 9 to 1, and from Z to A. (See also ascend.)

developer

See template developer.

dialog

  1. In template development, represents the component in which the developer groups variables and other components.
  2. In document assembly, represents the group of questions in the Interview tab of the assembly window where users enter their answers.

dialog element

A component that lets developers more easily add additional text, hyperlinks, buttons, graphics, lines, and spacing to dialogs. These can help make the dialog more visually pleasing and informative.

direct-fill assembly

The process of entering answers directly at the Form Document tab of the assembly window rather than answering questions at the Interview tab.

document

The file that is created after a template has been assembled.

document assembly

The process HotDocs goes through as it processes scripts in the template and merges answers into the document. At the end of the assembly process, the user has a document tailored to his or her needs.

document manager

A third-party application that stores various data files, including documents and answer files. Using a document manager, users can track versions and show histories of the document as well as enter other physical data about the files being stored, such as the date they were created, who created them, and so forth.

Document Preview tab

A tab of the assembly window that shows how the text document has been assembled using the answers entered in the interview. (See also Form Document tab and Interview tab.)

double-angle bracket

See chevrons.

driver

See printer driver.

duplicate

The process of copying a variable to create a new one.

[Top]

E

Edit field

A type of form template field that is used for entering text, dates, and numbers. It is the most commonly used type of field on a form.

ELSE IF / ELSE

See IF instruction.

End of Interview dialog

The last dialog displayed in an interview, which contains a report of the number of questions that are still unanswered. It also provides options for working with the assembled document.

example format

A predefined format for how an answer should look when it is merged in the assembled document. This allows the user to enter the answer however they want in the interview, but forces it to appear a specific way in the finished document.

explicit index

A reference to a specific answer in a list of answers. For example, to merge the third answer from a list, a template developer would assign the index number of [3] to the variable that is being merged, like this: «Service Date[3]». The third date in the list would then be merged.

expression

A command in a script that retrieves a special value. Expressions help calculate dates, sums, and so forth.

[Top]

F

field

A place in the template that denotes where users' answers should be merged, or where a specific instruction should be executed. In a text template, a field is denoted by chevrons. In a form template, a field is denoted by a colored box that is overlaid on the form's static text.

file name extension

Three characters appended to a file name that identify the type of file so Windows knows what program to use to work with the file.

fill

The process of assembling a form document.

fillable field

In Adobe Acrobat or Reader, represents a dynamic field in which a user can enter data while viewing the document. Using HotDocs, users can create fillable PDF templates from these PDF documents that contain fillable fields.

Filler

See HotDocs Filler.

filter

A script that removes unrelated or unwanted answers from a list of answers. For example, perhaps there is a list of a client's children but only the names of minor children should be merged. A filter can extract just this data from the list.

fixed value

A predefined answer, such as a date, number, or string of text. When working with instructions and expressions, placeholders are replaced either with fixed values or with variables.

foreign language DLL

A file that allows template developers and users to access Date variable and Number variable formats in languages other than English. This allows these dates and numbers to be formatted correctly in the assembled document. Supported languages include French, Spanish, German, Swiss German, Austrian German, Dutch, and Italian.

form document

The file that is created from an assembled form template. Form documents are distinguished from text documents by the design of the document—forms are static in nature, meaning the underlying text of the document cannot be changed or modified. (See also text document.)

Form Document tab

A tab of the assembly window that shows how the form document has been assembled using the answers entered in the interview. When viewing the Form Document tab, users can enter or change their answers by clicking on the form fields and changing the answer.

form template

A template that is created and automated in HotDocs Automator. It is distinguished from a text template by the fact that the underlying text cannot be modified because it is static. (See also form document.)

format example

See example format.

[Top]

H

.HDA

File name extension that designates that the file is a HotDocs auto-assemble file.

.HDI

File name extension that designates that the file is HotDocs auto-install file.

.HFD, .HPD

File name extension that designates that the file is a HotDocs form document.

.HFT, .HPT

File name extension that designates that the file is a HotDocs form template.

HotDocs Automator

The tool used to automate form templates, or those templates whose underlying static text cannot be changed. Examples of form templates include tax preparation forms, applications, and so forth.

HotDocs Compare

Starting with the release of HotDocs 2009, HotDocs Compare is no longer available.

A HotDocs add-in tool that is used to compare different versions of an assembled document. Using HotDocs Compare, users can take a "snapshot" of an assembled document, change some answers in the interview, and then compare the two versions.

HotDocs Database Connection

A tool that provides the mapping needed to connect templates to a database. Answers can be retrieved from the database during the interview, which keeps users from manually having to enter their answers. (Starting with the release of HotDocs 2008, HotDocs Database Connection (the separate product) was fully integrated into all editions of HotDocs.)

HotDocs Filler

The application used to view assembled form documents.

HotDocs Options

A section of the software where template developers and end users can set their preferences for working with HotDocs.

HotDocs PDF Advantage

A HotDocs add-in tool that allows the creation and automation of PDF-based form templates. PDF Advantage can also be used to save most types of documents as PDF (assembled or otherwise).

HotDocs Player Edition

A version of HotDocs that is used for assembling published (and registered) templates.

HotDocs Professional Edition

A version of HotDocs that contains the tools necessary to automate a simple to highly complicated set of both text and form templates. It is also used to assemble both text and form templates. (See also HotDocs Standard Edition.)

HotDocs Server

The Web-based version of HotDocs. When using HotDocs Server, interviews are presented in a user's Web browser. Answers are then sent back to a server where the document can be assembled. HotDocs Server allows users to create documents and answer files without requiring them to have HotDocs installed on their desktop.

HotDocs Standard Edition

A version of HotDocs that contains the tools necessary to automate a simple to moderately complicated set of text templates. HotDocs Standard can also be used to assemble text and form documents. (See also HotDocs Professional Edition.)

[Top]

I

IF instruction (also ELSE IF, ELSE, END IF)

A set of instructions and expressions that control the inclusion and exclusion of optional text in a document. IF instructions are based on either True/False variables or true/false expressions. IF instructions can also be used to control whether certain instructions or expressions are processed in computationscripts.

import

  1. When working with libraries, the process of copying template files into the currently viewed library. These files can be imported for assembly only or for editing and assembly.
  2. When working with answer files, the process of copying an answer file to the default Answers folder and then adding it to the answer library.

inactive field

A form document field on which the user cannot directly enter an answer. Fields can be inactive for any number of reasons. For example, the field may be conditioned or it may contain a Computation variable. Frequently, a template developer provides an answer wizard to help the user answer all of the questions that will make the field active.

infinite loop

The process of a HotDocs script repeatedly reprocessing itself until HotDocs stops responding. For example, a computation can repeatedly scan a text string, character by character, for a specific value. As HotDocs searches for this value, it adds information to what is called the processing stack. If too much information gets added to this stack, HotDocs may get into an infinite loop and stop responding.

INSERT instruction

An instruction that inserts one template into another. For example, if boilerplate text needs to be used in multiple documents, a template that contains that text can be created and inserted in each template that requires it (via an INSERT instruction). This way, if changes need to be made to the text, the change has to be made in only one template.

inserted dialog

See child dialog.

inserted template

A template that is inserted into another template using an INSERT instruction.

instant update

A command in the HotDocs assembly window that, when selected, updates the interview every time a user enters or changes an answer in the interview. Sometimes this updating may cause HotDocs to behave sluggishly as users move between answer fields. In such cases, the user can turn the instant update command off. Then HotDocs will update the interview only as it needs to.

instruction

A command in a script or template that performs a special task, such as inserting a template or asking a dialog at a specific place in the interview.

intake interview

See interview template.

interview

A presentation of questions that must be answered in order to create an assembled document. The interview is viewable by clicking the Interview tab of the assembly window.

interview component

A computation script that defines how a custom interview will look and function. An interview component usually includes ASK instructions to ask all of the dialogs/variables in the interview. The script frequently includes other instructions, such as REPEAT instructions and INSERT instructions as well as conditions for using these instructions. The name of this component is defined at the Component File Properties dialog box.

interview outline

The leftmost pane of the assembly window that lists all of the dialogs in the interview. Viewing the outline shows the natural progression of the interview. Icons in the outline also indicate whether questions in the associated dialog are completely answered, partially answered, or not answered at all.

Interview tab

A tab of the assembly window that shows the outline of questions in the interview as well as the dialogs that contain the questions. Users enter answers while viewing the Interview tab. (See also interview.)

interview template

A template that contains a series of interview questions designed to gather information about a person (or persons) or matter. Answers are saved in an answer source file, which can then be linked to a dialog in a template that requires the same information. Generally, interview templates can be used to create a list of possible answers so users have more options to choose from.

iteration

One instance of a repeated dialog.

[Top]

J

JS files

Stands for JavaScript files, which are used to display interviews in a Web browser. When templates are published for use with HotDocs Server, HotDocs generates these JavaScript files for the interview.

[Top]

K

keywords

A broad term used to describe scripting instructions, expressions, and operators. Keywords are used in a script and generate values or perform certain tasks.

[Top]

L

library

A window used to display and organize templates. The library does not store the actual files—instead, it contains shortcuts (or links) to the files, which are stored on disk. In addition to the template library, HotDocs also uses an answer library, which is more commonly known as Answer File Manager.

line break

A code in a Word document that indicates that text should appear on a new line within the same paragraph. For example, if the user must enter separate lines in a single paragraph (such as lines in an address), a line break should be used. (See also paragraph mark.)

linked field

Represents a HotDocs field in a fillable PDF template that is associated with an Adobe fillable field. By creating this association between a HotDocs field and a fillable field, template developers can create HotDocs fields that precisely match fields in the underlying PDF. Users who assemble the document can then edit answers associated with linked/fillable fields in the saved PDF.

list

Two or more answers to one question merged in the document.

[Top]

M

manual index

See explicit index.

map, mapping

See variable mapping.

mark up, markup

The formatting applied to a Word template or an assembled Word document that shows simplified template development marks. For example, when viewed in Markup View, variables in a template appear between brackets rather than chevrons. (See also Markup View.)

Markup View

A view that shows a simplified version of a Word template or an assembled document. This simplified view may be useful if a non-HotDocs user must review the template or document. When viewing a template or document in Markup View, variable and answer fields are marked using brackets.

merge field

  1. During template development, the place in the template where a variable is inserted.
  2. During document assembly, the place where the user's answer will be inserted.

merge text

The text that will be merged in a document if a user chooses a specific Multiple Choice variable option. For example, if a user chooses Male as the option, a masculine pronoun such as he or his can be merged instead of Male.

model

A tool in the script editor that template developers can use in writing scripts. A model shows the full instruction or expression—including any placeholders that must be replaced for the script to work correctly. Developers can drag these models from their respective lists and then replace the placeholders with the appropriate values.

Multiple Choice variable

A type of component that merges a predefined answer in the document.

[Top]

N

navigation bar

  1. In an interview (at the Interview tab), the toolbar used to move from dialog to dialog.
  2. In a document (at the Document tab), the toolbar used to move between merged answers in a document.

non-breaking space / hyphen

A property that can be assigned to a variable that keeps the answer from being split across two lines in the assembled document.

notation

An identification assigned to a variable name to help identify what type of variable it is. For example, Client Name TE would indicate that the variable is a Text variable. (Typical component notations include TE (Text), DA (Date), NU (Number), MC (Multiple Choice), TF (True/False), CO (Computation), and DI (dialog).)

Number variable

A type of component that merges a numeric value in the document.

[Top]

O

ODBC

Short for Open Database Connectivity, it's a data presentation layer that lets HotDocs communicate with a database so HotDocs can retrieve data from it and use it to assemble a document. (See also ADO.)

operator

A symbol or word that causes either an operation (such as addition) or a comparison to be performed in a computation script or expression.

order

The process of designating the sequence in which form template fields are asked in the tab order. Establishing this order in a form is important for users who directly fill the form document.

outline

See interview outline.

overflow

Answers in a form document that do not fit in the allotted field space. Overflowing answers are usually sent to the addendum.

overlay

The process of using the Overlay Answers command to merge existing answers into the current answer file. When answers are overlaid, the answers become a part of the current answer file. They also overwrite any existing answers in the interview.

[Top]

P

.PDF

File name extension that designates that the file is a Portable Document Format file, a format created and supported by Adobe. PDFs are a useful way of distributing documents in a format most users can view—as long as they have Adobe Acrobat, Adobe Reader, or HotDocs Filler (with HotDocs PDF Advantage) installed. With PDF Advantage, template developers can also create PDF-based form templates. They can also create PDFs from assembled documents.

paragraph mark

A code in a Word document that indicates that text following the mark should appear in a new paragraph. (See also line break.)

parent dialog

A dialog that contains a child dialog.

pattern

Determines how a Text variable will be displayed and formatted in the interview and in the assembled document. By default, HotDocs includes three patterns in all new templates (Social Security number, telephone number, and time of day), but template developers can create custom patterns.

PDF417

The two-dimensional bar code format used in HotDocs Filler.

Personal Information variable

A type of component that stores basic information about a user, such as a name, a company name, and a phone number. This information is saved in the Current User key of the Windows System Registry. Once answered, users won't be prompted to enter it again.

placeholder

A marker in an instruction or expression model that indicates where a value must be substituted. This value must be a literal value or a variable. Instruction and expression models help the developer use the correct syntax in a script.

pointed component file

When sharing components across multiple templates, represents the template's own component file, which, in turn, points to the shared component file.

pop-up interview

A dialog a user can display during an interview. Usually a pop-up interview shows a different view of the dialog. For example, if a user is entering answers in a spreadsheet, he or she can click the Edit RowEdit Row button and a pop-up interview appears that shows just the questions (and answers) from that particular row in the spreadsheet.

processing stack

A sequential list of templates and components HotDocs is processing at any given time. Each time a new component is processed, it is added to the stack. (Once processing is finished, it is removed.) In some instances where recursion is used in a script, the same component is repeatedly added to the list. If the number of components exceeds the stack limit, an infinite loop error will occur. (The stack limit can be changed at the Component File Properties dialog box.)

prompt

Text that can be assigned to a variable to help the user better understand how to answer the question.

punctuate

The process of formatting a REPEAT instruction so that a list of answers will appear in sentence format, like this: The client owns real estate in New York, Pennsylvania, and Montana. (New York, Pennsylvania, and Montana are the list items. The punctuation adds the commas and the conjunction and).

[Top]

Q

Question Summary

A brief report HotDocs generates that lists questions asked during an interview. The summary includes blank lines for handwritten answers. (See also Answer Summary.)

queue

See Assembly Queue.

[Top]

R

.RTF

File name extension that designates that the template file is a Word RTF file. (See text template.)

reference

In a form document, the text that is added to the addendum to identify any overflow answers. (See also label.)

reference path

A folder path for a template in which the drive letter and some or all of the folder names are represented by a keyword. At runtime, this keyword is mapped to an actual path on the user's computer so that when the user accesses the template, the keyword is replaced by the path. This allows templates saved in one central location to work on multiple workstations regardless of how the drives on the workstation are mapped.

REPEAT instruction

An instruction that repeatedly asks the same variable(s) so that two or more answers can be entered. REPEAT instructions are used to create lists of answers in the document.

repeated dialog

A dialog that contains the variables that need to be repeated so that multiple answers can be entered. (See REPEAT instruction.)

repeated series dialog

One of two representations of a dialog that is repeated. With a repeated series, the dialog is asked repeatedly until all answers in the list have been entered. (See also spreadsheet dialog.)

resource

Supplemental help that can be included with a variable or dialog to help users better understand how to answer the questions they are viewing. Resources appear in the resource pane of the assembly window.

[Top]

S

script

One or more instructions and/or expressions that generate a value or execute some kind of procedure.

script editor

The tool used to write a script. The script editor includes several options to make the script-writing process easier, including color-coding, auto-complete lists, and a toolbar for completing other tasks.

selection grouping

A dialog property assigned to True/False variables, clauses, and child dialogs which presents these options as check boxes (multiple-select) or option buttons (single-select).

Send to Word Processor command

A command that opens the word processor and copies the assembled document into it. Once opened in the word processor, the user can make any changes necessary to the document.

SET instruction

An instruction in a template or script that assigns a value to a variable. Variables that have their values set should not be asked again in the interview.

shared component file

A common component file to which several related templates are linked. To use a shared component file, the template's own component file must be pointed to the shared file. Changes to components in the file are reflected in all templates that use it. (See also pointed component file.)

sort

The process of alphabetizing answers in a repeated list or items in a library. Sorting can be done in ascending or descending order.

spreadsheet dialog

One representation of a repeated dialog. Each row in a spreadsheet represents one repetition in a dialog. (See also repeated series dialog.)

static text

The underlying text in a form template or document that does not change. To enter answers on a form, form fields must be created and overlaid on the static text.

strike-through field

A type of form template field that is used for crossing out static text on the form.

summary

See Question Summary and Answer Summary.

supplemental component

A term used to define components such as patterns, example formats, dialog elements, and merge text. Supplemental components are associated with regular components, but they can be created and edited as standalone components.

syntax

The language used in writing scripts. For a script to work properly, the script must be written in a way that HotDocs can understand. This language consists of instructions, expressions, operators, and values (such as text, numbers, dates, or answers users enter).

[Top]

T

template

A word processor or form document that has been converted to HotDocs format so that it can be automated. When in template format, changeable text in the template can be replaced with variables. Other instructions can be added as well, such as instructions that create lists, condition text, and insert other templates.

template developer

The person responsible for automating the templates in the set. The template developer creates and inserts the variables in the template, arranges variables in dialogs, and performs other custom tasks in the template. (See also user.)

template development

See automate, automation.

test

The process of testing a variable or other component to make sure it looks right and works correctly.

test assemble

The process of assembling a document for the purpose of ensuring the interview works correctly and the automation within the template produces a correctly assembled document. During a test assembly, developers can easily edit components and have the test assembly window updated with changes.

text document

A document that is viewed in either Word or WordPerfect. It can represent a document before it is automated as well as a document after it has been assembled. When in document format, it is not associated with (or linked to) HotDocs in any way. (See also text template.)

text template

A template that is created and automated in Microsoft Word or WordPerfect. It is distinguished from a form template by the fact that the underlying text of the template can be modified. (See also text document.)

Text variable

A type of component that merges text in the document.

title

A property of a variable or dialog that specifies a more user-friendly name for the component. For example, if project standards require components be named using notations, names like Employee Name TE may not make sense to a user. However a title like Employee Name can be used instead.

True/False expression

A script that must result in either true or false. Expressions are used for merging or excluding optional text in a document. They are also used for determining which parts of a script will be executed, based on answers or other values entered by a user. Expressions are often used when a simple True/False variable doesn't convey the condition needed. (See IF Instruction.)

True/False variable

A type of component that determines a true/false status of some condition and then merges the appropriate answer or text.

[Top]

U

unanswered text

Text in a text document that indicates that a question is unanswered. By default, unanswered questions appear as ***Variable Name***, but this can be customized.

Unicode

Computer specification that makes it possible for computers to represent and manipulate characters used in most of the world’s written languages. Unicode support in HotDocs makes it possible to automate and assemble documents in non-native, left-to-right-reading languages. This includes automating and assembling Microsoft Word templates as well as PDF-based form templates.

user

The customer, client, or person who assembles documents from templates. (See also template developer.)

[Top]

V

value

In an interview, it represents a user's answer. In a script, it represents data that must be used in executing the script. (The value can either be a literal value or a user's answer.)

variable

A component that is used to represent changeable text (such as names, dates, numbers, etc.) in the template. Types of variables include Text, Date, Number, True/False, Multiple Choice, Computation, and Personal Information.

variable flow-through

See answer sharing.

[Top]

W

.WPD

File name extension that designates that the file is a WordPerfect document. (See text document.)

.WPT

File name extension that designates that the file is a WordPerfect template. (See text template.)

[Top]

X

XML

Stands for eXtensible Markup Language. It is a computer language designed to store and transmit data between applications. Like HTML (HyperText Markup Language), it contains customized markers, or tags, that identify the information in an XML file. However, while HTML describes the way a page looks, XML controls the way data is structured, making it easy for diverse programs to access the same information. (For example, in HTML, to indicate a book title, you would italicize it using the <i> tag. In XML, you could mark the title using a <booktitle> tag. The HTML tag simply formats the text (making it italic), while the XML tag actually defines what the text is (a book title).) In HotDocs, you can save libraries and answer files in XML format.

[Top]