TemplateDoc

Since version 2.3 of TrapEd you'll find a templatedoc-utility within the download. This is a sophisticated utility to extract HTML-documentation from your transferproject-file.

It works for Tcl-templates and is build similar to javadoc. Have a look at the example documentation.

In the upper-left frame you'll find the following items:

• a list of all templates sorted alphabetically (opens in the lower-left frame)
• a list of all paths of the templates (see above)
• a list of all tcl-namespaces
• a list of all tcl-functions/procedures (listed alphabetically, added with namespace-information)
• a list of all DB-procedures (opens in main-frame)
• within 'Statistics' you can see a list of templates with their type/state and further information (if you use the Internet Explorer, you can sort these information so that you can find the template with the most template code or the template which 'INCLUDE's the most libraries).
• within 'Log' you'll find some hints on what happend during the production of the HTML and the analysis of the tcl-templates.

Moreover there is the usual project-hierarchy (as also seen in the Vignette client). Simply click on the folder-symbol to open the project. Click on the project-title and the templates will be listed in the lower-left frame.

But wait there's more of it. Did you ever look at a template and wondered: "What the heck, where is this template used/included/...? "
No problem with templatedoc. Open the template in the main-frame, there you find the 'Detailed Info'. Simply check if there are some items in 'directly referenced by'. You can simply click on those templates and open them.

Even when you look at the template-code all the included templates/libraries and the componentes are provided with a link. So you can simply surf through the template-structure to find the necessary information.

This tool has been a lifesaver lots of time for me.

Generate your own

To generate your own HTML-documentation from a transferproject-file you can simply use the templatedoc.kit which is included in the Download.

Open a DOS-box in the traped-directory:
traped.exe -script templatedoc.kit

You will see a userinterface. Simply open the attr-file and provide an output-directory and a good title for that project.