Merge branch 'release/4.20.0'

Author: delphidabbler

Build.html

@@ -80,6 +80,13 @@ <h2>
   XE. Compilation with other compilers is not guaranteed.
 </p>
 
+<p class="note">
+  For an explanation of why <em>CodeSnip</em> still uses Delphi XE see
+  <a
+    href="https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-11"
+  >FAQ 11</a> of the CodeSnip Compiling &amp; Source Code FAQs.
+</p>
+
 <p>
   The are currently two editions of <em>CodeSnip</em>: the standard edition and
   the portable edition. They both share the same code base: the different

CHANGELOG.md

@@ -10,6 +10,22 @@ This change log begins with the first ever pre-release version of _CodeSnip_. Re
 
 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).
 
+## Release v4.20.0 of 15 May 2022
+
+* Added an option to delete the user defined database.
+* Fixed bug that enabled the user to attempt to move, or back up, the user database when it doesn't exist. These options are now disabled when there is no user database.
+* Added facility to customise the size of font used in the details pane for all items except the source code font (which could already be modified separately). A new preference was added to the Display pane of the Preferences dialogue box to be used to set the font size.
+* Rearranged the controls on the Preferences dialogue box's Display pane.
+* Changed the default font used for the overview pane from a fixed value to the default size for the underlying operating system.
+* Changed the description of "Delphi 11 Alexandria" to "Delphi 11.x Alexandria" to reflect the fact the Delphi 11 updates have different minor version numbers, but can't be installed alongside each other.
+* Widened the compiler list box in the Configure Compilers dialogue box to accommodate the longer name used for Delphi 11.x compilers.
+* Refactored some font handling code.
+* Operating system detection code was updated to (a) fix some bugs and (b) detect some Dev channel builds of Windows 11.
+* Bumped the version of the per-user config file to 18 following the addition of a new preference.
+* Help file updated re the changes in this release.
+* Documentation updated to reflect changes in this release.
+* Updated `README.md` and `Build.html`
+
 ## Release v4.19.0 of 31 December 2021
 
 * Improved user-friendliness of Preferences dialogue box:

Docs/Design/FileFormats/config.html

@@ -5,7 +5,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: Configuration Files
 -->
@@ -167,7 +167,7 @@ <h3>
 </p>
 
 <p>
-  There have been several versions of this file. The current one is version 17. The change to version 17 came with CodeSnip v4.19.0 and the addition of the [Prefs] section.
+  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.
 </p>
 
 <p>
@@ -257,7 +257,7 @@ <h4>
     <em>D104S</em> &ndash; Delphi 10.4 Sydney
   </li>
   <li>
-    <em>D11A</em> &ndash; Delphi 11 Alexandria
+    <em>D11A</em> &ndash; Delphi 11.x Alexandria
   </li>
   <li>
     <em>FPC</em> &ndash; Free Pascal
@@ -570,7 +570,7 @@ <h4>
     <code class="key">D11A</code> (Boolean)
   </dt>
   <dd>
-    Indicates whether Delphi 11 Alexandria was included in the search.
+    Indicates whether Delphi 11.x Alexandria was included in the search.
   </dd>
   <dt>
     <code class="key">FPC</code> (Boolean)
@@ -917,7 +917,13 @@ <h4>
     <code class="key">OverviewFontSize</code> (Integer)
   </dt>
   <dd>
-    Size of font to be used in overview pane tree view. If missing or empty the default value is <code class="value">9</code>.
+    Size of font to be used in overview pane tree view. If missing or empty the default value is the default font size of the operationg system.
+  </dd>
+  <dt>
+    <code class="key">DetailFontSize</code> (Integer)
+  </dt>
+  <dd>
+    Size of font to be used in detail pane for all text except for source code. If missing or empty the default value is the default content font size of the operating system.
   </dd>
 </dl>
 

Docs/Design/FileFormats/export.html

@@ -5,7 +5,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: Export
 -->
@@ -597,7 +597,7 @@ <h2>
             <em>d104s</em> &ndash; Delphi 10.4 Sydney compiler <span class="highlight">(v7.1 &amp; later)</span>
           </li>
           <li>
-            <em>d11a</em> &ndash; Delphi 11 Alexandria compiler <span class="highlight">(v7.2 &amp; later)</span>
+            <em>d11a</em> &ndash; Delphi 11.x Alexandria compiler <span class="highlight">(v7.2 &amp; later)</span>
           </li>
           <li>
             <em>fpc</em> &ndash; Free Pascal compiler <span class="highlight">(all versions)</span>
@@ -969,7 +969,7 @@ <h2>
         <em>Version 7.2 - 13 September 2021</em>
       </dt>
       <dd>
-        Updated with CodeSnip v4.18.0 to add support for Delphi 11 Alexandria.
+        Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
     </dl>
   </dd>

Docs/Design/FileFormats/main-db.html

@@ -5,7 +5,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: Main Database
 -->
@@ -417,7 +417,7 @@ <h4>
         <code class="key">Delphi104S</code> – Delphi 10.4 Sydney compiler *
       </li>
       <li>
-        <code class="key">Delphi11A</code> – Delphi 11 Alexandria compiler *
+        <code class="key">Delphi11A</code> – Delphi 11.x Alexandria compiler *
       </li>
       <li>
         <code class="key">FPC</code> – Free Pascal compiler

Docs/Design/FileFormats/user-db.html

@@ -5,7 +5,7 @@
  * v. 2.0. If a copy of the MPL was not distributed with this file, You can
  * obtain one at https://mozilla.org/MPL/2.0/
  *
- * Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2012-2022, Peter Johnson (gravatar.com/delphidabbler).
  *
  * CodeSnip File Format Documentation: User Database
 -->
@@ -622,7 +622,7 @@ <h3 id="xml-file">
             <em>d104s</em> &ndash; Delphi 10.4 Sydney compiler <span class="highlight">(v6.9 &amp; later)</span>
           </li>
           <li>
-            <em>d11a</em> &ndash; Delphi 11 Alexandria compiler <span class="highlight">(v6.10 &amp; later)</span>
+            <em>d11a</em> &ndash; Delphi 11.x Alexandria compiler <span class="highlight">(v6.10 &amp; later)</span>
           </li>
           <li>
             <em>fpc</em> &ndash; Free Pascal compiler <span class="highlight">(all versions)</span>
@@ -1005,7 +1005,7 @@ <h2>
         <em>Version 6.10 - 13 September 2021</em>
       </dt>
       <dd>
-        Updated with CodeSnip v4.18.0 to add support for Delphi 11 Alexandria.
+        Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
       </dd>
     </dl>
   </dd>

Docs/ReadMe.txt

@@ -14,7 +14,7 @@ online DelphiDabbler Code Snippets database as well as maintain a database of
 user-defined snippets.
 
 It displays details of each snippet in the database and can test-compile them
-with each installed Win32 version of Delphi from Delphi 2 to Delphi 11
+with each installed Win32 version of Delphi from Delphi 2 to Delphi 11.x
 Alexandria and Free Pascal.
 
 Compilable Pascal units can be created that contain selected snippets.
@@ -201,7 +201,7 @@ Configuring CodeSnip to Work With Your Compilers
 ================================================================================
 
 A feature of CodeSnip is its ability to test compile snippets with any installed
-Windows 32 version of Delphi (from Delphi 2 to Delphi 11 Alexandria) and
+Windows 32 version of Delphi (from Delphi 2 to Delphi 11.x Alexandria) and
 FreePascal, providing some simple rules are followed.
 
 When CodeSnip is first installed it knows nothing about the available compilers

README.md

@@ -43,14 +43,15 @@ There's also plenty of info available on how to compile CodeSnip from source - s
 
 CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub†.
 
-[Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in various attempts to start work on CodeSnip 5.
+The [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in various attempts to start work on CodeSnip 5.
 
-The following branches existed at the time when CodeSnip v4.16.0 was released:
+The following branches existed as of 2022/01/01:
 
 * `master`: Always reflects the state of the source code as of the latest release.‡
-* `develop`: Main development branch. The head of this branch contains the latest development code.
+* `develop`: Main development branch. The head of this branch contains the latest v4 development code.
+* `belvedere`: The latest attempt to develop CodeSnip 5. See the [Belvedere Readme file](https://github.com/delphidabbler/codesnip/blob/belvedere/README.md) for a full explanation.
 * `pagoda`: An abortive attempt at developing CodeSnip 5. Work on this branch has halted. It does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
-* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and it's future is uncertain. Again it does not follow GitFlow methodology.
+* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and work on it has halted. Again it does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
 
 New features and most bug fixes are worked on in `feature/xxxx` branches that are branched off `develop` locally. They are merged into `develop` as they are completed and the branches are deleted.
 
@@ -62,14 +63,28 @@ Note that the default branch on GitHub is `master`, which contains the state of
 
 ### Contributions
 
-To contribute to the project please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to the feature branch then submit a pull request via GitHub.
+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.
+
+> **Do not create branches off `master`, always branch from `develop`.**
+
+#### Licensing of contributions
+
+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.
+
+Any new file you contribute **must** either be licensed under the Mozilla Public License v2.0 (MPL2) or have a license compatible with the MPL2. If a license is not specified then the MPL2 will be applied to the file. You should insert a suitable copyright statement in the file.
+
+Any third party code used by your contributed code **must** also have a license compatible with the MPL2.
+
+> MPL2 boilerplate text, in several programming language's comment formats, can be found in the file `Docs/MPL-2.0-Boilerplate.txt`. You will need to change the name of the copyright holder.
 
 ### Compiling
 
-`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.
+`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.
 
 There is also a [Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md).
 
+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.
+
 ## Change Log
 
 The program's current change log can be found in the file `CHANGELOG.md` in the root of the `master` branch.