Auto Documentor Templates
The templates define the appearance of the compiled HTML help file that Auto Documentor generates.
Overview Template
Files
The 'CHM.hhp' file is the project file for the HTML file. The main object affecting the appearance of the compiled
help file is the CSS style sheet file 'Styles.css' located in the Templates folder off the TurboVB install folder.
Modify this file to change colours or fonts etc. There are also settings within each of the ten template types. Various
settings in the 'General' tab of Auto Documentor Options will also affect
the appearance of the help file.
Standard Elements
The 'Standard Elements' are replaced with the required text at help file generation. For example in the Statistics page the
elements '{StatsFormCount}' and '{StatsCodeLinesCount}' would be replaced by '5' and '5342', if they were the counts
for that particular project.
The elements for the Description, References, Stats and Overview types are listed and described below: -
| {Name} | Project Name |
| {Description} | Description |
| {Type} | Type |
| {HelpFile} | Path to Help file |
| {MajorVer} | Major Version |
| {MinorVer} | Minor Version |
| {RevisionVer} | Revision Version |
| {CompatibleMode} | Version Compatibility Type |
| {CompatibleEXE32} | Path to File used |
Description
|
| {References} | Start of collection of references |
| {/References} | End of collection of references |
| {ReferencesFilename} | Reference Filename |
| {ReferencesVersion} | Version |
| {ReferencesDescription} | Description |
| | |
| References |
| | |
| | |
|
| {ProjectName} | Project Name |
| {StatsFormCount} | Form Count |
| {StatsStandardModuleCount} | Module Count |
| {StatsClassModuleCount} | Class Count |
| {StatsUserControlCount} | User Control Count |
| {StatsPropertyPageCount} | Property Page Count |
| {StatsProceduresCount} | Procedures Count |
| {StatsConstsCount} | Constants Count |
| {StatsEventsCount} | Events Count |
| {StatsPropertiesCount} | Properties Count |
| {StatsModuleVariablesCount} | Module Variables Count |
| {StatsDeclarationLinesCount} | Declaration Lines Count |
| {StatsCommentLinesCount} | Comment Lines Count |
| {StatsCodeLinesCount} | Code Lines Count |
| {StatsBlankLinesCount} | Blank Lines Count |
| | |
| Stats |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
|
| {ModuleName} | Name of the Module |
| {Procedures} | Start of collection of procedures |
| {/Procedures} | End of collection of procedures |
| {ProceduresName} | Name |
| {ProceduresScope} | Scope |
| {ProceduresType} | Sub or Function |
| {ProceduresReturn} | If function return type |
| {Properties} | Start of collection of properties |
| {/Properties} | End of collection of properties |
| {PropertiesName} | Name |
| {PropertiesScope} | Scope |
| {PropertiesDefinition} | For example 'Get/Let' |
| {ModuleVariables} | Start of collection of module variables |
| {/ModuleVariables} | End of collection of module variables |
| {ModuleVariablesName} | Name |
| {ModuleVariablesScope} | Scope |
| {ModuleVariablesType} | Type |
| {SourceCode} | The code for the module |
| {Constants} | Start of collection of constants |
| {/Constants} | End of collection of constants |
| {ConstantsName} | Name |
| {ConstantsScope} | Scope |
| {ConstantsValue} | Value |
| {Enums} | Start of collection of enums |
| {/Enums} | End of collection of enums |
| {EnumsName} | Name |
| {EnumsScope} | Scope |
| {UDTs} | Start of collection of UDTs |
| {/UDTs} | End of collection of UDTs |
| {UDTsName} | Name |
| {UDTsScope} | Scope |
| {Events} | Start of collection of events |
| {/Events} | End of collection of events |
| {EventsName} | Name |
| {DefaultSelections} | Used in the Default Selections options |
| {RemoveTables} | Used by the Remove Tables option |
Overview
|
The 'Collection' types referenced in the OverView type are used in a loop so that all Procedures etc. are written out
to the HTML file. The HTML used between the Start and End Elements will be repeated for each instance.
The 'Standard Elements' used in the other types are very similiar to those described above.