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 7482558

Browse files
Merge branch 'release/4.21.1'
Release v4.21.1
2 parents 02656b8 + d4af4f3 commit 7482558

Some content is hidden

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

46 files changed

+2703
-1196
lines changed

‎.gitignore‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
__history/
1111

1212
# Project specific directories & files
13-
Bin
14-
Exe
15-
Release
13+
_build
1614
Src/CodeSnip.cfg
1715
Src/AutoGen/IntfExternalObj.pas

‎Build.html‎

Lines changed: 62 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -460,8 +460,7 @@ <h3>
460460
|
461461
+-- DUnit - test source code that uses the DUnit framework</pre>
462462
<p>
463-
If, by chance you also have <code>Bin</code>, <code>Exe</code> and / or
464-
<code>Release</code> directories don't worry - all will become clear.
463+
If, by chance you also have a <code>_build</code> directory don't worry - all will become clear.
465464
Git users may also see the usual <code>.git</code> hidden
466465
directory. If you have done some editing in the Delphi IDE you may also see
467466
occasional hidden <code>__history</code> folders.
@@ -498,18 +497,18 @@ <h3>
498497

499498
<pre>./
500499
|
501-
+-- Bin - receives object files for CodeSnip
502-
|
503-
...
504-
|
505-
+-- Exe - receives executable code and compiled help file
506-
|
507-
+-- Release - receives release files
500+
+-- _build - contains all the build files
501+
| |
502+
| +-- bin - receives object files for CodeSnip
503+
| |
504+
| +-- exe - receives executable code and compiled help file
505+
| |
506+
| +-- release - receives release files
508507
|
509508
...</pre>
510509

511510
<p>
512-
If the <code>Bin</code> folder already existed, it will have been emptied.
511+
If the <code>_build/bin</code> folder already existed, it will have been emptied.
513512
In addition, <code>Make</code> will have created a <code>.cfg</code> file from
514513
template in the <code>Src</code> folder. This <code>.cfg</code> file is needed
515514
for DCC32 to run correctly. The file will be ignored by Git.
@@ -625,7 +624,7 @@ <h3>
625624

626625
<p>
627626
The <em>CodeSnip</em> executable, named <code>CodeSnip.exe</code> will be
628-
placed in the <code>Exe</code> folder.
627+
placed in the <code>_build\exe</code> folder.
629628
</p>
630629

631630
<h4>
@@ -640,7 +639,7 @@ <h4>
640639
<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE codesnip</pre>
641640

642641
<p>
643-
Again the executable is placed in the <code>Exe</code> folder, but this time
642+
Again the executable is placed in the <code>_build/exe</code> folder, but this time
644643
it is named <code>CodeSnip-p.exe</code>
645644
</p>
646645

@@ -654,13 +653,16 @@ <h3>
654653

655654
<pre class="cmd"><span class="prompt">&gt;</span> Make help</pre>
656655

656+
<p>
657+
The compiled help file will be written to the <code>_build\exe</code> folder.
658+
</p>
657659
<h3>
658660
Build the Setup Program
659661
</h3>
660662

661663
<p>
662664
The setup program requires that the <em>CodeSnip</em> excutable and the
663-
compiled help file are already present in the <code>Exe</code> directory.
665+
compiled help file are already present in the <code>_build\exe</code> directory.
664666
</p>
665667

666668
<p>
@@ -679,7 +681,7 @@ <h3>
679681
<p>
680682
The setup program is named <code>CodeSnip-Setup-x.x.x.exe</code>, where
681683
x.x.x is the version number extracted from <em>CodeSnip</em>'s version
682-
information. It is placed in the <code>Exe</code> directory.
684+
information. It is placed in the <code>_build/exe</code> directory.
683685
</p>
684686

685687
<p>
@@ -704,6 +706,7 @@ <h3>
704706

705707
<p>
706708
Make can create zip files containing all the files that are included in a release.
709+
Zip files are written to the <code>_build/release</code> directory.
707710
</p>
708711

709712
<h4>
@@ -723,13 +726,17 @@ <h4>
723726
<pre class="cmd"><span class="prompt">&gt;</span> Make release</pre>
724727

725728
<p>
726-
By default the release file is named <code>dd-codesnip.zip</code>. You can
729+
By default the release file is named <code>codesnip-exe.zip</code>. You can
727730
change this name by defining the <code>RELEASEFILENAME</code> macro or
728731
enviroment variable. For example, you can name the file
729732
<code>MyRelease.zip</code> by doing:
730733
</p>
731734

732-
<pre class="cmd"><span class="prompt">&gt;</span> Make -DRELEASEFILENAME=MyRelease.zip release</pre>
735+
<pre class="cmd"><span class="prompt">&gt;</span> Make -DRELEASEFILENAME=MyRelease release</pre>
736+
737+
<p>
738+
Note that the <code>.zip</code> extension should not be included in the file name.
739+
</p>
733740

734741
<h4>
735742
Portable edition
@@ -754,7 +761,11 @@ <h4>
754761
<code>MyPortableRelease.zip</code> by doing:
755762
</p>
756763

757-
<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease.zip release</pre>
764+
<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease release</pre>
765+
766+
<p>
767+
Once again note that the <code>.zip</code> extension should not be included in the file name.
768+
</p>
758769

759770
<p class="note">
760771
<strong>Warning:</strong> If you are building both the standard and portable
@@ -763,6 +774,35 @@ <h4>
763774
built release will overwrite the first.
764775
</p>
765776

777+
<h4>
778+
Including version numbers in zip file names
779+
</h4>
780+
781+
<p>
782+
A version number can be suffixed to the release zip file name by defining the <code>VERSION</code> macro.
783+
This macro works with both the <code>PORTABLE</code> and <code>RELEASEFILENAME</code> macros.
784+
</p>
785+
786+
<p>
787+
For example to appended version number 4.22.0 to the zip file name on a standard edition build, with the default
788+
file name do:
789+
</p>
790+
791+
<pre class="cmd"><span class="prompt">&gt;</span> Make -DVERSION=4.22.0 release</pre>
792+
793+
<p>
794+
This will create a zip file named <code>codesnip-exe-4.22.0.zip</code>.
795+
</p>
796+
797+
<p>
798+
A more complex example would be to append the same version number to a portable edition build named <code>MyPortableRelease</code>. Do:
799+
</p>
800+
801+
<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease -DVERSION=4.22.0 release</pre>
802+
803+
<p>
804+
This time the resulting zip file will be named <code>MyPortableRelease-4.22.0.zip</code>.
805+
</p>
766806

767807
<h3>
768808
Build and Release Everything
@@ -784,16 +824,17 @@ <h3>
784824
<span class="prompt">&gt;</span> Make setup
785825
<span class="prompt">&gt;</span> Make release</pre>
786826

787-
<h4>
788-
Portable edition
789-
</h4>
790-
791827
<p>
792828
To perform a complete build of the portable edition of <em>CodeSnip</em> do
793829
</p>
794830

795831
<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE</pre>
796832

833+
<p>
834+
Note that the <code>RELEASEFILENAME</code> and <code>VERSION</code> macros that can be used for customising
835+
zip file names can be used here too.
836+
</p>
837+
797838
<h3>
798839
Clean Up
799840
</h3>

‎CHANGELOG.md‎

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
11
# Changelog
22

3-
This is the change log for _DelphiDabbler CodeSnip_.
3+
This is the change log for _DelphiDabbler CodeSnip_. It begins with the first ever pre-release version of _CodeSnip_.
44

5-
All notable changes to this project are documented in this file.
6-
7-
This change log begins with the first ever pre-release version of _CodeSnip_. Releases are listed in reverse version number order.
5+
Releases are listed in reverse version number order.
86

97
> Note that _CodeSnip_ v4 was developed in parallel with v3 for a while. As a consequence some v3 releases have later release dates than early v4 releases.
108
11-
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).
9+
## Release v4.21.1 of 09 April 2023
10+
11+
* Completed implementation of support for [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0/Docs/Design/reml.html) (ommitted from v4.20.0 in error) and fixed some bugs in the original implementation [issues #81 and #82], including:
12+
* Heavily revised "active text" handling code and document model to fix support for lists introduced in v4.21.0.
13+
* Added support for rendering lists in plain text reports and generated source code header comments.
14+
* Added support for rendering lists in Rich Text Format for use in printed information and in reports copied to the clipboard.
15+
* Overhauled HTML rendering code that generates HTML for display in the UI.
16+
* Heavily revised parsing and generation of REML code.
17+
* Updated "active text" validation code.
18+
* Prevented snippets editor from stripping REML `<p>` tags [issue #103].
19+
* Fixed garbled copyright symbols in generated source code [issue #80].
20+
* Fixed bug in code that compresses multiple white space into a single space [issue #95].
21+
* Fixed out of range error in code that handles text encodings [issue #97].
22+
* Fixed broken formatting of compiler result tables in text and rich text snippet reports & print outs [issue #101].
23+
* Updated copyright date displayed in about box [issue #98].
24+
* Updated operating system detection code to detect Windows 10/11 builds released in December 2022 and Q1 2023.
25+
* Some refactoring [including issue #83]
26+
* Changed build process to create all files in `_build` directory and to use different zip file names [issue #78].
27+
* Documentation changes:
28+
* Updated `Build.html` to document changes in build process.
29+
* Updated `CHANGELOG.md` to fix broken link [issue #76] and to remove information about semantic versioning.
30+
* Removed broken links in `Docs/License.html`.
31+
* Updated copyright date in various license files [including issue #96].
32+
* Fixed errors and oversights in REML documentation.
33+
* Removed some redundant tests that were failing due to passing invalid parameters to the revised _StrWrap_ routine [issue #79].
1234

1335
## Release v4.21.0 of 16 December 2022
1436

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]:
37+
* 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]:
1638
* Numerous new character entities supported.
1739
* New list tags: `<ol>`, `<ul>` & `<li>`.
1840
* 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].

‎Docs/Design/reml.html‎

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE HTML>
22

33
<!--
4-
* This file copyright (C) 2020-2021, Peter Johnson (gravatar.com/delphidabbler) and
4+
* This file copyright (C) 2020-2023, Peter Johnson (gravatar.com/delphidabbler) and
55
* is licensed under the MIT License: https://opensource.org/licenses/MIT
66
*
77
* DelphiDabbler Code Snippets Database Documentation: REML markup language
@@ -279,19 +279,19 @@ <h2>
279279
</p>
280280
<ul class="half-spaced">
281281
<li>
282-
<code class="value">&lt;p&gt;...&lt;/p&gt;</code> &ndash; Renders the enclosed markup as a simple paragraph.
282+
<code class="value">&lt;p&gt;...&lt;/p&gt;</code> &ndash; Renders the enclosed markup as a simple paragraph.
283283
</li>
284284
<li>
285285
<code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> &ndash; Renders the enclosed markup as a heading.
286286
</li>
287287
<li>
288-
<code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> &ndash; Renders the enclosed HTML as an ordered list. <spanclass="very-strong">Must</span> contain <codeclass="value">&lt;li&gt;...&lt;/li&gt</code> blocks and nothing else.
288+
<code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> &ndash; Renders the enclosed markup as an ordered list.
289289
</li>
290290
<li>
291-
<code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> &ndash; Renders the enclosed HTML as an unordered list. <spanclass="very-strong">Must</span> contain <codeclass="value">&lt;li&gt;...&lt;/li&gt</code> blocks and nothing else.
291+
<code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> &ndash; Renders the enclosed markup as an unordered list.
292292
</li>
293293
<li>
294-
<code class="value">&lt;li&gt;...&lt;/li&gt;</code> &ndash; Renders the enclosed HTML as a list item. <spanclass="very-strong">Must</span> only be used within <codeclass="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <codeclass="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks.
294+
<code class="value">&lt;li&gt;...&lt;/li&gt;</code> &ndash; Renders the enclosed markup as a list item.
295295
</li>
296296
</ul>
297297
<p>
@@ -308,7 +308,7 @@ <h2>
308308
<code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks <span class="very-strong">must only</span> contain one or more <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks.
309309
</li>
310310
<li>
311-
<code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks <span class="very-strong">must not</span> contain <code class="value">&lt;p&gt;...&lt;/p&gt;</code>, <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> or other <code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks directly, but <em>may</em> contain <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks.
311+
<code class="value">&lt;li&gt;...&lt;/li&gt;</code> blocks <span class="very-strong">must</span> only be used within <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> and <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> blocks. <em>May</em> contain <code class="value">&lt;p&gt;...&lt;/p&gt;</code> and <codeclass="value">&lt;heading&gt;...&lt;/heading&gt;</code> blocks, but it is permitted to include text and inline tags directly without enclosing them one of the permitted blocks. Nested lists are permitted by including further <code class="value">&lt;ul&gt;...&lt;/ul&gt;</code> and <code class="value">&lt;ol&gt;...&lt;/ol&gt;</code> blocks.
312312
</li>
313313
<li>
314314
All text <em>should</em> be embedded within <code class="value">&lt;p&gt;...&lt;/p&gt;</code>, <code class="value">&lt;heading&gt;...&lt;/heading&gt;</code> or <code class="value">&lt;li&gt;...&lt;/li&gt;</code> block level tags, e.g. <code class="value">&lt;heading&gt;heading&lt;/heading&gt;&lt;p&gt;text&lt;/p&gt;</code> or simply <code class="value">&lt;p&gt;text&lt;/p&gt;</code>.
@@ -320,20 +320,23 @@ <h2>
320320
<p>
321321
Here is a valid example:
322322
</p>
323-
<pre class="sample">&lt;p&gt;Hello World&lt;/p&gt;
324-
&lt;heading&gt;Hello&lt;/heading&gt;
323+
<pre class="sample">&lt;heading&gt;Hello&lt;/heading&gt;
325324
&lt;p&gt;Hello World&lt;/p&gt;
326325
&lt;ol&gt;
327326
&lt;li&gt;one&lt;/li&gt;
328-
&lt;li&gt;two&lt;/li&gt;
327+
&lt;li&gt;&lt;p&gt;two&lt;/p&gt;&lt;/li&gt;
328+
&lt;ul&gt;
329+
&lt;li&gt;two A&lt;/li&gt;
330+
&lt;li&gt;two B&lt;/li&gt;
331+
&lt;ul&gt;
329332
&lt;li&gt;three&lt;/li&gt;
330333
&lt;/ol&gt;</pre>
331334
<p>
332335
Strictly speaking, the following example is invalid code &ndash; all occurrences of <code class="value">wrong</code> are in error because they are not contained within block tags.
333336
</p>
334337
<pre class="sample">wrong &lt;heading&gt;blah&lt;/heading&gt; wrong &lt;p&gt;blah&lt;/p&gt; wrong</pre>
335338
<p>
336-
However interpreting code <em>may</em> interpret this permissively. If this is done the text outside blocks <spanclass="very-strong">must</span> be interpreted as if it was enclosed in <code class="value">&lt;p&gt;</code> and <code class="value">&lt;/p&gt;</code> tags. Therefore the above code would be interpreted as:
339+
However interpreting code <em>may</em> interpret this permissively. If this is done the text outside blocks <em>should</em> be interpreted as if it was enclosed in <code class="value">&lt;p&gt;</code> and <code class="value">&lt;/p&gt;</code> tags. Therefore the above code would be interpreted as:
337340
</p>
338341
<pre class="sample">&lt;p&gt;wrong &lt;/p&gt;&lt;heading&gt;blah&lt;/heading&gt;&lt;p&gt;wrong &lt;/p&gt;&lt;p&gt;blah&lt;/p&gt;&lt;p&gt;wrong&lt;/p&gt;</pre>
339342
<aside>
@@ -375,13 +378,13 @@ <h2>
375378
</p>
376379
<ul class="unspaced">
377380
<li>
378-
In-line tags <span class="very-strong">must</span> be embedded inside a block level tag. E.g. <code class="value">&lt;p&gt;one&lt;strong&gt;two&lt;/strong&gt;three&lt;/p&gt;</code>.
381+
In-line tags <span class="very-strong">must</span> be embedded inside a valid block level tag. E.g. <code class="value">&lt;p&gt;one&lt;strong&gt;two&lt;/strong&gt;three&lt;/p&gt;</code>.
379382
</li>
380383
<li>
381384
Tags <span class="very-strong">must</span> match. E.g. <code class="value">&lt;em&gt;</code> must be matched with <code class="value">&lt;/em&gt;</code>.
382385
</li>
383386
<li>
384-
Tags may be nested, providing the tags match. E.g. <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/var&gt;&lt;/em&gt;</code> is valid but <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/em&gt;&lt;/var&gt;</code> is not.
387+
Tags may be nested, providing the tags are balanced. E.g. <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/var&gt;&lt;/em&gt;</code> is valid but <code class="value">&lt;em&gt;blah &lt;var&gt;blah&lt;/em&gt;&lt;/var&gt;</code> is not.
385388
</li>
386389
</ul>
387390
<p>

‎Docs/License.html‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
66
* obtain one at https://mozilla.org/MPL/2.0/
77
*
8-
* Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
8+
* Copyright (C) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
99
*
1010
* CodeSnip license.
1111
-->
@@ -225,7 +225,7 @@ <h2>
225225
Executable Program
226226
</h2>
227227
<p>
228-
DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2022 by <a
228+
DelphiDabbler <em>CodeSnip</em> is copyright &copy; 2005-2023 by <a
229229
href="https://gravatar.com/delphidabbler"
230230
>Peter D Johnson</a>.
231231
</p>
@@ -327,7 +327,7 @@ <h2>
327327
<div>
328328
This condition applies to all files in the
329329
<kbd>Src/Res/Img/Branding</kbd> directory, all of which are original
330-
work copyright &copy; 2012-2022 by <a
330+
work copyright &copy; 2012-2023 by <a
331331
href="https://gravatar.com/delphidabbler"
332332
>Peter D Johnson</a>.
333333
</div>
@@ -1615,7 +1615,7 @@ <h2 id="toolbar-icons-mit">
16151615
<p>Toolbar Icons is made available under the terms of the MIT License.
16161616
See <a
16171617
href="https://toolbaricons.sourceforge.net/"
1618-
>http://toolbaricons.sourceforge.net/</a> for more information.</p>
1618+
>https://toolbaricons.sourceforge.net/</a> for more information.</p>
16191619

16201620
<p>Copyright &copy; 2010 Florian Haag</p>
16211621

@@ -1674,12 +1674,10 @@ <h1>
16741674
</div>
16751675
<ul>
16761676
<li>
1677-
Silk Icon Set 1.3 by Mark James: <a
1678-
href="http://www.famfamfam.com/lab/icons/silk/"
1679-
>http://www.famfamfam.com/lab/icons/silk/</a>.
1677+
Silk Icon Set 1.3 by Mark James: <del>http://www.famfamfam.com/lab/icons/silk/</del> [link broken].
16801678
</li>
16811679
<li>
1682-
Silk Companion 1 by Damien Guard: <del>https://www.damieng.com/icons/silkcompanion</del> [link broken]
1680+
Silk Companion 1 by Damien Guard: <del>https://www.damieng.com/icons/silkcompanion</del> [link broken].
16831681
</li>
16841682
<li>
16851683
Led Icon Set v1.0: <del>http://led24.de/iconset/</del> [link broken].
@@ -1714,7 +1712,7 @@ <h1>
17141712
<li>
17151713
Some program icons are based on Florian Haag's Toolbar Icons set at <a
17161714
href="https://toolbaricons.sourceforge.net/"
1717-
>http://toolbaricons.sourceforge.net/</a>.
1715+
>https://toolbaricons.sourceforge.net/</a>.
17181716
</li>
17191717
<li>
17201718
Some images used in the program's Easter Egg are based on public domain

0 commit comments

Comments
(0)

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