Compatibility Issues Between the Different Versions of HotDocs

HotDocs Version:HD6, HD2005, HD2006, HD2007, HD2008, HD2009
Word Processor:Microsoft Word, WordPerfect
Added to Knowledge Base:January 2005
Updated:May 2009

With each release of HotDocs, new features or properties are added that are not backwards compatible. This means that if you implement one of these features in a template and then attempt to assemble the template with an earlier version of HotDocs, the feature or property may create errors or produce unexpected results in the assembled document. Additionally, editing a template that contains these features may clear the property or change the operation of the feature.

The following table explains version-specific features and properties. It also includes a designation of how the feature will affect template development or document assembly in versions of HotDocs prior to when the feature was introduced. 

FeatureVersion ImplementedTemplate DevelopmentDocument Assembly
Default example formats6.0Supported in all versionsSupported in all versions
Default merge field properties6.0Supported in all versionsSupported in all versions
Select the Automatically select this option if variable is unanswered when displayed property for more than one Multiple Choice option 6.0Supported in all versionsSupported in all versions
Assign individual resources to Multiple Choice options6.0Supported in all versionsSupported in all versions
Assign dialog titles6.0Supported in all versionsSupported in all versions
HIDE or SHOW variables in a dialog based on answers to one or more variables in that same dialog6.0Supported in all versionsSupported in all versions
Automate PDF-based form templates 16.0Supported in all versionsSupported in all versions
Designate answer field widths, including spreadsheet column widths when the variable is repeated6.1Supported in all versionsSupported in all versions
Use line breaks and paragraph marks in computation scripts6.1Supported in all versionsSupported in all versions
Use ADO-based database components6.1Supported in all versionsSupported in all versions
SET True/False value of grouped child dialogs6.1Supported in all versionsSupported in all versions
Include option prompts in CLEAR / ADD instructions6.1Supported in all versionsSupported in all versions
Use /ss, /ssn, /sa, and /sap command-line instructions in an ASSEMBLE instruction6.1 SP1Supported in all versionsSupported in all versions
Thousands and decimal separators in LANGUAGE instructions6.1 SP1Supported in all versionsSupported in all versions
Use a numeric expression in a dialog LIMIT instruction6.1 SP1Supported in all versionsSupported in all versions
Select Enter key in multi-line answers inserts new paragraph mark option for multi-line Text variables6.1 SP1Supported in all versionsSupported in all versions
SET value of multiple-select Multiple Choice variables to two or more values6.1 SP1Supported in all versionsSupported in all versions
DEBUG, INCREMENT, DECREMENT, WHILE, END WHILE instructions6.2Supported in all versionsSupported in all versions
Select the Ask automatically property for dialogs6.2Supported in all versionsSupported in all versions
Use the Named Group property to span fields across two or more form pages6.2Supported in all versionsSupported in all versions
KEEP HEADER and KEEP FOOTER of inserted template2005When editing template in earlier versions, keywords are ignoredWhen assembling documents in earlier versions, keywords cause scripting errors
Use non-breaking formats2005When editing a template in earlier versions, option is ignored 2When assembling a document in earlier versions, option causes errors
Use an Outlook Contacts list as an answer source2005When editing a template in earlier versions, option is ignoredWhen assembling a document in earlier versions, option is ignored
Format answers using symbol or other nonstandard fonts2005When editing a template in earlier versions, option is removed from templateWhen assembling a document in earlier versions, option is ignored
Assign variable titles2005 SP1When editing a template in earlier versions, title is removed from variableWhen assembling a document in earlier versions, title is ignored
Assign repeated series label2005 SP1When editing a template in earlier versions, label is removed from dialogWhen assembling a document in earlier versions, label is ignored
Limit the number of rows that are shown for a spreadsheet2005 SP2When editing a template in earlier versions, property is clearedWhen assembling a document in earlier versions, property is ignored
Use SPAN instructions to mark editable document text2006 3When editing a template in earlier versions, keyword is ignoredWhen assembling a document in earlier versions, keyword causes errors
Use dialog elements other than additional text and buttons (lines, spaces, graphics, etc.)2006When editing a template in earlier versions, dialog elements are either ignored or removed 4When assembling a document in earlier versions, dialog elements cause errors
Choose which component file provides properties when pointing templates 2006When editing a template in earlier versions, feature is ignoredWhen assembling a document in earlier versions, feature is ignored
Use smart returns when inserting instructions2006When editing a template in earlier versions of HotDocs, smart returns are ignoredWhen assembling a document in earlier versions of HotDocs, smart returns cause errors
Use dot codes to format plain text2006When editing a template in earlier versions of HotDocs, dot codes are ignoredWhen assembling a document in earlier versions of HotDocs, dot codes cause errors
REPLACE, SPACE, STRIP, VALUE, SELECTION, and UNION expression models2006When editing a template in earlier versions of HotDocs, keywords are ignoredWhen assembling a document in earlier versions of HotDocs, keywords cause errors
ERASE VAR, ERASE DIALOG instruction models2006When editing a template in earlier versions of HotDocs, keywords are ignoredWhen assembling a document in earlier versions of HotDocs, keywords cause errors
Store PLAY macros for an RTF in a DOT and reference it from the component file2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option causes errors
Automatically update references in assembled document2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option is ignored
Use scripting in plain-text resources2006When editing a template in earlier versions of HotDocs, scripting is ignoredWhen assembling a document in earlier versions of HotDocs, scripting is ignored
Sort a repeated list before filtering it2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option causes errors
Circle static text on a form2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option is ignored
Send part of an answer that overflows to the addendum, rather than the full answer2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option is ignored
Better implementation for ANSWER FILE NAME system variable2006When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option causes errors
Web link dot code2007 SP1When editing a template in earlier versions of HotDocs, dot code is ignoredWhen assembling a document in earlier versions of HotDocs, dot code causes errors
Automatically exclude irrelevant variables2008When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option is ignored
Single-page dialogs in HotDocs Server interviews2008When editing a template in earlier versions of HotDocs, option is ignoredWhen assembling a document in earlier versions of HotDocs, option is ignored
Use international languages when completing an interview2008When editing a template in earlier versions of HotDocs, Unicode characters appear as boxes or question marksWhen assembling a document in earlier versions of HotDocs, Unicode characters appear as boxes or question marks
Use international languages when automating a template set2009When editing a template in earlier versions of HotDocs, Unicode characters appear as boxes or question marksWhen assembling a document in earlier versions of HotDocs, Unicode characters appear as boxes or question marks
XML library and component file formats2009HotDocs cannot read XML-based library and component files in earlier versions of HotDocs.HotDocs cannot read XML-based library and component files in earlier versions of HotDocs.
INSERT instructions that insert graphics2009When editing a template in earlier versions of HotDocs, feature is ignoredWhen assembling a document in earlier versions of HotDocs, feature causes errors
Variable INSERT instructions2009When editing a template in earlier versions of HotDocs, feature is ignoredWhen assembling a document in earlier versions of HotDocs, feature causes errors
Use fillable PDFs as basis for form templates2009When editing a template in earlier versions of HotDocs PDF Advantage, fillable fields are ignoredWhen assembling a document in earlier versions of HotDocs PDF Advantage, fillable fields are ignored

Legend:

Feature ignored

Feature removed

Feature causes errors or causes unexpected results

Feature works correctly

Component File Version Updates

With some releases of HotDocs, users are required to upgrade their component file versions. For example, templates automated in HotDocs 2005 cannot be assembled with earlier versions of HotDocs, nor can they be edited. When HotDocs 2005 SP1 was released, an option was added to Component File Properties that allows developers to save the component file for use with a specific version in HotDocs. This helps to maintain backwards compatibility when users of the template are using a version different from template developers.

The following lists which versions of HotDocs incorporated a component file version update:

  • HotDocs 6
  • HotDocs 2005
  • HotDocs 2006
  • HotDocs 2009

If you want to use later versions of HotDocs to develop your templates but you want them to be compatible with earlier versions of HotDocs, be careful using any version-specific features listed in the table above. If you do, you may see unexpected results.

1 Requires HotDocs PDF Advantage license.

2 If you edit this instruction («INSERT "Inserted Template.rtf" KEEP HEADER FOOTER») in HotDocs 6.x, HotDocs will not recognize the keywords KEEP HEADER FOOTER and, when you edit the instruction, it will try to include them in the file path («INSERT "Inserted Template.rtf KEEP HEADER FOOTER"»). (Note the placement of quotation marks in each instruction.) You will receive errors when you assemble the template.

3 SPAN instructions were implemented (but not documented) for purposes of testing in the release of HotDocs 2005.

4 You cannot save a component file in HD2005 format or earlier if you have used a dialog element multiple times (either more than once in the same dialog or in more than one dialog). Additionally, the following dialog elements are not supported in earlier versions of HotDocs: horizontal dividers, vertical spacing, Web links (in desktop interviews), and images. Including these in a dialog will yield unexpected results both in editing and during assembly.