Edit and correct preference dialogue help topics

Author: delphidabbler

Src/Help/HTML/dlg_preferences.htm

@@ -31,15 +31,16 @@ <h1>
       dialogue box is accessed via the <em>Tools | Preferences</em> menu option.
     </p>
     <p>
-      The dialogue box is in several sections, accessed by tabs across the top
-      of the page. These are:
+      The dialogue box is divided into several sections, accessed by tabs across
+      the top of the page. These are:
     </p>
     <ul class="unspaced">
       <li>
         <a href="dlg_prefs_display.htm">Display</a>
       </li>
       <li>
         <a href="dlg_prefs_snippetlayout.htm">Snippet Layout</a>
+      </li>
       <li>
         <a href="dlg_prefs_codegen.htm">Code Generation</a>
       </li>

Src/Help/HTML/dlg_prefs_codegen.htm

@@ -28,8 +28,9 @@ <h1>
     </h1>
     <p>
       This tab of the <a href="dlg_preferences.htm">Preferences</a> dialogue box
-      is used to customise the source code emitted by the code generator for
-      test compilations and generated units.
+      is used to customise the source code emitted by the code generator when
+      creating test compilations and when outputting units.
+    </p>
     <p>
       The tab is accessed by selecting the <em>Tools | Preferences</em> menu
       item then clicking the <em>Code Generation</em> tab.
@@ -38,9 +39,10 @@ <h1>
       Formatting</a> tab for that.
     </p>
     <p>
-      The Code Generator can be configured to generate $WARN compiler directives
-      to switch specified warning messages on or off. These directives are
-      supported by Delphi 6 and later.
+      The Code Generator can be configured to generate <code>$WARN</code>
+      compiler directives to switch specified warning messages on or off. These
+      directives are supported by Delphi 6 and later. Free Pascal is not
+      supported.
     </p>
     <p>
       To enable this facility you must check the <em>Emit $WARN directives</em>
@@ -50,13 +52,13 @@ <h1>
       The warnings for which compiler directives are to be generated are those
       listed in the list view control situated below the check box. Warnings
       are identified by the text in the <em>Symbol</em> column. These symbols
-      must be valid parameters for Delphi's $WARN directive. Since new symbols
-      have been introduced in different versions of Delphi, the minimum version
-      of the compiler that supports the warning must also be specified. This is
-      shown in the <em>Min. Compiler</em> column of the list view. The version
-      number is that specified by the Delphi's <var>CompilerVersion</var>
-      constant. Finally, whether a warning is switched on or off is shown in the
-      <em>State</em> column.
+      must be valid parameters for Delphi's <code>$WARN</code> directive. Since
+      new symbols have been introduced in different versions of Delphi, the
+      minimum version of the compiler that supports the warning must also be
+      specified. This is shown in the <em>Min. Compiler</em> column of the list
+      view. The version number is that specified by Delphi's
+      <var>CompilerVersion</var> constant. Finally, whether a warning is
+      switched on or off is shown in the <em>State</em> column.
     </p>
     <p>
       The list view can be sorted on the contents of any of the columns by
@@ -73,12 +75,12 @@ <h1>
         <strong>Add a symbol</strong><br>
         Enter the symbol name in the <em>Symbol</em> edit control, specify the
         earliest compiler version that supports it in the <em>Min. Compiler</em>
-        edit control and specify whether the $WARN directive will switch the
-        warning on or off by selecting the appropriate <em>Warning State</em>
-        radio button. Click the <em>Add</em> button to add the symbol to the
-        list. If the <em>Add</em> button remains disabled check that the
+        edit control and specify whether the <code>$WARN</code> directive will
+        switch the warning on or off by selecting the appropriate <em>Warning
+        State</em> radio button. Click the <em>Add</em> button to add the symbol
+        to the list. If the <em>Add</em> button remains disabled check that the
         compiler version is valid and that the symbol name does not already
-        exist.
+        exist in the list view.
       </li>
       <li>
         <strong>Delete a symbol</strong><br>
@@ -91,9 +93,9 @@ <h1>
         copied into the <em>Symbol</em> and <em>Min. Compiler</em> edit
         controls and the appropriate <em>Warning State</em> radio button will be
         selected. Change the details as required then click the <em>Update</em>
-        button to modify the symbol. The changes will be reflected in the list
-        view. If the entered information is not valid then the <em>Update</em>
-        button will be disabled.
+        button. The changes will be reflected in the list view. If the entered
+        information is not valid then the <em>Update</em> button will be
+        disabled.
       </li>
     </ul>
     <p>
@@ -109,8 +111,8 @@ <h1>
       source code that will be emitted by the code generator.
     </p>
     <p>
-      The <em>Restore Defaults</em> button discards the current list of $WARN
-      directives and replaces it with a default set.
+      The <em>Restore Defaults</em> button discards the current list of
+      <code>$WARN</code> directives and replaces it with a default set.
     </p>
   </body>
 </html>

Src/Help/HTML/dlg_prefs_display.htm

@@ -43,29 +43,30 @@ <h1>
           href="overview_pane.htm"
         >overview pane</a> appears when the program starts. Do this using the
         <em>Start overview pane treeview as</em> drop down list to choose either
-        <em>Fully expanded</em> to make the treeview display all entries) or
+        <em>Fully expanded</em> to make the treeview display all entries or
         <em>Fully collapsed</em> to display only section headers.
       </li>
       <li>
         Choose whether new snippets and categories are displayed in the current
         tab or in a new tab in the <a
           href="detail_pane.htm"
         >detail pane</a>. Check the <em>Display newly added snippets &amp;
-        categories in new tabs</em> check box to add a new tab for each item
-        created or clear the check box to overwrite the content of the currently
-        selected tab.
+        categories in new tabs</em> check box to add a new tab for each item,
+        or clear the check box to overwrite the content of the currently
+        selected tab. Note that <span class="smallcaps">Ctrl</span> clicking an
+        item always displays the item in a new tab, regardless of this setting.
       </li>
       <li>
         Choose whether empty section headings are hidden in the <a
           href="overview_pane.htm"
         >overview pane</a>. Check the <em>Hide empty section headings in
-        overiew</em> check box to hide empty section headings or clear the check
+        overview</em> check box to hide empty section headings or clear the check
         box to display them.
       </li>
       <li>
-        <div>
+        <p>
           Specify the colours used for the following interface elements:
-        </div>
+        </p>
         <ul class="unspaced">
           <li>
             Snippet and category headings in the main database.
@@ -79,14 +80,16 @@ <h1>
             >detail pane</a>.
           </li>
         </ul>
-        <div>
+        <p>
           Choose the required colours from the appropriate drop-down colour
-          lists. Custom colours can be created: just select the 
-          <em>Custom...</em> option from the drop down list and choose or create
-          the colour in the displayed colour dialogue box. Default colours for 
-          any of the above interface elements can be restored by clicking the 
-          <em>Use Default Colours</em> button.
-        </div>
+          lists. Custom colours can be created: just select the
+          <em>Custom...</em> option from the top of the drop down list and
+          choose or create the colour in the displayed colour dialogue box.
+        </p>
+        <p>
+          Default colours for all the above interface elements can be restored
+          by clicking the <em>Use Default Colours</em> button.
+        </p>
       </li>
     </ul>
   </body>

Src/Help/HTML/dlg_prefs_general.htm

@@ -44,7 +44,7 @@ <h2>
       Select the measurement units to be used by the application from the
       <em>Preferred units of measurement</em> drop down list. Options are
       <em>Inches</em> and <em>Millimeters</em>. If you have not set this option
-      before, the measurement units will default to your locale settings.
+      before, the measurement units will be appropriate to your locale.
     </p>
   </body>
 </html>

Src/Help/HTML/dlg_prefs_hiliter.htm

@@ -44,7 +44,7 @@ <h3>
     </p>
     <p>
       Different syntax highlighter styles can be saved and given identifying
-      names for later user.
+      names for later use.
     </p>
     <h2>
       Highlighter Font
@@ -56,7 +56,7 @@ <h2>
     </p>
     <p>
       <strong>Note:</strong> The highlighter font is ignored in code previews in
-      other tabs in the <a href="dlg_preferences.htm">Preferences</a> dialogue
+      other tabs of the <a href="dlg_preferences.htm">Preferences</a> dialogue
       box to ensure that previews fit the available space.
     </p>
     <h2>
@@ -65,14 +65,14 @@ <h2>
     <p>
       The colour and font style used for various syntactic elements of the
       source code can be changed. Select an element in the <em>Elements</em>
-      list box then using the <em>Font style</em> check boxes and
-      <em>Colour</em> drop down list. A preview of the element is displayed.
+      list box then edit its style using the <em>Font style</em> check boxes and
+      the <em>Colour</em> drop down list. A preview of the element is displayed.
     </p>
     <h2>
       Named Styles
     </h2>
     <p>
-      <em>CodeSnip</em> provides five pre-defined styles that are applied by
+      <em>CodeSnip</em> provides some pre-defined styles that are applied by
       clicking the <em>Use Predefined Style</em> button and selecting the style
       from the drop-down menu that appears.
     </p>
@@ -81,7 +81,7 @@ <h2>
     </p>
     <ol class="spaced">
       <li>
-        <em>CodeSnip Classic</em> &ndash; style of highlighting used in main
+        <em>CodeSnip Classic</em> &ndash; style of highlighting used in the main
         display of CodeSnip v2 and earlier.
       </li>
       <li>
@@ -102,9 +102,7 @@ <h2>
         highlighters can also be deleted from this dialogue box.
       </li>
       <li>
-        <em>No Highlighter</em> &ndash; no syntax highlighting used. You might
-        want to use this style if you are storing code other than Pascal in
-        <em>CodeSnip</em>.
+        <em>No Highlighter</em> &ndash; no syntax highlighting is used.
       </li>
     </ol>
     <h2>
@@ -134,7 +132,7 @@ <h2>
       (see above).
     </p>
     <p>
-      Any number of custom highlighter style can be saved.
+      Any number of custom highlighter styles can be saved.
     </p>
   </body>
 </html>

Src/Help/HTML/dlg_prefs_printing.htm

@@ -36,7 +36,7 @@ <h1>
       tab from the <a href="dlg_print.htm">Print</a> dialogue box.
     </p>
     <p>
-      <strong>Note:</strong> Options set in this tab usually take effect the
+      <strong class="warning">Warning:</strong> Options set in this tab usually take effect the
       next time the application is started. The exception is when the tab is
       displayed from the <em>Print</em> dialogue box, when you can choose to
       apply the new options straight away.
@@ -47,7 +47,7 @@ <h2>
     <p>
       There are two options that change the way printed documents are formatted:
     </p>
-    <ul class="unspaced">
+    <ul class="spaced">
       <li>
         The <em>Syntax highlight source code</em> check box specifies whether
         source code included in the output is syntax highlighted by default.
@@ -62,6 +62,12 @@ <h2>
       A preview of the effect of the options is displayed to the right of the
       check boxes.
     </p>
+    <p>
+      When syntax highlighting is enabled the style used is as specified in the
+      <a href="dlg_prefs_hiliter.htm">Syntax Highlighter</a> tab. When black and
+      white printing is specified the highlighter's font styles are used but
+      colours are ignored.
+    </p>
     <h2>
       Page Margins
     </h2>
@@ -72,7 +78,7 @@ <h2>
     <p>
       Margins are displayed and entered either in inches or millimeters. The
       units being used are displayed in the group box caption.
-      <strong>Note:</strong> measurement units can be specified on the
+      <strong>Note:</strong> measurement units can be changed on the
       <a href="dlg_prefs_general.htm">Misc.</a> tab, if it is visible.
     </p>
   </body>

Src/Help/HTML/dlg_prefs_snippetlayout.htm

@@ -30,13 +30,16 @@ <h1>
       This tab of the <a
         href="dlg_preferences.htm"
       >Preferences</a> dialogue box is used to customise the layout of pages
-      that display the various kinds of snippet in the <a
+      that display the various <a
+        href="snippet_kinds.htm"
+      >kinds</a> of snippet
+      in the <a
         href="detail_pane.htm"
       >Detail Pane</a>.
     </p>
     <p>
       The tab is accessed by selecting the <em>Tools | Preferences</em> menu
-      item then clicking the <em>Display</em> tab in the <a
+      item then clicking the <em>Snippet Layout</em> tab in the <a
         href="dlg_preferences.htm"
       >Preferences</a> dialogue box.
     </p>
@@ -77,24 +80,24 @@ <h2>
           <em>Type</em>
         </div>
         <div>
-          Snippet's type or kind, e.g. &quot;Routine&quot; or &quot;Type
-          Definition&quot;
+          Snippet's type or <a href="snippet_kinds.htm">kind</a>, e.g.
+          &quot;Routine&quot; or &quot;Type Definition&quot;
         </div>
       </li>
       <li>
         <div>
           <em>Category</em>
         </div>
         <div>
-          Category that snippet belongs to. Renders as a link.
+          Category that a snippet belongs to. Renders as a link.
         </div>
       </li>
       <li>
         <div>
           <em>Required Units List</em>
         </div>
         <div>
-          Always empty for <a
+          List of units required by the selected snippet. Always empty for <a
             href="snippet_unit.htm"
           >Unit</a> snippets.
         </div>
@@ -104,7 +107,8 @@ <h2>
           <em>Required Snippets List</em>
         </div>
         <div>
-          Contains links to any required snippets. Always empty for <a
+          List of links to snippets called by the selected snippet. Always empty
+          for <a
             href="snippet_unit.htm"
           >Unit</a> snippets.
         </div>
@@ -114,7 +118,7 @@ <h2>
           <em>Cross Reference List</em>
         </div>
         <div>
-          Contains links to any cross referenced snippets.
+          List of links to any cross referenced snippets.
         </div>
       </li>
       <li>
@@ -157,10 +161,10 @@ <h2>
     <p>
       The current page components will be displayed in the right hand
       <em>Displayed page components</em> list box. Any unused page components
-      are listed in the <em>Unused page components</em> list box.
+      are listed in the <em>Unused page components</em> list box on the left.
     </p>
     <p>
-      You customise the page using this list boxes. Here are the available
+      You customise the page using these list boxes. Here are the available
       actions:
     </p>
     <ul class="spaced">