Edit online

How to Create a Publishing Template

To create a customization, you can start from scratch or from an existing template, and then adapt it according to your needs.

Creating a Publishing Template Starting from Scratch

To create a new Oxygen Publishing Template, follow these steps:
  1. Create a folder that will contain all the template files.
  2. In Oxygen XML Editor/Author, open the new document wizard (use File > New or the New toolbar button), then choose the Publishing Template Descriptor template.

    Figure 1. Choosing the Publishing Template Descriptor Document Template
  3. Save the .opt file into your customization directory.
  4. Open the .opt file in the editor and customize it to suit your needs. See: Publishing Template Package Contents for WebHelp Responsive Customizations.

Creating a Publishing Template Starting from an Existing Template

If you are using a DITA Map WebHelp Responsive or DITA Map PDF - based on HTML5 & CSS transformation, the easiest way to create a new Oxygen Publishing Template is to select an existing template in the transformation scenario dialog box and use the Save template as button to save that template into a new template package that can be used as a starting point.

To create a new Oxygen Publishing Template, follow these steps:
  1. Open the transformation scenario dialog box and select the publishing template you want to export and use as a starting point.
  2. Optional: You can set one or more transformation parameters from the Parameters tab and the edited parameters will be exported along with the selected template. You will see which parameters will be exported in the dialog box that is displayed after the next step.

  3. Click the Save template as button.

    Step Result: This opens a template package configuration dialog box that contains some options and displays the parameters that will be exported to your template package.

  4. Specify a name for the new template.
  5. Optional: Specify a template description.
  6. Optional: The same publishing template package can contain both a WebHelp Responsive and PDF customization and you can use the same template in both types of transformations (DITA Map WebHelp Responsive or DITA Map to PDF - based on HTML5 & CSS). You can use the Include WebHelp customization and Include PDF customization options to specify whether your custom template will include both types of customizations.
  7. Optional: For WebHelp Responsive customizations, you can select the Include HTML Page Layout Files option if you want to copy the default HTML Page Layout Files in your template package. They are helpful if you want to change the structure of the generated HTML pages.
  8. In the Save as field, specify the name and path of the ZIP file where the template will be saved.

    Step Result: A new ZIP archive will be created on disk in the specified location with the specified name.

  9. Open the .opt file in the editor and customize it to suit your needs. See: Publishing Template Package Contents for WebHelp Responsive Customizations.

For more information about creating and customizing publishing templates, watch our video demonstration:

Creating a Publishing Template Using the Oxygen Styles Basket

Another way to create an Oxygen Publishing Template is to use the Oxygen Styles Basket. This tool is a handy free-to-use web-based visual tool that helps you create your own Publishing Template Package to customize your DITA Map WebHelp Responsive transformation scenarios.

It is based on galleries that you can visit to pick styling aspects to create a custom look and feel. Various different types of styles can be selected (such as fonts, tables, lists, spacing, code) and all changes can be seen in the Preview pane. You can also click the See Results button to generate a preview of either WebHelp or PDF output.

It is possible to Download the current template or Upload a previously generated template for further customization.

Figure 2. Oxygen Styles Basket Interface

Resources

For more information about the Oxygen Styles Basket, see the following resources: