Creating a document template

You can create a blank template, start with an existing template and use its content, start with an existing template and remove its content, or start with a sample template.

Before you begin

Every template is associated with a blank document specification by default. When you preview or publish a template from the Document Studio application, this blank document specification can be customized or used without customization to generate the output. The Document Studio keeps the template in sync with the default document specification when you open or save the template.

About this task

Creating a blank document template

Procedure

  1. In the Document Studio application, click File > New > Document Template.
  2. Optional: Enter the metadata for the template:
    • Name: A metadata name for the template. This name is only in the metadata and not a name for the file to be saved as.
    • Description: An explanation of the content in the template or context for other users to work with the template.
  3. Select a template version.
    Note: In version 1.2, this selection opens in a new window when you click Finish.
    • Template version 1 (RPE 1.1.2.2 and older): Use the functionality from Rational® Publishing Engine 1.1.2.2 and earlier and not the additional functionality introduced in Rational Publishing Engine 1.2.
    • Template version 2 (current RPE version): Use the additional functionality introduced in Rational Publishing Engine 1.2.

      To use the same template version for every new template, select Use a specific template version in the Document design preferences.

    Tip: The template version you choose must align with the supported template version of the data provider. Verify that your data provider supports version 2 templates before using them.
  4. Click Finish.
  5. Click OK. A blank template opens and you can begin dragging elements from the Palette view into the template content editor.

Creating a document template and pre-populating it with new elements or elements from an existing template

Procedure

  1. In the Document Studio application, click File > New > New Template Wizard. The New Template Wizard opens and you can click Next.
  2. Select the template version.
    Note: In version 1.2, this selection opens in a separate window when you clicked Next.
    • Template version 1 (RPE 1.1.2.2 and older): Use the functionality from Rational Publishing Engine 1.1.2.2 and earlier and not the additional functionality introduced in Rational Publishing Engine 1.2.
    • Template version 2 (current RPE version): Use the additional functionality introduced in Rational Publishing Engine 1.2.

      To use the same template version for every new template, select Use a specific template version in the Document design preferences.

    Tip: The template version you choose must align with the supported template version of the data provider. Verify that your data provider supports version 2 templates before using them.
  3. Specify a new or existing template:
    • To create a template, select Create a New Template and enter the metadata for the template.
      1. Enter a metadata Name for the template. This name is only in the metadata and not a name for the file to be saved as.
      2. Enter a metadata Description for the template.
    • To start with an existing template, select Create a New Template starting from an existing base Template.
      1. Click Browse and select an existing template. If you choose to, you can select an existing sample template from the %RPE_HOME%/source directory.
      2. To use the data source schema, styles, and master pages but remove the elements from the template content editor, select Clear Template Content.
      3. Edit the Name and Description. This name is only in the metadata and not a name for the file to be saved as.
    Click Next.
  4. In the Title Page window, select an option for the title page.
    • To use an existing title page, select No Title Page/Use existing Title Page, and then click Next.
    • To create a title page, select Define Template Title Page.
      1. Select the elements to be included in the Template and click Next.
  5. In the Data Sources window, choose your data sources.
    • To add a data source:
      1. Click Add. The New Data Source window opens.
      2. Specify the data source type, data source file, data source ID, and description.
      3. Click OK.
      4. Repeat to create other data sources.
      5. Click Next.
    • To modify the data source that was used in the base template:
      1. Select the data source.
      2. Click Edit.
      3. Specify the data source type, data source file, data source ID, and description.
      4. Click OK.
      5. Repeat for other data sources.
      6. Click Next.
    • To remove a data source:
      1. Select the data source.
      2. Click Remove.
      3. Repeat for other data sources.
      4. Click Next.
  6. In the Master Page window, choose your master page structure.
    • To create a master page:
      1. Click Add. The New Master Page window opens.
      2. Specify a name, description, page orientation, and page size.
      3. Click OK.
      4. Repeat to create other master pages.
      5. Click Next.
    • To modify the master page that was used in the base template:
      1. Select a master page.
      2. Click Edit.
      3. Specify a name, description, page orientation, and page size.
      4. Click OK.
      5. Repeat for other master pages.
      6. Click Next.
    • To remove a master page:
      1. Select the master page.
      2. Click Remove.
      3. Repeat for other master pages.
      4. Click Next.
  7. In the Variables window, choose your variables.
    • To create a variable:
      1. Click Add. The New Variable window opens.
      2. Specify a name, description, default value, and access type.
      3. Click OK.
      4. Repeat to create other variables.
      5. Click Next.
    • To modify the variables that were used in the base template:
      1. Select a variable.
      2. Click Edit.
      3. Specify a name, description, default value, and access type.
      4. Click OK.
      5. Repeat for other variables.
      6. Click Next.
    • To remove a variable:
      1. Select a variable.
      2. Click Remove.
      3. Repeat for other variables.
      4. Click Next.
  8. Review the information in the Summary window and click Finish.
  9. Click File > Save As or click the Save icon on the toolbar. Select a location and enter a file name with a .dta extension.

Feedback