Merge branch 'release/4.21.0'

Author: delphidabbler

Build.html

@@ -6,7 +6,7 @@
  * 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) 2009-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2009-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Instructions for building CodeSnip from source.
 -->
@@ -191,10 +191,10 @@ <h3>
 </h3>
 
 <p>
-  This tool is used to compile version information (<code>.vi</code>) files
-  into intermediate resource source (<code>.rc</code>) files. Version 2.11.2
-  or later is required.
-  Version Information Editor can be obtained from
+  This tool is used to compile version information (<code>.vi</code>) files and
+  any associated macro file(s) into intermediate resource source
+  (<code>.rc</code>) files. Version 2.14.0 or later is required. Version
+  Information Editor can be obtained from
   <a
     href="https://github.com/delphidabbler/vied/releases"
   >https://github.com/delphidabbler/vied/releases</a>.

CHANGELOG.md

@@ -10,6 +10,26 @@ This change log begins with the first ever pre-release version of _CodeSnip_. Re
 
 From v4.1.0 the version numbering has attempted to adhere to the principles of [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Release v4.21.0 of 16 December 2022
+
+* Updated to support [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0`/Docs/Design/reml.html) in snippet description & extra information [issue #71]:
+  * Numerous new character entities supported. 
+  * New list tags: `<ol>`, `<ul>` & `<li>`.
+* Program now automatically detects new (supported) Delphi installations at startup and offers to register the compiler(s) to be used for test compiling snippets. This feature is on by default but can be turned off completely or for specifically excluded compilers [issue #19].
+* Modified Configure Compilers dialogue box:
+  * Added facility to customise automatic compiler detection on per-compiler or global basis.
+  * Changed manually triggered compiler detection to ignore excluded compilers.
+* Some refactoring [including issues #73 and #75].
+* Minor changes to program license
+  * Changed required image attribution in `Docs/License.html` [issue #63]
+  * Corrected copyright date & fix typo in licenses displayed by installer and help file [issue #65 & PR #72].
+* Bump per-user config file to version 19.
+* Documentation updates:
+  * Updated `README.md` re abandoned and new Git repo branches.
+  * Updated config file, database, export file & REML documentation re changes in this release [including issue #74].
+  * Help file updated with details of changes in this release.
+  * Updated development tool chain requirements in `Build.html`. 
+
 ## Release v4.20.2 of 04 November 2022
 
 * Fixes bug where an exception was raised when selecting a main menu item with the cursor keys then pressing F1. [issue 54]

Docs/Design/FileFormats/config.html

@@ -167,7 +167,7 @@ <h3>
 </p>
 
 <p>
-  There have been several versions of this file. The current one is version 18. The change to version 18 came with CodeSnip v4.20.0 and the addition of the [Prefs] section.
+  There have been several versions of this file. The current one is version 19. The change to version 19 came with CodeSnip v4.21.0 and the addition of the [Compilers] section and the <code class="key">CanAutoInstall</code> key in the [Cmp:XXX] sections.
 </p>
 
 <p>
@@ -333,8 +333,49 @@ <h4>
       Each entry contains a fully specified directory path.
     </div>
   </dd>
+  <dt>
+    <code class="key">CanAutoInstall</code> (Boolean)
+  </dt>
+  <dd>
+  <div class="half-spaced">
+    Determines whether the compiler can be automatically detected and registered by CodeSnip.
+  </div>
+  <div class="half-spaced">
+    Applies to Delphi compilers only, not to Free Pascal.
+  </div>
+  </dd>
+</dl>
+
+<h4>
+  [Compilers] section
+</h4>
+
+<p>
+  This section records configuration information that applies to all, or
+  multiple, compilers.
+</p>
+
+<p>
+  Name / Value pairs:
+</p>
+
+<dl class="indent">
+  <dt>
+    <code class="key">PermitStartupDetection</code> (Boolean)
+  </dt>
+  <dd>
+    <div class="half-spaced">
+      Determines whether CodeSnip should detect, and potentially register, any
+      Delphi compilers that are installed on the user's system but not
+      registered with the program.
+    </div>
+    <div class="half-spaced">
+      Does not apply to the Free Pascal compiler.
+    </div>
+  </dd>
 </dl>
 
+
 <h4>
   [Database] section
 </h4>
@@ -721,7 +762,7 @@ <h4>
       The version number of the config file. Incremented whenever the file format changes. If this section or this value is missing then the default value is <code class="value">1</code>.
     </div>
     <div class="half-spaced">
-      The current value is <code class="value">16</code>.
+      The current value is <code class="value">19</code>.
     </div>
   </dd>
   <dt>

Docs/Design/FileFormats/export.html

@@ -144,7 +144,7 @@ <h2>
         </div>
         <ul class="squashed">
           <li>
-            <span class="highlight">versions 1..4:</span> Attribute not
+            <span class="highlight">versions 1 to 4:</span> Attribute not
             provided.
           </li>
           <li>
@@ -175,8 +175,8 @@ <h2>
         <em>version</em>
       </dt>
       <dd>
-        Identifies version of file. Determines which tags are valid and
-        establishes rules concerning content. Valid versions are 1..7.
+        Identifies major version of file. Determines which tags are valid and
+        establishes rules concerning content. Valid versions are 1 to 7.
       </dd>
     </dl>
   </dd>
@@ -195,7 +195,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..6:</span> Contains information about user who created the file &nbsp; used for submissions to the online database, omitted for other exports.
+        <span class="highlight">versions 1 to 6:</span> Contains information about user who created the file &nbsp; used for submissions to the online database, omitted for other exports.
       </li>
       <li>
         <span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -209,7 +209,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..6:</span> User's name or nickname.
+        <span class="highlight">versions 1 to 6:</span> User's name or nickname.
       </li>
       <li>
         <span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -223,7 +223,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..6:</span> User's email address.
+        <span class="highlight">versions 1 to 6:</span> User's email address.
       </li>
       <li>
         <span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -237,7 +237,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..6:</span> Any comments provided by user.
+        <span class="highlight">versions 1 to 6:</span> Any comments provided by user.
       </li>
       <li>
         <span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -270,7 +270,7 @@ <h2>
         </div>
         <ul class="squashed">
           <li>
-            <span class="highlight">versions 1..4:</span> Name must begin with
+            <span class="highlight">versions 1 to 4:</span> Name must begin with
             an English language letter or the underscore.
           </li>
           <li>
@@ -292,13 +292,17 @@ <h2>
     </div>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..5:</span> Content is a single line
+        <span class="highlight">versions 1 to 5:</span> Content is a single line
         of plain text.
       </li>
       <li>
-        <span class="highlight">version 6 and later:</span> Content is formatted text
+        <span class="highlight">version 6 to 7.2:</span> Content is formatted text
         encoded in REML markup. REML v4 is supported.
       </li>
+      <li>
+        <span class="highlight">version 7.3 and later:</span> Content is formatted text
+        encoded in REML markup. REML v5 is supported.
+      </li>
     </ul>
   </dd>
 
@@ -315,7 +319,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..5:</span> Not supported.
+        <span class="highlight">versions 1 to 5:</span> Not supported.
       </li>
       <li>
         <div>
@@ -349,7 +353,7 @@ <h2>
   <dd>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..5:</span> Not supported.
+        <span class="highlight">versions 1 to 5:</span> Not supported.
       </li>
       <li>
         <span class="highlight">version 6 and later:</span> Display name of snippet. Can
@@ -440,7 +444,10 @@ <h2>
               <span class="highlight">version 4:</span> supports REML v3.
             </li>
             <li>
-              <span class="highlight">versions 5 &amp; 6:</span> supports REML v4.
+              <span class="highlight">versions 5 to 7.2:</span> supports REML v4.
+            </li>
+            <li>
+              <span class="highlight">version 7.3 &amp; later:</span> supports REML v5.
             </li>
           </ul>
         </li>
@@ -559,7 +566,7 @@ <h2>
             <em>dXE2</em> &ndash; Delphi XE2 compiler <span class="highlight">(v4.3 &amp; later)</span>
           </li>
           <li>
-            <em>dXE3</em> &ndash; Delphi XE3 compiler <span class="highlight">(v4.4..v4.5  and v6.1 &amp; later)</span>
+            <em>dXE3</em> &ndash; Delphi XE3 compiler <span class="highlight">(v4.4 to v4.5  and v6.1 &amp; later)</span>
           </li>
           <li>
             <em>dXE4</em> &ndash; Delphi XE4 compiler <span class="highlight">(v4.5 only)</span>
@@ -659,7 +666,7 @@ <h2>
     </div>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..4:</span> Name must begin with an
+        <span class="highlight">versions 1 to 4:</span> Name must begin with an
         English language letter or the underscore.
       </li>
       <li>
@@ -686,7 +693,7 @@ <h2>
     </div>
     <ul class="squashed">
       <li>
-        <span class="highlight">versions 1..4:</span> Name must begin with an
+        <span class="highlight">versions 1 to 4:</span> Name must begin with an
         English language letter or the underscore.
       </li>
       <li>
@@ -783,7 +790,7 @@ <h2>
       Introduced with CodeSnip v3.0.
     </p>
     <p>
-      Introduced with CodeSnip v3.0.
+      The following tag was removed:
     </p>
     <ul class="squashed">
       <li>
@@ -971,6 +978,12 @@ <h2>
       <dd>
         Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
+      <dt>
+        <em>Version 7.3 - 16 December 2022</em>
+      </dt>
+      <dd>
+        Updated with CodeSnip v4.21.0 to add support for REML v5, which is backward compatible with REML v4.
+      </dd>
     </dl>
   </dd>
 </dl>
@@ -1019,6 +1032,10 @@ <h2>
   Readers of v1 to v6 files must ignore the <em>codesnip-export/user-info</em> tag and sub-tags, where present.
 </p>
 
+<p>
+  Readers of v2 files and later can parse REML as v5, since all versions of REML up to v5 are backwards compatible.
+</p>
+
 </section>
 
 </body>

Docs/Design/FileFormats/main-db.html

@@ -925,7 +925,7 @@ <h2>
 <ol>
   <li id="footnote-1">
     <p>
-      REML is a text markup language used to format text. REML version 4 is supported. The REML format is documented <a href="../reml.html">here</a>.
+      REML is a text markup language used to format text. REML version 5 is supported. The REML format is documented <a href="../reml.html">here</a>.
      </p>
   </li>
   <li id="footnote-2">

Docs/Design/FileFormats/user-db.html

@@ -199,7 +199,7 @@ <h3 id="xml-file">
         <em>version</em>
       </dt>
       <dd>
-        Identifies version of file. Determines which tags are valid and rules
+        Identifies major version of file. Determines which tags are valid and rules
         concerning content. Valid versions are 1..6.
       </dd>
     </dl>
@@ -321,9 +321,13 @@ <h3 id="xml-file">
         of plain text.
       </li>
       <li>
-        <span class="highlight">version 6:</span> Content is formatted text
+        <span class="highlight">version 6.0 to 6.10:</span> Content is formatted text
         encoded in REML markup. REML v4 is supported.
       </li>
+      <li>
+        <span class="highlight">version 6.11 &amp; later:</span> Content is formatted text
+        encoded in REML markup. REML v5 is supported.
+      </li>
     </ul>
   </dd>
 
@@ -465,7 +469,10 @@ <h3 id="xml-file">
               <span class="highlight">version 4:</span> supports REML v3.
             </li>
             <li>
-              <span class="highlight">versions 5 &amp; 6:</span> supports REML v4.
+              <span class="highlight">versions 5 &amp; 6.10:</span> supports REML v4.
+            </li>
+            <li>
+              <span class="highlight">version 6.11 &amp; later:</span> supports REML v5.
             </li>
           </ul>
         </li>
@@ -1007,6 +1014,12 @@ <h2>
       <dd>
         Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
+      <dt>
+        <em>Version 6.11 - 16 December 2022</em>
+      </dt>
+      <dd>
+        Updated with CodeSnip v4.21.0 to add support for REML v5, which is backwards compatible with REML v4.
+      </dd>
     </dl>
   </dd>
 </dl>
@@ -1064,6 +1077,10 @@ <h3>
   </li>
 </ul>
 
+<p>
+  Readers of v2 and later files may parse REML from any file version as if it were REML v5, since all versions of REML up to v5 are compatible.
+</p>
+
 <h3>
   Handling Text File Encodings
 </h3>