Skip to content

Commit 5217e27

Browse files
delphidabblerdelphidabbler
committed
Update user-db.html with links to REML documentation
Fixes #134
1 parent 2a323b6 commit 5217e27

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

Diff for: ‎Docs/Design/FileFormats/user-db.html

+25-25
Original file line numberDiff line numberDiff line change
@@ -322,15 +322,15 @@ <h3 id="xml-file">
322322
</li>
323323
<li>
324324
<span class="highlight">version 6.0 to 6.10:</span> Content is formatted text
325-
encoded in REML markup. REML v4 is supported.
325+
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.
326326
</li>
327327
<li>
328328
<span class="highlight">version 6.11 &amp; 6.12:</span> Content is formatted text
329-
encoded in REML markup. REML v5 is supported.
329+
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.
330330
</li>
331331
<li>
332332
<span class="highlight">version 6.13 &amp; later:</span> Content is formatted text
333-
encoded in REML markup. REML v6 is supported.
333+
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.
334334
</li>
335335
</ul>
336336
</dd>
@@ -460,26 +460,26 @@ <h3 id="xml-file">
460460
<div class="unspaced">
461461
<span class="highlight">version 2 and later:</span> Additional
462462
information about a snippet. Content is formatted text encoded in
463-
REML markup.
463+
<a href="../reml.html">REML</a> markup.
464464
</div>
465465
<ul class="squashed">
466466
<li>
467-
<span class="highlight">version 2:</span> supports REML v1.
467+
<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>.
468468
</li>
469469
<li>
470-
<span class="highlight">version 3:</span> supports REML v2.
470+
<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>.
471471
</li>
472472
<li>
473-
<span class="highlight">version 4:</span> supports REML v3.
473+
<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>.
474474
</li>
475475
<li>
476-
<span class="highlight">versions 5 &amp; 6.10:</span> supports REML v4.
476+
<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>.
477477
</li>
478478
<li>
479-
<span class="highlight">version 6.11 &amp; 6.12:</span> supports REML v5.
479+
<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>.
480480
</li>
481481
<li>
482-
<span class="highlight">version 6.13 &amp; later:</span> supports REML v6.
482+
<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>.
483483
</li>
484484
</ul>
485485
</li>
@@ -788,7 +788,7 @@ <h2>
788788
Supported Delphi compilers from Delphi 2 to Delphi 2007 plus Free Pascal.
789789
</p>
790790
<p>
791-
REML not supported.
791+
<a href="../reml.html">REML</a> not supported.
792792
</p>
793793
<p>
794794
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>
833833
</li>
834834
</ul>
835835
<p>
836-
The version of REML supported by the
837-
<em>codesnip-data/routines/routine/extra</em> tag was v1.
836+
The version of <a href="../reml.html">REML</a> supported by the
837+
<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>.
838838
</p>
839839
</dd>
840840

@@ -862,8 +862,8 @@ <h2>
862862
</li>
863863
</ul>
864864
<p>
865-
The version of REML supported by the
866-
<em>codesnip-data/routines/routine/extra</em> tag was updated to v2.
865+
The version of <a href="../reml.html">REML</a> supported by the
866+
<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>.
867867
</p>
868868
</dd>
869869

@@ -875,8 +875,8 @@ <h2>
875875
Introduced with CodeSnip v3.0.1.
876876
</p>
877877
<p>
878-
The version of REML supported by the
879-
<em>codesnip-data/routines/routine/extra</em> tag was updated to v3.
878+
The version of <a href="../reml.html">REML</a> supported by the
879+
<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>.
880880
</p>
881881
<dl>
882882
<dt>
@@ -937,8 +937,8 @@ <h2>
937937
New &quot;class&quot and &quot;unit&quot; snippet kinds supported.
938938
</p>
939939
<p>
940-
The version of REML supported by the
941-
<em>codesnip-data/routines/routine/extra</em> tag was updated to v4.
940+
The version of <a href="../reml.html">REML</a> supported by the
941+
<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>.
942942
</p>
943943
</dd>
944944

@@ -950,7 +950,7 @@ <h2>
950950
Introduced with CodeSnip v4.0 beta 1.
951951
</p>
952952
<p>
953-
A snippet's description is now stored as formatted text using REML v4 markup. Previously the description was plain text.
953+
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.
954954
</p>
955955
<p>
956956
The following tags were introduced:
@@ -1028,7 +1028,7 @@ <h2>
10281028
<em>Version 6.11 - 16 December 2022</em>
10291029
</dt>
10301030
<dd>
1031-
Updated with CodeSnip v4.21.0 to add support for REML v5, which is backwards compatible with REML v4.
1031+
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>.
10321032
</dd>
10331033
<dt>
10341034
<em>Version 6.12 - 7 November 2023</em>
@@ -1040,7 +1040,7 @@ <h2>
10401040
<em>Version 6.13 - 2 April 2024</em>
10411041
</dt>
10421042
<dd>
1043-
Updated with CodeSnip v4.23.0 to add support for REML v6, which is backwards compatible with REML v4.
1043+
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>.
10441044
</dd>
10451045
</dl>
10461046
</dd>
@@ -1073,7 +1073,7 @@ <h3>
10731073
</ul>
10741074

10751075
<p>
1076-
into valid REML code that simulates the parsed content of the <em>codesnip-data/routines/routine/extra</em> tag.
1076+
into valid <a href="../reml.html">REML</a> code that simulates the parsed content of the <em>codesnip-data/routines/routine/extra</em> tag.
10771077
</p>
10781078

10791079
<p>
@@ -1090,7 +1090,7 @@ <h3>
10901090
<ul>
10911091
<li>
10921092
Convert the plain text snippet description read from
1093-
<em>codesnip-data/routines/routine/description</em> into the REML
1093+
<em>codesnip-data/routines/routine/description</em> into the <a href="../reml.html">REML</a>
10941094
equivalent of a single paragraph containing the description.
10951095
</li>
10961096
<li>
@@ -1100,7 +1100,7 @@ <h3>
11001100
</ul>
11011101

11021102
<p>
1103-
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.
1103+
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.
11041104
</p>
11051105

11061106
<h3>

0 commit comments

Comments
 (0)