Skip to content

Commit a1ec866

Browse files
delphidabblerdelphidabbler
committed
Merge branch 'feature/71-extend-reml-to-v5' into develop
Closes #71
2 parents 24cf048 + 1907d1b commit a1ec866

20 files changed

+1136
-370
lines changed

‎Docs/Design/FileFormats/export.html

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h2>
144144
</div>
145145
<ul class="squashed">
146146
<li>
147-
<span class="highlight">versions 1..4:</span> Attribute not
147+
<span class="highlight">versions 1 to 4:</span> Attribute not
148148
provided.
149149
</li>
150150
<li>
@@ -176,7 +176,7 @@ <h2>
176176
</dt>
177177
<dd>
178178
Identifies version of file. Determines which tags are valid and
179-
establishes rules concerning content. Valid versions are 1..7.
179+
establishes rules concerning content. Valid versions are 1 to 7.
180180
</dd>
181181
</dl>
182182
</dd>
@@ -195,7 +195,7 @@ <h2>
195195
<dd>
196196
<ul class="squashed">
197197
<li>
198-
<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.
198+
<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.
199199
</li>
200200
<li>
201201
<span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -209,7 +209,7 @@ <h2>
209209
<dd>
210210
<ul class="squashed">
211211
<li>
212-
<span class="highlight">versions 1..6:</span> User's name or nickname.
212+
<span class="highlight">versions 1 to 6:</span> User's name or nickname.
213213
</li>
214214
<li>
215215
<span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -223,7 +223,7 @@ <h2>
223223
<dd>
224224
<ul class="squashed">
225225
<li>
226-
<span class="highlight">versions 1..6:</span> User's email address.
226+
<span class="highlight">versions 1 to 6:</span> User's email address.
227227
</li>
228228
<li>
229229
<span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -237,7 +237,7 @@ <h2>
237237
<dd>
238238
<ul class="squashed">
239239
<li>
240-
<span class="highlight">versions 1..6:</span> Any comments provided by user.
240+
<span class="highlight">versions 1 to 6:</span> Any comments provided by user.
241241
</li>
242242
<li>
243243
<span class="highlight">version 7:</span> Not supported. Ignored if present.
@@ -270,7 +270,7 @@ <h2>
270270
</div>
271271
<ul class="squashed">
272272
<li>
273-
<span class="highlight">versions 1..4:</span> Name must begin with
273+
<span class="highlight">versions 1 to 4:</span> Name must begin with
274274
an English language letter or the underscore.
275275
</li>
276276
<li>
@@ -292,13 +292,17 @@ <h2>
292292
</div>
293293
<ul class="squashed">
294294
<li>
295-
<span class="highlight">versions 1..5:</span> Content is a single line
295+
<span class="highlight">versions 1 to 5:</span> Content is a single line
296296
of plain text.
297297
</li>
298298
<li>
299-
<span class="highlight">version 6 and later:</span> Content is formatted text
299+
<span class="highlight">version 6 to 7.2:</span> Content is formatted text
300300
encoded in REML markup. REML v4 is supported.
301301
</li>
302+
<li>
303+
<span class="highlight">version 7.3 and later:</span> Content is formatted text
304+
encoded in REML markup. REML v5 is supported.
305+
</li>
302306
</ul>
303307
</dd>
304308

@@ -315,7 +319,7 @@ <h2>
315319
<dd>
316320
<ul class="squashed">
317321
<li>
318-
<span class="highlight">versions 1..5:</span> Not supported.
322+
<span class="highlight">versions 1 to 5:</span> Not supported.
319323
</li>
320324
<li>
321325
<div>
@@ -349,7 +353,7 @@ <h2>
349353
<dd>
350354
<ul class="squashed">
351355
<li>
352-
<span class="highlight">versions 1..5:</span> Not supported.
356+
<span class="highlight">versions 1 to 5:</span> Not supported.
353357
</li>
354358
<li>
355359
<span class="highlight">version 6 and later:</span> Display name of snippet. Can
@@ -440,7 +444,10 @@ <h2>
440444
<span class="highlight">version 4:</span> supports REML v3.
441445
</li>
442446
<li>
443-
<span class="highlight">versions 5 &amp; 6:</span> supports REML v4.
447+
<span class="highlight">versions 5 to 7.2:</span> supports REML v4.
448+
</li>
449+
<li>
450+
<span class="highlight">version 7.3 &amp; later:</span> supports REML v5.
444451
</li>
445452
</ul>
446453
</li>
@@ -559,7 +566,7 @@ <h2>
559566
<em>dXE2</em> &ndash; Delphi XE2 compiler <span class="highlight">(v4.3 &amp; later)</span>
560567
</li>
561568
<li>
562-
<em>dXE3</em> &ndash; Delphi XE3 compiler <span class="highlight">(v4.4..v4.5 and v6.1 &amp; later)</span>
569+
<em>dXE3</em> &ndash; Delphi XE3 compiler <span class="highlight">(v4.4 to v4.5 and v6.1 &amp; later)</span>
563570
</li>
564571
<li>
565572
<em>dXE4</em> &ndash; Delphi XE4 compiler <span class="highlight">(v4.5 only)</span>
@@ -659,7 +666,7 @@ <h2>
659666
</div>
660667
<ul class="squashed">
661668
<li>
662-
<span class="highlight">versions 1..4:</span> Name must begin with an
669+
<span class="highlight">versions 1 to 4:</span> Name must begin with an
663670
English language letter or the underscore.
664671
</li>
665672
<li>
@@ -686,7 +693,7 @@ <h2>
686693
</div>
687694
<ul class="squashed">
688695
<li>
689-
<span class="highlight">versions 1..4:</span> Name must begin with an
696+
<span class="highlight">versions 1 to 4:</span> Name must begin with an
690697
English language letter or the underscore.
691698
</li>
692699
<li>
@@ -783,7 +790,7 @@ <h2>
783790
Introduced with CodeSnip v3.0.
784791
</p>
785792
<p>
786-
Introduced with CodeSnip v3.0.
793+
The following tag was removed:
787794
</p>
788795
<ul class="squashed">
789796
<li>
@@ -971,6 +978,12 @@ <h2>
971978
<dd>
972979
Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
973980
</dd>
981+
<dt>
982+
<em>Version 7.3 - &laquo;&laquo;TODO&raquo;&raquo;</em>
983+
</dt>
984+
<dd>
985+
Updated with CodeSnip v&laquo;&laquo;TODO&raquo;&raquo; to add support for REML v5, which is backward compatible with REML v4.
986+
</dd>
974987
</dl>
975988
</dd>
976989
</dl>
@@ -1019,6 +1032,10 @@ <h2>
10191032
Readers of v1 to v6 files must ignore the <em>codesnip-export/user-info</em> tag and sub-tags, where present.
10201033
</p>
10211034

1035+
<p>
1036+
Readers of v2 files and later can parse REML as v5, since all versions of REML up to v5 are backwards compatible.
1037+
</p>
1038+
10221039
</section>
10231040

10241041
</body>

‎Docs/Design/FileFormats/main-db.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -925,7 +925,7 @@ <h2>
925925
<ol>
926926
<li id="footnote-1">
927927
<p>
928-
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>.
928+
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>.
929929
</p>
930930
</li>
931931
<li id="footnote-2">

‎Docs/Design/FileFormats/user-db.html

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -321,9 +321,13 @@ <h3 id="xml-file">
321321
of plain text.
322322
</li>
323323
<li>
324-
<span class="highlight">version 6:</span> Content is formatted text
324+
<span class="highlight">version 6.0 to 6.10:</span> Content is formatted text
325325
encoded in REML markup. REML v4 is supported.
326326
</li>
327+
<li>
328+
<span class="highlight">version 6.11 &amp; later:</span> Content is formatted text
329+
encoded in REML markup. REML v5 is supported.
330+
</li>
327331
</ul>
328332
</dd>
329333

@@ -465,7 +469,10 @@ <h3 id="xml-file">
465469
<span class="highlight">version 4:</span> supports REML v3.
466470
</li>
467471
<li>
468-
<span class="highlight">versions 5 &amp; 6:</span> supports REML v4.
472+
<span class="highlight">versions 5 &amp; 6.10:</span> supports REML v4.
473+
</li>
474+
<li>
475+
<span class="highlight">version 6.11 &amp; later:</span> supports REML v5.
469476
</li>
470477
</ul>
471478
</li>
@@ -1007,6 +1014,12 @@ <h2>
10071014
<dd>
10081015
Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
10091016
</dd>
1017+
<dt>
1018+
<em>Version 6.11 - &laquo;&laquo;TODO&raquo;&raquo;</em>
1019+
</dt>
1020+
<dd>
1021+
Updated with CodeSnip v&laquo;&laquo;TODO&raquo;&raquo; to add support for REML v5, which is backwards compatible with REML v4.
1022+
</dd>
10101023
</dl>
10111024
</dd>
10121025
</dl>
@@ -1064,6 +1077,10 @@ <h3>
10641077
</li>
10651078
</ul>
10661079

1080+
<p>
1081+
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.
1082+
</p>
1083+
10671084
<h3>
10681085
Handling Text File Encodings
10691086
</h3>

0 commit comments

Comments
 (0)