Upgrading Custom Templates based on 2012 Style Templates

How to upgrade Custom Templates based on 2012 Style Templates to take advantage of improvements in the Classic Templates introduced in 2016.1

The 2016.1 version includes a comprehensive refresh of the underlying components of the "2012 Style" Templates; now renamed "Classic". Although functionally and visually identical to the 2012 Style Templates, the Classic Templates feature a modernized Javascript core and standardized set of CSS selectors.

These changes were made to ensure that the Templates retain broad compatibility with both Web Browser and Compiled Help outputs, whilst taking advantage of a common set of CSS selector names that will make it much simpler to manage Style Rules in custom Templates, override standard Template Style Rules and share custom Style Style Rules amongst different Templates. The improvements to the Javascript core will improve long term compatibility of the template with modern browsers and our ability to implement new features and fix browser compatibility issues.

Projects using the 2012 Style Templates will be automatically migrated to use the Classic Templates when they are opened.

Migrating Custom Templates

Although any custom Templates created based on the 2012 Style Templates will continue to work without modification, those custom Templates will not benefit from the improvements in the new Classic Templates, including key functionality for creating and managing Style Rules in Template Stylesheets and overriding standard Template Styles.

Migrating an existing Template involves creating a new Custom Template based on the Classic Template and then applying the customizations originally made to the previous Custom Template.

Identify the Customizations in the original Custom Template

The simplest way to identify the customizations you made to the previous custom Template is to compare the directory containing your original Custom Template with the Standard 2012 Style Template on which it was based.

There are a number of tools available to compare 2 directories, including the open source WinMerge or the commercial http://www.araxis.com/merge/.

Document! X and the Document! X and HelpStudio Bundle stores custom Templates beneath the c:\ProgramData\Innovasys\DocumentX2015\Templates directory. Standard Templates are stored beneath the c:\Program Files (x86)\Innovasys\DocumentX2015\Configuration\Templates directory (c:\Program Files\Innovasys\DocumentX2015\Configuration\Templates on 32bit versions of Windows).

HelpStudio stores custom Templates beneath the c:\ProgramData\Innovasys\HelpStudio2015\Templates directory. Standard Templates are stored beneath the c:\Program Files (x86)\Innovasys\HelpStudio2015\Configuration\Templates directory (c:\Program Files\Innovasys\HelpStudio2015\Configuration\Templates on 32bit versions of Windows).

Create a new Custom Template based on the Classic Template

Create a new Custom Template (select Options from the Tools Ribbon Tab and select the Custom Templates page);

Re-Apply your customizations to the new Custom Template

Once the new Custom Template is opened for edit, you can go ahead and re-apply the customizations (Page Types, Phrases, Scraps, Table of Contents) made to your original Custom Template.

Re-Apply Custom Style Rules to the new Custom Template

The new Classic Templates include a new feature that makes it simpler to add custom Style Rules to the Template whilst keeping them separate from the standard Template Stylesheets. Keeping your custom Style Rules in a separate Stylesheet ensures that the standard Stylesheets in the Custom Template can continue to be automatically updated with bug fixes or improvements to the Classic Template on which it was based when you install updates.

To add a custom Stylesheet to your Custom Template, simply save a new file with a .css extension in a \template\packages\custom\css sub-directory beneath the directory containing your custom Template. You will need to create this sub-directory if it does not already exist.

Document! X and the Document! X and HelpStudio Bundle store custom Templates beneath the c:\ProgramData\Innovasys\DocumentX2015\Templates directory.

HelpStudio stores custom Templates beneath the c:\ProgramData\Innovasys\HelpStudio2015\Templates directory.

Update Projects to use the new Custom Template

The final step is to update your projects that used your previous Custom Template to use the new Custom Template; using the Templates page in the Build Profile Editor.