Skip to content

Commit dd17a64

Browse files
committedJul 13, 2023
Merge branch 'release/4.21.2'
Release v4.21.2
2 parents 7482558 + ea20cb9 commit dd17a64

29 files changed

+771
-388
lines changed
 

‎Build.html

+117-47
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-2022, Peter Johnson (gravatar.com/delphidabbler).
9+
* Copyright (C) 2009-2023, Peter Johnson (gravatar.com/delphidabbler).
1010
*
1111
* Instructions for building CodeSnip from source.
1212
-->
@@ -21,6 +21,9 @@
2121
body {
2222
font-family: sans-serif;
2323
}
24+
code, pre {
25+
font-size: 1rem;
26+
}
2427
dt.spaced {
2528
margin-top: 0.5em;
2629
}
@@ -157,7 +160,7 @@ <h3>
157160
</dt>
158161
<dd>
159162
Type library importer tool. Used to create a Pascal unit that describes
160-
code contained in <code>ExternalObj.idl</code>.
163+
code contained in <code>ExternalObj.ridl</code>.
161164
</dd>
162165
</dl>
163166

@@ -193,7 +196,7 @@ <h3>
193196
<p>
194197
This tool is used to compile version information (<code>.vi</code>) files and
195198
any associated macro file(s) into intermediate resource source
196-
(<code>.rc</code>) files. Version 2.14.0 or later is required. Version
199+
(<code>.rc</code>) files. Version 2.15.0 or later is required. Version
197200
Information Editor can be obtained from
198201
<a
199202
href="https://github.com/delphidabbler/vied/releases"
@@ -376,30 +379,34 @@ <h3>
376379
</h3>
377380

378381
<p>
379-
The source code is maintained in the <code><a href="https://github.com/delphidabbler/codesnip">delphidabbler/codesnip</a></code> Git respository on GitHub.
382+
The source code is maintained in the <code><a href="https://github.com/delphidabbler/codesnip">delphidabbler/codesnip</a></code> Git respository on GitHub. Source code can be obtained in three ways:
380383
</p>
381384

382-
<p>
383-
If you are intending to contribute code to the project you need to:
384-
</p>
385-
386-
<ol class="spaced">
387-
<li>
388-
Fork the project on GitHub.
389-
</li>
385+
<ol>
390386
<li>
391-
Create a new branch off the <code>development</code> branch.
387+
<p>
388+
Fork the project from GitHub and then clone your forked repository.
389+
</p>
392390
</li>
393391
<li>
394-
Make your changes on the branch you created.
392+
<p>
393+
Clone the existing repository using:
394+
</p>
395+
<pre class="cmd"><span class="prompt">&gt;</span> git clone https://github.com/delphidabbler/codesnip.git</pre>
395396
</li>
396397
<li>
397-
Once finished raise a pull request for your code on the <code>delphidabbler/codesnip</code> repo.
398+
<p>
399+
Download the source of a specific release from the project's <a href="https://github.com/delphidabbler/codesnip/releases">Releases</a> section on GitHub &ndash; just choose the version you want.
400+
</p>
398401
</li>
399402
</ol>
400403

401404
<p>
402-
If you only intend to use the code for your own purposes you can still fork the repository as above. Alternatively you can download the source code from the project's <a href="https://github.com/delphidabbler/codesnip/releases">Releases</a> section on GitHub &ndash; just choose the version you want.
405+
If you are intending to contribute code to the project please read the most up to date version of the project's <a href="https://github.com/delphidabbler/codesnip/blob/develop/README.md">read-me file</a> before doing so.
406+
</p>
407+
408+
<p class="note">
409+
<strong>Important:</strong> If you are planning to fork <em>CodeSnip</em> and to develop and release your own application derived from the CodeSnip code base then some changes to the code are required under the terms of the <em>CodeSnip</em> license. See the <a href="#conditions">Conditions For Release of Modified Code</a> section below for details.
403410
</p>
404411

405412
<h3>
@@ -412,53 +419,55 @@ <h3>
412419

413420
<pre>./
414421
|
415-
+-- Docs - documentation
422+
+-- Docs - documentation
416423
| |
417-
| +-- Design - documents concerning program design
424+
| +-- Design - documents concerning program design
418425
| |
419-
| +-- FileFormats - documentation of CodeSnip's file formats
426+
| +-- FileFormats - documentation of CodeSnip's file formats
420427
|
421-
+-- Src - main CodeSnip source code
428+
+-- Src - main CodeSnip source code
422429
| |
423-
| +-- 3rdParty - third party &amp; DelphiDabbler library source code
430+
| +-- 3rdParty - third party &amp; DelphiDabbler library source code
424431
| |
425-
| +-- AutoGen - receives automatically generated code
432+
| +-- AutoGen - receives automatically generated code
426433
| |
427-
| +-- Help - help source files
434+
| +-- Help - help source files
428435
| | |
429-
| | +-- CSS - CSS code for help files
436+
| | +-- CSS - CSS code for help files
430437
| | |
431-
| | +-- HTML - HTML files included in help file
438+
| | +-- HTML - HTML files included in help file
432439
| | |
433-
| | +-- Images - images included in help file
440+
| | +-- Images - images included in help file
434441
| |
435-
| +-- Install - setup script and support code
442+
| +-- Install - setup script and support code
436443
| | |
437-
| | +-- Assets - files required for inclusion in install program
444+
| | +-- Assets - files required for inclusion in install program
438445
| |
439-
| +-- Res - container for files that are embedded in resources
446+
| +-- Res - container for files that are embedded in resources
440447
| |
441-
| +-- CSS - CSS files
448+
| +-- CSS - CSS files
442449
| |
443-
| +-- HTML - HTML files
450+
| +-- HTML - HTML files
444451
| |
445-
| +-- Img - image files
452+
| +-- Img - image files
453+
| | |
454+
| | +-- AltBranding - image files used for 3rd party branding
446455
| | |
447-
| | +-- Branding - image files used for CodeSnip branding
456+
| | +-- Branding - image files used for CodeSnip branding only
448457
| | |
449-
| | +-- Egg - image files for 'Easter Egg'
458+
| | +-- Egg - image files for 'Easter Egg'
450459
| |
451-
| +-- Misc - other resources
460+
| +-- Misc - other resources
452461
| |
453-
| +-- Scripts - scripting files
462+
| +-- Scripts - scripting files
454463
| |
455-
| +-- 3rdParty - 3rd party scripting files
464+
| +-- 3rdParty - 3rd party scripting files
456465
|
457-
+-- Tests - contains test code
466+
+-- Tests - contains test code
458467
|
459-
+-- Src - test source code
468+
+-- Src - test source code
460469
|
461-
+-- DUnit - test source code that uses the DUnit framework</pre>
470+
+-- DUnit - test source code that uses the DUnit framework</pre>
462471
<p>
463472
If, by chance you also have a <code>_build</code> directory don't worry - all will become clear.
464473
Git users may also see the usual <code>.git</code> hidden
@@ -497,13 +506,13 @@ <h3>
497506

498507
<pre>./
499508
|
500-
+-- _build - contains all the build files
509+
+-- _build - contains all the build files
501510
| |
502-
| +-- bin - receives object files for CodeSnip
511+
| +-- bin - receives object files for CodeSnip
503512
| |
504-
| +-- exe - receives executable code and compiled help file
513+
| +-- exe - receives executable code and compiled help file
505514
| |
506-
| +-- release - receives release files
515+
| +-- release - receives release files
507516
|
508517
...</pre>
509518

@@ -861,22 +870,22 @@ <h2>
861870
</p>
862871

863872
<p>
864-
To compile the tests, open the <code>.\Src\CodeSnip.groupproj</code> group
873+
To compile the tests, open the <code>Src\CodeSnip.groupproj</code> group
865874
project file in the Delphi XE IDE. Now select the <em>CodeSnipTests.exe</em>
866875
target in the project manager and compile.
867876
</p>
868877

869878
<p>
870879
If they were not already present <code>Bin</code> and <code>Exe</code>
871-
sub-directories will have been created in the <code>.\Tests</code> directory.
880+
sub-directories will have been created in the <code>Tests</code> directory.
872881
The <code>Exe</code> directory contains the <em>DUnit</em> test program while
873882
<code>Bin</code> contains intermediate binaries.
874883
</p>
875884

876885
<p>
877886
You can compile the tests as either a GUI application (default) or as a
878887
console application. For details please see the comments in
879-
<code>.\Tests\Src\DUnit\CodeSnipTests.dpr</code>.
888+
<code>Tests\Src\DUnit\CodeSnipTests.dpr</code>.
880889
</p>
881890

882891
<h2>
@@ -893,6 +902,67 @@ <h2>
893902
directory.
894903
</p>
895904

905+
<h2 id="conditions">
906+
Conditions For Release of Modified Code
907+
</h2>
908+
909+
<p>
910+
If you are intending to release your own application based on the <em>CodeSnip</em> source code you <strong>must</strong> <em>either</em> change the source code as described below <em>or</em> seek written permission to use the DelphiDabbler CodeSnip branding. To seek such permission please use the <em>CodeSnip</em> <a href="https://github.com/delphidabbler/codesnip/issues">Issue Tracker</a> on GitHub.
911+
</p>
912+
913+
<h3>
914+
Required Changes
915+
</h3>
916+
917+
<p>
918+
The changes are required to remove DelphiDabbler CodeSnip copyrighted branding from the program, to prevent interference with existing CodeSnip installations and to remove any implied endorsement of the modified release. You <strong>must</strong>:
919+
</p>
920+
921+
<ol>
922+
<li>
923+
<p>
924+
Replace the files in the <code>Src\Res\Img\Branding</code> directory with copies of the identically named placeholder files in the <code>Src\Res\Img\AltBranding</code> directory. The placeholder files are Public Domain, so you may use them as-is, edit them or replace them. If you delete the files in <code>Src\Res\Img\Branding</code> without copying the placeholder files across then <em>CodeSnip</em> will fail to build.
925+
</p>
926+
</li>
927+
<li>
928+
<p>
929+
Replace all relevant references, in source code and documentation, to the names &quot;CodeSnip&quot; and &quot;DelphiDabbler&quot; with your own company and program name. Relevant occurences are:
930+
</p>
931+
<ul>
932+
<li>
933+
Wherever the names may be displayed in the GUI.
934+
</li>
935+
<li>
936+
Wherever the names may be displayed by the installer.
937+
</li>
938+
<li>
939+
Wherever the names occur in directory names. In particular do not use the names in the program's <code>%ProgramData%</code> and <code>%AppData%</code> sub-directories.
940+
</li>
941+
<li>
942+
Anywhere else that use of the names could imply endorsement of the modified code.
943+
</li>
944+
</ul>
945+
</li>
946+
<li>
947+
<p>
948+
Provide your own license file with content compatible with the requirements of the <em>CodeSnip</em> license as it relates to the code reused from the <em>CodeSnip</em> source tree. <strong>Do not</strong> edit or re-use <code>Docs/License.html</code>.
949+
</p>
950+
</li>
951+
<li>
952+
<p>
953+
Modify source code and documentation where necessary to acknowledge the origins of the program's source code, documentation and images, in accordance with the <em>CodeSnip</em> license.
954+
</p>
955+
</li>
956+
</ol>
957+
958+
<p>
959+
Note that the <em>CodeSnip</em> license can be found in <code>Docs\License.html</code>.
960+
</p>
961+
962+
<p>
963+
If you are unsure about whether your changes meet the license requirements then you can seek clarification by creating an issue on the aforementioned <a href="https://github.com/delphidabbler/codesnip/issues">Issue Tracker</a>.
964+
</p>
965+
896966
</body>
897967

898968
</html>

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ Releases are listed in reverse version number order.
66

77
> 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.
88
9+
## Release v4.21.2 of 13 July 2023
10+
11+
* Removed broken links and fixed unsafe links in the About box [issue #105].
12+
* Fixed bug in version information files that resulted in an error in the Comments section of the version information of both editions of _CodeSnip_ [issue 106].
13+
* Fixed potential XSS vulnerability in JQuery code used in Easter egg [issue #107].
14+
* Documentation changes:
15+
* Rationalised, corrected, updated and clarified licensing information. These changes affected many documentation files. [issue #108].
16+
* Overhauled `README.md` and `Docs/ReadMe.txt` and created a new `CONTRIBUTING.md` file that explains how to contribute in detail [issue #104].
17+
918
## Release v4.21.1 of 09 April 2023
1019

1120
* 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:

‎CONTRIBUTING.md

+195
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# Contributing
2+
3+
Thanks for you interest in contributing to the CodeSnip project.
4+
5+
## Contents
6+
7+
* [Overview](#overview)
8+
* [Issues](#issues)
9+
* [Documentation](#documentation)
10+
* [Coding](#coding)
11+
* [About Pull Requests](#about-pull-requests)
12+
* [Licensing of Contributions](#licensing-of-contributions)
13+
* [Code of Conduct](#code-of-conduct)
14+
* [Attributions](#attributions)
15+
16+
## Overview
17+
18+
Contributions of all kinds are more than welcome.
19+
20+
> 💡 You will need a GitHub account to be able to make contributions. [Sign up here](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account).
21+
22+
There three main ways in which you can contribute, each of which is explained in its own section below. From easiest to hardest, they are:
23+
24+
* [Issues](#issues) - report bugs and request new features.
25+
* [Documentation](#documentation) - improve the project's documentation.
26+
* [Coding](#coding) - modify the project's source code.
27+
28+
Regardless of how you choose to contribute, please respect the project's [code of conduct](#code-of-conduct).
29+
30+
## Issues
31+
32+
The easiest way to make a contribution is to [create an issue](https://github.com/delphidabbler/codesnip/issues/new).
33+
34+
You can use issues to:
35+
36+
1. [Report a bug](#reporting-a-bug)
37+
2. [Request a new program feature](#requesting-a-new-feature)
38+
3. [Suggest changes to documentation](#suggesting-documentation-changes)
39+
40+
It is helpful if you perform a cursory search of [existing issues](https://github.com/delphidabbler/codesnip/issues?q=is%3Aissue) to see if there is already a similar issue. If so then please add your thoughts as comments on that issue rather than open a new one.
41+
42+
### Reporting a bug
43+
44+
Before reporting a bug please make sure the bug exists in the [latest release](https://github.com/delphidabbler/codesnip/releases) of CodeSnip 4.
45+
46+
To report a bug please provide as much information about the bug as possible, including the program's version number, what happened, what you expected to happen and what you were doing at the time. If possible, explain how to reproduce the bug.
47+
48+
> 💡 You can find CodeSnip's version number in the program's About box (_Help | About_ menu option).
49+
50+
If you have resolved an issue yourself please consider contributing your fix so that others can benefit from your work. Please read the [Coding](#coding) section before doing so.
51+
52+
### Requesting a new feature
53+
54+
If you think of a feature that you would like to see added to CodeSnip you can open an issue to request it.
55+
56+
Please be as clear as possible about what you expect the feature to do and why you want it.
57+
58+
Ideas about how to implement the feature are welcome. Even better, if you have implemented the feature yourself, you may be able to contribute the code. But please read the [Coding](#coding) section before doing so.
59+
60+
### Suggesting documentation changes
61+
62+
The third reason to create an issue is if you want to suggest new documentation or ammendments to existing documentation.
63+
64+
There are two types of documentation within the CodeSnip repository. Firstly, there is general documentation that can be found in the [repository root](https://github.com/delphidabbler/codesnip/tree/develop) and in the [`Docs`](https://github.com/delphidabbler/codesnip/tree/develop/Docs) directory. Secondly, there are numerous HTML help files in the [`Src/Help/HTML`](https://github.com/delphidabbler/codesnip/tree/develop/Src/Help/HTML) directory.
65+
66+
If you have written or corrected some documentation yourself please consider submitting it. See the [Documentation](#documentation) section below to find out how to do this.
67+
68+
## Documentation
69+
70+
Writing and editing documentation is a relatively easy way to start contributing. Providing simple clear or helpful documentation for users is critical. Things that *you* found hard to understand as a user, or difficult to work out, are excellent places to begin.
71+
72+
There are two ways to contribute documentation. The preferred method is by means of a [pull request](#about-pull-requests). But, you can simply create an issue and attach documentation files to the issue comments. This approach is perfectly acceptable for a small number of files, and saves you having to install Git!
73+
74+
## Coding
75+
76+
Code contributions to the [CodeSnip 4 development tree](https://github.com/delphidabbler/codesnip/tree/develop) are always welcome, from fixing bugs to developing new features.
77+
78+
> 🐘 Before going any further, let's address the elephant in the room. CodeSnip has to be compiled with the now rather ancient Delphi XE. It would be much better if development could move to a more recent version of Delphi, but that's proving to be extremely problematic. See [this FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-11) for an explanation.
79+
80+
If you're still here, you will need to set up a valid build environment in order to compile CodeSnip from source. [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/develop/Build.html) tells you everything you need to know about configuring the environment, the tools you will need, and how compile CodeSnip using the provided `Makefile`.
81+
82+
> 💡 Need ideas? You can [browse open issues](https://github.com/delphidabbler/codesnip/issues) and see if you can help with any of them.
83+
84+
Contributions should normally be made using [pull requests](#about-pull-requests).
85+
86+
But, if you have just a few lines of code to suggest it _may_ be possible to accept the code within (or attached to) a comment on an issue. If in doubt, ask first by means of a comment. When including the code in a comment, please use [GitHub code fencing](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to format the code and make it easier to read. For example:
87+
88+
```pascal
89+
procedure TFoo.CoolNewMethod;
90+
begin
91+
// cool code here
92+
end;
93+
```
94+
95+
## About Pull Requests
96+
97+
All pull requests *must* relate to an [open _accepted_ issue](https://github.com/delphidabbler/codesnip/issues?q=is%3Aissue+label%3Aaccepted++is%3Aopen+) on GitHub.
98+
99+
If you wish to contribute code for which there is no existing issue you can create one. Please wait for the issue to be accepted by the project owner before submitting your pull request. Acceptance is indicated by attaching an "accepted" label to the issue and is signed off by means of a comment on the issue from the project owner.
100+
101+
> 💡 Should you get stuck at any point please ask for help by leaving a comment on the relevant issue.
102+
103+
Before you can start you need to get the source code. Here's how:
104+
105+
1. Fork the CodeSnip project into your own GitHub repository.
106+
107+
***Important***_Ensure that all remote branches are included in the fork_, not just `master`. On GitHub this means clearing the "Copy the `master` branch only" check box before creating the fork.
108+
109+
2. Clone the forked repository onto your own system using:
110+
111+
$ git clone https://github.com/<account>/codesnip.git
112+
113+
where `<account>` is your GitHub user account ID.
114+
115+
CodeSnip uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology. This means that you need to create your source code on a "feature" branch off the `develop` branch. Here's how:
116+
117+
1. Pull the `develop` branch from your forked repository, and switch into it:
118+
119+
$ git pull origin develop
120+
$ git switch develop
121+
122+
2. Create and switch to a new feature branch, branched off `develop`.
123+
124+
Name the branch `feature/` followed by the issue number to which it relates. Appending a hyphen followed by a brief description is useful too. Example branch names are `feature/42-fix-ui-bug` or `feature/56`:
125+
126+
$ git branch feature/42-fix-ui-bug
127+
$ git switch feature/42-fix-ui-bug
128+
129+
3. Make your changes, whether to source code or documentation, and commit them to your feature branch. Clarity is prefered to terseness in commit messages. Please don't squash logically unrelated commits.
130+
131+
4. If you are editing source code you need to ensure that it compiles and works as expected.
132+
133+
> 💡 Having trouble? Please make sure you have read [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/develop/Build.html). If that doesn't solve your problem then ask for help by creating a comment on the relevant issue.
134+
135+
Once you have finished writing the code and are ready to submit it you need to prepare your forked repository:
136+
137+
1. Use GitHub to ensure that the `develop` branch of your fork is up to date with the parent `delphidabbler/codesnip` repository's `develop` branch.
138+
139+
2. Rebase your changes onto your forked repository's remote `develop` branch:
140+
141+
$ git rebase origin/develop feature/42-fix-ui-bug
142+
143+
3. Resolve any conflicts arising from the rebase then push your changes to your forked repository:
144+
145+
$ git push origin feature/42-fix-ui-bug
146+
147+
You are finally ready to open that pull request. Proceed as follows:
148+
149+
1. Open your forked repository on GitHub. You should see a banner saying something like "feature/42-fix-ui-bug had recent pushes ..." along with a button that says "Compare and Pull Request". Click that button.
150+
151+
2. You will be taken the "Comparing Changes" page on `delphidabbler/codesnip`.
152+
153+
***Important***⭐ Just below the page title is a line of drop-down buttons where you choose what to compare. Check the caption of the 2nd button from the left. If it reads anything other than "base: `develop`" (and it probably doesn't) then click the button and select `develop` from the list of branches that is displayed.
154+
155+
> ⚠️ Pull requests based on `master`, or any branch other than `develop`, will not be accepted.
156+
157+
3. Now complete the form and click the "Create Pull Request" button.
158+
159+
That's it.
160+
161+
Sit back and wait. Either your pull request will be accepted or you will receive comments requesting clarification or changes.
162+
163+
Once your pull request is accepted you can delete the feature branch from both your local and forked remote fork.
164+
165+
## Licensing of Contributions
166+
167+
The license that applies to any existing file you edit will continue to apply to the edited file. Any existing license text or copyright statement **must not** be altered or removed, but you can add your own copyright line if desired.
168+
169+
Any new file you contribute **must** either be licensed under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/) (MPL2) or have a license compatible with the MPL2. If a license is not specified then MPL2 will be assumed and will be applied to the file. You should insert a suitable copyright statement in the file.
170+
171+
Any third party code used by your contributed code **must** also have a license compatible with the MPL2.
172+
173+
> 💡 MPL2 boilerplate text, in several programming language's comment formats, can be found in the file [`Docs/MPL-2.0-Boilerplate.txt`](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/MPL-2.0-Boilerplate.txt). You will need to change the name of the copyright holder.
174+
175+
## Code of Conduct
176+
177+
This is a simple and straightforward code of conduct. What it boils down to is that if you're a decent person you're more than welcome here. Hateful, abusive and just plain rude people are not.
178+
179+
To be more precise, anyone who contributes to the CodeSnip project is expected to display respect, empathy and politeness towards others.
180+
181+
Certain behaviours will not be tolerated, and will result in an immediate ban. They are:
182+
183+
* Racism and hate speech in any form.
184+
* The use of sexualized language or imagery, and sexual attention or advances of any kind.
185+
* Intolerance towards people of any religion or none.
186+
* Trolling, insulting or derogatory comments, and personal or political attacks.
187+
* Public or private harassment.
188+
* Publishing others' private information, such as a physical or email address, without their explicit permission.
189+
* Other conduct which could reasonably be considered inappropriate in a professional setting.
190+
191+
## Attributions
192+
193+
1. The list of unacceptable behaviours in the Code of Conduct was taken, in part, from the "Our Standards" section of the [Contributor Covenant Code of Conduct v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
194+
195+
2. Some of the content of this document was inspired by and/or copied from the [Stumpy Contributing Guide](https://stumpy.readthedocs.io/en/latest/Contribute.html).

‎Docs/LICENSE

-9
This file was deleted.

‎Docs/License.html

+282-120
Large diffs are not rendered by default.

‎Docs/ReadMe.txt

+32-30
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,15 @@ Installation
4848
================================================================================
4949

5050
CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer 6
51-
or later, but IE 8, 9 or 10 are strongly recommended.
51+
or later, although IE 8, 9 or 10 are strongly recommended. But note that recent
52+
releases have only been tested on Windows 10/11.
5253

5354
Installing the Standard Edition
5455
-------------------------------
5556

5657
You will need administrator privileges to run the setup program for the standard
5758
edition. If you are using a non-admin user account on Windows 2000 or XP you
58-
should run setup as administrator. By default Windows Vista to Windows 10 will
59+
should run setup as administrator. By default Windows Vista to Windows 11 will
5960
require an admin password if running as a standard user and setup will attempt
6061
to elevate the process. If UAC prompts are disabled you must run setup as
6162
administrator.
@@ -66,8 +67,8 @@ usual way. Uninstalling v3 or earlier after installing v4 will have no adverse
6667
affect on v4.
6768

6869
CodeSnip's installation program is named codesnip-setup-4.x.x.exe, where x.x
69-
is the program's minor version number. The install program may be distributed in
70-
a zip file.
70+
is the program's minor version number. The install program is distributed in a
71+
zip file.
7172

7273
Close any running instance of CodeSnip, run the install program then follow the
7374
on-screen instructions.
@@ -80,9 +81,9 @@ The installer makes the following changes to your system:
8081
+ Files required by the uninstaller are stored in the main installation's Uninst
8182
sub-folder.
8283

83-
+ The program's uninstall information is registered with the "Apps and Features"
84-
(a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") control panel
85-
applet.
84+
+ The program's uninstall information is registered with the "Installed App"
85+
(a.k.a. "Apps and Features", a.k.a. "Programs and Features", a.k.a. "Add /
86+
Remove Programs") control panel app.
8687

8788
+ A program group may be created in the start menu (optional).
8889

@@ -113,9 +114,10 @@ the program executable, the help file and various documentation files.
113114

114115
Install the program using the following steps:
115116

116-
1) Mount the storage medium on which you want to install CodeSnip.
117+
1) Mount any storage medium on which you want to install CodeSnip.
117118

118-
2) Create a folder on the storage medium in which to copy the required files.
119+
2) Create a folder on the storage medium or on your computer's internal disk in
120+
which to copy the required files.
119121

120122
3) Copy the files CodeSnip-p.exe (the executable program) and CodeSnip.chm
121123
(the help file) into the folder you created.
@@ -143,12 +145,13 @@ Uninstallation
143145
Uninstalling the Standard Edition
144146
---------------------------------
145147

146-
CodeSnip can be uninstalled via "Apps and Features" (a.k.a. "Programs and
147-
Features", a.k.a. "Add / Remove Programs") from the Windows Control Panel or by
148-
choosing "Uninstall DelphiDabbler CodeSnip" from the program's start menu group.
148+
CodeSnip can be uninstalled via "Installed Apps" (a.k.a. "Apps and Features",
149+
a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") accessed from the
150+
Windows Control Panel or by choosing "Uninstall DelphiDabbler CodeSnip" from the
151+
program's start menu group.
149152

150153
Administrator privileges will be required to uninstall CodeSnip. Windows Vista
151-
to Windows 10 with UAC prompts enabled will prompt for an admin password if
154+
to Windows 11 with UAC prompts enabled will prompt for an admin password if
152155
necessary.
153156

154157
The uninstall program will delete any local copy of the online Code Snippets
@@ -205,12 +208,15 @@ Windows 32 version of Delphi (from Delphi 2 to Delphi 11.x Alexandria) and
205208
FreePascal, providing some simple rules are followed.
206209

207210
When CodeSnip is first installed it knows nothing about the available compilers
208-
and so test compilations cannot be performed. You must tell CodeSnip about the
209-
available compilers by using the "Tools | Configure Compilers" menu option. The
210-
resulting dialogue can automatically detect all installed versions of supported
211-
Delphi compilers at the click of a button. Free Pascal, where installed, must be
212-
set up manually. The Welcome page displays a list of compilers it has been
213-
configured to work with.
211+
and so test compilations cannot be performed. If any supported Delphi compiler
212+
is detected when the program is first run you will be given the option of
213+
registering it. This does not work for Free Pascal.
214+
215+
You can also tell CodeSnip about the available compilers by using the "Tools |
216+
Configure Compilers" menu option. The resulting dialogue can automatically
217+
detect all installed versions of supported Delphi compilers at the click of a
218+
button. Free Pascal, where installed, must be set up manually. The Welcome page
219+
displays a list of compilers it has been configured to work with.
214220

215221
Compilers that do not use English as their output language will need further
216222
configuration. See the help file for information (look up "configure compilers
@@ -221,19 +227,16 @@ Each user can configure compilers differently.
221227
Delphi XE2 and later may need to be configured to search for required units in
222228
the correct namespaces. This is explained in the Add/Edit Snippet Dialogue Box
223229
help topic and in the FAQ at
224-
https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-1
230+
https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-7
225231

226232
Any type of snippet other than "freeform" can be test compiled.
227233

228234

229235
Updating the Program
230236
================================================================================
231237

232-
Updates are published on:
233-
234-
+ GitHub: https://github.com/delphidabbler/codesnip/releases
235-
236-
+ SourceForge: https://sourceforge.net/projects/codesnip/files/
238+
Updates are published on GitHub. See
239+
https://github.com/delphidabbler/codesnip/releases
237240

238241
News of new updates is published on the CodeSnip Blog:
239242
https://codesnip-app.blogspot.com/.
@@ -324,9 +327,8 @@ If you wish to report a bug, please check the current reports on the bug
324327
tracker. If your bug hasn't already been reported or fixed please add a report
325328
using the "Add new" link on Tracker.
326329

327-
Please note that version 4.15.1 and earlier are no longer supported, so don't
328-
report bugs for those versions. You should update the program first and only
329-
report the bug if it is still present.
330+
Please ensure that you have installed the latest version of CodeSnip and checked
331+
if the bug is still present before reporting it.
330332

331333

332334
Feedback
@@ -378,8 +380,8 @@ Thanks to:
378380

379381
+ Various contributors to the DelphiDabbler Code Snippets database. Names of
380382
contributors are listed in the program's About Box (use the "Help | About"
381-
menu option then select the "About the Database" tab). If the list is empty
382-
then updating the Code Snippets Database will download the details.
383+
menu option then select the "About the Database" tab). The list will be empty
384+
if the Code Snippets Database has not been installed.
383385

384386

385387
================================================================================

‎LICENSE

-20
This file was deleted.

‎LICENSE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CodeSnip License
2+
3+
Executable releases of CodeSnip are released under the terms of the [Mozilla Public License 2.0](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Docs/License.html#mpl-2.0).
4+
5+
Much of CodeSnip's source code is released under the same license, although other open source licenses are also used.
6+
7+
There are restrictions on using CodeSnip's branding in any independent forks of the program.
8+
9+
For definitive details see the [full license text](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Docs/License.html).
10+
11+
A copy of the full license text is included with each CodeSnip executable. The original document can be found in the file `Docs/License.html` in the [_delphidabbler/codesnip_](https://github.com/delphidabbler/codesnip) repository on GitHub.

‎README.md

+33-50
Original file line numberDiff line numberDiff line change
@@ -6,101 +6,84 @@ A code bank designed with Pascal in mind.
66
* [Installation](#installation)
77
* [Support](#support)
88
* [Source Code](#source-code)
9+
* [Compiling](#compiling)
10+
* [Contributing](#contributing)
911
* [Change Log](#change-log)
1012
* [License](#license)
11-
* [Bug Reports and Features](#bug-reports-and-features)
13+
* [Bug Reports and Feature Requests](#bug-reports-and-feature-requests)
1214

1315
## Overview
1416

1517
CodeSnip is an open source code bank for storing and viewing your code snippets. While it can manage snippets in any source language, it is focused mainly on Pascal and Delphi code for which additional features are available.
1618

17-
CodeSnip can import code from the DelphiDabbler [Code Snippets Database](https://github.com/delphidabbler/code-snippets).
18-
1919
The program is available in both standard and portable editions.
2020

21-
CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, although XP and IE 8 and later are recommended.
21+
CodeSnip can import code from the DelphiDabbler [Code Snippets Database](https://github.com/delphidabbler/code-snippets) and the [SWAG Pascal Code Collection](https://github.com/delphidabbler/swag).
2222

2323
## Installation
2424

2525
The standard edition of CodeSnip is installed and removed using a Windows installer. Administrator privileges are required for installation.
2626

27-
The portable edition has no installer. Simply follow the instructions in the [read me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt) that is included in the download zip file.
27+
The portable edition has no installer. Simply follow the instructions in the [read me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt) that is included in the download.
28+
29+
The program _should_ run on Windows 2000, with Internet Explorer 6 or later, although XP and IE 8 and later are recommended. _But_ note that recent releases of CodeSnip have only been tested on Windows 10 & 11.
2830

2931
## Support
3032

3133
The following support is available to CodeSnip users:
3234

3335
* A comprehensive help file.
34-
* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt)<sup> *</sup> that discusses installation, configuration, updating and known issues.
35-
* A [Using CodeSnip FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md).
36-
* A [Blog](https://codesnip-app.blogspot.co.uk/).
36+
* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt) that discusses installation, configuration, updating and known issues. [^1]
37+
* The [Using CodeSnip FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md).
38+
* The [CodeSnip Blog](https://codesnip-app.blogspot.co.uk/).
39+
* CodeSnip's own [Web Page](https://delphidabbler.com/software/codesnip).
3740

3841
There's also plenty of info available on how to compile CodeSnip from source - see below.
3942

40-
> <sup>*</sup> This link takes you to the most recent version of the read-me file -- it can change from release to release.
43+
> [^1]: The linked read-me file is the most recent version. It can change from release to release.
4144
4245
## Source Code
4346

44-
CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub†.
45-
46-
The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some experimental branches.
47-
48-
The following branches existed as of 2022/12/03:
49-
50-
* [`master`](https://github.com/delphidabbler/codesnip/tree/master): Always reflects the state of the source code as of the latest release.‡
51-
* [`develop`](https://github.com/delphidabbler/codesnip/tree/develop): Main development branch. The head of this branch contains the latest v4 development code. Normal development of CodeSnip 4 takes place in `feature/xxx` branches off `develop`.
52-
* [`caboli`](https://github.com/delphidabbler/codesnip/tree/caboli): Experimental branch where an attempt is being made to (a) modernise the UI and (b) get the code to work properly when compiled with Delphi 11.
53-
* Abandoned branches:
54-
* [`pagoda`](https://github.com/delphidabbler/codesnip/tree/pagoda): An abortive attempt at developing CodeSnip 5.
55-
* [`pavilion`](https://github.com/delphidabbler/codesnip/tree/pavilion): Another attempt at working on CodeSnip 5 that branched off `pagoda`.
56-
* [`belvedere`](https://github.com/delphidabbler/codesnip/tree/belvedere): A thiird, failed attempt to develop CodeSnip 5 as a ground up rewrite. Not related to `pagoda` & `pavilion`.
47+
CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub. [^2]
5748

58-
> † Up to and including v4.13.1 the source code was kept in a Subversion repository on SourceForge. It was converted to Git in October 2015 and imported into GitHub. All releases from v3.0.0 are marked by tags in the form `version-x.x.x` where `x.x.x` is the version number. None of the Subversion branches made it through the conversion to Git, so to see a full history look at the old [SourceForge repository](https://sourceforge.net/p/codesnip/code/).
49+
The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted for CodeSnip 4 development. The following branches are used:
5950

60-
> ‡ All the converted Subversion code was committed to `master`, making it a copy of the old Subversion `trunk`. As such `master` contains various development commits along with numerous commits related to management of Subversion. After release 4.13.1, and the the first commit of this read-me file, `master` contains only commits relating to actual releases.
51+
* [`master`](https://github.com/delphidabbler/codesnip/tree/master): Always reflects the state of the source code as of the latest release. [^3]
52+
* [`develop`](https://github.com/delphidabbler/codesnip/tree/develop): The head of this branch contains the latest v4 development code. Normal development of CodeSnip 4 takes place in feature branches that are then merged into `develop`.
53+
* Feature branches, with names of the form `feature/<feature-name>`. Normally such branches are only used locally, but occasionally some feature branches may be pushed to the main repository.
6154

62-
### Contributions
55+
You will find other branches in the repository. These are either experimental or abandoned. To find out more about them switch to the required branch and read its `README.md` file.
6356

64-
To contribute to CodeSnip 4 development please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to your feature branch then submit a pull request via GitHub.
57+
> [^2]: Up to and including v4.13.1 the source code was kept in a Subversion repository on SourceForge. It was converted to Git in October 2015 and imported into GitHub. All releases from v3.0.0 are marked by tags in the form `version-x.x.x` where `x.x.x` is the version number. None of the Subversion branches made it through the conversion to Git, so to see a full history look at the old [SourceForge repository](https://sourceforge.net/p/codesnip/code/).
6558
66-
:warning: **Do not create branches off `master`, always branch from `develop`.**
59+
> [^3]: All the converted Subversion code was committed to `master`, making it a copy of the old Subversion `trunk`. As such `master` contains various development commits along with numerous commits related to management of Subversion. After release 4.13.1, and the the first commit of this read-me file, `master` contains only commits relating to actual releases.
6760
68-
:no_entry: Contributions to experimental branches are not being excepted just now.
61+
## Compiling
6962

70-
#### Licensing of contributions
63+
If you want to compile CodeSnip 4 from source code you will need the rather long-in-the-tooth Delphi XE. See [this FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-11) to find out why.
7164

72-
The license that applies to any existing file you edit will continue to apply to the edited file. Any existing license text or copyright statement **must not** be altered or removed.
65+
Full instructions on setting up the build environment are provided in [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/develop/Build.html).
7366

74-
Any new file you contribute **must** either be licensed under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/) (MPL2) or have a license compatible with the MPL2. If a license is not specified then MPL2 will be assumed and will be applied to the file. You should insert a suitable copyright statement in the file.
67+
## Contributing
7568

76-
Any third party code used by your contributed code **must** also have a license compatible with the MPL2.
69+
Please see [`CONTRIBUTING.md`](https://github.com/delphidabbler/codesnip/blob/develop/CONTRIBUTING.md) for details of how to contribute to the CodeSnip project.
7770

78-
> MPL2 boilerplate text, in several programming language's comment formats, can be found in the file [`Docs/MPL-2.0-Boilerplate.txt`](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/MPL-2.0-Boilerplate.txt). You will need to change the name of the copyright holder.
79-
80-
### Compiling
81-
82-
`master` has a file in the root directory named [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Build.html) that gives detailed information about how to compile the current release of CodeSnip 4.
83-
84-
There is also a [Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md).
85-
86-
CodeSnip 4 **must** be compiled with Delphi XE. See [Compiling & Source Code FAQ 11](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-11) for the reason why.
71+
⛔ Contributions to experimental and abandoned branches are not accepted.
8772

8873
## Change Log
8974

90-
The program's current change log can be found in the file [`CHANGELOG.md`](https://github.com/delphidabbler/codesnip/blob/master/CHANGELOG.md) in the root of the `master` branch.
75+
The change log can be found in the file [`CHANGELOG.md`](https://github.com/delphidabbler/codesnip/blob/master/CHANGELOG.md). [^4]
9176

92-
> Note that CodeSnip v4.15.1 and earlier did not have `CHANGELOG.md`. Instead, some versions maintained a separate change log for each major version in the `Docs/ChangeLogs` directory.
77+
> [^4]: CodeSnip v4.15.1 and earlier did not have `CHANGELOG.md`. Instead, some versions maintained a separate change log for each major version in the `Docs/ChangeLogs` directory.
9378
9479
## License
9580

96-
The program's EULA, which gives full details of the license applying to the latest release, can be found in the file [`Docs\License.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Docs/License.html) in the `master` branch. The license has changed between releases, so if you need to see an older one, select the appropriate `version-x.x.x` tag and read the older version of the file.
97-
98-
Most of the original code is made available under the [Mozilla Public License v2](https://www.mozilla.org/MPL/2.0/).
81+
A summary of CodeSnip's license can be found in [`LICENSE.md`](https://github.com/delphidabbler/codesnip/blob/master/LICENSE.md) and the complete license text is in [`Docs\License.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Docs/License.html). [^5]
9982

100-
The [CodeSnip Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md) may be useful if you have any queries about re-using CodeSnip source in other projects.
83+
> [^5]: The linked license files relate to the latest release. However, the license file names and content can change between releases, so if you need to see an older version, select the relevant `version-x.x.x` tag to find the appropriate file.
10184
102-
## Bug Reports and Features
85+
The [CodeSnip Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md) may be useful if you have any queries about re-using the CodeSnip source code in other projects.
10386

104-
You can report bugs or request new features using the [Issues section](https://github.com/delphidabbler/codesnip/issues) of the CodeSnip GitHub project. You will need a GitHub account to do this.
87+
## Bug Reports and Feature Requests
10588

106-
Please do not report bugs unless you have checked whether the bug exists in the latest version of the program.
89+
Report bugs and requests for new features are welcome. Please see the [Issues section of `CONTRIBUTING.md`](https://github.com/delphidabbler/codesnip/blob/develop/CONTRIBUTING.md#issues) for information about how to proceed.

‎Src/3rdParty/LICENSE

-12
This file was deleted.

‎Src/AutoGen/LICENSE

-7
This file was deleted.

‎Src/Help/HTML/new.htm

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
55
* obtain one at https://mozilla.org/MPL/2.0/
66
*
7-
* Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
7+
* Copyright (C) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
88
*
99
* Help topic listing key new features of CodeSnip 4.
1010
-->

‎Src/Help/Images/LICENSE

-5
This file was deleted.

‎Src/Install/Assets/LICENSE

-9
This file was deleted.

‎Src/LICENSE

-20
This file was deleted.

‎Src/Res/HTML/dlg-about-program-tplt.html

+9-12
Original file line numberDiff line numberDiff line change
@@ -77,30 +77,27 @@
7777
</li>
7878
<li>
7979
<div>
80-
<em>CodeSnip</em> makes use of images from the following icon
80+
<em>CodeSnip</em> makes use of images from the following image
8181
collections:
8282
</div>
8383
<ul>
8484
<li>
85-
<a
86-
href="http://www.famfamfam.com/lab/icons/silk/"
87-
class="external-link"
88-
>Silk Icon Set 1.3</a> by Mark James.
85+
<span title="broken link removed">Silk Icon Set 1.3</span> by Mark
86+
James.
8987
</li>
9088
<li>
91-
Silk Companion 1 by Damien Guard.
89+
<span title="broken link removed">Silk Companion 1</span> by Damien
90+
Guard.
9291
</li>
9392
<li>
94-
Led Icon Set v1.0.
93+
<span title="broken link removed">Led Icon Set v1.0</span>.
9594
</li>
9695
<li>
97-
16x16-free-application-icons by <a
98-
href="https://www.aha-soft.com"
99-
class="external-link"
100-
>Aha-Soft</a>.
96+
<span title="broken link removed">16&times;16 Free Application
97+
Icons</span> by Aha-Soft.
10198
</li>
10299
<li>
103-
PixelBox icon collection.
100+
<span title="broken link removed">PixelBox icon collection</span>.
104101
</li>
105102
<li>
106103
<a

‎Src/Res/Img/AltBranding/CodeSnip.ico

16.2 KB
Binary file not shown.

‎Src/Res/Img/AltBranding/README.txt

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
About the Src/Res/Img/AltBranding directory
2+
===========================================
3+
4+
If you are creating a fork of CodeSnip, or a program based on it, then
5+
the CodeSnip license does not permit you to use the images in the
6+
`Src/Res/Img/Branding` directory. But, since CodeSnip expects to find
7+
the files `CodeSnip.ico`, `icon.gif` and `Splash.gif` in that directory,
8+
simply deleting the images will cause CodeSnip to fail to build.
9+
10+
Alternative versions of the above images are provided in the
11+
`Src/Res/Img/AltBranding` directory. These files are Public Domain, and
12+
therefore can be used and modified in derived programs.
13+
14+
Simply copy the image files from the `Src/Res/Img/AltBranding` directory
15+
into `Src/Res/Img/Branding`, overwriting the existing files. CodeSnip
16+
can then be built successfully without using the prohibited files.
17+
18+
It is not expected that the images will be used as-is. They are provided
19+
only as placeholders to enable CodeSnip to build successfully.
20+
Evetually you may want to edit the images to meet your needs.
21+
Alternatively, the CodeSnip source could be changed so that the images
22+
are not required at all.
23+
24+
Because the files are Public Domain, you may relicense any modified
25+
version as you wish.
26+
27+
28+
Information about the files
29+
---------------------------
30+
31+
`CodeSnip.ico`
32+
33+
This is the program's main icon.
34+
35+
It contains images at four different resolutions: 16×16, 32×32, 48×48
36+
and 256×256 pixels.
37+
38+
`icon.gif`
39+
40+
A 32×32 pixel GIF file that is displayed in the About box.
41+
42+
`Splash.gif`
43+
44+
A 325×155 pixel GIF image that is displayed as a splash screen while
45+
the program is loading.
46+
47+
The program's version number is overlaid in the bottom quarter of the
48+
image.

‎Src/Res/Img/AltBranding/Splash.gif

2.98 KB
Loading

‎Src/Res/Img/AltBranding/icon.gif

157 Bytes
Loading

‎Src/Res/Img/Branding/LICENSE

-8
This file was deleted.

‎Src/Res/Img/Branding/README.txt

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
About the Src/Res/Img/Branding directory
2+
========================================
3+
4+
If you are creating a fork of CodeSnip, or a program based on it, the
5+
CodeSnip license does not permit you to use the images in this directory
6+
in such a project.
7+
8+
To assist with this problem, alternative versions of the above images
9+
are provided in the `Src/Res/Img/AltBranding` directory.
10+
11+
For more information see:
12+
13+
* `Src/Res/Img/AltBranding/README.txt`
14+
15+
* `Build.html`, specifically the "Get the Source Code" sub-section and
16+
the "Conditions For Release of Modified Code" section.
17+
18+
* `Docs/License.html` for full details of the license restrictions
19+
applying to files in this directory.

‎Src/Res/Img/LICENSE

-16
This file was deleted.

‎Src/Res/Scripts/3rdParty/LICENSE

-10
This file was deleted.

‎Src/Res/Scripts/easteregg.js

+7-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
44
* obtain one at https://mozilla.org/MPL/2.0/
55
*
6-
* Copyright (C) 2009-2021, Peter Johnson (gravatar.com/delphidabbler).
6+
* Copyright (C) 2009-2023, Peter Johnson (gravatar.com/delphidabbler).
77
*
88
* JavaScript code used to perform animations in program's easter egg.
99
* Requires jQuery and lite version of jQuery Cycle plug-in.
@@ -13,6 +13,12 @@
1313
// Main function called when DOM has loaded. Runs prelinary animations up to
1414
// when introductory page is shown on unfolded screen
1515
$(document).ready(function(){
16+
17+
//! Fix vulnerability using patch suggested in dependabot alert
18+
//! https://github.com/delphidabbler/codesnip/security/dependabot/1
19+
jQuery.htmlPrefilter = function( html ) {
20+
return html;
21+
};
1622

1723
var spt = null; // showPrompt timeout
1824

‎Src/VCodeSnip.vi

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
; v. 2.0. If a copy of the MPL was not distributed with this file, You can
33
; obtain one at https://mozilla.org/MPL/2.0/
44
;
5-
; Copyright (C) 2008-2022, Peter Johnson (gravatar.com/delphidabbler).
5+
; Copyright (C) 2008-2023, Peter Johnson (gravatar.com/delphidabbler).
66
;
77
; Version information description file for CodeSnip.
88

@@ -24,7 +24,7 @@ Language=2057
2424
Character Set=1252
2525

2626
[String File Info]
27-
Comments=<%var.license>
27+
Comments=<%ver.license>
2828
Company Name=<%ver.company>
2929
File Description=<%ver.description> (Standard Edition)
3030
File Version=<#F1>.<#F2>.<#F3> build <#F4>
@@ -41,4 +41,4 @@ Special Build=
4141
Identifier=
4242
NumRCComments=0
4343
ResOutputDir=
44-
FileVersion=1
44+
FileVersion=2

‎Src/VCodeSnipPortable.vi

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
; v. 2.0. If a copy of the MPL was not distributed with this file, You can
33
; obtain one at https://mozilla.org/MPL/2.0/
44
;
5-
; Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
5+
; Copyright (C) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
66
;
77
; Version information description file for the portable edition of CodeSnip
88

@@ -24,7 +24,7 @@ Language=2057
2424
Character Set=1252
2525

2626
[String File Info]
27-
Comments=<%var.license>
27+
Comments=<%ver.license>
2828
Company Name=<%ver.company>
2929
File Description=<%ver.description> (Portable Edition)
3030
File Version=<#F1>.<#F2>.<#F3> build <#F4>
@@ -41,4 +41,4 @@ Special Build=Portable
4141
Identifier=
4242
NumRCComments=0
4343
ResOutputDir=
44-
FileVersion=1
44+
FileVersion=2

‎Src/VersionInfo.vi-inc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# CodeSnip Version Information Macros for Including in .vi files
22

33
# Version & build numbers
4-
version=4.21.1
5-
build=268
4+
version=4.21.2
5+
build=269
66

77
# String file information
88
copyright=Copyright © P.D.Johnson, 2005-<YEAR>.

‎Tests/Src/DUnit/LICENSE

-3
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.