Publish Templates as Auto-Install Files (HDI)

A HotDocs auto-install (.HDI) file is a compressed file containing a library and one or more templates and their related files (component file, clause library file, and so forth). Auto-install files are a convenient way to distribute template sets to users, especially sets that must be updated periodically.

When you create an auto-install file, you specify a library file name. The first three characters of the file name are automatically assigned the characters, PUB, which sets a reference path keyword for the library. The first time a user installs a template set with that library file name, HotDocs suggests to the user that the library for the templates be installed in the Template Sets folder or the user's Libraries folder. HotDocs then asks where the templates should be installed. Any subsequent template sets with that same library file name will automatically get installed to the same folders. The paths for the templates in the library will appear as ^library file name\library file name\template file name.

If you select multiple library items to publish, you can either publish each item as its own HDI file, or you can group items together in a template set.

Additionally, you can publish your templates for use with HotDocs 2006-2008. This allows you to keep your templates backwards compatible. If you select this option, HotDocs opens and saves the component file in that version.

To assemble an auto-install file, you can either pass the file to HotDocs using a command-line option, or you can add the auto-install file to a HotDocs library using the Install Templates command (File menu at the HotDocs library). If users open an auto-install file from the Internet or an intranet, the browser will start HotDocs and pass it the file.

When HotDocs is passed an auto-install file, it installs a library, which contains the templates you published. If the library already exists, HotDocs updates it, overwriting existing library items and adding new items. If the library doesn't already exist, HotDocs creates it.

To publish templates as HotDocs auto-install files

  1. At the HotDocs library, select the template or templates you want to publish and click the Publishing Wizard button. The Publishing Wizard dialog box appears, displaying the Publishing Options information.
  2. Select one of the following from the Publish as group:
    • Individual auto-install files (HDI)
    • Template set in a single auto-install file (HDI)
  3. If your template contains any INSERT or ASSEMBLE instructions, select Include templates used in INSERT and ASSEMBLE instructions.
  4. If you want to make the published template(s) compatible with HotDocs 2006-2008, select Make published files compatible with HotDocs 2006-2008.
  5. Click the Browse button next to the Local folder for published files field to specify the folder where you want HotDocs to save the published files.
  6. Optionally, if you plan to upload the published files, click the Edit button next to the Web destination for published files field and specify the URL of the server to which you want to upload. (When HotDocs finishes publishing the templates, it will start the uploading process. See Introduction: Upload HotDocs Files to a Web Server.)
  7. Click Next. The File Security dialog box appears.
  8. Optionally, specify any security options and click Next. (See Protect Published Files.) (If publishing individual auto-install files, skip to step 9.)
  9. At the Published Template Set dialog box, enter a name for the HDI file in the File name for published HDI file field, and then enter a title for the file in the Template set title field.
  10. Click Next. The Auto-Install Target Library dialog box appears.
  11. Enter a library file name, title, and optional description for the library that will be created and select any of the following options:
    • Update library title and description even if library already exists updates the current library title and description to match the information in the library that is being installed.
    • Update library items without installing templates points the items in the library to templates on a CD. (The templates on the CD must be saved in a first-level folder with the same name as the library base file name (including PUB).)
    • Install templates for read-only access installs the templates as read-only, which prohibits users from editing them.
  12. Click Next. If you’re publishing a template set in a single auto-install file, the Target Library Shortcut dialog box appears. (If you’re publishing individual auto-install files, skip to step 13.)
  13. Optionally, select Install a shortcut in the user's Start menu and specify any shortcut options. (See Create a Shortcut for an Auto-Install Library.)
  14. Click Next. The Additional Files dialog box appears.
  15. If you want to include additional files (such as resource files), click Add Files, then select the desired files. (See Add Additional Files to a Published Set for details.)
  16. Click Finish. HotDocs publishes your files and returns you to the HotDocs library.

Once these files are published to this temporary folder, you should move them to a more permanent location. If you publish additional templates or other files that use the same file names, HotDocs will overwrite the previously published files.

When installing templates for read-only access, you should understand that this option simply marks the files as read-only, so feasibly, users could change the file properties and then edit the templates, as long as they have HotDocs Developer. To keep users from editing the template, specify the Lock Component Files option at the File Security dialog box.

When updating an existing published template set that is in binary format, if you use any foreign characters in any of the properties of the template set, HotDocs will convert the existing library to XML format so that it can display the characters.

When updating the library, HotDocs looks to see if each item in the auto-install file’s library exists in the user’s library. If folder and template titles don't match, HotDocs adds new items instead of updating existing items.

If you give your libraries file names that are unique to your company or product, you will reduce the chance of another publisher creating a template set with the same name.

If you publish multiple template sets, you can save the settings you specify during the publishing process so that the next time you publish, the options are already specified. (See Save Publishing Settings.)

You can have a custom splash screen appear when the user launches the library created by the auto-install file. (See Use a Custom Library Splash Screen.)