Customizing Documentation

Parent Previous Next

How do I customize the way my documentation looks?

Table of Contents


  Document Control

  Structure Map


The DOC xPress and DOC xPress Server templates are used to lend form and reason to the output. They are fully customizable and control what information is included in the documentation.

For users that are just beginning to learn how to customize their templates, it is recommended that they first read through the introduction before continuing. After completing the introduction, the document control, structure map, and templates pages can provide users with a more detailed description of the functions present within the DOC xPress template documentation generation.

By default, the templates are stored within a folder in the installation directories for Pragmatic Workbench and Workbench Server. Below can be found the two default install locations:

  DOC xPress

o   C:\Program Files (x86)\Pragmatic Works\Pragmatic Workbench\DOC xPress Templates

  DOC xPress Server

o   C:\Program Files (x86)\Pragmatic Works\Workbench Server\DOC xPress Web Services\DefaultTemplates

Important Note:

Modification of the DOC xPress templates are not officially supported by Pragmatic Works and this cannot be stressed enough. While we do provide documentation and guidance within the help documentation, any modification to the DOC xPress templates is taken at the risk of the user.

Because of this, users are encouraged to back up the DOC xPress templates folder before beginning any modification work. At this time, the only assistance Pragmatic Works Support may offer is in the restoration of the template files to their original state.

Within the template folder, You will notice four files types and two folders:  

  *.template filescontrol the general layout of an object and the properties that are displayed within that object's page

  *.lookupUsed to manage the lookup key-value pairs that are searched when called from the Lookup( ) Function.

  defaultTemplate.documentControlThis file is responsible for setting what is and is not displayed within templates and Structure Maps using output type flags that are set in the Generate Documentation dialog box.

  StructureMap.*.xmlControls the overall structure of the root object within a Solution Layout. If a valid Structure Map cannot be found then the StructureMap.Default.xml will be used, which is a data dump.

  Images - This folder contains all of the images that are used along side the Image( ) Function.

  TemplateImage – This folder contains small (16x16) and large (32x32) icons for many of the major templates. To add additional TemplateImages, the images must be saved within the TemplateImage folder in the following syntax: <template key><size>

o   template key – The key of the template file that you wish to include, as described in the templates Page( ) function.

o   size – Whether this template image is the small (16x16) or large (32x32) version of the icon

Important Note:

If you plan to use custom templates, please ensure that you take a back-up of the existing templates and point the templates folder to a new location with DOC xPress. You cannot edit the templates, lookups, document control, structure maps, images, or template images in the default folder and must first copy them into a new template location.

Additionally, you may be required to change the template and structure map files from Read-Only before being able to edit them.