Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 02656b8

Browse files
Merge branch 'release/4.21.0'
2 parents 93bc8df + 9703052 commit 02656b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+2757
-800
lines changed

‎Build.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
77
* obtain one at https://mozilla.org/MPL/2.0/
88
*
9-
* Copyright (C) 2009-2021, Peter Johnson (gravatar.com/delphidabbler).
9+
* Copyright (C) 2009-2022, Peter Johnson (gravatar.com/delphidabbler).
1010
*
1111
* Instructions for building CodeSnip from source.
1212
-->
@@ -191,10 +191,10 @@ <h3>
191191
</h3>
192192

193193
<p>
194-
This tool is used to compile version information (<code>.vi</code>) files
195-
into intermediate resource source (<code>.rc</code>) files. Version 2.11.2
196-
or later is required.
197-
Version Information Editor can be obtained from
194+
This tool is used to compile version information (<code>.vi</code>) files and
195+
any associated macro file(s) into intermediate resource source
196+
(<code>.rc</code>) files. Version 2.14.0 or later is required. Version
197+
Information Editor can be obtained from
198198
<a
199199
href="https://github.com/delphidabbler/vied/releases"
200200
>https://github.com/delphidabbler/vied/releases</a>.

‎CHANGELOG.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,26 @@ This change log begins with the first ever pre-release version of _CodeSnip_. Re
1010
1111
From v4.1.0 the version numbering has attempted to adhere to the principles of [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
1212

13+
## Release v4.21.0 of 16 December 2022
14+
15+
* Updated to support [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0`/Docs/Design/reml.html) in snippet description & extra information [issue #71]:
16+
* Numerous new character entities supported.
17+
* New list tags: `<ol>`, `<ul>` & `<li>`.
18+
* Program now automatically detects new (supported) Delphi installations at startup and offers to register the compiler(s) to be used for test compiling snippets. This feature is on by default but can be turned off completely or for specifically excluded compilers [issue #19].
19+
* Modified Configure Compilers dialogue box:
20+
* Added facility to customise automatic compiler detection on per-compiler or global basis.
21+
* Changed manually triggered compiler detection to ignore excluded compilers.
22+
* Some refactoring [including issues #73 and #75].
23+
* Minor changes to program license
24+
* Changed required image attribution in `Docs/License.html` [issue #63]
25+
* Corrected copyright date & fix typo in licenses displayed by installer and help file [issue #65 & PR #72].
26+
* Bump per-user config file to version 19.
27+
* Documentation updates:
28+
* Updated `README.md` re abandoned and new Git repo branches.
29+
* Updated config file, database, export file & REML documentation re changes in this release [including issue #74].
30+
* Help file updated with details of changes in this release.
31+
* Updated development tool chain requirements in `Build.html`.
32+
1333
## Release v4.20.2 of 04 November 2022
1434

1535
* Fixes bug where an exception was raised when selecting a main menu item with the cursor keys then pressing F1. [issue 54]

‎Docs/Design/FileFormats/config.html‎

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ <h3>
167167
</p>
168168

169169
<p>
170-
There have been several versions of this file. The current one is version 18. The change to version 18 came with CodeSnip v4.20.0 and the addition of the [Prefs] section.
170+
There have been several versions of this file. The current one is version 19. The change to version 19 came with CodeSnip v4.21.0 and the addition of the [Compilers] section and the <codeclass="key">CanAutoInstall</code> key in the [Cmp:XXX] sections.
171171
</p>
172172

173173
<p>
@@ -333,8 +333,49 @@ <h4>
333333
Each entry contains a fully specified directory path.
334334
</div>
335335
</dd>
336+
<dt>
337+
<code class="key">CanAutoInstall</code> (Boolean)
338+
</dt>
339+
<dd>
340+
<div class="half-spaced">
341+
Determines whether the compiler can be automatically detected and registered by CodeSnip.
342+
</div>
343+
<div class="half-spaced">
344+
Applies to Delphi compilers only, not to Free Pascal.
345+
</div>
346+
</dd>
347+
</dl>
348+
349+
<h4>
350+
[Compilers] section
351+
</h4>
352+
353+
<p>
354+
This section records configuration information that applies to all, or
355+
multiple, compilers.
356+
</p>
357+
358+
<p>
359+
Name / Value pairs:
360+
</p>
361+
362+
<dl class="indent">
363+
<dt>
364+
<code class="key">PermitStartupDetection</code> (Boolean)
365+
</dt>
366+
<dd>
367+
<div class="half-spaced">
368+
Determines whether CodeSnip should detect, and potentially register, any
369+
Delphi compilers that are installed on the user's system but not
370+
registered with the program.
371+
</div>
372+
<div class="half-spaced">
373+
Does not apply to the Free Pascal compiler.
374+
</div>
375+
</dd>
336376
</dl>
337377

378+
338379
<h4>
339380
[Database] section
340381
</h4>
@@ -721,7 +762,7 @@ <h4>
721762
The version number of the config file. Incremented whenever the file format changes. If this section or this value is missing then the default value is <code class="value">1</code>.
722763
</div>
723764
<div class="half-spaced">
724-
The current value is <code class="value">16</code>.
765+
The current value is <code class="value">19</code>.
725766
</div>
726767
</dd>
727768
<dt>

‎Docs/Design/FileFormats/export.html‎

Lines changed: 34 additions & 17 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>
@@ -175,8 +175,8 @@ <h2>
175175
<em>version</em>
176176
</dt>
177177
<dd>
178-
Identifies version of file. Determines which tags are valid and
179-
establishes rules concerning content. Valid versions are 1..7.
178+
Identifies major version of file. Determines which tags are valid and
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 - 16 December 2022</em>
983+
</dt>
984+
<dd>
985+
Updated with CodeSnip v4.21.0 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: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h3 id="xml-file">
199199
<em>version</em>
200200
</dt>
201201
<dd>
202-
Identifies version of file. Determines which tags are valid and rules
202+
Identifies major version of file. Determines which tags are valid and rules
203203
concerning content. Valid versions are 1..6.
204204
</dd>
205205
</dl>
@@ -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 - 16 December 2022</em>
1019+
</dt>
1020+
<dd>
1021+
Updated with CodeSnip v4.21.0 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)

AltStyle によって変換されたページ (->オリジナル) /