| Prev | Next |
Generating HTML Files
After constructing a Help model in Enterprise Architect, you can then generate HTML files from the model, suitable for uploading to a web site, or for use on a local file system.
The generation process is as simple as choosing the package for which to generate Help pages and invoking the 'Generate Help' command. In the dialog that displays, specify an output folder, specify the location of the template files, specify the master template file to use, then click on 'Generate'.
Access
|
Browser menu |
In the Browser window, right-click on a «HelpPackage», «HelpTopic» or a «HelpTopicProxy» element, then choose the menu option 'Generate Help on Current Item'. |
|
Ribbon |
With a «HelpPackage», «HelpTopic» or a «HelpTopicProxy» element selected in the Browser window, choose the ribbon option "Publish > Model Reports > Generate Help". |
Steps for Generating HTML Files
The table below steps through the procedure for generating HTML files from your Help model, in its simplest form, using only the default values.
The 'Generate Help' dialog is explained in detail in the help topic 'The Generate Help Dialog'.
Step |
Description |
See also |
|---|---|---|
|
Select the Package/Topic to Generate |
In the Browser window, right-click on a «HelpPackage», «HelpTopic» or a «HelpTopicProxy», then choose the command 'Generate Help for Current Item'. The 'Generate Help' dialog is displayed. |
The 'Generate Help' Dialog |
|
Select an Output Folder |
Use the 'browse' button to select an existing folder on your file system, in which to write the generated HTML files. Note: Do not choose "C:\" as the output folder, as the generator cannot extract the necessary files into the root folder. |
|
|
Specify the Location of the Template Files |
If this is the first run of the Help Generator, the 'Templates Location' field was empty up to this point. When the 'Output Folder' is selected using the 'browse' button, the 'Templates Location' is updated with the value 'Templates', as a sub-folder of the chosen output folder. Note: The Help Generator will copy the set of provided template files into the specified 'Templates Location' on every run, if the files do not already exist in that location. |
Help Template Files |
|
Specify the Master Template to Use |
The 'Master Template' field will have been populated with the default value 'HelpPageTemplate.html'. For now, leave this value as is. |
Help Template Files |
|
Generate |
Click on the 'Generate' button to generate a set of HTML files for the model hierarchy starting at the selected «HelpPackage». The System Output window is displayed and a processing log is written into the 'Help System' page of that window. |
|
|
View the Generated Files |
At the top of the processing log in the System Output window, you will find the full path of the file generated for the root package of the model branch you just generated. Open a web browser and load the file named in the output window. |
Template Files
A set of ready to use template files is provided as part of Enterprise Architect. The template files will be extracted into a sub-folder named 'Templates' in your specified output folder each time you generate HTML files. Once the files have been copied to the output folder, you are free to modify them to suit your own needs. Existing files will not be overwritten when you next generate your HTML files.
It is expected that you will customize the master template file to suit your own needs, however, it is far less likely that you will need to modify the element template files.
For detailed information on the template files, see the Help topic Help Template Files.
CSS File
A CSS file named 'user-guide.css' that defines the styles used by the generated HTML is also provided as part of Enterprise Architect. When generating HTML files, this file is also extracted into your specified output folder if it does not already exist there. Once the file exists in your output folder, you can update the styles it defines to suit your needs.