From 848d284bdc4450c811333bdc875213e658a54156 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 11:54:58 +0100
Subject: [PATCH 01/23] Split Docs/ReadMe.txt into two different versions
Split into ReadMe-portable.txt relating to Portable edition and
ReadMe-standard.txt for Standard edition.
Both files were edited according to new purpose and to update content
where necessary.
---
Docs/ReadMe-portable.txt | 257 +++++++++++++++++++++++
Docs/{ReadMe.txt => ReadMe-standard.txt} | 174 ++++-----------
2 files changed, 303 insertions(+), 128 deletions(-)
create mode 100644 Docs/ReadMe-portable.txt
rename Docs/{ReadMe.txt => ReadMe-standard.txt} (64%)
diff --git a/Docs/ReadMe-portable.txt b/Docs/ReadMe-portable.txt
new file mode 100644
index 000000000..e0883fa5c
--- /dev/null
+++ b/Docs/ReadMe-portable.txt
@@ -0,0 +1,257 @@
+================================================================================
+
+DELPHIDABBLER CODESNIP v4 PORTABLE EDITION README
+
+================================================================================
+
+
+What is CodeSnip?
+================================================================================
+
+DelphiDabbler CodeSnip 4 is a code snippets repository targetted at the Pascal /
+Delphi programming languages. It can download and display code snippets from the
+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 12.x and
+Free Pascal.
+
+Compilable Pascal units can be created that contain selected snippets.
+
+
+CodeSnip Editions
+================================================================================
+
+This document relates to the PORTABLE edition of CodeSnip. This edition can be
+run from any writeable removable storage medium (e.g. a USB memory stick) or
+from any folder on the computer's hard disk. It makes no changes to the host
+computer.
+
+There is also a standard edition of the program. This edition is installed on
+the user's computer using an installer. It records its presence in the registry
+and stores data in the system's application and user data directories. You can
+get the standard edition from the same place you downloaded the this edition.
+
+You can run both the standard and portable editions together on the same
+computer and even run them at the same time. However, each edition maintains its
+own settings and keeps its own copies of the snippets databases. To share user
+defined snippets you must export them from one edition and import into the
+other. CodeSnip provides no mechanism for keeping them synchronised.
+
+
+Installation
+================================================================================
+
+CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer 6
+or later, although IE 8, 9 or 10 are strongly recommended. Note that recent
+releases have only been tested on Windows 11.
+
+The portable edition of CodeSnip 4 is distributed in a zip file that contains
+the program executable, the help file and various documentation files.
+
+Install the program using the following steps:
+
+1) Mount any storage medium on which you want to install CodeSnip.
+
+2) Create a folder on the storage medium or on your computer's internal disk in
+ which to copy the required files.
+
+3) Copy the files CodeSnip-p.exe (the executable program) and CodeSnip.chm
+ (the help file) into the folder you created.
+
+ CodeSnip does not need the other files included in the zip file in order to
+ run, but you may find them useful. Copy them if you wish.
+
+Run the program by double clicking it. When it first runs it will create two
+sub-directories within the folder where you installed the program. These will
+be named AppData and UserData. Do not remove these directories or alter any of
+the contents because CodeSnip uses them to store configuration data along with
+your code snippets.
+
+No files are written outside the folder where you copied the files and the
+registry is not modified.
+
+** WARNING: When updating an existing portable installation with a new version
+of CodeSnip it is important that you do not change or delete the AppData and
+UserData folders. If you do this you risk loosing your settings and/or database.
+
+
+Uninstallation
+================================================================================
+
+Simply delete the folder where you installed the portable edition of CodeSnip
+along with all its contents.
+
+Be aware that any snippets you have created will be lost. If you want to keep
+them for use in another CodeSnip installation, either export them or back up the
+user database before deleting the folder. See the help file for details of how
+to do this.
+
+
+Downloading & Updating the Code Snippets Database
+================================================================================
+
+The online DelphiDabbler Code Snippets database is not installed with the
+program.
+
+CodeSnip's start-up screen shows details of any installed databases. If there is
+no copy of the online database then a link is displayed that enables the
+database to be installed. This link opens the "Install or Update DelphiDabbler
+Snippets Database" wizard dialogue box. The dialogue box explains how to
+download and install the database.
+
+You can download or update the database later by opening the same dialogue box
+using the "Database | Install or Update DelphiDabbler Snippets Database" menu
+option.
+
+
+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.x) and FreePascal,
+providing some simple rules are followed.
+
+When CodeSnip is first installed it knows nothing about the available compilers
+and so test compilations cannot be performed. If any supported Delphi compiler
+is detected when the program is first run you will be given the option of
+registering it. This does not work for Free Pascal.
+
+You can also tell CodeSnip about the available compilers by using the "Tools |
+Configure Compilers" menu option. The resulting dialogue can automatically
+detect all installed versions of supported Delphi compilers at the click of a
+button. Free Pascal, where installed, must be set up manually. The Welcome page
+displays a list of compilers it has been configured to work with.
+
+Compilers that do not use English as their output language will need further
+configuration. See the help file for information (look up "configure compilers
+dialogue" in the help file index).
+
+Each user can configure compilers differently.
+
+Delphi XE2 and later may need to be configured to search for required units in
+the correct namespaces. This is explained in the Add/Edit Snippet Dialogue Box
+help topic and in the FAQ at
+https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md#faq-7
+
+Any type of snippet other than "freeform" can be test compiled.
+
+
+Updating the Program
+================================================================================
+
+Updates are published on GitHub. See
+https://github.com/delphidabbler/codesnip/releases
+
+News of new updates is published on the CodeSnip Blog:
+https://codesnip-app.blogspot.com/.
+
+
+Known Installation and Upgrading Issues
+================================================================================
+
++ If you have updated to CodeSnip v4.2.0 or later from any earlier v4 release,
+ and then run the earlier version of the program again, its saved main window
+ state, size, position and layout will have been lost and the program will
+ display in its default size.
+
++ If you have updated to CodeSnip v4.3.0 or later from v4.2.x or earlier any -NS
+ command line options you have specified on the "Switches" (aka "Command Line")
+ tab of the Configure Compilers dialogue box for Delphi XE2 or later will be
+ removed and equivalent entries will have been made on the "Namespaces" tab.
+
++ CodeSnip v4.16.0 and later cannot be registered. Any previous registration
+ information may be lost.
+
+
+License & Disclaimer
+================================================================================
+
+CodeSnip is made available under the terms of the Mozilla Public License v2.0.
+The license is explained in full in the file License.html that is installed with
+CodeSnip. A summary of the license can be viewed from the "Help | License" menu
+option.
+
+CodeSnip is supplied on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
+express or implied. See License.html for details.
+
+The source code of any snippet managed by CodeSnip, whether from the
+DelphiDabbler Code Snippets Database or the user database, is used WITHOUT
+WARRANTY OF ANY KIND, either express or implied. The code is used entirely at
+the user's own risk.
+
+The snippets from the DelphiDabbler Code Snippets Database are open source. See
+the "About The Database" tab of the About dialogue box for details of the
+applicable license. (You can display the About box from the "Help" menu.)
+
+The user is responsible to ensure that any code snippets managed by CodeSnip are
+used in accordance with any applicable license.
+
+
+Source Code
+================================================================================
+
+CodeSnip's source code is freely available. For details of how to obtain the
+source see the FAQ at
+https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-1
+
+The portable edition of CodeSnip shares the same source code base with the
+standard edition.
+
+The original source code of v4 is released under the Mozilla Public license
+v2.0 (see https://www.mozilla.org/MPL/) and other open source licenses. See the
+file "License.html" in the "Docs" directory of the repository for full licensing
+information.
+
+
+Bugs & Feature Requests
+================================================================================
+
+Please do report any bugs you find. Suggestions for new features are also
+welcomed.
+
+Both bug reports and feature requests are made using the GitHub issue tracker
+(GitHub account required). For details about using the issue tracker see
+https://github.com/delphidabbler/codesnip/blob/master/CONTRIBUTING.md#issues.
+
+
+FAQs
+================================================================================
+
+There are Frequently Asked Questions pages for CodeSnip on the web, at
+https://github.com/delphidabbler/codesnip-faq/blob/master/README.md
+
+
+Privacy
+================================================================================
+
+From v4.16.0 CodeSnip neither stores nor transmits any personally identifiable
+data.
+
+Do note though that CodeSnip can display web pages via your default web browser,
+but only in response to user input. No guarantee is made about any personal data
+collected by such web pages.
+
+
+Thanks
+================================================================================
+
+Thanks to:
+
++ David Mustard and Bill Miller for providing information that enabled me to add
+ Delphi 2007 and Delphi 2009 support, respectively, to the program.
+
++ geoffsmith82 and an anonymous contributor for information about getting
+ CodeSnip to work with Delphi XE2.
+
++ 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.
+
++ 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
+ if the Code Snippets Database has not been installed.
+
+
+================================================================================
diff --git a/Docs/ReadMe.txt b/Docs/ReadMe-standard.txt
similarity index 64%
rename from Docs/ReadMe.txt
rename to Docs/ReadMe-standard.txt
index b7806db53..5f5ea703f 100644
--- a/Docs/ReadMe.txt
+++ b/Docs/ReadMe-standard.txt
@@ -1,6 +1,6 @@
================================================================================
-DELPHIDABBLER CODESNIP v4 README
+DELPHIDABBLER CODESNIP v4 STANDARD EDITION README
================================================================================
@@ -14,30 +14,26 @@ 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 12 Athens
-and Free Pascal.
+with each installed Win32 version of Delphi from Delphi 2 to Delphi 12.x and
+Free Pascal.
Compilable Pascal units can be created that contain selected snippets.
-Features new to CodeSnip 4 are listed in the "What's New In CodeSnip 4" topic
-in the program's help file.
-
CodeSnip Editions
================================================================================
-There are two different editions of CodeSnip 4 available:
-
-+ The standard edition, which is installed on the user's computer using an
- installer and which records its presence in the registry and stores data in
- the system's application and user data directories.
+This document relates to the STANDARD edition of CodeSnip. This edition is
+installed on the user's computer using a standard Windows installer and which
+records its presence in the registry and stores data in the system's application
+and user data directories.
-+ The portable edition that can be run from any writeable removable storage
- medium (e.g. a USB memory stick) and that makes no changes to the host
- computer. This edition has no installer and is simply copied onto the required
- medium.
+There is also a portable edition of the program. This edition can be run from
+any writeable removable storage medium (e.g. a USB memory stick) or from any
+folder on the computer's hard disk. It makes no changes to the host computer.
+This edition has no installer and is simply copied to the required location.
-You can run both the standard and portable editions together on the same
+You can run both the portable and standard editions together on the same
computer and even run them at the same time. However, each edition maintains its
own settings and keeps its own copies of the snippets databases. To share user
defined snippets you must export them from one edition and import into the
@@ -48,18 +44,14 @@ Installation
================================================================================
CodeSnip requires Windows 2000 or later. It also requires MS Internet Explorer 6
-or later, although IE 8, 9 or 10 are strongly recommended. But note that recent
-releases have only been tested on Windows 10/11.
+or later, although IE 8, 9 or 10 are strongly recommended. Note that recent
+releases have only been tested on Windows 11.
-Installing the Standard Edition
--------------------------------
-
-You will need administrator privileges to run the setup program for the standard
-edition. If you are using a non-admin user account on Windows 2000 or XP you
-should run setup as administrator. By default Windows Vista to Windows 11 will
-require an admin password if running as a standard user and setup will attempt
-to elevate the process. If UAC prompts are disabled you must run setup as
-administrator.
+You will need administrator privileges to run the setup program. If you are
+using a non-admin user account on Windows 2000 or XP you should run setup as
+administrator. By default Windows Vista to Windows 11 will require admin
+privileges and setup will attempt to elevate the process if required. If UAC
+prompts are disabled you must run setup as administrator.
CodeSnip v4 will install alongside any v3 or earlier release that may already be
installed. If you want to replace the earlier version simply uninstall it in the
@@ -106,53 +98,15 @@ If you are updating to CodeSnip 4 from version 3 or earlier, CodeSnip will give
you the option of bringing forward your old settings and / or user defined
database. This happens the first time v4 is run for each user.
-Installing the Portable Edition
--------------------------------
-
-The portable edition of CodeSnip 4 is distributed in a zip file that contains
-the program executable, the help file and various documentation files.
-
-Install the program using the following steps:
-
-1) Mount any storage medium on which you want to install CodeSnip.
-
-2) Create a folder on the storage medium or on your computer's internal disk in
- which to copy the required files.
-
-3) Copy the files CodeSnip-p.exe (the executable program) and CodeSnip.chm
- (the help file) into the folder you created.
-
- CodeSnip does not need the other files included in the zip file in order to
- run, but you may find them useful. Copy them if you wish.
-
-Run the program by double clicking it. When it first runs it will create two
-sub-directories within the folder where you installed the program. These will
-be named AppData and UserData. Do not remove these directories or alter any of
-the contents. CodeSnip uses them to store configuration data along with your
-code snippets.
-
-No files are written outside the folder where you copied the files and the
-registry is not modified.
-
-** WARNING: When updating an existing portable installation with a new version
-of CodeSnip it is important that you do not change or delete the AppData and
-UserData folders. If you do this you risk loosing your settings and/or database.
-
Uninstallation
================================================================================
-Uninstalling the Standard Edition
----------------------------------
-
-CodeSnip can be uninstalled via "Installed Apps" (a.k.a. "Apps and Features",
-a.k.a. "Programs and Features", a.k.a. "Add / Remove Programs") accessed from the
-Windows Control Panel or by choosing "Uninstall DelphiDabbler CodeSnip" from the
-program's start menu group.
+CodeSnip can be uninstalled using your version of Windows' application
+uninstaller, run from Control Panel. Alternatively you can choose "Uninstall
+DelphiDabbler CodeSnip" from the program's start menu group.
-Administrator privileges will be required to uninstall CodeSnip. Windows Vista
-to Windows 11 with UAC prompts enabled will prompt for an admin password if
-necessary.
+Administrator privileges will be required to uninstall CodeSnip.
The uninstall program will delete any local copy of the online Code Snippets
database but will leave any user defined database, configuration data and
@@ -161,16 +115,6 @@ delete the %AppData%\DelphiDabbler\CodeSnip.4 directory and all its contents for
each user who ran CodeSnip. If any user has moved the user database directory
those directories also need to be deleted.
-Uninstalling the Portable Edition
----------------------------------
-
-Simply delete the folder where you installed CodeSnip, with all its contents.
-
-Be aware that any snippets you have created will be lost. If you want to keep
-them for use in another CodeSnip installation either export them or back up the
-user database before deleting the folder. See the help file for details of how
-to do this.
-
Downloading & Updating the Code Snippets Database
================================================================================
@@ -179,22 +123,19 @@ The online DelphiDabbler Code Snippets database is not installed with the
program.
CodeSnip's start-up screen shows details of any installed databases. If there is
-no copy of the online database a link is displayed that enables the database to
-be installed. This link opens the "Install or Update DelphiDabbler Snippets
-Database" wizard style dialogue box. The dialogue box explains how to download
-and install the database.
+no copy of the online database then a link is displayed that enables the
+database to be installed. This link opens the "Install or Update DelphiDabbler
+Snippets Database" wizard dialogue box. The dialogue box explains how to
+download and install the database.
You can download or update the database later by opening the same dialogue box
using the "Database | Install or Update DelphiDabbler Snippets Database" menu
option.
-Standard Edition Only
----------------------
-
-When installing the standard edition, the setup program will detect if an older
-database installation is present and will give the option to carry it forward.
-When setup completes it checks for the presence of the database and puts up a
-message if it is not present.
+During installation the setup program will detect if an older database version
+is present and will give the option to carry it forward. When setup completes it
+checks for the presence of the database and puts up a message if it is not
+present.
Database updates will apply to all users of the computer the next time they
start CodeSnip.
@@ -204,7 +145,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 12 Athens) and FreePascal,
+Windows 32 version of Delphi (from Delphi 2 to Delphi.x) and FreePascal,
providing some simple rules are followed.
When CodeSnip is first installed it knows nothing about the available compilers
@@ -235,7 +176,7 @@ Any type of snippet other than "freeform" can be test compiled.
Updating the Program
================================================================================
-Updates are published on GitHub. See
+Updates are published on GitHub. See
https://github.com/delphidabbler/codesnip/releases
News of new updates is published on the CodeSnip Blog:
@@ -288,7 +229,7 @@ DelphiDabbler Code Snippets Database or the user database, is used WITHOUT
WARRANTY OF ANY KIND, either express or implied. The code is used entirely at
the user's own risk.
-The snippets from the DelphiDabbler Code Snippets Database is open source. See
+The snippets from the DelphiDabbler Code Snippets Database are open source. See
the "About The Database" tab of the About dialogue box for details of the
applicable license. (You can display the About box from the "Help" menu.)
@@ -303,7 +244,8 @@ CodeSnip's source code is freely available. For details of how to obtain the
source see the FAQ at
https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-1
-The standard and portable editions of CodeSnip share the same source code.
+The standard edition of CodeSnip shares the same source code base with the
+portable edition.
The original source code of v4 is released under the Mozilla Public license
v2.0 (see https://www.mozilla.org/MPL/) and other open source licenses. See the
@@ -311,36 +253,15 @@ file "License.html" in the "Docs" directory of the repository for full licensing
information.
-Bugs
+Bugs & Feature Requests
================================================================================
-Please do report any bugs you find.
-
-Bugs are recorded in tracker software. View the reported and fixed bugs via
-https://github.com/delphidabbler/codesnip/issues (GitHub account required).
-
-You can also access the bug tracker from CodeSnip by using the "Tools | Report
-Bug Online" menu option then following the link that appears in the resulting
-dialogue box.
-
-If you wish to report a bug, please check the current reports on the bug
-tracker. If your bug hasn't already been reported or fixed please add a report
-using the "Add new" link on Tracker.
+Please do report any bugs you find. Suggestions for new features are also
+welcomed.
-Please ensure that you have installed the latest version of CodeSnip and checked
-if the bug is still present before reporting it.
-
-
-Feedback
-================================================================================
-
-If you want to suggest new features please use the feature request tracker
-accessed from https://github.com/delphidabbler/codesnip/issues (GitHub account
-required). Please check whether anyone else has requested something similar and
-add a comment to their request if so.
-
-Always check the latest version of CodeSnip before requesting a feature just in
-case it has already been implemented!
+Both bug reports and feature requests are made using the GitHub issue tracker
+(GitHub account required). For details about using the issue tracker see
+https://github.com/delphidabbler/codesnip/blob/master/CONTRIBUTING.md#issues.
FAQs
@@ -353,15 +274,12 @@ https://github.com/delphidabbler/codesnip-faq/blob/master/README.md
Privacy
================================================================================
-As of v4.16.0 CodeSnip no longer stores or transmits any personally identifiable
+From v4.16.0 CodeSnip neither stores nor transmits any personally identifiable
data.
-Because of this change the privacy statement that used to be provided with the
-program has been removed.
-
-Do note though that CodeSnip can display web pages via your default web
-browser, but only in response to user input. No guarantee is made about any
-personal data collected by such web pages.
+Do note though that CodeSnip can display web pages via your default web browser,
+but only in response to user input. No guarantee is made about any personal data
+collected by such web pages.
Thanks
From 7f2f758efc9ef2785c51a92a0cee0c266ac330fe Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 13:09:29 +0100
Subject: [PATCH 02/23] Release different ReadMe.txt for standard & portable
Makefile updated to copy appropriate ReadMe-portable.txt or
ReadMe-standard.txt as ReadMe.txt to release zip files for portable and
standard edition builds respectively.
Made similar changes to Inno Setup script to copy ReadMe-standard.txt
as ReadMe.txt into the install program.
Both versions of ReadMe.txt were temporarily stored in new
_build\release\~tmp~ directory.
---
Src/Install/CodeSnip.iss | 3 ++-
Src/Makefile | 16 +++++++++++++---
2 files changed, 15 insertions(+), 4 deletions(-)
diff --git a/Src/Install/CodeSnip.iss b/Src/Install/CodeSnip.iss
index 47a85f471..3e154e1d0 100644
--- a/Src/Install/CodeSnip.iss
+++ b/Src/Install/CodeSnip.iss
@@ -29,6 +29,7 @@
#define SrcDocsPath SourcePath + "..\..\Docs\"
#define SrcAssetsPath SourcePath + "\Assets\"
#define SrcExePath SourcePath + "..\..\_build\exe\"
+#define TmpPath SourcePath + "..\..\_build\release\~tmp~\"
#define ProgDataSubDir AppName + ".4"
#define ExeProg SrcExePath + ExeFile
#define AppVersion DeleteToVerStart(GetFileProductVersion(ExeProg))
@@ -89,7 +90,7 @@ Name: {commonappdata}\{#AppPublisher}\{#ProgDataSubDir}\Database; permissions: e
Source: {#SrcExePath}{#ExeFile}; DestDir: {app}
Source: {#SrcExePath}{#HelpFile}; DestDir: {app}; Flags: ignoreversion
Source: {#SrcDocsPath}{#LicenseTextFile}; DestDir: {app}; Flags: ignoreversion
-Source: {#SrcDocsPath}{#ReadMeFile}; DestDir: {app}; Flags: ignoreversion
+Source: {#TmpPath}{#ReadMeFile}; DestDir: {app}; Flags: ignoreversion
Source: {#SrcAssetsPath}UpdatingPreview.rtf; Flags: dontcopy
[Icons]
diff --git a/Src/Makefile b/Src/Makefile
index 17b443abf..ce6cb8cf8 100644
--- a/Src/Makefile
+++ b/Src/Makefile
@@ -12,12 +12,15 @@ BUILD_ROOT = _build
BIN_ROOT = $(BUILD_ROOT)\bin
EXE_ROOT = $(BUILD_ROOT)\exe
RELEASE_ROOT = $(BUILD_ROOT)\release
+RELEASE_TMP_ROOT = $(RELEASE_ROOT)\~tmp~
DOCS_ROOT = Docs
SRC_ROOT = Src
# Defines macros giving directories relative to location of the Makefile
BIN_REL = ..\$(BIN_ROOT)
EXE_REL = ..\$(EXE_ROOT)
+DOCS_REL = ..\$(DOCS_ROOT)
+RELEASE_TMP_REL = ..\$(RELEASE_TMP_ROOT)
# Check for required environment variables
@@ -115,6 +118,7 @@ config:
@mkdir $(BIN_ROOT)
@if not exist $(EXE_ROOT) mkdir $(EXE_ROOT)
@if not exist $(RELEASE_ROOT) mkdir $(RELEASE_ROOT)
+ @if not exist $(RELEASE_TMP_ROOT) mkdir $(RELEASE_TMP_ROOT)
@cd $(SRC_ROOT)
# Builds CodeSnip pascal files and links program
@@ -160,8 +164,10 @@ typelib:
# Builds setup program
setup:
!ifndef PORTABLE
- @del $(EXE_REL)\CodeSnip-Setup-*
+ copy $(DOCS_REL)\ReadMe-standard.txt $(RELEASE_TMP_REL)\ReadMe.txt
+ del $(EXE_REL)\CodeSnip-Setup-*
@$(ISCC) Install\CodeSnip.iss
+ del $(RELEASE_TMP_REL)\ReadMe.txt
!else
@echo **** Portable build - no setup file created ****
!endif
@@ -195,12 +201,16 @@ release:
@cd ..
-@if exist $(OUTFILE) del $(OUTFILE)
!ifndef PORTABLE
- @$(ZIP) -j -9 $(OUTFILE) $(EXE_ROOT)\CodeSnip-Setup-*.exe $(DOCS_ROOT)\ReadMe.txt
+ copy $(DOCS_ROOT)\ReadMe-standard.txt $(RELEASE_TMP_ROOT)\ReadMe.txt
+ @$(ZIP) -j -9 $(OUTFILE) $(EXE_ROOT)\CodeSnip-Setup-*.exe $(RELEASE_TMP_ROOT)\ReadMe.txt
+ del $(RELEASE_TMP_ROOT)\ReadMe.txt
!else
+ copy $(DOCS_ROOT)\ReadMe-portable.txt $(RELEASE_TMP_ROOT)\ReadMe.txt
@$(ZIP) -j -9 $(OUTFILE) $(EXE_ROOT)\CodeSnip-p.exe
@$(ZIP) -j -9 $(OUTFILE) $(EXE_ROOT)\CodeSnip.chm
- @$(ZIP) -j -9 $(OUTFILE) $(DOCS_ROOT)\ReadMe.txt
+ @$(ZIP) -j -9 $(OUTFILE) $(RELEASE_TMP_ROOT)\ReadMe.txt
@$(ZIP) -j -9 $(OUTFILE) $(DOCS_ROOT)\License.html
+ del $(RELEASE_TMP_ROOT)\ReadMe.txt
!endif
@cd $(SRC_ROOT)
From dc7cb79e3c82c94a6e8526949c73fec5957c01e3 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 14:49:25 +0100
Subject: [PATCH 03/23] Update copyright date in header comments
---
Src/Install/CodeSnip.iss | 2 +-
Src/Makefile | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Src/Install/CodeSnip.iss b/Src/Install/CodeSnip.iss
index 3e154e1d0..229db969a 100644
--- a/Src/Install/CodeSnip.iss
+++ b/Src/Install/CodeSnip.iss
@@ -2,7 +2,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) 2006-2022, Peter Johnson (gravatar.com/delphidabbler).
+; Copyright (C) 2006-2024, Peter Johnson (gravatar.com/delphidabbler).
;
; Install file generation script for use with Inno Setup.
diff --git a/Src/Makefile b/Src/Makefile
index ce6cb8cf8..b8b69e3b5 100644
--- a/Src/Makefile
+++ b/Src/Makefile
@@ -2,7 +2,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) 2009-2022, Peter Johnson (gravatar.com/delphidabbler).
+# Copyright (C) 2009-2024, Peter Johnson (gravatar.com/delphidabbler).
#
# Makefile for the CodeSnip project.
From bcaf6cc90084ff19a45480904d4227dccab4ea90 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 15:08:59 +0100
Subject: [PATCH 04/23] Update Build.html re changes per issue #127
Updated re change from using single ReadMe.txt to using a version of the
files for each edition.
Made some other changes for clarity.
---
Build.html | 23 +++++++++++++++++------
1 file changed, 17 insertions(+), 6 deletions(-)
diff --git a/Build.html b/Build.html
index fc6947166..0f96ec05e 100644
--- a/Build.html
+++ b/Build.html
@@ -723,9 +723,13 @@
- The release file for the standard edition of CodeSnip includes the
- setup file along with ReadMe.txt from the Docs
- directory. Both files must exist.
+ The release zip file for the standard edition requires that the setup files is already
+ present in the _build/exe directory.
+
+
+
+ The release file includes the setup file along with ReadMe.txt
+ that is automatically generated from Docs/ReadMe-standard.txt.
@@ -752,9 +756,16 @@
- The release file for the portable edition includes the portable executable
- file, CodeSnip-p.exe, the help file CodeSnip.chm and
- several files from the Docs directory. All must be present.
+ The release zip file for the portable edition cannot be created until the
+ CodeSnip excutable and the compiled help file are already present in the
+ _build\exe directory.
+
+
+
+ The release file includes the portable executable file, CodeSnip-p.exe,
+ the help file CodeSnip.chm, Docs/License.html and
+ ReadMe.txt that is automatically generated from
+ Docs/ReadMe-portable.txt.
From 4e120754407cde6a4124e6ff0a85b979e933c3b3 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 15:46:38 +0100
Subject: [PATCH 05/23] Add Deploy.bat
Deployment script that creates release zip files for both editions of
CodeSnip and includes the version number passed on command line in zip
file names.
Fixes #128
---
Deploy.bat | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 99 insertions(+)
create mode 100644 Deploy.bat
diff --git a/Deploy.bat b/Deploy.bat
new file mode 100644
index 000000000..23d95a425
--- /dev/null
+++ b/Deploy.bat
@@ -0,0 +1,99 @@
+:: This Source Code Form is subject to the terms of the Mozilla Public License,
+:: 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) 2024, Peter Johnson (gravatar.com/delphidabbler).
+::
+:: Deploy script for CodeSnip.
+::
+:: This script compiles release versions of the standard and portable editions
+:: of CodeSnip and places them into two different zip files ready for release.
+::
+:: This script uses Embarcadero Make. Various other programs are required to
+:: run Make. See Src/Makefile for details.
+::
+:: To use the script:
+:: 1) Set the environment variables required for Make to succeed. See
+:: Src/Makefile for details
+:: 2) Change directory to that where this script is located.
+:: 3) Run the script.
+::
+:: Usage:
+:: Deploy
+:: where
+:: is the version number of the release, e.g. 0.5.3-beta or 1.2.0.
+
+@echo off
+
+setlocal
+
+:: Check for required parameter
+if "%1"=="" goto paramerror
+
+:: Store parameter
+set Version=%1
+
+:: Store common make parameters
+set CommonParams=-DVERSION=%Version%
+
+:: Store standard edition make parameters
+set StandardParams=%CommonParams%
+
+:: Store portable edition make parameters
+set PortableParams=-DPORTABLE %CommonParams%
+
+:: Set command line
+set MakeCmd=Make
+set StandardMakeCmd=%MakeCmd% %StandardParams%
+set PortableMakeCmd=%MakeCmd% %PortableParams%
+
+echo ----------------------------------------------
+echo Deploying CodeSnip Standard And Portable Builds
+echo -----------------------------------------------
+echo.
+echo Standard edition Make command: %StandardMakeCmd%
+echo Portable edition Make command: %PortableMakeCmd%
+
+cd Src
+
+echo.
+echo.
+echo.
+echo =========================
+echo Building Standard edition
+echo =========================
+echo.
+echo.
+%StandardMakeCmd%
+
+echo.
+echo.
+echo.
+echo =========================
+echo Building Portable edition
+echo =========================
+echo.
+echo.
+%PortableMakeCmd%
+
+echo.
+echo.
+echo.
+echo ====================
+echo Deployment completed
+echo ====================
+
+goto end
+
+:: Error messages
+
+:paramerror
+echo.
+echo ***ERROR: Please specify a version number as a parameter
+echo.
+goto end
+
+:: End
+:end
+
+endlocal
From b52c7853ee4baed649c3c43875db84bbbabc5b80 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Wed, 3 Apr 2024 23:47:51 +0100
Subject: [PATCH 06/23] Change README.md re use per-edition ReadMe.txt files
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 8672ddf64..3787b2439 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ CodeSnip can import code from the DelphiDabbler [Code Snippets Database](https:/
The standard edition of CodeSnip is installed and removed using a Windows installer. Administrator privileges are required for installation.
-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.
+The portable edition has no installer. Simply follow the instructions in the [read me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe-portable.txt) that is included in the download.
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.
@@ -33,14 +33,14 @@ The program _should_ run on Windows 2000, with Internet Explorer 6 or later, alt
The following support is available to CodeSnip users:
* A comprehensive help file.
-* A [read-me file](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe.txt) that discusses installation, configuration, updating and known issues. [^1]
+* A read-me file that discusses installation, configuration, updating and known issues. There are different versions of this file for each edition of CodeSnip: one for the [standard edition](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe-standard.txt) and another for the [portable edition](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/ReadMe-portable.txt). [^1]
* The [Using CodeSnip FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md).
* The [CodeSnip Blog](https://codesnip-app.blogspot.co.uk/).
* CodeSnip's own [Web Page](https://delphidabbler.com/software/codesnip).
There's also plenty of info available on how to compile CodeSnip from source - see below.
-> [^1]: The linked read-me file is the most recent version. It can change from release to release.
+> [^1]: The linked read-me file is the most recent version. It can change from release to release.
## Source Code
From 101592fb8af64b1be9fa85b8d93d2c597fd28a1c Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Thu, 4 Apr 2024 00:41:32 +0100
Subject: [PATCH 07/23] Update Build.html re addition of Deploy.bat script
Also fixed some errors and inconsistencies and tweaked some content.
---
Build.html | 58 ++++++++++++++++++++++++++++++++++++++++++------------
1 file changed, 45 insertions(+), 13 deletions(-)
diff --git a/Build.html b/Build.html
index 0f96ec05e..ba8a9086f 100644
--- a/Build.html
+++ b/Build.html
@@ -6,7 +6,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) 2009-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2009-2024, Peter Johnson (gravatar.com/delphidabbler).
*
* Instructions for building CodeSnip from source.
-->
@@ -513,12 +513,14 @@
| +-- exe - receives executable code and compiled help file
| |
| +-- release - receives release files
+ | |
+ | +-- ~tmp~ - store for temp files ceated in release process
|
...
If the _build/bin folder already existed, it will have been emptied.
- In addition, Make will have created a .cfg file from
+ In addition, Make will have created a .cfg file from a
template in the Src folder. This .cfg file is needed
for DCC32 to run correctly. The file will be ignored by Git.
@@ -580,7 +582,7 @@
You have several options:
-
+
Build the CodeSnip Executable
@@ -599,10 +601,10 @@
Clean Up.
-
+
- Each of these options is described below. All except the last assume that
+ Each of these options is described below. All except options 5 and 6 assume that
Make config has been run.
@@ -648,7 +650,7 @@
> Make -DPORTABLE codesnip
- Again the executable is placed in the _build/exe folder, but this time
+ Again the executable is placed in the _build\exe folder, but this time
it is named CodeSnip-p.exe
@@ -665,12 +667,17 @@
The compiled help file will be written to the _build\exe folder.
+
+
+ The same help file is used for the standard and portable editions.
+
+
Build the Setup Program
- The setup program requires that the CodeSnip excutable and the
+ The setup program requires that the CodeSnip executable and the
compiled help file are already present in the _build\exe directory.
@@ -690,7 +697,7 @@
The setup program is named CodeSnip-Setup-x.x.x.exe, where
x.x.x is the version number extracted from CodeSnip's version
- information. It is placed in the _build/exe directory.
+ information. It is placed in the _build\exe directory.
@@ -715,7 +722,7 @@
Make can create zip files containing all the files that are included in a release.
- Zip files are written to the _build/release directory.
+ Zip files are written to the _build\release directory.
@@ -724,12 +731,12 @@
The release zip file for the standard edition requires that the setup files is already
- present in the _build/exe directory.
+ present in the _build\exe directory.
The release file includes the setup file along with ReadMe.txt
- that is automatically generated from Docs/ReadMe-standard.txt.
+ that is automatically generated from Docs\ReadMe-standard.txt.
@@ -763,9 +770,9 @@
The release file includes the portable executable file, CodeSnip-p.exe,
- the help file CodeSnip.chm, Docs/License.html and
+ the help file CodeSnip.chm, Docs\License.html and
ReadMe.txt that is automatically generated from
- Docs/ReadMe-portable.txt.
+ Docs\ReadMe-portable.txt.
@@ -855,6 +862,31 @@
zip file names can be used here too.
+
+ There is also a quicker way to build a release, but you must provide a version number to use it. First navigate up
+ to the repository root. Then run
+
+
+
> Deploy 9.9.9
+
+
+ where 9.9.9 is the release version number.
+
+
+
+ This command will build both the standard and portable executables, the help file, the standard edition setup file
+ and finally create the release zip files for both editions, with the release version number incorporated in the file names.
+
+
+
+ Using Deploy 9.9.9 is the equivalent of doing:
+
+
+
> cd Src
+> Make -DVERSION=9.9.9
+> Make -DPORTABLE -DVERSION=9.9.9
+> cd ..
+
Clean Up
From b38d5fe1ff81e7bc7a767e22bc7141b1c641efa3 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Thu, 4 Apr 2024 01:01:05 +0100
Subject: [PATCH 08/23] Update 3rd party PJSysInfo unit to v5.27.0
Fixes #126
---
Src/3rdParty/PJSysInfo.pas | 348 +++++++++++++++++++++++++------------
1 file changed, 241 insertions(+), 107 deletions(-)
diff --git a/Src/3rdParty/PJSysInfo.pas b/Src/3rdParty/PJSysInfo.pas
index efd2c4de6..88f726505 100644
--- a/Src/3rdParty/PJSysInfo.pas
+++ b/Src/3rdParty/PJSysInfo.pas
@@ -3,7 +3,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) 2001-2023, Peter Johnson (https://gravatar.com/delphidabbler).
+ * Copyright (C) 2001-2024, Peter Johnson (https://gravatar.com/delphidabbler).
*
* This unit contains various static classes, constants, type definitions and
* global variables for use in providing information about the host computer and
@@ -21,8 +21,12 @@
* 3: When run on operating systems up to and including Windows 8 running the
* host program in compatibility mode causes some variables and TPJOSInfo
* methods to be "spoofed" into returning information about the emulated
- * OS. When run on Windows 8.1 and later details of the actual host
- * operating system are always returned and the emulated OS is ignored.
+ * OS. When run on Windows 8.1 details of the actual host operating system
+ * are always returned and the emulated OS is ignored.
+ *
+ * 4: On Windows 10 and later the correct operating system will only be
+ * reported if the application declares the operating systems it supports
+ * in its manifest.
*
* ACKNOWLEDGEMENTS
*
@@ -1226,11 +1230,12 @@ TBuildNameMap = record
https://en.wikipedia.org/wiki/Windows_NT
https://en.wikipedia.org/wiki/Windows_10_version_history
https://en.wikipedia.org/wiki/Windows_11_version_history
+ https://blogs.windows.com/windows-insider/tag/windows-insider-program/
https://en.wikipedia.org/wiki/Windows_Server
https://en.wikipedia.org/wiki/Windows_Server_2019
https://en.wikipedia.org/wiki/Windows_Server_2016
+ https://en.wikipedia.org/wiki/Windows_Server_2022
https://tinyurl.com/y8tfadm2 (MS Windows Server release information)
- https://tinyurl.com/usupsz4a (Win 11 Version Numbers & Build Versions)
https://docs.microsoft.com/en-us/lifecycle/products/windows-server-2022
https://tinyurl.com/yj5e72jt (MS Win 10 release info)
https://tinyurl.com/kd3weeu7 (MS Server release info)
@@ -1239,6 +1244,10 @@ TBuildNameMap = record
For Vista and Win 7 we have to add service pack number to these values to
get actual build number. For Win 8 onwards we just use the build numbers
as is.
+
+ References:
+ [^1] MS community blog post https://tinyurl.com/3c8e3hsc
+ [^2] https://en.wikipedia.org/wiki/Windows_11_version_history
}
{
@@ -1267,24 +1276,30 @@ TBuildNameMap = record
// Windows 10 ----------------------------------------------------------------
- // Version 1507 previews
- // Preview builds with major/minor version number 6.4
- Win10_6point4Builds: array[0..2] of Integer = (9841, 9860, 9879);
- // Preview builds with major/minor version number 10.0
- Win10_1507_Preview_Builds: array[0..10] of Integer = (
- 9926, 10041, 10049, 10061, 10074, 10122, 10130, 10158, 10159, 10162, 10166
- );
+ // Version 1507 preview builds
+ // Preview builds with major/minor version number 6.4
+ // Expired by 2015-04-30 [^1]:
+ // 9841, 9860, 9879
+ // Preview builds with major/minor version number 10.0
+ // Expired by 2015-10-15 [^1]:
+ // 9926, 10041, 10049, 10061, 10074, 10122, 10130, 10158, 10159, 10162,
+ // 10166
- // Version 1511 previews
- Win10_1511_Preview_Builds: array[0..4] of Integer = (
- 10525, 10532, 10547, 10565, 10576
- );
+ // Version 1511 preview builds
+ // Expired by 2016-07-30 [^1]:
+ // 10525, 10532, 10547, 10565, 10576
// Version 1607 previews
- Win10_1607_Preview_Builds: array[0..24] of Integer = (
- 11082, 11099, 11102, 14251, 14257, 14271, 14279, 14291, 14295, 14316,
- 14328, 14332, 14342, 14352, 14361, 14366, 14367, 14371, 14372, 14376,
- 14379, 14383, 14385, 14388, 14390
+ Win10_1607_Preview_Builds: array[0..5] of Integer = (
+ // Expired 2016-07-30 [^1]:
+ // 11082, 11099
+ // Expired 2016-08-01 [^1]:
+ // 11102, 14251, 14257, 14267, 14271, 14279, 14291, 14295, 14316, 14328,
+ // 14332, 14342, 14352, 14361
+ // Expired 2016-10-15 [^1]:
+ // 14366, 14367, 14371, 14372,
+ 14376, 14379, 14383, 14385, // unknown expiry date [^1]
+ 14388, 14390 // permanently activated [^1]
);
// Version 1703 previews
@@ -1349,7 +1364,7 @@ TBuildNameMap = record
);
{
- End of support information for Windows 10 versions (as of 2022-12-31).
+ End of support information for Windows 10 versions (as of 2023-05-01).
GAC = General Availablity Channel.
LTSC = Long Term Support Channel.
@@ -1365,10 +1380,10 @@ TBuildNameMap = record
1903 | ended | N/a
1909 | ended | N/a
2004 | ended | N/a
- 20H2 | 2023-09-05 | N/a
+ 20H2 | ended | N/a
21H1 | ended | N/a
21H2 | 2024-06-11 | 2032-01-13
- 22H2 | 2025-05-13 | N/a
+ 22H2 | 2025-10-14 | N/a
}
// Map of Win 10 builds from 1st release (version 1507) to version 20H2
@@ -1397,7 +1412,7 @@ TBuildNameMap = record
Name: 'Version 1909: November 2019 Update'),
(Build: 19041; LoRev: 264; HiRev: 1415;
Name: 'Version 2004: May 2020 Update'),
- (Build: 19042; LoRev: 572; HiRev: MaxInt;
+ (Build: 19042; LoRev: 572; HiRev: 2965;
Name: 'Version 20H2: October 2020 Update')
);
@@ -1430,6 +1445,7 @@ TBuildNameMap = record
--------|------------|------------
21H2 | 2023-10-10 | 2024-10-08
22H2 | 2024-10-08 | 2025-10-14
+ 23H2 | 2025-11-11 | 2026-11-10
}
// 1st build released branded as Windows 11
@@ -1445,50 +1461,93 @@ TBuildNameMap = record
// various other channels.
// See **REF1** in implementation
Win11v22H2Build = 22621;
- // Build 22632 was added as an alternative Beta channel build as of rev 290.
+
+ // Windows 11 version 22H3
+ // See **REF10** in implementation
+ Win11v23H2Build = 22631;
+
+ // "Preview Builds of October 2022 component update in Beta Channel"
// See **REF2** in implementation
- Win11v22H2BuildAlt = 22622;
-
- // Windows 11 Dev channel releases (with version string "Dev").
- // For details see https://en.wikipedia.org/wiki/Windows_11_version_history
- Win11DevChannelDevBuilds: array[0..25] of Integer = (
- // pre Win 11 release (expired 2021/10/31):
- // 22449, 22454, 22458, 22463,
- // pre Win 11 release (expired 2022/09/15):
- // 22468,
- // post Win 11 release, pre Win 11 22H2 beta release (expired 2022/09/15):
- // 22471, 22478, 22483, 22489, 22494, 22499, 22504, 22509, 22518, 22523,
- // 22526, 22533, 22538, 22543, 22557, 22563,
- // post Win 11 22H2 beta release (expired 2022/09/15):
+ Win11Oct22ComponentBetaChannelBuild = 22622;
+
+ // "Preview Builds of February 2023 component update in Beta Channel"
+ // See **REF7** in implementation
+ Win11Feb23ComponentBetaChannelBuild = 22623;
+
+ // "Preview builds of May 2023 component update in Beta Channel"
+ // See **REF8** in implementation
+ Win11May23ComponentBetaChannelBuild = 22624;
+
+ // "Preview builds of future component update in Beta Channel"
+ // See **REF9** in implementation
+ Win11FutureComponentBetaChannelBuild = 22635;
+
+ // Windows 11 Dev channel releases with version string "Dev" [^2]
+ // pre Win 11 release (expired 2021/10/31):
+ // 22449, 22454, 22458, 22463,
+ // pre Win 11 release (expired 2022/09/15):
+ // 22468,
+ // post Win 11 release, pre Win 11 22H2 beta release (expired 2022/09/15):
+ // 22471, 22478, 22483, 22489, 22494, 22499, 22504, 22509, 22518, 22523,
+ // 22526, 22533, 22538, 22543, 22557, 22563,
+
+ // Windows 11 Dev channel releases with version string "22H2" [^2]
+ Win1122H2DevChannelDevBuilds: array[0..20] of Integer = (
+ // expired 2022/09/15 (pre Win 11 22H2 beta release):
+ // 22567, 22572, 22579
+ // expired 2022/09/15 (post Win 11 22H2 beta release):
// 25115, 25120, 25126, 25131, 25136, 25140, 25145, 25151, 25158, 25163,
// 25169, 25174, 25179,
- // post Win 11 22H2 beta release (expiring 2023/09/15):
- 25182, 25188, 25193, 25197, 25201, 25206, 25211,
- // post Win 11 22H2 release (expiring 2023/09/15):
- 25217, 25227, 25231, 25236, 25247, 25252, 25262, 25267, 25272, 25276, 25281,
- 25284, 25290, 25295, 25300, 25309, 23403, 23419, 23424
+ // expired 2023/09/15 (post Win 11 22H2 beta release):
+ // 25182, 25188, 25193, 25197, 25201, 25206, 25211,
+ // expired 2023/09/15 (post Win 11 22H2 release):
+ // 25217, 25227, 25231, 25236, 25247, 25252, 25262, 25267, 25272, 25276,
+ // 25281, 25284, 25290, 25295, 25300, 25309, 23403, 23419, 23424, 23430,
+ // 23435, 23440, 23451, 23466, 23471, 23475, 23481, 23486, 23493, 23506,
+ // 23511, 23516, 23521,
+ // expiring 2024-09-15:
+ 23526, 23531, 23536, 23541, 23545, 23550, 23555, 23560, 23565, 23570, 23575,
+ 23580, 23585, 23590, 23595, 23601, 23606, 23612, 23615, 23619, 23620
+ );
+
+ // Win 11 Dev channel releases with version string "24H2" [^2]
+ Win1124H2DevChannelDevBuilds: array[0..4] of Integer = (
+ // expiring 2024-09-15:
+ 26052, 26058, 26080, 26085, 26090
);
- // Preview builds of Windows 11 in the Canary Channel
- // For details see https://en.wikipedia.org/wiki/Windows_11_version_history
- Win11CanaryPreviewBuilds: array[0..2] of Integer = (
- // expiring 2023/09/15:
- 25314, 25324, 25330
+ // Preview builds of Windows 11 in the Canary Channel with version string
+ // "22H2" [^2]
+ // (expired 2023-09-15):
+ // 25314, 25324, 25330, 25336, 25346, 25352, 25357, 25370,
+
+ // Preview builds of Windows 11 in the Canary Channel with version string
+ // "23H2" [^2]
+ Win11Canary23H2PreviewBuilds: array[0..15] of Integer = (
+ // expired 2023-09-15:
+ // 25375, 25381, 25387, 25393, 25905, 25915, 25921, 25926,
+ // expires 2024-09-15:
+ 25931, 25936, 25941, 25947, 25951, 25967, 25977, 25982, 25987, 25992, 25997,
+ 26002, 26010, 26016, 26020, 26040
);
- // Windows 11 Dev channel builds with version string "22H2"
- // expired 2022/09/15):
- // 22567, 22572, 22579
+ // Preview builds of Windows 11 in the Canary Channel with version string
+ // "24H2" [^2]
+ Win11Canary24H2PreviewBuilds: array[0..5] of Integer = (
+ // expires 2024-09-15:
+ 26052, 26058, 26063, 26080, 26085,
+ // expiry date unknown
+ 26090
+ );
- // Windows 11 Dev & Beta channel builds with version string "22H2"
+ // Windows 11 Dev & Beta channel builds with version string "22H2" [^2]
Win11DevBetaChannels22H2Builds: array[0..1] of Integer = (
- // expired 2022/09/15: 22581, 22593, 22598,
+ // Expired 2022/09/15:
+ // 22581, 22593, 22598
+ // Unknown expiry date:
22610, 22616
);
- Win11Feb23ComponentBetaChannelBuild = 22623;
- Win11FutureComponentBetaChannelBuild = 22624;
-
Win11FirstBuild = Win11DevBuild; // First build number of Windows 11
// Windows server v10.0 version ----------------------------------------------
@@ -2006,6 +2065,13 @@ procedure InitPlatformIdEx;
);
end;
+ // Append "Moment N" to InternalExtraUpdateInfo
+ procedure AppendMomentToInternalExtraUpdateInfo(N: Cardinal);
+ begin
+ InternalExtraUpdateInfo := InternalExtraUpdateInfo
+ + ' Moment ' + IntToStr(N);
+ end;
+
begin
// Load version query functions used externally to this routine
VerSetConditionMask := LoadKernelFunc('VerSetConditionMask');
@@ -2073,17 +2139,6 @@ procedure InitPlatformIdEx;
// Windows 2016 Server tech preview 1
InternalBuildNumber := Win2016TP1Build;
InternalExtraUpdateInfo := 'Technical Preview 6';
- end
- else
- begin
- if FindBuildNumberFrom(
- Win10_6point4Builds, InternalBuildNumber
- ) then
- // Early Win 10 preview builds report v6.4, not v10.0
- InternalExtraUpdateInfo := Format(
- 'Version 1507 Preview v6.4.%d.%d',
- [InternalBuildNumber, InternalRevisionNumber]
- )
end;
end;
if Win32ServicePackMajor > 0 then
@@ -2150,11 +2205,13 @@ procedure InitPlatformIdEx;
1288, 1348, 1387, 1415, 1466, 1469, 1503, 1526, 1566, 1586,
1620, 1645, 1682, 1706, 1708, 1741, 1766, 1767, 1806, 1826,
1865, 1889, 1949, 2006, 2075, 2130, 2132, 2193, 2194, 2251,
- 2311, 2364, 2486, 2546, 2604, 2673, 2728, 2788 .. MaxInt:
+ 2311, 2364, 2486, 2546, 2604, 2673, 2728, 2788, 2846, 2965,
+ 3086, 3208, 3324, 3448, 3570, 3693, 3803, 3930, 4046,
+ 4170 .. MaxInt:
InternalExtraUpdateInfo := 'Version 21H2';
1147, 1149, 1151, 1165, 1200, 1202, 1237, 1263, 1266, 1319,
- 1320, 1379, 1381, 1499, 1618, 1679, 1737, 1739, 1862, 1947,
- 2192, 2545:
+ 1320, 1379, 1381, 1499, 1618, 1679, 1737, 1739, 1862,
+ 1947, 2192, 2545:
InternalExtraUpdateInfo := Format(
'Version 21H2 [Release Preview Channel v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
@@ -2172,16 +2229,19 @@ procedure InitPlatformIdEx;
InternalBuildNumber := Win1022H2Build;
case InternalBuildNumber of
2006, 2130, 2132, 2193, 2194, 2251, 2311, 2364, 2486, 2546,
- 2604, 2673, 2728, 2788 .. MaxInt:
+ 2604, 2673, 2728, 2788, 2846, 2913, 2965, 3031, 3086, 3208,
+ 3271, 3324, 3393, 3448, 3516, 3570, 3636, 3693, 3758, 3803,
+ 3930, 3996, 4046, 4123, 4170, 4239 .. MaxInt:
InternalExtraUpdateInfo := 'Version 22H2';
- 1865, 1889, 1949, 2075, 2301, 2670, 2787:
+ 1865, 1889, 1949, 2075, 2301, 2670, 2787, 2908, 3030, 3154,
+ 3155, 3269, 3391, 3513, 3754, 3757, 3992, 4116, 4233, 4235:
InternalExtraUpdateInfo := Format(
'Version 22H2 [Release Preview Channel v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
else
InternalExtraUpdateInfo := Format(
- 'Version 22H1 [Unknown release v10.0.%d.%d]',
+ 'Version 22H2 [Unknown release v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
end;
@@ -2209,7 +2269,9 @@ procedure InitPlatformIdEx;
194, 258, 282, 348, 376, 434, 438, 469, 493, 527, 556, 593, 613,
652, 675, 708, 739, 740, 778, 795, 832, 856, 918, 978, 1042,
1098, 1100, 1165, 1219, 1281, 1335, 1455, 1516, 1574, 1641,
- 1696, 1761 .. MaxInt:
+ 1696, 1761, 1817, 1880, 1936, 2003, 2057, 2124, 2176, 2245,
+ 2295, 2360, 2416, 2482, 2538, 2600, 2652, 2713, 2777,
+ 2836 .. MaxInt:
// Public releases of Windows 11
InternalExtraUpdateInfo := 'Version 21H2';
51, 65, 71:
@@ -2228,9 +2290,10 @@ procedure InitPlatformIdEx;
+ '[Beta & Release Preview Channels v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
- 651, 706, 776, 829, 917, 1041, 1163, 1279, 1515, 1639, 1757:
+ 651, 706, 776, 829, 917, 1041, 1163, 1279, 1515, 1639, 1757,
+ 1879, 2001, 2121, 2243, 2359, 2479:
InternalExtraUpdateInfo := Format(
- 'Version 21H1 Release Preview Channel v10.0.%d.%d]',
+ 'Version 21H2 Release Preview Channel v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
else
@@ -2246,21 +2309,35 @@ procedure InitPlatformIdEx;
InternalBuildNumber := Win11v22H2Build;
case InternalRevisionNumber of
382, 521, 525, 608, 674, 675, 755, 819, 900, 963, 1105, 1194,
- 1265, 1344, 1413, 1485, {placeholder->}1538 .. MaxInt:
+ 1265, 1344, 1413, 1485, 1555, 1635, 1702, 1778, 1848, 1926,
+ 1928, 1992, 2070, 2134, 2215, 2283, 2361, 2428, 2506, 2715,
+ 2792, 2861, 3007, 3085, 3155, 3235, 3296, 3374 .. MaxInt:
+ begin
InternalExtraUpdateInfo := 'Version 22H2';
+ case InternalRevisionNumber of
+ 675: AppendMomentToInternalExtraUpdateInfo(1);
+ 1344: AppendMomentToInternalExtraUpdateInfo(2);
+ 1778: AppendMomentToInternalExtraUpdateInfo(3);
+ 2361: AppendMomentToInternalExtraUpdateInfo(4);
+ 3235: AppendMomentToInternalExtraUpdateInfo(5);
+ end;
+ end;
1:
InternalExtraUpdateInfo := Format(
'Version 22H2 [Beta & Release Preview v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
- 105, 169, 232, 317, 457, 607, 754, 898, 1192, 1343, 1483:
+ 105, 169, 232, 317, 457, 607, 754, 898, 1192, 1343, 1483, 1631,
+ 1776, 2066, 2213, 2359, 2500, 2787, 3078, 3227, 3371:
InternalExtraUpdateInfo := Format(
'Version 22H2 [Release Preview v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
);
160, 290, 436, 440, 450, 575, 586, 590, 598, 601, 730, 741, 746,
870, 875, 885, 891, 1020, 1028, 1037, 1095, 1180, 1245, 1250,
- 1255, 1325, 1391, 1465, 1470, 1537:
+ 1255, 1325, 1391, 1465, 1470, 1537, 1546, 1616, 1680, 1690,
+ 1755, 1825, 1830, 1835, 1900, 1906, 1972, 2048, 2050, 2115,
+ 2129, 2191, 2199, 2262, 2265, 2271, 2338:
InternalExtraUpdateInfo := Format(
'Version 22H2 [Beta v10.0.%d.%d]',
[InternalBuildNumber, InternalRevisionNumber]
@@ -2272,11 +2349,40 @@ procedure InitPlatformIdEx;
);
end;
end
- else if IsBuildNumber(Win11v22H2BuildAlt) then
+ else if IsBuildNumber(Win11v23H2Build) then
+ begin
+ // **REF10**
+ InternalBuildNumber := Win11v23H2Build;
+ case InternalRevisionNumber of
+ 2428, 2506, 2715, 2792, 2861, 3007, 3085, 3155, 3235 {Moment 5}, 3296, 3374 .. MaxInt:
+ InternalExtraUpdateInfo := 'Version 23H2';
+ 1825, 1830, 1835, 1900, 1906, 1972:
+ // revisions 1825..1972 had version string "22H2"
+ InternalExtraUpdateInfo := Format(
+ 'Version 22H2 [Beta v10.0.%d.%d]',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ 2048, 2050, 2115, 2129, 2191, 2199, 2262, 2265, 2271, 2338:
+ InternalExtraUpdateInfo := Format(
+ 'Version 23H2 [Beta v10.0.%d.%d]',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ 2361, 2787, 3078, 3227, 3371:
+ InternalExtraUpdateInfo := Format(
+ 'Version 23H2 [Release Preview v10.0.%d.%d]',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ else
+ InternalExtraUpdateInfo := Format(
+ 'Version 23H2 [Unknown release v10.0.%d.%d]',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ end;
+ end
+ else if IsBuildNumber(Win11Oct22ComponentBetaChannelBuild) then
begin
// **REF2**
- InternalBuildNumber := Win11v22H2BuildAlt;
- // Set fallback update info for unknown revisions
+ InternalBuildNumber := Win11Oct22ComponentBetaChannelBuild;
case InternalRevisionNumber of
290, 436, 440, 450, 575, 586, 590, 598, 601:
InternalExtraUpdateInfo := Format(
@@ -2291,22 +2397,42 @@ procedure InitPlatformIdEx;
end;
end
else if FindBuildNumberFrom(
- Win11DevChannelDevBuilds, InternalBuildNumber
+ Win1122H2DevChannelDevBuilds, InternalBuildNumber
+ ) then
+ begin
+ // Win11 Dev Channel builds with version string "22H2"
+ InternalExtraUpdateInfo := Format(
+ 'Dev Channel Version 22H2 v10.0.%d.%d',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ end
+ else if FindBuildNumberFrom(
+ Win1124H2DevChannelDevBuilds, InternalBuildNumber
+ ) then
+ begin
+ // Win11 Dev Channel builds with version string "22H2"
+ InternalExtraUpdateInfo := Format(
+ 'Dev Channel Version 24H2 v10.0.%d.%d',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ end
+ else if FindBuildNumberFrom(
+ Win11Canary23H2PreviewBuilds, InternalBuildNumber
) then
begin
- // Win11 Dev Channel builds with version string "Dev"
+ // Win11 Canary Channel builds with version string "23H2"
InternalExtraUpdateInfo := Format(
- 'Dev Channel v10.0.%d.%d (Dev)',
+ 'Canary Channel Version 23H2 v10.0.%d.%d',
[InternalBuildNumber, InternalRevisionNumber]
);
end
else if FindBuildNumberFrom(
- Win11CanaryPreviewBuilds, InternalBuildNumber
+ Win11Canary24H2PreviewBuilds, InternalBuildNumber
) then
begin
- // Win11 Canary Channel builds
+ // Win11 Canary Channel builds with version string "24H2"
InternalExtraUpdateInfo := Format(
- 'Canary Channel v10.0.%d.%d (Dev)',
+ 'Canary Channel Version 24H2 v10.0.%d.%d',
[InternalBuildNumber, InternalRevisionNumber]
);
end
@@ -2314,7 +2440,7 @@ procedure InitPlatformIdEx;
Win11DevBetaChannels22H2Builds, InternalBuildNumber
) then
begin
- // Win 11 Dev & Beta channel builds with verison string "22H2"
+ // Win 11 Dev & Beta channel builds with version string "22H2"
InternalExtraUpdateInfo := Format(
'Dev & Beta Channels v10.0.%d.%d (22H2)',
[InternalBuildNumber, InternalRevisionNumber]
@@ -2322,6 +2448,7 @@ procedure InitPlatformIdEx;
end
else if IsBuildNumber(Win11Feb23ComponentBetaChannelBuild) then
begin
+ // **REF7**
InternalBuildNumber := Win11Feb23ComponentBetaChannelBuild;
case InternalRevisionNumber of
730, 741, 746, 870, 875, 885, 891, 1020, 1028, 1037, 1095,
@@ -2337,11 +2464,32 @@ procedure InitPlatformIdEx;
);
end;
end
+ else if IsBuildNumber(Win11May23ComponentBetaChannelBuild) then
+ begin
+ // **REF8**
+ InternalBuildNumber := Win11May23ComponentBetaChannelBuild;
+ case InternalRevisionNumber of
+ 1391, 1465, 1470, 1537, 1546, 1610, 1616, 1680, 1690, 1755 ..
+ MaxInt:
+ InternalExtraUpdateInfo := Format(
+ 'May 2023 Component Update Beta v10.0.%d.%d',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ else
+ InternalExtraUpdateInfo := Format(
+ 'May 2023 Component Update [Unknown Beta v10.0.%d.%d]',
+ [InternalBuildNumber, InternalRevisionNumber]
+ );
+ end;
+ end
else if IsBuildNumber(Win11FutureComponentBetaChannelBuild) then
begin
+ // **REF9**
InternalBuildNumber := Win11FutureComponentBetaChannelBuild;
case InternalRevisionNumber of
- 1391, 1465, 1470, 1537 .. MaxInt:
+ 2419, 2483, 2486, 2552, 2700, 2771, 2776, 2841, 2850, 2915,
+ 2921, 3061, 3066, 3130, 3139, 3140, 3209, 3212, 3276, 3286,
+ 3350, 3420 .. MaxInt:
InternalExtraUpdateInfo := Format(
'Future Component Update Beta v10.0.%d.%d',
[InternalBuildNumber, InternalRevisionNumber]
@@ -2431,20 +2579,6 @@ procedure InitPlatformIdEx;
begin
// Nothing to do: required internal variables set in function call
end
- else if FindWin10PreviewBuildNameAndExtraFrom(
- Win10_1511_Preview_Builds, '1511',
- InternalBuildNumber, InternalExtraUpdateInfo
- ) then
- begin
- // Nothing to do: required internal variables set in function call
- end
- else if FindWin10PreviewBuildNameAndExtraFrom(
- Win10_1507_Preview_Builds, '1507',
- InternalBuildNumber, InternalExtraUpdateInfo
- ) then
- begin
- // Nothing to do: required internal variables set in function call
- end
end
else // Win32ProductType in [VER_NT_DOMAIN_CONTROLLER, VER_NT_SERVER]
begin
@@ -3059,8 +3193,6 @@ class function TPJOSInfo.Platform: TPJOSPlatform;
end;
class function TPJOSInfo.Product: TPJOSProduct;
-var
- DummyBN: Integer; // dummy build number
begin
Result := osUnknown;
case Platform of
@@ -3150,8 +3282,10 @@ class function TPJOSInfo.Product: TPJOSProduct;
// application is "manifested" for the correct Windows version.
// See https://bit.ly/MJSO8Q.
Result := osWin10Svr
- else if FindBuildNumberFrom(Win10_6point4Builds, DummyBN) then
- Result := osWin10;
+ // Version 6.4 was also used for some early Windows 10 preview
+ // builds, but they have all expired so detection has been
+ // removed.
+ // See https://tinyurl.com/3c8e3hsc
else
// Higher minor version: must be an unknown later OS
Result := osWinLater
From df62229ccefa0349445c08049261dd5233a19207 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Thu, 4 Apr 2024 01:19:30 +0100
Subject: [PATCH 09/23] Fix copyright date in About box
Fixes #129
---
Src/Res/HTML/dlg-about-program-tplt.html | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Src/Res/HTML/dlg-about-program-tplt.html b/Src/Res/HTML/dlg-about-program-tplt.html
index 63a3a2cd4..be93a30c3 100644
--- a/Src/Res/HTML/dlg-about-program-tplt.html
+++ b/Src/Res/HTML/dlg-about-program-tplt.html
@@ -9,7 +9,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) 2005-2023, Peter Johnson (gravatar.com/delphidabbler).
+ * Copyright (C) 2005-2024, Peter Johnson (gravatar.com/delphidabbler).
*
* Template for content displayed in program tab of about dialog box.
-->
@@ -47,7 +47,7 @@
From 0fb7ce6de170769f3f7aa102375ce8d533fda714 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Mon, 8 Apr 2024 08:04:27 +0100
Subject: [PATCH 13/23] Rewrite Docs/Design/reml.html
Docs/Design/reml.html now contains a brief overview of REML and links to
documentation in the new delphidabbler/reml repository for a full
language definition.
---
Docs/Design/reml.html | 537 ++----------------------------------------
1 file changed, 20 insertions(+), 517 deletions(-)
diff --git a/Docs/Design/reml.html b/Docs/Design/reml.html
index 43adc650f..fb8b0ce15 100644
--- a/Docs/Design/reml.html
+++ b/Docs/Design/reml.html
@@ -19,7 +19,7 @@
-
+
@@ -219,450 +116,56 @@
-
-
-
-
-
- Introduction
-
-
-
- REML is a little markup language that can be used to style text. It is used in Code Snippets collection meta data for certain properties of a snippet.
-
-
- The REML language is a SGML language similar to a greatly simplified XHTML. The are a small number of tags and character entities that can be used.
-
-
-
-
+
-
+
- Tags
+ About REML
- There are two types of tags: block level and in-line.
-
-
-
- If an unrecognised tag is encountered an REML code the interpreter should report an error. However, providing start and end tags are matched, the interpreter may choose to simply ignore the tags.
-
-
-
- Block Level Tags
-
-
-
- Block level tags separate the enclosed text into paragraphs of some description. The supported tags are:
-
-
-
- <p>...</p> – Renders the enclosed markup as a simple paragraph.
-
-
- <heading>...</heading> – Renders the enclosed markup as a heading.
-
-
- <ol>...</ol> – Renders the enclosed markup as an ordered list.
-
-
- <ul>...</ul> – Renders the enclosed markup as an unordered list.
-
-
- <li>...</li> – Renders the enclosed markup as a list item.
-
-
-
- The following rules apply to the use of block level tags:
-
-
-
- Must be matched, e.g. <p>must have a matching </p>.
-
-
- <p>...</p> and <heading>...</heading> blocks must not contain other block level tags.
-
-
- <ol>...</ol> and <ul>...</ul> blocks must only contain one or more <li>...</li> blocks.
-
-
- <li>...</li> blocks must only be used within <ol>...</ol> and <ul>...</ul> blocks. May contain <p>...</p> and <heading>...</heading> 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 <ul>...</ul> and <ol>...</ol> blocks.
-
-
- All text should be embedded within <p>...</p>, <heading>...</heading> or <li>...</li> block level tags, e.g. <heading>heading</heading><p>text</p> or simply <p>text</p>.
-
- However interpreting code may interpret this permissively. If this is done the text outside blocks should be interpreted as if it was enclosed in <p> and </p> tags. Therefore the above code would be interpreted as:
+ REML is a little markup language that can be used to style text. It is a SGML language similar to HTML, albeit much smaller. A small number of tags and character entities are supported.
- <strong>...</strong> – Renders the enclosed markup with strong emphasis.
-
-
- <em>...</em> – Emphasises the enclosed markup.
-
-
- <var>...</var> – Used to indicate the enclosed markup is a variable.
-
-
- <warning>...</warning> – Used for warning text.
-
-
- <mono>...</mono> – Renders markup in a mono-spaced font.
-
-
- <a href="url">...</a> – Creates a hyper-link. The href attribute must specify the required URL, which must use one of the http, https or file protocols; others are not permitted. If you use the file protocol it must reference a valid local or network file.
-
-
-
- The following rules apply to the use of in-line tags:
-
-
-
- In-line tags must be embedded inside a valid block level tag. E.g. <p>one<strong>two</strong>three</p>.
-
-
- Tags must match. E.g. <em> must be matched with </em>.
-
-
- Tags may be nested, providing the tags are balanced. E.g. <em>blah <var>blah</var></em> is valid but <em>blah <var>blah</em></var> is not.
-
-
-
- Examples:
-
-
<p>Make stuff <strong>stand out</strong>.</p>
-<p><em>Emphasised <warning>warning!</warning></em></p>
-<p>Refer to a function <var>parameter</var>.</p>
-<p>Use the: <mono>Windows</mono> unit.</p>
-<p>See this <a href="https://example.com">example</a>.</p>
-
+
- Character Entities
+ REML in CodeSnip
- Some symbolic character entities are supported in REML. Many symbols, but not all, have analogues in the list of supported character entities in XHTML or HTML 5. Some entities have alternate symbols. Here is the complete list.
+ Code snippets include REML to format snippets' description and extra fields. CodeSnip interprets and renders the REML when displaying snippets in its UI and when printing them.
- To express other special symbols for which there is no symbolic character entity, numeric character entities can be used. For example to display the 'Ω' character (Unicode Greek capital letter Omega) use Ω.
+ CodeSnip currently supports REML v6. Earlier versions of CodeSnip supported different versions of REML:
-
-
-
-
-
-
-
-
-
Change Log
-
-
- This section notes the changes in the various versions of REML.
-
-
-
- v1 of 2008-12-31
-
-
-
- Introduced in CodeSnip v2.2.5
-
-
-
-
- Supported tags: <strong> and <a>.
-
-
- Supported entities: >, <, " and &.
-
-
- Supported protocols for use in <a> tags: http.
-
REML v4 was first supported by CodeSnip v4.0 alpha 1 (preview)
+
REML v5 was first supported by CodeSnip v4.21.0
+
REML v6 was first supported by CodeSnip v4.23.0
- v6 of 2024-04-02
+ All CodeSnip versions are backward compatible with earlier versions of REML.
-
- Introduced in CodeSnip v4.23.0
-
+
-
-
- Added entity: '.
-
-
-
-
+
From fca862c6d28a2b3fed1fa43a2e3852293791d6e0 Mon Sep 17 00:00:00 2001
From: delphidabbler <5164283+delphidabbler@users.noreply.github.com>
Date: Mon, 8 Apr 2024 08:46:15 +0100
Subject: [PATCH 14/23] Rewite REML help topic
REML language definition was replaced with a link to the definition on
the delphidabbler/reml project.
Added a brief preamble and an example that uses all supported tags.
Added screens shot image to illustrate example.
---
Src/Help/HTML/reml.htm | 387 ++++----------------------------
Src/Help/Images/REMLExample.png | Bin 0 -> 47280 bytes
2 files changed, 47 insertions(+), 340 deletions(-)
create mode 100644 Src/Help/Images/REMLExample.png
diff --git a/Src/Help/HTML/reml.htm b/Src/Help/HTML/reml.htm
index 3b6753a59..0783817a5 100644
--- a/Src/Help/HTML/reml.htm
+++ b/Src/Help/HTML/reml.htm
@@ -15,20 +15,6 @@
About REML
-