www.pudn.com > Delphi-Script-30.rar > dhman_use.html, change:2012-04-12,size:45774b


<html> 
 
<head> 
<title>How to use</title> 
<link rel="stylesheet" type="text/css" href="general.css"> 
</head> 
 
<body> 
 
<h1>How to use program.</h1> 
<p>This chapter contains detailed information about <em>dHelp</em> usage 
and formats of input and output files. Here you can find information about:</p> 
<ul> 
  <li style="margin-top: 15; margin-bottom: 15"><a href="#Run">Command line 
    parameters</a> describes the format, meaning and default values of all 
    command line parameters. </li> 
  <li style="margin-top: 15; margin-bottom: 15"><a href="#Project_Management_Controls">Project 
    management controls</a> describes the main element of the user interfaces 
    through which help project can be managed.</li> 
  <li style="margin-top: 15; margin-bottom: 15"><a href="#description">Format of 
    the topic description files</a> describes in detail the structure and 
    process of the creation of the topic description files. Provides an example 
    of the single topic description.</li> 
  <li style="margin-top: 15; margin-bottom: 15"><a href="#Precompiled_headers">Precompiled 
    headers (.DPU files)</a> describes what precompiled headers are, how they 
    can be used and how you can generate them.</li> 
</ul> 
<a name="Run"></a><hr> 
<h1>Command line parameters</h1> 
<p>dHelp has number of command line parameters that define program 
behavior and allow you to include dHelp into automatic generation routines. The format of 
the command line of the dHelp 
Pro program is:</p> 
<p><b><font color="#000080">    dHelp <op_type> 
<project_file> [[-<parameter_1> [-<parameter_2> [...]]]]</font></b></p> 
<p style="margin-bottom: 0"><b><op_type></b> – this parameter can have 
one of the following values:<br> 
 </p> 
<table border="0" cellspacing="0" width="100%" 
style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" 
    nowrap> 
      <p style="TEXT-ALIGN: center"> Value </th> 
    <th 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" 
    nowrap width="100%">    Description</th> 
  </tr> 
  <tr> 
    <td nowrap style="border-bottom-style: solid; border-bottom-width: 1"> 
      <p style="TEXT-ALIGN: center"><b>b</b></p> 
    </td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Generates 
      help file without showing dHelp manager. If this option is specified in 
      the command line program finishes after help generation is completed.</td> 
  </tr> 
  <tr> 
    <td 
    style="border-bottom-style: solid; border-bottom-width: 1;TEXT-ALIGN: center" 
    nowrap><b>i</b></td> 
    <td nowrap width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Installs 
      help file into Delphi/C++ Builder help.</td> 
  </tr> 
  <tr> 
    <td style="TEXT-ALIGN: center" nowrap><b>u</b></td> 
    <td nowrap width="100%" 
    style="border-left-style: solid; border-left-width: 1">Uninstalls help file 
      from Delphi/C++ Builder help.</td> 
  </tr> 
</table> 
<p><b><project_file></b>–specifies the name of the file with project 
options. 
<p><b>Note</b>: When <b><op_type></b> is <b>i</b> or <b>u</b> then <b><project_file></b> 
must be a name of the help file, which will be installed or uninstalled. 
<p><b>Parameters</b> - a set of the following parameters:</p> 
<table border="0" cellspacing="0" width="100%" 
style="border-style: solid; border-width: 1"> 
  <tr> 
    <th width="70" valign="top" 
    style="text-align: Center; border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Value</th> 
    <th 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2">Description</th> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">DEFxxx</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies 
      defines xxx. Multiple items can be separated with semicolon.</td> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">IDEFxxx</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies 
      ignore defines xxx. Multiple items can be separated with semicolon.</td> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">INCxxx</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies 
      include path xxx. Multiple items can be separated with semicolon. </td> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">VERxx</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies 
      version of the Delphi or C++ Builder to which help file should be linked: 
      <table border="0" cellspacing="0" width="100%" 
      style="border-style: solid; border-width: 1"> 
        <tr> 
          <th nowrap 
          style="text-align: Center; border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" 
          align="center"> Value </th> 
          <th nowrap width="100%" 
          style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2">Description</th> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>C1</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            C++ Builder 1.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>C3</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            C++ Builder 3.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>C4</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            C++ Builder 4.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>D2</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            Delphi 2.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>D3</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            Delphi 3.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>D4</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
            Delphi 4.</td> 
        </tr> 
        <tr> 
          <td nowrap style="text-align: Center"><b>D5</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1">for Delphi 5.</td> 
        </tr> 
      </table> 
    </td> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">IGNDPU</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Determines 
      whether to ignore existing <a href="#Precompiled_headers">DPU files</a>. 
      If parameter is not specified, parser will use previously compiled 
      information for modules that have not been changed. 
    </td> 
  </tr> 
  <tr> 
    <td width="70" valign="top" 
    style="border-bottom-style: solid; border-bottom-width: 1">KIND</td> 
    <td 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies 
      the type of creating help file: 
      <table border="0" cellspacing="0" width="100%" 
      style="border-style: solid; border-width: 1"> 
        <tr> 
          <th nowrap 
          style="text-align: Center; border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" 
          align="center"> Value </th> 
          <th nowrap width="100%" 
          style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2">Description</th> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>CHM</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
      generating help file in the CHM format.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>HLP</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
      generating help file in the HLP format.</td> 
        </tr> 
        <tr> 
          <td nowrap 
          style="text-align: Center; border-bottom-style: solid; border-bottom-width: 1"><b>HTML</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">for 
      generating manual in the HTML format.</td> 
        </tr> 
        <tr> 
          <td nowrap style="text-align: Center"><b>RTF</b></td> 
          <td nowrap width="100%" 
          style="border-left-style: solid; border-left-width: 1">for 
      generating manual in the RTF format.</td> 
        </tr> 
      </table> 
By default, if this field is not assigned, program generates HLP file. 
    </td> 
  </tr> 
  <tr> 
    <td width="70" valign="top">F</td> 
    <td style="border-left-style: solid; border-left-width: 1"> 
      When this parameter is specified in the command line program will not stop 
      after help is generated. 
      <p>By default when dHelp generates help messages window with help 
      processing results is shown. Program will finish only when messages window 
      is closed by user.</td> 
  </tr> 
</table> 
<p>Here is the sample command line that can be passed to dHelp:</p> 
<center> 
<table border="0" cellspacing="0" width="455" class="Example"> 
  <tr> 
    <td nowrap> 
      <p style="margin-left: 15; margin-right: 15"><b>dHelp</b> b help.hpc 
      <b>-DEF</b>Debug <b>-IDEF</b>Profile <b>-INC</b>C:\UNITS;..\..\UNITS <b>-VER</b>D5 
      <b>-IGNDPU -F</b></p> 
    </td> 
  </tr> 
</table> 
</center><br> 
<a name="Project_Management_Controls"><hr> 
<h1></a>Project management </h1> 
<p><a name="Project_Option_Menu"></a> You can use main menu to open, save, and to add new units to the open project.</p><a name="Project_Menu_File"></a><p><b><a name="Project_Menu_File"></a></b>  
<hr> 
<p><b>File</b> - group contains controls for help projects loading and 
savings.<br> 
  
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <tr> 
    <a name="Project_SourceFiles"></a> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>New</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Creates 
      a new project and initializes its properties.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Load</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Loads existing <a href="#File_Projectcomment">projects</a>.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Save</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Saves the current help <a href="#File_Projectcomment">project</a> using 
      its current name</td> 
  </tr> 
  <tr> 
    <a name="Project_TopicDesc"></a> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Save 
      As ...</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Saves the current help project using a new name.</td> 
  </tr> 
  <tr> 
    <a name="Project_Topics"></a> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Team 
      work support</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      dHelp supports team work on a single help project. Each 
      member of a team writes help in separate files in <a href="#description">plain 
      text format</a>. Team leader can distribute task in the form of <a href="#description">description 
      frames</a> . To do so he can export 
      empty topics description to files with plain text format and then merge team 
      members' work in a help project using importing 
      descriptions of the topics from <a href="#description">text files</a>. <br> 
      Export can be used for further storing topics description in archive. 
      Export/Import options are also very useful if you need to share the description 
      of several topics between several help projects. 
    </td> 
  </tr> 
  <tr> 
    <a name="Project_IgnoreTopics"></a> 
  </tr> 
  <tr> 
    <a name="Project_General"></a> 
    <td valign="top" nowrap><b>Exit</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1">Closes 
      the open project and exits dHelp. 
    </td> 
  </tr> 
</table> 
<p><a name="File_Projectcomment"></a>Help project is stored in a single “.hpc” file. It contains project 
options, the list of source code units and entered help descriptions. Information stored 
in project file allows you to work on the help project even if you have no source 
code of the units. 
<p><a name="Project_Menu_Project"></a> 
<hr> 
<p>Use <b>Project</b> menu to manage project 
options. Here you can add new units to the open project, update the project 
contents using the latest changes in source code, customize different project options 
and build help files.<br> 
  
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Add 
      units</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Chooses 
      'Add units' item to add source code units into open help project.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Refresh 
      contents tree</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Rescans the source units and updates the help contents. New topics will be added into 
      contents section. dHelp will inform user about topics that 
      are no longer exist and suggest you to choose whether to delete inactive 
      descriptions or store them in files with <a href="#description">plain text 
      format</a>. </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Build 
      help</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Generates help file. When you select this file <a href="#Project_BuildHelp">help 
      building options</a> dialog is displayed as a start of help building process.</td> 
  </tr> 
  <tr> 
    <td valign="top" nowrap><b>Options</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1">Shows 
      dialog for customizing <a href="#Project_Option"> help project options</a>. 
    </td> 
  </tr> 
</table> 
<p><a name="Project_Menu_View"></a> 
<hr> 
<p>Use <b>View</b>  menu to manage the current view of the project contents section. 
Here you can highlight not described or partially described 
topics, manage the contents section and customize what diagnostic windows are 
displayed by the program.</p> 
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Highlight 
      partially described topics</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Allows 
      to mark out topics that have not completed description. 
      <p>Description for each topic consists of two parts: short and long 
      descriptions. Short description contains brief information about the main 
      topics functionality and purpose. Long description contains more substantial 
      description of the topic functionality, enlist and describe every 
      parameters if any exists and so on. Topics that have one of the description part 
      empty are considered as partially described.</p> 
      <p>When '<i>Highlight partially described topics</i>' is checked in all 
      partially described topics will be displayed with bold font in contents 
      section.</p> 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Highlight 
      not described topics</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      Marks out topics that have neither long nor brief description. When '<i>Highlight 
      not described topics</i>' is checked in all not described topics will be 
      displayed with bold font in contents section. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Disable 
      topics grouping</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
      When '<i>Disable topics grouping</i>' item is checked in classes, 
      interface, types and procedures will not be grouped in alphabetical lists. 
      All items will be only sorted in alphabetical order and setting in '<i>Help 
      contents setting</i>' option will be ignored. 
      <p><b>Note</b>: This option works only while designing help. When the help 
      is generated topics are grouped depending on the settings in <a href="#Project_Option">project 
      options</a>.</p> 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" nowrap><b>Show messages window</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1">Shows/Hides 
      window with processing messages list. List is refreshed each time the contents tree 
      or help file are built. It contains diagnostic information, warnings and 
      error messages generated generated during source code units parsing, topics list 
      processing and help building process. 
    </td> 
  </tr> 
</table> 
<p><a name="Project_Menu_Help"></a> 
<hr> 
<p>Use the <b> Help</b> menu to access the online Help system, which is displayed in a special Help window.<br> 
</p> 
<a name="Project_Option"><hr> 
</a> 
<h2>Custom help project options window.</h2> 
<p>Main help project options are divided into three groups:</p> 
<ul> 
  <li><b><a href="#Project_Option_General">General options</a></b> - contains 
    common management information about project contents, and Delphi version which 
    will be used while parsing source code units.</li> 
  <li><b><a href="#Project_Option_Dirs">Directories/Conditions</a></b> - 
    specifies the location of files used while parsing the units, and the place 
    where generated files and diagnostic information will be stored. Group 
    also contains conditional defines and module aliases used while parsing 
    source code units.</li> 
  <li><b><a href="#Project_Option_HelpGen">Help generation</a></b> - options that 
    customize the contents of the generated help. Here you can specify used images, 
    and rules used to generate contents section.</li> 
</ul> 
<p><a name="Project_Option_General"></a><hr> 
<h3>General options.</h3> 
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" valign="top"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Used 
      units</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" valign="top">Specify 
      source units used in the project. 
      <p><b>Note</b>: You can use INT files as well cause only interface section 
      is processed</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1"><b>Include 
      protected methods and properties</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" valign="top"> 
<p>Determines whether protected methods and properties are included in the 
generated help. </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Help 
      window title</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" valign="top"> 
      Specifies the title of the help 
      window and contents section.</td> 
  </tr> 
  <tr> 
    <td valign="top" nowrap><b>Used units compiler</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1" valign="top"> 
<p>Specifies the version of Delphi/CPB for which the help will be generated. 
This value is also used to make the links to standard VCL help.<p><b>Note</b>: 
      You can specify version in the command line in <b><a href="#Run">-VER</a></b>  
      parameter. When <b><a href="#Run">-VER</a></b>   is specified it has 
higher priority. 
    </td> 
  </tr> 
</table> 
<p><a name="Project_Option_Dirs"><hr> 
<h3></a>Directories/Conditions.</h3> 
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <a name="Project_DestFolder"></a> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Destination</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Determines the folder where intermediate files and resulting help file will 
be placed. 
      <p>By default dHelp creates help file in the folder where 
project file is located.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Include 
      folders</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
<p>Specifies the location of your source files. If you try to parse modules that are not located on the search path they will be 
considered as empty. The search path for standard VCL units is added automatically. You can separate multiple folders with 
semicolons. 
<p><b>Note</b>: Folders that are passed from the command line through <b><a 
href="#Run">-INC</a></b> parameter will be added automatically to the end of 
this list.</p> 
<p>If you use <a href="#Precompiled_headers">.DPU files</a> instead of source 
code units you must specify their location in <b>IncludeFolders</b> field.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Log 
      folder</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
<p>Defines the folder where files with <a href="dhman_logs.html">diagnostic 
information</a> will be placed when <a href="#Project_CreateLogFiles"> creating diagnostic files</a> is enabled on '<i><a href="#Project_Option_HelpGen">Help 
generation</a></i>' tab. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Conditional 
      defines</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
<p>Specifies defines that will be used when parsing the source code. You can 
separate multiple defines with semicolons. 
<p><b>Note</b>: Defines that are passed from the command line through <b><a 
href="#Run">-DEF</a></b> parameter will be added automatically to the end of the 
list of specified defines .</p> 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Ignoring 
      defines</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
<p>Specifies defines that will be ignored when parsing the source 
code. You can separate multiple defines with semicolons. 
<p><b>Note</b>: Defines that are passed from the command line through <b><a 
href="#Run">-IDEF</a></b> parameter will be added automatically to the end of 
the ignore defines list.</td> 
  </tr> 
  <tr> 
    <td valign="top" nowrap><b>Unit aliases</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1"> 
This option is useful for backward compatibility. The format is <oldunit>=<newunit>. You can separate multiple aliases 
with semicolons. 
    </td> 
  </tr> 
</table> 
<p><a name="Project_Option_HelpGen"></a><hr> 
<h3>Help generation.</h3> 
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2"> 
      <p>Description</p> 
    </th> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Images 
      protected</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1">Specifies the file with image that will be 
      used to mark protected properties.</td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Images 
      published</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    Specifies the file with image that will be used to mark published 
    properties. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Images 
      read only</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    Specifies the file with image that will be used to mark read only 
    properties. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Images 
      abstract</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    Specifies the file with image that will be used to mark abstract methods. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1"><b>Maximal 
      deep in ... alphabetical list</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    Specifies the maximal depth of the alphabetical list of topics (classes, interfaces, types or procedures). 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1"><b>Max 
      number of ... in a group</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    Specifies the maximal number of topics included in a single 
    alphabetical group. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap><b>Don't 
      show same prefix</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1"> 
    dHelp have special feature that allow you to cut off the same 
    prefixes for topics while grouping in alphabetical groups. It is designed to 
    increase efficiency of contents section. For example if all participating 
    procedures have the same prefix DC it can be removed from the group names:<br> 
      
<table border="0" cellspacing="0" class="Example"> 
  <tr> 
    <td> 
      <p>AddReferences-ReadProp</p> 
      <p>     DCAddReferences</p> 
      <p>     DCBuildContents</p> 
      <p>     DCExportTopics</p> 
      <p>     DCGetHelpKind</p> 
      <p>     DCReadProp</p> 
      <p>SelectNewName-WriteProp</p> 
      <p>     DCSelectNewName</p> 
      <p>     DCShowBuildProcess</p> 
      <p>     DCShowCategories</p> 
      <p>     DCWriteProp</p> 
    </td> 
  </tr> 
</table> 
      
    </td> 
  </tr> 
<a name="Project_CreateLogFiles"></a> 
  <tr> 
    <td valign="top" nowrap><b>Generate diagnostic files</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1"> 
<p>Determines whether to create files with <a href="dhman_logs.html">diagnostic 
information</a> (.log files). These files contain the information about 
duplicate descriptions, failed topics, bad links in topic descriptions, not 
described or partially described topics, information about functions that are 
not included into any category, etc. 
    </td> 
  </tr> 
</table> 
<p><a name="Project_BuildHelp"></a> 
<hr> 
<h2>Help building options dialog.</h2> 
<p>Help building option dialog contains options that are important for building 
help. Here you can specify the kind of generated help file and the location of 
help compilers. Help building options dialog starts the help generation process. All 
options specified in this dialog are saved in the help project file 
along with other options.<br> 
  
<table cellspacing="0" width="100%" style="border-style: solid; border-width: 1" height="383"> 
  <tr> 
    <th 
    style="border-left-style: ridge; border-left-width: 2; border-right-style: inset; border-right-width: 1; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" nowrap height="23"> 
      <p>Item</p> 
    </th> 
    <th width="100%" 
    style="border-left-style: inset; border-left-width: 1; border-right-style: ridge; border-right-width: 2; border-top-style: ridge; border-top-width: 2; border-bottom-style: ridge; border-bottom-width: 2" height="23" valign="top"> 
      <p>Description</p> 
    </th> 
  </tr> 
<a name="Project_HelpKind"></a>   
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" nowrap height="40"><b>Kind 
      of help</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" height="40" valign="top">Specifies 
      what kind of help file will be generated. dHelp support following 
      kinds of help/manuals: 
      <ul> 
        <li>WinHelp format (HLP file).</li> 
        <li>Microsoft HTML Help (CHM file).</li> 
        <li>Manual in RTF format.</li> 
        <li>Manual in HTML format.</li> 
      </ul> 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" height="172"><b>Delete 
      temporary file</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" height="172" valign="top"> 
<p>Indicates whether the temporary files will be deleted after the help is 
generated. When program generates 
help file it creates temporary files with topic descriptions in RTF or HTML 
format in the <a href="#Project_DestFolder">project destination folder</a>. 
These files are used by a help compiler.<br> 
You can use temporary files as a source of the descriptions for your custom 
manual. When dHelp creates help in the HLP format all topic descriptions 
are gathered in to the single RTF file. When dHelp creates help in the 
CHM format there will be separate file for each topic, list of properties, 
methods, events and hierarchy tree in the HTML format. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" style="border-bottom-style: solid; border-bottom-width: 1" height="97"><b>Ignore 
      existent DPU files</b></td> 
    <td width="100%" 
    style="border-left-style: solid; border-left-width: 1; border-bottom-style: solid; border-bottom-width: 1" height="97" valign="top"> 
    Determines whether to ignore existing <a href="#Precompiled_headers">DPU 
files</a>. If this parameter is not specified, parser will use previously compiled information for modules that have not been changed. Parameter can also be 
    set from the command line through the <a 
href="#Run">-IGNDPU</a> parameter. 
    </td> 
  </tr> 
  <tr> 
    <td valign="top" height="41"><b>Path to the help compilers</b></td> 
    <td width="100%" style="border-left-style: solid; border-left-width: 1" height="41" valign="top"> 
    <p>Specifies the location of the compiler which can be used 
    to generate the help in the format specified in <a href="#Project_HelpKind">Kind of 
    help</a> property. 
<p> dHelp finds 
installed compiler itself. If you don't have help compiler installed you can 
download it from:</p> 
<p> Microsoft Help 
Workshop (HLP compiler): <a href="http://support.microsoft.com/download/support/mslfiles/HCWSETUP.EXE">http://support.microsoft.com/download/support/mslfiles/HCWSETUP.EXE</a><br> 
<a href="http://support.microsoft.com/support/downloads/DP2677.ASP">http://support.microsoft.com/support/downloads/DP2677.ASP</a></p> 
<p> HTML Help Workshop (CHM compiler):<br> 
<a href="http://msdn.microsoft.com/workshop/author/htmlhelp" target="_blank">http://msdn.microsoft.com/workshop/author/htmlhelp</a></p> 
    </td> 
  </tr> 
</table> 
<p><a name="description"></a> 
<hr> 
<h1>Format of the topic description files</h1> 
<p>dHelp uses <em>text files </em>for storing topic descriptions.  
When file with 
descriptions is imported by dHelp, the following rules take place: 
<ul> 
  <li> 
    <p>Topics can include only tags with reserved names, other tags are treated 
    as a start of the new topic description and tag name serves as the name of 
    the topic. Units, procedures, variables, types and classes are shown by 
    their name. For methods, properties and events you must indicate class name 
    before topic name and separate them with dot.<br> 
      
    <table border="0" cellspacing="0" width="201" class="Example"> 
      <tr> 
        <td width="193"><MyUnit> 
          <hr> 
          <p><MyClass></p> 
          <hr> 
          <p><MyClass.NewProperty></p> 
          <hr> 
          <p><MyClass.CustomEvent></p> 
          <hr> 
          <p><MyProcedure></td> 
      </tr> 
    </table> 
  </li> 
</ul> 
<ul> 
  <li> 
    <p>Every tag name is started from open triangle bracket "<" and 
    ended with close triangle bracket ">". The tag contents 
    continues until the next tag definition.</li> 
  <li> 
    <p>File can have comments enclosed in “<!--” and “-->” 
    symbols. The text inside these symbols is ignored when descriptions are 
    imported.</li> 
</ul> 
<p>Here is an example of the descriptions file structure:</p> 
<table cellspacing="0" width="397" border="0" class="Example"> 
  <tr> 
    <td> 
      <p><b><TPSCCalendar.Multiselect></b><br> 
      This is a brief description of the Multiselect property.<br> 
      <b><Definition></b><br> 
      Unit<br> 
        PSCCalendar;<br> 
      <br> 
      property TPSCCalendar.Multiselect : Boolean;<br> 
      <b><Description></b><br> 
      Here you can describe in more details the possible values of the property, 
      give some short examples and so on.<br> 
      <b><See Also></b><br> 
      TPSCCalendar.SelStart, ExtendedSelection.</td> 
</table> 
<p>Description can contain the following tags:</p> 
<p><b><Definition></b> - the contents of this tag is ignored during help 
file generation. When dHelp generates empty frames for the topic 
descriptions it inserts there an example of the topic declaration as it will be displayed in the generated help.</p> 
<p><b><Description></b> - tag contains the full description of the topic.</p> 
<p><b><See Also></b> - heads reference section. All elements must be a 
reference to the valid topic within your library or standard VCL library. When 
you reference to the topic you must specify it's name using the following rules:</p> 
<ul> 
  <li> 
    <p>Procedures, variables, types and classes are referenced by their names.</li> 
  <li> 
    <p>Class members (methods, properties, events) must be referenced with the 
    class name before it (for example: TPSCCalendar.Multiselect). If topic is a 
    member of the class that is currently described class name can be omitted. 
    Multiple elements can be separated by comma or entered in the separate 
    lines.</li> 
</ul> 
<p><b>Brief description</b> must be included in the section right after new 
topic is started. 
<p><b><font color="#FF0000">Warning</font></b>: '<' and '>' symbols are 
reserved words. If you want to use such characters in your description you must 
use two sequential brackets. For example:<br> 
  
<table border="0" cellspacing="0" width="350" class="Example"> 
  <tr> 
    <td width="342"> 
      <p style="margin-top: 0; margin-bottom: 0"><b><Description></b> 
      <p style="margin-top: 0; margin-bottom: 0">.. procedure returns the full 
      path: "C:\WINDOWS>>" ...</td> 
  </tr> 
</table> 
<p><b><a name="Description_Ref"></a>Note</b>: You can point program to get topic 
description from another topic. In this case dHelp will ignore <b><i>Brief 
description, Description, See Also</i></b> sections of the topic and substitute 
them by the corresponding sections from the referenced topic. To do this you 
must specify the referenced topic inside the tag that begins topic with '=' 
symbol between topic and referenced topic. 
<p><Topic=Referencing_Topic> 
<p><b>Example</b>:<br> 
  
<table border="0" cellspacing="0" width="400" class="Example"> 
  <tr> 
    <td width="392"><TPSCCustomDateEdit.Kind=TPSCPopupCalendar.PopupKind></td> 
  </tr> 
</table> 
<p style="margin-bottom: 0">dHelp<font color="#000080"> </font>validates 
description files and informs about errors using <a 
href="dhman_logs.html#pscFH_FailedTopic">pscFH_FailedTopic</a>, <a 
href="dhman_logs.html#pscFH_NoBodyDesc">pscFH_NoBodyDesc</a>, <a 
href="dhman_logs.html#pscFH_NoBriefDesc">pscFH_NoBriefDesc</a>, <a 
href="dhman_logs.html#pscFH_BadLinks">pscFH_BadLinks</a> diagnostic files. 
<p><a name="Precompiled_headers"></a> 
<hr> 
<h1>Precompiled headers  (.DPU files)</h1> 
<p>dHelp uses source code parser that processes 
Delphi units. Unit parser stores information about every parsed unit in files with DPU 
extension so that the next time it needs to parse the file it loads DPU file 
which is much faster.<em> </em>dHelp<font color="#000080"> <b></b></font>creates 
directory DPU_<Compiler_Version> in folder for temporary files and 
generates DPU files there.</p> 
<p>To use DPU files for the VCL, you must specify path where these DPU files are 
stored in the <b><a href="#Run">-INC</a></b> parameter of the dHelp 
command line.</p> 
<p><b>Example</b>:</p> 
<table border="0" cellspacing="0" class="Example"> 
  <tr> 
    <td> 
      <p style="margin-left: 15; margin-right: 15">-INCC:\DHELP\LIB\DPU_D5</td> 
  </tr> 
</table> 
 
</body>