Merge branch 'feature/issue#31+#32+#34-update-help+docs' into develop

Author: delphidabbler

Docs/Design/FileFormats/export.html

@@ -201,6 +201,9 @@
       <li>
         <a href="#entities">Character Entities</a>
       </li>
+      <li>
+        <a href="#changes">Change Log</a>
+      </li>
     </ul>
   </nav>
 
@@ -384,6 +387,80 @@ <h1>
 
 </section>
 
+<section id="changes">
+
+  <h1>Change Log</h1>
+
+  <p>
+    This section notes the changes in the various versions of REML.
+  </p>
+
+  <p>
+    <strong>v1 of 2008/12/31</strong>
+  </p>
+
+  <p>
+    Introduced in CodeSnip v2.2.5
+  </p>
+
+  <ul>
+    <li>
+      Supported tags: <code class="value">&lt;strong&gt;</code> and <code class="value">&lt;a&gt;</code>.
+    </li>
+    <li>
+      Supported entities: <code class="value">&amp;gt;</code>, <code class="value">&amp;lt;</code>, <code class="value">&amp;quot;</code> and <code class="value">&amp;amp;</code>.
+    </li>
+    <li>
+      Supported protocols for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">http</code>.
+    </li>
+  </ul>
+
+  <p>
+    <strong>v2 of 2009/06/29</strong>
+  </p>
+
+  <p>
+    Introduced in CodeSnip v3.0
+  </p>
+
+  <ul>
+    <li>
+      Added tags: <code class="value">&lt;em&gt;</code>, <code class="value">&lt;var&gt;</code>, <code class="value">&lt;warning&gt;</code>, <code class="value">&lt;mono&gt;</code>, <code class="value">&lt;p&gt;</code> and <code class="value">&lt;heading&gt;</code>.
+    </li>
+    <li>
+      Added entity: <code class="value">&amp;copy;</code>.
+    </li>
+  </ul>
+
+  <p>
+    <strong>v3 of 2009/07/06</strong>
+  </p>
+
+  <p>
+    Introduced in CodeSnip v3.0.1
+  </p>
+
+  <ul>
+    <li>
+      Added protocol for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">file</code>.
+    </li>
+  </ul>
+
+  <p>
+    <strong>v4 of 2011/12/31</strong>
+  </p>
+
+  <p>
+    Introduced in CodeSnip v4.0 alpha 1 (preview)
+  </p>
+
+  <ul>
+    <li>
+      Added protocol for use in <code class="value">&lt;a&gt;</code> tags: <code class="value">https</code>.
+    </li>
+  </ul>
+
+</section>
 </body>
 
 </html>

Docs/Design/FileFormats/user-db.html

@@ -245,14 +245,14 @@ Known Installation and Upgrading Issues
 + Any syntax highlighter customisation you have made will be lost if you are
   updating from any v2 or earlier.
 
-  You will need to redo any customisation using the "Syntax Highlighter" tab of
+  You will need to redo any customisation using the "Syntax Highlighter" page of
   the Preferences dialogue box displayed from the "Tools | Preferences" menu
   option.
 
 + Your source code formatting preferences will have been lost if you are
   updating from v1.7.4 or earlier.
 
-  You will need to reconfigure them using the "Code Formatting" tab of the
+  You will need to reconfigure them using the "Code Formatting" page of the
   Preferences dialogue box displayed from the "Tools | Preferences" menu option.
 
 + If you have updated to CodeSnip v4.2.0 or later from any earlier v4 release,

Docs/Design/reml.html

@@ -27,7 +27,7 @@ interface
   ///  Dialog box that sets user preferences.
   ///  </summary>
   ///  <remarks>
-  ///  This dialog box displays tabs for preferences frames registered with the
+  ///  This dialog box displays pages for preferences frames registered with the
   ///  dialog box.
   ///  </remarks>
   TPreferencesDlg = class(TGenericOKDlg, INoPublicConstruct)
@@ -161,16 +161,17 @@ implementation
   Design notes
   ------------
 
-  This dialog box is a multi-page preferences dialog that provides access to
-  each page via a tab. The dialog box does not provide an implementation of each
-  page of the dialog. This representation must be provided by a frame descended
-  from TPrefsBaseFrame. Such frames must:
-    (a) register themselves with the dialog box by passing their class to the
+  This dialogue box is a multi-page preferences dialog that provides access to
+  each page via a list of page names. The dialogue box does not provide an
+  implementation of each page. This representation must be provided by a frame 
+  descended from TPrefsBaseFrame. Such frames must:
+    (a) register themselves with the dialogue box by passing their class to the
         TPreferencesDlg.RegisterPage class method.
     (b) implement all the abstract methods of TPrefsBaseFrame.
 
-  The dialog box will create registered frames when needed and host them within
-  a tab sheet in the main page control.
+  The dialogue box will create registered frames when needed and host them
+  within tab sheet in the main page control. It will also add the name of the
+  frame to a list control that is used to select the required "page".
 
   There is no need to modify this unit when a new frame is to be addded to it.
 }
@@ -188,7 +189,7 @@ implementation
 
 procedure TPreferencesDlg.ArrangeForm;
 var
-  Idx: Integer;           // loops through all displayed tab sheets
+  Idx: Integer;           // loops through all displayed page
   Frame: TPrefsBaseFrame; // references each preference frame
   TabSheet: TTabSheet;    // references each tab sheet
 begin
@@ -306,7 +307,7 @@ class function TPreferencesDlg.Execute(AOwner: TComponent;
 
 procedure TPreferencesDlg.FormDestroy(Sender: TObject);
 begin
-  // Save current tab
+  // Save current page
   if Assigned(pcMain.ActivePage) then
     Preferences.LastTab := MapTabSheetToPage(pcMain.ActivePage).DisplayName;
   inherited;
@@ -343,7 +344,7 @@ procedure TPreferencesDlg.InitForm;
   // Display and initialise required pages
   for TabIdx := 0 to Pred(pcMain.PageCount) do
     MapTabSheetToPage(TabIdx).LoadPrefs(fLocalPrefs, fFrameFlags);
-  // Select last use tab sheet (or 1st if last not known)
+  // Select last used tab sheet (or 1st if last not known)
   fCurrentPageIdx := GetLastTabIdx;
   if fCurrentPageIdx < 0 then
     fCurrentPageIdx := 0;

Docs/ReadMe.txt

@@ -7,7 +7,8 @@
  *
  * Implements a frame that allows user to set source code generation
  * preferences.
- * Designed for use as one of the tabs in the Preferences dialogue box.
+ *
+ * Designed for use as one of the pages in the Preferences dialogue box.
 }
 
 

Src/FmPreferencesDlg.pas

@@ -6,7 +6,8 @@
  * Copyright (C) 2012-2020, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Implements a frame that allows user to set application display preferences.
- * Designed for use as one of the tabs in the preferences dialog box.
+ 
+ * Designed for use as one of the pages in the preferences dialogue box.
 }
 
 

Src/FrCodeGenPrefs.pas

@@ -6,7 +6,8 @@
  * Copyright (C) 2007-2020, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Implements a frame that allows user to set general application preferences.
- * Designed for use as one of the tabs in the Preferences dialogue box.
+ *
+ * Designed for use as one of the pages in the Preferences dialogue box.
 }
 
 

Src/FrDisplayPrefs.pas

@@ -6,8 +6,9 @@
  * Copyright (C) 2006-2020, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Implements a frame that allows the user to set syntax highlighter
- * preferences. Designed for use as one of the tabs in the Preferences dialogue
- * box.
+ * preferences.
+ *
+ * Designed for use as one of the pages in the Preferences dialogue box.
 }
 
 

Src/FrGeneralPrefs.pas

@@ -5,8 +5,9 @@
  *
  * Copyright (C) 2007-2020, Peter Johnson (gravatar.com/delphidabbler).
  *
- * Implements a frame that allows user to set printing preferences. Designed for
- * use as one of the tabs in the Preferences dialogue box.
+ * Implements a frame that allows user to set printing preferences.
+ *
+ * Designed for use as one of the pages in the Preferences dialogue box.
 }