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


<html> 
 
<head> 
<meta http-equiv="Content-Type" content="text/html; charset=windows-1251"> 
<title>Description of the diagnostic files</title> 
<link rel="stylesheet" type="text/css" href="general.css"> 
</head> 
 
<body> 
 
<h1>Description of the diagnostic files.</h1> 
<p><em>dHelp</em> outputs different diagnostic information during 
generation of the help file. This information is categorized and saved to the files with LOG extension.</p> 
<p>These <a href="dhman_use.html#project">project file</a> fields customize the diagnostic information generation:</p> 
<ol> 
  <li>Field <a href="dhman_use.html#Project_CreateLogFiles"><b>CreateLogFiles</b></a> 
    defines whether diagnostic information will be generated. By default 
    dHelp generates all diagnostic files. If <b>CreateLogFiles</b> flag is 
    set, dHelp clears the contents of all log files before compiling 
    the project.</li> 
  <li>Field <a href="dhman_use.html#Project_LogFolder"><b>LogFolder</b></a> 
    specifies folder where files with diagnostic information will be created.</li> 
</ol> 
<p><em>dHelp</em>  creates the following report files:</p> 
<ul style="margin-top: 15; margin-bottom: 15"> 
  <li style="margin-top: 15; margin-bottom: 15"> <a href="#dhpFH_BadLinks">dh_BadLinks</a> 
    contains information about references that cannot be solved.</li> 
  <li style="margin-top: 15; margin-bottom: 15"> <a href="#dhpFH_Compiler">dh_Compiler</a> 
    contains messages generated by HTML Help Workshop during compilation of the 
    CHM help file.</li> 
  <li style="margin-top: 15; margin-bottom: 15"> <a href="#dhpFH_NoBodyDesc">dh_NoBodyDesc</a> 
    contains topics that have empty brief description part.</li> 
  <li style="margin-top: 15; margin-bottom: 15"> <a 
    href="#dhpFH_NoBriefDesc">dh_NoBriefDesc</a> contains topics that have 
    empty primary description part.</li> 
  <li style="margin-top: 15; margin-bottom: 15"> <a 
    href="#dhpFH_NoDescTopic">dh_NoDescTopic</a> contains the list of not 
    described topics.</li> 
  <li style="margin-top: 15; margin-bottom: 15"> <a href="#dhpFH_ValidSize">dh_ValidSize</a> 
    contains the effective size of the topic descriptions.</li> 
</ul> 
  
<hr> 
<h1><a name="dhpFH_BadLinks"></a>Bad links report (dh_BadLinks.log)</h1> 
This file contains information about references that cannot be solved. 
<p>The possible messages are:</p> 
<p>1. <font color="#000080"><b>"<ref_topic>" not found<br> 
</b></font><font color="#000080"><b>      (referenced 
by "<topic>")</b></font></p> 
<blockquote> 
  <p>This message alerts about errors in the topic aliases. Error occurs when 
  the right part of the '<b><topic1=topic2></b>' expression was not found. 
  Message has the following parameters:</p> 
  <ul> 
    <li><b><ref_topic></b> indicates unknown topic (topic2).</li> 
    <li><b><topic></b> contains name of the topic where error occurs 
      (topic1).</li> 
  </ul> 
  <p><b>Example</b>:</p> 
  <table> 
    <tr> 
      <td class="Example"> 
        <p>"TDCWeekDay" not found<br> 
        (referenced by "TDCFirstDayOfWeek")</p> 
      </td> 
    </tr> 
  </table> 
  <p><cite>Solution</cite>: 
  <ul> 
    <li>First, you must check whether the referenced topic exists in the source code 
      units. If you can't find it, change the reference to the right one.</li> 
    <li>If topic exists in the source code units, you must check whether this 
      topic is described in the <a href="dhman_use.html#description">description 
      file</a>. If referenced topic is not described, change the reference to 
      the described topic or write new description for that topic.</li> 
  </ul> 
</blockquote> 
<p>2. <b><font color="#000080">"<ref_topic>" topic not found in 
source<br> 
</font></b><b><font color="#000080">      (referenced 
by see also of "<topic>")</font></b></p> 
<blockquote> 
  <p>This message reports about errors with items listed in the <i>See Also</i> 
  section. Error message is included when referenced item cannot be found among 
  source code topics. Message has the following parameters:</p> 
  <ul> 
    <li><b><ref_topic></b> indicates name of the failed topic.</li> 
    <li><b><topic></b> marks the topic name where bad reference was found.</li> 
  </ul> 
  <p><b>Example</b>:</p> 
  <table> 
    <tr> 
      <td class="Example"> 
        <p>"TDCFltBld.OnSaveToStream" topic not found in source<br> 
        (referenced by "TDCPrmListBox.OnSaveToStream")</td> 
    </tr> 
  </table> 
  <p><cite>Solution</cite>: 
  <ul> 
    <li>You must check whether referenced topic exists in the source code units. 
      If you can't find it, change reference to the right topic name or exclude 
      it from the <i>See Also</i> section</li> 
  </ul> 
</blockquote> 
<p>3. <font color="#000080"><b>"<ref_topic>" description not 
found<br> 
</b></font><font color="#000080"><b>      (referenced 
by see also of "<topic>",<br> 
       found as topic 
"<ref_found_topic>"</b></font></p> 
<blockquote> 
  <p>This message reports about errors with items listed in the <i>See Also</i> 
  section. This error message is reported when referenced topic cannot be found 
  among described topics but it is an element of the parsed source code units 
  (class, property, procedure, etc.). If topic is a class member (property, 
  method or event) <em>dHelp</em> always tries to fix failed topic link 
  by searching it among members of all parent classes. Message has the following 
  parameters:</p> 
  <ul> 
    <li><b><ref_topic></b> indicates name of the failed topic.</li> 
    <li><b><topic></b> marks the topic name where bad reference was found.</li> 
    <li><b><ref_found_topic></b> contains the full name of the topic as it 
      was found in the source code.</li> 
  </ul> 
  <p><b>Example</b>:</p> 
  <table> 
    <tr> 
      <td class="Example"> 
        <p>"OnGetLookupDef" description not found<br> 
        (referenced by see also of "TDCPrmListBox.GetParamLookupDef",<br> 
        found as topic "TDCPrmListBox.OnGetLookupDef")</p> 
      </td> 
    </tr> 
  </table> 
  <p><cite>Solution</cite>: 
  <ul> 
    <li>Check whether referenced topic has valid description. It is possible 
      that referenced topic is not described.</li> 
    <li>If reference topic has description you must check whether this topic is 
      mentioned in the <b><a href="dhman_use.html#Project_IgnoreTopics">IgnoreTopics</a></b> 
      section of the <a href="dhman_use.html#project">project file</a>. If you 
      find it there then you can remove all references to it.</li> 
  </ul> 
</blockquote> 
<hr> 
<h1><a name="dhpFH_Compiler"></a>Compiler output report (dh_Compiler.log)</h1> 
<p>This file contains messages written by HTML Help Workshop during compilation 
of the CHM help file. Program intercepts all messages generated by compiler for 
the currently generated help project and stores them in the dhpFH_Compiler.log 
file. You can use this information to validate created help file.</p> 
<p><b>Note</b>: dhpFH_Compiler.log file is empty after generating help in the 
HLP format.</p> 
<p><b>Example</b>:</p> 
<table> 
  <tr> 
    <td class="Example"> 
      <p>Microsoft HTML Help Compiler 4.72.7352</p> 
      <p> <br> 
      Compiling D:\pSoft\OUT\Help_CHM\psoft.chm</p> 
      <p> <br> 
      DCBtPan.html</p> 
      <p>DCCalc.html</p> 
      <p>DCCalendar.html</p> 
      <p>...</p> 
      <p>Compile time: 1 minute, 26 seconds</p> 
      <p>1,974 Topics</p> 
      <p>14,315 Local links</p> 
      <p>1,577 Internet links</p> 
      <p>0 Graphics</p> 
      <p> </p> 
      <p>Created d:\pSoft\OUT\Help_CHM\psoft.chm, 972,913 bytes</p> 
      <p>Compression decreased file by 3,596,819 bytes.</p> 
    </td> 
  </tr> 
</table> 
  
<br> 
<hr> 
<h1><a name="dhpFH_NoBodyDesc"></a><a name="dhpFH_NoBriefDesc"></a> Not complete 
description report (dh_NoBodyDesc.log and dh_NoBriefDesc.log)</h1> 
<p>These files list topics that are partially described. In description section 
each topic must have brief and primary descriptions (see <a href="dhman_use.html#description">description files</a> for the 
additional information). If one of the description parts is absent, <em> 
dHelp</em> notifies user about this error through dhpFH_NoBriefDesc.log and 
dhpFH_NoBodyDesc.log files. File dhpFH_NoBriefDesc collects topics that have 
empty brief description part. File dhpFH_NoBodyDesc collects topics that have 
empty primary description part.</p> 
<p>Both files have the same structure:</p> 
<p style="margin-bottom: 0"><b><font color="#000080"><Description_file_name_1><br> 
   <Failed_topic_11></font></b></p> 
<p style="margin-top: 0; margin-bottom: 0"><b><font color="#000080">   
<Failed_topic_12></font></b></p> 
<p style="margin-top: 0; margin-bottom: 0"><font color="#000080"><b>  </b></font> 
<font color="#000080"><b>...</b></font></p> 
<p style="margin-top: 0; margin-bottom: 0"><b><font color="#000080"><Description_file_name_2><br> 
   <Failed_topic_21></font></b></p> 
<p style="margin-top: 0; margin-bottom: 0"><b><font color="#000080">   
<Failed_topic_22></font></b></p> 
<p style="margin-top: 0"><b><font color="#000080">   ...</font></b></p> 
<p>where</p> 
<ul> 
  <li><b><Description_file_name></b> is a file with descriptions where 
    partially described topic was found.</li> 
  <li><b><Failed_topic></b> - topic name that have incomplete description.</li> 
</ul> 
<p><b>Note</b>: Files where all topics have right and complete 
descriptions are not listed.</p> 
<p><b>Example</b>:</p> 
<table> 
  <tr> 
    <td class="Example"> 
      <p>D:\PROJECTS\dHelp\Samples\TOPICS\documentation2.txt</p> 
      <p>DCFormsUseOneFont</p> 
      <p>DCStdCtrls<br> 
       <br> 
      D:\PROJECTS\dHelp\Samples\TOPICS\DCsysutils.txt</p> 
      <p>DCGetDelphiVerByCompilerVer</p> 
      <p>DCSubStr</p> 
      <p>DCExpandRelativeFileEx</p> 
      <p>DCExpandRelativeFile</p> 
    </td> 
  </tr> 
</table> 
<p><cite>Solution</cite>: 
<ul> 
  <li>Fill in all parts of the description for all mentioned topics.</li> 
</ul> 
<hr> 
<h1><a name="dhpFH_NoDescTopic"></a> Not described report (dh_NoDescTopic.log)</h1> 
<p>This file contains the list of topics that are not described. By default 
program don't include topics without description. <a 
href="dhman_use.html#project">Project file</a> has field <a 
href="dhman_use.html#Project_IncludeEmptyTopics"><b>IncludeEmptyTopics</b></a> 
where you can specify whether to include empty topics in the help file or not.</p> 
<p><b>Note</b>: When <b>IncludeEmptyTopic</b> flag is set 
dhpFH_NoDescTopic.log file will not contain any items.</p> 
<p style="margin-bottom: 0">Topics in the not described report are listed in the 
alphabetical order using their full name:</p> 
<ul> 
  <li> 
    <p style="margin-bottom: 0">Global procedures and variables are preceded 
    with the module name where they are declared.</li> 
  <li> 
    <p style="margin-bottom: 0">Members of the class are preceded with the class 
    name.</li> 
</ul> 
<p><b>Note</b>: You can include topics from this file directly into the <a 
href="dhman_use.html#Project_Topics"><b>Topics</b></a> section of the <a 
href="dhman_use.html#project">project file</a>.</p> 
<p><b>Example</b>:</p> 
<table> 
  <tr> 
    <td class="Example"> 
      <p>DCClasses.DCWriteIntToStream</p> 
      <p>DCClasses.DCWriteStrToStream</p> 
      <p>DCClasses.DCWriteStrWithLengToStream</p> 
      <p>DCColors.DCColorToRGB</p> 
      <p>DCColors.DCColorToString</p> 
      <p>DCColors.DCRGBToColor</p> 
      <p>DCColors.DCStringToColor</p> 
      <p>DCControls.DCAddBitmapFromResource</p> 
      <p>DCControls.DCAddBitmapFromResourceEx</p> 
      <p>DCControls.DCAddIconFromResource</p> 
      <p>DCControls.DCAddIconFromResourceEx</p> 
    </td> 
  </tr> 
</table> 
<p><cite>Solution</cite>: 
<ul> 
  <li>Fill in descriptions for all listed topics. If you have no <a 
    href="dhman_use.html#description">description frames</a> for these topics, 
    copy topics list to the <a href="dhman_use.html#Project_Topics"><b>Topics</b></a> 
    section of the <a href="dhman_use.html#project">project file</a> and run<em> 
    dHelp</em> with command <b> f</b> to 
    generate empty topic description frames.</li> 
</ul> 
<hr> 
<h1><a name="dhpFH_ValidSize"></a>  Performance report (dh_ValidSize.log)</h1> 
<p>Contents of this file represents the effective size of the topic 
descriptions. <em> 
dHelp</em> calculates all valid characters (Latin letters and numbers) found 
in <a href="dhman_use.html#description">brief and primary description</a> 
sections and stores this information in the dhpFH_ValidSize.log file. Only 
topics that were successfully imported are taken into account.</p> 
<p>Program divides total size by files with descriptions and presents this 
information in the following format:</p> 
<p><b><font color="#000080">In module <description_file_name><br> 
   useful symbols are: <total_module_size> 
(<total_module_size_in_KB> KB)</font></b></p> 
<p>where</p> 
<ul> 
  <li><b><description_file_name></b> - contains full name of the file with 
    topic descriptions.</li> 
  <li><b><total_module_size></b> - the effective size of 
    descriptions for topics included into the mentioned file.</li> 
  <li><b><total_module_size_in_KB></b> - the effective size in 
    KBytes of descriptions for topics included into the mentioned file.</li> 
</ul> 
<p>At the end of the file <em>dHelp</em> inserts the total effective size 
for all included topic descriptions. The format of the message is:</p> 
<p><b><font color="#000080">In all files useful symbols are : <total_size> 
(<total_size_in_KB> KB)</font></b></p> 
<p>where</p> 
<ul> 
  <li><b><total_size></b> - shows the effective size of descriptions for 
    all successfully imported topics.</li> 
  <li><b><total_size_in_KB></b> - shows the effective size in KBytes of 
    descriptions for all successfully imported topics.</li> 
</ul> 
<p><b>Example</b>:</p> 
<table> 
  <tr> 
    <td class="Example"> 
      <p>In module D:\PROJECTS\dHelp\Samples\TOPICS\documentation.txt</p> 
      <p>useful symbols are: 38733 (37.825 KB)</p> 
      <p> </p> 
      <p>In module D:\PROJECTS\dHelp\Samples\TOPICS\DCCalendar.txt</p> 
      <p>useful symbols are: 43436 (42.418 KB)</p> 
      <p> </p> 
      <p>In module D:\PROJECTS\dHelp\Samples\TOPICS\DCCalendarPro.txt</p> 
      <p>useful symbols are: 12847 (12.546 KB)</p> 
      <p> </p> 
      <p>...</p> 
      <p>--------------------------</p> 
      <p>In all files useful symbols are: 385232 (376.203 KB)</p> 
    </td> 
  </tr> 
</table> 
 
</body>