WTDocument Coversheet Customization

WTDocument coversheet customization allows users to modify the layout and content of their document coversheets. This can be achieved by using a template file with specialized markups that are replaced with actual values generated by generator classes.

Understanding the Template Mechanism

The basis of the coversheet template mechanism is the concept of generators, which browse through the template and find all the markups. A markup is constructed as ${}. Each generator follows the same procedure recursively:

• The generator takes a persistable object and template file as input parameters.
• The generator finds all markups inside the template file.
• For every markup found, create a mapping: key = markup name, value = default value (defined inside the generator class).
• The generator reads the template configuration and searches to see if there is a generator definition for the particular markup name.

Customizing Coversheets

Coversheets can be customized in several ways, including:

• Modifying the template file (which is actually a modified HTML file)
• Inserting images using the <img> tag
• Using out-of-the-box markups to extract document information
• Creating new templates, associated generators, and markups

Example: Customizing a Coversheet

To customize a coversheet, create a new template file (e.g., CustomTemplate.tpl) and register it in the template.properties.xconf file. The template file can include markups, images, and other content.

Available Out-of-the-Box Markups

The following table lists the available out-of-the-box markups:

Creating New Templates, Generators, and Markups

To create a new template, generator, and markup, follow these steps:

1. Define a new template (e.g., UploadedFromPath.tpl) for the markup.
2. Define the generator class (e.g., UploadedFromPathGenerator.java) for the markup.
3. Register the new template and generator in the template.properties.xconf file.

For more information on WTDocument coversheet customization, visit the PTC Support website. To learn more about Windchill, visit the Windchill Help Center.