Update user-db.html with links to REML documentation

Fixes #134
delphidabbler · Oct 23, 2024 · 5217e27 · 5217e27
1 parent 2a323b6
commit 5217e27
Showing 1 changed file with 25 additions and 25 deletions.
diff --git a/Docs/Design/FileFormats/user-db.html b/Docs/Design/FileFormats/user-db.html
@@ -322,15 +322,15 @@ <h3 id="xml-file">
       </li>
       <li>
         <span class="highlight">version 6.0 to 6.10:</span> Content is formatted text
-        encoded in REML markup. REML v4 is supported.
+        encoded in <a href="../reml.html">REML</a> markup. <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">REML v4</a> is supported.
       </li>
       <li>
         <span class="highlight">version 6.11 &amp; 6.12:</span> Content is formatted text
-        encoded in REML markup. REML v5 is supported.
+        encoded in <a href="../reml.html">REML</a> markup. <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v5.html">REML v5</a> 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.
+        encoded in <a href="../reml.html">REML</a> markup. <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v6.html">REML v6</a> is supported.
       </li>
     </ul>
   </dd>
@@ -460,26 +460,26 @@ <h3 id="xml-file">
           <div class="unspaced">
             <span class="highlight">version 2 and later:</span> Additional
             information about a snippet. Content is formatted text encoded in
-            REML markup.
+            <a href="../reml.html">REML</a> markup.
           </div>
           <ul class="squashed">
             <li>
-              <span class="highlight">version 2:</span> supports REML v1.
+              <span class="highlight">version 2:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v1.html">REML v1</a>.
             </li>
             <li>
-              <span class="highlight">version 3:</span> supports REML v2.
+              <span class="highlight">version 3:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v2.html">REML v2</a>.
             </li>
             <li>
-              <span class="highlight">version 4:</span> supports REML v3.
+              <span class="highlight">version 4:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v3.html">REML v3</a>.
             </li>
             <li>
-              <span class="highlight">versions 5 &amp; 6.10:</span> supports REML v4.
+              <span class="highlight">versions 5 &amp; 6.10:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">REML v4</a>.
             </li>
             <li>
-              <span class="highlight">version 6.11 &amp; 6.12:</span> supports REML v5.
+              <span class="highlight">version 6.11 &amp; 6.12:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v5.html">REML v5</a>.
             </li>
             <li>
-              <span class="highlight">version 6.13 &amp; later:</span> supports REML v6.
+              <span class="highlight">version 6.13 &amp; later:</span> supports <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v6.html">REML v6</a>.
             </li>
           </ul>
         </li>
@@ -788,7 +788,7 @@ <h2>
       Supported Delphi compilers from Delphi 2 to Delphi 2007 plus Free Pascal.
     </p>
     <p>
-      REML not supported.
+      <a href="../reml.html">REML</a> not supported.
     </p>
     <p>
       Data files were ANSI text using code page 1252. The XML file was in UTF-8 format with no BOM and no XML encoding attribute.
@@ -833,8 +833,8 @@ <h2>
       </li>
     </ul>
     <p>
-      The version of REML supported by the
-      <em>codesnip-data/routines/routine/extra</em> tag was v1.
+      The version of <a href="../reml.html">REML</a> supported by the
+      <em>codesnip-data/routines/routine/extra</em> tag was <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v1.html">v1</a>.
     </p>
   </dd>
 
@@ -862,8 +862,8 @@ <h2>
       </li>
     </ul>
     <p>
-      The version of REML supported by the
-      <em>codesnip-data/routines/routine/extra</em> tag was updated to v2.
+      The version of <a href="../reml.html">REML</a> supported by the
+      <em>codesnip-data/routines/routine/extra</em> tag was updated to <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v2.html">v2</a>.
     </p>
   </dd>
 
@@ -875,8 +875,8 @@ <h2>
       Introduced with CodeSnip v3.0.1.
     </p>
     <p>
-      The version of REML supported by the
-      <em>codesnip-data/routines/routine/extra</em> tag was updated to v3.
+      The version of <a href="../reml.html">REML</a> supported by the
+      <em>codesnip-data/routines/routine/extra</em> tag was updated to <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v3.html">v3</a>.
     </p>
     <dl>
       <dt>
@@ -937,8 +937,8 @@ <h2>
       New &quot;class&quot and &quot;unit&quot; snippet kinds supported.
     </p>
     <p>
-      The version of REML supported by the
-      <em>codesnip-data/routines/routine/extra</em> tag was updated to v4.
+      The version of <a href="../reml.html">REML</a> supported by the
+      <em>codesnip-data/routines/routine/extra</em> tag was updated to <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">v4</a>.
     </p>
   </dd>
 
@@ -950,7 +950,7 @@ <h2>
       Introduced with CodeSnip v4.0 beta 1.
     </p>
     <p>
-      A snippet's description is now stored as formatted text using REML v4 markup. Previously the description was plain text.
+      A snippet's description is now stored as formatted text using <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">REML v4</a> markup. Previously the description was plain text.
     </p>
     <p>
       The following tags were introduced:
@@ -1028,7 +1028,7 @@ <h2>
         <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.
+        Updated with CodeSnip v4.21.0 to add support for <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v5.html">REML v5</a>, which is backwards compatible with <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">REML v4</a>.
       </dd>
       <dt>
         <em>Version 6.12 - 7 November 2023</em>
@@ -1040,7 +1040,7 @@ <h2>
         <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.
+        Updated with CodeSnip v4.23.0 to add support for <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v6.html">REML v6</a>, which is backwards compatible with <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v4.html">REML v4</a>.
       </dd>
     </dl>
   </dd>
@@ -1073,7 +1073,7 @@ <h3>
 </ul>
 
 <p>
-  into valid REML code that simulates the parsed content of the <em>codesnip-data/routines/routine/extra</em> tag.
+  into valid <a href="../reml.html">REML</a> code that simulates the parsed content of the <em>codesnip-data/routines/routine/extra</em> tag.
 </p>
 
 <p>
@@ -1090,7 +1090,7 @@ <h3>
 <ul>
   <li>
     Convert the plain text snippet description read from
-    <em>codesnip-data/routines/routine/description</em> into the REML
+    <em>codesnip-data/routines/routine/description</em> into the <a href="../reml.html">REML</a>
     equivalent of a single paragraph containing the description.
   </li>
   <li>
@@ -1100,7 +1100,7 @@ <h3>
 </ul>
 
 <p>
-  Readers of v2 and later files may parse REML from any file version as if it were REML v6, since all versions of REML up to v6 are compatible.
+  Readers of v2 and later files may parse <a href="../reml.html">REML</a> from any file version as if it were <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/delphidabbler/reml/main/docs/reml-v6.html">REML v6</a>, since all versions of REML up to v6 are compatible.
 </p>
 
 <h3>