options.html

DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. At the momen

    <h3><a name="OptionTICBaseHTMLDoc"><code>TICBaseHTMLDoc</code></a></h3>
       <dl>
         <dt><a name="TICBaseHTMLDoc.DontOverrideCSSFile">DontOverrideCSSFile</a></dt>
           <dd>Creates the CSS file only if it does not exist yet.</dd>
         <dt><a name="TICBaseHTMLDoc.TextHeaderFile">TextHeaderFile</a></dt>
           <dd>The file to insert instead of the default text at the beginning
               of each HTML file. The texts <code>&lt;topic&gt;</code>,
               <code>&lt;keywords&gt;</code>, <code>&lt;mainpath&gt;</code> and
               <code>&lt;encoding&gt;</code> will be replaced with the actual
               values, case does matter.<br> 
               <code>&lt;topic&gt;</code> will be replaced with the title of
               the page, <code>&lt;keywords&gt;</code> with all key words of
               the page and <code>&lt;mainpath&gt;</code> with the path to the
               main directory of the documentation, in most cases "" but may
               also be "../" or "../../", it can for instance be used to link
               to the common CSS file. <code>&lt;encoding&gt;</code> will be
               replaced with the character encoding as specified with the
               option "CharacterEncoding".</dd>
         <dt><a name="TICBaseHTMLDoc.TextFooterFile">TextFooterFile</a></dt>
           <dd>The file to insert instead of the default text at the end of
               each HTML-file.</dd>
         <dt><a name="TICBaseHTMLDoc.CharacterEncoding">CharacterEncoding</a></dt>
           <dd>Name of the character encoding to set for the generated HTML
               files, for example "iso-8859-15", "UTF-8", "iso-8859-1" or
               "windows-1252".</dd>
         <dt><a name="TICBaseHTMLDoc.DontQuoteSpecialCharacters">DontQuoteSpecialCharacters</a></dt>
           <dd>Whether special HTML-characters should not be quoted and just
               passed on into the documentation, handy if the source code is
               commented with HTML format. All special characters,
               &lt;, &gt;, &amp; and &quot;, have to be quoted manually, if
               not used as HTML tags (as &amp;lt;, &amp;gt;, &amp;amp; and
               &amp;quot;). When employing this options of course generating
               the documentation in a format other than HTML will intersperse
               the text with the cryptic HTML tags.</dd>
         <dt><a name="TICBaseHTMLDoc.UseCSS">UseCSS</a></dt>
           <dd>Whether Cascading Style-Sheets should be used instead of some
               (deprecated) HTML tags and attributes.</dd>
         <dt><a name="TICBaseHTMLDoc.XMLConformity">XMLConformity</a></dt>
           <dd>Whether XML conform (well-formed) files should be generated.
               Other option may be used to make the files further XHTML
               conform.</dd>
         <dt><a name="TICBaseHTMLDoc.UseXHTMLHeader">UseXHTMLHeader</a></dt>
           <dd>Whether the <a href="http://www.w3.org/TR/xhtml1/">XHTML</a>
               header should be used instead of HTML 4.01 (transitional).
               Options "XMLConformity" and "UseCSS" should also be enabled. But
               a note as warning, the format may not be perfect. Some inline
               commands in the comments may cause a non-conforming file to be
               created (like a link around a paragraph boundary or images in
               ~[preformatted text]). Browsers may (and should) deny the
               rendering of faulty XHTML files, thus the user will not see the
               content but an error message. So if this option is used, all
               files should be checked with an XML validator before
               distributing them. To force browsers to actually render the
               files using XML, the option "FileExtension" should also be set
               to ".xhtml".</dd>
         <dt><a name="TICBaseHTMLDoc.FileExtension">FileExtension</a></dt>
           <dd>The extension of the (X)HTML files to be created; can be changed
               to ".htm" for better compatibility or to ".xhtml" if option
               "XMLConformity" is enabled. Be sure to include the leading dot
               "." before the actual extension.</dd>
         <dt><a name="TICBaseHTMLDoc.GenerateHelpContextRedirector">GenerateHelpContextRedirector</a></dt>
           <dd>Whether a HTML file should be generated that can be called with
               the number of a help context to redirect to the topic specified
               by it. The help context should just be added after the file name
               and "#HC". This is done with the help of
               <a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript</a>
               (JavaScript), if it fails (f.i. because JavaScript is disabled)
               the user will be left stranded on the page, to work at least
               partially around that you might want to use the option
               "GenerateVisualHelpContextRedirector" instead.</dd>
         <dt><a name="TICBaseHTMLDoc.GenerateVisualHelpContextRedirector">GenerateVisualHelpContextRedirector</a></dt>
           <dd>Whether a HTML file should be generated that can be called with
               the number of a help context to redirect to the topic specified
               by it. The help context should just be added after the file name
               and "#HC". This is done with the help of
               <a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript</a>
               (JavaScript).<br>
               For each help context a visible link will also be created which
               will be automatically shown, so even if the redirection fails
               the user has only to click the (highlighted) link to get to the
               actual documentation.</dd>
         <dt><a name="TICBaseHTMLDoc.GenerateFileAndClassesTreeSVGWithLinks">GenerateFileAndClassesTreeSVGWithLinks</a></dt>
           <dd>Whether the simple diagrams showing the inter-dependence
               between the files and the inheritance tree of classes and
               interfaces should contain links to the documentation of the
               files and classes in the image format Scalable Vector
               Graphics.</dd>
         <dt><a name="TICBaseHTMLDoc.HTMLDiagramFormat">HTMLDiagramFormat</a></dt>
           <dd>The image format in which diagrams should be exported can be
               selected, the default is "PNG" - Portable Network Graphics -,
               also supported is "SVG" - Scalable Vector Graphics -, which
               could be much smaller and powerful, but the support for this
               format in browsers is sadly after 9 years still in its infancy.
               "SVGz" for compressed SVG files is also available but the
               browser support for those is even worse.</dd>
         <dt><a name="TICBaseHTMLDoc.SVGDiagramsWithLinks">SVGDiagramsWithLinks</a></dt>
           <dd>If diagrams are exported as SVG files (via option
               "HTMLDiagramFormat") the links on the classes and files can be
               included directly in the image file instead of the HTML file
               embedding it. This is the default and preferred because SVG
               files are dynamic and the shown position of the files and
               classes may change below the link mask, and because it won't
               work if a plug-in is used to show the image.</dd>
       </dl>




    <h3><a name="OptionTICHTMLHelpDoc"><code>TICHTMLHelpDoc</code></a></h3>
       <dl>
         <dt><a name="TICHTMLHelpDoc.HelpCompilerPath">HelpCompilerPath</a></dt>
           <dd>The path and name of the HTML help compiler &quot;hhc.exe&quot;.
                If not set the generator searches the compiler on its own.</dd>
         <dt><a name="TICHTMLHelpDoc.AutoCompileHelpProject">AutoCompileHelpProject</a></dt>
           <dd>Whether the HTML help project should be compiled automatically
               after it has been generated.</dd>
         <dt><a name="TICHTMLHelpDoc.FileName">FileName</a></dt>
           <dd>The name of the CHM file to create in the directory (i.e.
               without path).</dd>
         <dt><a name="TICHTMLHelpDoc.UseSubdirectories">UseSubdirectories</a></dt>
           <dd>The source HTML files can be spread to several sub-directories.
               This makes it possible to generate HTML Help even for big
               projects on volumes formated with FAT32, which has some
               limitations on the number of files per directory. Be aware of
               this, if you use custom headers for the HTML files and you use a
               global file (f.i. the CSS file), that you have to prepend
               &lt;mainpath&gt; to the file's name. Either no sub-directories
               can be used or one sub-directory for each pascal file or even
               sub-sub-directories for all record-like types in the files.</dd>
       </dl>


    <h3><a name="OptionTICWinHelpDoc"><code>TICWinHelpDoc</code></a></h3>
       <dl>
         <dt><a name="TICWinHelpDoc.DontOverrideProjectFile">DontOverrideProjectFile</a></dt>
           <dd>Creates the help project files only if they do not exist
               yet. This option can be usefull in case the files were
               customized.</dd>
         <dt><a name="TICWinHelpDoc.DisableHelpFileCompression">DisableHelpFileCompression</a></dt>
           <dd>Disables compression of the help file (faster compilation, but
               the help file(s) will be more than twice the size). Compressing
               the help file take considerably longer than the whole rest of
               the generation, so it would probably be better to only use
               compression for the final documentation.</dd>
         <dt><a name="TICWinHelpDoc.HelpCompilerPath">HelpCompilerPath</a></dt>
           <dd>The path and name of the help compiler &quot;hcrtf.exe&quot;. If
               not set the generator searches the compiler on its own.</dd>
         <dt><a name="TICWinHelpDoc.AutoCompileHelpProject">AutoCompileHelpProject</a></dt>
           <dd>Whether the help project should be compiled automatically after
               it has been generated.</dd>
         <dt><a name="TICWinHelpDoc.FileName">FileName</a></dt>
           <dd>The name of the Windows Help file to create in the directory
               (i.e. without path). This is important because the content file
               will be named the same way, and they can't just be renamed
               without losing the linkage between them. It is also the base
               name for additional files when using the option
               "ExtraWinHelpFilesFor" and leaving the option
               "ExtraWinHelpFilesPrefix" empty.</dd>
         <dt><a name="TICWinHelpDoc.ExtraWinHelpFilesFor">ExtraWinHelpFilesFor</a></dt>
           <dd>For which parts of the documentation extra files should be
               generated to split it into several files in case it gets too
               substantial to be compiled by the Windows Help compiler. The
               files will use the value of the option
               "ExtraWinHelpFilesPrefix" as part of their base name unless it
               is empty, in that case the value of the option "FileName" is
               used.<br>
               Parts with help contexts should not be split into several files,
               this means especially the additional user documentation should
               not be splitted from the help on a GUI.
               </dd>
         <dt><a name="TICWinHelpDoc.ExtraWinHelpFilesPrefix">ExtraWinHelpFilesPrefix</a></dt>
           <dd>Prefix for the extra Windows Help files, if empty uses the value
               of the option "FileName".</dd>
         <dt><a name="TICWinHelpDoc.GenerateHelpContextFileMapping">GenerateHelpContextFileMapping</a></dt>
           <dd>Whether a file mapping the help contexts to the help files
               containing the topics they point to should be generated. The
               created file "HelpContextFileMap.ini" will contain only the
               section "ContextFileMapping". In it the keys are the help
               contexts and the value the name of the file their topics are
               defined in. If only one help file contains all topics for which
               help contexts are defined, an additional entry "all" will
               written (as the first entry) with the value being the name of
               the file.</dd>
       </dl>



    <h3><a name="OptionTICLaTeXDoc"><code>TICLaTeXDoc</code></a></h3>

       <p>Here are only a few options, you are expected to adjust the main file
          <code>DelphiDoc.tex</code> according to your needs.</p>

       <dl>
         <dt><a name="TICLaTeXDoc.DontOverrideMainFile">DontOverrideMainFile</a></dt>
           <dd>Creates the main
               L<small><sup>A</sup></small>T<small><sub>E</sub></small>X-file
               <code>DelphiDoc.tex</code> only if it does not exist yet (in
               case you want to change it).</dd>
         <dt><a name="TICLaTeXDoc.UseSimpleTextAsLinks">UseSimpleTextAsLinks</a></dt>
           <dd>Uses simple texts without links to refer to other identifiers
               etc.. That's more suitable for printing.</dd>
         <dt><a name="TICLaTeXDoc.ApplyCharacterTranslation">ApplyCharacterTranslation</a></dt>
           <dd>Whether special characters should be translated via the
               "CharTranslation_&lt;<i>nnn</i>&gt;" options. Some
               packages/versions of
               L<small><sup>A</sup></small>T<small><sub>E</sub></small>X seem
               to support reading non ASCII texts and use an encoding, so the
               manual translation can be disabled here.</dd>
         <dt><a name="TICLaTeXDoc.CharTranslation_127">CharTranslation_&lt;<i>nnn</i>&gt;</a></dt>
           <dd>The characters the character with that ASCII code should be
               replaced with.
               L<small><sup>A</sup></small>T<small><sub>E</sub></small>X has