Update REML docs & help topic re REML v6

delphidabbler · delphidabbler · commit dfa315ba8548 · 2024-04-02T13:08:28.000+01:00
* Updated affected file format documentation
* Updated REML documentation (reml.html)
* Updated help topic (reml.htm)

Also corrected omission in list of REML entities in reml.html
diff --git a/Docs/Design/FileFormats/export.html b/Docs/Design/FileFormats/export.html
@@ -5,7 +5,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) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2024, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: Export
 -->
@@ -300,9 +300,13 @@ <h2>
         encoded in REML markup. REML v4 is supported.
       </li>
       <li>
-        <span class="highlight">version 7.3 and later:</span> Content is formatted text
+        <span class="highlight">version 7.3 and 7.4:</span> Content is formatted text
         encoded in REML markup. REML v5 is supported.
       </li>
+      <li>
+        <span class="highlight">version 7.5 and later:</span> Content is formatted text
+        encoded in REML markup. REML v6 is supported.
+      </li>
     </ul>
   </dd>
 
@@ -447,7 +451,10 @@ <h2>
               <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.
+              <span class="highlight">version 7.3 &amp; 7.4:</span> supports REML v5.
+            </li>
+            <li>
+              <span class="highlight">version 7.5 &amp; later:</span> supports REML v6.
             </li>
           </ul>
         </li>
@@ -993,6 +1000,12 @@ <h2>
       <dd>
         Updated in time for CodeSnip v4.22.0 to add support for Delphi 12 Athens.
       </dd>
+      <dt>
+        <em>Version 7.5 - 2 April 2014</em>
+      </dt>
+      <dd>
+        Added support for REML v6, which is backward compatible with REML v4.
+      </dd>
     </dl>
   </dd>
 </dl>
@@ -1042,7 +1055,7 @@ <h2>
 </p>
 
 <p>
-  Readers of v2 files and later can parse REML as v5, since all versions of REML up to v5 are backwards compatible.
+  Readers of v2 files and later can parse REML as v6, since all versions of REML up to v6 are backwards compatible.
 </p>
 
 </section>
diff --git a/Docs/Design/FileFormats/main-db.html b/Docs/Design/FileFormats/main-db.html
@@ -5,7 +5,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) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2024, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: Main Database
 -->
@@ -928,7 +928,7 @@ <h2>
 <ol>
   <li id="footnote-1">
     <p>
-      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>.
+      REML is a text markup language used to format text. REML version 6 is supported. The REML format is documented <a href="../reml.html">here</a>.
      </p>
   </li>
   <li id="footnote-2">
diff --git a/Docs/Design/FileFormats/user-db.html b/Docs/Design/FileFormats/user-db.html
@@ -5,7 +5,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) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2024, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: User Database
 -->
@@ -325,9 +325,13 @@ <h3 id="xml-file">
         encoded in REML markup. REML v4 is supported.
       </li>
       <li>
-        <span class="highlight">version 6.11 &amp; later:</span> Content is formatted text
+        <span class="highlight">version 6.11 &amp; 6.12:</span> Content is formatted text
         encoded in REML markup. REML v5 is supported.
       </li>
+      <li>
+        <span class="highlight">version 6.13 &amp; later:</span> Content is formatted text
+        encoded in REML markup. REML v6 is supported.
+      </li>
     </ul>
   </dd>
 
@@ -472,7 +476,10 @@ <h3 id="xml-file">
               <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.
+              <span class="highlight">version 6.11 &amp; 6.12:</span> supports REML v5.
+            </li>
+            <li>
+              <span class="highlight">version 6.13 &amp; later:</span> supports REML v6.
             </li>
           </ul>
         </li>
@@ -1029,6 +1036,12 @@ <h2>
       <dd>
         Updated in time for CodeSnip v4.22.0 to add support for Delphi 12 Athens.
       </dd>
+      <dt>
+        <em>Version 6.13 - 2 April 2024</em>
+      </dt>
+      <dd>
+        Updated with CodeSnip v4.23.0 to add support for REML v6, which is backwards compatible with REML v4.
+      </dd>
     </dl>
   </dd>
 </dl>
diff --git a/Docs/Design/reml.html b/Docs/Design/reml.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 
 <!--
- * This file copyright (C) 2020-2023, Peter Johnson (gravatar.com/delphidabbler) and
+ * This file copyright (C) 2020-2024, Peter Johnson (gravatar.com/delphidabbler) and
  * is licensed under the MIT License: https://opensource.org/licenses/MIT
  *
  * DelphiDabbler Code Snippets Database Documentation: REML markup language
@@ -251,7 +251,7 @@ <h1>
     The REML language is a SGML language similar to a greatly simplified XHTML. The are a small number of tags and character entities that can be used.
   </p>
   <aside>
-    <strong>Note:</strong> The language described here is REML v5. v4 is still in regular use in CodeSnip up to v4.20.x. Earlier versions are obsolete.
+    <strong>Note:</strong> The language described here is REML v6. v4 is still in regular use in CodeSnip up to v4.20.x. Earlier versions are obsolete.
   </aside>
 
 </section>
@@ -524,6 +524,10 @@ <h1>
         <td><code>&amp;deg;</code></td>
         <td>°</td>
       </tr>
+      <tr>
+        <td><code>&amp;cent;</code></td>
+        <td>¢</td>
+      </tr>
       <tr>
         <td><code>&amp;laquo;</code></td>
         <td>«</td>
@@ -536,6 +540,10 @@ <h1>
         <td><code>&amp;iquest;</code></td>
         <td>¿</td>
       </tr>
+      <tr>
+        <td><code>&amp;apos;</code></td>
+        <td>'</td>
+      </tr>
     </tbody>
   </table>
 
@@ -644,8 +652,21 @@ <h1>Change Log</h1>
     </li>
   </ul>
 
-</section>
+  <p>
+    <strong>v6 of 2024-04-02</strong>
+  </p>
+
+  <p>
+    Introduced in CodeSnip v4.23.0
+  </p>
 
+  <ul>
+    <li>
+      Added entity: <code class="value">&amp;apos;</code>.
+    </li>
+  </ul>
+  
+  </section>
 
 </body>
 
diff --git a/Src/Help/HTML/reml.htm b/Src/Help/HTML/reml.htm
@@ -4,7 +4,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-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2009-2024, Peter Johnson (gravatar.com/delphidabbler).
  *
  * Help topic describing REML markup language.
 -->
@@ -43,8 +43,8 @@ <h1>
     <p>
       <em>REML</em> is <em>CodeSnip</em>'s own little markup language that can
       be used to style the text of a snippet's description and / or extra
-      information. The latest version is v5, which is backwards compatible with
-	  all other versions.
+      information. The latest version is v6, which is backwards compatible with
+	    all other versions.
     </p>
     <h2>
       Language Details
