Update help file re save snippet information feature

delphidabbler · delphidabbler · commit afa37e47a5be · 2025-04-16T08:19:33.000+01:00
Added new help topic for the Save Snippet Information file save dialogue
box.

Updated help project file and help index file re the new topic.

Updated File menu help topic to add the new Save Snippet Information
menu option.
diff --git a/Src/Help/CodeSnip.hhp b/Src/Help/CodeSnip.hhp
@@ -57,6 +57,7 @@ HTML\dlg_registercompilers.htm
 HTML\dlg_renamecategory.htm
 HTML\dlg_restore.htm
 HTML\dlg_savehiliter.htm
+HTML\dlg_saveinfo.htm
 HTML\dlg_saveselection.htm
 HTML\dlg_savesnippet.htm
 HTML\dlg_selectcompiler.htm
diff --git a/Src/Help/HTML/dlg_saveinfo.htm b/Src/Help/HTML/dlg_saveinfo.htm
@@ -0,0 +1,48 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<!--
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at https://mozilla.org/MPL/2.0/
+ *
+ * Copyright (C) 2025, Peter Johnson (gravatar.com/delphidabbler).
+ *
+ * Help topic for Save Snippet Information dialogue box.
+-->
+<html>
+
+<head>
+    <meta name="generator" content="HTML Tidy, see www.w3.org">
+    <meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
+    <title>
+        Save Snippet Information Dialogue Box
+    </title>
+    <link rel="stylesheet" href="../css/codesnip.css" type="text/css">
+</head>
+
+<body>
+    <object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
+        <param name="ALink Name" value="SnippetInfoFileDlg">
+    </object>
+    <h1>
+        <a name="dlg_saveinfo"></a>Save Snippet Information Dialogue Box
+    </h1>
+    <p>
+        This dialogue box is displayed when the <em>File | Save Snippet
+        Information</em> menu option is clicked. It is used to specify the
+        name of the file into which information about the currently selected
+        snippet is to be saved.
+    </p>
+    <p>
+        The saved snippet information is written in rich text format.
+    </p>
+    <p>
+        This dialogue is a standard Windows save dialogue box. You specify the
+         name and folder for the file in the usual way.
+    </p>
+    <p>
+        Use the <em>Save</em> button to write the file to disk or press
+        <em>Cancel</em> to abort.
+    </p>
+</body>
+
+</html>
diff --git a/Src/Help/HTML/menu_file.htm b/Src/Help/HTML/menu_file.htm
@@ -44,6 +44,22 @@ <h1>
           not routines are ignored.
         </td>
       </tr>
+      <tr>
+        <td class="img">
+          &nbsp;
+        </td>
+        <td class="item">
+          Save Snippet Information<br>
+          [<span class="smallcaps">Shift+Ctrl+I</span>]
+        </td>
+        <td class="desc">
+          Saves information about the currently selected snippet to file, in
+          rich text format. The information saved is that displayed in the
+          <a href="detail_pane.htm">Detail Pane</a>.
+          The <a href="dlg_saveinfo.htm">Save Snippet Information</a> dialogue
+          box is displayed where the required file name is entered.
+        </td>
+      </tr>
       <tr>
         <td class="img">
           <img
diff --git a/Src/Help/Index.hhk b/Src/Help/Index.hhk
@@ -316,6 +316,10 @@
     <param name="Name" value="rename category dialogue">
     <param name="Local" value="HTML\dlg_renamecategory.htm">
     </OBJECT>
+  <LI> <OBJECT type="text/sitemap">
+    <param name="Name" value="save snippet information dialogue">
+    <param name="Local" value="HTML\dlg_saveinfo.htm">
+    </OBJECT>
   <LI> <OBJECT type="text/sitemap">
     <param name="Name" value="save annotated source dialogue">
     <param name="Local" value="HTML\dlg_savesnippet.htm">
