Merge branch 'feature/update-help' into develop

Author: delphidabbler

Src/CodeSnip.todo

@@ -1,9 +1,2 @@
 {TODO -cUI : Remove unused tool bar button in main window}
-
-
-{TODO -cHelp :
-Add a Backup Database task help topics that describes how to backup and restore databases.
-Then add help link to Res/HTML/dlg-dbupdate-intro-tplt.html}
-
-
 {TODO -cPreRelease : Remove -[**dev**] from product and file versions in .vi files before bumping release number}

Src/Help/CSS/codesnip.css

@@ -145,6 +145,11 @@ table.menu td.desc {
   background-color: white;
 }
 
+pre.reml,
+code.reml {
+  color: purple;
+}
+
 .indent {
   margin-left: 2em;
 }

Src/Help/CodeSnip.hhp

@@ -6,7 +6,6 @@
 ;
 ; CodeSnip help project file.
 
-
 [OPTIONS]
 Compatibility=1.1
 Compiled file=..\..\Exe\CodeSnip.chm
@@ -17,28 +16,32 @@ Index file=Index.hhk
 Language=0x809 English (United Kingdom)
 Title=CodeSnip Help
 
-
 [FILES]
 HTML\about_compiler_checks.htm
+HTML\about_swag.htm
 HTML\detail_pane.htm
 HTML\dlg_about.htm
 HTML\dlg_addcategory.htm
 HTML\dlg_backup.htm
 HTML\dlg_configcompilers.htm
 HTML\dlg_deletecategory.htm
 HTML\dlg_dependencies.htm
+HTML\dlg_dependencies_edit.htm
 HTML\dlg_duplicatesnippet.htm
 HTML\dlg_editsnippet.htm
 HTML\dlg_elementcolour.htm
 HTML\dlg_export.htm
 HTML\dlg_exportfile.htm
+HTML\dlg_favourites.htm
 HTML\dlg_findcompiler.htm
 HTML\dlg_findtext.htm
 HTML\dlg_findxrefs.htm
 HTML\dlg_firstrun.htm
+HTML\dlg_hilitemgr.htm
 HTML\dlg_import.htm
 HTML\dlg_importfile.htm
 HTML\dlg_loadselection.htm
+HTML\dlg_moveuserdb.htm
 HTML\dlg_pagesetup.htm
 HTML\dlg_preferences.htm
 HTML\dlg_prefs_codegen.htm
@@ -51,10 +54,12 @@ HTML\dlg_prefs_sourcecode.htm
 HTML\dlg_print.htm
 HTML\dlg_renamecategory.htm
 HTML\dlg_restore.htm
+HTML\dlg_savehiliter.htm
 HTML\dlg_saveselection.htm
 HTML\dlg_savesnippet.htm
 HTML\dlg_selectcompiler.htm
 HTML\dlg_selectroutines.htm
+HTML\dlg_swagimport.htm
 HTML\dlg_testcompile.htm
 HTML\dlg_trappedbugreport.htm
 HTML\dlg_update.htm
@@ -88,8 +93,8 @@ HTML\snippet_kinds.htm
 HTML\snippet_routine.htm
 HTML\snippet_type.htm
 HTML\snippet_unit.htm
-HTML\tasks.htm
 HTML\task_addsnippets.htm
+HTML\task_backup.htm
 HTML\task_copysnippet.htm
 HTML\task_customise.htm
 HTML\task_export.htm
@@ -99,13 +104,5 @@ HTML\task_savesnippet.htm
 HTML\task_search.htm
 HTML\task_testcompile.htm
 HTML\task_update.htm
+HTML\tasks.htm
 HTML\welcome.htm
-HTML\dlg_favourites.htm
-HTML\dlg_moveuserdb.htm
-HTML\dlg_savehiliter.htm
-HTML\dlg_hilitemgr.htm
-HTML\dlg_prefs_updates.htm
-HTML\notifiy_database_update.htm
-HTML\dlg_dependencies_edit.htm
-HTML\about_swag.htm
-HTML\dlg_swagimport.htm

Src/Help/HTML/about_compiler_checks.htm

@@ -52,11 +52,15 @@ <h2>
       <em>Configure Compilers</em> dialogue box.
     </p>
     <p>
-      Compiler configuration is stored on a per user basis, i.e. each user
-      account maintains separate compiler configuration information. Therefore
-      each user must configure compilers separately. The reason for this is that
-      each user may wish to use a different set of available compilers and / or
-      may wish to use different compiler switches and search paths.
+      When using the standard version of CodeSnip, compiler configuration is
+      stored on a per user basis, i.e. each user account maintains separate
+      compiler configuration information. Therefore each user must configure
+      compilers separately. The reason for this is that each user may wish to
+      use a different set of available compilers and / or may wish to use
+      different compiler switches and search paths.
+    </p>
+    <p>
+      The portable version of CodeSnip only maintains one set of compiler configuration information per installation.
     </p>
     <h2>
       Running the tests

Src/Help/HTML/about_swag.htm

@@ -37,8 +37,15 @@ <h1>
     <p>
       <em>CodeSnip</em> provides the
       <a href="dlg_swagimport.htm">SWAG Import Wizard</a> that enables you to
-      browse the SWAG database and import any of its snippets into your own
-      snippets database.
+      browse a local copy of the SWAG database and import any of its snippets
+      into your snippets database.
+    </p>
+    <p>
+      You can download the database from the <a
+        href="https://github.com/delphidabbler/swag"
+        class="weblink"
+        target="_blank"
+      ><code>delphidabbler/swag</code></a> project on GitHub. Go to the <em>releases</em> tab and download the latest version. Unpack the zip file into an empty folder then run the SWAG Import Wizard and navigate to the folder where you extracted the zip file contents.
     </p>
   </body>
 </html>

Src/Help/HTML/detail_pane.htm

@@ -32,7 +32,7 @@ <h2>
       Tabs
     </h2>
     <p>
-      Information is be displayed in one or more tabs. Items selected in the
+      Information is displayed in one or more tabs. Items selected in the
       <a href="overview_pane.htm">Overview pane</a> are normally displayed in
       the currently selected tab, overwriting previous contents. This behaviour
       can be changed as follows:
@@ -63,7 +63,7 @@ <h2>
       </li>
     </ul>
     <p>
-      When more than one tab is displayed you can quickly cycle through them
+      When multiple tabs are displayed you can quickly cycle through them
       from left to right by pressing <span class="smallcaps">Ctrl+Tab</span> or
       from right to left using <span class="smallcaps">Shift+Ctrl+Tab</span>.
     </p>
@@ -74,7 +74,7 @@ <h2>
       <li>
         Close the selected tab using <em>Close Tab</em> menu option displayed on
         the <a href="menu_view.htm">View</a> menu, the detail pane's context
-        menu and any tab's context menu. Alternatively press
+        menu or any tab's context menu. Alternatively press
         <span class="smallcaps">Ctrl+F4</span>.
       </li>
       <li>
@@ -150,8 +150,8 @@ <h3>
           </li>
         </ul>
         <div>
-          This information is not displayed for user-defined snippets. In the
-          place of the images is a link that can be clicked to edit the snippet.
+          This information is not displayed for user-defined snippets. Instead
+          there is a link that can be clicked to edit the snippet.
         </div>
       </li>
       <li>
@@ -215,15 +215,15 @@ <h3>
     <p>
       Selecting a section header (a category, an intial letter or a <a
         href="snippet_kinds.htm"
-      >snippet kind</a> in the <a
+      >snippet kind</a>) in the <a
         href="overview_pane.htm"
       >Overview Pane</a> causes a table to be displayed in the detail pane that
-      lists the name of the snippets contained in the section, along with their
+      lists the names of the snippets contained in the section, along with their
       descriptions. Following a search, the listed snippets are just those
       contained in the current database selection, if any.
     </p>
     <p>
-      Snippet names are links that, when clicked, displays the chosen snippet
+      Snippet names are links that, when clicked, display the chosen snippet
       in the detail pane.
     </p>
     <p>
@@ -242,18 +242,18 @@ <h3>
       Database Update View
     </h3>
     <p>
-      When the database has been updated, all open tabs are closed and a new tab
-      created that simply informs that the database has been updated
-      successfully.
+      When the main DelphiDabbler Snippets database has been installed or
+      updated, all open tabs are closed and a new tab is created that simply
+      informs that the database has been updated successfully.
     </p>
     <h3>
       Empty Tab View
     </h3>
     <p>
       When a new tab is created (<em>View | New Tab</em> or <span
         class="smallcaps"
-      >Ctrl+T</span>, nothing is displayed except &quot;Empty Tab&quot; in light
-      grey.
+      >Ctrl+T</span>), nothing is displayed except &quot;Empty Tab&quot; in
+      light grey.
     </p>
     <h2>
       View History
@@ -277,7 +277,7 @@ <h2>
       >Alt+Right</span>.
     </p>
     <p>
-      You can also jump directly to some recent views by selecting its name from
+      You can also jump directly to a recent view by selecting its name from
       the drop-down menus adjacent to the <img
         alt="Previous button"
         src="../Images/GoBack.png"
@@ -292,22 +292,6 @@ <h2>
       Deleting or editing an existing snippet or category will clear the
       history.
     </p>
-    <h2>
-      Snippet and Category Links
-    </h2>
-    <p>
-      Links to snippets or categories may be displayed as part of snippet or
-      section contents views.
-    </p>
-    <p>
-      Clicking a snippet link displays a snippet view for that snippet in the
-      current tab of the details pane, Clicking a category link causes a
-      section contents view to be displayed for the contents of the category,
-      again in the current tab.
-    </p>
-    <p>
-      Views displayed in this way are added to the history list.
-    </p>
   </body>
 </html>
 

Src/Help/HTML/dlg_about.htm

@@ -27,12 +27,12 @@ <h1>
     </h1>
     <p>
       This dialogue box provides various pieces of information about
-      <em>CodeSnip</em> and the <em>Code Snippets Database</em>. It is accessed
-      from the <em>Help | About</em> menu option.
+      <em>CodeSnip</em> and the <em>DelphiDabbler Code Snippets Database</em>.
+      It is accessed from the <em>Help | About</em> menu option.
     </p>
     <p>
-      The program's version number is displayed in the heading of the dialogue
-      box.
+      The program's name and version number is displayed in the heading of the
+      dialogue box.
     </p>
     <p>
       In addition the dialogue has three tabs, each of which is described below.
@@ -59,7 +59,8 @@ <h2>
     </p>
     <ul class="unspaced">
       <li>
-        Where to find the <em>Code Snippets Database</em> online.
+        A brief description of the database with a link to its <em>GitHub</em>
+        project page.
       </li>
       <li>
         Licensing information.
@@ -89,8 +90,8 @@ <h3>
       </li>
       <li>
         <em>Main Database Directory</em> &ndash; the directory containing a
-        local copy of the DelphiDabbler Code Snippets Database database. This
-        directory may be empty if the user has not downloaded the database.
+        copy of the DelphiDabbler Code Snippets Database. This directory may be
+        empty if the database has not been installed.
       </li>
       <li>
         <em>User Database Directory</em> &ndash; the directory containing the
@@ -113,16 +114,16 @@ <h3>
     </h3>
     <p>
       The content of the program's application wide and per-user config files
-      can be displayed by clicking the <em>View Application Config File</em> and
-      <em>View Per-User Config File</em> buttons respectively.
+      can be displayed by clicking the <em>View Application  Config File</em>
+      and <em>View Per-User Config File</em> buttons respectively.
     </p>
     <p>
-      You can find documentation of the meaning of the config file entries in
-      <em>CodeSnip<em>'s <a
+      You can find documentation of the config file entries in
+      <em>CodeSnip</em>'s <a
         href="https://github.com/delphidabbler/codesnip"
         class="weblink"
         target="_blank"
-      >Git repository</a>.
+      >GitHub repository</a>.
     </p>
   </body>
 </html>

Src/Help/HTML/dlg_addcategory.htm

@@ -38,20 +38,20 @@ <h1>
       accessed from the <em>Categories | New Category</em> menu option.
     </p>
     <p>
-      Enter a description of the category in the edit box and click OK to add it
-      to the database. The description you provided will be used to identify the
-      category in program, so keep it brief.
+      Enter a description of the category in the edit box and click <em>OK</em>
+      to add it to the database. The description you provided will be used to
+      identify the category in the user interface, so keep it brief.
     </p>
     <p>
-      Leading and trailing spaces are ignored. If you enter an existing
+      Leading and trailing spaces are ignored. If you enter a pre-existing
       description a warning to that effect is displayed below the edit box. The
-      <em>OK</em> button will be disabled if you haven't entered any text or if
-      the entry is not valid.
+      <em>OK</em> button will be disabled if you haven't entered any text, if
+      the entry is not valid or if it is a duplicate.
     </p>
     <p>
-      Note that the new category may not appear in the
-      <a href="overview_pane.htm">overview pane</a> because it is empty. It will
-      however be available to use when editing snippets.
+      Depending on your settings, the new category may not appear in the
+      <a href="overview_pane.htm">overview pane</a>, because the category is
+      empty. It will however be available to use when editing snippets.
     </p>
   </body>
 </html>

Src/Help/HTML/dlg_backup.htm

@@ -35,7 +35,10 @@ <h1>
     <p>
       This Windows standard dialogue box is displayed when the <em>Database |
       Backup User Database</em> menu option is selected. Use the dialogue to
-      specify the name and location of the file the will store the backup.
+      specify the name and location of the file that will store the backup.
+    </p>
+    <p>
+      No extension is added to the specified file name.
     </p>
     <p>
       Note that the entire database is stored in a single file.