The 'Generate Help' Dialog

Output Folder

Use this field to specify a file system folder, into which the generated files should be written.

Note:  Do not choose "C:\" as the output folder, as the generator cannot extract the necessary files into the root folder.

Templates Location

This field is used to specify the folder in which the generator can find the template files used in the generation process.

By default, this field will be empty, however, when the 'browse' button is used to select an output folder, this field will be updated with the value 'Templates', as a sub-folder of the selected output folder.

On every run of the Help Generator, a default set of template files will be copied into the folder specified here.  Existing files within the folder will not be overwritten.

Master Template

The 'master template' file acts as the container for the generated content.

By default, the value of this field is 'HelpPageTemplate.html'.  This file is part of the set of template files provided by Enterprise Architect.  It is intended to be used as a starting point for creating HTML files that will be viewed from your local file system.

A second 'master template' file named 'HelpPageTemplateWeb.html' is also provided in the set of template files.  This file is intended as a starting point for creating web-based files.

You are free to copy and modify these file to suit your specific needs - in that case you would specify the name of the modified file.

Translate into

Use the drop-down list in this field to choose a target language for translation.  The element names and Notes fields will be translated into this language during generation, resulting in HTML file rendered in the chosen language.

Note:  Translation services are only available when you connect to your Enterprise Architect model using Pro Cloud Server, and only when the required SBPI facilities have been set up.  Otherwise, "SBPI unavailable" will be shown in the drop-down list.

Update Translation

The values in the drop-down list of this field are used to control whether the generator uses a saved translation string or queries the translation service to retrieve a new translation string.

• Never - Do not query the translation service for a new translation string. Use the saved translation if one exists.
• Auto - Query the translation service for a new translation string, only when the Name, or Notes of the element being processed have been updated since the last translation string was saved. Otherwise, use the saved translation.
• Always - Query the translation service and retrieve a new translation string in every case.

Whenever a new translation string is retrieved, it is saved in the model.

Web Site Path

This field is used to specify the URL of the web site's root folder.

The value is used when writing entries for the file 'site-map.xml'.  It can also be used to substitute the placeholder "#SITE_PATH#" in the master template file.

Generation Options

Generate Sub-Packages - Select this option when generating a full set of HTML files for publication.  By de-selecting this option, you can generate an HTML file for just the package or topic selected in the Browser window, which is very useful when you want to review changes you have made to a single topic.

Write errors to 'Errors.txt' - Choose whether or not errors and warnings from the generation process should be written to the file 'errors.txt' in the specified output folder.

Generate Image Captions - Use this option to specify whether or not to generate the HTML <caption> tag for images that are embedded in the element's Notes fields.  The text for the caption is retrieved from the Notes field of an Image Artifact element, or from the 'Description' field of an image stored in the Image Manager.