options.html

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

           <dd>Name of the character encoding to set for the generated HTML
               files, for example: iso-8859-15, UTF-8, iso-8859-1,
               windows-1252.</dd>
         <dt><a name="TBaseHTMLDoc.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>
       </dl>

    <h3><a name="OptionTHTMLHelpDoc"><code>THTMLHelpDoc</code></a></h3>
       <dl>
         <dt><a name="THTMLHelpDoc.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="THTMLHelpDoc.AutoCompileHelpProject">AutoCompileHelpProject</a></dt>
           <dd>Compile the HTML help project after generation.</dd>
         <dt><a name="THTMLHelpDoc.FileName">FileName</a></dt>
           <dd>The name of the CHM file to create in the directory (i.e.
               without path).</dd>
         <dt><a name="THTMLHelpDoc.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="OptionTWinHelpDoc"><code>TWinHelpDoc</code></a></h3>
       <dl>
         <dt><a name="TWinHelpDoc.DontOverrideProjectFile">DontOverrideProjectFile</a></dt>
           <dd>Creates the help project file only if it does not exist
               yet.</dd>
         <dt><a name="TWinHelpDoc.DisableHelpFileCompression">DisableHelpFileCompression</a></dt>
           <dd>Disables compression of the help file (a bit faster, but the
               help file will be more than twice the size).</dd>
         <dt><a name="TWinHelpDoc.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="TWinHelpDoc.AutoCompileHelpProject">AutoCompileHelpProject</a></dt>
           <dd>Compile the help project after generation.</dd>
         <dt><a name="TWinHelpDoc.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.</dd>
       </dl>


    <h3><a name="OptionTLaTeXDoc"><code>TLaTeXDoc</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="TLaTeXDoc.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="TLaTeXDoc.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="TLaTeXDoc.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="TLaTeXDoc.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
               only a small set of normal characters, most character have to be
               created by commands or special character sequences. I don't know
               what sequences to use for each character and it may be character
               encoding dependent. So you have here the chance to define them
               yourself.</dd>
       </dl>




    <h3><a name="OptionTBasePDFDoc"><code>TBasePDFDoc</code></a></h3>
       <dl>
         <dt><a name="TBasePDFDoc.UseSansSerifFont">UseSansSerifFont</a></dt>
           <dd>Uses the font Arial/Helvetica instead of Times New Roman.</dd>
         <dt><a name="TBasePDFDoc.FontSize">FontSize</a></dt>
           <dd>Size of the font to use in points.</dd>
         <dt><a name="TBasePDFDoc.LineDistanceScale">LineDistanceScale</a></dt>
           <dd>Factor of the size of the current font to get the distance to
               the next line.</dd>
         <dt><a name="TBasePDFDoc.LinkColor">LinkColor</a></dt>
           <dd>Color of links inside the file as RGB integer value.</dd>
         <dt><a name="TBasePDFDoc.ExternLinkColor">ExternLinkColor</a></dt>
           <dd>Color of links to the Word Wide Web as RGB integer value.</dd>
         <dt><a name="TBasePDFDoc.FileLinkColor">FileLinkColor</a></dt>
           <dd>Color of links to other files as RGB integer value.</dd>
         <dt><a name="TBasePDFDoc.PageMarkingFont">PageMarkingFont</a></dt>
           <dd>Use the font Courier, Arial / Helvetica or Times New Roman when
               printing number of pages etc..</dd>
         <dt><a name="TBasePDFDoc.PageMarkingFontSize">PageMarkingFontSize</a></dt>
           <dd>Size of the font to use when printing number of page etc..</dd>
         <dt><a name="TBasePDFDoc.PageMarkingFontStyle">PageMarkingFontStyle</a></dt>
           <dd>Style of the font to use when printing number of page etc..</dd>
         <dt><a name="TBasePDFDoc.PageWidth">PageWidth</a></dt>
           <dd>Width of the pages in the file in centimeters, default is
               DIN A4.</dd>
         <dt><a name="TBasePDFDoc.PageHeight">PageHeight</a></dt>
           <dd>Height of the pages in the file in centimeters, default is
               DIN A4.</dd>
         <dt><a name="TBasePDFDoc.LeftMargin">LeftMargin</a></dt>
           <dd>Margin on the left of the page, where no text is written.</dd>
         <dt><a name="TBasePDFDoc.RightMargin">RightMargin</a></dt>
           <dd>Margin on the right of the page, where no text is written.</dd>
         <dt><a name="TBasePDFDoc.TopMargin">TopMargin</a></dt>
           <dd>Margin on the top of the page, where no text is written, besides
               the page markings.</dd>
         <dt><a name="TBasePDFDoc.BottomMargin">BottomMargin</a></dt>
           <dd>Margin on the bottom of the page, where no text is written,
               besides the page markings.</dd>
         <dt><a name="TBasePDFDoc.InterpolateImages">InterpolateImages</a></dt>
           <dd>If images should be shown interpolated (smoother) by the viewer
               when showing.</dd>
         <dt><a name="TBasePDFDoc.MaxImageScale">MaxImageScale</a></dt>
           <dd>The maximimum zoom/scale factor of images in the PDF file.</dd>
       </dl>

    <h3><a name="OptionTPDFDoc"><code>TPDFDoc</code></a></h3>
       <dl>
         <dt><a name="TPDFDoc.DisablePDFCompression">DisablePDFCompression</a></dt>
           <dd>Disables compression of the PDF file.<br>
               Documentation of the Delphi 7 Sources:
                                 <code>629 MB</code> (compressed) and
                                 <code>1043 MB</code> (not compressed).</dd>
         <dt><a name="TPDFDoc.FileName">FileName</a></dt>
           <dd>The name of the PDF file to create in the directory (i.e.
               without path).</dd>
         <dt><a name="TPDFDoc.TableOfContentsDetailLevel">TableOfContentsDetailLevel</a></dt>
           <dd>To what sub-level topics will be listed in the table of
               contents. So if you think it is too long, try removing the
               individual members/variables etc. by setting it to 3.</dd>
       </dl>















    <h2>Options of the Extractors of Comments</h2>

    <h3><a name="OptionTSectionExtractor"><code>TSectionExtractor</code></a></h3>
       <dl>
         <dt><a name="TSectionExtractor.SectionSeparator">SectionSeparator</a></dt>
           <dd>The character that starts a new section inside of comments, by
               default &quot;~&quot;. This option should probably always have
               the same value as the option "CommandChar" of the evaluator of
               the comments.</dd>
         <dt><a name="TSectionExtractor.DoNotSectionize">DoNotSectionize</a></dt>
           <dd>Don't split the comments into sections, this option should
               probably always have the same value as the option
               "DontParseComments" of the evaluator of the comments to treat
               them as a general comment without special characters.</dd>
         <dt><a name="TSectionExtractor.SectionName_param">SectionName_<b>*</b></a> <i>(several)</i></dt>
           <dd>The words the sections are marked with in the comments. Multiple
               names can be defined separated by commas.</dd>
       </dl>

    <h3><a name="OptionTSourceCommentExtractor"><code>TSourceCommentExtractor</code></a></h3>
       <dl>
         <dt><a name="TSourceCommentExtractor.IgnoreIdentifierComments">IgnoreIdentifierComments</a></dt>
           <dd>Ignore all comments on identifiers (usefull if not commented for
               <em>DelphiDoc</em>).</dd>
         <dt><a name="TSourceCommentExtractor.IgnoreFileComments">IgnoreFileComments</a></dt>
           <dd>Ignore all comments on files (usefull if not commented for
               <em>DelphiDoc</em>).</dd>
         <dt><a name="TSourceCommentExtractor.GetForwardComments">GetForwardComments</a></dt>
           <dd>Get comments from the forward-declaration instead of the
               implementation if possible.</dd>
         <dt><a name="TSourceCommentExtractor.FallBackToOtherPositionForComment">FallBackToOtherPositionForComment</a></dt>
           <dd>If no comment at the position of an identifier has been found,
               try its forward declaration or vice versa.</dd>
         <dt><a name="TSourceCommentExtractor.FileCommentAfterFirstStatement">FileCommentAfterFirstStatement</a></dt>
           <dd>Get the comments on files after the first statement (after
               unit, program, etc.) (f.i. to skip legal comments).</dd>
         <dt><a name="TSourceCommentExtractor.UseOnlyStaredComments">UseOnlyStaredComments</a></dt>
           <dd>Ignores comments if they don't start with a star &quot;*&quot;.
               Be sure to also check <code>RemoveLeadingStar