Skip to content

Commit 0320b6a

Browse files
author
delphidabbler
committed
Fix errors a make clarifications
1 parent 21de63b commit 0320b6a

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

Docs/Design/FileFormats/user-db.html

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ <h2>
5858
</p>
5959

6060
<p>
61-
The source code for each snippet is stored in separate sequentially numbered
62-
.dat data files &ndash; one per snippet. Each source code file is referenced
63-
by the XML file.
61+
The source code for each snippet is stored in separate, sequentially numbered, <code>.dat</code> data files &ndash; one per snippet. Each source code file is referenced by the XML file.
6462
</p>
6563

6664
<p>
@@ -86,7 +84,7 @@ <h2>
8684
</p>
8785

8886
<p>
89-
CodeSnip v4 must be able to work with all these encoding because it may
87+
CodeSnip v4 must be able to work with all these encodings because it may
9088
inherit a copy of a user database in an earlier format.
9189
</p>
9290

@@ -283,7 +281,7 @@ <h3>
283281
</li>
284282
<li>
285283
<span class="highlight">version 6:</span> Content is formatted text
286-
encoded in REML markup. REML v3 is supported.
284+
encoded in REML markup. REML v4 is supported.
287285
</li>
288286
</ul>
289287
</dd>
@@ -423,7 +421,10 @@ <h3>
423421
<span class="highlight">version 3:</span> indicates REML v2
424422
</li>
425423
<li>
426-
<span class="highlight">versions 4..6:</span> indicates REML v3.
424+
<span class="highlight">versions 4..5:</span> indicates REML v3.
425+
</li>
426+
<li>
427+
<span class="highlight">version 6:</span> indicates REML v4.
427428
</li>
428429
</ul>
429430
</li>
@@ -673,8 +674,8 @@ <h3>
673674

674675
<p>
675676
Source code is stored separately from the main XML file. The source code of
676-
each snippet has its file. Files are numbered sequentially and have a .dat
677-
extension, for example <code>6.dat</code>.
677+
each snippet has its own file. Files are numbered sequentially and have a
678+
<code>.dat</code> extension, for example <code>6.dat</code>.
678679
</p>
679680

680681
<p>
@@ -789,7 +790,10 @@ <h2>
789790
Previously the description was plain text.
790791
</div>
791792
<div class="half-spaced">
792-
The following tag was introduced:
793+
The supported version of REML was updated to v4.
794+
</div>
795+
<div class="half-spaced">
796+
The following tags were introduced:
793797
</div>
794798
<ul class="squashed">
795799
<li>
@@ -810,7 +814,7 @@ <h3>
810814
Readers of version 1 files must convert the contents of the
811815
<em>codesnip-data/routines/routine/comments</em>,
812816
<em>codesnip-data/routines/routine/credits</em> and
813-
<em>codesnip-data/routines/routine/credits-url</em> tags into formatted text
817+
<em>codesnip-data/routines/routine/credits-url</em> tags into valid REML code
814818
that simulates the parsed content of the
815819
<em>codesnip-data/routines/routine/extra</em> tag.
816820
</p>
@@ -828,7 +832,7 @@ <h3>
828832
<ol>
829833
<li>
830834
Convert the plain text snippet description read from
831-
<em>codesnip-data/routines/routine/description</em> into the formatted text
835+
<em>codesnip-data/routines/routine/description</em> into the REML
832836
equivalent of a single paragraph containing the description.
833837
</li>
834838
<li>

0 commit comments

Comments
 (0)