|
58 | 58 | </p> |
59 | 59 |
|
60 | 60 | <p> |
61 | | - The source code for each snippet is stored in separate sequentially numbered |
62 | | - .dat data files – 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 – one per snippet. Each source code file is referenced by the XML file. |
64 | 62 | </p> |
65 | 63 |
|
66 | 64 | <p> |
|
86 | 84 | </p> |
87 | 85 |
|
88 | 86 | <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 |
90 | 88 | inherit a copy of a user database in an earlier format. |
91 | 89 | </p> |
92 | 90 |
|
|
283 | 281 | </li> |
284 | 282 | <li> |
285 | 283 | <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. |
287 | 285 | </li> |
288 | 286 | </ul> |
289 | 287 | </dd> |
@@ -423,7 +421,10 @@ <h3> |
423 | 421 | <span class="highlight">version 3:</span> indicates REML v2 |
424 | 422 | </li> |
425 | 423 | <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. |
427 | 428 | </li> |
428 | 429 | </ul> |
429 | 430 | </li> |
|
673 | 674 |
|
674 | 675 | <p> |
675 | 676 | 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>. |
678 | 679 | </p> |
679 | 680 |
|
680 | 681 | <p> |
@@ -789,7 +790,10 @@ <h2> |
789 | 790 | Previously the description was plain text. |
790 | 791 | </div> |
791 | 792 | <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: |
793 | 797 | </div> |
794 | 798 | <ul class="squashed"> |
795 | 799 | <li> |
|
810 | 814 | Readers of version 1 files must convert the contents of the |
811 | 815 | <em>codesnip-data/routines/routine/comments</em>, |
812 | 816 | <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 |
814 | 818 | that simulates the parsed content of the |
815 | 819 | <em>codesnip-data/routines/routine/extra</em> tag. |
816 | 820 | </p> |
|
828 | 832 | <ol> |
829 | 833 | <li> |
830 | 834 | 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 |
832 | 836 | equivalent of a single paragraph containing the description. |
833 | 837 | </li> |
834 | 838 | <li> |
|
0 commit comments