Merge tag 'version-4.26.0' into develop

delphidabbler · delphidabbler · commit 877ad2174593 · 2025-05-02T19:49:42.000+01:00
Release v4.26.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,40 @@ Releases are listed in reverse version number order.
 
 > 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.
 
+## Release v4.26.0 of 02 May 2025
+
+* Updated the dialogue box displayed when saving units and annotated source code [issue #166]:
+  * The _File Encoding_ drop down list control is disabled if there is only one encoding option.
+  * Updated and clarified the naming of encodings in the _File Encoding_ drop down list.
+  * The sole encoding option displayed for the _Rich text file_ file type was changed from the erroneous ANSI to the correct ASCII.
+* Fixed bug where, when ANSI encoding was selected in the _Save Unit_ and _Save Annotated Source_ dialogue boxes, snippets containing characters not supported in the default locale's code page were being rendered diffently in the Preview dialogue box to when saved to file [issue #164]. The previewed code is now the same as that of the saved source code.
+* Updated file formats available when the _File | Save Snippet Information_ menu option is selected:
+  * Syntax highlighting of the existing RTF format output is now optional.
+  * Added the option to save snippet information in the following new formats:
+    * Plain text, in UTF-8, UTF-16LE, UTF-16BE and the system locale's default ANSI code page. [issue #162]
+    * HMTL 5 with optional syntax highlighting, in UTF-8 format [issue #153].
+    * XHTML with optional syntax highlighting, in UTF-8 format [issue #153].
+    * Markdown, in UTF-8, UTF-16LE, UTF-16BE and the system locale's default ANSI code page [issue #155].
+  * Changed the _Save Snippet Information_ dialogue box: 
+    * It is now based on that used for saving unit and annotated source code in that file encoding and snippet highlighting can be customised where relevant, although the _Comment style_ controls are disabled since they are not relevant.
+    * The suggested file name was changed from &quot;SnippetInfo&quot; to the display name of the selected snippet.
+    * The dialogue box caption now contains the display name of the selected snippet.
+* Changed the title of the _Save Annotated Source_ dialogue box when displaying snippets.
+* Added option to prevent descriptive comments from appearing in the implementation section of generated units. A check box for this option has been added to the _Code Formatting_ tab of the _Preferences_ dialogue box [issue #85].
+* The _Help | CodeSnip News Blog_ menu item was changed to link to the [DelphiDabbler Blog](https://delphidabbler.blogspot.com/) instead of the CodeSnip Blog, because the latter is to be closed down. The menu item was renamed to _Help | CodeSnip News On DelphiDabbler Blog_ [issue #161].
+* Improved how the CSS used in generated HTML 5 and XHTML files is generated:
+  * The ordering of CSS selectors can now be pre-determined.
+  * CSS lengths and sizes can now be specified in units, such as `em`, instead of just pixels.
+* Refactored the `USourceGen` unit to remove an unnecessary dependency on user preferences [issue #167].
+* Updated the help file: 
+  * Re changes when saving snippet information [issue #163].
+  * Re changes to the _Save Unit_ and _Save Annotated Source_ dialogue boxes.
+  * Re changes to the blog linked from the _Help_ menu.
+  * Re the new option to inhibit comments in the implementation sections of generated units.
+* Updated documentation: 
+  * File format documentation was changed re the addition of the Markdown file format and the changes to the encodings used in saved files.
+  * Read-me files were updated re the change of news blog.
+
 ## Release v4.25.0 of 19 April 2025
 
 * Added new feature to save snippet information to file in RTF format using the new _File | Save Snippet Information_ menu option [issue #140].
@@ -15,7 +49,7 @@ Releases are listed in reverse version number order.
 * Overhauled rich text format processing:
   * Fixed bug where Unicode characters that don't exist in the system code page were not being displayed correctly [issue #157].
   * Fixed potential bug where some reserved ASCII characters may not be escaped properly [issue #159].
-  * Refactored and improved the rich text handling code [issue #100].
+  * Refactored and improved the rich text handling code [issue #100]. 
 * Corrected the copyright date displayed in the About Box to include 2025 [issue #149].
 * Documentation changes:
   * Fixed error in the export file formation documentation and related help topic [issue #151].
diff --git a/Docs/Design/FileFormats/config.html b/Docs/Design/FileFormats/config.html
@@ -167,7 +167,7 @@ <h3>
 </p>
 
 <p>
-  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 <code class="key">CanAutoInstall</code> key in the [Cmp:XXX] sections.
+  There have been several versions of this file. The current one is version 20. The change to version 20 came with CodeSnip v4.26.0 and the addition of the <code class="key">UseCommentsInUnitImpl</code> key in the <code>[Prefs:SourceCode]</code> section.
 </p>
 
 <p>
@@ -771,7 +771,7 @@ <h4>
       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>.
     </div>
     <div class="half-spaced">
-      The current value is <code class="value">19</code>.
+      The current value is <code class="value">20</code>.
     </div>
   </dd>
   <dt>
diff --git a/Docs/ReadMe-portable.txt b/Docs/ReadMe-portable.txt
@@ -248,6 +248,9 @@ Thanks to:
 + The authors of the third party source code and images used by the program. See
   the program's about box or License.html for details.
 
++ SirRufo for helping to fix a long standing bug where CodeSnip would crash on
+  resuming from hibernation.
+
 + Various contributors to the DelphiDabbler Code Snippets database. Names of
   contributors are listed in the program's About Box (use the "Help | About"
   menu option then select the "About the Database" tab). The list will be empty
diff --git a/Docs/ReadMe-standard.txt b/Docs/ReadMe-standard.txt
@@ -293,6 +293,9 @@ Thanks to:
 + geoffsmith82 and an anonymous contributor for information about getting
   CodeSnip to work with Delphi XE2.
 
++ SirRufo for helping to fix a long standing bug where CodeSnip would crash on
+  resuming from hibernation.
+
 + The authors of the third party source code and images used by the program. See
   the program's about box or License.html for details.
 
diff --git a/Src/FirstRun.UConfigFile.pas b/Src/FirstRun.UConfigFile.pas
@@ -82,7 +82,7 @@   TUserConfigFileUpdater = class(TConfigFileUpdater)
   strict private
     const
       ///  <summary>Current user config file version.</summary>
-      FileVersion = 19;
+      FileVersion = 20;
   strict protected
     ///  <summary>Returns current user config file version.</summary>
     class function GetFileVersion: Integer; override;
diff --git a/Src/VersionInfo.vi-inc b/Src/VersionInfo.vi-inc
@@ -1,8 +1,8 @@
 # CodeSnip Version Information Macros for Including in .vi files
 
 # Version & build numbers
-version=4.25.0
-build=275
+version=4.26.0
+build=276
 
 # String file information
 copyright=Copyright © P.D.Johnson, 2005-<YEAR>.
