- CodeSnip is written in Object Pascal and is targeted at Delphi
- XE. Compilation with earlier compilers is not guaranteed. The code will
- require some changes to compile on Delphi XE2 or later.
-
-
-
- The are currently two editions of CodeSnip: the standard edition and
- the portable edition. They both share the same code base and the different
- editions are created using conditional compilation. These instructions show
- how to build either edition.
-
-
-
- The Delphi XE IDE can be used to modify the source and to perform test builds.
- Final builds should be created using the provided makefile.
-
-
-
- Dependencies
-
-
-
- Several DelphiDabbler and other 3rd party libraries and components are
- required to compile CodeSnip, most of which are included in the code
- repository in the Src/3rdParty directory. Code not included in
- the repository is noted below.
-
-
-
- Indy libraries v10
-
-
-
- The Indy 10 Internet components ship with Delphi XE.
- If you prefer to work with the latest release you can download it from http://www.indyproject.org/. If you download a copy of Indy 10 you
- should compile the source code separately with the same version of Delphi
- that is being used to compile CodeSnip.
-
-
-
- Regardless of whether you are using the version of Indy 10 supplied with
- Delphi or if you have downloaded and compiled your own version, you must set
- the INDY10 environment variable to the directory where you
- placed the compiled code.
-
-
-
- Changes between different Indy 10 releases
-
-
-
- Changes were made to the parameter lists of the TWorkBeginEvent
- and TWorkEvent events between early and later releases of Indy
- 10. Specifically, earlier versions use type Integer for the
- AWorkCount parameter of TWorkEvent and the
- AWorkCountMax parameter of TWorkBeginEvent, while
- later versions use Int64.
-
-
-
- CodeSnip's source code uses conditional compilation to provide the
- correct event handler signatures – and it makes an intelligent guess
- at which signature to use depending on the version number provided by the
- Indy library code. Should the program fail to compile with an error in the
- Web.UDownloadMonitor unit, you should check the event signatures in
- your Indy IdComponent unit and then define the
- INDY_WORKEVENT_INT64 environment variable if Int64
- parameters are required or INDY_WORKEVENT_INT32 if
- Integer parameters are used.
-
-
-
- Delphi RTL & VCL
-
-
-
- Goes without saying really, but you need the RTL and VCL that ships with
- Delphi.
-
-
-
- Build Tools
-
-
-
- The following tools are required to build CodeSnip.
-
-
-
- Delphi
-
-
-
- A copy of the Delphi XE command line compiler is required to build the
- object Pascal code from the provided makefile.
-
-
-
- You can use the Delphi IDE to edit the code and test compile it, but final
- builds should be created using the makefile, which requires the following
- tools that are supplied with Delphi:
-
-
-
-
- DCC32
-
-
- The Delphi command line compiler.
-
-
- BRCC32
-
-
- The Borland resource compiler. Used to compile various resource source
- (.rc) files.
-
-
- GenTLB
-
-
- Type library generator. Used to create the ExternalObj.tlb type
- library from source code in ExternalObj.ridl.
-
-
- TLibImpl
-
-
- Type library importer tool. Used to create a Pascal unit that describes
- code contained in ExternalObj.idl.
-
-
-
-
- The following environment variables are associated with these tools:
-
-
-
-
- DELPHIROOT - required unless DELPHIXE is set.
-
-
- Should be set to the install directory of the version of Delphi being
- used. DCC32, BRCC32 and TLibImpl
- are expected to be in the Bin sub-directory of
- DELPHIROOT.
-
-
- DELPHIXE - optional
-
-
- This environment variable can be set to the Delphi XE install
- directory. When DELPHIXE is defined
- DELPHIROOT will be set to the value of
- DELPHIXE.
-
-
- INDY10 - required
-
-
- Must be set to the directory where the Indy 10 components are installed.
- The code must have been built with the same version of Delphi used to
- compile CodeSnip.
-
- See above for details. If used, only one of
- the environment variables may be defined. Defining both causes
- compilation to fail.
-
-
-
-
- MAKE
-
-
-
- This is the make tool that ships with Delphi. You can use any version that
- works.
-
-
-
- DelphiDabbler Version Information Editor (VIEd)
-
-
-
- This tool is used to compile version information (.vi) files
- into intermediate resource source (.rc) files. Version 2.11.2
- or later is required.
- Version Information Editor can be obtained from
- http://www.delphidabbler.com/software/vied.
-
-
-
- The program is expected to be on the path unless its install directory is
- specified by the VIEDROOT environment variable.
-
-
-
- DelphiDabbler HTML Resource Compiler (HTMLRes)
-
-
-
- HTMLRes is used to compile HTML.hrc which stores various
- HTML, JavaScript, CSS and images into HTML resources. Version 1.1 or later
- is required.
- The HTML Resource Compiler can be obtained from
- http://www.delphidabbler.com/software/htmlres.
-
-
-
- The program is expected to be on the path unless its install directory is
- specified by the HTMLRESROOT environment variable.
-
-
-
- Inno Setup
-
-
-
- The Unicode version on the Inno setup command line compiler is needed to
- create CodeSnip's install program. v5.5.2 (u) or later is required.
- Earlier (Unicode) versions may work, but this is not guaranteed.
-
-
-
- You can get Inno Setup at http://www.jrsoftware.org/isinfo.php. Choose the Unicode version and
- ensure that the ISPP pre-processor is installed. If you already have the ANSI
- version the Unicode version can be installed alongside it - just use a
- different install directory and program group name.
-
-
-
- The path to Unicode Inno Setup's install directory will be looked for in the
- INNOSETUP_U environment variable, or, if that is not set, in the
- INNOSETUP environment variable. If neither of these is set then
- the correct version of Inno Setup is expected to be on the path.
-
-
-
- Note: Inno Setup is not required if you are creating only the
- portable edition of CodeSnip since that edition does not have an
- install program.
-
-
-
- Microsoft HTML Help Compiler (HHC)
-
-
-
- This command line compiler is supplied with Microsoft HTML Help Workshop. It
- is used to compile the CodeSnip help file.
-
-
-
- The program is expected to be on the path unless its install directory is
- specified by the HHCROOT environment variable.
-
- The program is expected to be on the path unless its install directory is
- specified by the ZIPROOT environment variable.
-
-
-
- Note: You do not need Zip if you do not intend to create
- release files.
-
-
-
- Preparation
-
-
-
- Configure the environment.
-
-
-
- You can configure environment variables either by modifying your system
- environment variables or by creating a batch file that you run before
- performing the build.
-
-
-
- Step 1
-
-
-
- Configure the required environment variables. Compilation will fail if these
- environment variables are not set:
-
-
-
-
- DELPHIROOTorDELPHIXE
-
-
- INDY10
-
-
-
-
- Step 2
-
-
-
- Update the PATH environment variable to include
- %DELPHIROOT%\Bin as its first path, i.e. do:
-
-
-
> set PATH=%DELPHIROOT%\Bin;%PATH%
-
-
- You do not have to do this but it means you can run the preferred version of
- Make from the command line without having to specify its path
- every time.
-
-
-
- Step 3
-
-
-
- Set any of the following environment variables that are needed to specify
- the path to any tools that cannot be found on the path:
-
-
-
-
- VIEDROOT
-
-
- HTMLRESROOT
-
-
- INNOSETUP_U or INNOSETUP
-
-
- HHCROOT
-
-
- ZIPROOT
-
-
-
-
- Step 4
-
-
-
- Set INDY_WORKEVENT_INT64 or INDY_WORKEVENT_INT32
- if necessary (explained above).
-
-
-
- Get the Source Code
-
-
-
- If you don't already have it, download or checkout the CodeSnip
- source code. There are several options:
-
-
-
-
-
- If you are a Subversion user you can:
-
-
-
-
- Check out the source using the following command:
-
- Where PATH is the directory where you want to place the
- working copy. You will not be able to commit changes unless you join
- the project, when a different check out URL is used.
-
- where PATH is the directory where you wish to store the
- code.
-
-
-
-
- These commands get code from the repository trunk. To get the code of a
- stable release replace trunk with tags/XXXX
- where XXX specifies the version.
-
- Grab the source code of the latest release from DelphiDabbler.com.
-
-
-
-
- Configure the Source Tree
-
-
-
- After checking out or downloading and extracting the source code you should
- have the following directory structure:
-
-
-
./
- |
- +-- Docs - documentation
- | |
- | +-- ChangeLogs - program change log files
- | |
- | +-- Design - documents concerning program design
- | |
- | +-- FileFormats - documentation of CodeSnip's file formats
- |
- +-- Src - main CodeSnip source code
- | |
- | +-- 3rdParty - third party & DelphiDabbler library source code
- | |
- | +-- AutoGen - receives automatically generated code
- | |
- | +-- Help - help source files
- | | |
- | | +-- CSS - CSS code for help files
- | | |
- | | +-- HTML - HTML files included in help file
- | | |
- | | +-- Images - images included in help file
- | |
- | +-- Install - setup script and support code
- | | |
- | | +-- Assets - files required for inclusion in install program
- | |
- | +-- Res - container for files that are embedded in resources
- | |
- | +-- CSS - CSS files
- | |
- | +-- HTML - HTML files
- | |
- | +-- Img - image files
- | | |
- | | +-- Branding - image files used for CodeSnip branding
- | | |
- | | +-- Egg - image files for 'Easter Egg'
- | |
- | +-- Misc - other resources
- | |
- | +-- Scripts - scripting files
- | |
- | +-- 3rdParty - 3rd party scripting files
- |
- +-- Tests - contains test code
- |
- +-- Src - test source code
- |
- +-- DUnit - test source code that uses the DUnit framework
-
- If, by chance you also have Bin, Exe and / or
- Release directories don't worry - all will become clear.
- Subversion users may also see the usual .svn hidden
- directories. If you have done some editing in the Delphi IDE you may also see
- occasional hidden __history folders.
-
-
-
- Before you can get hacking, you need to prepare the code tree. Open a command
- console and navigate into the Src sub-folder. Run any script you
- have created to set environment variables then do:
-
-
-
> Make config
-
-
- You may need to replace Make with the full path to
- Make if it isn't on the path, or if the Make that
- runs isn't the CodeGear / Embarcadero version. If this is the case try:
-
-
-
> %DELPHIROOT%\Bin\Make config
-
-
- or
-
-
-
> %DELPHIXE%\Bin\Make config
-
-
- depending on which environment variable you have set.
-
-
-
- Once Make config has completed your folder structure should
- have acquired the following new folders, if they weren't present already:
-
- If the Bin folder already existed, it will have been emptied.
- In addition, Make will have created a .cfg file from
- template in the Src folder. This .cfg file is needed
- for DCC32 to run correctly. The file will be ignored by Subversion.
-
-
-
- Using the Delphi IDE
-
-
-
- If you are intending to use the Delphi IDE to compile code, you should also
- do:
-
-
-
> Make resources
-> Make typelib
-> Make autogen
-
-
- This compiles the resource files that the IDE needs to link into compiled
- executables, compiles the type library from IDL code and generates the
- Pascal file that provides an interface to the type library.
-
-
-
- If you wish to build the portable edition of CodeSnip you also need
- to do:
-
-
-
> Make -DPORTABLE resources
-
-
- and define the PORTABLE conditional define in Project
- Options. The standard name for the portable exe file is
- CodeSnip-p.exe, but the IDE will generate
- CodeSnip.exe. You can rename the file manually.
-
-
-
- Note that building with the make file insted of the IDE performs all the above
- steps automatically.
-
-
-
- Building CodeSnip
-
-
-
- This section guides you through building CodeSnip from the command
- line, not from the IDE.
-
-
-
- You have several options:
-
-
-
-
- Build the CodeSnip Executable
-
-
- Build the Help File.
-
-
- Build the Setup Program.
-
-
- Build the Release Zip File.
-
-
- Build and Release Everything.
-
-
- Clean Up.
-
-
-
-
- Each of these options is described below. All except the last assume that
- Make config has been run.
-
-
-
- Note: This information applies only to building
- CodeSnip itself, not to building and using the code in the
- Test directory.
-
-
-
- Build the CodeSnip Executable
-
-
-
- This is the most common build and has a simple command:
-
-
-
> Make codesnip
-
-
- This is the same as doing this sequence of commands:
-
-
-
> Make typelib
-> Make resources
-> Make autogen
-> Make pascal
-
-
- The CodeSnip executable, named CodeSnip.exe will be
- placed in the Exe folder.
-
-
-
- Portable edition
-
-
-
- To build the portable edition of CodeSnip you must either define the
- PORTABLE environment variable or do:
-
-
-
> Make -DPORTABLE codesnip
-
-
- Again the executable is placed in the Exe folder, but this time
- it is named CodeSnip-p.exe
-
-
-
- Build the Help File
-
-
-
- To build the help file just do
-
-
-
> Make help
-
-
- Build the Setup Program
-
-
-
- The setup program requires that the CodeSnip excutable and the
- compiled help file are already present in the Exe directory.
-
-
-
- As an aside, you can make all the required files by doing:
-
-
-
> Make exes
-
-
- Once you have built all the required files you build the setup file by
- doing:
-
-
-
> Make setup
-
-
- 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 Exe directory.
-
-
-
- If the SpecialBuild string is defined in CodeSnip's
- version information the string will be appended to the setup file name like
- this CodeSnip-Setup-x.x.x-SPECIALBUILD.
-
-
-
- Portable edition
-
-
-
- CodeSnip's portable edition does not use a setup file so Make
- setup does nothing except print a message if it is run when the
- PORTABLE symbol is defined.
-
-
-
- Build the Release Zip File
-
-
-
- Make can create zip files containing the files that are included in a release.
-
-
-
- Standard edition
-
-
-
- The release file for the standard edition of CodeSnip includes the
- setup file along with ReadMe.txt from the Docs
- directory. Both must be present.
-
-
-
- Build the release by doing:
-
-
-
> Make release
-
-
- By default the release file is named dd-codesnip.zip. You can
- change this name by defining the RELEASEFILENAME macro or
- enviroment variable. For example, you can name the file
- MyRelease.zip by doing:
-
-
-
> Make -DRELEASEFILENAME=MyRelease.zip release
-
-
- Portable edition
-
-
-
- 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.
-
-
-
- Build the portable release by doing:
-
-
-
> Make -DPORTABLE release
-
-
- By default the release file is named dd-codesnip-portable.zip.
- You can change this name by defining the RELEASEFILENAME macro or
- enviroment variable. For example, you can name the file
- MyPortableRelease.zip by doing:
-
-
-
> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease.zip release
-
-
- Warning: If you are building both the standard and portable
- releases with custom file names, make sure you supply a different value of
- the RELEASEFILENAME macro for each release, otherwise the last
- built release will overwrite the first.
-
-
-
-
- Build and Release Everything
-
-
-
- You can do a complete build of everything, and generate the release zip file
- simply by doing:
-
-
-
> Make
-
-
- without specifying a target. This is the equivalent of:
-
-
-
> Make config
-> Make exes
-> Make setup
-> Make release
-
-
- Portable edition
-
-
-
- To perform a complete build of the portable edition of CodeSnip do
-
-
-
> Make -DPORTABLE
-
-
- Clean Up
-
-
-
- Various temporary files and directories are created by the IDE. These can be
- deleted by running.
-
-
-
> Make clean
-
-
- Warning: This command removes the __history
- folders that Delphi uses to maintain earlier versions of files.
-
-
-
- Running the Tests
-
-
-
- At present all tests use the DUnit unit testing framework and are
- combined into a single test application.
-
-
-
- To compile the tests, open the .\Src\CodeSnip.groupproj group
- project file in the Delphi XE IDE. Now select the CodeSnipTests.exe
- target in the project manager and compile.
-
-
-
- If they were not already present Bin and Exe
- sub-directories will have been created in the .\Tests directory.
- The Exe directory contains the DUnit test program while
- Bin contains intermediate binaries.
-
-
-
- You can compile the tests as either a GUI application (default) or as a
- console application. For details please see the comments in
- .\Tests\Src\DUnit\CodeSnipTests.dpr.
-
-
-
- License
-
-
-
- The majority of CodeSnip's original source code is licensed under the
- Mozilla Public License v2.0. The are a few exceptions, mainly relating to
- third party source code and image files. For full details of all applicable
- licenses please read License.html in the Docs
- directory.
-
+ CodeSnip is written in Object Pascal and is targeted at Delphi
+ XE. Compilation with other compilers is not guaranteed.
+
+
+
+ For an explanation of why CodeSnip still uses Delphi XE see
+ FAQ 11 of the CodeSnip Compiling & Source Code FAQs.
+
+
+
+ The are currently two editions of CodeSnip: the standard edition and
+ the portable edition. They both share the same code base: the different
+ editions are created using conditional compilation. These instructions show
+ how to build either edition.
+
+
+
+ Dependencies
+
+
+
+ Several DelphiDabbler and other 3rd party libraries and components are
+ required to compile CodeSnip. They are all included in the code
+ repository in the Src/3rdParty directory.
+
+
+
+ It goes without saying that you will also need the RTL and VCL that ships with
+ Delphi.
+
+
+
+ Build Tools
+
+
+
+ The following tools are required to build CodeSnip.
+
+
+
+ Delphi
+
+
+
+ All the following tools that ship with Delphi XE are required:
+
+
+
+
+ MAKE
+
+
+ The make tool – do not use the Microsoft make tool.
+
+
+ DCC32
+
+
+ The Delphi command line compiler.
+
+
+ BRCC32
+
+
+ The Borland resource compiler. Used to compile various resource source
+ (.rc) files.
+
+
+ GenTLB
+
+
+ Type library generator. Used to create the ExternalObj.tlb type
+ library from source code in ExternalObj.ridl.
+
+
+ TLibImpl
+
+
+ Type library importer tool. Used to create a Pascal unit that describes
+ code contained in ExternalObj.ridl.
+
+
+
+
+ The following environment variables are associated with these tools:
+
+
+
+
+ DELPHIROOT - required unless DELPHIXE is set.
+
+
+ Should be set to the install directory of the version of Delphi being
+ used. DCC32, BRCC32 and TLibImpl
+ are expected to be in the Bin sub-directory of
+ DELPHIROOT.
+
+
+ DELPHIXE - optional
+
+
+ This environment variable can be set to the Delphi XE install
+ directory. When DELPHIXE is defined
+ DELPHIROOT will be set to the value of
+ DELPHIXE.
+
+
+
+
+ DelphiDabbler Version Information Editor (VIEd)
+
+
+
+ This tool is used to compile version information (.vi) files and
+ any associated macro file(s) into intermediate resource source
+ (.rc) files. Version 2.15.0 or later is required. Version
+ Information Editor can be obtained from
+ https://github.com/delphidabbler/vied/releases.
+
+
+
+ The program is expected to be on the path unless its install directory is
+ specified by the VIEDROOT environment variable.
+
+
+
+ DelphiDabbler HTML Resource Compiler (HTMLRes)
+
+ The program is expected to be on the path unless its install directory is
+ specified by the HTMLRESROOT environment variable.
+
+
+
+ Inno Setup
+
+
+
+ The Unicode version of the Inno Setup v5 command line
+ compiler is needed to create CodeSnip's install program. v5.5.2(u) or
+ later is required.
+
+
+
+ Warning: Do not use Inno Setup v6. This will fail to compile
+ the setup script. Inno Setup 6 does not support Windows 2000 or XE, while
+ CodeSnip still does.
+
+
+
+ You can get Inno Setup at https://www.jrsoftware.org/isinfo.php. Choose the Unicode version and
+ ensure that the ISPP pre-processor is installed. If you already have the ANSI
+ version the Unicode version can be installed alongside it - just use a
+ different install directory and program group name.
+
+
+
+ The path to Unicode Inno Setup's install directory will be looked for in the
+ INNOSETUP_U environment variable, or, if that is not set, in the
+ INNOSETUP environment variable. If neither of these is set then
+ the correct version of Inno Setup is expected to be on the path.
+
+
+
+ Note: Inno Setup is not required if you are creating only the
+ portable edition of CodeSnip since that edition does not have an
+ install program.
+
+
+
+ Microsoft HTML Help Compiler (HHC)
+
+
+
+ This command line compiler is supplied with Microsoft HTML Help Workshop. It
+ is used to compile the CodeSnip help file.
+
+
+
+ The program is expected to be on the path unless its install directory is
+ specified by the HHCROOT environment variable.
+
+ Warning: The above link is http only. If you or
+ your browser object to the insecure link you can download an identical version
+ from delphidabbler.com, using the https protocol. See https://delphidabbler.com/extras/info-zip.
+
+
+
+ The program is expected to be on the path unless its install directory is
+ specified by the ZIPROOT environment variable.
+
+
+
+ You do not need Zip if you do not intend to create release files.
+
+
+
+
+ Preparation
+
+
+
+ Configure the environment.
+
+
+
+ You can configure environment variables either by modifying your system
+ environment variables or by creating a batch file that you run before
+ performing the build.
+
+
+
+ Step 1
+
+
+
+ Configure the required environment variables. Compilation will fail if these
+ environment variables are not set:
+
+
+
+
+ DELPHIROOTorDELPHIXE
+
+
+
+
+ Step 2
+
+
+
+ Update the PATH environment variable to include
+ %DELPHIROOT%\Bin as its first path, i.e. do:
+
+
+
> set PATH=%DELPHIROOT%\Bin;%PATH%
+
+
+ You do not have to do this but it means you can run
+ Make from the command line without having to specify its path
+ every time.
+
+
+
+ Step 3
+
+
+
+ Set any of the following environment variables that are needed to specify
+ the path to any tools that cannot be found on the path:
+
+
+
+
+ VIEDROOT
+
+
+ HTMLRESROOT
+
+
+ INNOSETUP_U or INNOSETUP
+
+
+ HHCROOT
+
+
+ ZIPROOT
+
+
+
+
+ Get the Source Code
+
+
+
+ The source code is maintained in the delphidabbler/codesnip Git respository on GitHub. Source code can be obtained in three ways:
+
+
+
+
+
+ Fork the project from GitHub and then clone your forked repository.
+
+ Download the source of a specific release from the project's Releases section on GitHub – just choose the version you want.
+
+
+
+
+
+ If you are intending to contribute code to the project please read the most up to date version of the project's read-me file before doing so.
+
+
+
+ Important: If you are planning to fork CodeSnip and to develop and release your own application derived from the CodeSnip code base then some changes to the code are required under the terms of the CodeSnip license. See the Conditions For Release of Modified Code section below for details.
+
+
+
+ Configure the Source Tree
+
+
+
+ After forking the repository or downloading and extracting the source code you should have the following directory structure:
+
+
+
./
+ |
+ +-- Docs - documentation
+ | |
+ | +-- Design - documents concerning program design
+ | |
+ | +-- FileFormats - documentation of CodeSnip's file formats
+ |
+ +-- Src - main CodeSnip source code
+ | |
+ | +-- 3rdParty - third party & DelphiDabbler library source code
+ | |
+ | +-- AutoGen - receives automatically generated code
+ | |
+ | +-- Help - help source files
+ | | |
+ | | +-- CSS - CSS code for help files
+ | | |
+ | | +-- HTML - HTML files included in help file
+ | | |
+ | | +-- Images - images included in help file
+ | |
+ | +-- Install - setup script and support code
+ | | |
+ | | +-- Assets - files required for inclusion in install program
+ | |
+ | +-- Res - container for files that are embedded in resources
+ | |
+ | +-- CSS - CSS files
+ | |
+ | +-- HTML - HTML files
+ | |
+ | +-- Img - image files
+ | | |
+ | | +-- AltBranding - image files used for 3rd party branding
+ | | |
+ | | +-- Branding - image files used for CodeSnip branding only
+ | | |
+ | | +-- Egg - image files for 'Easter Egg'
+ | |
+ | +-- Misc - other resources
+ | |
+ | +-- Scripts - scripting files
+ | |
+ | +-- 3rdParty - 3rd party scripting files
+ |
+ +-- Tests - contains test code
+ |
+ +-- Src - test source code
+ |
+ +-- DUnit - test source code that uses the DUnit framework
+
+ If, by chance you also have a _build directory don't worry - all will become clear.
+ Git users may also see the usual .git hidden
+ directory. If you have done some editing in the Delphi IDE you may also see
+ occasional hidden __history folders.
+
+
+
+ Before you can get hacking, you need to prepare the code tree. Open a command
+ console then run any script you may have created to set the required environment variables. Now navigate into the Src sub-folder and do:
+
+
+
> Make config
+
+
+ You may need to replace Make with the full path to
+ Make if it isn't on the path. If this is the case try:
+
+
+
> %DELPHIROOT%\Bin\Make config
+
+
+ or
+
+
+
> %DELPHIXE%\Bin\Make config
+
+
+ depending on which environment variable you have set.
+
+
+
+ Once Make config has run your folder structure should
+ have acquired the following new folders, if they weren't present already:
+
+
+
./
+ |
+ +-- _build - contains all the build files
+ | |
+ | +-- bin - receives object files for CodeSnip
+ | |
+ | +-- 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 a
+ template in the Src folder. This .cfg file is needed
+ for DCC32 to run correctly. The file will be ignored by Git.
+
+
+
+ Using the Delphi IDE
+
+
+
+ If you are intending to use the Delphi IDE to compile code, you should also
+ do:
+
+
+
> Make resources
+> Make typelib
+> Make autogen
+
+
+ This compiles the resource files that the IDE needs to link into compiled
+ executables, compiles the type library from IDL code and generates the
+ Pascal file that provides an interface to the type library.
+
+
+
+ If you wish to build the portable edition of CodeSnip you also need
+ to do:
+
+
+
> Make -DPORTABLE resources
+
+
+ and define the PORTABLE conditional define in Project
+ Options. The standard name for the portable exe file is
+ CodeSnip-p.exe, but the IDE will generate
+ CodeSnip.exe. You can rename the file manually.
+
+
+
+ After you have gone through these steps you can edit Pascal code and test
+ compile from the Delphi IDE. However if you change any files compiled into resources, or the type library, or run a clean up, then you must repeat the
+ above steps and do a complete build from the IDE.
+
+
+
+ Note that building with the make file insted of the IDE performs all the above
+ steps automatically.
+
+
+
+ Building CodeSnip
+
+
+
+ This section guides you through building CodeSnip from the command
+ line, not from the IDE.
+
+
+
+ You have several options:
+
+
+
+
+ Build the CodeSnip Executable
+
+
+ Build the Help File.
+
+
+ Build the Setup Program.
+
+
+ Build the Release Zip File.
+
+
+ Build and Release Everything.
+
+
+ Clean Up.
+
+
+
+
+ Each of these options is described below. All except options 5 and 6 assume that
+ Make config has been run.
+
+
+
+ Note: This information applies only to building
+ CodeSnip itself, not to building and using the code in the
+ Test directory.
+
+
+
+ Build the CodeSnip Executable
+
+
+
+ This is the most common build and has a simple command:
+
+
+
> Make codesnip
+
+
+ This is the same as doing this sequence of commands:
+
+
+
> Make typelib
+> Make resources
+> Make autogen
+> Make pascal
+
+
+ The CodeSnip executable, named CodeSnip.exe will be
+ placed in the _build\exe folder.
+
+
+
+ Portable edition
+
+
+
+ To build the portable edition of CodeSnip you must either define the
+ PORTABLE environment variable or do:
+
+
+
> Make -DPORTABLE codesnip
+
+
+ Again the executable is placed in the _build\exe folder, but this time
+ it is named CodeSnip-p.exe
+
+
+
+ Build the Help File
+
+
+
+ To build the help file just do
+
+
+
> Make help
+
+
+ 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 executable and the
+ compiled help file are already present in the _build\exe directory.
+
+
+
+ As an aside, you can make all the required files by doing:
+
+
+
> Make exes
+
+
+ Once you have built all the required files you build the setup file by
+ doing:
+
+
+
> Make setup
+
+
+ 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.
+
+
+
+ If the SpecialBuild string is defined in CodeSnip's
+ version information the string will be appended to the setup file name like
+ this CodeSnip-Setup-x.x.x-SPECIALBUILD.
+
+
+
+ Portable edition
+
+
+
+ CodeSnip's portable edition does not use a setup file so Make
+ setup does nothing except print a message if it is run when the
+ PORTABLE symbol is defined.
+
+
+
+ Build the Release Zip File
+
+
+
+ Make can create zip files containing all the files that are included in a release.
+ Zip files are written to the _build\release directory.
+
+
+
+ Standard edition
+
+
+
+ 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.
+
+
+
+ Build the release by doing:
+
+
+
> Make release
+
+
+ By default the release file is named codesnip-exe.zip. You can
+ change this name by defining the RELEASEFILENAME macro or
+ enviroment variable. For example, you can name the file
+ MyRelease.zip by doing:
+
+
+
> Make -DRELEASEFILENAME=MyRelease release
+
+
+ Note that the .zip extension should not be included in the file name.
+
+
+
+ Portable edition
+
+
+
+ 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.
+
+
+
+ Build the portable release by doing:
+
+
+
> Make -DPORTABLE release
+
+
+ By default the release file is named dd-codesnip-portable.zip.
+ You can change this name by defining the RELEASEFILENAME macro or
+ enviroment variable. For example, you can name the file
+ MyPortableRelease.zip by doing:
+
+
+
> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease release
+
+
+ Once again note that the .zip extension should not be included in the file name.
+
+
+
+ Warning: If you are building both the standard and portable
+ releases with custom file names, make sure you supply a different value of
+ the RELEASEFILENAME macro for each release, otherwise the last
+ built release will overwrite the first.
+
+
+
+ Including version numbers in zip file names
+
+
+
+ A version number can be suffixed to the release zip file name by defining the VERSION macro.
+ This macro works with both the PORTABLE and RELEASEFILENAME macros.
+
+
+
+ For example to appended version number 4.22.0 to the zip file name on a standard edition build, with the default
+ file name do:
+
+
+
> Make -DVERSION=4.22.0 release
+
+
+ This will create a zip file named codesnip-exe-4.22.0.zip.
+
+
+
+ A more complex example would be to append the same version number to a portable edition build named MyPortableRelease. Do:
+
+
+
> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease -DVERSION=4.22.0 release
+
+
+ This time the resulting zip file will be named MyPortableRelease-4.22.0.zip.
+
+
+
+ Build and Release Everything
+
+
+
+ You can do a complete build of everything, and generate the release zip file
+ simply by doing:
+
+
+
> Make
+
+
+ without specifying a target. This is the equivalent of:
+
+
+
> Make config
+> Make exes
+> Make setup
+> Make release
+
+
+ To perform a complete build of the portable edition of CodeSnip do
+
+
+
> Make -DPORTABLE
+
+
+ Note that the RELEASEFILENAME and VERSION macros that can be used for customising
+ 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
+
+
+
+ Various temporary files and directories are created by the IDE. These can be
+ deleted by running.
+
+
+
> Make clean
+
+
+ Warning: This command removes the __history
+ folders that Delphi uses to roll back to earlier versions of files.
+
+
+
+ Running the Tests
+
+
+
+ At present all tests use the DUnit unit testing framework and are
+ combined into a single test application.
+
+
+
+ To compile the tests, open the Src\CodeSnip.groupproj group
+ project file in the Delphi XE IDE. Now select the CodeSnipTests.exe
+ target in the project manager and compile.
+
+
+
+ If they were not already present Bin and Exe
+ sub-directories will have been created in the Tests directory.
+ The Exe directory contains the DUnit test program while
+ Bin contains intermediate binaries.
+
+
+
+ You can compile the tests as either a GUI application (default) or as a
+ console application. For details please see the comments in
+ Tests\Src\DUnit\CodeSnipTests.dpr.
+
+
+
+ License
+
+
+
+ The majority of CodeSnip's original source code is licensed under the
+ Mozilla Public License v2.0. The are a few exceptions, mainly relating to
+ third party source code and image files. For full details of all applicable
+ licenses please read License.html in the Docs
+ directory.
+
+
+
+ Conditions For Release of Modified Code
+
+
+
+ If you are intending to release your own application based on the CodeSnip source code you musteither change the source code as described below or seek written permission to use the DelphiDabbler CodeSnip branding. To seek such permission please use the CodeSnipIssue Tracker on GitHub.
+
+
+
+ Required Changes
+
+
+
+ The changes are required to remove DelphiDabbler CodeSnip copyrighted branding from the program, to prevent interference with existing CodeSnip installations and to remove any implied endorsement of the modified release. You must:
+
+
+
+
+
+ Replace the files in the Src\Res\Img\Branding directory with copies of the identically named placeholder files in the Src\Res\Img\AltBranding directory. The placeholder files are Public Domain, so you may use them as-is, edit them or replace them. If you delete the files in Src\Res\Img\Branding without copying the placeholder files across then CodeSnip will fail to build.
+
+
+
+
+ Replace all relevant references, in source code and documentation, to the names "CodeSnip" and "DelphiDabbler" with your own company and program name. Relevant occurences are:
+
+
+
+ Wherever the names may be displayed in the GUI.
+
+
+ Wherever the names may be displayed by the installer.
+
+
+ Wherever the names occur in directory names. In particular do not use the names in the program's %ProgramData% and %AppData% sub-directories.
+
+
+ Anywhere else that use of the names could imply endorsement of the modified code.
+
+
+
+
+
+ Provide your own license file with content compatible with the requirements of the CodeSnip license as it relates to the code reused from the CodeSnip source tree. Do not edit or re-use Docs/License.html.
+
+
+
+
+ Modify source code and documentation where necessary to acknowledge the origins of the program's source code, documentation and images, in accordance with the CodeSnip license.
+
+
+
+
+
+ Note that the CodeSnip license can be found in Docs\License.html.
+
+
+
+ If you are unsure about whether your changes meet the license requirements then you can seek clarification by creating an issue on the aforementioned Issue Tracker.
+
+
+
+
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 000000000..d3fbdcf23
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,2331 @@
+# Changelog
+
+This is the change log for _DelphiDabbler CodeSnip_. It begins with the first ever pre-release version of _CodeSnip_.
+
+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 "SnippetInfo" 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].
+* Added the option to save optionally highlighted annotated source code and units in HTML 5 format [issue #87].
+* Fixed malformed bullet character(s) in the list of imported snippets on the last page of the Snippets Import Wizard dialogue box [issue #147].
+* Improved the solution to the crash after hibernation bug, initially fixed in v4.24.1 and v4.24.2, with much improved and more stable code [issue #158]. Implemented by [@SirRufo](https://github.com/SirRufo).
+* 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].
+* 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].
+ * Corrected erroneous comments for the _TREMLEntities.MapToEntity_ method [issue #84].
+ * Updated file format documentation with details the changes introduced when implementing issues #87 and #140.
+ * Updated the help file with details of the new features added in this release.
+
+## Release v4.24.2 of 14 April 2025
+
+Hotfix release.
+
+* Updated bug fix implemented in v4.24.1 to avoid relying on a potentially problematic windows event [issue #70 (2nd attempt)].
+* Corrected release date error for v4.24.1 in `CHANGELOG.md`.
+
+## Release v4.24.1 of 13 April 2025
+
+* Fixed bug where CodeSnip occasionally crashes after a computer resumes from hibernation [issue #70].
+* Updated license copyright dates for 2025.
+
+## Release v4.24.0 of 23 October 2024
+
+* Compilers with which a snippet has not been tested are now omitted from snippet information that is copied to the clipboard and included in print outs [issue #143].
+* Reversed order of compilers in the snippets editor's _Compile Results_ tab so that later compilers are display first. This change was accidentally left out of release v4.22.0 when similar changes were made in other parts of the UI [issue #135].
+* Release version number is now displayed in the program title bar [issue #122].
+* Fixed incorrect copyright date displayed in About Box [issue #129].
+* Fixed bug when checking for correct preamble bytes (BOMs) in UTF-8 and UTF-16 format text files [issue #139].
+* Portable and Standard edition now use the same program names. Portable edition was previously declaring itself as _DelphiDabbler CodeSnip-p_ instead of _DelphiDabbler CodeSnip_ [issue #130].
+* Updated operating system detection code [issues #126 and #144].
+* Added `Deploy.bat` script to create and package both the CodeSnip standard and portable releases [issue #128].
+* Documentation changes:
+ * CodeSnip standard and portable releases now each have their own release read-me files instead of both releases being shipped with the same read-me [issue #127]. Updated `Build.html` and `README.md` re this change.
+ * Updated and corrected REML documentation and REML help topic. Those documents and others that discuss REML were also changed to link to authoritative REML definitions in the `delphidabbler/reml` repository. [issues #131, #133 & #134].
+ * Updated `Build.html` with alternative, more secure, download link for `zip.exe` program that is required to package releases [issue #137].
+
+## Release v4.23.0 of 02 April 2024
+
+* Removed marketing names (e.g. "Athens" or "Rio") from Delphi compiler names to save space when the compiler names are displayed in the UI [issue #125].
+* Added new `'` entity to REML markup language and boosted REML version to v6 as a consequence [issue #99].
+* Refactored class helper code by splitting a single monolithic unit into three more specialised units [issue #90].
+* Updated documentation and related help topic re change to REML v6.
+
+## Release v4.22.0 of 08 November 2023
+
+* Added support for test compiling snippets with Delphi 12 Athens [issue #121].
+* Documentation changes re addition of support for Delphi 12:
+ * File format additions for config, export, user database and main database.
+ * `Docs/ReadMe.txt`.
+ * Relevant help topics.
+* Reversed order in which compilers are listed in the Configure Compilers and Find Compilers dialogue boxes so that the most recent version of Delphi is listed first [issue #51].
+* Refactored out all `with` statements from Pascal source code [issue #118].
+* Fixed error in `CHANGELOG.md` entry for release v4.21.2 [issue #120].
+
+## Release v4.21.2 of 14 July 2023
+
+* Removed broken links and fixed unsafe links in the About box [issue #105].
+* Fixed bug in version information files that resulted in an error in the Comments section of the version information of both editions of _CodeSnip_ [issue #106].
+* Fixed potential XSS vulnerability in JQuery code used in Easter egg [issue #107].
+* Documentation changes:
+ * Rationalised, corrected, updated and clarified licensing information. These changes affected many documentation files. [issue #108].
+ * Overhauled `README.md` and `Docs/ReadMe.txt` and created a new `CONTRIBUTING.md` file that explains how to contribute in detail [issue #104].
+
+## Release v4.21.1 of 09 April 2023
+
+* Completed implementation of support for [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0/Docs/Design/reml.html) (ommitted from v4.20.0 in error) and fixed some bugs in the original implementation [issues #81 and #82], including:
+ * Heavily revised "active text" handling code and document model to fix support for lists introduced in v4.21.0.
+ * Added support for rendering lists in plain text reports and generated source code header comments.
+ * Added support for rendering lists in Rich Text Format for use in printed information and in reports copied to the clipboard.
+ * Overhauled HTML rendering code that generates HTML for display in the UI.
+ * Heavily revised parsing and generation of REML code.
+ * Updated "active text" validation code.
+* Prevented snippets editor from stripping REML `
` tags [issue #103].
+* Fixed garbled copyright symbols in generated source code [issue #80].
+* Fixed bug in code that compresses multiple white space into a single space [issue #95].
+* Fixed out of range error in code that handles text encodings [issue #97].
+* Fixed broken formatting of compiler result tables in text and rich text snippet reports & print outs [issue #101].
+* Updated copyright date displayed in about box [issue #98].
+* Updated operating system detection code to detect Windows 10/11 builds released in December 2022 and Q1 2023.
+* Some refactoring [including issue #83]
+* Changed build process to create all files in `_build` directory and to use different zip file names [issue #78].
+* Documentation changes:
+ * Updated `Build.html` to document changes in build process.
+ * Updated `CHANGELOG.md` to fix broken link [issue #76] and to remove information about semantic versioning.
+ * Removed broken links in `Docs/License.html`.
+ * Updated copyright date in various license files [including issue #96].
+ * Fixed errors and oversights in REML documentation.
+* Removed some redundant tests that were failing due to passing invalid parameters to the revised _StrWrap_ routine [issue #79].
+
+## Release v4.21.0 of 16 December 2022
+
+* Updated to support [REML version 5](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/version-4.21.0/Docs/Design/reml.html) in snippet description & extra information [issue #71]:
+ * Numerous new character entities supported.
+ * New list tags: `
`, `
` & `
`.
+* Program now automatically detects new (supported) Delphi installations at startup and offers to register the compiler(s) to be used for test compiling snippets. This feature is on by default but can be turned off completely or for specifically excluded compilers [issue #19].
+* Modified Configure Compilers dialogue box:
+ * Added facility to customise automatic compiler detection on per-compiler or global basis.
+ * Changed manually triggered compiler detection to ignore excluded compilers.
+* Some refactoring [including issues #73 and #75].
+* Minor changes to program license
+ * Changed required image attribution in `Docs/License.html` [issue #63]
+ * Corrected copyright date & fix typo in licenses displayed by installer and help file [issue #65 & PR #72].
+* Bump per-user config file to version 19.
+* Documentation updates:
+ * Updated `README.md` re abandoned and new Git repo branches.
+ * Updated config file, database, export file & REML documentation re changes in this release [including issue #74].
+ * Help file updated with details of changes in this release.
+ * Updated development tool chain requirements in `Build.html`.
+
+## Release v4.20.2 of 04 November 2022
+
+* Fixes bug where an exception was raised when selecting a main menu item with the cursor keys then pressing F1. [issue 54]
+* Update operating system detection code to correctly detect Version 22H2 of Windows 10 & Windows 11 plus some other Windows releases on the Dev, Beta & Release channels. [issues 55, 61 & 62]
+* Fix appearance of copyright symbol in version information.
+
+## Release v4.20.1 of 01 July 2022
+
+* Operating system detection code was updated to (a) fix bugs and (b) detect some Dev, Beta and Release Preview builds of Windows 11 22H2.
+* Fixed copyright date in `Docs/License.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:
+ * Removed multi-line tab sets and replacing navigation pane on left hand side of window.
+ * Hid warning on Printing preferences page that changes will not be made until after program is restarted, if and only if page is displayed from Print dialogue box.
+ * Last preferences page displayed is now remembered and restored the next time the dialogue box is displayed.
+* Added facility to customise size of font used in Overview pane's tree view. A new preference added to Display pane of Preferences dialogue box is used to set the font size.
+* Fixed obscure bug in code that reads legacy ANSI Code Snippets Database files that was potentially using the incorrect ANSI code page.
+* Updated help file re changes
+* Fixed errors in custom installer dialogue boxes.
+* Documentation corrected, expanded and updated, with some file format documentation having a major overhaul.
+* Some tidying up:
+ * Fixed some broken web links in source code comments and elsewhere.
+ * Replaced `http` protocol in URLS with `https` wherever supported - mainly in source code comments & documentation.
+ * Removed some orphaned files long since removed from project.
+ * Added missing header comments to source file.
+ * Updated copyright dates in files modified during year to include 2021.
+ * Change log was overhauled to fix linting errors.
+* Bumped version of per-user config file to 17 following addition of new preferences.
+* Small amount of refactoring
+
+## Release v4.18.1 of 29 November 2021
+
+* Improved handling of control and whitespace characters in generated HTML: revised which characters were converted to HTML character attributes / entities.
+* Fixed error in title of _Save Annotated Source_ dialogue box.
+* Replaced use 3rd party `GIFImage` unit with similar `GIFImg` unit from Delphi XE VCL.
+* Corrected help topic for _Dependencies_ dialogue box to describe _Save & Close_ button.
+* Operating system detection code was updated to correctly detect Windows 11 and Windows 10 version 21H2.
+* Some refactoring.
+* Updated license document (`License.html`) following removal of dependency on GIFImage unit.
+
+## Release v4.18.0 of 13 September 2021
+
+* Added support for test compilation with, and detection of, Delphi 11 Alexandria.
+* Updated various dialogue boxes to widen lists of compilers to accommodate length of new compiler name.
+* Operating system detection code was updated to correctly detect Windows 10 version 20H2.
+* Updated documentation re changes.
+* Updated help file re changes.
+* Minor documentation corrections.
+
+## Release v4.17.2 of 12 September 2020
+
+Hotfix release.
+
+* Updated version of jQuery used by program easter egg from v1.8.0 to v1.12.4 to fix a known vulnerability in v1.8.0. Also updated jQuery Cycle Lite that depends on jQuery from v1.6 to 1.7.
+
+## Release v4.17.1 of 31 July 2020
+
+Hotfix release.
+
+* Corrected "What's New" dialogue box content that is displayed _only_ when updating from v4.15.1 and earlier. The correction is to ensure the text makes sense when release 4.16.0 has been skipped. This change should have been made in v4.17.0.
+* Removed a redundant resource.
+
+## Release v4.17.0 of 31 July 2020
+
+* Added support for test compilation with, and detection of, Delphi 10.2 Tokyo, Delphi 10.3 Rio and Delphi 10.4 Sydney compilers.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.16.0 of 31 May 2020
+
+This is a significant update. It's purpose is to remove CodeSnip's dependencies on the delphidabbler.com website and associated web services. This was done because of the expected June 2020 closure or reduced functionality of delphidabbler.com. Some affected features were removed and others replaced with alternatives.
+
+* Removed all dependencies on web services. The following changes were made as a consequence of this:
+ * Replaced the option to update the main DelphiDabbler Code Snippets database from the web with an option to update it from locally stored data:
+ * Replaced the _Update from Web_ dialogue box with a new wizard. Menu options on the _Snippets_ menu were renamed accordingly and the old tool bar button was removed.
+ * Changed the database update code to use data that has been manually downloaded from the `delphidabbler/code-snippets` GitHub project.
+ * Modified the database reading code to accept both the new Code Snippets database v2 format _and_ the legacy v1 format.
+ * Replaced the option to import SWAG snippets from an on-line REST service with an option to import snippets from locally stored data.
+ * Revised the SWAG import wizard re the changes to the import method.
+ * Modified the SWAG import code to use data that has been manually downloaded from the `delphidabbler/swag` GitHub project.
+ * The option to register the program was removed. No registration key is now generated or stored.
+ * Replaced the option to read and display the CodeSnip RSS news feed with one to display the CodeSnip Blog.
+ * Removed the menu option used to check for program updates.
+ * Removed the background task that automatically checked for program and database updates.
+ * Removed the option to submit snippets for addition to the DelphiDabbler Code Snippets database.
+ * Removed support for a proxy web server - now unnecessary.
+ * Removed support for the `--test-server` command line option that enabled use of a different server to test web services.
+ * Updated install program so it no longer displays a page stating that CodeSnip will go automatically go on-line to check for updates.
+* Removed references and links to delphidabbler.com from the program, the installer, the help file and documentation. Some references were deleted while others were replaced with alternatives, including:
+ * Changed the URL of the FAQs to refer to the `codesnip-faq` GitHub project.
+ * References to swag.delphidabbler.com were replaced with references to the `delphidabbler/swag` project on GitHub.
+ * URLs that were redirected via a service on delphidabbler.com were replaced by hard coded URLs.
+* The export file format was changed to exclude personal user information. The original format can still be read but any user information is ignored and discarded.
+* Config file processing changes:
+ * Removed support for reading or writing data relating to removed features.
+ * When CodeSnip is first run after updating from an earlier version, any pre-existing config files are purged of any information that is no longer relevant.
+ * The common config file is no longer used by the portable edition. Any pre-existing file is deleted the first time the portable edition is run.
+ * The common and per-user config file versions were bumped to 7 and 16 respectively.
+* Welcome page changes:
+ * Removed the _Update Checks_ and _Donate_ sections and related links.
+ * Removed links used to check for program and database updates.
+ * Replaced the link used to display the news feed with one that displays the CodeSnip blog.
+* Added a "What's New" type of dialogue box that can be selectively displayed when a new version of CodeSnip is run for the first time. v4.16.0 _always_ displays the dialogue box when first run.
+* The operating system detection code was updated to correctly detect all Windows and Windows Server releases as of March 2020.
+* Revised the _About_ dialogue box:
+ * To display version and licensing information extracted from Code Snippets Database v2 meta data.
+ * To remove credits for 3rd party code that is no longer used.
+* The bug tracker dialogue boxes were updated re the change of issue tracker from SourceForge to GitHub.
+* Removed redundant pages and controls from the _Preferences_ dialogue box.
+* Removed the _Donate_ dialogue box and associated menu options.
+* Revised and re-ordered some menu options.
+* The program no longer generates and saves an application identifier key.
+* Bugs fixed:
+ * Corrected license information stored in the _Extra_ information section of imported SWAG packages.
+ * Fixed a text formatting error in the SWAG import wizard ([issue #4](https://github.com/delphidabbler/codesnip/issues/4)).
+ * Fixed broken help topic links in some dialogue boxes ([issue #3](https://github.com/delphidabbler/codesnip/issues/3))
+ * Fixed a bug in the portable edition's startup processing of its config file.
+ * Fixed the dialogue box displayed when updating from CodeSnip v3 or earlier to display an icon in the Windows task bar.
+ * Corrected the license details included in comments of generated source code that includes snippets from the main database.
+ * Corrected typos and errors in the UI.
+* Some source code refactoring and clarifications.
+* Removed redundant library code:
+ * Encryption library.
+ * Indy Internet components.
+* Help file overhauled: new topics added, redundant topics removed and many errors corrected. Some restyling.
+* Updated documentation, including:
+ * Major changes to `./README.md` and `./Docs/ReadMe.txt`.
+ * Merged all the major version specific changelogs into a single `./CHANGELOG.md` file and deleted the old files.
+ * File format documentation was overhauled re changes introduced in this release.
+ * Edited `./Docs/License.html` to remove license information and acknowledgements for 3rd party code that is no longer used.
+ * Fixed errors in `./Build.html` concerning the source code repository and made some other minor changes.
+ * Removed the privacy statement document, `./Docs/Privacy.txt` since CodeSnip no longer stores or transmits any personal information. (Also removed privacy help topic and menu item.)
+ * Removed `./Docs/Design/WebServices.txt` file that described the web services used by CodeSnip.
+
+## Release v4.15.1 of 22 September 2016
+
+* Updated OS detection code to detect Windows 10 Version 1607 (Anniversary update) and all technical previews of Windows 2016 Server to date.
+
+## Release v4.15.0 of 13 July 2016
+
+* Added support for test compilation with, and detection of, Delphi 10.1 Berlin compiler.
+* Tweaked size of compiler list in Configure Compilers dialogue box to accommodate length of Delphi 10.1 Berline compiler name!
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.14.0 of 19 March 2016
+
+* Changes to About Box's "Paths" tab:
+ * Added new buttons to display the contents of the system and per-user config files.
+ * Renamed tab as "Paths & Files".
+* Implemented [SourceForge] feature request #83 to enable the name and port of any web service test server to be passed on command line by using the new "--test-server" command line option. This replaces hard-wired test server name & port that was activated using the now removed "-localhost" command line switch.
+* Fixed [SourceForge] bug #96: "Some open / save dialogues too small". The height of customised dialogue boxes was increased.
+* Updated operating system detection code to detect Windows 10 TH2.
+* New photo of Sophie the dog added to the Easter egg slide show!
+* Updated help file re About Box changes.
+
+## Release v4.13.2 of 20 February 2016
+
+* Updated and corrected hints displayed in main window.
+* Changed some menu options and associated dialogue box captions.
+* Tweaked some button captions in Select Snippets dialogue box.
+* Updated help file re the menu and caption changes.
+* Updated copyright date in program license as displayed in help, about box, installer and documentation.
+
+## Release v4.13.1 of 29 September 2015
+
+* Improved operating system detection to detect Windows 10.
+* Modified program's manifest to declare it compatible with Windows 8 to 10.
+* Code that determines which system font to use no longer depends on OS version but simply on font availability.
+* Updated copyright date in program license as displayed in help, about box, installer and documentation.
+
+## Release v4.13.0 of 5 September 2015
+
+* Added support for test compilation with, and detection of, Delphi 10 Seattle compiler.
+* Made some minor changes to method used to build required type library to remove dependency on the MS MIDL compiler, greatly simplifying build process.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.12.0 of 6 May 2015
+
+* Added support for test compilation with, and detection of, Delphi XE8 compiler.
+* Updated documentation re changes.
+* Updated help file re changes and fixed some spelling mistakes.
+
+## Release v4.11.1 of 26 October 2014
+
+* Corrected an erroneous error message that is displayed when circular snippet references are detected in the snippets editor (no bug report filed).
+* Corrected some spelling errors in UI.
+* Some documentation corrections.
+
+## Release v4.11.0 of 25 September 2014
+
+* Changes re licensing of snippets from online Code Snippets Database under MIT license:
+ * Generated code now carries a reference to the MIT license where relevant.
+ * Submit Snippets wizard has a new page where user must confirm that any submitted snippets may be MIT licensed.
+ * "About the Database" of the About Box now refers to the license.
+ * Documentation and help file updated accordingly.
+* Now uses version 6 of the Code Snippets Database update web service which supports the downloading of category and source code files larger than 32Kb.
+* The undocumented -localhost command line option now causes CodeSnip to expect web services to be on localhost port 8080 instead of port 80. This change has no effect on normal operation and is used only in testing.
+* Minor layout tweaks in in Display tab of Preferences dialogue box.
+* Minor changes to help file and documentation.
+
+## Release v4.10.0 of 12 September 2014
+
+* Added support for test compilation with, and detection of, Delphi XE7 compiler.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.9.0 of 30 April 2014
+
+* Added support for test compilation with, and detection of, Delphi XE6 compiler.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.8.7 of 06 March 2014
+
+* Fixed automatic update checker so that it correctly records last update date. Fixes [SourceForge] bug #93.
+* Updated to use v2 of the DelphiDabbler CodeSnip update web service when checking for availability of program updates.
+* Minor corrections to help file.
+
+## Release v4.8.6 of 28 February 2014
+
+* Improved operating system detection to handle Windows 8.1.
+* Added compatibility section to application manifest that declares the program has been tested with Windows Vista and Windows 7.
+
+## Release v4.8.5 of 13 January 2014
+
+* Fixed [SourceForge] bug #91: "Generated units won't compile on Delphi XE5". Compiler directives that are used to change compiler warnings now includes a conditionally compiled $LEGACYIFEND ON directive.
+* Fixed potential bug when checking for the existence of files. It had been possible that a "sym-link" to a file could give misleading results.
+* Updated program copyright date in license file, about box, help file and installer.
+
+## Release v4.8.4 of 28 November 2013
+
+* Improved user interface of SWAG Import Wizard.
+* Renamed "Save Snippet" and "Copy Snippet" menu options to "Save Annotated Source" and "Copy Annotated Source". This fixes [SourceForge] bug #90: " Wrong caption on menu option for copying category to clipboard".
+* Revised and corrected numerous main menu and pop-up menu hints.
+* Updated help file re changes to menu options and SWAG Import Wizards.
+
+## Release v4.8.3 of 06 November 2013
+
+* Fixed registry access code so that the 64 bit view of the registry is used when CodeSnip runs on a Windows 64 bit operating system.
+* Changed to avoid use of a deprecated API call when using the Windows Browse for Folder dialogue box.
+* Updated documentation.
+
+## Release v4.8.2 of 30 October 2013
+
+* Modified Syntax Highlighter tab of Preferences dialogue box so that "vertical" fonts (whose names begin with "@") no longer appear in list of available fonts.
+* Fixed potential bug in operating system detection code that may fail on Windows 2000.
+
+## Release v4.8.1 of 18 September 2013
+
+* Removed "File | Page Setup" menu option because some settings made there were being ignored when a file was printed. This is a fix for [SourceForge] bug #89: "Setup selections not being remembered".
+* Updated help file re changes.
+
+## Release v4.8.0 of 12 September 2013
+
+* Added support for Delphi XE5 compiler.
+* Fixed bug in code that reads or imports user database files written using CodeSnip 3 where Delphi XE4 compile results would be lost.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.7.2 of 27 August 2013
+
+* Fixed [SourceForge] bug #88: "SWAG Import Wizard display bug" where duplicate snippets could be displayed on the "Ready to import" page in certain circumstances.
+
+## Release v4.7.1 of 18 August 2013
+
+* Fixed bug where right clicking a tab in the detail pane sometimes caused the contents of the pane to be temporarily blanked out while the context menu was displayed.
+* The above fix also, as a side effect, fixed [SourceForge] bug #87: "Tab headings and contents don't match after a tab is closed."
+
+## Release v4.7.0 of 31 July 2013
+
+* Implemented [SourceForge] feature request #71: "Support importing of one or more snippets from the SWAG database":
+ * Uses DelphiDabbler SWAG web service to get SWAG data.
+ * New wizard to permit user to select required SWAG snippets. This is accessible from the new "Snippets | Import Snippets From SWAG" menu option.
+ * Snippets are imported into a new "SWAG Imports" category.
+* Implemented [SourceForge] feature request #80: "Enable detail pane tabs to be re-ordered".
+* In detail pane source code and compiler table now display horizontal scroll bars if they do not fit within the width of the pane. This implements [SourceForge] feature requests #60 and #61.
+* Minor changes to dialogue box that appears during long operations.
+* Fixed [SourceForge] bug #86: "Snippets are sorted by snippet name in snippet table listings in detail pane".
+* Fixed a few code errors that could have surfaced as bugs.
+* Modified how HTML based detail pane display is generated and displayed.
+* Some refactoring.
+* Updated some 3rd party code to latest available versions.
+* Updated help file re changes.
+* Updated privacy statement.
+
+## Release v4.6.4 of 24 July 2013
+
+* Fix for IE 9 related browser control script bugs introduced in v4.6.3 when IE 10 bugs were fixed:
+ * [SourceForge] Bug #84: "Script errors on startup"
+ * [SourceForge] Bug #85: "Check For Updates link"
+
+## Release v4.6.3 of 14 July 2013
+
+* Further fix for IE 10 related [SourceForge] bug #75 "Floating point error in 4.4.1". Re-implemented method used to display content in main window's detail pane using the IE web browser control.
+
+## Release v4.6.2 of 09 July 2013
+
+* Tentative fix for [SourceForge] bug #83: "Error when the main form is shown" that has been reported on Windows 8. The fix is tentative because the bug hasn't been reproduced.
+
+## Release v4.6.1 of 01 July 2013
+
+* Provided fix for reported [SourceForge] bug #75: "Floating point error in 4.4.1" that apparently affects Windows 8, probably with IE 10 installed.
+* Fixed unreported bug where IE 10 browser was being reported as IE 9.
+* Fixed potential bug in code that processes class / advanced record snippet types ready for test compilation and inclusion in generated units.
+
+## Release v4.6.0 of 02 June 2013
+
+* Added new options to "Find Cross References" dialogue box to allow snippets that either cross reference or depend upon the selected snippet to be included in the search. This implements [SourceForge] feature request #30.
+* Added a new "Select and Close" button to the Dependencies dialogue box that causes the snippets displayed on the current tab to be selected in the main display. This implements [SourceForge] feature request #77.
+* The background colour of source code displayed in the main display can now be customised via a new option on the Display tab of the Preferences dialogue box. This implements [SourceForge] feature request #36.
+* CodeSnip now compiled with Delphi XE.
+* Per-user configuration file format changed to v15 which is not entirely compatible with previous versions of CodeSnip.
+* Updated help file re changes.
+
+## Release v4.5.1 of 15 May 2013
+
+* Added progress bars or marquees to several database operations that can take a long time on slower storage devices, i.e.:
+ * When local files are being updated after downloading an updated database in the Update From Web dialogue box. This fixes [SourceForge] bug #79:
+ * When the local database is being saved.
+ * When the local database is being backed up or restored.
+ * When the local database is being moved to a new location.
+* The user database can now be relocated to a network drive. This fixes [SourceForge] issue #81 "Move database to a network drive".
+* Fixed [SourceForge] issue #80 "HTML output bug".
+* Fixed minor alignment bug that occurred when displaying a wait dialogue box over the main window.
+* Some refactoring.
+* Updated help file re changes.
+
+## Release v4.5.0 of 02 May 2013
+
+* Added support for Delphi XE4 compiler. Implements [SourceForge] feature request #78.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v4.4.2 of 26 April 2013
+
+* Fixed [SourceForge] bugs:
+ * #76: An advanced record snippet with a method name that clashes with a directive is not test compiling correctly.
+ * #77: Syntax highlighter highlights "contains", "requires" and "package" directives when used in method names.
+ * #78: CodeSnip doesn't restore window in correct position when task bar on left or top of screen.
+
+## Release v4.4.1 of 09 April 2013
+
+* Fixed [SourceForge] bug #73: "Attempting to check for program updates returns a 404 'Not found' error" - this error happened only when using remote server, not localhost test server.
+
+## Release v4.4.0 of 08 April 2013
+
+* Implemented [SourceForge] feature request #75 "Check for updates on start-up":
+ * CodeSnip checks for both program and Code Snippets Database updates in low priority background threads that run when the program is first started.
+ * Update checking takes place at intervals between once per day and once per month.
+ * A new "Updates" tab was added to the "Preferences" dialogue box where update frequencies can be chosen, or the auto-update feature switched off. Program and database update checking can be configured individually.
+ * Updates are notified via a new slide-in, slide-out notification window that is displayed for a fixed amount of time or until closed by the user. The notification window contains a button that can be used to initiate the appropriate update. For database updates the "Update From Web" dialogue box is opened while for program updates a suitable download web page is displayed in the default browser.
+ * Program checking is edition specific, i.e. the standard edition checks for standard edition updates and the portable edition behaves similarly.
+* A new "Update Checks" section was added the welcome screen that gives information about the current auto-update settings and provides a link to change them. Some other text on the screen was tweaked.
+* The "Check For Program Updates" dialogue box now opens the correct version and edition specific web page to download the latest version of CodeSnip instead of simply opening a general download page.
+* A new CodeSnip specific program update web service on the codesnip.delphidabbler.com sub-domain is now used to get information about CodeSnip updates instead of the generic update service on delphidabbler.com.
+* Additional usage information is now sent to the DelphiDabbler Code Snippets database update web service.
+* Some refactoring and code clean-up.
+* The installer may now display an information page that describes the new automatic update checking feature. This page is displayed only when updating from v4.3.0 or earlier to v4.4.0 (or later).
+* Updated help file:
+ * Updated and added help topics for all new features of the release.
+ * Updated "What's New" topic re new features.
+* Updated documentation, including privacy statement, with information about automatic update checking.
+* Per-user configuration file format changed to v13 which is incompatible with previous versions of CodeSnip.
+
+## Release v4.3.0 of 27 February 2013
+
+* Implemented [SourceForge] feature request #40: "Add 'Namespaces' tab to Configure Compilers dialogue box". The new tab appears only for Delphi XE2 and later and obviates the need to manually create -NS commands for passing to the compilers. Suitable default namespaces are provided if none have been configured.
+* Implemented [SourceForge] feature request #70: "Let user specify location of user database". This feature is accessed from the new "Move Use Database" option on the Database menu. NOTE: The feature is not available in the portable edition which is designed to keep the user database together with the program.
+* Implemented [SourceForge] feature request #69: "Enable custom syntax highlighter styles to be saved". The Syntax Highlighter tab of the Preferences dialogue box has been modified to enable custom syntax highlighter attributes to be saved under a given name and existing named styles to be used or deleted.
+* Changed name of "Delphi 2006" predefined syntax highlighter to "RAD Studio". This remains the default highlighter.
+* A little refactoring.
+* Enlarged Configure Compilers dialogue box.
+* Updated help file:
+ * Updated and added help topics re all new features in the release.
+ * Updated "What's New" topic re new features.
+ * Removed help topic for "Browse For Folders" dialogue box accessed from Search Paths tab of Configure Compilers dialogue.
+* Per-user configuration file format changed to v12 which is not fully compatible with previous versions of CodeSnip.
+* Updated documentation.
+
+## Release v4.2.1 of 14 February 2013
+
+* Bug fix: changed Favourites dialogue to display snippet display names instead of unique names. Fixes [SourceForge] bug #72.
+* Updated program copyright date in About box.
+
+## Release v4.2.0 of 07 February 2013
+
+* Added support for "favourite" snippets. Implements [SourceForge] feature request #37:
+ * Any displayed snippet can be flagged as a favourite via a menu option or toolbar button.
+ * A new non-modal dialogue box can now be displayed alongside the CodeSnip window for easy selection and management of favourite snippets.
+* Changes to Duplicate Snippets dialogue box:
+ * Display name of duplicate snippet can be edited. Implements [SourceForge] feature request #64.
+ * Snippets Editor can be opened immediately the Duplicate Snippet dialogue box closes to edit the duplicated snippet. Implements [SourceForge] feature request #65.
+* Status bar changed: first panel now displays no category information, but displays both total number of snippets and number of snippets in each database.
+* Fixed unreported bug in save dialogue boxes where overwrite permission requests could be displayed erroneously.
+* Program closes gracefully if run on unsupported versions.
+* Updated some 3rd party code to latest available versions.
+* Some refactoring.
+* Per-user configuration file format changed to v11 which is not fully compatible with older versions of CodeSnip.
+* Updated help file re changes in Duplicate Snippets dialogue box and addition of support for Favourites.
+* Updated documentation.
+
+## Release v4.1.1 of 30 January 2013
+
+* Fixed [SourceForge] bugs:
+ * #68: Comments missing in unit / code generation for some types.
+ * #70: Changing syntax highlighter font has no effect in main display.
+ * #71: Option to select monochrome printing not working properly.
+ * Unreported: Changing syntax highlighter font has no effect when printing or when copying text to clipboard as RTF (related to bug #70).
+* Updated help file re syntax highlighter changes.
+
+## Release v4.1.0 of 06 January 2013
+
+* This is the first non-beta release to made available in both standard and portable editions, compiled from a common code base. The portable edition differs from the standard as follows (as per release v4.0.1 portable beta 1):
+ * Executable file name is CodeSnip-p.exe.
+ * Program caption identifies program as portable version.
+ * Data directories are sub-directories of executable program directory.
+ * Common file dialogue boxes default to program's working directory.
+ * First run processing does not give the option to import old settings or existing user databases.
+ * Different version information and program identifier.
+ * There is no set up program.
+* Changes to snippets editor:
+ * Added context menus to cross-references and dependencies check box lists. Both have menu item to clear list. Dependencies list has item to view dependencies. Implements [SourceForge] feature request #3560960.
+ * Deleted "View Dependencies" button now that its functionality is now on context menu.
+ * Enlarged various controls on all except "Code" tab.
+ * Units listed on "References" tab is now persistent. Units can be removed, defaults restored and selection cleared via a new context menu. Implements [SourceForge] feature request #3560962.
+* New source code formatting option added to only use first paragraph of a snippet description as snippet comment in generated code. This is configured via "Code Formatting" tab of "Preferences" dialogue box and / or from relevant "Save" dialogue boxes. Implements [SourceForge] feature request #3560647.
+* Changed mini-toolbar in overview pane to expand / collapse all overview tree view instead of just selected node. Implements [SourceForge] feature request #3560646.
+* Reimplemented database search engine.
+* Some external links modified that will seamlessly accommodate future changes in destination URLs.
+* Changed some glyphs used in menus.
+* Per-user configuration file format changed: bumped file version to 10.
+* Some refactoring.
+* Help file updated re changes & added privacy statement to TOC.
+* Updated documentation:
+ * Re changes to source code repository and bug / feature request trackers.
+ * Re portable version.
+
+## Release v4.0.2 of 17 December 2012
+
+* Improvements to keyboard handling:
+ * Fixed some keyboard focus bugs.
+ * Fixed broken, missing and duplicate Alt-key short-cuts in several dialogue boxes.
+ * Fixed broken keyboard access to list view in Code Generation tab of Preferences dialogue box.
+* Corrected an incorrect font in Compilers dialogue box.
+* Added title to "View Link" dialogue box displayed from mark-up editor.
+* Corrected error in "Submit Code to the Database" task help topic.
+
+## Release v4.0.1 portable edition, beta 1 of 12 December 2012
+
+Internal CodeSnip version 4.0.1.213
+
+* Modified version of Release v4.0.1 that can run from a writeable removable medium without writing files or registry on host computer. This implements [SourceForge] feature request #3577431.
+* Changes that apply only to portable version:
+ * Changed executable file name to CodeSnip-p.exe.
+ * Program caption changed to identify as portable version.
+ * Data directories changed to be sub-directories of executable program directory.
+ * Changed common file dialogue boxes to working directory by default.
+ * First run processing no longer gives option to import old settings or existing user databases.
+ * Different version information and program identifier format.
+ * No set up program.
+* Code base modified to conditionally compile either portable or standard edition.
+* Updated documentation, including privacy statement.
+
+## Release v4.0.1 of 08 December 2012
+
+Internal CodeSnip version 4.0.1.212
+
+* Fixed [SourceForge] bug #3578652: "Pre-processor directive errors in main db ini files" by removing support for problematic directives.
+* Rolling mouse over links in detail pane no longer displays a hint in the status bar. This change fixes [SourceForge] bug #3577407: Clicking detail pane snippet link leaves hint in status bar.
+* Windows no longer scale automatically when screen DPI differs from that on design system. This fixes [SourceForge] bug #3591818: "Strange window behaviour in Windows 7" and [SourceForge] bug #3591820: "Incorrect font size used for some bold text".
+* Update operating system detection code to detect Windows 8 & 2012 server.
+* Some refactoring and some redundant code removed.
+* Updated documentation.
+* Updated help topic that describes main display.
+
+## Release v4.0.0 of 12 October 2012
+
+_Final v4 release._
+
+See also changes from alpha, beta and release candidates below for details of changes since v3.9.3.
+
+* New glyphs that describes level of testing applied to snippets from online Code Snippets Database now appear in top right of detail pane.
+* Changed main window caption and task bar entry to include version number "4" after program name.
+* Fixed bugs:
+ * [SourceForge] bug #3572382 Automatic conversion of blank lines to paragraphs in REML mark-up editor gets confused if block level tags are already present.
+ * Unreported: Controls in News dialogue box do not use correct font.
+* A little refactoring.
+* Updated help file:
+ * Modified re recent changes
+ * Added new "What's new" topic giving details of changes in v4. Implements [SourceForge] feature request.
+ * Renamed "Welcome" page as "Overview".
+* Updated documentation, including read-me file.
+
+## Release v4.0 RC 3 of 18 September 2012
+
+Internal CodeSnip version 3.999.3
+
+* Fixed serious [SourceForge] bug #3568628: "CodeSnip faulting at startup after fresh install with no previous v3 installation".
+
+## Release v4.0 RC 2 of 17 September 2012
+
+Internal CodeSnip version 3.999.2
+
+* Fixed serious [SourceForge] bug #3568515: Duplicating a snippet with a display name causes crash.
+* Minor update to licensing information and about box credits.
+
+## Release v4.0 RC 1 of 14 September 2012
+
+Internal CodeSnip version 3.999.1
+
+* UI changes:
+ * Welcome page completely revised. Instead of a program overview the page now describes the state of the databases and available compilers and displays help links and a donation request. There are also some links to the about box, news and program updates.
+ * Many changes to glyphs used in menus and toolbar.
+ * Removed some images that relate to trade marks, i.e. PayPal Donate button and Delphi compiler icons.
+ * No clicking noise is now issued by UI in response to user interaction with Details pane.
+ * Links to external commands and to other snippets re-styled.
+ * Revised and updated program's main icon.
+* Fixed [SourceForge] bug #3566426: About Box Paths Page displays wrongly when themes not available.
+* Added support for Delphi XE3 compiler. Implements [SourceForge] feature request #3566346.
+* Completely new Easter Egg.
+* Refactoring and internal code changes, including a revision of the "external" object that communicates with JavaScript in browser controls.
+* Changed License:
+ * EULA for executable code changed to Mozilla Public License v2.0.
+ * Most original source code changed to Mozilla Public License v2.0 from v1.1.
+ * Only an abbreviated version of the license is now displayed by the installer and in the help file.
+ * License information has been consolidated into a new file: License.html.
+* About box changed re new license and changes in required and voluntary acknowledgements and credits.
+* Help file updated.
+* Documentation updated.
+
+## Release v4.0 beta 2 of 25 August 2012
+
+Internal CodeSnip version 3.99.2
+
+* [SourceForge] Bug fixes:
+ * #3556620: Serious flaw in generating units containing class types when the classes contain method types other than procedure or function.
+ * #3556713: Context menus are not displayed when pressing Alt+F10.
+ * #3556715: Deleting a category then returning to it via the history list causes a GPF.
+ * #3556718: Inconsistent context menus for edit controls in Snippets Editor.
+ * #3557107: New snippets and categories are not added to the history list.
+ * #3558649: Closing the Preferences dialogue always refreshes the main display even if the dialogue box was cancelled or if nothing was changed.
+ * #3559156: "Previews" giving examples of the effect of changes made in the Preferences dialogue box sometimes disappear when the tab key is pressed.
+ * #3559239: Snippet names and display names are used inconsistently in the UI.
+ * #3559257: Compile Results displayed from the main menu can get out of sync with the actual compile results of snippets that have been edited since they were last compiled.
+ * #3559265: Viewing dependencies for an unnamed snippet or a snippet not in the database causes a GPF.
+ * #3559266: When include files are generated for a snippet that depends on a class type, the required class is not listed in the file's header comments.
+ * #3560317: The caption of the Active Text preview dialogue box refers to "Extra" text when it is used to preview a snippet's description.
+ * #3560521: The state of the Overview tree often doesn't restore correctly after a database update.
+ * #3560958: Snippets are not sorted correctly (i.e. on display name) in the Overview pane.
+ * #3561014: The current view in the Display pane is not cleared, even though all tabs are closed, when the database is re-loading.
+ * #3561047: The Category view in the Overview pane sometimes appears fully expanded when it is expected to be fully collapsed.
+ * Untracked: Removed "(v4 preview)" text that had been left in main window title bar.
+ * Untracked: Minor accelerator key related problems in the Preferences dialogue box.
+* Main UI changes:
+ * The Detail pane tab-set now has a context menu that can be used to close the current tab or all but the current tab. The Close tab option is also added to current view's context menu.
+ * Right-clicking a tab in the Overview or Detail pane now selects the tab.
+ * Middle-clicking an item in the Overview pane now selects it. Previously middle clicks were ignored.
+ * Many more parts of the main display and dialogue boxes now display display names for snippets rather than unique names.
+ * Ctrl clicking snippet and category links in the Detail pane and History UI controls now opens the chosen item in a new tab. Implements [SourceForge] feature requests #3559377 and #3559378.
+ * Different link styles are now used for the different types of link in the Detail pane. Implements [SourceForge] feature request #3559464.
+ * Pressing Ctrl+Return on an active snippet or category link in the Details pane now opens the item in a new tab instead of the current tab. Pressing Return now opens the item in the current tab.
+ * The Detail pane's context menu now displays more options when text selections and links are right clicked. Implements [SourceForge] feature request #3559375 with some minor differences.
+ * New button added to the Display tab of the Preferences dialogue box that resets default snippet heading colours. Implements [SourceForge] feature request #3559140.
+ * The "Types" unit is now displayed by default in the Snippets Editor Reference Tab's predefined units list.
+* When a category is printed, any URLs in snippet descriptions are output and styled.
+* Names of units referenced by snippets may now contain dots.
+* Some refactoring and internal code changes, including a major reworking of the "first run" program configuration and a revision to the "external" object that communicates with JavaScript in browser controls.
+* Help file updated:
+ * Re UI changes.
+ * With a description of the need to configure namespaces for Delphi XE2 for each unit referenced by the code it is test compiling - addresses [SourceForge] bug.
+* Updated documentation.
+
+## Release v4.0 beta 1 of 11 August 2012
+
+Internal CodeSnip version 3.99.1
+
+* New features:
+ * Structure of snippet pages in details pane is now customisable: various page elements can be omitted and order of elements can be specified. Each snippet type has its own page customisation. Implements [SourceForge] feature request #3519456.
+ * Snippets can now have a "display name" that can contain any characters and does not need to be unique. When provided the display name is displayed in preference to the normal name. Implements [SourceForge] feature request #3519460.
+ * Snippet descriptions can now be formatted and contain multiple paragraphs. This implements [SourceForge] feature requests #3411890 and #3520405.
+ * Snippets can now be configured so that their source code is not syntax highlighted. This change allows snippets in other languages not to be highlighted as if they are Pascal. Implements [SourceForge] feature request #3519935.
+ * Colour of headings for snippets and categories from main and user databases are now user configurable. This implements [SourceForge] feature request #3519463.
+ * User can now limit the number of compilers that appear in the compiler results table in the display pane. This is done via the Configure Compilers dialogue box. Implements [SourceForge] feature request #3519459.
+ * New option on Tools menu that checks availability of new versions of CodeSnip.
+* User interface changes:
+ * "Test Compile" link removed from snippet display in details pane.
+ * "Test Compile" dialogue box changed so that only the installed compilers that CodeSnip uses for test compilation are displayed, instead of all known compilers.
+ * Welcome page revised.
+* Changes to snippets editor:
+ * New field on Code tab to enter optional snippet display name.
+ * New check box on Code tab to specify if Pascal syntax highlighter is to be used for source code.
+ * New tabbed "mark-up editor" lets user enter multi-paragraph snippet descriptions and extra information either as plain text or as REML mark-up.
+ * Controls on Code tab re-ordered.
+ * Extra Information tab revised with much larger edit control and deletion of explanatory text.
+ * Editor enlarged.
+* Changes to Preferences dialogue box:
+ * New "Snippet Layout" tab added where composition and layout of snippet pages can be customised.
+ * "General" preferences tab split into two: "Misc." that contains only measurement units and "Display" that contains display related options.
+ * Added controls to "Display" tab to set main and user database heading colours.
+ * Changes that affect appearance of content of details pane are now reflected in the display as soon as the Preferences dialogue box closes, rather than on program restart.
+* Changes to REML mark-up handling:
+ * Any REML text not embedded in block level tags is now automatically wrapped in `
`...`
` tags.
+ * Nested REML block level tags are no longer allowed.
+ * Changed handling of multiple spaces in REML code to be the same as in HTML.
+ * Formatting of REML code improved when re-displayed.
+* Bug fixes:
+ * [SourceForge] bug #3536331 fixed: words at the end of some paragraphs in a snippet's extra information were not being found in "whole word only" searches.
+ * Fixed unreported file parsing bug that occurred when loading a saved snippet selection from disk.
+* Changed Delphi compiler detection so that compilers can be detected by examining current user registry key in addition to local machine registry key. This enables Delphis that were installed for a given user only to be detected.
+* Improved error handling when reading and writing snippet selection files.
+* User database and export file formats updated to v6.
+* Per-user configuration file format changes: bumped file version to v9.
+* Major changes to installer:
+ * Now always brings forward any earlier common configuration files if needed.
+ * Per user configuration files are now ignored: they are handled by main program (see below).
+ * Only main database, not user database, is now imported from earlier versions on user request. User databases are now handled by main program (see below).
+ * There is no longer an option to delete old databases or configuration files.
+ * Updating from a v4 preview (alpha) release causes an extra page to be displayed that gives instructions relating to updating from preview to current release.
+* Program now detects if it is running for first time since updating:
+ * If this is first run since updating from v3 or earlier a "first run" wizard guides user through importing any old preferences or user databases.
+ * For point v4.x point updates user configuration file is silently updated as necessary.
+* Significant refactoring.
+* Updated help file in line with changes and new features.
+* Updated documentation, including minor changes to privacy statement and license.
+
+## Release v4.0 alpha 3 (preview) of 18 June 2012
+
+Internal CodeSnip version 3.98.3
+
+* New features:
+ * Compiler warnings can now be switched on as well as off in generated code.
+ * Names and descriptions of snippets in a category can now be printed.
+ * Text and compiler searches can now be nested so that the later search refines the earlier one.
+ * Current selection (i.e. search result set) can be saved to disk and loaded again later.
+* User interface changes:
+ * Overview pane now displays buttons that can be used to collapse or expand non-empty section headings.
+ * Ctrl+arrow keys can now be used to scroll overview pane tree view vertically and horizontally without changing selection in overview pane.
+ * Main window is now refreshed whenever changes that affect it are made in the Preferences dialogue box.
+ * Some main menu short-cut keys changed.
+ * Dependencies dialogue box now has two tabs: the first displays the snippets required to compile the selected snippet while the second tab displays snippets that depend upon the selected snippet.
+ * Code Generation tab of Preferences dialogue box updated to enable warnings to be switched on or off. In addition default warnings can be restored, list view columns can be sorted and Alt key short-cuts tweaked.
+ * Code Import dialogue box improved: now sorts imported units in list view and scrolls to make renamed snippets visible.
+ * Snippet selection and cross-reference search dialogues now report if existing search results will be overwritten.
+ * Text and compiler search dialogues now ask if any current search results are to be refined.
+ * Tree views in Snippet Selection, Snippets export and Snippets submission dialogue boxes can now be expanded and collapsed.
+ * Appearance of message boxes tweaked.
+ * Program tab of About box updated with credits for new third party code.
+* Bug fixes:
+ * Error in logic of code that generates program ID was fixed.
+ * [SourceForge] Bug #2868708 fixed: edited snippets are no longer lost from manual snippet selections unless snippet names are changed.
+ * [SourceForge] Bug #3534138 fixed: details pane display is now cleared when last tab is closed: previously content of last closed tab remained on screen.
+* Info about user's OS and IE version is now sent to web server during online database updates.
+* Some refactoring.
+* Help file updated in line with changes and new features. Some US English spellings changed to UK English for consistency.
+* Updated documentation, including:
+ * Privacy statement updated re changes in data recorded via database update log-ons.
+ * Licensing docs updated re introduction of some MPL 2.0 files.
+
+## Release v4.0 alpha 2 (preview) of 21 April 2012
+
+Internal CodeSnip version 3.98.2
+
+* New features:
+ * New "unit" snippet type that enables complete units to be stored in database and to be test compiled.
+ * New "classes" snippet type that enables a single Object Pascal class or advanced record-with-methods to be stored in database, test compiled and included in generated units.
+ * Snippets from both the user and main databases can now be duplicated. Duplicates are editable and are stored in the user database.
+ * Online CodeSnip FAQs can now be displayed in the default browser from a new option on the "Help" menu.
+* User interface changes:
+ * New "Snippets" and "Categories" top level menus have been added. They are populated with items previously on the "Database" menu. "Snippets" menu also has new "Duplicate Snippet" item.
+ * "Help" menu re-arranged: items from the former "On The Web" sub-menu are now placed directly on "Help" menu.
+ * Numerous new and updated glyphs on toolbar, menu and in main display.
+ * Minor tweaks to controls in the Code tab of the Snippets Editor.
+ * Minor changes to the style of version info displayed on the splash screen.
+* Bug fixes:
+ * Fixed potential source of a bug in code that edits user-defined categories.
+ * Fixed unreported minor bug in dialogue boxes that display tabbed page controls: clicking a tab did not always give it the keyboard focus.
+ * Fixed [SourceForge] bug #3519784 where multi-line "type" or "constant" snippets that start on the same line as the type or const keyword were corrupted when included in units using the "comments after snippet header" comment style.
+* Characters used to introduced switches on the command line were changed: '/' replaces '\'. '-' is still permitted.
+* User and main database formats modified. User databases saved with this version may not be readable with release 4.0 alpha 1.
+* Some refactoring.
+* Help file updated in line with changes and some errors fixed.
+* Updated documentation.
+
+## Release v4.0 alpha 1 (preview) of 31 December 2011
+
+Internal CodeSnip version 3.98.1
+
+**Changes relate to v3.9.3:** CodeSnip 4 development branched off CodeSnip 3.9.3. CodeSnip v3 continued to be developed in parallel.
+
+* User interface changes:
+ * New multi-tab detail pane can now show more than one snippet, category etc.
+ * Results of test compiles now appear in a dialogue box instead of in details pane.
+ * New code import wizard for cleaner control over import process.
+ * New "Compile" top level menu that groups all actions relating to test compilation.
+ * Empty section headings can now be displayed in overview pane if required.
+ * New display options relating to multi-tab display.
+ * New view displayed instead of welcome screen when database updated.
+ * Some additions and changes to main window navigation keys.
+ * Main window and task bar captions changed.
+ * Some dialogue boxes tweaked.
+ * Compiler configuration dialogue box heavily revised to support default compiler paths.
+ * "About" dialogue box paths tab display improved.
+ * Compile error dialogue box display standardised.
+ * Splash screen updated.
+* Improved Delphi code syntax highlighter:
+ * Recognises Delphi 2010 keywords
+ * Correctly handles context sensitive directives within "property", "exports" and "external" statements.
+ * Recognises `&` prefix that causes keywords to be treated as identifiers.
+* Compiler search paths can now be specified for included units permitting non-VCL units to be used by snippets.
+* Database:
+ * Non-empty categories can no longer be deleted.
+ * File format of both user-defined and main databases changed.
+ * Database locations changed: updates to main database and edits to user database do not affect databases used by v3 and earlier.
+ * Location and file format of both user defined and main databases changed.
+ * Database now supports Unicode Delphi source code.
+ * Unicode Delphi identifiers can now be used for snippet names.
+ * Export and backup file formats updated: new formats are not backward compatible but older versions can still be imported.
+ * Code submission service now supports Unicode source code.
+ * Database updates now use v5 of delphidabbler.com web update service with revised checksum handling.
+* Unicode support:
+ * Program now fully supports Unicode internally.
+ * Test units now use UTF-8 format if source code contains non-ANSI characters. ANSI format is used otherwise to permit compilation on older Delphi compilers.
+ * Many export file formats now support Unicode and UTF8 formats. User may specify file types from Save dialogue box.
+ * Configuration files are now in Unicode format.
+ * Some Unicode support added to database (see above).
+* Web service data handling code improved: now includes ability to send raw bytes and can detect and adapt to character encoding used in responses.
+* Common and per-user configuration file names and locations changed. Bumped file version numbers to 6 and 8 respectively.
+* Fixed some bugs:
+ * Various Unicode and code page related problems in RTF code generation.
+ * Memory leaks.
+ * Version detection in backup file restoration.
+* Cascading style sheet handling improved.
+* Any errors in scripts run in browser control now trapped and reported as exceptions instead of via browser control's own error dialogue box.
+* Revised external object that communicates with JavaScript in browser controls.
+* Hyper-links used in snippets now support the https:// protocol.
+* A default title now used in print spooler if none specified.
+* Source code heavily refactored.
+* Help file updated in line with changes.
+* Installer:
+ * Changed so that v3 and v4 installs can co-exist - default install locations are different and v4 does not overwrite v3.
+ * Converts v3 configuration files to v4 Unicode format and copies to new locations. File version stamps are updated.
+ * Installer is now compiled with Unicode version of Inno Setup instead of ANSI version.
+ * Scripts updated and refactored.
+* Updated documentation, including changes to privacy statement and new file format documentation.
+
+## Release v3.13.2 of 31 October 2013
+
+* Modified Syntax Highlighter tab of Preferences dialogue box so that "vertical" fonts (whose names begin with "@") no longer appear in list of available fonts.
+* Fixed potential bug in operating system detection code that may fail on Windows 2000.
+* Fixed registry access code so that the 64 bit view of the registry is used when CodeSnip runs on a Windows 64 bit operating system.
+
+## Release v3.13.1 of 18 September 2013
+
+* Removed File | Page Setup menu option because some settings made there were being ignored when a file was printed. This is a fix for [SourceForge] bug #89 "Setup selections not being remembered".
+* Updated help file re changes.
+
+## Release v3.13.0 of 12 September 2013
+
+* Added support for Delphi XE5 compiler.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v3.12.1 of 01 July 2013
+
+* Fixed [SourceForge] bug #82 "Fatal divide by zero exception on start-up" that affected all v3.x versions when the IE 10 browser was installed.
+* Fixed unreported bug where IE 10 browser was being reported as IE 9.
+* Updated all third party DelphiDabbler code to latest available versions.
+* Updated documentation re changes.
+
+## Release v3.12.0 of 02 May 2013
+
+* Added support for Delphi XE4 compiler. Implements [SourceForge] feature request #78.
+* Fixed [SourceForge] bug #78: CodeSnip doesn't restore window in correct position when task bar on left or top of screen.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v3.11.1 of 08 December 2012
+
+* Fixed [SourceForge] bug #3578654: "Pre-processor directive errors in main db ini files" by removing support for problematic directives.
+* Hints are no longer displayed in status bar when user rolls mouse over a link in the display pane. This fixes [SourceForge] bug #3577408: "Clicking detail pane snippet link leaves hint in status bar".
+* Windows no longer scale automatically when screen DPI differs from that on design system. This fixes [SourceForge] bug #3591818: "Strange window behaviour in Windows 7" and [SourceForge] bug #3591820: "Incorrect font size used for some bold text".
+* Updated operating system detection code to detect Windows 8 & 2012 server.
+* Updated documentation
+
+## Release v3.11.0 of 17 September 2012
+
+* Added support for Delphi XE3 compiler. Implements [SourceForge] feature request #3566345.
+* [SourceForge] Bug fixes:
+ * #3561713: The Category view in the Overview pane sometimes appears fully expanded when it is expected to be fully collapsed.
+ * #3566430: About Box Paths Page displays wrongly when themes not available.
+* Updated documentation re changes.
+* Updated help file re changes.
+
+## Release v3.10.5 of 21 August 2012
+
+* Fixed [SourceForge] bugs:
+ * #3559257: Compile Results accessed from menu can get out of sync.
+ * #3559156: "Previews" disappearing in Preferences dialogue box
+
+## Release v3.10.4 of 16 August 2012
+
+* Added support for displaying pop-up menus over appropriate control when Alt+F10 is pressed. Fixes [SourceForge] bug #3556713.
+* Changes to snippets editor:
+ * Added missing edit context menu to "add unit" edit control on References tab. Fixes [SourceForge] bug #3556718 as it relates to v3.
+ * Predefined list of units in Units list on References tab now includes the "Types" unit.
+ * Referenced unit names may now contain dots.
+ * Snippets Editor help topic now explains need to configure Delphi XE2 compiler to search namespaces containing referenced units. This provides a solution to [SourceForge] bug #3536531.
+
+## Release v3.10.3 of 25 July 2012
+
+* Changed so that Delphi compilers can be detected by examining current user registry key in addition to local machine registry key. This enables Delphis that were installed for a given user only to be detected.
+* Fixed bug in Compiler tab of Configure Compilers dialogue box that failed to flag selected compiler as unavailable after button was pressed.
+
+## Release v3.10.2 of 19 June 2012
+
+* Fixed [SourceForge] bug #3536331 where some distinct words in a snippet's Extra text where not being found in text searches.
+* Info about user's OS and IE version is now sent to web server during online database updates.
+* Updated privacy statement re changes in information sent by update web service.
+
+## Release v3.10.1 of 20 April 2012
+
+* Fixed [SourceForge] bug #3519784 where multi-line type or constant snippets that start on same line as type or const keyword were corrupted when included in units using the "comments after snippet header" comment style.
+* Also fixed potential source of a bug in code that edits user-defined categories.
+
+## Release v3.10.0 of 17 April 2012
+
+* Added new Help | On The Web | FAQs menu option to display CodeSnip FAQs in default browser.
+* Fixed unreported minor bug in dialogue boxes that display tabbed page controls: clicking a tab did not always give it the keyboard focus.
+* Characters used to introduced switches on command line were changed: '/' replaces non-standard '\'. '-' is still permitted.
+* Updated help file: added topic for new menu option and minor change to FAQ help topic.
+
+## Release v3.9.3 of 23 November 2011
+
+**Note:** Development of CodeSnip 4 branched off this release.
+
+* Fixed some bugs in main window:
+ * Toolbar was truncated when window is too narrow to display it all. It now wraps.
+ * Treeview state in Overview pane was not restoring correctly after navigating away from and then returning to a tab.
+ * Pressing Ctrl+Tab or Shift+Ctrl+Tab did not necessarily change the tab in the expected tab set in either the Overview or Detail panes.
+* Fixed a broken URL in about box.
+* Bumped installer program helper build number re Delphi 2010 compilation (should have been done at v3.5.1).
+
+## Release v3.9.2 of 28 October 2011
+
+* Fixed [SourceForge] bug #3427741 where details pane tabs didn't change in response to key presses.
+* Fixed [SourceForge] bug #3427866 where selection in overview was not always same as item displayed in details pane.
+* Fixed [SourceForge] bug #3427889 where there was the possibility of a GPF in overview pane.
+
+## Release v3.9.1 of 18 September 2011
+
+* Fixed [SourceForge] bug #3369422 in Pascal highlighter that was causing an assertion failure when parsing malformed Pascal general format floating point numbers.
+
+## Release v3.9.0 of 07 September 2011
+
+* Added support for Delphi XE2 Windows 32 bit compiler:
+ * Can now test compile and display results with Delphi XE2 32 bit.
+ * Delphi XE2 compiler version 23.0 has been added to the drop down menu in the Code Generation tab of the preference dialogue box.
+ * Updated help file re Delphi XE2 support.
+ * Updated documentation.
+* Limited user name edit control to 48 chars in registration wizard because this is limit in online registration database.
+
+## Release v3.8.11 of 02 July 2011
+
+* Fixed display problem in about box and compiler error dialogue boxes on systems using Internet Explorer v9 web browser control. This fixes [SourceForge] issue #3349186.
+* Updated read-me file re support for IE9 browser control.
+
+## Release v3.8.10 of 20 May 2011
+
+* Reverted checked tree views and list boxes to standard Windows behaviour. Clicking item text no longer toggles associated check boxes. This behaviour was more problematic then helpful.
+* Updated documentation, including new info about CodeSnip FAQ.
+* Added FAQs topic and TOC entry to help file that links to online FAQ.
+
+## Release v3.8.9 of 10 May 2011
+
+* Fixed [SourceForge] bug #3299870 that was allowing imported snippets with duplicate names to be renamed with invalid names.
+* Improved UI used to edit imported snippet names.
+* Any "warning" compile results in main database are now treated and displayed as "success" results per [SourceForge] feature request #3290359.
+* Fixed unreported potential bug in code that sets window class names.
+* Updated documentation.
+
+## Release v3.8.8 of 19 January 2011
+
+* Added facility for user to specify maximum age of news items displayed in news dialogue box. New preferences tab added where the maximum age can be customised.
+* Preferences dialogue box now displays multi-line tabs when necessary.
+* Refactored some code used to align controls on forms.
+* Updated license. License HTML help file is no longer MPLd and may not be altered by third parties.
+* Updated help file re changes.
+* Updated documentation.
+
+## Release v3.8.7 of 16 December 2010
+
+* Delphi XE compiler version 22.0 has been added to the drop down menu in the Code Generation tab of the preference dialogue box.
+* Bug fix: compiler results are no longer listed when free-form snippets are printed or copied to the clipboard using the "Edit | Copy Information" menu item.
+
+## Release v3.8.6 of 06 December 2010
+
+* Bug fix release (none reported in bug tracker):
+ * Corrected XML file validation so that it does not reject XML processing instructions that contain an "encoding" attribute.
+ * Fixed long standing bug that was crashing CodeSnip when the database was updated or restored after editing, adding or deleting any user defined snippet.
+ * Attempting to restore a database backup with an unknown (later) file format now raises an exception. Previously CodeSnip tried, unsuccessfully, to read the file.
+
+## Release v3.8.5 of 28 November 2010
+
+* Fixed bug where user was able to create snippets with valid names that would crash the alphabetic overview. Snippet names are now limited to letters from English alphabet and the underscore. Fixes [SourceForge] bug #3120958.
+* Fixed bug where snippets that have names beginning with a lower case letter were being omitted from from the associated list of snippets shown in the detail pane. Fixes [SourceForge] bug #3120962.
+* Updated Snippets Editor topic in help file.
+
+## Release v3.8.4 of 26 November 2010
+
+* User can now opt to terminate the application when an unexpected exception is trapped. This implements [SourceForge] feature request #3074914.
+* Wording of bug report dialogue boxes changed.
+* Snippets selection dialogue box now displays wait cursor while waiting for it to be displayed.
+* Some corrections and clarifications made to comments that appear in generated "include" files.
+* Custom message boxes can now display custom title and icon.
+* Imported some updates from "new-backend" development tree:
+ * Some source code re-organisation and renaming.
+ * Updated some sorted list management code.
+
+## Release v3.8.3 of 24 November 2010
+
+* Added button to "Compile" tab of Snippets Editor to display unit used to test compile snippets. This implements [SourceForge] feature request #3108008.
+* Fixed unreported bugs in handling of exceptions raised in threads.
+* Simplified method used to load database on start up. No longer uses a separate thread.
+* Overhauled and simplified code used to display "wait" dialogues during test compilations and database reloading.
+* Refactorings:
+ * Increased use of generics in lists and enumerators.
+ * Reorganised source code tree by moving some code to more relevant units, renaming some units and increasing use of namespaces.
+ * Removed some redundant code.
+* Updated help file re changes to snippets editor.
+
+## Release v3.8.2 of 16 November 2010
+
+* The position of the caret in the Snippets Editor's Extra Information control is now displayed. Implements [SourceForge] feature request #3105288.
+* Code that displays caret positions was refactored and improved.
+* Display of errors in the Snippets Editor's text edit controls has been improved in most cases either by positioning the caret near the error or selecting the erroneous text. This implements [SourceForge] feature request #3107042.
+* Made significant changes to code that parses REML mark-up:
+ * Rationalised error reporting and added support for reporting the position of errors.
+ * Fixed unreported bug that produced wrong error message when empty tags are encountered.
+ * Fixed [SourceForge] bug #3107982 that failed to report some unclosed tags as errors.
+ * Refactored and reorganised much of the code.
+* All encoding and decoding of URIs is now RFC 3986 compliant.
+* Refactored character detection and string encoding support code.
+* Renamed some units and classes.
+* Updated documentation.
+
+## Release v3.8.1 of 08 November 2010
+
+* Fixed [SourceForge] bug #3015589 where some user syntax highlighter settings were being ignored in main display.
+* Changed Test Unit view dialogue box to use user syntax highlighter settings.
+* Revised credits in About Box program tab.
+* Updated third party units: PJMD5 to v0.3, PJSysInfo to v3.3, PJVersionInfo to v3.3.
+* Modified version info code to use new features of new PJVersionInfo 3rd party unit.
+* Refactored code that parses XHTML-style code.
+* Updated compiler warnings used in project and made command line and IDE options the same.
+* Updated documentation.
+
+## Release v3.8.0 of 23 October 2010
+
+* Added support for Delphi XE to program. Can now test compile and display results with Delphi XE.
+* Updated help file re Delphi XE support.
+* Some refactoring.
+* Standardised bug-trap and assertion failure exception messages.
+
+## Release v3.7.0 of 23 September 2010
+
+* Added new "Help | CodeSnip News" menu option that displays latest news about CodeSnip and the online database in a dialogue box. The news comes from the CodeSnip RSS news feed.
+* Removed news pane from "Update from Web" dialogue box and replaced with button that displays new "CodeSnip News" dialogue box.
+* Removed mailing list subscription facility:
+ * Removed subscription dialogue box and associated menu option.
+ * Removed code that accessed mailing list web service.
+ * Removed subscription option from program registration dialogue box.
+* Fixed a memory leak.
+* Added code that downloads XML document and reads and parses RSS feeds.
+* Refactored and improved HTTP request handling code.
+* Some further refactoring.
+* Updated help file re changes in this release.
+* Updated privacy statement.
+
+## Release v3.6.3 of 22 July 2010
+
+* Completely overhauled code that interacts with web services.
+ * Character encodings are now correctly handled per information in HTTP header and several different encodings are supported.
+ * MD5 checksums in HTTP headers are now supported.
+* Updated and corrected the contents of the About Box's "About The Program" Tab.
+* Some refactorings, mainly to code that uses MD5 message digests.
+* Attempts to compile source with Delphi 2009 and earlier are now prevented.
+* Updated documentation.
+
+## Release v3.6.2 of 18 June 2010
+
+* Fixed source code formatting problem in code generator where "forward" declarations were sometimes preceded with an unwanted blank line.
+* Fixed potential bug in code that parses mark-up used for a snippet's Extra information. Symbolic entities were not case sensitive.
+* Fixed a memory leak.
+* Some refactorings that increase use of generics and some others.
+* Read-me file updated re v3.6.1 password changes.
+
+## Release v3.6.1 of 01 June 2010
+
+* Proxy server passwords can now contain any Unicode character, not just those included in the Windows-1252 code page.
+* Password format in per user ini file changed. Existing passwords have to be re-entered. Ini file format updated to v7.
+* Installer updated:
+ * It deletes any passwords from v6 and earlier per user ini files.
+ * Per-user ini file now stamped as v7.
+* Some potential Unicode-ANSI string conversion problems fixed.
+* Updated documentation.
+
+## Release v3.6.0 of 26 May 2010
+
+* Added support for emitting compiler directives to switch off specified warnings. This implement [SourceForge] feature request #2994485.
+* Preferences dialogue box updated:
+ * New "Code Generation" tab used to configure which if any warnings are to be inhibited.
+ * Renamed "Source Code" tab to "Code Formatting".
+* Added new tab to About Box that displays and enables exploration of some key directories used by CodeSnip.
+* Snippets editor now displays row and column occupied by text cursor.
+* Per user ini file format changed. It now supports code generation preferences. Ini file version updated to v6.
+* Installer updated:
+ * Ini files are stamped with correct program and ini file version information.
+ * Older versions (v1..v5) of per-user ini file are updated with default code generation preferences.
+ * Per-user ini file now stamped as v6.
+* Fixed numerous memory leaks.
+* Fixed some other potential and unreported minor bugs.
+* Some refactoring.
+* Updated help file re changes.
+
+## Release v3.5.5 of 24 March 2010
+
+* Fixes download stream read [SourceForge] bug #2976048.
+
+## Release v3.5.4 of 18 March 2010
+
+* Temporary fix for download error checking [SourceForge] bug #2970055.
+* Fixed https protocol [SourceForge] bug #2970896.
+
+## Release v3.5.3 of 08 March 2010
+
+* Fixed database download error checking [SourceForge] bug #2964767.
+* Updated PayPal donations narrative on welcome page.
+
+## Release v3.5.2 of 22 February 2010
+
+* Changed database downloader to:
+ * Use web service's revised download file format
+ * Validate download data before updating local database.
+ * Provide better download error messages.
+* Fixed [SourceForge] bug #2947794 in view link dialogue box.
+* Refactored some exception handling code.
+
+## Release v3.5.1 of 09 February 2010
+
+* New Unicode build of the program compiled with Delphi 2010. File I/O remains ANSI.
+* Windows NT is no longer supported. Windows 2000 is now the minimum OS. Set-up program changed to enforce this.
+* More rigorous enforcement of rules for REML tag attributes used in a snippet's Extra information.
+* Fixed a couple of minor UI problems in the Proxy Server and Trapped Bug Report dialogue boxes.
+* Minor changes to HTML and embedded browser code.
+* Some refactoring.
+* Updated documentation.
+
+## Release v3.5.0 of 16 January 2010
+
+* Overview pane can now be configured using Preferences dialogue box to start up with all sections collapsed.
+* Reference to ability to donate by credit / debit card removed from Donate dialogue box: now PayPal only.
+* Help file updated re above changes.
+* Minor refactoring of code that provides information about and renders source code comments.
+
+## Release v3.4.8 of 10 January 2010
+
+* Made some changes to key presses responded to by overview pane and fixed bug where Alt+F4 was not closing program when pane had focus.
+* Made some changes to hints displayed when rolling over links in compiler check pane. Also removed pop-up windows describing compiler errors.
+* Updated help file: noted Delphi 2010 compiler support and added new information about overview pane keyboard short-cuts.
+
+## Release v3.4.7 of 31 December 2009
+
+* Added IE version number to OS information submitted when program is registered.
+* Program now displays "[localhost]" in main window caption when started with -localhost switch.
+* All text edit controls in snippets editor now have custom pop-up menus and short-cuts for "cut", "copy", "paste", "select all" and "undo" now work.
+* Refactored code that supports use of fonts.
+* Updated privacy statement re registration changes.
+
+## Release v3.4.6 of 18 November 2009
+
+* Changed code that takes a security backup of main database during updates to store backup in a single file rather as separate files in a temporary folder. This should fix [SourceForge] bug #2898687.
+* Slightly modified user database backup file format to match that now used for main database backup.
+* Fixed potential bugs:
+ * Code that performs busy waits could have caused program to freeze.
+ * Negative numbers written to backup files were not being written correctly.
+ * A garbled error message was corrected.
+
+## Release v3.4.5 of 09 November 2009
+
+* Home, Ctrl+Home, End and Ctrl+End keys now work in overview pane and go to first and last item in tree view respectively per [SourceForge] feature request #2888880.
+* State of tree view in overview pane is now maintained after editing the user database: the tree is no longer always fully expanded after each edit.
+* Removed "Properties" button from print dialogue box along with associated dialogue boxes. This option has always been buggy. This "fixes" [SourceForge] bug #2868706.
+* Fixed unreported makefile bug.
+
+## Release v3.4.4 of 21 October 2009
+
+* Changed bug reporting mechanism. Bugs are now reported via the on-line bug tracker. Bug report dialogues changed accordingly. Access to the old bug report web service was removed.
+* Added two new default syntax highlighter styles: "Visual Studio" and "No Highlighter". The latter switches off syntax highlighting.
+* Fixed [SourceForge] bug #2882331. This was a bug in the syntax highlighter that occurred when an unexpected character was encountered.
+* Updated help file re changes.
+* Some minor source code corrections.
+
+## Release v3.4.3 of 19 October 2009
+
+* User's OS is now reported and recorded when program is registered.
+* Text displayed in preview dialogue boxes can now be scrolled horizontally.
+* Added support for building source against later releases of Indy 10 components.
+* Help file and privacy statement updated.
+* Further updated third party GIF image handling code to latest release.
+* Some changes to source code project options.
+
+## Release v3.4.2 of 10 October 2009
+
+* Fixed [SourceForge] bugs #2868706 and #2875857.
+* Updated GIF image handling code.
+
+## Release v3.4.1 of 29 September 2009
+
+* All dialogue boxes that request a user's name and / or email address now remember the information last entered, to save retyping the same data.
+* Changed to use Indy Internet Components v10 instead of v9 for net access.
+* Refactored:
+ * Code that stores information about a user.
+ * Code that gets details of system folders on local system and other file system related code.
+* Updated privacy statement (text file and in help file).
+
+## Release v3.4 of 24 September 2009
+
+* Added support for Delphi 2010 to program. Can now test compile and display results with Delphi 2010.
+* Bug fixes:
+ * "Invalid cast" error that occasionally appears when a snippet is updated.
+ * Bug that kept backup files locked open after restoring a database backup.
+ * Current selection is now displayed in Alphabetic and Snippet Kind tabs of overview pane: previously all the database was shown, regardless of search.
+
+## Release v3.3 of 21 September 2009
+
+* Added support for user defined categories which can now be added, renamed or deleted.
+* Made changes to snippets editor:
+ * On the "Compile Results" Tab, a single simplified list box is now used to both display and change compile results. This replaces two linked controls.
+ * The text case of a snippet name can now be changed without causing a duplicate name error.
+ * Some controls resized.
+* Fixed bug where attempting to overwrite files that are in use caused the bug report dialogue box to appear instead of simply reporting the problem.
+* Improved validity checking of snippets that are included in generated source code.
+* Help file updated.
+* Refactored:
+ * UI handling code in snippets editor.
+ * Some Snippets database and validation code.
+
+## Release v3.2.3 of 14 September 2009
+
+* Fixed bug in "update from web" dialogue box where most up to date news item was not being displayed.
+* Dialogue boxes that that enable selection of categories and snippets by means of tree views and associated check boxes now sort categories by description.
+* Categories and snippet kinds displayed in the snippets editor are now sorted by description.
+* Refactored:
+ * Code that displays tree views in overview pane and snippet selection dialogues.
+ * Some list management code.
+ * Some snippets editor code.
+
+## Release v3.2.2 of 08 September 2009
+
+* Fixed bug in check list boxes where moving selection using keyboard causes check state to be toggled.
+* Custom colours used in colour dialogue, on syntax highlighter page of preferences dialogue box, are now persistent.
+* Re-implemented code that displays pop-up menus in detail pane, and fixed a minor glitch as a side effect.
+* Simplified code that manages help system.
+* Refactored code that manages and customises common dialogues.
+
+## Release v3.2.1 of 24 August 2009
+
+* Appearance of comments that appear at the top of generated source code was changed.
+* Slightly modified "license" that appears at the top of some generated units.
+* Information about contributor of imported code is now appended to snippet's "extra" information.
+* Added a garbage collector.
+* Changed size of About box - now wider and credits scroll boxes are now taller. Added credit for encryption code.
+* Fixed minor bug that could display a JavaScript error dialogue if an exception occurred in an action initiated by clicking a link in the main display.
+* Numerous refactorings.
+
+## Release v3.2 of 17 August 2009
+
+* Added facility for CodeSnip to use a proxy server when accessing the Internet.
+* Provided a new dialogue box to configure any proxy server.
+* Updated help file re proxy server support and configuration.
+* UI is no longer frozen while web services are executing requests. "Update from Web" dialogue box changed to indicate if cancel button pressed when a web request is executing.
+* Product version reported in generated source code header comments, splash screen and about box now includes any special build information.
+* Some minor code tweaks and refactoring.
+
+## Release v3.1.1 of 15 August 2009
+
+* Check list boxes throughout program changed so that clicking anywhere on an item toggles check state.
+* Button used to render and display extra information in snippets editor is now disabled when there is no extra information to display.
+* Made minor changes to layout of some dialogue boxes: replaced missing text in bug report dialogue box.
+* Some refactorings.
+
+## Release v3.1 of 11 August 2009
+
+* Added a button to the snippets editor to preview an HTML rendering of the mark-up entered as extra information. Includes facility to check any links in the mark-up.
+
+## Release v3.0.5 of 21 July 2009
+
+* Default font is now dependent on underlying OS: Vista - Segoe UI, XP/2000 - Tahoma, NT - MS Sans Serif.
+* Some dialogues and splash screen modified to accommodate OS font, in particular larger Vista font. Some also given a light makeover.
+
+## Release v3.0.4 of 13 July 2009
+
+* Added a snippet's category description to main display and to snippet information copied to clipboard or printed. Category description in main display can be clicked to display the category.
+* Refactored code that displays clicked routines and code that displays a snippet for editing.
+
+## Unreleased v3.0.3 of 12 July 2009
+
+* Refactored code:
+ * Rationalised some JavaScript code.
+ * Rationalised some dialogue alignment code.
+ * Changed some object types and class hierarchies.
+ * Added some automatic object lifetime management logic.
+ * Removed some duplicate code and merged some units.
+* Fixed an obscure bug in category code snippet generation as a side effect of refactoring.
+
+## Release v3.0.2 of 08 July 2009
+
+* Fixed broken link to CodeSnip database in welcome page.
+* Fixed bug in selection search that was selecting both user defined and main database snippets with same name if only one was selected.
+* Fixed bug where units required by constants and type definitions were not being added to generated units.
+
+## Release v3.0.1 of 06 July 2009
+
+* Added support for file:// protocol in links in a snippet's extra information.
+* Updated help file re changes to extra info.
+* Updated exported code and user database file formats to v4 to accommodate revised extra information, although we now save data in v3 format if possible.
+
+## Release v3.0 of 29 June 2009
+
+* Added support for constants and type definition snippets: there are now four types of snippets - routines, constants, types and free-form (which don't conform to any format). Free-form snippets cannot be included in generated units.
+* Further formatting instructions added to the active text used in database's Extra information field. Also added a contributors field to database.
+* Three predefined syntax highlighters are now provided, with default changing to Delphi 2006 default style. Syntax highlighting used in main display is now customisable. Highlighter keyword list updated.
+* Main display changed:
+ * Test unit is no longer displayed in compiler check pane: it's now displayed in a dialogue box.
+ * Compiler check pane's font changed to true type, with face depending on OS.
+ * Information pane now hides compiler table when a free-form snippet is displayed.
+ * Compiler check pane now displays special "not available" pages when no compilers installed or a free-form snippet or a section header is selected.
+ * "Uncategorised" tab removed from overview pane and replaced with new "Alphabetical" tab that groups snippets by initial letter and "Snippet Kind" tab that groups snippets by kind.
+ * "Section" nodes in overview pane can now be expanded and collapsed: pane now has toolbar to perform these actions.
+ * "Edit snippet" links displayed in information pane are now also displayed in compiler check pane.
+ * Information about snippet type added to information pane.
+ * Context menu added to overview pane.
+ * Some changes to menu glyphs and short-cut keys.
+ * Welcome display modified and now has a link to the donate dialogue box.
+* Added option to copy an snippet's source code to clipboard in text and RTF formats.
+* Exporting and copying of snippets complete with descriptions and cross references is restricted to routines: not supported for free-form, types and constants.
+* Improved detection of invalid dependencies in snippets, including circular dependencies, and provided option to view all dependencies for any snippet from main window and snippets editor.
+* Revised content of many dialogue boxes etc to refer to "snippets" instead of "routines" where necessary.
+* Changed format and location of user-defined database and format of exported and submitted files.
+* Added new "Imported Snippets" category that receives imported routines: they were formerly imported into the "User Defined" category
+* Modified code that reads main database to deal with revised file format for new snippets types and introduction of pre-processor instructions to enable retrofitting of new snippets without breaking earlier versions of CodeSnip.
+* Changed name and location of user preference configuration file.
+* Revised external object that communicates with JavaScript in browser controls.
+* Updated program credits in about box, restyled and widened it.
+* Changed size of preferences dialogue box and revised syntax highlighter tab.
+* Changed captions in preview dialogue box.
+* Changed appearance of splash screen.
+* Modified snippets editor to work with new snippet types, improved error checking code and prevented test compilation of free-form snippets.
+* Speeded up loading of main database.
+* Added an Easter egg!
+* A few refactorings.
+* Fixed several bugs:
+ * Bug in backup files including database files larger than 32Kb was fixed.
+ * Bug in history list following editing user defined snippets fixed by clearing list after snippets have been edited.
+ * Imported user defined routines no longer forget any dependencies on main database snippets.
+ * Occasional bug in displaying test unit fixed by displaying test unit in dialogue box instead of main display.
+* Modified installer re new folder structure and copying over data from previous versions.
+* Revised help file to reflect changes. Added new main contents "chapter" about the various snippet types.
+
+## Unreleased v2.4.1 of 13 May 2009
+
+* Refactored code that provides information about the program and web URLs and services it accesses.
+* Changed URL accessed by donations dialogue box.
+
+## Release v2.4 of 11 May 2009
+
+* Added donate menu option and dialogue that accesses a PayPal donation web page.
+* Removed support for the Windows 9x platform since CodeSnip now generates fatal errors on that platform:
+ * Removed Windows 9x specific code.
+ * Changed installer to prevent installation on Windows 9x.
+* Updated help file re changes.
+
+## Release v2.3.7 of 26 April 2009
+
+* Made user name and email address entered in Code Submission Wizard persistent on a per-user basis.
+* Updated Code Submission Wizard and Privacy Statement help topics re the changes.
+
+## Unreleased v2.3.6 of 26 January 2009
+
+* Changed method that is used to get locale information to be compatible with Vista as well as earlier OSs.
+
+## Release v2.3.5 of 25 January 2009
+
+* Changed method used to generate HTML displayed in main program window to avoid dynamic updating of documents in attempt to counter a reported JavaScript bug.
+* Refactored generation of HTML tags in all parts of program that use HTML in display.
+* Corrected method naming error.
+
+## Unreleased v2.3.4 of 16 January 2009
+
+* Copy Source Code menu item now places a copy of selected snippet on clipboard in syntax highlighted rich text in addition to plain text.
+* Updated help file accordingly.
+
+## Unreleased v2.3.3 of 14 January 2009
+
+* Browser controls and snippets tree-views are now selected when containing frame is entered.
+* Discrepancy in way highlighting works in snippets tree-views fixed.
+* "&" characters are now rendered correctly in TMessageBox dialogues.
+* Code that executes compilers now uses one thread instead of two.
+* Refactorings:
+ * Some constants relocated.
+ * Rationalised some routine and method calls.
+ * Replaced some control character literals with constants.
+ * Updated IntfUIHandlers unit with IE6/7 related constants.
+
+## Unreleased v2.3.2 of 10 January 2009
+
+* Revised compilers object. Singleton instance removed. Local instances of object are created where needed.
+* Added new method to compiler objects to detect errors and warnings
+* Fixed incorrect caption in compiler error dialogue.
+* Added new object that manages test compilations, compiler set-up and viewing compile errors. Used by main form and snippets editor.
+* Added "View Compile Errors" menu option to Database menu.
+* Added Alt+V hot key to view compile errors in Snippets editor.
+* Updated help file for database menu to add "View Compile Errors" and missing entries for Submission, import and export of user database.
+
+## Unreleased v2.3.1 of 06 January 2009
+
+* Fixed test compilation bug in snippets editor that could corrupt compiler errors or warnings displayed from main display.
+* Added support for tab switching in compiler errors dialogue box using Ctrl+Tab and Shift+Ctrl+Tab.
+
+## Release v2.3 of 05 January 2009
+
+* Changed name of Copy Snippet menu item to Copy Source Code.
+* Added new Copy Information menu item to Copy menu - copies all snippet information to clipboard in text and RTF.
+* Added Save Database button to toolbar.
+* Changed status bar to display a count of user defined routines and an indicator that shows when user database has been modified.
+* Refactored and extended clipboard management code.
+* Added new buttons to selection search dialogue box to select user defined or main database routines.
+* Added facility to test compile routines to user defined snippets editor dialogue box.
+* Modified compiler errors dialogue box to be able to display results of compilation with more than one compiler.
+* Updated help file re changes.
+
+## Release v2.2.5 of 31 December 2008
+
+* Replaced routine's credits and comments properties with new Extra information property that can store formatted text.
+* Added parser for mark-up language used by new Extra property.
+* Modified snippets edit dialogue box to use new Extra property.
+* Changed main database, user database and export file format to support new Extra property. User database and export files generated by this version can't be read by earlier versions of the program.
+* Modified and refactored print document generation code to use new Extra property.
+* Refactored some HTML generation code.
+* Fixed a bug that occasionally causes a GPF when updating a user defined routine.
+* Removed redundant topic from help file.
+
+## Release v2.2.4 of 19 December 2008
+
+* Fixed bug in text and RTF preview dialogue boxes that was setting margins incorrectly and clipping displayed text.
+
+## Unreleased v2.2.3 of 17 December 2008
+
+* Refactored code that handles XML files (user database and import / export). Pulled out common code and further extended XML document object.
+
+## Unreleased v2.2.2 of 16 December 2008
+
+* Added glyphs to printers in print dialogue box.
+* Various refactorings of print and highlighting related code.
+* Printing now uses user-defined highlighters. Current highlighting is now previewed in print preferences.
+* Bug fixes:
+ * Help button now displays in page set-up dialogue on Vista.
+ * Page set-up dialogue now makes use of custom margin settings.
+
+## Unreleased v2.2.1 of 16 December 2008
+
+* Several refactorings:
+ * Rationalised email validation code.
+ * Rationalised exceptions raised when validating entry into dialogue box.
+ * Rationalised code that momentarily pauses execution of a thread.
+ * Made wide use of extended TRect structure.
+ * Changed various loops to use enumerators.
+ * Removed some unused code.
+* Fixed minor bug in open and save dialogues that occasionally failed to detect existence of a file.
+
+## Unreleased v2.2 of 15 December 2008
+
+* Added facility to submit user defined snippets via Internet for inclusion in main database.
+* Added facility to export user defined routines to file and to import exported files.
+* Made minor changes to wizard dialogue boxes.
+* Rewrote message dialogue box code.
+* Made minor changes to open and save dialogue boxes.
+* Updated help file for the new code import, export and submission features.
+
+## Release v2.1 of 11 October 2008
+
+* Added support for Delphi 2009 Win 32 personality.
+* Added a button to set all compiler results to success to snippets edit dialogue box.
+* Refactored some code.
+* Updated help file re Delphi 2009 support.
+
+## Unreleased v2.0.7 of 05 October 2008
+
+* Fixed residual bug in alt key bug work-around (CodeGear Quality Central bug report #374030). The bug was manifesting itself only for the first dialogue box displayed after the program started.
+
+## Unreleased v2.0.6 of 05 October 2008
+
+* Refactoring:
+ * Added class methods to instantiate and use various classes that have only one public method to save caller having to create, execute and destroy object. Public constructors of these classes were changed to cause assertion failure if directly called.
+ * Made static classes derive from new base class that causes assertion failure if constructor called.
+ * Combined some action update handlers in main form.
+ * Updated assertions and raising of EBug exceptions to programatically get name of class triggering error.
+ * Made some class' protected and private sections strict.
+
+## Unreleased v2.0.5 of 03 October 2008
+
+* Refactoring: changed custom save source dialogue to descend from extended save dialogue box.
+
+## Release v2.0.4 of 21 September 2008
+
+* Improved speed of looking up routines in database.
+* Prevented any user defined routine from referencing itself.
+* User defined routines now always reference routines from user database in preference to main database when there is a name conflict.
+
+## Unreleased v2.0.3 of 20 September 2008
+
+* Fixed bug that caused an assertion failure when an attempt was made to display the Select Routines dialogue box when an empty category was present in database.
+
+## Unreleased v2.0.2 of 19 September 2008
+
+* Now gives option to save changed user defined database before updated main database.
+* When a routine is updated or deleted references to it in other routines are updated or removed.
+* Corrected reference in installer to menu item used to update database (this changed from v2).
+
+## Release v2.0.1 of 18 September 2008
+
+* Fixed bug that fails to load user database and deletes it if a category is added to main database during on-line update.
+* Fixed bug that ignores any user defined snippets that have same name as snippets in main database.
+* Ensured main form is disabled when database is loading.
+* Ensured splash form is hidden if an exception occurs while splash form is displayed.
+
+## Release v2.0 of 15 September 2008
+
+* Added support for user defined snippets:
+ * User database can be edited, saved, backed-up and restored.
+ * User database can reference code in main database.
+ * Names of user defined snippets are coloured blue to distinguish them from main database.
+ * User database is stored as a mix of XML and source files in a sub-folder of the per-user application data folder.
+ * Queries can now be refreshed when content of user database changes.
+* Modified extended external object that communicates between browser controls and application.
+* Main database engine heavily modified.
+* Greater use of DHTML to manipulate main display.
+* Made browser pop-up menu display glyphs for items menu items that replicate links in browser control.
+* Modified welcome page to appear differently depending on state of main and user defined databases.
+* Disclaimers, copyright and other headers of saved, printed and copied documents changed.
+* Commenting of exported code changed slightly to allow for user snippets that may not support all commenting styles.
+* Fixed status bar display bug.
+* Category headers in overview pane are now in bold.
+* Added enumerators to several list objects to support for..in construct.
+* Tweaked exception handling.
+* Added support for converting GIF resources into bitmaps for use in image lists.
+* Changed URL used to access program's home page.
+* Updated help file to reflect changes.
+* Added credits for use of Anders Melander's GIFImage unit to about box.
+
+## Release v1.9.4 of 01 September 2008
+
+* Improved handling of errors encountered when running compilers.
+* Provided checks for invalid compiler executable files in Config Compilers dialogue box.
+* Added enumerator to Compilers object.
+* Made ECodeSnip exceptions and descendants clonable when copying between threads.
+
+## Unreleased v1.9.3 of 24 August 2008
+
+* Fixed bug in the database updater which could cause a deleted local file not to be noticed and not replaced.
+
+## Unreleased v1.9.2 of 24 August 2008
+
+* Changed method used to generate program key. No longer uses MAC Address, since code to find this fails on Windows Vista.
+* Refactored to remove knowledge of how contributor information and database are stored from TAppInfo class.
+* Revised code that manages contributors so that storage details are private to the classes.
+
+## Unreleased v1.9.1 of 24 August 2008
+
+* Rebuilt CodeSnip and install helper program with Delphi 2006:
+* Modified CodeSnip source to compile without warnings.
+* Replaced deprecated library calls with alternatives.
+
+## Release v1.9 of 14 August 2008
+
+* Changed so that all user accounts use the same database rather than having their own copy. Database now stored in common application data folder, along with registration information. Per-user configuration information remains in per-user application data folder in renamed file.
+* Installer can now optionally preserve data stored in database and configuration file used by earlier versions of the program. This involves creating new configuration files and moving the database.
+* Updated help file re these changes.
+
+## Unreleased v1.8.11 of 11 August 2008
+
+* Removed duplicate compiler glyph resources and modified compiler handling code accordingly.
+
+## Unreleased v1.8.10 of 11 August 2008
+
+* Refactored various units to use extended theme support.
+* Fixed redraw bug in tree views that use check boxes: check boxes were redrawing in wrong state when themes changed.
+* Improved support for theme changes. Theme manager now gets notified of changes directly from Windows.
+* Suppressed unnecessary compiler warnings.
+
+## Unreleased v1.8.9 of 10 August 2008
+
+* Modified Select Compiler dialogue box (opened from Configure Compiler dialogue) and Choose Element Colour dialogue (opened from Preferences dialogue) to be aligned correctly over dialogues, work correctly with Vista task bar and support help keywords.
+* Select Compiler file open dialogue now defaults to display any current compiler executable.
+* Choose Element Colour dialogue box now uses UK English and has custom title.
+* Added help topics for Select Compiler and Choose Element Colour dialogues.
+
+## Release v1.8.8 of 16 June 2008
+
+* Changed to make application minimisation, task bar preview window, and appearance in "Flip 3D" task switching display correctly on Windows Vista.
+* Provided work-around for Delphi's Alt key bug on XP and Vista (CodeGear Quality Central bug report #374030).
+
+## Unreleased v1.8.7 of 05 June 2008
+
+* Made selected tabs in information and detail pane persistent.
+* Fixed bug in build script.
+
+## Unreleased v1.8.6 of 02 June 2008
+
+* Fixed lock-up that could occur when displaying wait dialogue box while background tasks execute. Previous attempt to fix this problem failed.
+* Changed "marquee" that is displayed in wait dialogue box to appear correctly on Vista.
+
+## Release v1.8.5 of 30 May 2008
+
+* Fixed bug that was causing Save Snippet and Save Unit dialogue boxes to ignore file type
+ selected by user, always outputting default file type.
+* Deleted some unused source code.
+* Removed option to install a desktop icon from installer. Also refactored install script to conform to current Inno Setup standards.
+
+## Release v1.8.4 of 22 April 2008
+
+* Added manifest resource to ensure compatibility with Windows Vista and to use Vista themes.
+* Fixed border problem in web update dialogue box and about box when displayed under Vista / IE7 browser control.
+* Prevented selection of text in previews displayed in preferences dialogue box.
+* Updated set-up script to use macros.
+* Modified Build batch file to work with Windows SDK 2008.
+
+## Unreleased v1.8.3 of 05 November 2007
+
+* Refactored dynamic CSS generation code.
+
+## Unreleased v1.8.2 of 04 November 2007
+
+* Refactored assignable interfaced objects.
+
+## Release v1.8.1 of 04 November 2007
+
+* Made changes to browser control and URL handling.
+
+## Unreleased v1.8 of 04 November 2007
+
+* Added pop-up context menus to main display's detail pane.
+
+## Unreleased v1.7.7 of 29 October 2007
+
+* Modified code of compiler wait dialogue box and splash screen to try to prevent bug that occasionally prevent the dialogue from closing, locking up application.
+
+## Unreleased v1.7.6 of 18 October 2007
+
+* Shift-clicking links in the main display and some dialogue boxes was starting Internet Explorer. Fixed so that Internet Explorer is no longer started and shift-clicking external links now starts default browser.
+
+## Unreleased v1.7.5 of 17 October 2007
+
+* Modified Preferences dialogue box:
+ * Refactored code that displays measurement units.
+ * Preview on Source Code tab now takes on appearance of source code highlighter defined on Syntax Highlighter tab.
+* Changed format of ini file that stores persistent settings so that source code highlighter preferences are now stored in Prefs section of ini file rather than own section.
+* Customised installer to update existing ini files to revised version.
+
+## Release v1.7.4 of 14 October 2007
+
+* Fixed display bug when selecting routines following a text search.
+* Improved text search algorithm to permit search strings containing punctuation characters.
+* Fixed typo in the "About The Database" section of the About box.
+
+## Release v1.7.3 of 27 September 2007
+
+* Improved alignment of dialogue boxes and splash screen over owning forms. Alignment code substantially refactored.
+* Added support for multiple monitors.
+
+## Release v1.7.2 of 24 September 2007
+
+* Fixed bug that was preventing wait dialogue box from displaying during long compilations.
+
+## Unreleased v1.7.1 of 22 September 2007
+
+* Added list of testers to credits section of Database tab in About box.
+* Added new help menu item that displays privacy statement.
+* Rearranged help menu items.
+* Updated help file re changes to help menu.
+
+## Release v1.7 of 08 September 2007
+
+* Added new facility to print information about selected routines, with page set-up and printer configuration.
+* Added new "general" tab (sets default measurement units) and "printing" tab (to set printing defaults) to preferences dialogue box.
+* Changed format of ini file that stores persistent settings.
+* Updated help file to reflect changes.
+* Customised installer to update existing ini files to revised version.
+
+## Unreleased v1.6.4 of 02 July 2007
+
+* Corrected typos in generated source code header comments.
+* Added support for embedding titles in generated documents where document supports title meta data.
+* Added suggested file name to save unit and save snippets dialogue boxes.
+* Refactored code in syntax highlighter that generates XHTML.
+
+## Unreleased v1.6.3 of 13 May 2007
+
+* Added support for selecting and copying text displayed in preview dialogue.
+* Changed so that each document type displayed in preview dialogue box has same margins.
+* Updated help file re changes to preview dialogue box.
+
+## Unreleased v1.6.2 of 12 May 2007
+
+* Updated to use revised news data format provided by web service.
+* Update from Web dialogue box now displays number of news items along with page number of currently displayed item.
+
+## Release v1.6.1 of 09 May 2007
+
+* Fixed bug that allowed user to select a different routine while compiling another causing display to get out sync.
+
+## Release v1.6 of 08 May 2007
+
+* Added support for Delphi 2007 compiler.
+* Updated help file re new compiler support.
+
+## Release v1.5.13 of 04 March 2007
+
+* Fixed bug from v1.5.11 where Tools | Register CodeSnip and View | Show/Hide Test Unit menu options were permanently disabled.
+* Fixed bug from v1.5.9 where showing and hiding test units from menus was out of sync with links in compiler check pane.
+
+## Release v1.5.12 of 01 March 2007
+
+* Made long operations (loading database and compiling test units) execute in threads.
+* Changed to display wait dialogue while updated database is being loaded.
+* Made progress meters displayed in wait dialogues update more smoothly.
+
+## Release v1.5.11 of 25 February 2007
+
+* Added splash screen displayed when program is loading.
+* Main window, menu and toolbar is now disabled when program is initialising and when updated database is loading.
+* Program window is now centred on screen first time it is run and program is now never started minimized.
+
+## Unreleased v1.5.10 of 17 February 2007
+
+* Refactored code that handles web browser controls. Moved various pieces of code that manipulates and queries browser controls into central UI and IO manager classes. Also added helper classes to manipulate HTML documents and browser controls.
+* Some code made redundant by above changes was removed.
+* Lightened and centralised colours used to highlight text search results.
+
+## Unreleased v1.5.9 of 16 February 2007
+
+* Refactoring update. Revised code that manages the main display, i.e overview and details panes.
+
+## Release v1.5.8 of 16 February 2007
+
+* Fixed bug in view history where selecting an item from the history list could cause a crash after database has been updated. This was fixed by clearing the history list after updating the database.
+* Now clears the main display before re-displaying an updated database to prevent an item from the old version of the database being selected.
+
+## Unreleased v1.5.7 of 12 February 2007
+
+* Refactored, relocated and extended use of some utility routines, resulting in some other minor changes:
+ * All error and information message boxes now have properly terminated sentences.
+ * Generated XHTML less likely to contain illegal characters.
+
+## Unreleased v1.5.6 of 11 February 2007
+
+* Modified about dialogue box to display information about the Code Snippets Database in addition to the program. The two kinds of information are displayed in two tabs.
+* Added code to get list of database contributors from a file downloaded with database updates.
+
+## Unreleased v1.5.5 of 11 February 2007
+
+* Made keyboard interaction with application more consistent:
+ * Made browser controls activate and focus properly when user tabs into them.
+ * Fixed tab order problems in main display and about dialogue box so that only controls that may need to receive user input are now activated by tabbing.
+ * Links displayed in browser controls are always now included in tab sequence and can be activated by Ctrl+Return when focused.
+ * Fixed inconsistency in tab sets in overview and details pane responded inconsistently to Ctrl+Tab and Shift+Ctrl+Tab.
+* Changed browser control respond to activation via the mouse to be the same as for the keyboard.
+
+## Release v1.5.4 of 09 February 2007
+
+* Added disclaimers re database code to generated units and snippets and to program's welcome page.
+* Made slight modifications to source code generation code.
+
+## Release v1.5.3 of 08 February 2007
+
+* Refactored and rationalised code in main form and moved some code into help classes.
+* Revised code that performs customisation, auto-sizing and alignment of forms and dialogue boxes.
+* Standardised execution method of dialogue boxes.
+
+## Unreleased v1.5.2 of 04 February 2007
+
+* Refactored help manager system to make it easier to swap in new help systems in future.
+* Modified help handlers in forms to remove redundant code.
+* Modified how help menu items call help topics.
+
+## Unreleased v1.5.1 of 04 February 2007
+
+* Refactored handling of database searches by creating new global query object to store information about current query on database.
+* Changed relevant code to use the new object and deleted resulting redundant code.
+* Made some other minor code improvements and modifications.
+
+## Unreleased v1.5 of 03 February 2007
+
+* Made status bar display database and search information along with other prompts in addition to displaying hints.
+
+## Unreleased v1.4.6 of 17 December 2006
+
+* Made minor changes to appearance:
+ * Changed some colours to system colours from hard-wired colours.
+ * Changed help links in main display from blue to green.
+ * Removed text highlighting from welcome page.
+
+## Unreleased v1.4.5 of 04 December 2006
+
+* Refactored code that generates test units. As a consequence names of test units displayed in Compiler Check pane have been corrected to the actual names used in test compilations.
+
+## Release v1.4.4 of 04 December 2006
+
+* Added new menu item to View menu that toggles visibility of test units in the compiler check tab.
+* Changed glyph used for link that performs same action in compiler check tab and made image change depending on visibility of test unit.
+
+## Unreleased v1.4.3 of 03 December 2006
+
+* Changed information pane to load routines dynamically via DHTML rather than reloading document each time.
+* Refactored DHTML code and detail frames that support DHTML.
+* Refactored routine HTML generation code.
+* Rationalised some dynamic CSS generating code.
+* Revised information pane's underlying HTML code.
+
+## Unreleased v1.4.2 of 03 December 2006
+
+* Corrected alignment of About and Compiler Errors dialogue boxes over main form.
+
+## Unreleased v1.4.1 of 03 December 2006
+
+* Fixed bug where Test Compile menu option and tool button were always enabled and could cause an assertion failure when no routine was selected or no compilers were available.
+
+## Unreleased v1.4 of 03 December 2006
+
+* Revised display in compiler check pane. Now lists database and test results side by side.
+* Changed routine compiler check page to be updated dynamically (using JavaScript) when routine selection changes rather than always reloading page.
+* Modified some JavaScript support code.
+* Fixed potential bug in compiler code.
+* Updated help file re changes to Compiler Check tab.
+* Fixed a typo and index error in help file.
+
+## Unreleased v1.3.5 of 01 December 2006
+
+* Changed to display a border-less message dialogue during long test compilations. The dialogue is not displayed for shorter compilations.
+* Updated help file re above and fixed an error in the search menu topic.
+
+## Unreleased v1.3.4 of 26 November 2006
+
+* Refactored JavaScript used to interface between main program and HTML display.
+* Centralised generation of JavaScript in main code.
+
+## Unreleased v1.3.3 of 25 November 2006
+
+* Refactored handling of CSS and XHTML:
+ * Changed way CSS is provided to enable use of system font and colours.
+ * Tidied source HTML documents to remove illegal XHTML strict attributes and to remove hard-wired colours.
+
+## Release v1.3.2 of 24 November 2006
+
+* Made program remember whether test units are displayed or hidden until end of session.
+
+## Unreleased v1.3.1 of 21 November 2006
+
+* Made minor modification to appearance of Configure Compilers dialogue box.
+
+## Unreleased v1.3 of 18 November 2006
+
+* Added facility to sign up to CodeSnip mailing list on-line.
+* Corrected further typos in registration wizard.
+* Updated help file re mailing list sign-up, changed privacy statement and added license to contents page.
+
+## Release v1.2.5 of 16 November 2006
+
+* Corrected and modified text displayed on last page of Registration Wizard when user elects to join mailing list.
+
+## Unreleased v1.2.4 of 14 November 2006
+
+* Changed about box and help menu to display end user license agreement in help file rather than separate text file.
+* Added license topic and made related changes to help file.
+
+## Unreleased v1.2.3 of 12 November 2006
+
+* Fixed incorrect glyph used for Show All search menu item and tool button.
+* Moved Tools | Preferences menu option to top of Tools menu.
+
+## Unreleased v1.2.2 of 12 November 2006
+
+* Added hot tracking to tree view check boxes used in Select Routines dialogue box when Windows XP themes are enabled.
+
+## Unreleased v1.2.1 of 11 November 2006
+
+* Refactoring release:
+ * Method used to construct and use help file changed.
+ * Moved code that detects HTML and RTF files to appropriate utility units.
+ * Streamlined code in preview dialogue box.
+
+## Release v1.2 of 11 November 2006
+
+* Changed syntax highlighter used to format units and code snippets to be able to read custom settings from persistent storage.
+* Added Syntax Highlighter tab to preferences dialogue box to enable users to customise the font, style and colours used by the syntax highlighter.
+* Modified preferences dialogue box's Source Code tab to display a preview of routines using various comment styles.
+* Updated help file re revised preferences dialogue box.
+
+## Unreleased v1.1.2 of 07 November 2006
+
+* Refactoring release:
+ * Added code to generate CSS properties.
+ * Added new classes to generate RTF code.
+ * Re-implemented RTF highlighted code.
+* Now generates much smaller RTF export files.
+
+## Unreleased v1.1.1 of 31 October 2006
+
+* Changed Select Routines dialogue to use XP style check boxes when XP themes active and custom check boxes when XP themes inactive.
+
+## Release v1.1 of 30 October 2006
+
+* Added ability to generate and save whole Pascal unit containing currently selected routines.
+* Added new search that can find all routines cross-referenced by a given routine.
+* Added ability to manually select routines that are displayed in overview pane.
+* Added short-cut key and changed glyph for File | Save Snippet option / tool button.
+* Updated way source code preferences are stored. Broke backwards compatibility with previous storage method, so upgraders may loose settings.
+* Made minor changes to preferences dialogue box.
+* Word-wrapped long uses lists in generated units.
+* Refactored code that determines type of exported files.
+* Refactored and expanded code that deals with source code exporting.
+* Fixed some minor bugs:
+ * Previews of large rich text documents were displaying RTF source instead of rendering document.
+ * Assertion failure could (rarely) happen when displaying message boxes without specifying parent form.
+ * Saving snippets in a file without supplying a file extension could silently overwrite existing files.
+ * Comment style was being ignored when generating a unit.
+* Updated help file:
+ * Added new topics, index entries and TOC entries for new features.
+ * Updated some existing topics to refer to new features.
+ * Revised and corrected several existing help topics.
+
+## Unreleased v1.0.3 of 26 October 2006
+
+* Refactored various parts of source code. No changes to program's functionality. Details are:
+ * Standardised all singleton objects on interface based implementation.
+ * Centralised code that gets location of license file.
+ * Standardised links that trigger JavaScript in some HTML resources.
+ * Changed bug report dialogue box to descend from common wizard dialogue box.
+
+## Release v1.0.2 of 25 October 2006
+
+* Changed so that links from program to external web pages display in default browser rather than IE.
+* Refactored code that displays license text file in external application.
+* Reworded some of welcome screen and added links to on-line database.
+* Refactored some JavaScript code that works with main display HTML and web browser code.
+* Made minor changes to hints displayed in status bar when cursor is over links.
+
+## Release v1.0.1 of 14 October 2006
+
+* Fixed problem in web update that caused program to crash on Windows 9x platforms.
+
+## Release v1.0 of 09 June 2006
+
+* Revised About Box text and appearance and added link that displays license file.
+* Refactored and renamed some code.
+* Made minor changes to appearance and effect of Configure Compilers dialogue box.
+* Fixed potential bug displaying JavaScript error dialogue if help called from links in main display fail.
+* Made some literal strings resource strings.
+* Made calls to help system fail gracefully on machines without HTML Help installed.
+* Modified code that reads program's version information.
+* Added important compiler directives.
+* Standardised appearance of all groups of action links in main display.
+* Added Help menu item to display license and to access CodeSnip web page.
+* Moved bug report and registration menu options from Help to Tools menu.
+* Updated and help file re new commands, corrected some errors and re-styled menu help sections.
+* Created installer using Inno Setup.
+* Added new batch file to build program.
+* Fully commented code.
+* Changed to new end user license agreement for the executable program. The program remains open source.
+
+## Release v1.0 RC 3 of 01 May 2006
+
+Internal CodeSnip version 0.12.0
+
+* 3rd release candidate for the v1.0 release.
+* Updated to use v4 of update web service that uses completely new update protocol. Significant changes to code were needed to achieve this.
+* Redesigned update dialogue box accordingly.
+* Added ability to update dialogue to display latest CodeSnip news delivered as part update process.
+* Updated help file re changes to update dialogue box.
+
+## Release v1.0 RC 2 of 16 April 2006
+
+Internal CodeSnip version 0.11.3
+
+* 2nd release candidate for the v1.0 release.
+* Fixed bug where user could drag and drop files onto web browser controls and file contents would overwrite the display.
+
+## Release v1.0 RC 1 of 11 April 2006
+
+Internal CodeSnip version 0.11.2
+
+* 1st release candidate for the v1.0 release.
+* Updated help file:
+ * Ensured that external links display in a web browser window rather than in the help window.
+ * Added additional internal links to some help topics.
+* Fixed compiler warnings.
+* Removed some redundant code.
+
+## Unreleased v0.11.1 Beta of 10 April 2006
+
+* Improved and fixed interaction with database update web service:
+ * Download manager now sends program's key and registration code to web service instead of place-holder strings.
+ * Handling for HTTP error messages improved. Short HTTP error descriptions are displayed rather than full content of error pages.
+
+## Release v0.11.0 Beta of 07 April 2006
+
+* Added ability to register CodeSnip at DelphiDabbler.com:
+ * Registration is performed via a new wizard that gathers registration information and interacts with web server.
+ * Wizard is accessed via a Help menu option and About box button that appear only when application is unregistered.
+ * Application is identified by a unique key.
+ * Registration information is stored in persistent storage.
+* Reworked and added classes to centralise access to system and application information.
+* Updated help file with details of registration dialogue and CodeSnip mailing list.
+
+## Unreleased v0.10.12 Beta of 04 April 2006
+
+* Improved code that stores global application settings. Prepared way for having per-user and global settings rather than just per-user settings as at present.
+
+## Unreleased v0.10.11 Beta of 03 April 2006
+
+* Revised to work with v3.1 of CodeSnip database update web service.
+
+## Unreleased v0.10.10 Beta of 02 April 2006
+
+* Added program icon (16x16, 32x32 and 48x48 versions).
+
+## Release v0.10.9 Beta of 02 April 2006
+
+* Fixed bug where browser controls displayed JavaScript error dialogue when exceptions were raised by database updates initiated from browser control's "external" object.
+* Refactored some code in main form and main snippets object as a result of above fix.
+* Also refactored some of search code in main form.
+
+## Unreleased v0.10.8 Beta of 02 April 2006
+
+* Removed bug in database update manager that was causing database to be restored unnecessarily.
+* Heavily refactored update manager code as part of bug fix.
+
+## Release v0.10.7 Beta of 28 January 2006
+
+* Fixed display problems in details pane when running on Windows 2000.
+* Changed style of scroll bars from flat to normal when running in Windows XP classic style or on earlier Windows version.
+* Made compiler check pane update itself when compilers are added or removed.
+
+## Release v0.10.6 Beta of 20 January 2006
+
+* Fixed bug where backup directory was not being deleted after database updates.
+
+## Release v0.10.5 Beta of 14 January 2006
+
+* Added credits for third party code to about box.
+* Completed help file.
+
+## Release v0.10.4 Beta of 12 January 2006
+
+* Added checking of checksums of downloaded files to increase security. Exceptions now raised when a file's checksum is incorrect.
+* Fixed small alignment problem in update dialogue.
+
+## Unreleased v0.10.3 Beta of 11 January 2006
+
+* Changed so that compiler output is now captured directly rather than via temporary log file.
+* Compiler execution is now time-sliced and time-limited rather than being allowed infinite processing time.
+
+## Unreleased v0.10.2 Beta of 10 January 2006
+
+* Reverted to Delphi 7 to avoid Delphi 2006 bug that was enabling dialogues to be minimized and maximized.
+* Reordered controls in Find Compiler dialogues.
+* Restored title bar close button to web update dialogue.
+* Reverted to Indy 9 Internet controls (from Indy 10) and made relevant adjustments to code.
+* Completed help topics for Find Text and Find Compiler dialogues.
+
+## Release v0.10.1 Beta of 09 January 2006
+
+* Removed debug code (message box) mistakenly left in compiler execution code.
+* Refactored compiler support classes.
+
+## Release v0.10.0 Beta of 08 January 2006
+
+* Added support for Delphi 2005/6 Win32 compilers.
+* Refactored some compiler support code.
+* Added support for user-configurable compiler switches.
+* Used new tabbed layout for Configure Compilers dialogue box and added tab for configuring compiler switches.
+* Updated help file to reflect redesign of Configure Compilers dialogue box.
+
+## Release v0.9.0 Beta of 06 January 2006
+
+* Added facility to copy code snippets to clipboard.
+* Added new preferences dialogue box to enable configuration of default format for code snippets.
+* Added new preferences class to persist data entered in the preferences dialogue.
+* Refactored main snippets class to simplify addition of new copy snippet facility.
+* Updated help file re new additions.
+
+## Unreleased v0.8.3 Beta of 04 January 2006
+
+* Modified to compile with Indy Components v10 and Delphi 2006 for Win 32.
+
+## Unreleased v0.8.2 Beta of 04 January 2006
+
+* Created static class to interpret command line and changed other code to work with the new class.
+
+## Unreleased v0.8.1 Beta of 04 January 2006
+
+* Fixed minor display bug in web update dialogue box.
+* Fixed about box's problem in displaying help in response to F1 key press.
+
+## Release v0.8.0 Beta of 30 November 2005
+
+* Changed help file from WinHelp (.hlp) format to HTML Help (.chm) format.
+* Changed program to use new format help file.
+
+## Release v0.7.7 Beta of 22 November 2005
+
+* Refactored and revised code that accesses DelphiDabbler web services.
+* Updated to use v2 of the database update web service.
+* Added topics for Bug Report dialogue and Web Update dialogue to help file.
+
+## Release v0.7.6 Beta of 04 June 2005
+
+* Fixed Delphi compiler auto-detection bug.
+* Fixed bug that caused endless loop of exceptions when "database" was corrupt.
+* Syntax highlighter now generates correct XHTML for multi-line comments and generates correct CSS for mono-spaced fonts.
+* Occasional failure to create compiler log files now reported as error rather than bug.
+
+## Release v0.7.5 Beta of 03 June 2005
+
+* Fixes bugs that surface when user has disabled scripts in IE's Internet zone. Program no longer runs in Internet zone.
+
+## Release v0.7.4 Beta of 09 May 2005
+
+* Made user defined settings in Save Snippets dialogue box persistent.
+
+## Unreleased v0.7.3 Beta of 25 April 2005
+
+* Disabled test compile button on compiler checks pane along with associated menu and toolbar button when no compilers installed.
+* Rewrote main welcome page, adding links to compiler check dialogue. Made same welcome page appear in both detail panes.
+* Updated compiler check pages by adding links to compiler check dialogue and new "about compiler checks" help topic.
+* Updated help file with new "about compiler checks" topic and completed "QuickStart" topic.
+* Added new features to DOM's external object to support above changes.
+
+## Unreleased v0.7.2 Beta of 21 April 2005
+
+* Refactored code that maintains persistent application data.
+* Refactored syntax highlighter code and moved interfaces and enumerated types to own unit.
+* Renamed unit generation unit now that it generates source code other than complete units.
+* Carried out minor refactoring of Pascal analyser unit.
+
+## Unreleased v0.7.1 Beta of 20 April 2005
+
+* Disabled F1 key press handling in dialogues with no help button. Was triggering bad topic errors in WinHelp.
+* Added "Compile" prefix to compiler check page's "Test Compile" button.
+* Fixed errors in "do nothing" doc host handler used by web browser control.
+
+## Release v0.7.0 Beta of 17 March 2005
+
+* Added new facility to save a routine, or a whole category of routines, to file.
+* Reworked syntax highlighter implementation.
+* Updated help file with details of new routine saving feature.
+
+## Release v0.6.0 Beta of 10 March 2005
+
+* Added syntax highlighting for source code displayed in detail panes.
+
+## Release v0.5.0 Beta of 05 March 2005
+
+* Added support for Free Pascal compiler by totally reworking the compiler support engine.
+* Added new dialogue box to configure compilers. Compiler detection ability retained but now only works in response to user request.
+* Revised about box to include "powered by Delphi" logo.
+* Updated help file:
+ * Added incomplete topics for each of the main menus.
+ * Added complete new topic for the compiler configuration dialogue box.
+ * Fixed K-keyword errors and added extra keywords for dialogue boxes.
+
+## Release v0.4.0 Beta of 28 February 2005
+
+* Text search results are now highlighted when routines are displayed in the information pane.
+
+## Unreleased v0.3.4 Beta of 26 February 2005
+
+* Separated back end database code from Snippets object.
+* New back end code designed to make it easy to change the data provider in future versions. Current version accesses data in .ini and .dat files.
+
+## Unreleased v0.3.3 Beta of 25 February 2005
+
+* Fixed bug that was preventing Ctrl+F from activating Find Text dialogue box.
+* Realigned controls in bug report dialogue and fixed tab order problems.
+* Fixed email address validation error in bug report dialogue
+
+## Unreleased v0.3.2 Beta of 24 February 2005
+
+* Refactored code that provides compiler names and introduced global Compilers object.
+
+## Unreleased v0.3.1 Beta of 24 February 2005
+
+* Centralised code that displays message dialogues and standardised their appearance.
+
+## Unreleased v0.3.0 Beta of 23 February 2005
+
+* Updated welcome pages to provide more help on using CodeSnip.
+* Removed dialogues that appeared on start up when database was empty. Welcome page now provides this information along with an option to download database.
+* Improved handling of welcome page.
+
+## Unreleased v0.2.4 Beta of 23 February 2005
+
+* Refactored and simplified access to dialogue boxes.
+* Improved search code.
+
+## Unreleased v0.2.3 Beta of 23 February 2005
+
+* Created a class hierarchy for all frames that display HTML in a web browser control.
+
+## Unreleased v0.2.2 Beta of 22 February 2005
+
+* Localised various literal strings and moved some constant values to a common location.
+
+## Unreleased v0.2.1 Beta of 22 February 2005
+
+* Overhauled web browser external object extender that communicates browser events to application.
+* Added new notifier object that centralises handling of GUI user interaction.
+
+## Unreleased v0.2.0 Beta of 21 February 2005
+
+* Made minor changes to appearance of main display.
+* Refactored the HTML generation engine, added several HTML templates to resources and localised all strings used in generated HTML.
+
+## Unreleased v0.1.4 Beta of 19 February 2005
+
+* Refactored some code.
+
+## Unreleased v0.1.3 Beta of 18 February 2005
+
+* Removed redundant code.
+
+## Unreleased v0.1.2 Beta of 18 February 2005
+
+* Removed debug code.
+
+## Unreleased v0.1.1 Beta of 18 February 2005
+
+* Fixed minor bugs.
+
+## Release v0.1.0 Beta of 30 January 2005
+
+* Original beta release.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..8531ff7e8
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,195 @@
+# Contributing
+
+Thanks for you interest in contributing to the CodeSnip project.
+
+## Contents
+
+* [Overview](#overview)
+* [Issues](#issues)
+* [Documentation](#documentation)
+* [Coding](#coding)
+* [About Pull Requests](#about-pull-requests)
+* [Licensing of Contributions](#licensing-of-contributions)
+* [Code of Conduct](#code-of-conduct)
+* [Attributions](#attributions)
+
+## Overview
+
+Contributions of all kinds are more than welcome.
+
+> 💡 You will need a GitHub account to be able to make contributions. [Sign up here](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account).
+
+There three main ways in which you can contribute, each of which is explained in its own section below. From easiest to hardest, they are:
+
+* [Issues](#issues) - report bugs and request new features.
+* [Documentation](#documentation) - improve the project's documentation.
+* [Coding](#coding) - modify the project's source code.
+
+Regardless of how you choose to contribute, please respect the project's [code of conduct](#code-of-conduct).
+
+## Issues
+
+The easiest way to make a contribution is to [create an issue](https://github.com/delphidabbler/codesnip/issues/new).
+
+You can use issues to:
+
+1. [Report a bug](#reporting-a-bug)
+2. [Request a new program feature](#requesting-a-new-feature)
+3. [Suggest changes to documentation](#suggesting-documentation-changes)
+
+It is helpful if you perform a cursory search of [existing issues](https://github.com/delphidabbler/codesnip/issues?q=is%3Aissue) to see if there is already a similar issue. If so then please add your thoughts as comments on that issue rather than open a new one.
+
+### Reporting a bug
+
+Before reporting a bug please make sure the bug exists in the [latest release](https://github.com/delphidabbler/codesnip/releases) of CodeSnip 4.
+
+To report a bug please provide as much information about the bug as possible, including the program's version number, what happened, what you expected to happen and what you were doing at the time. If possible, explain how to reproduce the bug.
+
+> 💡 You can find CodeSnip's version number in the program's About box (_Help | About_ menu option).
+
+If you have resolved an issue yourself please consider contributing your fix so that others can benefit from your work. Please read the [Coding](#coding) section before doing so.
+
+### Requesting a new feature
+
+If you think of a feature that you would like to see added to CodeSnip you can open an issue to request it.
+
+Please be as clear as possible about what you expect the feature to do and why you want it.
+
+Ideas about how to implement the feature are welcome. Even better, if you have implemented the feature yourself, you may be able to contribute the code. But please read the [Coding](#coding) section before doing so.
+
+### Suggesting documentation changes
+
+The third reason to create an issue is if you want to suggest new documentation or ammendments to existing documentation.
+
+There are two types of documentation within the CodeSnip repository. Firstly, there is general documentation that can be found in the [repository root](https://github.com/delphidabbler/codesnip/tree/develop) and in the [`Docs`](https://github.com/delphidabbler/codesnip/tree/develop/Docs) directory. Secondly, there are numerous HTML help files in the [`Src/Help/HTML`](https://github.com/delphidabbler/codesnip/tree/develop/Src/Help/HTML) directory.
+
+If you have written or corrected some documentation yourself please consider submitting it. See the [Documentation](#documentation) section below to find out how to do this.
+
+## Documentation
+
+Writing and editing documentation is a relatively easy way to start contributing. Providing simple clear or helpful documentation for users is critical. Things that *you* found hard to understand as a user, or difficult to work out, are excellent places to begin.
+
+There are two ways to contribute documentation. The preferred method is by means of a [pull request](#about-pull-requests). But, you can simply create an issue and attach documentation files to the issue comments. This approach is perfectly acceptable for a small number of files, and saves you having to install Git!
+
+## Coding
+
+Code contributions to the [CodeSnip 4 development tree](https://github.com/delphidabbler/codesnip/tree/develop) are always welcome, from fixing bugs to developing new features.
+
+> 🐘 Before going any further, let's address the elephant in the room. CodeSnip has to be compiled with the now rather ancient Delphi XE. It would be much better if development could move to a more recent version of Delphi, but that's proving to be extremely problematic. See [this FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md#faq-11) for an explanation.
+
+If you're still here, you will need to set up a valid build environment in order to compile CodeSnip from source. [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/develop/Build.html) tells you everything you need to know about configuring the environment, the tools you will need, and how compile CodeSnip using the provided `Makefile`.
+
+> 💡 Need ideas? You can [browse open issues](https://github.com/delphidabbler/codesnip/issues) and see if you can help with any of them.
+
+Contributions should normally be made using [pull requests](#about-pull-requests).
+
+But, if you have just a few lines of code to suggest it _may_ be possible to accept the code within (or attached to) a comment on an issue. If in doubt, ask first by means of a comment. When including the code in a comment, please use [GitHub code fencing](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to format the code and make it easier to read. For example:
+
+ ```pascal
+ procedure TFoo.CoolNewMethod;
+ begin
+ // cool code here
+ end;
+ ```
+
+## About Pull Requests
+
+All pull requests *must* relate to an [open _accepted_ issue](https://github.com/delphidabbler/codesnip/issues?q=is%3Aissue+label%3Aaccepted++is%3Aopen+) on GitHub.
+
+If you wish to contribute code for which there is no existing issue you can create one. Please wait for the issue to be accepted by the project owner before submitting your pull request. Acceptance is indicated by attaching an "accepted" label to the issue and is signed off by means of a comment on the issue from the project owner.
+
+> 💡 Should you get stuck at any point please ask for help by leaving a comment on the relevant issue.
+
+Before you can start you need to get the source code. Here's how:
+
+1. Fork the CodeSnip project into your own GitHub repository.
+
+ ⭐***Important***⭐ _Ensure that all remote branches are included in the fork_, not just `master`. On GitHub this means clearing the "Copy the `master` branch only" check box before creating the fork.
+
+2. Clone the forked repository onto your own system using:
+
+ $ git clone https://github.com//codesnip.git
+
+ where `` is your GitHub user account ID.
+
+CodeSnip uses the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology. This means that you need to create your source code on a "feature" branch off the `develop` branch. Here's how:
+
+1. Pull the `develop` branch from your forked repository, and switch into it:
+
+ $ git pull origin develop
+ $ git switch develop
+
+2. Create and switch to a new feature branch, branched off `develop`.
+
+ Name the branch `feature/` followed by the issue number to which it relates. Appending a hyphen followed by a brief description is useful too. Example branch names are `feature/42-fix-ui-bug` or `feature/56`:
+
+ $ git branch feature/42-fix-ui-bug
+ $ git switch feature/42-fix-ui-bug
+
+3. Make your changes, whether to source code or documentation, and commit them to your feature branch. Clarity is prefered to terseness in commit messages. Please don't squash logically unrelated commits.
+
+4. If you are editing source code you need to ensure that it compiles and works as expected.
+
+ > 💡 Having trouble? Please make sure you have read [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/develop/Build.html). If that doesn't solve your problem then ask for help by creating a comment on the relevant issue.
+
+Once you have finished writing the code and are ready to submit it you need to prepare your forked repository:
+
+1. Use GitHub to ensure that the `develop` branch of your fork is up to date with the parent `delphidabbler/codesnip` repository's `develop` branch.
+
+2. Rebase your changes onto your forked repository's remote `develop` branch:
+
+ $ git rebase origin/develop feature/42-fix-ui-bug
+
+3. Resolve any conflicts arising from the rebase then push your changes to your forked repository:
+
+ $ git push origin feature/42-fix-ui-bug
+
+You are finally ready to open that pull request. Proceed as follows:
+
+1. Open your forked repository on GitHub. You should see a banner saying something like "feature/42-fix-ui-bug had recent pushes ..." along with a button that says "Compare and Pull Request". Click that button.
+
+2. You will be taken the "Comparing Changes" page on `delphidabbler/codesnip`.
+
+ ⭐***Important***⭐ Just below the page title is a line of drop-down buttons where you choose what to compare. Check the caption of the 2nd button from the left. If it reads anything other than "base: `develop`" (and it probably doesn't) then click the button and select `develop` from the list of branches that is displayed.
+
+ > ⚠️ Pull requests based on `master`, or any branch other than `develop`, will not be accepted.
+
+3. Now complete the form and click the "Create Pull Request" button.
+
+That's it.
+
+Sit back and wait. Either your pull request will be accepted or you will receive comments requesting clarification or changes.
+
+Once your pull request is accepted you can delete the feature branch from both your local and forked remote fork.
+
+## 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, but you can add your own copyright line if desired.
+
+Any new file you contribute **must** either be licensed under the [Mozilla Public License v2.0](https://www.mozilla.org/MPL/2.0/) (MPL2) or have a license compatible with the MPL2. If a license is not specified then MPL2 will be assumed and will be applied to the file. You should insert a suitable copyright statement in the file.
+
+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`](https://raw.githubusercontent.com/delphidabbler/codesnip/master/Docs/MPL-2.0-Boilerplate.txt). You will need to change the name of the copyright holder.
+
+## Code of Conduct
+
+This is a simple and straightforward code of conduct. What it boils down to is that if you're a decent person you're more than welcome here. Hateful, abusive and just plain rude people are not.
+
+To be more precise, anyone who contributes to the CodeSnip project is expected to display respect, empathy and politeness towards others.
+
+Certain behaviours will not be tolerated, and will result in an immediate ban. They are:
+
+* Racism and hate speech in any form.
+* The use of sexualized language or imagery, and sexual attention or advances of any kind.
+* Intolerance towards people of any religion or none.
+* Trolling, insulting or derogatory comments, and personal or political attacks.
+* Public or private harassment.
+* Publishing others' private information, such as a physical or email address, without their explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Attributions
+
+1. The list of unacceptable behaviours in the Code of Conduct was taken, in part, from the "Our Standards" section of the [Contributor Covenant Code of Conduct v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+
+2. Some of the content of this document was inspired by and/or copied from the [Stumpy Contributing Guide](https://stumpy.readthedocs.io/en/latest/Contribute.html).
\ No newline at end of file
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
diff --git a/Docs/ChangeLogs/ChangeLog-v0.txt b/Docs/ChangeLogs/ChangeLog-v0.txt
deleted file mode 100644
index 82c2642a9..000000000
--- a/Docs/ChangeLogs/ChangeLog-v0.txt
+++ /dev/null
@@ -1,211 +0,0 @@
-; ------------------------------------------------------------------------------
-; 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 http://mozilla.org/MPL/2.0/
-;
-; Copyright (C) 2012, Peter Johnson (www.delphidabbler.com).
-;
-; $Rev$
-; $Date$
-;
-; Change Log for CodeSnip Release 0 (Beta releases)
-; ------------------------------------------------------------------------------
-
-Unreleased v0.11.1 Beta of 10 April 2006
-+ Improved and fixed interaction with database update web service:
- - Download manager now sends program's key and registration code to web service instead of place-holder strings.
- - Handling for HTTP error messages improved. Short HTTP error descriptions are displayed rather than full content of error pages.
-
-Release v0.11.0 Beta of 07 April 2006
-+ Added ability to register CodeSnip at DelphiDabbler.com:
- - Registration is performed via a new wizard that gathers registration information and interacts with web server.
- - Wizard is accessed via a Help menu option and About box button that appear only when application is unregistered.
- - Application is identified by a unique key.
- - Registration information is stored in persistent storage.
-+ Reworked and added classes to centralise access to system and application information.
-+ Updated help file with details of registration dialogue and CodeSnip mailing list.
-
-Unreleased v0.10.12 Beta of 04 April 2006
-+ Improved code that stores global application settings. Prepared way for having per-user and global settings rather than just per-user settings as at present.
-
-Unreleased v0.10.11 Beta of 03 April 2006
-+ Revised to work with v3.1 of CodeSnip database update web service.
-
-Unreleased v0.10.10 Beta of 02 April 2006
-+ Added program icon (16x16, 32x32 and 48x48 versions).
-
-Release v0.10.9 Beta of 02 April 2006
-+ Fixed bug where browser controls displayed JavaScript error dialogue when exceptions were raised by database updates initiated from browser control's "external" object.
-+ Refactored some code in main form and main snippets object as a result of above fix.
-+ Also refactored some of search code in main form.
-
-Unreleased v0.10.8 Beta of 02 April 2006
-+ Removed bug in database update manager that was causing database to be restored unnecessarily.
-+ Heavily refactored update manager code as part of bug fix.
-
-Release v0.10.7 Beta of 28 January 2006
-+ Fixed display problems in details pane when running on Windows 2000.
-+ Changed style of scroll bars from flat to normal when running in Windows XP classic style or on earlier Windows version.
-+ Made compiler check pane update itself when compilers are added or removed.
-
-Release v0.10.6 Beta of 20 January 2006
-+ Fixed bug where backup directory was not being deleted after database updates.
-
-Release v0.10.5 Beta of 14 January 2006
-+ Added credits for third party code to about box.
-+ Completed help file.
-
-Release v0.10.4 Beta of 12 January 2006
-+ Added checking of checksums of downloaded files to increase security. Exceptions now raised when a file's checksum is incorrect.
-+ Fixed small alignment problem in update dialogue.
-
-Unreleased v0.10.3 Beta of 11 January 2006
-+ Changed so that compiler output is now captured directly rather than via temporary log file.
-+ Compiler execution is now time-sliced and time-limited rather than being allowed infinite processing time.
-
-Unreleased v0.10.2 Beta of 10 January 2006
-+ Reverted to Delphi 7 to avoid Delphi 2006 bug that was enabling dialogues to be minimized and maximized.
-+ Reordered controls in Find Compiler dialogues.
-+ Restored title bar close button to web update dialogue.
-+ Reverted to Indy 9 Internet controls (from Indy 10) and made relevant adjustments to code.
-+ Completed help topics for Find Text and Find Compiler dialogues.
-
-Release v0.10.1 Beta of 09 January 2006
-+ Removed debug code (message box) mistakenly left in compiler execution code.
-+ Refactored compiler support classes.
-
-Release v0.10.0 Beta of 08 January 2006
-+ Added support for Delphi 2005/6 Win32 compilers.
-+ Refactored some compiler support code.
-+ Added support for user-configurable compiler switches.
-+ Used new tabbed layout for Configure Compilers dialogue box and added tab for configuring compiler switches.
-+ Updated help file to reflect redesign of Configure Compilers dialogue box.
-
-Release v0.9.0 Beta of 06 January 2006
-+ Added facility to copy code snippets to clipboard.
-+ Added new preferences dialogue box to enable configuration of default format for code snippets.
-+ Added new preferences class to persist data entered in the preferences dialogue.
-+ Refactored main snippets class to simplify addition of new copy snippet facility.
-+ Updated help file re new additions.
-
-Unreleased v0.8.3 Beta of 04 January 2006
-+ Modified to compile with Indy Components v10 and Delphi 2006 for Win 32.
-
-Unreleased v0.8.2 Beta of 04 January 2006
-+ Created static class to interpret command line and changed other code to work with the new class.
-
-Unreleased v0.8.1 Beta of 04 January 2006
-+ Fixed minor display bug in web update dialogue box.
-+ Fixed about box's problem in displaying help in response to F1 key press.
-
-Release v0.8.0 Beta of 30 November 2005
-+ Changed help file from WinHelp (.hlp) format to HTML Help (.chm) format.
-+ Changed program to use new format help file.
-
-Release v0.7.7 Beta of 22 November 2005
-+ Refactored and revised code that accesses DelphiDabbler web services.
-+ Updated to use v2 of the database update web service.
-+ Added topics for Bug Report dialogue and Web Update dialogue to help file.
-
-Release v0.7.6 Beta of 04 June 2005
-+ Fixed Delphi compiler auto-detection bug.
-+ Fixed bug that caused endless loop of exceptions when "database" was corrupt.
-+ Syntax highlighter now generates correct XHTML for multi-line comments and generates correct CSS for mono-spaced fonts.
-+ Occasional failure to create compiler log files now reported as error rather than bug.
-
-Release v0.7.5 Beta of 03 June 2005
-+ Fixes bugs that surface when user has disabled scripts in IE's Internet zone. Program no longer runs in Internet zone.
-
-Release v0.7.4 Beta of 09 May 2005
-+ Made user defined settings in Save Snippets dialogue box persistent.
-
-Unreleased v0.7.3 Beta of 25 April 2005
-+ Disabled test compile button on compiler checks pane along with associated menu and toolbar button when no compilers installed.
-+ Rewrote main welcome page, adding links to compiler check dialogue. Made same welcome page appear in both detail panes.
-+ Updated compiler check pages by adding links to compiler check dialogue and new "about compiler checks" help topic.
-+ Updated help file with new "about compiler checks" topic and completed "QuickStart" topic.
-+ Added new features to DOM's external object to support above changes.
-
-Unreleased v0.7.2 Beta of 21 April 2005
-+ Refactored code that maintains persistent application data.
-+ Refactored syntax highlighter code and moved interfaces and enumerated types to own unit.
-+ Renamed unit generation unit now that it generates source code other than complete units.
-+ Carried out minor refactoring of Pascal analyser unit.
-
-Unreleased v0.7.1 Beta of 20 April 2005
-+ Disabled F1 key press handling in dialogues with no help button. Was triggering bad topic errors in WinHelp.
-+ Added "Compile" prefix to compiler check page's "Test Compile" button.
-+ Fixed errors in "do nothing" doc host handler used by web browser control.
-
-Release v0.7.0 Beta of 17 March 2005
-+ Added new facility to save a routine, or a whole category of routines, to file.
-+ Reworked syntax highlighter implementation.
-+ Updated help file with details of new routine saving feature.
-
-Release v0.6.0 Beta of 10 March 2005
-+ Added syntax highlighting for source code displayed in detail panes.
-
-Release v0.5.0 Beta of 05 March 2005
-+ Added support for Free Pascal compiler by totally reworking the compiler support engine.
-+ Added new dialogue box to configure compilers. Compiler detection ability retained but now only works in response to user request.
-+ Revised about box to include "powered by Delphi" logo.
-+ Updated help file:
- - Added incomplete topics for each of the main menus.
- - Added complete new topic for the compiler configuration dialogue box.
- - Fixed K-keyword errors and added extra keywords for dialogue boxes.
-
-Release v0.4.0 Beta of 28 February 2005
-+ Text search results are now highlighted when routines are displayed in the information pane.
-
-Unreleased v0.3.4 Beta of 26 February 2005
-+ Separated back end database code from Snippets object.
-+ New back end code designed to make it easy to change the data provider in future versions. Current version accesses data in .ini and .dat files.
-
-Unreleased v0.3.3 Beta of 25 February 2005
-+ Fixed bug that was preventing Ctrl+F from activating Find Text dialogue box.
-+ Realigned controls in bug report dialogue and fixed tab order problems.
-+ Fixed email address validation error in bug report dialogue
-
-Unreleased v0.3.2 Beta of 24 February 2005
-+ Refactored code that provides compiler names and introduced global Compilers object.
-
-Unreleased v0.3.1 Beta of 24 February 2005
-+ Centralised code that displays message dialogues and standardised their appearance.
-
-Unreleased v0.3.0 Beta of 23 February 2005
-+ Updated welcome pages to provide more help on using CodeSnip.
-+ Removed dialogues that appeared on start up when database was empty. Welcome page now provides this information along with an option to download database.
-+ Improved handling of welcome page.
-
-Unreleased v0.2.4 Beta of 23 February 2005
-+ Refactored and simplified access to dialogue boxes.
-+ Improved search code.
-
-Unreleased v0.2.3 Beta of 23 February 2005
-+ Created a class hierarchy for all frames that display HTML in a web browser control.
-
-Unreleased v0.2.2 Beta of 22 February 2005
-+ Localised various literal strings and moved some constant values to a common location.
-
-Unreleased v0.2.1 Beta of 22 February 2005
-+ Overhauled web browser external object extender that communicates browser events to application.
-+ Added new notifier object that centralises handling of GUI user interaction.
-
-Unreleased v0.2.0 Beta of 21 February 2005
-+ Made minor changes to appearance of main display.
-+ Refactored the HTML generation engine, added several HTML templates to resources and localised all strings used in generated HTML.
-
-Unreleased v0.1.4 Beta of 19 February 2005
-+ Refactored some code.
-
-Unreleased v0.1.3 Beta of 18 February 2005
-+ Removed redundant code.
-
-Unreleased v0.1.2 Beta of 18 February 2005
-+ Removed debug code.
-
-Unreleased v0.1.1 Beta of 18 February 2005
-+ Fixed minor bugs.
-
-Release v0.1.0 Beta of 30 January 2005
-+ Original beta version.
diff --git a/Docs/ChangeLogs/ChangeLog-v1.txt b/Docs/ChangeLogs/ChangeLog-v1.txt
deleted file mode 100644
index ee1a2151a..000000000
--- a/Docs/ChangeLogs/ChangeLog-v1.txt
+++ /dev/null
@@ -1,386 +0,0 @@
-; ------------------------------------------------------------------------------
-; 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 http://mozilla.org/MPL/2.0/
-;
-; Copyright (C) 2012, Peter Johnson (www.delphidabbler.com).
-;
-; $Rev$
-; $Date$
-;
-; Change Log for CodeSnip Release 1
-; ------------------------------------------------------------------------------
-
-Release v1.9.4 of 01 September 2008
-+ Improved handling of errors encountered when running compilers.
-+ Provided checks for invalid compiler executable files in Config Compilers dialogue box.
-+ Added enumerator to Compilers object.
-+ Made ECodeSnip exceptions and descendants clonable when copying between threads.
-
-Unreleased v1.9.3 of 24 August 2008
-+ Fixed bug in the database updater which could cause a deleted local file not to be noticed and not replaced.
-
-Unreleased v1.9.2 of 24 August 2008
-+ Changed method used to generate program key. No longer uses MAC Address, since code to find this fails on Windows Vista.
-+ Refactored to remove knowledge of how contributor information and database are stored from TAppInfo class.
-+ Revised code that manages contributors so that storage details are private to the classes.
-
-Unreleased v1.9.1 of 24 August 2008
-+ Rebuilt CodeSnip and install helper program with Delphi 2006:
-+ Modified CodeSnip source to compile without warnings.
-+ Replaced deprecated library calls with alternatives.
-
-Release v1.9 of 14 August 2008
-+ Changed so that all user accounts use the same database rather than having their own copy. Database now stored in common application data folder, along with registration information. Per-user configuration information remains in per-user application data folder in renamed file.
-+ Installer can now optionally preserve data stored in database and configuration file used by earlier versions of the program. This involves creating new configuration files and moving the database.
-+ Updated help file re these changes.
-
-Unreleased v1.8.11 of 11 August 2008
-+ Removed duplicate compiler glyph resources and modified compiler handling code accordingly.
-
-Unreleased v1.8.10 of 11 August 2008
-+ Refactored various units to use extended theme support.
-+ Fixed redraw bug in tree views that use check boxes: check boxes were redrawing in wrong state when themes changed.
-+ Improved support for theme changes. Theme manager now gets notified of changes directly from Windows.
-+ Suppressed unnecessary compiler warnings.
-
-Unreleased v1.8.9 of 10 August 2008
-+ Modified Select Compiler dialogue box (opened from Configure Compiler dialogue) and Choose Element Colour dialogue (opened from Preferences dialogue) to be aligned correctly over dialogues, work correctly with Vista task bar and support help keywords.
-+ Select Compiler file open dialogue now defaults to display any current compiler executable.
-+ Choose Element Colour dialogue box now uses UK English and has custom title.
-+ Added help topics for Select Compiler and Choose Element Colour dialogues.
-
-Release v1.8.8 of 16 June 2008
-+ Changed to make application minimisation, task bar preview window, and appearance in "Flip 3D" task switching display correctly on Windows Vista.
-+ Provided work-around for Delphi's Alt key bug on XP and Vista (CodeGear Quality Central bug report #374030).
-
-Unreleased v1.8.7 of 05 June 2008
-+ Made selected tabs in information and detail pane persistent.
-+ Fixed bug in build script.
-
-Unreleased v1.8.6 of 02 June 2008
-+ Fixed lock-up that could occur when displaying wait dialogue box while background tasks execute. Previous attempt to fix this problem failed.
-+ Changed "marquee" that is displayed in wait dialogue box to appear correctly on Vista.
-
-Release v1.8.5 of 30 May 2008
-+ Fixed bug that was causing Save Snippet and Save Unit dialogue boxes to ignore file type
- selected by user, always outputting default file type.
-+ Deleted some unused source code.
-+ Removed option to install a desktop icon from installer. Also refactored install script to conform to current Inno Setup standards.
-
-Release v1.8.4 of 22 April 2008
-+ Added manifest resource to ensure compatibility with Windows Vista and to use Vista themes.
-+ Fixed border problem in web update dialogue box and about box when displayed under Vista / IE7 browser control.
-+ Prevented selection of text in previews displayed in preferences dialogue box.
-+ Updated set-up script to use macros.
-+ Modified Build batch file to work with Windows SDK 2008.
-
-Unreleased v1.8.3 of 05 November 2007
-+ Refactored dynamic CSS generation code.
-
-Unreleased v1.8.2 of 04 November 2007
-+ Refactored assignable interfaced objects.
-
-Release v1.8.1 of 04 November 2007
-+ Made changes to browser control and URL handling.
-
-Unreleased v1.8 of 04 November 2007
-+ Added pop-up context menus to main display's detail pane.
-
-Unreleased v1.7.7 of 29 October 2007
-+ Modified code of compiler wait dialogue box and splash screen to try to prevent bug that occasionally prevent the dialogue from closing, locking up application.
-
-Unreleased v1.7.6 of 18 October 2007
-+ Shift-clicking links in the main display and some dialogue boxes was starting Internet Explorer. Fixed so that Internet Explorer is no longer started and shift-clicking external links now starts default browser.
-
-Unreleased v1.7.5 of 17 October 2007
-+ Modified Preferences dialogue box:
- - Refactored code that displays measurement units.
- - Preview on Source Code tab now takes on appearance of source code highlighter defined on Syntax Highlighter tab.
-+ Changed format of ini file that stores persistent settings so that source code highlighter preferences are now stored in Prefs section of ini file rather than own section.
-+ Customised installer to update existing ini files to revised version.
-
-Release v1.7.4 of 14 October 2007
-+ Fixed display bug when selecting routines following a text search.
-+ Improved text search algorithm to permit search strings containing punctuation characters.
-+ Fixed typo in the "About The Database" section of the About box.
-
-Release v1.7.3 of 27 September 2007
-+ Improved alignment of dialogue boxes and splash screen over owning forms. Alignment code substantially refactored.
-+ Added support for multiple monitors.
-
-Release v1.7.2 of 24 September 2007
-+ Fixed bug that was preventing wait dialogue box from displaying during long compilations.
-
-Unreleased v1.7.1 of 22 September 2007
-+ Added list of testers to credits section of Database tab in About box.
-+ Added new help menu item that displays privacy statement.
-+ Rearranged help menu items.
-+ Updated help file re changes to help menu.
-
-Release v1.7 of 08 September 2007
-+ Added new facility to print information about selected routines, with page set-up and printer configuration.
-+ Added new "general" tab (sets default measurement units) and "printing" tab (to set printing defaults) to preferences dialogue box.
-+ Changed format of ini file that stores persistent settings.
-+ Updated help file to reflect changes.
-+ Customised installer to update existing ini files to revised version.
-
-Unreleased v1.6.4 of 02 July 2007
-+ Corrected typos in generated source code header comments.
-+ Added support for embedding titles in generated documents where document supports title meta data.
-+ Added suggested file name to save unit and save snippets dialogue boxes.
-+ Refactored code in syntax highlighter that generates XHTML.
-
-Unreleased v1.6.3 of 13 May 2007
-+ Added support for selecting and copying text displayed in preview dialogue.
-+ Changed so that each document type displayed in preview dialogue box has same margins.
-+ Updated help file re changes to preview dialogue box.
-
-Unreleased v1.6.2 of 12 May 2007
-+ Updated to use revised news data format provided by web service.
-+ Update from Web dialogue box now displays number of news items along with page number of currently displayed item.
-
-Release v1.6.1 of 09 May 2007
-+ Fixed bug that allowed user to select a different routine while compiling another causing display to get out sync.
-
-Release v1.6 of 08 May 2007
-+ Added support for Delphi 2007 compiler.
-+ Updated help file re new compiler support.
-
-Release v1.5.13 of 04 March 2007
-+ Fixed bug from v1.5.11 where Tools | Register CodeSnip and View | Show/Hide Test Unit menu options were permanently disabled.
-+ Fixed bug from v1.5.9 where showing and hiding test units from menus was out of sync with links in compiler check pane.
-
-Release v1.5.12 of 01 March 2007
-+ Made long operations (loading database and compiling test units) execute in threads.
-+ Changed to display wait dialogue while updated database is being loaded.
-+ Made progress meters displayed in wait dialogues update more smoothly.
-
-Release v1.5.11 of 25 February 2007
-+ Added splash screen displayed when program is loading.
-+ Main window, menu and toolbar is now disabled when program is initialising and when updated database is loading.
-+ Program window is now centred on screen first time it is run and program is now never started minimized.
-
-Unreleased v1.5.10 of 17 February 2007
-+ Refactored code that handles web browser controls. Moved various pieces of code that manipulates and queries browser controls into central UI and IO manager classes. Also added helper classes to manipulate HTML documents and browser controls.
-+ Some code made redundant by above changes was removed.
-+ Lightened and centralised colours used to highlight text search results.
-
-Unreleased v1.5.9 of 16 February 2007
-+ Refactoring update. Revised code that manages the main display, i.e overview and details panes.
-
-Release v1.5.8 of 16 February 2007
-+ Fixed bug in view history where selecting an item from the history list could cause a crash after database has been updated. This was fixed by clearing the history list after updating the database.
-+ Now clears the main display before re-displaying an updated database to prevent an item from the old version of the database being selected.
-
-Unreleased v1.5.7 of 12 February 2007
-+ Refactored, relocated and extended use of some utility routines, resulting in some other minor changes:
- - All error and information message boxes now have properly terminated sentences.
- - Generated XHTML less likely to contain illegal characters.
-
-Unreleased v1.5.6 of 11 February 2007
-+ Modified about dialogue box to display information about the Code Snippets Database in addition to the program. The two kinds of information are displayed in two tabs.
-+ Added code to get list of database contributors from a file downloaded with database updates.
-
-Unreleased v1.5.5 of 11 February 2007
-+ Made keyboard interaction with application more consistent:
- - Made browser controls activate and focus properly when user tabs into them.
- - Fixed tab order problems in main display and about dialogue box so that only controls that may need to receive user input are now activated by tabbing.
- - Links displayed in browser controls are always now included in tab sequence and can be activated by Ctrl+Return when focused.
- - Fixed inconsistency in tab sets in overview and details pane responded inconsistently to Ctrl+Tab and Shift+Ctrl+Tab.
-+ Changed browser control respond to activation via the mouse to be the same as for the keyboard.
-
-Release v1.5.4 of 09 February 2007
-+ Added disclaimers re database code to generated units and snippets and to program's welcome page.
-+ Made slight modifications to source code generation code.
-
-Release v1.5.3 of 08 February 2007
-+ Refactored and rationalised code in main form and moved some code into help classes.
-+ Revised code that performs customisation, auto-sizing and alignment of forms and dialogue boxes.
-+ Standardised execution method of dialogue boxes.
-
-Unreleased v1.5.2 of 04 February 2007
-+ Refactored help manager system to make it easier to swap in new help systems in future.
-+ Modified help handlers in forms to remove redundant code.
-+ Modified how help menu items call help topics.
-
-Unreleased v1.5.1 of 04 February 2007
-+ Refactored handling of database searches by creating new global query object to store information about current query on database.
-+ Changed relevant code to use the new object and deleted resulting redundant code.
-+ Made some other minor code improvements and modifications.
-
-Unreleased v1.5 of 03 February 2007
-+ Made status bar display database and search information along with other prompts in addition to displaying hints.
-
-Unreleased v1.4.6 of 17 December 2006
-+ Made minor changes to appearance:
- - Changed some colours to system colours from hard-wired colours.
- - Changed help links in main display from blue to green.
- - Removed text highlighting from welcome page.
-
-Unreleased v1.4.5 of 04 December 2006
-+ Refactored code that generates test units. As a consequence names of test units displayed in Compiler Check pane have been corrected to the actual names used in test compilations.
-
-Release v1.4.4 of 04 December 2006
-+ Added new menu item to View menu that toggles visibility of test units in the compiler check tab.
-+ Changed glyph used for link that performs same action in compiler check tab and made image change depending on visibility of test unit.
-
-Unreleased v1.4.3 of 03 December 2006
-+ Changed information pane to load routines dynamically via DHTML rather than reloading document each time.
-+ Refactored DHTML code and detail frames that support DHTML.
-+ Refactored routine HTML generation code.
-+ Rationalised some dynamic CSS generating code.
-+ Revised information pane's underlying HTML code.
-
-Unreleased v1.4.2 of 03 December 2006
-+ Corrected alignment of About and Compiler Errors dialogue boxes over main form.
-
-Unreleased v1.4.1 of 03 December 2006
-+ Fixed bug where Test Compile menu option and tool button were always enabled and could cause an assertion failure when no routine was selected or no compilers were available.
-
-Unreleased v1.4 of 03 December 2006
-+ Revised display in compiler check pane. Now lists database and test results side by side.
-+ Changed routine compiler check page to be updated dynamically (using JavaScript) when routine selection changes rather than always reloading page.
-+ Modified some JavaScript support code.
-+ Fixed potential bug in compiler code.
-+ Updated help file re changes to Compiler Check tab.
-+ Fixed a typo and index error in help file.
-
-Unreleased v1.3.5 of 01 December 2006
-+ Changed to display a border-less message dialogue during long test compilations. The dialogue is not displayed for shorter compilations.
-+ Updated help file re above and fixed an error in the search menu topic.
-
-Unreleased v1.3.4 of 26 November 2006
-+ Refactored JavaScript used to interface between main program and HTML display.
-+ Centralised generation of JavaScript in main code.
-
-Unreleased v1.3.3 of 25 November 2006
-+ Refactored handling of CSS and XHTML:
- - Changed way CSS is provided to enable use of system font and colours.
- - Tidied source HTML documents to remove illegal XHTML strict attributes and to remove hard-wired colours.
-
-Release v1.3.2 of 24 November 2006
-+ Made program remember whether test units are displayed or hidden until end of session.
-
-Unreleased v1.3.1 of 21 November 2006
-+ Made minor modification to appearance of Configure Compilers dialogue box.
-
-Unreleased v1.3 of 18 November 2006
-+ Added facility to sign up to CodeSnip mailing list on-line.
-+ Corrected further typos in registration wizard.
-+ Updated help file re mailing list sign-up, changed privacy statement and added license to contents page.
-
-Release v1.2.5 of 16 November 2006
-+ Corrected and modified text displayed on last page of Registration Wizard when user elects to join mailing list.
-
-Unreleased v1.2.4 of 14 November 2006
-+ Changed about box and help menu to display end user license agreement in help file rather than separate text file.
-+ Added license topic and made related changes to help file.
-
-Unreleased v1.2.3 of 12 November 2006
-+ Fixed incorrect glyph used for Show All search menu item and tool button.
-+ Moved Tools | Preferences menu option to top of Tools menu.
-
-Unreleased v1.2.2 of 12 November 2006
-+ Added hot tracking to tree view check boxes used in Select Routines dialogue box when Windows XP themes are enabled.
-
-Unreleased v1.2.1 of 11 November 2006
-+ Refactoring release:
- - Method used to construct and use help file changed.
- - Moved code that detects HTML and RTF files to appropriate utility units.
- - Streamlined code in preview dialogue box.
-
-Release v1.2 of 11 November 2006
-+ Changed syntax highlighter used to format units and code snippets to be able to read custom settings from persistent storage.
-+ Added Syntax Highlighter tab to preferences dialogue box to enable users to customise the font, style and colours used by the syntax highlighter.
-+ Modified preferences dialogue box's Source Code tab to display a preview of routines using various comment styles.
-+ Updated help file re revised preferences dialogue box.
-
-Unreleased v1.1.2 of 07 November 2006
-+ Refactoring release:
- - Added code to generate CSS properties.
- - Added new classes to generate RTF code.
- - Re-implemented RTF highlighted code.
-+ Now generates much smaller RTF export files.
-
-Unreleased v1.1.1 of 31 October 2006
-+ Changed Select Routines dialogue to use XP style check boxes when XP themes active and custom check boxes when XP themes inactive.
-
-Release v1.1 of 30 October 2006
-+ Added ability to generate and save whole Pascal unit containing currently selected routines.
-+ Added new search that can find all routines cross-referenced by a given routine.
-+ Added ability to manually select routines that are displayed in overview pane.
-+ Added short-cut key and changed glyph for File | Save Snippet option / tool button.
-+ Updated way source code preferences are stored. Broke backwards compatibility with previous storage method, so upgraders may loose settings.
-+ Made minor changes to preferences dialogue box.
-+ Word-wrapped long uses lists in generated units.
-+ Refactored code that determines type of exported files.
-+ Refactored and expanded code that deals with source code exporting.
-+ Fixed some minor bugs:
- - Previews of large rich text documents were displaying RTF source instead of rendering document.
- - Assertion failure could (rarely) happen when displaying message boxes without specifying parent form.
- - Saving snippets in a file without supplying a file extension could silently overwrite existing files.
- - Comment style was being ignored when generating a unit.
-+ Updated help file:
- - Added new topics, index entries and TOC entries for new features.
- - Updated some existing topics to refer to new features.
- - Revised and corrected several existing help topics.
-
-Unreleased v1.0.3 of 26 October 2006
-+ Refactored various parts of source code. No changes to program's functionality. Details are:
- - Standardised all singleton objects on interface based implementation.
- - Centralised code that gets location of license file.
- - Standardised links that trigger JavaScript in some HTML resources.
- - Changed bug report dialogue box to descend from common wizard dialogue box.
-
-Release v1.0.2 of 25 October 2006
-+ Changed so that links from program to external web pages display in default browser rather than IE.
-+ Refactored code that displays license text file in external application.
-+ Reworded some of welcome screen and added links to on-line database.
-+ Refactored some JavaScript code that works with main display HTML and web browser code.
-+ Made minor changes to hints displayed in status bar when cursor is over links.
-
-Release v1.0.1 of 14 October 2006
-+ Fixed problem in web update that caused program to crash on Windows 9x platforms.
-
-Release v1.0 of 09 June 2006
-+ Version 1 release.
-+ Revised About Box text and appearance and added link that displays license file.
-+ Refactored and renamed some code.
-+ Made minor changes to appearance and effect of Configure Compilers dialogue box.
-+ Fixed potential bug displaying JavaScript error dialogue if help called from links in main display fail.
-+ Made some literal strings resource strings.
-+ Made calls to help system fail gracefully on machines without HTML Help installed.
-+ Modified code that reads program's version information.
-+ Added important compiler directives.
-+ Standardised appearance of all groups of action links in main display.
-+ Added Help menu item to display license and to access CodeSnip web page.
-+ Moved bug report and registration menu options from Help to Tools menu.
-+ Updated and help file re new commands, corrected some errors and re-styled menu help sections.
-+ Created installer using Inno Setup.
-+ Added new batch file to build program.
-+ Fully commented code.
-+ Changed to new end user license agreement for the executable program. The program remains open source.
-
-Release v1.0 RC 3 of 01 May 2006
-Internal CodeSnip version 0.12.0
-+ 3rd release candidate for the v1.0 release.
-+ Updated to use v4 of update web service that uses completely new update protocol. Significant changes to code were needed to achieve this.
-+ Redesigned update dialogue box accordingly.
-+ Added ability to update dialogue to display latest CodeSnip news delivered as part update process.
-+ Updated help file re changes to update dialogue box.
-
-Release v1.0 RC 2 of 16 April 2006
-Internal CodeSnip version 0.11.3
-+ 2nd release candidate for the v1.0 release.
-+ Fixed bug where user could drag and drop files onto web browser controls and file contents would overwrite the display.
-
-Release v1.0 RC 1 of 11 April 2006
-Internal CodeSnip version 0.11.2
-Changes relate to v0.11.1 Beta
-+ 1st release candidate for the v1.0 release.
-+ Updated help file:
- - Ensured that external links display in a web browser window rather than in the help window.
- - Added additional internal links to some help topics.
-+ Fixed compiler warnings.
-+ Removed some redundant code.
diff --git a/Docs/ChangeLogs/ChangeLog-v2.txt b/Docs/ChangeLogs/ChangeLog-v2.txt
deleted file mode 100644
index 352515fc5..000000000
--- a/Docs/ChangeLogs/ChangeLog-v2.txt
+++ /dev/null
@@ -1,179 +0,0 @@
-; ------------------------------------------------------------------------------
-; 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 http://mozilla.org/MPL/2.0/
-;
-; Copyright (C) 2012, Peter Johnson (www.delphidabbler.com).
-;
-; $Rev$
-; $Date$
-;
-; Change Log for CodeSnip Release 2
-; ------------------------------------------------------------------------------
-
-Unreleased v2.4.1 of 13 May 2009
-+ Refactored code that provides information about the program and web URLs and services it accesses.
-+ Changed URL accessed by donations dialogue box.
-
-Release v2.4 of 11 May 2009
-+ Added donate menu option and dialogue that accesses a PayPal donation web page.
-+ Removed support for the Windows 9x platform since CodeSnip now generates fatal errors on that platform:
- - Removed Windows 9x specific code.
- - Changed installer to prevent installation on Windows 9x.
-+ Updated help file re changes.
-
-Release v2.3.7 of 26 April 2009
-+ Made user name and email address entered in Code Submission Wizard persistent on a per-user basis.
-+ Updated Code Submission Wizard and Privacy Statement help topics re the changes.
-
-Unreleased v2.3.6 of 26 January 2009
-+ Changed method that is used to get locale information to be compatible with Vista as well as earlier OSs.
-
-Release v2.3.5 of 25 January 2009
-+ Changed method used to generate HTML displayed in main program window to avoid dynamic updating of documents in attempt to counter a reported JavaScript bug.
-+ Refactored generation of HTML tags in all parts of program that use HTML in display.
-+ Corrected method naming error.
-
-Unreleased v2.3.4 of 16 January 2009
-+ Copy Source Code menu item now places a copy of selected snippet on clipboard in syntax highlighted rich text in addition to plain text.
-+ Updated help file accordingly.
-
-Unreleased v2.3.3 of 14 January 2009
-+ Browser controls and snippets tree-views are now selected when containing frame is entered.
-+ Discrepancy in way highlighting works in snippets tree-views fixed.
-+ "&" characters are now rendered correctly in TMessageBox dialogues.
-+ Code that executes compilers now uses one thread instead of two.
-+ Refactorings:
- - Some constants relocated.
- - Rationalised some routine and method calls.
- - Replaced some control character literals with constants.
- - Updated IntfUIHandlers unit with IE6/7 related constants.
-
-Unreleased v2.3.2 of 10 January 2009
-+ Revised compilers object. Singleton instance removed. Local instances of object are created where needed.
-+ Added new method to compiler objects to detect errors and warnings
-+ Fixed incorrect caption in compiler error dialogue.
-+ Added new object that manages test compilations, compiler set-up and viewing compile errors. Used by main form and snippets editor.
-+ Added "View Compile Errors" menu option to Database menu.
-+ Added Alt+V hot key to view compile errors in Snippets editor.
-+ Updated help file for database menu to add "View Compile Errors" and missing entries for Submission, import and export of user database.
-
-Unreleased v2.3.1 of 06 January 2009
-+ Fixed test compilation bug in snippets editor that could corrupt compiler errors or warnings displayed from main display.
-+ Added support for tab switching in compiler errors dialogue box using Ctrl+Tab and Shift+Ctrl+Tab.
-
-Release v2.3 of 05 January 2009
-+ Changed name of Copy Snippet menu item to Copy Source Code.
-+ Added new Copy Information menu item to Copy menu - copies all snippet information to clipboard in text and RTF.
-+ Added Save Database button to toolbar.
-+ Changed status bar to display a count of user defined routines and an indicator that shows when user database has been modified.
-+ Refactored and extended clipboard management code.
-+ Added new buttons to selection search dialogue box to select user defined or main database routines.
-+ Added facility to test compile routines to user defined snippets editor dialogue box.
-+ Modified compiler errors dialogue box to be able to display results of compilation with more than one compiler.
-+ Updated help file re changes.
-
-Release v2.2.5 of 31 December 2008
-+ Replaced routine's credits and comments properties with new Extra information property that can store formatted text.
-+ Added parser for mark-up language used by new Extra property.
-+ Modified snippets edit dialogue box to use new Extra property.
-+ Changed main database, user database and export file format to support new Extra property. User database and export files generated by this version can't be read by earlier versions of the program.
-+ Modified and refactored print document generation code to use new Extra property.
-+ Refactored some HTML generation code.
-+ Fixed a bug that occasionally causes a GPF when updating a user defined routine.
-+ Removed redundant topic from help file.
-
-Release v2.2.4 of 19 December 2008
-+ Fixed bug in text and RTF preview dialogue boxes that was setting margins incorrectly and clipping displayed text.
-
-Unreleased v2.2.3 of 17 December 2008
-+ Refactored code that handles XML files (user database and import / export). Pulled out common code and further extended XML document object.
-
-Unreleased v2.2.2 of 16 December 2008
-+ Added glyphs to printers in print dialogue box.
-+ Various refactorings of print and highlighting related code.
-+ Printing now uses user-defined highlighters. Current highlighting is now previewed in print preferences.
-+ Bug fixes:
- - Help button now displays in page set-up dialogue on Vista.
- - Page set-up dialogue now makes use of custom margin settings.
-
-Unreleased v2.2.1 of 16 December 2008
-+ Several refactorings:
- - Rationalised email validation code.
- - Rationalised exceptions raised when validating entry into dialogue box.
- - Rationalised code that momentarily pauses execution of a thread.
- - Made wide use of extended TRect structure.
- - Changed various loops to use enumerators.
- - Removed some unused code.
-+ Fixed minor bug in open and save dialogues that occasionally failed to detect existence of a file.
-
-Unreleased v2.2 of 15 December 2008
-+ Added facility to submit user defined snippets via Internet for inclusion in main database.
-+ Added facility to export user defined routines to file and to import exported files.
-+ Made minor changes to wizard dialogue boxes.
-+ Rewrote message dialogue box code.
-+ Made minor changes to open and save dialogue boxes.
-+ Updated help file for the new code import, export and submission features.
-
-Release v2.1 of 11 October 2008
-+ Added support for Delphi 2009 Win 32 personality.
-+ Added a button to set all compiler results to success to snippets edit dialogue box.
-+ Refactored some code.
-+ Updated help file re Delphi 2009 support.
-
-Unreleased v2.0.7 of 05 October 2008
-+ Fixed residual bug in alt key bug work-around (CodeGear Quality Central bug report #374030). The bug was manifesting itself only for the first dialogue box displayed after the program started.
-
-Unreleased v2.0.6 of 05 October 2008
-+ Refactoring:
- - Added class methods to instantiate and use various classes that have only one public method to save caller having to create, execute and destroy object. Public constructors of these classes were changed to cause assertion failure if directly called.
- - Made static classes derive from new base class that causes assertion failure if constructor called.
- - Combined some action update handlers in main form.
- - Updated assertions and raising of EBug exceptions to programatically get name of class triggering error.
- - Made some class' protected and private sections strict.
-
-Unreleased v2.0.5 of 03 October 2008
-+ Refactoring: changed custom save source dialogue to descend from extended save dialogue box.
-
-Release v2.0.4 of 21 September 2008
-+ Improved speed of looking up routines in database.
-+ Prevented any user defined routine from referencing itself.
-+ User defined routines now always reference routines from user database in preference to main database when there is a name conflict.
-
-Unreleased v2.0.3 of 20 September 2008
-+ Fixed bug that caused an assertion failure when an attempt was made to display the Select Routines dialogue box when an empty category was present in database.
-
-Unreleased v2.0.2 of 19 September 2008
-+ Now gives option to save changed user defined database before updated main database.
-+ When a routine is updated or deleted references to it in other routines are updated or removed.
-+ Corrected reference in installer to menu item used to update database (this changed from v2).
-
-Release v2.0.1 of 18 September 2008
-+ Fixed bug that fails to load user database and deletes it if a category is added to main database during on-line update.
-+ Fixed bug that ignores any user defined snippets that have same name as snippets in main database.
-+ Ensured main form is disabled when database is loading.
-+ Ensured splash form is hidden if an exception occurs while splash form is displayed.
-
-Release v2.0 of 15 September 2008
-Changes relate to v1.9.4
-+ Added support for user defined snippets:
- - User database can be edited, saved, backed-up and restored.
- - User database can reference code in main database.
- - Names of user defined snippets are coloured blue to distinguish them from main database.
- - User database is stored as a mix of XML and source files in a sub-folder of the per-user application data folder.
- - Queries can now be refreshed when content of user database changes.
-+ Modified extended external object that communicates between browser controls and application.
-+ Main database engine heavily modified.
-+ Greater use of DHTML to manipulate main display.
-+ Made browser pop-up menu display glyphs for items menu items that replicate links in browser control.
-+ Modified welcome page to appear differently depending on state of main and user defined databases.
-+ Disclaimers, copyright and other headers of saved, printed and copied documents changed.
-+ Commenting of exported code changed slightly to allow for user snippets that may not support all commenting styles.
-+ Fixed status bar display bug.
-+ Category headers in overview pane are now in bold.
-+ Added enumerators to several list objects to support for..in construct.
-+ Tweaked exception handling.
-+ Added support for converting GIF resources into bitmaps for use in image lists.
-+ Changed URL used to access program's home page.
-+ Updated help file to reflect changes.
-+ Added credits for use of Anders Melander's GIFImage unit to about box.
diff --git a/Docs/ChangeLogs/ChangeLog-v3.txt b/Docs/ChangeLogs/ChangeLog-v3.txt
deleted file mode 100644
index 66e0ad007..000000000
--- a/Docs/ChangeLogs/ChangeLog-v3.txt
+++ /dev/null
@@ -1,473 +0,0 @@
-; ------------------------------------------------------------------------------
-; 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 http://mozilla.org/MPL/2.0/
-;
-; Copyright (C) 2012, Peter Johnson (www.delphidabbler.com).
-;
-; $Rev$
-; $Date$
-;
-; Change Log for CodeSnip Release 3
-; ------------------------------------------------------------------------------
-
-Release v3.13.2 of 31 October 2013
-+ Modified Syntax Highlighter tab of Preferences dialogue box so that "vertical" fonts (whose names begin with "@") no longer appear in list of available fonts.
-+ Fixed potential bug in operating system detection code that may fail on Windows 2000.
-+ Fixed registry access code so that the 64 bit view of the registry is used when CodeSnip runs on a Windows 64 bit operating system.
-
-Release v3.13.1 of 18 September 2013
-+ Removed File | Page Setup menu option because some settings made there were being ignored when a file was printed. This is a fix for bug #89 "Setup selections not being remembered" (http://bit.ly/1a3V94x).
-+ Updated help file re changes.
-
-Release v3.13.0 of 12 September 2013
-+ Added support for Delphi XE5 compiler.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v3.12.1 of 01 July 2013
-+ Fixed bug #82 "Fatal divide by zero exception on start-up" (http://bit.ly/15aIJqQ) that affected all v3.x versions when the IE 10 browser was installed.
-+ Fixed unreported bug where IE 10 browser was being reported as IE 9.
-+ Updated all third party DelphiDabbler code to latest available versions.
-+ Updated documentation re changes.
-
-Release v3.12.0 of 02 May 2013
-+ Added support for Delphi XE4 compiler. Implements feature request #78 (http://bit.ly/10uGhoD).
-+ Fixed bug #78 (http://bit.ly/ZQl3T4) - CodeSnip doesn't restore window in correct position when task bar on left or top of screen.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v3.11.1 of 08 December 2012
-+ Fixed bug #3578654 (http://bit.ly/T7fTxu): "Pre-processor directive errors in main db ini files" by removing support for problematic directives.
-+ Hints are no longer displayed in status bar when user rolls mouse over a link in the display pane. This fixes bug #3577408 (http://bit.ly/WEzZGg): "Clicking detail pane snippet link leaves hint in status bar".
-+ Windows no longer scale automatically when screen DPI differs from that on design system. This fixes bugs #3591818 (http://bit.ly/TvNaUL) "Strange window behaviour in Windows 7" and bug #3591820 (http://bit.ly/SEH6dO) "Incorrect font size used for some bold text".
-+ Updated operating system detection code to detect W0ndows 8 & 2012 server.
-+ Updated documentation
-
-Release v3.11.0 of 17 September 2012
-+ Added support for Delphi XE3 compiler. Implements feature request #3566345 (http://bit.ly/OvbBPp).
-+ Bug fixes:
- - #3561713 (http://bit.ly/QEYRFx): The Category view in the Overview pane sometimes appears fully expanded when it is expected to be fully collapsed.
- - #3566430 (http://bit.ly/U1KnGZ): About Box Paths Page displays wrongly when themes not available.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v3.10.5 of 21 August 2012
-+ Fixed bugs:
- - #3559257 (http://bit.ly/Qc8Fqu): Compile Results accessed from menu can get out of sync.
- - #3559156 (http://bit.ly/TKXYQ7): "Previews" disappearing in Preferences dialogue box
-
-Release v3.10.4 of 16 August 2012
-+ Added support for displaying pop-up menus over appropriate control when Alt+F10 is pressed. Fixes bug #3556713 (http://bit.ly/RIzfvQ).
-+ Changes to snippets editor:
- - Added missing edit context menu to "add unit" edit control on References tab. Fixes bug #3556718 (http://bit.ly/RVanCE) as it relates to v3.
- - Predefined list of units in Units list on References tab now includes the "Types" unit.
- - Referenced unit names may now contain dots.
- - Snippets Editor help topic now explains need to configure Delphi XE2 compiler to search namespaces containing referenced units. This provides a solution to bug #3536531 (http://bit.ly/Q2bcmY).
-
-Release v3.10.3 of 25 July 2012
-+ Changed so that Delphi compilers can be detected by examining current user registry key in addition to local machine registry key. This enables Delphis that were installed for a given user only to be detected.
-+ Fixed bug in Compiler tab of Configure Compilers dialogue box that failed to flag selected compiler as unavailable after button was pressed.
-
-Release v3.10.2 of 19 June 2012
-+ Fixed bug #3536331 (http://bit.ly/KQVATf) where some distinct words in a snippet's Extra text where not being found in text searches.
-+ Info about user's OS and IE version is now sent to web server during online database updates.
-+ Updated privacy statement re changes in information sent by update web service.
-
-Release v3.10.1 of 20 April 2012
-+ Fixed bug #3519784 (http://bit.ly/IsCsun) where multi-line type or constant snippets that start on same line as type or const keyword were corrupted when included in units using the "comments after snippet header" comment style.
-+ Also fixed potential source of a bug in code that edits user-defined categories.
-
-Release v3.10.0 of 17 April 2012
-+ Added new Help | On The Web | FAQs menu option to display CodeSnip FAQs in default browser.
-+ Fixed unreported minor bug in dialogue boxes that display tabbed page controls: clicking a tab did not always give it the keyboard focus.
-+ Characters used to introduced switches on command line were changed: '/' replaces non-standard '\'. '-' is still permitted.
-+ Updated help file: added topic for new menu option and minor change to FAQ help topic.
-
-Release v3.9.3 of 23 November 2011
-+ Fixed some bugs in main window:
- - Toolbar was truncated when window is too narrow to display it all. It now wraps.
- - Treeview state in Overview pane was not restoring correctly after navigating away from and then returning to a tab.
- - Pressing Ctrl+Tab or Shift+Ctrl+Tab did not necessarily change the tab in the expected tab set in either the Overview or Detail panes.
-+ Fixed a broken URL in about box.
-+ Bumped installer program helper build number re Delphi 2010 compilation (should have been done at v3.5.1).
-
-Release v3.9.2 of 28 October 2011
-+ Fixed bug #3427741 (http://bit.ly/vq2fAz) where details pane tabs didn't change in response to key presses.
-+ Fixed bug #3427866 (http://bit.ly/w31z8L) where selection in overview was not always same as item displayed in details pane.
-+ Fixed bug #3427889 (http://bit.ly/tijnmF) where there was the possibility of a GPF in overview pane.
-
-Release v3.9.1 of 18 September 2011
-+ Fixed bug #3369422 (http://bit.ly/omSp6F) in Pascal highlighter that was causing an assertion failure when parsing malformed Pascal general format floating point numbers.
-
-Release v3.9.0 of 07 September 2011
-+ Added support for Delphi XE2 Windows 32 bit compiler:
- - Can now test compile and display results with Delphi XE2 32 bit.
- - Delphi XE2 compiler version 23.0 has been added to the drop down menu in the Code Generation tab of the preference dialogue box.
- - Updated help file re Delphi XE2 support.
- - Updated documentation.
-+ Limited user name edit control to 48 chars in registration wizard because this is limit in online registration database.
-
-Release v3.8.11 of 02 July 2011
-+ Fixed display problem in about box and compiler error dialogue boxes on systems using Internet Explorer v9 web browser control. This fixes issue #3349186 (http://bit.ly/lF6bTO).
-+ Updated read-me file re support for IE9 browser control.
-
-Release v3.8.10 of 20 May 2011
-+ Reverted checked tree views and list boxes to standard Windows behaviour. Clicking item text no longer toggles associated check boxes. This behaviour was more problematic then helpful.
-+ Updated documentation, including new info about CodeSnip FAQ.
-+ Added FAQs topic and TOC entry to help file that links to online FAQ.
-
-Release v3.8.9 of 10 May 2011
-+ Fixed bug #3299870 (http://bit.ly/iX8Its) that was allowing imported snippets with duplicate names to be renamed with invalid names.
-+ Improved UI used to edit imported snippet names.
-+ Any "warning" compile results in main database are now treated and displayed as "success" results per feature request #3290359 (http://bit.ly/mshbRa).
-+ Fixed unreported potential bug in code that sets window class names.
-+ Updated documentation.
-
-Release v3.8.8 of 19 January 2011
-+ Added facility for user to specify maximum age of news items displayed in news dialogue box. New preferences tab added where the maximum age can be customised.
-+ Preferences dialogue box now displays multi-line tabs when necessary.
-+ Refactored some code used to align controls on forms.
-+ Updated license. License HTML help file is no longer MPLd and may not be altered by third parties.
-+ Updated help file re changes.
-+ Updated documentation.
-
-Release v3.8.7 of 16 December 2010
-+ Delphi XE compiler version 22.0 has been added to the drop down menu in the Code Generation tab of the preference dialogue box.
-+ Bug fix: compiler results are no longer listed when free-form snippets are printed or copied to the clipboard using the "Edit | Copy Information" menu item.
-
-Release v3.8.6 of 06 December 2010
-+ Bug fix release (none reported in bug tracker):
- - Corrected XML file validation so that it does not reject XML processing instructions that contain an "encoding" attribute.
- - Fixed long standing bug that was crashing CodeSnip when the database was updated or restored after editing, adding or deleting any user defined snippet.
- - Attempting to restore a database backup with an unknown (later) file format now raises an exception. Previously CodeSnip tried, unsuccessfully, to read the file.
-
-Release v3.8.5 of 28 November 2010
-+ Fixed bug where user was able to create snippets with valid names that would crash the alphabetic overview. Snippet names are now limited to letters from English alphabet and the underscore. Fixes bug #3120958 (http://bit.ly/fDAswL).
-+ Fixed bug where snippets that have names beginning with a lower case letter were being omitted from from the associated list of snippets shown in the detail pane. Fixes bug #3120962 (http://bit.ly/eGhQvc).
-+ Updated Snippets Editor topic in help file.
-
-Release v3.8.4 of 26 November 2010
-+ User can now opt to terminate the application when an unexpected exception is trapped. This implements feature request #3074914 (http://bit.ly/hUyEAw).
-+ Wording of bug report dialogue boxes changed.
-+ Snippets selection dialogue box now displays wait cursor while waiting for it to be displayed.
-+ Some corrections and clarifications made to comments that appear in generated "include" files.
-+ Custom message boxes can now display custom title and icon.
-+ Imported some updates from "new-backend" development tree:
- - Some source code re-organisation and renaming.
- - Updated some sorted list management code.
-
-Release v3.8.3 of 24 November 2010
-+ Added button to "Compile" tab of Snippets Editor to display unit used to test compile snippets. This implements feature request #3108008 (http://bit.ly/elBZnn).
-+ Fixed unreported bugs in handling of exceptions raised in threads.
-+ Simplified method used to load database on start up. No longer uses a separate thread.
-+ Overhauled and simplified code used to display "wait" dialogues during test compilations and database reloading.
-+ Refactorings:
- - Increased use of generics in lists and enumerators.
- - Reorganised source code tree by moving some code to more relevant units, renaming some units and increasing use of namespaces.
- - Removed some redundant code.
-+ Updated help file re changes to snippets editor.
-
-Release v3.8.2 of 16 November 2010
-+ The position of the caret in the Snippets Editor's Extra Information control is now displayed. Implements feature request #3105288 (http://bit.ly/bRV86Z).
-+ Code that displays caret positions was refactored and improved.
-+ Display of errors in the Snippets Editor's text edit controls has been improved in most cases either by positioning the caret near the error or selecting the erroneous text. This implements feature request #3107042 (http://bit.ly/cKx5YQ).
-+ Made significant changes to code that parses REML mark-up:
- - Rationalised error reporting and added support for reporting the position of errors.
- - Fixed unreported bug that produced wrong error message when empty tags are encountered.
- - Fixed bug #3107982 (http://bit.ly/cp9Cff) that failed to report some unclosed tags as errors.
- - Refactored and reorganised much of the code.
-+ All encoding and decoding of URIs is now RFC 3986 compliant.
-+ Refactored character detection and string encoding support code.
-+ Renamed some units and classes.
-+ Updated documentation.
-
-Release v3.8.1 of 08 November 2010
-+ Fixed bug #3015589 (http://bit.ly/cdPedH) where some user syntax highlighter settings were being ignored in main display.
-+ Changed Test Unit view dialogue box to use user syntax highlighter settings.
-+ Revised credits in About Box program tab.
-+ Updated third party units: PJMD5 to v0.3, PJSysInfo to v3.3, PJVersionInfo to v3.3.
-+ Modified version info code to use new features of new PJVersionInfo 3rd party unit.
-+ Refactored code that parses XHTML-style code.
-+ Updated compiler warnings used in project and made command line and IDE options the same.
-+ Updated documentation.
-
-Release v3.8.0 of 23 October 2010
-+ Added support for Delphi XE to program. Can now test compile and display results with Delphi XE.
-+ Updated help file re Delphi XE support.
-+ Some refactoring.
-+ Standardised bug-trap and assertion failure exception messages.
-
-Release v3.7.0 of 23 September 2010
-+ Added new "Help | CodeSnip News" menu option that displays latest news about CodeSnip and the online database in a dialogue box. The news comes from the CodeSnip RSS news feed.
-+ Removed news pane from "Update from Web" dialogue box and replaced with button that displays new "CodeSnip News" dialogue box.
-+ Removed mailing list subscription facility:
- - Removed subscription dialogue box and associated menu option.
- - Removed code that accessed mailing list web service.
- - Removed subscription option from program registration dialogue box.
-+ Fixed a memory leak.
-+ Added code that downloads XML document and reads and parses RSS feeds.
-+ Refactored and improved HTTP request handling code.
-+ Some further refactoring.
-+ Updated help file re changes in this release.
-+ Updated privacy statement.
-
-Release v3.6.3 of 22 July 2010
-+ Completely overhauled code that interacts with web services.
- - Character encodings are now correctly handled per information in HTTP header and several different encodings are supported.
- - MD5 checksums in HTTP headers are now supported.
-+ Updated and corrected the contents of the About Box's "About The Program" Tab.
-+ Some refactorings, mainly to code that uses MD5 message digests.
-+ Attempts to compile source with Delphi 2009 and earlier are now prevented.
-+ Updated documentation.
-
-Release v3.6.2 of 18 June 2010
-+ Fixed source code formatting problem in code generator where "forward" declarations were sometimes preceded with an unwanted blank line.
-+ Fixed potential bug in code that parses mark-up used for a snippet's Extra information. Symbolic entities were not case sensitive.
-+ Fixed a memory leak.
-+ Some refactorings that increase use of generics and some others.
-+ Read-me file updated re v3.6.1 password changes.
-
-Release v3.6.1 of 01 June 2010
-+ Proxy server passwords can now contain any Unicode character, not just those included in the Windows-1252 code page.
-+ Password format in per user ini file changed. Existing passwords have to be re-entered. Ini file format updated to v7.
-+ Installer updated:
- - It deletes any passwords from v6 and earlier per user ini files.
- - Per-user ini file now stamped as v7.
-+ Some potential Unicode-ANSI string conversion problems fixed.
-+ Updated documentation.
-
-Release v3.6.0 of 26 May 2010
-+ Added support for emitting compiler directives to switch off specified warnings. This implement feature request #2994485 (see http://bit.ly/cxDJG4).
-+ Preferences dialogue box updated:
- - New "Code Generation" tab used to configure which if any warnings are to be inhibited.
- - Renamed "Source Code" tab to "Code Formatting".
-+ Added new tab to About Box that displays and enables exploration of some key directories used by CodeSnip.
-+ Snippets editor now displays row and column occupied by text cursor.
-+ Per user ini file format changed. It now supports code generation preferences. Ini file version updated to v6.
-+ Installer updated:
- - Ini files are stamped with correct program and ini file version information.
- - Older versions (v1..v5) of per-user ini file are updated with default code generation preferences.
- - Per-user ini file now stamped as v6.
-+ Fixed numerous memory leaks.
-+ Fixed some other potential and unreported minor bugs.
-+ Some refactoring.
-+ Updated help file re changes.
-
-Release v3.5.5 of 24 March 2010
-+ Fixes download stream read bug #2976048 (see http://bit.ly/ds6mBr).
-
-Release v3.5.4 of 18 March 2010
-+ Temporary fix for download error checking bug #2970055 (see http://bit.ly/cvf9Mm).
-+ Fixed https protocol bug #2970896 (see http://bit.ly/bCIx38).
-
-Release v3.5.3 of 08 March 2010
-+ Fixed database download error checking bug #2964767 (see http://bit.ly/90vFfp).
-+ Updated PayPal donations narrative on welcome page.
-
-Release v3.5.2 of 22 February 2010
-+ Changed database downloader to:
- - Use web service's revised download file format
- - Validate download data before updating local database.
- - Provide better download error messages.
-+ Fixed bug #2947794 in view link dialogue box (see http://bit.ly/beiZZ8).
-+ Refactored some exception handling code.
-
-Release v3.5.1 of 09 February 2010
-+ New Unicode build of the program compiled with Delphi 2010. File I/O remains ANSI.
-+ Windows NT is no longer supported. Windows 2000 is now the minimum OS. Set-up program changed to enforce this.
-+ More rigorous enforcement of rules for REML tag attributes used in a snippet's Extra information.
-+ Fixed a couple of minor UI problems in the Proxy Server and Trapped Bug Report dialogue boxes.
-+ Minor changes to HTML and embedded browser code.
-+ Some refactoring.
-+ Updated documentation.
-
-Release v3.5.0 of 16 January 2010
-+ Overview pane can now be configured using Preferences dialogue box to start up with all sections collapsed.
-+ Reference to ability to donate by credit / debit card removed from Donate dialogue box: now PayPal only.
-+ Help file updated re above changes.
-+ Minor refactoring of code that provides information about and renders source code comments.
-
-Release v3.4.8 of 10 January 2010
-+ Made some changes to key presses responded to by overview pane and fixed bug where Alt+F4 was not closing program when pane had focus.
-+ Made some changes to hints displayed when rolling over links in compiler check pane. Also removed pop-up windows describing compiler errors.
-+ Updated help file: noted Delphi 2010 compiler support and added new information about overview pane keyboard short-cuts.
-
-Release v3.4.7 of 31 December 2009
-+ Added IE version number to OS information submitted when program is registered.
-+ Program now displays "[localhost]" in main window caption when started with -localhost switch.
-+ All text edit controls in snippets editor now have custom pop-up menus and short-cuts for "cut", "copy", "paste", "select all" and "undo" now work.
-+ Refactored code that supports use of fonts.
-+ Updated privacy statement re registration changes.
-
-Release v3.4.6 of 18 November 2009
-+ Changed code that takes a security backup of main database during updates to store backup in a single file rather as separate files in a temporary folder. This should fix bug #2898687 (see http://bit.ly/bKg6oH).
-+ Slightly modified user database backup file format to match that now used for main database backup.
-+ Fixed potential bugs:
- - Code that performs busy waits could have caused program to freeze.
- - Negative numbers written to backup files were not being written correctly.
- - A garbled error message was corrected.
-
-Release v3.4.5 of 09 November 2009
-+ Home, Ctrl+Home, End and Ctrl+End keys now work in overview pane and go to first and last item in tree view respectively per feature request #2888880 - see http://bit.ly/bgJCVU).
-+ State of tree view in overview pane is now maintained after editing the user database: the tree is no longer always fully expanded after each edit.
-+ Removed "Properties" button from print dialogue box along with associated dialogue boxes. This option has always been buggy. This "fixes" bug #2868706 (see http://bit.ly/9LArqI).
-+ Fixed unreported makefile bug.
-
-Release v3.4.4 of 21 October 2009
-+ Changed bug reporting mechanism. Bugs are now reported via the on-line bug tracker. Bug report dialogues changed accordingly. Access to the old bug report web service was removed.
-+ Added two new default syntax highlighter styles: "Visual Studio" and "No Highlighter". The latter switches off syntax highlighting.
-+ Fixed bug no. 2882331 (see http://bit.ly/beArcC). This was a bug in the syntax highlighter that occurred when an unexpected character was encountered.
-+ Updated help file re changes.
-+ Some minor source code corrections.
-
-Release v3.4.3 of 19 October 2009
-+ User's OS is now reported and recorded when program is registered.
-+ Text displayed in preview dialogue boxes can now be scrolled horizontally.
-+ Added support for building source against later releases of Indy 10 components.
-+ Help file and privacy statement updated.
-+ Further updated third party GIF image handling code to latest release.
-+ Some changes to source code project options.
-
-Release v3.4.2 of 10 October 2009
-+ Fixed bugs #2868706 (see http://bit.ly/9LArqI) and #2875857 (see http://bit.ly/bN4xqE)
-+ Updated GIF image handling code.
-
-Release v3.4.1 of 29 September 2009
-+ All dialogue boxes that request a user's name and / or email address now remember the information last entered, to save retyping the same data.
-+ Changed to use Indy Internet Components v10 instead of v9 for net access.
-+ Refactored:
- - Code that stores information about a user.
- - Code that gets details of system folders on local system and other file system related code.
-+ Updated privacy statement (text file and in help file).
-
-Release v3.4 of 24 September 2009
-+ Added support for Delphi 2010 to program. Can now test compile and display results with Delphi 2010.
-+ Bug fixes:
- - "Invalid cast" error that occasionally appears when a snippet is updated.
- - Bug that kept backup files locked open after restoring a database backup.
- - Current selection is now displayed in Alphabetic and Snippet Kind tabs of overview pane: previously all the database was shown, regardless of search.
-
-Release v3.3 of 21 September 2009
-+ Added support for user defined categories which can now be added, renamed or deleted.
-+ Made changes to snippets editor:
- - On the "Compile Results" Tab, a single simplified list box is now used to both display and change compile results. This replaces two linked controls.
- - The text case of a snippet name can now be changed without causing a duplicate name error.
- - Some controls resized.
-+ Fixed bug where attempting to overwrite files that are in use caused the bug report dialogue box to appear instead of simply reporting the problem.
-+ Improved validity checking of snippets that are included in generated source code.
-+ Help file updated.
-+ Refactored:
- - UI handling code in snippets editor.
- - Some Snippets database and validation code.
-
-Release v3.2.3 of 14 September 2009
-+ Fixed bug in "update from web" dialogue box where most up to date news item was not being displayed.
-+ Dialogue boxes that that enable selection of categories and snippets by means of tree views and associated check boxes now sort categories by description.
-+ Categories and snippet kinds displayed in the snippets editor are now sorted by description.
-+ Refactored:
- - Code that displays tree views in overview pane and snippet selection dialogues.
- - Some list management code.
- - Some snippets editor code.
-
-Release v3.2.2 of 08 September 2009
-+ Fixed bug in check list boxes where moving selection using keyboard causes check state to be toggled.
-+ Custom colours used in colour dialogue, on syntax highlighter page of preferences dialogue box, are now persistent.
-+ Re-implemented code that displays pop-up menus in detail pane, and fixed a minor glitch as a side effect.
-+ Simplified code that manages help system.
-+ Refactored code that manages and customises common dialogues.
-
-Release v3.2.1 of 24 August 2009
-+ Appearance of comments that appear at the top of generated source code was changed.
-+ Slightly modified "license" that appears at the top of some generated units.
-+ Information about contributor of imported code is now appended to snippet's "extra" information.
-+ Added a garbage collector.
-+ Changed size of About box - now wider and credits scroll boxes are now taller. Added credit for encryption code.
-+ Fixed minor bug that could display a JavaScript error dialogue if an exception occurred in an action initiated by clicking a link in the main display.
-+ Numerous refactorings.
-
-Release v3.2 of 17 August 2009
-+ Added facility for CodeSnip to use a proxy server when accessing the Internet.
-+ Provided a new dialogue box to configure any proxy server.
-+ Updated help file re proxy server support and configuration.
-+ UI is no longer frozen while web services are executing requests. "Update from Web" dialogue box changed to indicate if cancel button pressed when a web request is executing.
-+ Product version reported in generated source code header comments, splash screen and about box now includes any special build information.
-+ Some minor code tweaks and refactoring.
-
-Release v3.1.1 of 15 August 2009
-+ Check list boxes throughout program changed so that clicking anywhere on an item toggles check state.
-+ Button used to render and display extra information in snippets editor is now disabled when there is no extra information to display.
-+ Made minor changes to layout of some dialogue boxes: replaced missing text in bug report dialogue box.
-+ Some refactorings.
-
-Release v3.1 of 11 August 2009
-+ Added a button to the snippets editor to preview an HTML rendering of the mark-up entered as extra information. Includes facility to check any links in the mark-up.
-
-Release v3.0.5 of 21 July 2009
-+ Default font is now dependent on underlying OS: Vista - Segoe UI, XP/2000 - Tahoma, NT - MS Sans Serif.
-+ Some dialogues and splash screen modified to accommodate OS font, in particular larger Vista font. Some also given a light makeover.
-
-Release v3.0.4 of 13 July 2009
-+ Added a snippet's category description to main display and to snippet information copied to clipboard or printed. Category description in main display can be clicked to display the category.
-+ Refactored code that displays clicked routines and code that displays a snippet for editing.
-
-Unreleased v3.0.3 of 12 July 2009
-+ Refactored code:
- - Rationalised some JavaScript code.
- - Rationalised some dialogue alignment code.
- - Changed some object types and class hierarchies.
- - Added some automatic object lifetime management logic.
- - Removed some duplicate code and merged some units.
-+ Fixed an obscure bug in category code snippet generation as a side effect of refactoring.
-
-Release v3.0.2 of 08 July 2009
-+ Fixed broken link to CodeSnip database in welcome page.
-+ Fixed bug in selection search that was selecting both user defined and main database snippets with same name if only one was selected.
-+ Fixed bug where units required by constants and type definitions were not being added to generated units.
-
-Release v3.0.1 of 06 July 2009
-+ Added support for file:// protocol in links in a snippet's extra information.
-+ Updated help file re changes to extra info.
-+ Updated exported code and user database file formats to v4 to accommodate revised extra information, although we now save data in v3 format if possible.
-
-Release v3.0 of 29 June 2009
-Changes relate to v2.4.1
-+ Added support for constants and type definition snippets: there are now four types of snippets - routines, constants, types and free-form (which don't conform to any format). Free-form snippets cannot be included in generated units.
-+ Further formatting instructions added to the active text used in database's Extra information field. Also added a contributors field to database.
-+ Three predefined syntax highlighters are now provided, with default changing to Delphi 2006 default style. Syntax highlighting used in main display is now customisable. Highlighter keyword list updated.
-+ Main display changed:
- - Test unit is no longer displayed in compiler check pane: it's now displayed in a dialogue box.
- - Compiler check pane's font changed to true type, with face depending on OS.
- - Information pane now hides compiler table when a free-form snippet is displayed.
- - Compiler check pane now displays special "not available" pages when no compilers installed or a free-form snippet or a section header is selected.
- - "Uncategorised" tab removed from overview pane and replaced with new "Alphabetical" tab that groups snippets by initial letter and "Snippet Kind" tab that groups snippets by kind.
- - "Section" nodes in overview pane can now be expanded and collapsed: pane now has toolbar to perform these actions.
- - "Edit snippet" links displayed in information pane are now also displayed in compiler check pane.
- - Information about snippet type added to information pane.
- - Context menu added to overview pane.
- - Some changes to menu glyphs and short-cut keys.
- - Welcome display modified and now has a link to the donate dialogue box.
-+ Added option to copy an snippet's source code to clipboard in text and RTF formats.
-+ Exporting and copying of snippets complete with descriptions and cross references is restricted to routines: not supported for free-form, types and constants.
-+ Improved detection of invalid dependencies in snippets, including circular dependencies, and provided option to view all dependencies for any snippet from main window and snippets editor.
-+ Revised content of many dialogue boxes etc to refer to "snippets" instead of "routines" where necessary.
-+ Changed format and location of user-defined database and format of exported and submitted files.
-+ Added new "Imported Snippets" category that receives imported routines: they were formerly imported into the "User Defined" category
-+ Modified code that reads main database to deal with revised file format for new snippets types and introduction of pre-processor instructions to enable retrofitting of new snippets without breaking earlier versions of CodeSnip.
-+ Changed name and location of user preference configuration file.
-+ Revised external object that communicates with JavaScript in browser controls.
-+ Updated program credits in about box, restyled and widened it.
-+ Changed size of preferences dialogue box and revised syntax highlighter tab.
-+ Changed captions in preview dialogue box.
-+ Changed appearance of splash screen.
-+ Modified snippets editor to work with new snippet types, improved error checking code and prevented test compilation of free-form snippets.
-+ Speeded up loading of main database.
-+ Added an Easter egg!
-+ A few refactorings.
-+ Fixed several bugs:
- - Bug in backup files including database files larger than 32Kb was fixed.
- - Bug in history list following editing user defined snippets fixed by clearing list after snippets have been edited.
- - Imported user defined routines no longer forget any dependencies on main database snippets.
- - Occasional bug in displaying test unit fixed by displaying test unit in dialogue box instead of main display.
-+ Modified installer re new folder structure and copying over data from previous versions.
-+ Revised help file to reflect changes. Added new main contents "chapter" about the various snippet types.
diff --git a/Docs/ChangeLogs/ChangeLog-v4.txt b/Docs/ChangeLogs/ChangeLog-v4.txt
deleted file mode 100644
index 58bf04a27..000000000
--- a/Docs/ChangeLogs/ChangeLog-v4.txt
+++ /dev/null
@@ -1,554 +0,0 @@
-; ------------------------------------------------------------------------------
-; 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 http://mozilla.org/MPL/2.0/
-;
-; Copyright (C) 2012-2016, Peter Johnson (www.delphidabbler.com).
-;
-; $Rev$
-; $Date$
-;
-; Change Log for CodeSnip Release 4
-; ------------------------------------------------------------------------------
-
-Release v4.14.0 of 19 March 2016
-+ Changes to About Box's "Paths" tab:
- - Added new buttons to display the contents of the system and per-user config files.
- - Renamed tab as "Paths & Files".
-+ Implemented feature request #83 (https://sourceforge.net/p/codesnip/feature-requests/83/) to enable the name and port of any web service test server to be passed on command line by using the new "--test-server" command line option. This replaces hard-wired test server name & port that was activated using the now removed "-localhost" command line switch.
-+ Fixed bug #96: "Some open / save dialogues too small" (https://sourceforge.net/p/codesnip/bugs/96/). The height of customised dialogue boxes was increased.
-+ Updated operating system detection code to detect Windows 10 TH2.
-+ New photo of Sophie the dog added to the Easter egg slide show!
-+ Updated help file re About Box changes.
-
-Release v4.13.2 of 20 February 2016
-+ Updated and corrected hints displayed in main window.
-+ Changed some menu options and associated dialogue box captions.
-+ Tweaked some button captions in Select Snippets dialogue box.
-+ Updated help file re the menu and caption changes.
-+ Updated copyright date in program license as displayed in help, about box, installer and documentation.
-
-Release v4.13.1 of 29 September 2015
-+ Improved operating system detection to detect Windows 10.
-+ Modified program's manifest to declare it compatible with Windows 8 to 10.
-+ Code that determines which system font to use no longer depends on OS version but simply on font availability.
-+ Updated copyright date in program license as displayed in help, about box, installer and documentation.
-
-Release v4.13.0 of 5 September 2015
-+ Added support for test compilation with, and detection of, Delphi 10 Seattle compiler.
-+ Made some minor changes to method used to build required type library to remove dependency on the MS MIDL compiler, greatly simplifying build process.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v4.12.0 of 6 May 2015
-+ Added support for test compilation with, and detection of, Delphi XE8 compiler.
-+ Updated documentation re changes.
-+ Updated help file re changes and fixed some spelling mistakes.
-
-Release v4.11.1 of 26 October 2014
-+ Corrected an erroneous error message that is displayed when circular snippet references are detected in the snippets editor (no bug report filed).
-+ Corrected some spelling errors in UI.
-+ Some documentation corrections.
-
-Release v4.11.0 of 25 September 2014
-+ Changes re licensing of snippets from online Code Snippets Database under MIT license:
- - Generated code now carries a reference to the MIT license where relevant.
- - Submit Snippets wizard has a new page where user must confirm that any submitted snippets may be MIT licensed.
- - "About the Database" of the About Box now refers to the license.
- - Documentation and help file updated accordingly.
-+ Now uses version 6 of the Code Snippets Database update web service which supports the downloading of category and source code files larger than 32Kb.
-+ The undocumented -localhost command line option now causes CodeSnip to expect web services to be on localhost port 8080 instead of port 80. This change has no effect on normal operation and is used only in testing.
-+ Minor layout tweaks in in Display tab of Preferences dialogue box.
-+ Minor changes to help file and documentation.
-
-Release v4.10.0 of 12 September 2014
-+ Added support for test compilation with, and detection of, Delphi XE7 compiler.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v4.9.0 of 30 April 2014
-+ Added support for test compilation with, and detection of, Delphi XE6 compiler.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v4.8.7 of 06 March 2014
-+ Fixed automatic update checker so that it correctly records last update date. This fixes bug #93 (http://bit.ly/NmSQUt).
-+ Updated to use v2 of the DelphiDabbler CodeSnip update web service when checking for availability of program updates.
-+ Minor corrections to help file.
-
-Release v4.8.6 of 28 February 2014
-+ Improved operating system detection to handle Windows 8.1.
-+ Added compatibility section to application manifest that declares the program has been tested with Windows Vista and Windows 7.
-
-Release v4.8.5 of 13 January 2014
-+ Fixed bug #91 "Generated units won't compile on Delphi XE5" (http://bit.ly/1eBjym2). Compiler directives that are used to change compiler warnings now includes a conditionally compiled $LEGACYIFEND ON directive.
-+ Fixed potential bug when checking for the existence of files. It had been possible that a "sym-link" to a file could give misleading results.
-+ Updated program copyright date in license file, about box, help file and installer.
-
-Release v4.8.4 of 28 November 2013
-+ Improved user interface of SWAG Import Wizard.
-+ Renamed "Save Snippet" and "Copy Snippet" menu options to "Save Annotated Source" and "Copy Annotated Source". This fixes bug #90: " Wrong caption on menu option for copying category to clipboard" (http://bit.ly/ImA398).
-+ Revised and corrected numerous main menu and pop-up menu hints.
-+ Updated help file re changes to menu options and SWAG Import Wizards.
-
-Release v4.8.3 of 06 November 2013
-+ Fixed registry access code so that the 64 bit view of the registry is used when CodeSnip runs on a Windows 64 bit operating system.
-+ Changed to avoid use of a deprecated API call when using the Windows Browse for Folder dialogue box.
-+ Updated documentation.
-
-Release v4.8.2 of 30 October 2013
-+ Modified Syntax Highlighter tab of Preferences dialogue box so that "vertical" fonts (whose names begin with "@") no longer appear in list of available fonts.
-+ Fixed potential bug in operating system detection code that may fail on Windows 2000.
-
-Release v4.8.1 of 18 September 2013
-+ Removed "File | Page Setup" menu option because some settings made there were being ignored when a file was printed. This is a fix for bug #89 "Setup selections not being remembered" (http://bit.ly/1a3V94x).
-+ Updated help file re changes.
-
-Release v4.8.0 of 12 September 2013
-+ Added support for Delphi XE5 compiler.
-+ Fixed bug in code that reads or imports user database files written using CodeSnip 3 where Delphi XE4 compile results would be lost.
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v4.7.2 of 27 August 2013
-+ Fixed bug #88 "SWAG Import Wizard display bug" (http://bit.ly/15ryOxz) where duplicate snippets could be displayed on the "Ready to import" page in certain circumstances.
-
-Release v4.7.1 of 18 August 2013
-+ Fixed bug where right clicking a tab in the detail pane sometimes caused the contents of the pane to be temporarily blanked out while the context menu was displayed.
- - This fix also, as a side effect, fixed bug #87 "Tab headings and contents don't match after a tab is closed." (http://bit.ly/15TD197).
-
-Release v4.7.0 of 31 July 2013
-+ Implemented feature request #71 "Support importing of one or more snippets from the SWAG database" (http://bit.ly/18AFlGu):
- - Uses DelphiDabbler SWAG web service to get SWAG data.
- - New wizard to permit user to select required SWAG snippets. This is accessible from the new "Snippets | Import Snippets From SWAG" menu option.
- - Snippets are imported into a new "SWAG Imports" category.
-+ Implemented feature request #80 "Enable detail pane tabs to be re-ordered" (http://bit.ly/13cbjTZ).
-+ In detail pane source code and compiler table now display horizontal scroll bars if they do not fit within the width of the pane. This implements feature requests #60 (http://bit.ly/17iCzT4) and #61 (http://bit.ly/1coDJ5f).
-+ Minor changes to dialogue box that appears during long operations.
-+ Fixed bug #86 "Snippets are sorted by snippet name in snippet table listings in detail pane" (http://bit.ly/17iD27H).
-+ Fixed a few code errors that could have surfaced as bugs.
-+ Modified how HTML based detail pane display is generated and displayed.
-+ Some refactoring.
-+ Updated some 3rd party code to latest available versions.
-+ Updated help file re changes.
-+ Updated privacy statement.
-
-Release v4.6.4 of 24 July 2013
-+ Fix for IE 9 related browser control script bugs introduced in v4.6.3 when IE 10 bugs were fixed:
- - Bug #84 "Script errors on startup" (http://bit.ly/13bfaAL).
- - Bug #85 "Check For Updates link " (http://bit.ly/1656pgE).
-
-Release v4.6.3 of 14 July 2013
-+ Further fix for IE 10 related bug #75 "Floating point error in 4.4.1" (http://bit.ly/12zAWSp). Re-implemented method used to display content in main window's detail pane using the IE web browser control.
-
-Release v4.6.2 of 09 July 2013
-+ Tentative fix for bug #83 "Error when the main form is shown" (http://bit.ly/12eUV5Y) that has been reported on Windows 8. The fix is tentative because the bug hasn't been reproduced.
-
-Release v4.6.1 of 01 July 2013
-+ Provided fix for reported bug #75 "Floating point error in 4.4.1" (http://bit.ly/12zAWSp) that apparently affects Windows 8, probably with IE 10 installed.
-+ Fixed unreported bug where IE 10 browser was being reported as IE 9.
-+ Fixed potential bug in code that processes class / advanced record snippet types ready for test compilation and inclusion in generated units.
-
-Release v4.6.0 of 02 June 2013
-+ Added new options to "Find Cross References" dialogue box to allow snippets that either cross reference or depend upon the selected snippet to be included in the search. This implements feature request #30 (http://bit.ly/13cYImA).
-+ Added a new "Select and Close" button to the Dependencies dialogue box that causes the snippets displayed on the current tab to be selected in the main display. This implements feature request #77 (http://bit.ly/15s8fH2).
-+ The background colour of source code displayed in the main display can now be customised via a new option on the Display tab of the Preferences dialogue box. This implements feature request #36 (http://bit.ly/17fxMGW).
-+ CodeSnip now compiled with Delphi XE.
-+ Per-user configuration file format changed to v15 which is not entirely compatible with previous versions of CodeSnip.
-+ Updated help file re changes.
-
-Release v4.5.1 of 15 May 2013
-+ Added progress bars or marquees to several database operations that can take a long time on slower storage devices, i.e.:
- - When local files are being updated after downloading an updated database in the Update From Web dialogue box. This fixes bug #79 (https://sourceforge.net/p/codesnip/bugs/79/)
- - When the local database is being saved.
- - When the local database is being backed up or restored.
- - When the local database is being moved to a new location.
-+ The user database can now be relocated to a network drive. This fixes issue #81 "Move database to a network drive" (https://sourceforge.net/p/codesnip/bugs/81/).
-+ Fixed issue #80 "HTML output bug" (https://sourceforge.net/p/codesnip/bugs/80/).
-+ Fixed minor alignment bug that occurred when displaying a wait dialogue box over the main window.
-+ Some refactoring.
-+ Updated help file re changes.
-
-Release v4.5.0 of 02 May 2013
-+ Added support for Delphi XE4 compiler. Implements feature request #78 (http://bit.ly/10uGhoD).
-+ Updated documentation re changes.
-+ Updated help file re changes.
-
-Release v4.4.2 of 26 April 2013
-+ Fixed bugs:
- - #76 (http://bit.ly/12Loz5o) - An advanced record snippet with a method name that clashes with a directive is not test compiling correctly.
- - #77 (http://bit.ly/11I9wXI) - Syntax highlighter highlights "contains", "requires" and "package" directives when used in method names.
- - #78 (http://bit.ly/ZQl3T4) - CodeSnip doesn't restore window in correct position when task bar on left or top of screen.
-
-Release v4.4.1 of 09 April 2013
-+ Fixed bug #73 "Attempting to check for program updates returns a 404 'Not found' error" (http://bit.ly/Yf3UGy) - this error happened only when using remote server, not localhost test server.
-
-Release v4.4.0 of 08 April 2013
-+ Implemented feature request #75 "Check for updates on start-up" (http://bit.ly/ZJ8OGH):
- - CodeSnip checks for both program and Code Snippets Database updates in low priority background threads that run when the program is first started.
- - Update checking takes place at intervals between once per day and once per month.
- - A new "Updates" tab was added to the "Preferences" dialogue box where update frequencies can be chosen, or the auto-update feature switched off. Program and database update checking can be configured individually.
- - Updates are notified via a new slide-in, slide-out notification window that is displayed for a fixed amount of time or until closed by the user. The notification window contains a button that can be used to initiate the appropriate update. For database updates the "Update From Web" dialogue box is opened while for program updates a suitable download web page is displayed in the default browser.
- - Program checking is edition specific, i.e. the standard edition checks for standard edition updates and the portable edition behaves similarly.
-+ A new "Update Checks" section was added the welcome screen that gives information about the current auto-update settings and provides a link to change them. Some other text on the screen was tweaked.
-+ The "Check For Program Updates" dialogue box now opens the correct version and edition specific web page to download the latest version of CodeSnip instead of simply opening a general download page.
-+ A new CodeSnip specific program update web service on the codesnip.delphidabbler.com sub-domain is now used to get information about CodeSnip updates instead of the generic update service on delphidabbler.com.
-+ Additional usage information is now sent to the DelphiDabbler Code Snippets database update web service.
-+ Some refactoring and code clean-up.
-+ The installer may now display an information page that describes the new automatic update checking feature. This page is displayed only when updating from v4.3.0 or earlier to v4.4.0 (or later).
-+ Updated help file:
- - Updated and added help topics for all new features of the release.
- - Updated "What's New" topic re new features.
-+ Updated documentation, including privacy statement, with information about automatic update checking.
-+ Per-user configuration file format changed to v13 which is incompatible with previous versions of CodeSnip.
-
-Release v4.3.0 of 27 February 2013
-+ Implemented feature request #40 "Add 'Namespaces' tab to Configure Compilers dialogue box" (http://bit.ly/12XsX32). The new tab appears only for Delphi XE2 and later and obviates the need to manually create -NS commands for passing to the compilers. Suitable default namespaces are provided if none have been configured.
-+ Implemented feature request #70 "Let user specify location of user database" (http://bit.ly/13aNCQZ). This feature is accessed from the new "Move Use Database" option on the Database menu. NOTE: The feature is not available in the portable edition which is designed to keep the user database together with the program.
-+ Implemented feature request #69 "Enable custom syntax highlighter styles to be saved" (http://bit.ly/XQHkOI). The Syntax Highlighter tab of the Preferences dialogue box has been modified to enable custom syntax highlighter attributes to be saved under a given name and existing named styles to be used or deleted.
-+ Changed name of "Delphi 2006" predefined syntax highlighter to "RAD Studio". This remains the default highlighter.
-+ A little refactoring.
-+ Enlarged Configure Compilers dialogue box.
-+ Updated help file:
- - Updated and added help topics re all new features in the release.
- - Updated "What's New" topic re new features.
- - Removed help topic for "Browse For Folders" dialogue box accessed from Search Paths tab of Configure Compilers dialogue.
-+ Per-user configuration file format changed to v12 which is not fully compatible with previous versions of CodeSnip.
-+ Updated documentation.
-
-Release v4.2.1 of 14 February 2013
-+ Bug fix: changed Favourites dialogue to display snippet display names instead of unique names. Fixes bug #72 (http://bit.ly/Vj6ZCM).
-+ Updated program copyright date in About box.
-
-Release v4.2.0 of 07 February 2013
-+ Added support for "favourite" snippets. Implements feature request #37 (http://bit.ly/12unShW):
- - Any displayed snippet can be flagged as a favourite via a menu option or toolbar button.
- - A new non-modal dialogue box can now be displayed alongside the CodeSnip window for easy selection and management of favourite snippets.
-+ Changes to Duplicate Snippets dialogue box:
- - Display name of duplicate snippet can be edited. Implements feature request #64 (http://bit.ly/14TdUGF).
- - Snippets Editor can be opened immediately the Duplicate Snippet dialogue box closes to edit the duplicated snippet. Implements feature request #65 (http://bit.ly/UBlt2Y).
-+ Status bar changed: first panel now displays no category information, but displays both total number of snippets and number of snippets in each database.
-+ Fixed unreported bug in save dialogue boxes where overwrite permission requests could be displayed erroneously.
-+ Program closes gracefully if run on unsupported versions.
-+ Updated some 3rd party code to latest available versions.
-+ Some refactoring.
-+ Per-user configuration file format changed to v11 which is not fully compatible with older versions of CodeSnip.
-+ Updated help file re changes in Duplicate Snippets dialogue box and addition of support for Favourites.
-+ Updated documentation.
-
-Release v4.1.1 of 30 January 2013
-+ Fixed bugs:
- - #68 (http://bit.ly/WxG6LC): Comments missing in unit / code generation for some types.
- - #70 (http://bit.ly/WAYEHN): Changing syntax highlighter font has no effect in main display.
- - #71 (http://bit.ly/14v9i9v): Option to select monochrome printing not working properly.
- - Unreported: Changing syntax highlighter font has no effect when printing or when copying text to clipboard as RTF (related to bug #70).
-+ Updated help file re syntax highlighter changes.
-
-Release v4.1.0 of 06 January 2013
-+ This is the first non-beta release to made available in both standard and portable editions, compiled from a common code base. The portable edition differs from the standard as follows (as per release v4.0.1 portable beta 1):
- - Executable file name is CodeSnip-p.exe.
- - Program caption identifies program as portable version.
- - Data directories are sub-directories of executable program directory.
- - Common file dialogue boxes default to program's working directory.
- - First run processing does not give the option to import old settings or existing user databases.
- - Different version information and program identifier.
- - There is no set up program.
-+ Changes to snippets editor:
- - Added context menus to cross-references and dependencies check box lists. Both have menu item to clear list. Dependencies list has item to view dependencies. Implements feature request #3560960 (http://bit.ly/U83Swh).
- - Deleted "View Dependencies" button now that its functionality is now on context menu.
- - Enlarged various controls on all except "Code" tab.
- - Units listed on "References" tab is now persistent. Units can be removed, defaults restored and selection cleared via a new context menu. Implements feature request #3560962 (http://bit.ly/UM0c0B).
-+ New source code formatting option added to only use first paragraph of a snippet description as snippet comment in generated code. This is configured via "Code Formatting" tab of "Preferences" dialogue box and / or from relevant "Save" dialogue boxes. Implements feature request #3560647 (http://bit.ly/UQrDax).
-+ Changed mini-toolbar in overview pane to expand / collapse all overview tree view instead of just selected node. Implements feature request #3560646 (http://bit.ly/UOUQTr).
-+ Reimplemented database search engine.
-+ Some external links modified that will seamlessly accommodate future changes in destination URLs.
-+ Changed some glyphs used in menus.
-+ Per-user configuration file format changed: bumped file version to 10.
-+ Some refactoring.
-+ Help file updated re changes & added privacy statement to TOC.
-+ Updated documentation:
- - Re changes to source code repository and bug / feature request trackers.
- - Re portable version.
-
-Release v4.0.2 of 17 December 2012
-+ Improvements to keyboard handling:
- - Fixed some keyboard focus bugs.
- - Fixed broken, missing and duplicate Alt-key short-cuts in several dialogue boxes.
- - Fixed broken keyboard access to list view in Code Generation tab of Preferences dialogue box.
-+ Corrected an incorrect font in Compilers dialogue box.
-+ Added title to "View Link" dialogue box displayed from mark-up editor.
-+ Corrected error in "Submit Code to the Database" task help topic.
-
-Release v4.0.1 portable edition, beta 1 of 12 December 2012
-Internal CodeSnip version 4.0.1.213
-+ Modified version of Release v4.0.1 that can run from a writeable removable medium without writing files or registry on host computer. This implements feature request #3577431 (http://bit.ly/UxvUj0).
-+ Changes that apply only to portable version:
- - Changed executable file name to CodeSnip-p.exe.
- - Program caption changed to identify as portable version.
- - Data directories changed to be sub-directories of executable program directory.
- - Changed common file dialogue boxes to working directory by default.
- - First run processing no longer gives option to import old settings or existing user databases.
- - Different version information and program identifier format.
- - No set up program.
-+ Code base modified to conditionally compile either portable or standard edition.
-+ Updated documentation, including privacy statement.
-
-Release v4.0.1 of 08 December 2012
-Internal CodeSnip version 4.0.1.212
-+ Fixed bug #3578652 (http://bit.ly/RXIwBC): "Pre-processor directive errors in main db ini files" by removing support for problematic directives.
-+ Rolling mouse over links in detail pane no longer displays a hint in the status bar. This change fixes bug #3577407 (http://bit.ly/VeSVGg): Clicking detail pane snippet link leaves hint in status bar.
-+ Windows no longer scale automatically when screen DPI differs from that on design system. This fixes bugs #3591818 (http://bit.ly/TvNaUL) "Strange window behaviour in Windows 7" and bug #3591820 (http://bit.ly/SEH6dO) "Incorrect font size used for some bold text".
-+ Update operating system detection code to detect W0ndows 8 & 2012 server.
-+ Some refactoring and some redundant code removed.
-+ Updated documentation.
-+ Updated help topic that describes main display.
-
-Release v4.0.0 of 12 October 2012
-Final v4 release.
-See also changes from alpha, beta and release candidates below for details of changes since v3.9.3.
-+ New glyphs that describes level of testing applied to snippets from online Code Snippets Database now appear in top right of detail pane.
-+ Changed main window caption and task bar entry to include version number "4" after program name.
-+ Fixed bugs:
- - #3572382 (http://bit.ly/OnEtNY): Automatic conversion of blank lines to paragraphs in REML mark-up editor gets confused if block level tags are already present.
- - Unreported: Controls in News dialogue box do not use correct font.
-+ A little refactoring.
-+ Updated help file:
- - Modified re recent changes
- - Added new "What's new" topic giving details of changes in v4. Implements feature request #3567490 (http://bit.ly/RgQx0W).
- - Renamed "Welcome" page as "Overview".
-+ Updated documentation, including read-me file.
-
-Release v4.0 RC 3 of 18 September 2012
-Internal CodeSnip version 3.999.3
-+ Fixed serious bug #3568628 (http://bit.ly/V5NX0H): "CodeSnip faulting at startup after fresh install with no previous v3 installation".
-
-Release v4.0 RC 2 of 17 September 2012
-Internal CodeSnip version 3.999.2
-+ Fixed serious bug #3568515 (http://bit.ly/Oy2Q7g): Duplicating a snippet with a display name causes crash.
-+ Minor update to licensing information and about box credits.
-
-Release v4.0 RC 1 of 14 September 2012
-Internal CodeSnip version 3.999.1
-+ UI changes:
- - Welcome page completely revised. Instead of a program overview the page now describes the state of the databases and available compilers and displays help links and a donation request. There are also some links to the about box, news and program updates.
- - Many changes to glyphs used in menus and toolbar.
- - Removed some images that relate to trade marks, i.e. PayPal Donate button and Delphi compiler icons.
- - No clicking noise is now issued by UI in response to user interaction with Details pane.
- - Links to external commands and to other snippets re-styled.
- - Revised and updated program's main icon.
-+ Fixed bug #3566426 (http://bit.ly/OmbwTB): About Box Paths Page displays wrongly when themes not available.
-+ Added support for Delphi XE3 compiler. Implements feature request #3566346 (http://bit.ly/SIVpS2).
-+ Completely new Easter Egg.
-+ Refactoring and internal code changes, including a revision of the "external" object that communicates with JavaScript in browser controls.
-+ Changed License:
- - EULA for executable code changed to Mozilla Public License v2.0.
- - Most original source code changed to Mozilla Public License v2.0 from v1.1.
- - Only an abbreviated version of the license is now displayed by the installer and in the help file.
- - License information has been consolidated into a new file: License.html.
-+ About box changed re new license and changes in required and voluntary acknowledgements and credits.
-+ Help file updated.
-+ Documentation updated.
-
-Release v4.0 beta 2 of 25 August 2012
-Internal CodeSnip version 3.99.2
-+ Bug fixes:
- - #3556620 (http://bit.ly/Mq1Khh): Serious flaw in generating units containing class types when the classes contain method types other than procedure or function.
- - #3556713 (http://bit.ly/RIzfvQ): Context menus are not displayed when pressing Alt+F10.
- - #3556715 (http://bit.ly/O3QN0u): Deleting a category then returning to it via the history list causes a GPF.
- - #3556718 (http://bit.ly/RVanCE): Inconsistent context menus for edit controls in Snippets Editor.
- - #3557107 (http://bit.ly/PfiYxm): New snippets and categories are not added to the history list.
- - #3558649 (http://bit.ly/PAXLQv): Closing the Preferences dialogue always refreshes the main display even if the dialogue box was cancelled or if nothing was changed.
- - #3559156 (http://bit.ly/TKXYQ7): "Previews" giving examples of the effect of changes made in the Preferences dialogue box sometimes disappear when the tab key is pressed.
- - #3559239 (http://bit.ly/Pm1HU4): Snippet names and display names are used inconsistently in the UI.
- - #3559257 (http://bit.ly/Qc8Fqu): Compile Results displayed from the main menu can get out of sync with the actual compile results of snippets that have been edited since they were last compiled.
- - #3559265 (http://bit.ly/NvV9iH): Viewing dependencies for an unnamed snippet or a snippet not in the database causes a GPF.
- - #3559266 (http://bit.ly/S69wO2): When include files are generated for a snippet that depends on a class type, the required class is not listed in the file's header comments.
- - #3560317 (http://bit.ly/PUcEgV): The caption of the Active Text preview dialogue box refers to "Extra" text when it is used to preview a snippet's description.
- - #3560521 (http://bit.ly/RG7Jlw): The state of the Overview tree often doesn't restore correctly after a database update.
- - #3560958 (http://bit.ly/TX7M9V): Snippets are not sorted correctly (i.e. on display name) in the Overview pane.
- - #3561014 (http://bit.ly/PEFgXY): The current view in the Display pane is not cleared, even though all tabs are closed, when the database is re-loading.
- - #3561047 (http://bit.ly/Pf5L5v): The Category view in the Overview pane sometimes appears fully expanded when it is expected to be fully collapsed.
- - Untracked: Removed "(v4 preview)" text that had been left in main window title bar.
- - Untracked: Minor accelerator key related problems in the Preferences dialogue box.
-+ Main UI changes:
- - The Detail pane tab-set now has a context menu that can be used to close the current tab or all but the current tab. The Close tab option is also added to current view's context menu.
- - Right-clicking a tab in the Overview or Detail pane now selects the tab.
- - Middle-clicking an item in the Overview pane now selects it. Previously middle clicks were ignored.
- - Many more parts of the main display and dialogue boxes now display display names for snippets rather than unique names.
- - Ctrl clicking snippet and category links in the Detail pane and History UI controls now opens the chosen item in a new tab. Implements feature requests #3559377 (http://bit.ly/OqnAjd) and #3559378 (http://bit.ly/NPtEkX).
- - Different link styles are now used for the different types of link in the Detail pane. Implements feature request #3559464 (http://bit.ly/Pwsqg6).
- - Pressing Ctrl+Return on an active snippet or category link in the Details pane now opens the item in a new tab instead of the current tab. Pressing Return now opens the item in the current tab.
- - The Detail pane's context menu now displays more options when text selections and links are right clicked. Implements feature request #3559375 (http://bit.ly/NzaY8a) with some minor differences.
- - New button added to the Display tab of the Preferences dialogue box that resets default snippet heading colours. Implements feature request #3559140 (http://bit.ly/QKQo43).
- - The "Types" unit is now displayed by default in the Snippets Editor Reference Tab's predefined units list.
-+ When a category is printed, any URLs in snippet descriptions are output and styled.
-+ Names of units referenced by snippets may now contain dots.
-+ Some refactoring and internal code changes, including a major reworking of the "first run" program configuration and a revision to the "external" object that communicates with JavaScript in browser controls.
-+ Help file updated:
- - Re UI changes.
- - With a description of the need to configure namespaces for Delphi XE2 for each unit referenced by the code it is test compiling - addresses bug #3536531 (http://bit.ly/Q2bcmY).
-+ Updated documentation.
-
-Release v4.0 beta 1 of 11 August 2012
-Internal CodeSnip version 3.99.1
-+ New features:
- - Structure of snippet pages in details pane is now customisable: various page elements can be omitted and order of elements can be specified. Each snippet type has its own page customisation. Implements feature request #3519456 (http://bit.ly/NhT8Kr).
- - Snippets can now have a "display name" that can contain any characters and does not need to be unique. When provided the display name is displayed in preference to the normal name. Implements feature request #3519460 (http://bit.ly/NN6kRP).
- - Snippet descriptions can now be formatted and contain multiple paragraphs. This implements feature requests #3411890 (http://bit.ly/OS8a5a) and #3520405 (http://bit.ly/OS8yRe).
- - Snippets can now be configured so that their source code is not syntax highlighted. This change allows snippets in other languages not to be highlighted as if they are Pascal. Implements feature request #3519935 (http://bit.ly/LrNiAg)
- - Colour of headings for snippets and categories from main and user databases are now user configurable. This implements feature request #3519463 (http://bit.ly/Nz9JH2).
- - User can now limit the number of compilers that appear in the compiler results table in the display pane. This is done via the Configure Compilers dialogue box. Implements feature request #3519459 (http://bit.ly/Q5O51z).
- - New option on Tools menu that checks availability of new versions of CodeSnip.
-+ User interface changes:
- - "Test Compile" link removed from snippet display in details pane.
- - "Test Compile" dialogue box changed so that only the installed compilers that CodeSnip uses for test compilation are displayed, instead of all known compilers.
- - Welcome page revised.
-+ Changes to snippets editor:
- - New field on Code tab to enter optional snippet display name.
- - New check box on Code tab to specify if Pascal syntax highlighter is to be used for source code.
- - New tabbed "mark-up editor" lets user enter multi-paragraph snippet descriptions and extra information either as plain text or as REML mark-up.
- - Controls on Code tab re-ordered.
- - Extra Information tab revised with much larger edit control and deletion of explanatory text.
- - Editor enlarged.
-+ Changes to Preferences dialogue box:
- - New "Snippet Layout" tab added where composition and layout of snippet pages can be customised.
- - "General" preferences tab split into two: "Misc." that contains only measurement units and "Display" that contains display related options.
- - Added controls to "Display" tab to set main and user database heading colours.
- - Changes that affect appearance of content of details pane are now reflected in the display as soon as the Preferences dialogue box closes, rather than on program restart.
-+ Changes to REML mark-up handling:
- - Any REML text not embedded in block level tags is now automatically wrapped in
tags.
- - Nested REML block level tags are no longer allowed.
- - Changed handling of multiple spaces in REML code to be the same as in HTML.
- - Formatting of REML code improved when re-displayed.
-+ Bug fixes:
- - Bug #3536331 fixed (http://bit.ly/KQTYc3): words at the end of some paragraphs in a snippet's extra information were not being found in "whole word only" searches.
- - Fixed unreported file parsing bug that occurred when loading a saved snippet selection from disk.
-+ Changed Delphi compiler detection so that compilers can be detected by examining current user registry key in addition to local machine registry key. This enables Delphis that were installed for a given user only to be detected.
-+ Improved error handling when reading and writing snippet selection files.
-+ User database and export file formats updated to v6.
-+ Per-user configuration file format changes: bumped file version to v9.
-+ Major changes to installer:
- - Now always brings forward any earlier common configuration files if needed.
- - Per user configuration files are now ignored: they are handled by main program (see below).
- - Only main database, not user database, is now imported from earlier versions on user request. User databases are now handled by main program (see below).
- - There is no longer an option to delete old databases or configuration files.
- - Updating from a v4 preview (alpha) release causes an extra page to be displayed that gives instructions relating to updating from preview to current release.
-+ Program now detects if it is running for first time since updating:
- - If this is first run since updating from v3 or earlier a "first run" wizard guides user through importing any old preferences or user databases.
- - For point v4.x point updates user configuration file is silently updated as necessary.
-+ Significant refactoring.
-+ Updated help file in line with changes and new features.
-+ Updated documentation, including minor changes to privacy statement and license.
-
-Release v4.0 alpha 3 (preview) of 18 June 2012
-Internal CodeSnip version 3.98.3
-+ New features:
- - Compiler warnings can now be switched on as well as off in generated code.
- - Names and descriptions of snippets in a category can now be printed.
- - Text and compiler searches can now be nested so that the later search refines the earlier one.
- - Current selection (i.e. search result set) can be saved to disk and loaded again later.
-+ User interface changes:
- - Overview pane now displays buttons that can be used to collapse or expand non-empty section headings.
- - Ctrl + arrow keys can now be used to scroll overview pane tree view vertically and horizontally without changing selection in overview pane.
- - Main window is now refreshed whenever changes that affect it are made in the Preferences dialogue box.
- - Some main menu short-cut keys changed.
- - Dependencies dialogue box now has two tabs: the first displays the snippets required to compile the selected snippet while the second tab displays snippets that depend upon the selected snippet.
- - Code Generation tab of Preferences dialogue box updated to enable warnings to be switched on or off. In addition default warnings can be restored, list view columns can be sorted and Alt key short-cuts tweaked.
- - Code Import dialogue box improved: now sorts imported units in list view and scrolls to make renamed snippets visible.
- - Snippet selection and cross-reference search dialogues now report if existing search results will be overwritten.
- - Text and compiler search dialogues now ask if any current search results are to be refined.
- - Tree views in Snippet Selection, Snippets export and Snippets submission dialogue boxes can now be expanded and collapsed.
- - Appearance of message boxes tweaked.
- - Program tab of About box updated with credits for new third party code.
-+ Bug fixes:
- - Error in logic of code that generates program ID was fixed.
- - Bug #2868708 fixed (http://bit.ly/KeyAvS): edited snippets are no longer lost from manual snippet selections unless snippet names are changed.
- - Bug #3534138 fixed (http://bit.ly/Mg9gJG): details pane display is now cleared when last tab is closed: previously content of last closed tab remained on screen.
-+ Info about user's OS and IE version is now sent to web server during online database updates.
-+ Some refactoring.
-+ Help file updated in line with changes and new features. Some US English spellings changed to UK English for consistency.
-+ Updated documentation, including:
- - Privacy statement updated re changes in data recorded via database update log-ons.
- - Licensing docs updated re introduction of some MPL 2.0 files.
-
-Release v4.0 alpha 2 (preview) of 21 April 2012
-Internal CodeSnip version 3.98.2
-+ New features:
- - New "unit" snippet type that enables complete units to be stored in database and to be test compiled.
- - New "classes" snippet type that enables a single Object Pascal class or advanced record-with-methods to be stored in database, test compiled and included in generated units.
- - Snippets from both the user and main databases can now be duplicated. Duplicates are editable and are stored in the user database.
- - Online CodeSnip FAQs can now be displayed in the default browser from a new option on the "Help" menu.
-+ User interface changes:
- - New "Snippets" and "Categories" top level menus have been added. They are populated with items previously on the "Database" menu. "Snippets" menu also has new "Duplicate Snippet" item.
- - "Help" menu re-arranged: items from the former "On The Web" sub-menu are now placed directly on "Help" menu.
- - Numerous new and updated glyphs on toolbar, menu and in main display.
- - Minor tweaks to controls in the Code tab of the Snippets Editor.
- - Minor changes to the style of version info displayed on the splash screen.
-+ Bug fixes:
- - Fixed potential source of a bug in code that edits user-defined categories.
- - Fixed unreported minor bug in dialogue boxes that display tabbed page controls: clicking a tab did not always give it the keyboard focus.
- - Fixed bug #3519784 (http://bit.ly/IsCsun) where multi-line "type" or "constant" snippets that start on the same line as the type or const keyword were corrupted when included in units using the "comments after snippet header" comment style.
-+ Characters used to introduced switches on the command line were changed: '/' replaces '\'. '-' is still permitted.
-+ User and main database formats modified. User databases saved with this version may not be readable with release 4.0 alpha 1.
-+ Some refactoring.
-+ Help file updated in line with changes and some errors fixed.
-+ Updated documentation.
-
-Release v4.0 alpha 1 (preview) of 31 December 2011
-Internal CodeSnip version 3.98.1
-Changes relate to v3.9.3
-+ User interface changes:
- - New multi-tab detail pane can now show more than one snippet, category etc.
- - Results of test compiles now appear in a dialogue box instead of in details pane.
- - New code import wizard for cleaner control over import process.
- - New "Compile" top level menu that groups all actions relating to test compilation.
- - Empty section headings can now be displayed in overview pane if required.
- - New display options relating to multi-tab display.
- - New view displayed instead of welcome screen when database updated.
- - Some additions and changes to main window navigation keys.
- - Main window and task bar captions changed.
- - Some dialogue boxes tweaked.
- - Compiler configuration dialogue box heavily revised to support default compiler paths.
- - "About" dialogue box paths tab display improved.
- - Compile error dialogue box display standardised.
- - Splash screen updated.
-+ Improved Delphi code syntax highlighter:
- - Recognises Delphi 2010 keywords
- - Correctly handles context sensitive directives within "property", "exports" and "external" statements.
- - Recognises '&' prefix that causes keywords to be treated as identifiers.
-+ Compiler search paths can now be specified for included units permitting non-VCL units to be used by snippets.
-+ Database:
- - Non-empty categories can no longer be deleted.
- - File format of both user-defined and main databases changed.
- - Database locations changed: updates to main database and edits to user database do not affect databases used by v3 and earlier.
- - Location and file format of both user defined and main databases changed.
- - Database now supports Unicode Delphi source code.
- - Unicode Delphi identifiers can now be used for snippet names.
- - Export and backup file formats updated: new formats are not backward compatible but older versions can still be imported.
- - Code submission service now supports Unicode source code.
- - Database updates now use v5 of delphidabbler.com web update service with revised checksum handling.
-+ Unicode support:
- - Program now fully supports Unicode internally.
- - Test units now use UTF-8 format if source code contains non-ANSI characters. ANSI format is used otherwise to permit compilation on older Delphi compilers.
- - Many export file formats now support Unicode and UTF8 formats. User may specify file types from Save dialogue box.
- - Configuration files are now in Unicode format.
- - Some Unicode support added to database (see above).
-+ Web service data handling code improved: now includes ability to send raw bytes and can detect and adapt to character encoding used in responses.
-+ Common and per-user configuration file names and locations changed. Bumped file version numbers to 6 and 8 respectively.
-+ Fixed some bugs:
- - Various Unicode and code page related problems in RTF code generation.
- - Memory leaks.
- - Version detection in backup file restoration.
-+ Cascading style sheet handling improved.
-+ Any errors in scripts run in browser control now trapped and reported as exceptions instead of via browser control's own error dialogue box.
-+ Revised external object that communicates with JavaScript in browser controls.
-+ Hyper-links used in snippets now support the https:// protocol.
-+ A default title now used in print spooler if none specified.
-+ Source code heavily refactored.
-+ Help file updated in line with changes.
-+ Installer:
- - Changed so that v3 and v4 installs can co-exist - default install locations are different and v4 does not overwrite v3.
- - Converts v3 configuration files to v4 Unicode format and copies to new locations. File version stamps are updated.
- - Installer is now compiled with Unicode version of Inno Setup instead of ANSI version.
- - Scripts updated and refactored.
-+ Updated documentation, including changes to privacy statement and new file format documentation.
diff --git a/Docs/Design/FileFormats/backup.html b/Docs/Design/FileFormats/backup.html
index c3646ad1d..1e2752961 100644
--- a/Docs/Design/FileFormats/backup.html
+++ b/Docs/Design/FileFormats/backup.html
@@ -1,18 +1,15 @@
+ "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+
@@ -80,14 +77,14 @@
Similar to version 1 except that the 32Kb size limit was lifted (now 2Gb).
- Also only for backing up the user database.
+ Used only for backing up the user database.
Version 3
- Similar to Versions 1 and 2. Nowused for backing up both the user database
- and the main database. An file ID field was added to allows which database
+ Similar to Versions 1 and 2. Now used for backing up both the user database
+ and the main database. A file ID field was added to specify which database
was backed up. The file ID generalises to any file.
@@ -135,7 +132,7 @@
This file format uses pure binary raw data. The watermark part of the file
header is written in ASCII. File names are stored as UTF-8. All other
- information, including file contents is stored as raw binary.
+ information is stored as raw binary.
@@ -288,7 +285,6 @@
'DBAC' for user database backup.
- Other IDs could be used for other backup types.
FileCount
@@ -374,7 +370,6 @@
'DBAC' for user database backup.
- Other IDs could be used for other backup types.
FileCount
@@ -423,13 +418,13 @@
Code that writes backup files should only ever write the latest available file
- format at the time the code was written. It should never attempt to write
+ format at the time the code was written. It musr never attempt to write
earlier versions.
- Code that restores backup files be able to interpret all earlier formats in
- addition to the current one because the program may to restore data from an
+ Code that restores backup files must be able to interpret all earlier formats in
+ addition to the current one, because the program may need to restore data from an
old backup file. If the code detects a later version than it was designed for
it should display an error message and terminate.
@@ -440,9 +435,9 @@
Some earlier versions of the backup restoration code have faults in that they
- will attempt to read later backup file versions than thosethey were designed
- for. By good fortune factors in the design of later file formats mean that the
- reading code always abandons the reading, albeit with no error message. These
+ will attempt to read later backup file versions than those they were designed
+ for. By good fortune, factors in the design of later file formats mean that the
+ reading code always abandons reading later, albeit with no error message. These
problems are:
@@ -458,11 +453,10 @@
The reading code expects backup files to begin with a file count as a text
- hex representation of a SmallInt. In file version 2 and later the first
+ representation of a SmallInt in hex. In file version 2 and later the first
four ANSI chars of the file are 'FFFF', which decodes as
-1. The reader interprets this value as meaning there are no
- files in the backup and does nothing, leaving the existing database
- intact.
+ files in the backup and does nothing.
@@ -476,7 +470,7 @@
In v3 files the file ID is recorded in the same location and same format
as the v2 file format expects to find the file count. Luckily the only two
values in use as File IDs are 'CBAC' and 'DBAC',
- both of which decode as negative integers. The reader software interprets
+ both of which decode as negative integers expressed in hex. The reader software interprets
this as meaning there are no files in the backup.
@@ -498,11 +492,11 @@
work with file format v3 will also try to read later file versions. It
looks for its file count in a hex encoded SmallInt value at position 12 in
the backup file. File format v4 was designed to have a padding value of
- '0000' in this location. Agains this fools the reader software
+ '0000' in this location. This fools the v3 reader software
into thinking there are no files in the backup.
- From CodeSnip v3.8.6 the file reader works correctly.
+ From CodeSnip v3.8.6 the file reader works correctly and exits with an error when an unsupported backup file version is encountered.
@@ -536,7 +530,7 @@
File format version 1
- Watermark: ''
+ Watermark: '' (empty)
File format version 2
@@ -561,8 +555,8 @@
It can be seen that the version number at byte offset 4 is not necessary for
identification if the watermark is made longer. However, it should always be
- used because earlier versions of the file readers use it to determine which
- format is to be read.
+ used because earlier versions of the file readers may use it to determine which
+ format version is to be read.
- CodeSnip uses two config files – one system wide application file named
- Common.config and another per-user file named
- User.config. There will be a different one of the latter for each
- user account on the system where CodeSnip is used.
+ CodeSnip uses two config files – one system wide application file named Common.config and another user file named User.config. The standard version of CodeSnip maintains separate user config file for each user account that uses CodeSnip, while the portable version has just one such file.
- Config files use the standard .ini file format and are written and read using
- Windows API calls.
+ Config files use the standard INI file format and are written and read using Windows API calls.
@@ -66,27 +59,19 @@
- String – stored as a sequence of characters, optionally
- enclosed in double quotes.
+ String – stored as a sequence of characters, optionally enclosed in double quotes.
- Boolean – stored as the text False and
- True (although 0, No and
- N are all read as false.
+ Boolean – stored as the text False and True (although 0, No and N are all read as false).
- Integer – stored as positive or negative whole numbers or
- zero.
+ Integer – stored as positive or negative whole numbers or zero.
- Float – stored as positive or negative floating point numbers
- or zero. Floating point representations of whole numbers are stored as
- integers.
+ Float – stored as positive or negative floating point numbers or zero. Floating point representations of whole numbers are stored as integers.
- Date-Time – stored in the YYYY-MM-DD hh:mm:ss
- format in all locales (i.e. the date and time separators are always '-' and
- ':' respectively.
+ Date-Time – stored in the YYYY-MM-DD hh:mm:ss format in all locales (i.e. the date and time separators are always - and : respectively.
@@ -95,16 +80,11 @@
- From CodeSnip v4 config files are little endian Unicode text files with a byte
- order mark. This encoding is used because the international support is
- required and because the Windows API, which is used to read and write the
- files, understands this file format.
+ From CodeSnip v4 config files are little endian Unicode text files with a byte order mark. This encoding is used because the international support is required and because the Windows API, which is used to read and write the files, understands this file format.
- On earlier versions of CodeSnip the config files were ANSI text files using
- the system's default encoding. The installer takes care of converting the
- older files to Unicode.
+ On earlier versions of CodeSnip the config files were ANSI text files using the system's default encoding. CodeSnip v4 and the standard edition's installer convert the older ANSI files to Unicode.
@@ -115,20 +95,20 @@
Common Config File
+
+ Note: From CodeSnip v4.16 this file is used only by the installer of the standard edition. The portable edition does not use the file and does not create it.
+
+
- This file stores information about CodeSnip that is common to all users. There
- is just one file named Common.config that is stored in the
- %ProgramData%\DelphiDabbler\CodeSnip.4 directory.
+ The file stores information about the current version of the program. It is named Common.config. The file is stored in the standard edition's %ProgramData%\DelphiDabbler\CodeSnip.4 directory.
- There have been several versions of this file. The current one is version 6.
- The change to version 6 came with CodeSnip v4 and the change to Unicode
- encoding.
+ There have been several versions of this file. The current one is version 7. The change to version 7 came with CodeSnip v4.16.0 and the removal of DelphiDabbler web service support.
- The file is in INI file format. It has the following sections.
+ The file has the following sections.
@@ -145,30 +125,10 @@
- Key (String)
-
-
- Unique application ID. String of 32 hex digits.
-
-
- RegCode (String)
+ Version (String)
- Registration code. String of 32 hex digits. May be empty string or missing
- if application not registered.
-
-
- RegName (String)
-
-
- Name of person who registered program. May be empty string or missing if
- application not registered.
-
-
- Version (String)
-
-
- Version of installed program as dotted quad string.
+ Internal version number of the installed version of CodeSnip as a dotted quad string.
@@ -186,39 +146,32 @@
- Version (Integer)
+ Version (Integer)
- Version number of file. Incremented whenever the config file format
- changes. If this section or this value is missing then the default value
- is 1. The installer takes care of converting earlier file versions and
- stamping config file with the correct version number.
+ 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 1.
- Current value is 6.
+ The current value is 7.
- Per User Config File
+ User Config File
- This file records configuration information that is unique to each user of the
- application. Some sections correspond to user preferences while others record
- details of previous operations or the layout of the GUI. The file is named
- User.config and is stored in the logged on user's
- %AppData%\DelphiDabbler\CodeSnip.4 directory.
+ This file records configuration information that is unique users of the application. Some sections correspond to user preferences while others record details of previous operations or the layout of the GUI. The file is named User.config. The standard edition of CodeSnip stores the file in the logged on user's %AppData%\DelphiDabbler\CodeSnip.4 directory, while the portable version stores it in the AppDir sub-directory of the folder where CodeSnip is installed.
- There have been several versions of this file. The current one is version 15.
-
+ 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 UseCommentsInUnitImpl key in the [Prefs:SourceCode] section.
+
- The file is in INI file format. It has the following sections.
+ The file has the following sections.
@@ -226,14 +179,11 @@
- There is one of these section for each compiler known to CodeSnip. Each
- section describes how CodeSnip should use the compiler, or indicates that the
- compiler is not available.
+ There is one of these sections for each compiler known to CodeSnip. Each section describes how CodeSnip should use the compiler, or indicates that the compiler is not available.
- The actual name of a section is found by replacing XXX with one of
- the following values:
+ The actual name of a section is found by replacing XXX with one of the following values:
@@ -243,7 +193,7 @@
D3 – Delphi 3
-
+
D4 – Delphi 4
@@ -294,6 +244,24 @@
D10S – Delphi 10 Seattle
+
+ D101B – Delphi 10.1 Berlin
+
+
+ D102T – Delphi 10.2 Tokyo
+
+
+ D103R – Delphi 10.3 Rio
+
+
+ D104S – Delphi 10.4 Sydney
+
+
+ D11A – Delphi 11.x Alexandria
+
+
+ D12Y – Delphi 12 Athens
+
FPC – Free Pascal
@@ -305,80 +273,112 @@
- ExePath (String)
+ ExePath (String)
- Path to compiler. Empty string if compiler not configured.
+ Path to the compiler's executable file. Empty string if the compiler not configured.
- Displayable (Boolean)
+ Displayable (Boolean)
- Indicates whether compiler's compilation results for a snippet can be
- displayed in detail pane.
+ Indicates whether the compiler's compilation results for a snippet should be displayed in the UI.
- Namespaces (String)
+ Namespaces (String)
- Space separated list of namespaces containing Delphi RTL units. Missing or
- empty string value ⇒ use default RTL namespaces for compiler.
+ Space separated list of the namespaces containing Delphi's RTL units. A missing or empty string value ⇒ use the default RTL namespaces for the compiler.
- Relates to the Delphi XE2 and later compilers. If the value present, it is
- ignored for earlier compilers and Free Pascal.
+ Relates to the Delphi XE2 and later compilers. If the value is present, it is ignored for earlier compilers and Free Pascal.
- Prefix0 (String)
+ Prefix0 (String)
- Double quoted prefix to text output by the compiler to indicate fatal
- compiler errors. If not present the default is "Fatal: ".
+ Double quoted prefix to the text output by the compiler to indicate fatal compiler errors. If not present the default is Fatal: .
- Prefix1 (String)
+ Prefix1 (String)
- Double quoted prefix to text output by the compiler to indicate standard
- compiler errors. If not present the default is "Error: ".
+ Double quoted prefix to the text output by the compiler to indicate standard compiler errors. If not present the default is Error: .
- Prefix2 (String)
+ Prefix2 (String)
- Double quoted prefix to text output by the compiler to indicate warnings. If
- not present the default is "Warning: ".
+ Double quoted prefix to the text output by the compiler to indicate warnings. If not present the default is Warning: .
- Switches (String)
+ Switches (String)
- Comma separated list of compiler switches. Empty string value ⇒ use
- default switches for compiler. A missing value is the same as an empty
- string value.
+ Comma separated list of compiler switches. A missing or empty string value ⇒ use default switches for the compiler.
- Count of number of search directories configured for compiler.
+ Count of the number of search directories configured for the compiler.
- SearchDirXXX (String)
+ SearchDirXXX (String)
- Once entry for each search directory configured for compiler where
- XXX ranges from 0 to SearchDirCount - 1.
+ One entry for each search directory configured for the compiler where XXX ranges from 0 to SearchDirCount - 1.
Each entry contains a fully specified directory path.
+
+ CanAutoInstall (Boolean)
+
+
+
+ Determines whether the compiler can be automatically detected and registered by CodeSnip.
+
+
+ Applies to Delphi compilers only, not to Free Pascal.
+
+
+
+ [Compilers] section
+
+
+
+ This section records configuration information that applies to all, or
+ multiple, compilers.
+
+
+
+ Name / Value pairs:
+
+
+
+
+ PermitStartupDetection (Boolean)
+
+
+
+ Determines whether CodeSnip should detect, and potentially register, any
+ Delphi compilers that are installed on the user's system but not
+ registered with the program.
+
+
+ Does not apply to the Free Pascal compiler.
+
+
+
+
+
[Database] section
@@ -393,17 +393,14 @@
- UserDataDir (String)
+ UserDataDir (String)
- Specifies the directory that contains the user database. This value is
- only present if the user has moved the database from its default
- location.
+ Specifies the directory that contains the user database. This value is only present if the user has moved the database from its default location.
- Note: The value is ignored in the portable version of
- CodeSnip.
+ Note: The value is ignored in the portable version of CodeSnip.
@@ -413,7 +410,7 @@
- Persists state of controls in Duplicate Snippet dialogue box.
+ Persists the state of controls in the Duplicate Snippet dialogue box.
- Stores alpha blend value (i.e. degree of transparency) of Favourites
- dialogue box when it is not active. Values should be in range 128 to 255.
+ Stores the alpha blend value (i.e. the degree of transparency) of the Favourites dialogue box when it is not active. Values should be in the range 128 to 255.
@@ -471,151 +467,179 @@
- D2 (Boolean)
+ D2 (Boolean)
+
+
+ Indicates whether Delphi 2 was included in the search.
+
+
+ D3 (Boolean)
+
+
+ Indicates whether Delphi 3 was included in the search.
+
+
+ D4 (Boolean)
+
+
+ Indicates whether Delphi 4 was included in the search.
+
+
+ D5 (Boolean)
+
+
+ Indicates whether Delphi 5 was included in the search.
+
+
+ D6 (Boolean)
+
+
+ Indicates whether Delphi 6 was included in the search.
+
+
+ D7 (Boolean)
+
+
+ Indicates whether Delphi 7 was included in the search.
+
+
+ D2005w32 (Boolean)
- Indicates whether Delphi 2 was included in search.
+ Indicates whether the Win32 personality of Delphi 2005 was included in the search.
- D3 (Boolean)
+ D2006w32 (Boolean)
- Indicates whether Delphi 3 was included in search.
+ Indicates whether the Win32 personality of Delphi 2006 was included in the search.
- D4 (Boolean)
+ D2007 (Boolean)
- Indicates whether Delphi 4 was included in search.
+ Indicates whether the Win32 personality of Delphi 2007 was included in the search.
- D5 (Boolean)
+ D2009w32 (Boolean)
- Indicates whether Delphi 5 was included in search.
+ Indicates whether the Win32 personality of Delphi 2009 was included in the search.
- D6 (Boolean)
+ D2010 (Boolean)
- Indicates whether Delphi 6 was included in search.
+ Indicates whether Delphi 2010 was included in the search.
- D7 (Boolean)
+ DXE (Boolean)
- Indicates whether Delphi 7 was included in search.
+ Indicates whether Delphi XE was included in the search.
- D2005w32 (Boolean)
+ DXE2 (Boolean)
- Indicates whether the Win32 personality of Delphi 2005 was included in
- search.
+ Indicates whether Delphi XE2 was included in the search.
- D2006w32 (Boolean)
+ DXE3 (Boolean)
- Indicates whether the Win32 personality of Delphi 2006 was included in
- search.
+ Indicates whether Delphi XE3 was included in the search.
- D2007 (Boolean)
+ DXE4 (Boolean)
- Indicates whether the Win32 personality of Delphi 2007 was included in
- search.
+ Indicates whether Delphi XE4 was included in the search.
- D2009w32 (Boolean)
+ DXE5 (Boolean)
- Indicates whether the Win32 personality of Delphi 2009 was included in
- search.
+ Indicates whether Delphi XE5 was included in the search.
- D2010 (Boolean)
+ DXE6 (Boolean)
- Indicates whether Delphi 2010 was included in search.
+ Indicates whether Delphi XE6 was included in the search.
- DXE (Boolean)
+ DXE7 (Boolean)
- Indicates whether Delphi XE was included in search.
+ Indicates whether Delphi XE7 was included in the search.
- DXE2 (Boolean)
+ DXE8 (Boolean)
- Indicates whether Delphi XE2 was included in search.
+ Indicates whether Delphi XE8 was included in the search.
- DXE3 (Boolean)
+ D10S (Boolean)
- Indicates whether Delphi XE3 was included in search.
+ Indicates whether Delphi 10 Seattle was included in the search.
- DXE4 (Boolean)
+ D101B (Boolean)
- Indicates whether Delphi XE4 was included in search.
+ Indicates whether Delphi 10.1 Berlin was included in the search.
- DXE5 (Boolean)
+ D102T (Boolean)
- Indicates whether Delphi XE5 was included in search.
+ Indicates whether Delphi 10.2 Tokyo was included in the search.
- DXE6 (Boolean)
+ D103R (Boolean)
- Indicates whether Delphi XE6 was included in search.
+ Indicates whether Delphi 10.3 Rio was included in the search.
- DXE7 (Boolean)
+ D104S (Boolean)
- Indicates whether Delphi XE7 was included in search.
+ Indicates whether Delphi 10.4 Sydney was included in the search.
- DXE8 (Boolean)
+ D11A (Boolean)
- Indicates whether Delphi XE8 was included in search.
+ Indicates whether Delphi 11.x Alexandria was included in the search.
- D10S (Boolean)
+ D12Y (Boolean)
- Indicates whether Delphi 10 Seattle was included in search.
+ Indicates whether Delphi 12 Athens was included in the search.
- FPC (Boolean)
+ FPC (Boolean)
- Indicates whether Free Pascal was included in search.
+ Indicates whether Free Pascal was included in the search.
- Option (Integer)
+ Option (Integer)
- Code that describes the kind of compilation result to be searched for: 0
- ⇒ snippet compiles OK; 1 ⇒ snippet compiles without warnings; 2
- ⇒ snippet compiles with warning(s); 3 ⇒ snippet fails to compile;
- 4 ⇒ snippet not tested.
+ Code that describes the kind of compilation result to be searched for: 0 ⇒ snippet compiles OK; 1 ⇒ snippet compiles without warnings; 2 ⇒ snippet compiles with warning(s); 3 ⇒ snippet fails to compile; 4 ⇒ snippet not tested.
- Logic (Integer)
+ Logic (Integer)
- Code that describes search logic to use: 0 ⇒ "and"; 1 ⇒
- "or".
+ Code that describes the search logic to use: 0 ⇒ "and"; 1 ⇒ "or".
@@ -624,8 +648,7 @@
- Provides information about last the last text search that was run and records
- a history of search terms.
+ Provides information about last the last text search that was run and records a history of search terms.
@@ -634,42 +657,39 @@
- HistoryCount (Integer)
+ HistoryCount (Integer)
- Count of items in search term history.
+ Count of items in the search term history.
- HistoryXXX (String)
+ HistoryXXX (String)
- One entry for each search term in history where XXX ranges from 0
- to HistoryCount - 1.
+ One entry for each search term in the history where XXX ranges from 0 to HistoryCount - 1.
Each entry contains one or more spaced separated search words.
- MatchCase (Boolean)
+ MatchCase (Boolean)
One of the search options. Indicates whether searches are case sensitive.
- WholeWord (Boolean)
+ WholeWord (Boolean)
- One of the search options. Indicates whether searches match whole words
- only.
+ One of the search options. Indicates whether searches match whole words only.
- Logic (Integer)
+ Logic (Integer)
- Code that describes search logic to use: 0 ⇒ "and"; 1 ⇒
- "or".
+ Code that describes the search logic to use: 0 ⇒ "and"; 1 ⇒ "or".
@@ -678,8 +698,7 @@
- Provides information about the last snippet cross reference search that was
- run.
+ Provides information about the last snippet cross reference search that was run.
- Indicates whether to include the snippet for which the search is being
- performed in the search result.
+ Indicates whether to include the snippet for which the search is being performed in the search result.
- Required (Boolean)
+ Required (Boolean)
- Indicates whether to include snippets that are required to compile the
- selected snippet are included in search result.
+ Indicates whether snippets that are required to compile the selected snippet are included in the search results.
- Indicates whether to recurse required snippets to search for required
- snippets of each required snippet and so on. Ignored if
- Required = False.
+ Indicates whether the search for required snippets is recursive. Ignored if Required = False.
- Indicates whether to include snippets that depend on the searched for
- snippet.
+ Indicates whether snippets that depend on the searched-for snippet are included in the search results.
- SeeAlso (Boolean)
+ SeeAlso (Boolean)
- Indicates whether to include snippets that are cross referenced by the
- selected snippet in search results.
+ Indicates whether snippets that are cross referenced by the selected snippet are included in the search results.
- Indicates whether to recurse cross-referenced snippets to search for their
- own cross references and so on. Ignored if SeeAlso = False.
+ Indicates whether the search for cross-referenced snippets is recursive. Ignored if SeeAlso = False.
- Indicates whether to include snippets that cross-reference searched for
- snippet.
+ Indicates whether snippets that cross-reference the searched-for snippet are included in the search results.
@@ -744,7 +755,7 @@
- Provides information about the config file itself.
+ Provides information about the config file and installed version of CodeSnip.
@@ -753,24 +764,42 @@
- Version (Integer)
+ Version (Integer)
- Version number of file. Incremented whenever the config file format
- changes. If this section or this value is missing then the default value
- is 1. The installer takes care of converting earlier file versions and
- stamping config file with the correct version number.
+ 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 1.
+ Internal version number of the currently installed version of CodeSnip as a dotted quad.
+
+
+
+
+ [Prefs] section
+
+
+
+ Stores information about the Preferences dialogue box itself, rather than actual preferences data. Actual preference data is stored in sections with names like [Prefs:XXX] where XXX is a preferences sub-section.
+
+
+
+ Name / Value pairs:
+
+
+
+
+ LastTab (string)
- Internal version number of currently installed program as a dotted quad.
+ Name of the tab that was open when the dialogue box was last closed. May be the empty string if the dialogue box has not yet been opened.
@@ -779,8 +808,7 @@
- Stores source code generation preferences. Used in test compilations or when
- generating user defined units.
+ Stores source code generation preferences. Used in test compilations or when generating user defined units.
@@ -789,57 +817,48 @@
- EmitWarnings (Boolean)
+ EmitWarnings (Boolean)
- Flag indicating whether directives are emitted to switch specified warnings
- on or off. True ⇒ emit directives; False ⇒ do emit directives.
+ Flag indicating whether directives are emitted to switch specified warnings on or off. True ⇒ emit directives; False ⇒ do not emit directives.
- One entry for each supported warning where XXX ranges from 0 to
- WarningCount - 1.
+ One entry for each supported warning directive, where XXX ranges from 0 to WarningCount - 1.
- Each entry contains the symbol representing a warning as used in Delphi's
- $WARN directive.
+ Each entry contains the symbol representing a warning as used in Delphi's $WARN directive.
- One entry for each supported warning where XXX ranges from 0 to
- WarningCount - 1.
+ One entry for each supported warning directive, where XXX ranges from 0 to WarningCount - 1.
- Records the earliest version of Delphi that supports the warning. This
- version number is a decimal value containing compiler version number as
- specified by Delphi's CompilerVersion constant. Must be 14.0
- (Delphi 6) or higher.
+ Records the earliest version of Delphi that supports the warning. This version number is a decimal value containing the compiler version number as specified by Delphi's CompilerVersion constant. Must be 14.0 (Delphi 6) or higher.
- One entry for each supported warning where XXX ranges from 0 to
- WarningCount - 1.
+ One entry for each supported warning directive, where XXX ranges from 0 to WarningCount - 1.
- Indicates whether the warning should be switched on or off. True ⇒
- switch on; False ⇒ switch off.
+ Indicates whether the warning should be switched on or off. True ⇒ switch on; False ⇒ switch off.
@@ -849,7 +868,7 @@
- Stores main display preferences.
+ Stores preferences for the main display.
- Code that indicates the desired start state of the overview pane treeview:
- 0 ⇒ fully expanded; 1 ⇒ fully collapsed.
+ Code that indicates the desired start state of the overview pane treeview: 0 ⇒ fully expanded; 1 ⇒ fully collapsed.
- Flag that specifies whether empty sections should be displayed in overview
- pane. True ⇒ display empty sections; False ⇒ hide empty
- sections.
+ Flag that specifies whether empty sections should be displayed in the overview pane. True ⇒ display empty sections; False ⇒ hide empty sections.
- Flag that specifies how newly created snippets and categories are displayed
- in detail pane. True ⇒ new tab created for each new item; False ⇒
- new items overwrite item in selected tab.
+ Flag that specifies how newly created snippets and categories are displayed in the detail pane. True ⇒ a new tab is created for each new item; False ⇒ new items overwrite the current item in the selected tab.
- One entry for each recorded custom colours for main database item
- headings, where XXX ranges from 0 to
- MainDBHeadingCustomColourCount - 1.
+ One entry for each recorded custom colour for main database item headings, where XXX ranges from 0 to MainDBHeadingCustomColourCount - 1.
- The value is a definition of a custom colour in the format used by the
- TColorDialog dialogue box. This format is
- ColourID=ColourNum where ColourID is a value
- from "ColorA" to "ColorP" and ColourNum is
- the hex representation of the colour.
+ The value is a definition of a custom colour in the format used by the TColorDialog dialogue box. This format is ColourID=ColourNum where ColourID is a value from ColorA to ColorP and ColourNum is the hex representation of the colour.
- One entry for each recorded custom colours for user database item
- headings, where XXX ranges from 0 to
- UserDBHeadingCustomColourCount - 1.
+ One entry for each recorded custom colour for user database item headings, where XXX ranges from 0 to UserDBHeadingCustomColourCount - 1.
- The value is a definition of a custom colour in the format used by the
- TColorDialog dialogue box. This format is
- ColourID=ColourNum where ColourID is a value
- from "ColorA" to "ColorP" and ColourNum is
- the hex representation of the colour.
+ The value is a definition of a custom colour in the format used by the TColorDialog dialogue box. This format is ColourID=ColourNum where ColourID is a value from ColorA to ColorP and ColourNum is the hex representation of the colour.
- Number of recorded custom colours for source code background in the main
- display.
+ Number of recorded custom colours for the source code background in the main display.
- One entry for each recorded custom colours for source code background in
- the main display, where XXX ranges from 0 to
- SourceCodeBGCustomColourCount - 1.
+ One entry for each recorded custom colour for the source code background in the main display, where XXX ranges from 0 to SourceCodeBGCustomColourCount - 1.
- The value is a definition of a custom colour in the format used by the
- TColorDialog dialogue box. This format is
- ColourID=ColourNum where ColourID is a value
- from "ColorA" to "ColorP" and ColourNum is
- the hex representation of the colour.
+ The value is a definition of a custom colour in the format used by the TColorDialog dialogue box. This format is ColourID=ColourNum where ColourID is a value from ColorA to ColorP and ColourNum is the hex representation of the colour.
+
+ OverviewFontSize (Integer)
+
+
+ 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.
+
+
+ DetailFontSize (Integer)
+
+
+ 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.
+
- A code that records the units of measurement used by the application: 0
- ⇒ inches; 1 ⇒ millimeters.
+ A code that records the units of measurement used by the application: 0 ⇒ inches; 1 ⇒ millimeters.
@@ -997,9 +1003,7 @@
- Stores preferences that define the properties of one or more syntax
- highlighters. Also records information about the custom colours available when
- configuring the highlighters.
+ Stores preferences that define the properties of one or more syntax highlighters. Also records information about the custom colours available when configuring the highlighters.
@@ -1008,176 +1012,125 @@
- FontSize (Integer)
+ FontSize (Integer)
- Size of current highlighter font in points.
+ Size of the current highlighter font in points.
- FontName (String)
+ FontName (String)
- Name of current highlighter font.
+ Name of the current highlighter font.
- One entry for each of the 12 source code elements recognised by the
- current syntax highlighter. XXX ranges from 0 to 11.
+ One entry for each of the 12 source code elements recognised by the current syntax highlighter. XXX ranges from 0 to 11.
- Colour of source code element. Integer representation of a Delphi
- TColor value. If the colour is not specified the value is the
- integer representation of clNone.
+ Each value is a colour of a source code element as an integer representation of a Delphi TColor value. If the colour is not specified the value is the integer representation of clNone.
- One entry for each of the 12 source code elements recognised by the
- current syntax highlighter. XXX ranges from 0 to 11.
+ One entry for each of the 12 source code elements recognised by the current syntax highlighter. XXX ranges from 0 to 11.
- Bitmask representing the font styles used for the source code element.
+ Each value is a bitmask representing the font styles used for the source code element.
- One entry for each custom syntax highlighter, where XXX ranges
- from 0 to NamedHiliterCount - 1.
+ One entry for each custom syntax highlighter, where XXX ranges from 0 to NamedHiliterCount - 1.
- Each value is the name used to identify the syntax highlighter with the
- same index. (See the various NamedHiliterXXX entries below.)
+ Each value is the name used to identify the syntax highlighter with the same index. (See the various NamedHiliterXXX entries below.)
- One entry for each custom syntax highlighter, where XXX ranges
- from 0 to NamedHiliterCount - 1.
+ One entry for each custom syntax highlighter, where XXX ranges from 0 to NamedHiliterCount - 1.
- Each value is the size of the corresponding syntax highlighter's font, in
- points.
+ Each value is the size of the corresponding syntax highlighter's font, in points.
- One entry for each custom syntax highlighter, where XXX ranges
- from 0 to NamedHiliterCount - 1.
+ One entry for each custom syntax highlighter, where XXX ranges from 0 to NamedHiliterCount - 1.
Each value is the name of the corresponding syntax highlighter's font.
- There is an entry for each source code element of each custom synax
- highliter. XXX represents the index of the corresponding syntax
- highlighter and ranges from 0 to NamedHiliterCount - 1.
- For each value of XXX there are 12
- .ElemYYY values, with YYY ranging from
- 0 to 11.
+ There is an entry for each source code element of each custom synax highliter. XXX represents the index of the corresponding syntax highlighter and ranges from 0 to NamedHiliterCount - 1. For each value of XXX there are 12 .ElemYYY values, with YYY ranging from 0 to 11.
- Each value specifies the colour of a source code element. The values are
- integer representations of a Delphi TColor value. If the colour
- is not specified the value is the integer representation of
- clNone.
+ Each value specifies the colour of a source code element as an integer representations of a Delphi TColor value. If the colour is not specified the value is the integer representation of clNone.
- There is an entry for each source code element of each custom synax
- highliter. XXX represents the index of the corresponding syntax
- highlighter and ranges from 0 to NamedHiliterCount - 1.
- For each value of XXX there are 12
- .ElemYYY values, with YYY ranging from
- 0 to 11.
+ There is an entry for each source code element of each custom synax highliter. XXX represents the index of the corresponding syntax highlighter and ranges from 0 to NamedHiliterCount - 1. For each value of XXX there are 12 .ElemYYY values, with YYY ranging from 0 to 11.
- Each value contains a bitmask representing the font style of a source code
- element.
+ Each value contains a bitmask representing the font style of a source code element.
- One entry for each recorded custom colour, where XXX ranges from
- 0 to CustomColourCount - 1.
+ One entry for each recorded custom colour, where XXX ranges from 0 to CustomColourCount - 1.
- The value is a definition of a custom colour in the format used by the
- TColorDialog dialogue box. This format is
- ColourID=ColourNum where ColourID is a value
- from "ColorA" to "ColorP" and ColourNum is
- the hex representation of the colour.
+ The value is a definition of a custom colour in the format used by the TColorDialog dialogue box. This format is ColourID=ColourNum where ColourID is a value from ColorA to ColorP and ColourNum is the hex representation of the colour.
-
- [Prefs:News] section
-
-
-
- Stores preferences that determine how items from the CodeSnip news feed are
- displayed.
-
-
-
- Name / Value pairs:
-
-
-
-
- MaxAge (Integer)
-
-
- Maximum age of a news item that can appear in CodeSnip News dialogue box in
- days. Default is 92 days.
-
- Flag that indicates whether printing is to be in colour.
+ Flag that indicates whether printing is to be in colour: True ⇒ print in colour; False ⇒ print in black and white.
- SyntaxPrint (Boolean)
+ SyntaxPrint (Boolean)
- Flag that indicates whether source code in printed output is to be syntax
- highlighted.
+ Flag that indicates whether source code in printed output is to be syntax highlighted: True ⇒ use syntax highlighting; False ⇒ do not syntax highlight.
- LeftMargin (Float)
+ LeftMargin (Float)
- Size of printed page's left margin in mm.
+ Size of a printed page's left margin in mm.
- TopMargin (Float)
+ TopMargin (Float)
- Size of printed page's top margin in mm.
+ Size of a printed page's top margin in mm.
- RightMargin (Float)
+ RightMargin (Float)
- Size of printed page's right margin in mm.
+ Size of a printed page's right margin in mm.
- BottomMargin (Float)
+ BottomMargin (Float)
- Size of printed page's bottom margin in mm.
+ Size of a printed page's bottom margin in mm.
@@ -1229,8 +1181,7 @@
- Stores preferences that describes customisations of snippet pages displayed in
- details pane.
+ Stores preferences that describes the customisation of pages displayed in the details pane for different snippet kinds.
@@ -1239,47 +1190,42 @@
- PageKindXXX (String)
+ PageKindXXX (String)
- One entry for each snippet kind where XXX is the ordinal value of
- the snippet kind.
+ One entry for each snippet kind where XXX is the ordinal value of the snippet kind.
- Each entry's value describes the structure of the details pane page that
- snippets of the kind given by the key name. The value is a comma separated
- list of zero or more names, each of which denotes a page component.
- Components are displayed in the order they are listed. Valid component
- names are:
+ Each entry's value describes the structure of the details pane page that displays snippets of the related kind. The value is a comma separated list of zero or more names, each of which denotes a page component. Components are displayed in the order they are listed. Valid component names are:
- Description
+ Description
- SourceCode
+ SourceCode
- Kind
+ Kind
- Category
+ Category
- Units
+ Units
- Depends
+ Depends
- XRefs
+ XRefs
- CompileResults
+ CompileResults
- ExtraInfo
+ ExtraInfo
@@ -1290,8 +1236,7 @@
- Stores preferences that govern the way source code is stored in exported
- documents by default.
+ Stores preferences that specify how source code is exported by default.
@@ -1300,74 +1245,43 @@
- FileType (Integer)
+ FileType (Integer)
- Code that determines type of exported files: 0 ⇒ plain text; 1 ⇒
- Pascal; 2 ⇒ HTML; 3 ⇒ rich text (RTF).
+ A code that determines type of exported files: 0 ⇒ plain text; 1 ⇒ Pascal; 2 ⇒ HTML; 3 ⇒ rich text (RTF).
- CommentStyle (Integer)
+ CommentStyle (Integer)
- Code that determines style of commenting used for documentation of snippets
- in output files: 0 ⇒ no documentation comment; 1 ⇒ description of
- snippet between prototype and body; 2 ⇒ description of snippet
- immediately precedes snippet.
+ A code that determines the style of documentation comments used for snippets in output files: 0 ⇒ no documentation comment; 1 ⇒ a description of the snippet apperars between the snippet's prototype and the body of the code; 2 ⇒ the description of the snippet immediately precedes it.
- Flag indicating whether multi-paragraph snippet descriptions are to be
- truncated to first paragraph only in snippet documentation comments.
+ Flag indicating whether multi-paragraph snippet descriptions are to be truncated to the first paragraph only in documentation comments. True ⇒ truncate the description; False ⇒ use the full description.
- Flag indicating whether source code is to be syntax highlighted.
+ Flag indicating whether source code comments are repeated in a generated unit's implementation section. True ⇒ emit comments in both the interface and implementation sections; False ⇒ emit comments in the interface section only.
-
-
-
- [Prefs:Updating] section
-
-
-
- Stores preferences relating to updating CodeSnip and the local copy of the
- online database.
-
- Specifies frequency, in days, with which CodeSnip automatically checks
- online for program updates. A value of 0 indicates that CodeSnip will not
- check for program updates automatically.
-
-
- AutoCheckDatabaseFrequency (Integer)
-
-
- Specifies frequency, in days, with which CodeSnip automatically checks
- online for database updates. A value of 0 indicates that CodeSnip will not
- check for database updates automatically.
+ Flag indicating whether source code is to be syntax highlighted. True ⇒ use syntax highlighting; False ⇒ do not syntax highlight.
- [ProxyServer] section
+ [UnitList] section
- Stores information about any proxy internet server that is to be used.
+ Records the names of the units that appear in the Units check box list on the References tab of the Edit Snippet dialoogue box.
@@ -1376,112 +1290,80 @@
- UseProxy (Boolean)
-
-
- Flag that indicates whether to use a proxy server or not. If false the
- remaining name / value pairs in this section are ignored.
-
-
- IPAddress (String)
+ Count (Integer)
- IP address of proxy server in dotted quad format, e.g. 127.0.0.1.
+ The number of units in the list.
- Port (Integer)
+ UnitXXX (String)
- Port on which to access proxy server.
-
-
- UserName (String)
-
-
- Username for proxy server access. Empty if server doesn't require a user
- name.
-
-
- Password (String)
-
-
- Encrypted form of any password required to access proxy server. Empty if no
- password is required. This value is a hex representation of the bytes of
- the encrypted password.
+ One entry for each unit, where XXX range from 0 to Count - 1.
-
- [UpdateChecks] section
-
-
- Records date of last (automatic) update checks for different items. These
- values are used to determine when to perform the next check. (Checks are made
- within a fixed interval of the preceding check).
+ Note that some "reserved" unit names that always appear in the list box are not recorded in settings. They are:
-
- Name / Value pairs:
-
-
-
-
- LastProgramCheck (Date-Time)
-
-
- Date (in GMT) that the program last checked to see if a new version of
- CodeSnip is available.
-
-
- LastDatabaseCheck (Date-Time)
-
-
- Date (in GMT) that the program last checked to see if the online version of
- the Code Snippets Database had been updated.
-
-
-
-
- [UserInfo] section
-
+
+
+ SysUtils
+
+
+ Classes
+
+
+ Windows
+
+
+ Graphics
+
+
- Stores personal information about the user.
+ If this section is missing or has no units listed then CodeSnip defaults to using the following units in addition to the "reserved" units:
+
+
+ Controls
+
+
+ Messages
+
+
+ Types
+
+
+ ShlObj
+
+
+ ShellAPI
+
+
+ ActiveX
+
+
+ Math
+
+
+
- Name / Value pairs:
+ These default unit names will be included in this section the first time it is written.
-
-
- Name (String)
-
-
- User's name.
-
-
- Email (String)
-
-
- User's email address.
-
-
-
[WindowState:XXX] sections
- There is one of these section for each window that stores its state and size
- in the config file. XXX is a sub-section placeholder and is replaced
- by a unique name representing the window whose state is stored.
+ There is one of these section for each window that stores its state and size in the config file. XXX is a sub-section placeholder and is replaced by a unique name representing the window whose state is stored.
- Some windows also store custom information in their sub-section that is not
- used in all sub-sections.
+ Some windows also store custom information in their sub-section that is unique to them. Values common to all sub-sections are described first, followed by additional details of any sub-section storing custom information.
@@ -1498,50 +1380,48 @@
- Left (Integer)
+ Left (Integer)
- Location of left side of window on screen in pixels.
+ Location of the left side of the window on screen in pixels.
- Top (Integer)
+ Top (Integer)
- Location of top of window on screen in pixels.
+ Location of the top of the window on screen in pixels.
- Width (Integer)
+ Width (Integer)
- Width of window in pixels.
+ Width of the window in pixels.
Not used for fixed size windows.
- Height (Integer)
+ Height (Integer)
- Height of window in pixels.
+ Height of the window in pixels.
Not used for fixed size windows.
- State (Integer)
+ State (Integer)
- Value of that describes state of window: 0 ⇒ normal state; 1 ⇒
- minimized; 2 ⇒ maximized.
+ Value of that describes the state of window: 0 ⇒ normal state; 1 ⇒ minimized; 2 ⇒ maximized.
- Not used for dialogue boxes and other windows that are always displayed in
- the normal state.
+ Not used for dialogue boxes and other windows that are always displayed in the normal state.
@@ -1560,17 +1440,16 @@
- SplitterPos (Integer)
+ SplitterPos (Integer)
- Position of vertical splitter control in main window, in pixels from left
- of window client area.
+ Position of the main window's vertical splitter control, in pixels from the left of the window client area.
- OverviewTab (Integer)
+ OverviewTab (Integer)
- Index of selected tab in overview pane.
+ Index of the selected tab in the overview pane.
User defined snippets can be exported from the program for importing into
- another program or for submitting to the online database. Exported data is
- stored in a single XML file.
+ another user's user database. Exported data is stored in a single XML file.
@@ -59,13 +86,20 @@
these is explained below.
+
+
+
+
Encoding
- XML export files use UTF-8 encoding without a byte order mark. XML generated
- for submission to the online database is also encoded in UTF-8.
+ XML export files use UTF-8 encoding without a byte order mark.
+
+
+
+ In earlier versions of CodeSnip, XML files generated for submission to the online database were also encoded in UTF-8. Support for code submission was removed from CodeSnip v4.16.0.
@@ -74,13 +108,17 @@
this attribute.
+
+
+
+
File Format
- There have been six different versions of the XML file format – v1 to
- v6. Tags from all six versions are explained below with notes describing
+ There have been eight different versions of the XML export file format – v1 to
+ v8. Tags used by all versions are explained below, with notes describing
which versions a tag applies to. Where there is no note the tag is valid in
all versions.
@@ -109,7 +147,7 @@
- versions 1..4: Attribute not
+ versions 1 to 4: Attribute not
provided.
@@ -140,8 +178,8 @@
version
- Identifies version of file. Determines which tags are valid and
- establishes rules concerning content. Valid versions are 1..6.
+ Identifies major version of file. Determines which tags are valid and
+ establishes rules concerning content. Valid versions are 1 to 8.
@@ -158,29 +196,56 @@
codesnip-export/user-info
- Contains information about user who created the file (omitted for normal
- exports – included for submissions to the online database).
+
+
+ versions 1 to 6: Contains information about user who created the file used for submissions to the online database, omitted for other exports.
+
+
+ version 7 and later: Not supported. Ignored if present.
+
+
codesnip-export/user-info/name
- User's name or nickname.
+
+
+ versions 1 to 6: User's name or nickname.
+
+
+ version 7 and later: Not supported. Ignored if present.
+
+
codesnip-export/user-info/email
- User's email address.
+
+
+ versions 1 to 6: User's email address.
+
+
+ version 7 and later: Not supported. Ignored if present.
+
+
codesnip-export/user-info/comments
- Any comments provided by user.
+
+
+ versions 1 to 6: Any comments provided by user.
+
+
+ version 7 and later: Not supported. Ignored if present.
+
+
@@ -208,7 +273,7 @@
- versions 1..4: Name must begin with
+ versions 1 to 4: Name must begin with
an English language letter or the underscore.
@@ -230,12 +295,20 @@
- versions 1..5: Content is a single line
+ versions 1 to 5: Content is a single line
of plain text.
- version 6: Content is formatted text
- encoded in REML markup. REML v3 is supported.
+ version 6 to 7.2: Content is formatted text
+ encoded in REML markup. REML v4 is supported.
+
+
+ version 7.3 and 7.4: Content is formatted text
+ encoded in REML markup. REML v5 is supported.
+
+
+ version 7.5 and later: Content is formatted text
+ encoded in REML markup. REML v6 is supported.
@@ -253,11 +326,11 @@
- versions 1..5: Not supported.
+ versions 1 to 5: Not supported.
- versions 1..5: Not supported.
+ versions 1 to 5: Not supported.
- version 6: Display name of snippet. Can
+ version 6 and later: Display name of snippet. Can
contain any characters and need not be unique. Present only if snippet
has a display name that is different to the value of the name
- attribute of the codesnip-data/routines/routine tag.
+ attribute of the codesnip-export/routines/routine tag.
@@ -369,14 +442,22 @@
- version 2: indicates REML v1
+ version 2: supports REML v1.
+
+
+ version 3: supports REML v2.
+
+
+ version 4: supports REML v3.
+
+
+ versions 5 to 7.2: supports REML v4.
- version 3: indicates REML v2
+ version 7.3 & 7.4: supports REML v5.
- versions 4 and 5: indicates REML
- v3.
+ version 7.5 & later: supports REML v6.
- d2005 – Delphi 2005 compiler
+ dXE3 – Delphi XE3 compiler (v4.4 to v4.5 and v6.1 & later)
- d2006 – Delphi 2006 compiler
+ dXE4 – Delphi XE4 compiler (v4.5 only)
+ Note: CodeSnip 3 used correct dXE4 id, but CodeSnip 4 did not (see dDX4 below).
- d2007 – Delphi 2007 compiler
+ dDX4 – Delphi XE4 compiler (v6.2 & later)
+ Note: CodeSnip 4 dDX4 in error instead of dXE4 used by CodeSnip 3 (see above). The erroneous value was retained for backwards compatibility reasons.
- dDX4 – Delphi XE4 compiler. Note:
- This value was named dDX4 in error: it should have been
- named dXE4 but the erroneous value has been retained for
- backwards compatibility reasons.
+ d101b – Delphi 10.1 Berlin compiler (v6.8 & later)
- Name of a snippet within cross-reference list.
-
-
-
- versions 1..4: Name must begin with an
- English language letter or the underscore.
-
-
- version 5 and later: Name can begin with
- any character that is valid as the first character of a Unicode Pascal
- identifier.
-
-
-
-
+
+
+
+ Erratum
+
+
+
+ The codesnip-export/routines/routine/xref and codesnip-export/routines/routine/xref/pascal-name tags were included in versions 1 to 7 of this specification in error. XRefs were never intended to be written to export files by any version of CodeSnip, as source code comments make clear.
+
+
+
+ These tags have been removed from this document entirely of specification version 8.
+
+
+
+
+
- Differences Between File Versions
+ Change Log
- The differences between different export file versions is summarised below:
+ This section describes the changes between versions of the file format.
+
+
+
+ There were small changes within versions, that probably should have been given minor version numbers - but weren't. Such minor numbers have been assigned retrospectively below, in order to better explain when in-version changes actually took place.
+
+
+
+ File formats v4 and v5/v6 actually overlapped in the dates they were in use. This is because v4 was used by CodeSnip v3 and v5/v6 were used by CodeSnip 4. Those two versions of CodeSnip were maintained in parallel for a while.
- Version 1
+ Version 1 - 15 December 2008
- First version of database.
+
+ Introduced in CodeSnip v2.2
+
+
+ First version of export file format.
+
+
+ Supported Delphi compilers from Delphi 2 to Delphi 2009 plus Free Pascal.
+
+
+ REML not supported.
+
+
+ The XML file was in UTF-8 format with no BOM and no XML encoding attribute.
+
+ The version of REML supported by the
+ codesnip-export/routines/routine/extra tag was v1.
+
+
- Version 3
+ Version 3 - 29 June 2009
-
- The following tag is no longer supported:
-
+
+ Introduced with CodeSnip v3.0.
+
+
+ The following tag was removed:
+
codesnip-export/routines/routine/standard-format
-
+
The following tag was introduced:
-
+
codesnip-export/routines/routine/kind
-
+
The version of REML supported by the
codesnip-export/routines/routine/extra tag was updated to v2.
-
+
+
- Version 4
+ Version 4 - 06 July 2009
- The version of REML supported by the
- codesnip-export/routines/routine/extra tag was updated to v3.
+
+ Introduced with CodeSnip v3.0.1.
+
+
+ The version of REML supported by the
+ codesnip-export/routines/routine/extra tag was updated to v3.
+
+
+
+ Version 4.1 - 24 September 2009
+
+
+ Updated with CodeSnip v3.4 to add support for Delphi 2010.
+
+
+ Version 4.2 - 23 October 2010
+
+
+ Updated with CodeSnip v3.8.0 to add support for Delphi XE.
+
+
+ Version 4.3 - 07 September 2011
+
+
+ Updated with CodeSnip v3.9.0 to add support for Delphi XE2.
+
+
+ Version 4.4 - 17 September 2012
+
+
+ Updated with CodeSnip v3.11.0 to add support for Delphi XE3.
+
+
+ Version 4.5 - 02 May 2013
+
+
+ Updated with CodeSnip v3.12.0 to add support for Delphi XE4.
+
+
+
- Version 5
+ Version 5 - 31 December 2011
-
+
+ Introduced with CodeSnip v4.0 alpha 1.
+
+
The XML file's encoding was explicitly set to "UTF-8" by setting
the encoding attribute of the XML processing instruction to this value.
-
-
+
+
Snippet names, wherever they occur in the XML file, can now begin with
any character that is a valid first character of a Unicode Pascal
identifier. Previously the first character of the attribute had to be one
of 'A'..'Z', 'a'..'z' or '_'.
-
-
+
+
New "class" and "unit" snippet kinds supported.
-
+
+
+ The version of REML supported by the
+ codesnip-export/routines/routine/extra tag was updated to v4.
+
+
- Version 6
+ Version 6 - 11 August 2012
-
- A snippet's description is now stored as formatted text using REML markup.
- Previously the description was plain text.
-
-
+
+ Introduced with CodeSnip v4.0 beta 1.
+
+
+ A snippet's description is now stored as formatted text using REML v4 markup. Previously the description was plain text.
+
+ Updated with CodeSnip v4.0 RC 1 to add support for Delphi XE3.
+
+
+ Version 6.2 - 02 May 2013
+
+
+ Updated with CodeSnip v4.5.0 to add support for Delphi XE4.
+
+
+ Version 6.3 - 12 September 2013
+
+
+ Updated with CodeSnip v4.8.0 to add support for Delphi XE5.
+
+
+ Version 6.4 - 30 April 2014
+
+
+ Updated with CodeSnip v4.9.0 to add support for Delphi XE6.
+
+
+ Version 6.5 - 12 September 2014
+
+
+ Updated with CodeSnip v4.10.0 to add support for Delphi XE7.
+
+
+ Version 6.6 - 06 May 2015
+
+
+ Updated with CodeSnip v4.12.0 to add support for Delphi XE8.
+
+
+ Version 6.7 - 05 September 2015
+
+
+ Updated with CodeSnip v4.13.0 to add support for Delphi 10 Seattle.
+
+
+ Version 6.8 - 13 July 2016
+
+
+ Updated with CodeSnip v4.15.0 to add support for Delphi 10.1 Berlin.
+
+
+
+
+
+ Version 7 - 31 May 2020
+
+
+
+ Introduced with CodeSnip v4.16.0.
+
+
+ The codesnip-export/user-info tag and sub-tags were no longer supported.
+
+
+
+ Version 7.1 - 31 July 2020
+
+
+ Updated with CodeSnip v4.17.0 to add support for Delphi 10.2 Tokyo, Delphi 10.3 Rio and Delphi 10.4 Sydney.
+
+
+ Version 7.2 - 13 September 2021
+
+
+ Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
+
+
+ Version 7.3 - 16 December 2022
+
+
+ Updated with CodeSnip v4.21.0 to add support for REML v5, which is backward compatible with REML v4.
+
+
+ Version 7.4 - 7 November 2023
+
+
+ Updated in time for CodeSnip v4.22.0 to add support for Delphi 12 Athens.
+
+
+ Version 7.5 - 2 April 2014
+
+
+ Added support for REML v6, which is backward compatible with REML v4.
+
+
+
+
+
+ Version 8 - 15 April 2025
+
+
+
+ Introduced with CodeSnip v4.24.3.
+
+
+ The codesnip-export/routines/routine/xref and codesnip-export/routines/routine/xref/pascal-name tags were removed from the specification. See Erratum above for details.
+
-
- Notes For File Readers Used For Importing
-
+
+
+
+
+
+ Notes For File Readers
+
Readers of v1 files must convert the contents of the
- codesnip-data/routines/routine/comments,
- codesnip-data/routines/routine/credits and
- codesnip-data/routines/routine/credits-url tags into formatted text
+ codesnip-export/routines/routine/comments,
+ codesnip-export/routines/routine/credits and
+ codesnip-export/routines/routine/credits-url tags into formatted text
that simulates the parsed content of a
- codesnip-data/routines/routine/extra tag.
+ codesnip-export/routines/routine/extra tag.
Readers of v1 and v2 files should map a
- codesnip-data/routines/routine/standard-format value of "0"
- to a codesnip-data/routines/routine/kind value of
+ codesnip-export/routines/routine/standard-format value of "0"
+ to a codesnip-export/routines/routine/kind value of
"freeform" and a value of "1" to "routine".
Readers of v1 to v5 files must:
-
+
+
Convert the plain text snippet description read from
- codesnip-data/routines/routine/description into the formatted text
+ codesnip-export/routines/routine/description into the formatted text
equivalent of a single paragraph containing the description.
@@ -766,6 +1053,20 @@
+
+ Readers of v1 to v6 files must ignore the codesnip-export/user-info tag and sub-tags, where present.
+
+
+
+ Readers of v2 files and later can parse REML as v6, since all versions of REML up to v6 are backwards compatible.
+
+
+
+ Readers of v1 to v7 files must ignore any codesnip-export/routines/routine/xref tags and sub tags in the unlikely event that they are found. For an explanation see Erratum above.
+
- This documentation describes the various file formats used by CodeSnip. It
- also includes the format of some streams downloaded from or uploaded to web
- services.
+ This documentation describes the various file formats used by CodeSnip.
- The Database Update Data Stream is a stream of data received from the CodeSnip
- Database Update web service that is used to update the local copy of the main
- database.
-
-
-
- The stream is plain text and consists of a concatenation of text files from
- the online database along with some housekeeping information. The text files
- are recreated in the main database directory.
-
-
-
- Encoding
-
-
-
- The data stream is received from the web server as single- or multi-byte ANSI
- encoded text. The encoding must be such that characters from the ASCII
- character set occupy one byte each. Therefore encodings that use two bytes for
- such characters, such as UTF-16, cannot be used.
-
-
-
- The actual encoding used is determined by the web server should be specified
- in HTTP header. If the HTTP headers do not specify the encoding then
- ISO-8859-1 is assumed.
-
-
-
- The encoding used for the files recreated in the main database directory is
- UTF-8 with byte order mark.
-
-
-
- Data is converted between several formats on its journey from the web server
- to the final database file. See the appendix for
- details.
-
-
-
- Stream Format
-
-
-
- The stream contains structured plain text comprising both numeric and string
- information. Variable length strings are preceded by numeric values that
- indicate the length of the following string in bytes. Numeric values are
- encoded as hexadecimal characters. The format is as follows:
-
-
-
-
- FileCount
-
-
- Number of files encoded in the data stream. 16 bit integer encoded as four
- hex digits. Maximum number of files is 32,767.
-
-
-
-
- Followed by FileCount file records of:
-
-
-
-
- Name
-
-
- Name of file without path information. AnsiString preceded by its size in
- bytes as a 16 bit integer encoded as four hex digits.
-
-
- UnixDate
-
-
- File's modification date (GMT) in Unix format. Int64 encoded as 16 hex
- digits.
-
-
- Content
-
-
-
- File contents.
-
-
- For web service version 5 this is an AnsiString preceded by its
- size in bytes as a 16 bit integer encoded as four hex digits. File size is
- limited to 32kB.
-
-
- For web service version 6 this is an AnsiString preceded by its
- size in bytes as a 32 bit integer encoded as eight hex digits. File size
- limit is raised to 2 Gb.
-
-
-
-
-
- Appendix: Description of Data Encoding Conversions
-
-
-
- The following flowchart show the various encodings used for downloaded data on
- its journey from web server to main database file.
-
-
-
-
-
- Text sent from web server using a single or multi-byte ANSI encoding.
- Encoding used sent in HTTP header.
-
-
-
- ↓
-
-
-
- ANSI text stream
-
-
-
- ↓
-
-
-
- CodeSnip's HTTP handling code automatically converts ANSI text stream into
- Unicode string using encoding specified in HTTP header.
-
-
-
- ↓
-
-
-
- Unicode string
-
-
-
- ↓
-
-
-
- Database download manager code converts Unicode string back into ANSI text
- stream with same encoding in which it was sent from web server.
-
-
-
- ↓
-
-
-
- ANSI text stream
-
-
-
- ↓
-
-
-
- File updater interprets information stored in formatted ANSI text stream and
- get contents of each file, converting them to Unicode.
-
-
-
- ↓
-
-
-
- Unicode string
-
-
-
- ↓
-
-
-
- File writer finally writes each file as UTF-8 with a BOM.
-
+ The are two versions of the Code Snippets Database: v1 and v2. Both versions are similar and both are described here. Where one version differs from another the differences will be noted. Where there is no such note there is no difference between the versions.
+
+
- The Code Snippets database is stored in a set of .ini files with associated
- data files located in the main database directory. Two subsidiary text files
- containing credits are also included.
+ The database is organised as a set of categories, each of which contains one or more code snippets.
- The master data file is named categories.ini. This lists the
- database categories. There is another .ini file for each category which stores
- information about all the snippets in the category.
+ Meta data describing the categories and snippets is stored in a set of .ini files. In addition there are numerous .dat files, each of which contains the source code of a snippet.
- The source code for each snippet is stored in separate data files – one
- or more per snippet. This snippet file is referenced in the relevant category
- .ini file.
+ There are additional files containing further information.
- The credits text files contain lists of names.
+ All the files are plain text, encoded in UTF-8 format with UTF-8 preamble (BOM).
Encoding
+
+ Version 1
+
+
- CodeSnip v4 stores all main database files, including the subsidiary text
- files, using UTF-8 encoding. Files are saved with the UTF-8 preamble (BOM).
+ With CodeSnip v4 all the files are plain text, encoded in UTF-8 format with UTF-8 preamble (BOM). Prior to CodeSnip v4 local database files were encoded using the system default ANSI code page.
- Prior to CodeSnip v4 local database files were encoded using the system
- default ANSI code page.
+ CodeSnip v4 must be able to work with both encodings because it may need to use a database installed by CodeSnip v3 or earlier.
+
+ Version 2
+
+
- CodeSnip v4 must be able to work with both encodings because it may inherit or
- have to use a database downloaded by a v3 or earlier version of the program.
+ All the files are plain text, encoded in UTF-8 format with UTF-8 preamble (BOM).
@@ -94,33 +94,71 @@
- Master Data File
+ Meta Data Files
- This file has a simple format. Each section is named after a category id, i.e.
- the id by which the category is referred to in the database. Each section of
- the .ini file has a value containing the description of the category and
- another that names the category's .ini file. Here is the format of a
- section:
+ There are two kinds of meta data files:
+
+
+
+
+ categories.ini lists the categories contained in the collection.
+
+
+ A set of further .ini files, one for each category specified in categories.ini. Each of these files contains numerous details of each snippet along with the name of the file containing the source code.
+
+
+
+
+ Format Of categories.ini
+
+
+
+ Each section in this file defines a category and has the following format:
- and here is an example (this is a copy of the "Date and Time"
- category's entry):
+ The sections in these files are named with a unique identifier that identifies a category within the collection. The section names must be alphanumeric characters. The values have the following purpose:
+
+
+
+
+
+ Desc
+
+
+
+ A brief, human readable, description of the category. Any valid UTF-8 text is permitted.
+
+
+
+
+ Ini
+
+
+
+ The name of the .ini file that contains information about each snippet in the category. Must be a valid file name, without path. The files must be stored in the same directory as category.ini.
+
+
+
+
+
+
+ Here is an example (this is a copy of the "Date and Time" category's entry):
[date]
Desc=Date and Time
Ini=date.ini
-
- Category ini files
-
+
+ Format Of Individual Category .ini Files
+
Each section in these files defines a snippet and has the following content:
@@ -157,6 +195,11 @@
- The sections in these files are named with a unique name that identifies a
- snippet. This must be a valid Unicode Pascal identifier. The values have the
- following purpose:
+ The sections in these files are named with identifiers that uniquely identify a snippet. This must be a valid Unicode Pascal identifier. The keys in a section have the following purpose:
-
+
+
- DisplayName
+ DisplayName
-
- Display name of snippet. If present this value is used in the program GUI
- as the snippet's name. The value is optional. If not present the name of
- the section is used as the display name. There are no restriction on the
- characters used.
-
-
- Supported from CodeSnip v4.0 beta 1 and ignored by earlier versions which
- always use the section name as display name.
-
+
+ Human readable name of snippet. The value is optional. If not present then the snippet identifier that names the section is used as the human readable name.
+
+
+
+ v1: There are no restriction on the characters used.
+
+
+ v2: May be any valid UTF-8 string of up to 64 characters.
+
+
+
- Desc
+ Desc
- Description of the snippet as plain text. Ignored by versions of CodeSnip
- that recognise DescEx if that field is present.
+
+ Description of the snippet as plain text. Ignored if a non-empty DescEx key is present.
+
+
- DescEx
+ DescEx
-
- Formatted description of the snippet using REML code. May be empty, in which case the Desc field
- is used. The Desc field is ignored if DescEx has a
- value.
-
-
- Supported from CodeSnip v4.0 beta 1.
-
+
+ Formatted description of the snippet using REML1 code. May be empty, in which case the Desc key is used. Desc is ignored if DescEx has a non-empty value.
+
+
- Snip
+ Snip
- Name of file containing source code. Contains no file path information.
+
+ Name of the file containing this snippet's source code. The file name must:
+
+
+
+ be a valid file name;
+
+
+ contain no path information;
+
+
+ exist in the same directory as the .ini file;
+
+
+ be unique within the directory.
+
+
+
- Units
+ Units
- Comma separated list of units required by the snippet. May be empty if no
- units are required. The System unit is assumed and does not need to be
- specified.
+
+ Comma separated list of units required to compile the snippet. May be omitted or empty if no units are required. The System unit is assumed and does not need to be specified. Unit names must be valid Pascal identifiers.
+
+
- Depends
+ Depends
- Comma separated list of snippets that are required to compile this snippet.
- May be empty if there are no dependencies. Must not cause a circular
- reference back to this snippet.
+
+ Comma separated list of the identifiers of snippets that are required to compile this snippet. May be omitted or empty if there are no such dependencies. Snippet identifiers must exist within the collection and must not cause a circular reference back to this snippet.
+
+
- SeeAlso
+ SeeAlso
- Comma separated list of cross-referenced snippets. May be empty.
+
+ Comma separated list of the identifiers of cross-referenced snippets. May be omitted or empty. Snippet identifiers should exist in the collection.
+
- Text string that notes any credits / acknowledgements. May be empty.
-
-
- Credits may optionally contain one (and only one) section of text
- delimited by "[" and "]" characters that indicate the
- presence of a hyperlink. The text enclosed by "[" and
- "]" is used for the text of the hyperlink. If present the
- Credits_URL field must contain the URL of the hyperlink.
-
-
- Credits is ignored by versions of CodeSnip that recognise the
- Extra field unless the Extra field is empty.
-
+
+ Text string that notes any credits / acknowledgements. May be omitted or empty. Credits may optionally contain one (and only one) section of text delimited by [ and ] characters that indicate the presence of a hyperlink. The enclosed text is used as the text of a hyperlink whose URL must be specified in the Credits_URL key.
+
+
+ Credits is ignored if a non-empty Extra key is present.
+
- "Y" – compiles on the compiler
+ Y – compiles on the compiler
- "N" – does not compile on the compiler
+ N – does not compile on the compiler
- "W" – compiles with warnings on the compiler
+ W – compiles with warnings on the compiler
- "Q" – compilation result unknown
+ Q – compilation result unknown
-
- If not present, the compile result is assumed to be "Q"
-
-
- From CodeSnip v3.8.9 a compile result of "W" is treated as if it
- were "Y".
-
-
+
+ If any of the above compilers is not present, the compile result is assumed to be Q. A compile result of W is obsolete and treated as if it were Y.
+
+
Any compiler not recognised by a given version of CodeSnip is ignored.
-
- Provides extra information about the snippet. Can be empty or be a string
- of REML code.
-
-
- If empty the extra information is generated from any Comments and
- Credits / Credits_URL values.
-
-
- This value was supported from CodeSnip v2.2.5.
-
+
+ Optional. Provides extra information about the snippet. When present the value must be a valid string of REML1 code.
+
+
+ If omitted the extra information is generated from the values of any Comments, Credits and Credits_URL keys.
+
+
+ When Extra has a non-empty value the Comments, Credits and Credits_URL keys are ignored.
+
+
- StandardFormat
+ StandardFormat
-
- Flag indicating if a snippet is in "standard format". Valid
- values are:
-
+
+
+
+ v1: Flag indicating if a snippet is in "standard format". Valid values are:
+
+
+
+ 0 – no.
+
+
+ 1 – yes.
+
+
+
+ Ignored if the Kind key is present.
+
+
+
+ v2: not supported.
+
+
+
+
+
+ Kind
+
+
+
+ The kind (or type) of this code snippet. Valid values are:
+
- "0" – no
+ freeform – a freeform snippet that doesn't conform to any other other supported type.
- "1" – yes.
+ routine – a Pascal routine (function or procedure).
-
-
- If not present then StandardFormat = "1" is assumed.
-
-
- This value was supported from CodeSnip v2.0.
-
-
- From CodeSnip v3.0 StandardFormat is ignored if the Kind
- value is present. If Kind is not present then
- StandardFormat = "0" is read as Kind =
- "freeform" and StandardFormat = "1" is read
- as Kind = "routine".
-
-
-
- Kind
-
-
-
- Kind of code snippet. Valid values are:
-
-
- "freeform" – a freeform snippet that doesn't conform to
- any type other supported type
+ type – a simple Pascal type definition.
- "routine" – a Pascal routine (function or procedure)
+ const – a Pascal constant definition.
- "type" – a simple Pascal type definition
+ class – a Pascal class or advanced record definition and implementation.
- "const" – a Pascal constant definition
+ unit – a complete Pascal unit.
+
+
+ If Kind is omitted or has no value then:
+
+
- "class" – a Pascal class or advanced record definition
- and implementation.
+ v1: If the StandardFormat key has value 0 then Kind defaults to freeform. If StandardFormat has value 1 or is not present then Kind defaults to routine.
- "unit" – a complete Pascal unit
+ v2: If Kind is not present then its value defaults to freeform.
-
- If Kind is not present and StandardFormat is then
- StandardFormat = "1" implies Kind =
- "routine" and StandardFormat = "0" implies
- Kind = "freeform". If neither Kind nor
- StandardFormat are present then Kind defaults to
- "routine".
-
-
- This value was supported from CodeSnip v3.0.
-
+
- TestInfo
+ TestInfo
-
- Testing information for snippets. Valid values are:
-
+
+ Testing information for the snippet. Valid values are:
+
- "none" – the snippet has not been tested
+ none – the snippet has not been tested.
- "basic" – the snippet has passed some simple testing
+ basic – the snippet has passed some simple testing.
- "advanced" – the snippet has passed more advanced
- testing, usually unit tests
+ advanced – the snippet has passed more advanced testing, usually unit tests.
-
- If TestInfo is not present then its value defaults to
- "basic". This is because, until the release of CodeSnip v4.0,
- all snippets had undergone at least basic testing.
-
-
- This value was supported from CodeSnip v4.0.
-
+
+ If TestInfo is not present then its value defaults to basic.
+
+
- MinVer
+ MinVer
-
- Ignored.
-
-
- This value was used by a now defunct version of the online Code Snippets
- Database, but is no longer used.
-
+
+ Redundant key left over from an earlier, and now unsupported version of CodeSnip.
+
+
+
+ v1: Ignored.
+
+
+ v2: Not supported.
+
+
+
- Each value should occur only once. If more than one value of the same type is
- present the result is not defined and may change between program versions.
+ Each key should occur only once. If more than one value of the same type is present the result is not defined and may change between program versions.
+
+
+
+ This file format is quite messy, with several keys having similar or overlapping purposes. This has happened because new features have been added over time while preserving backward compatibility.
Pre-processor directives
+
+ Pre-processor directives are supported only in v1 of the database.
+
+
- A simple pre-processor was added to CodeSnip v3 and later that can process
- special pre-processor instructions contained in .ini files. The pre-processor
- symbols are ignored by CodeSnip versions earlier than v3. These symbols allow
- the program's version number to be tested and different parts of the file to
- be read or ignored accordingly.
+ A simple pre-processor was added to CodeSnip v3 and later that can process special pre-processor instructions contained in .ini files. The pre-processor symbols ignored by CodeSnip versions earlier than v3. These symbols allow the program's version number to be tested and different parts of the file to be read or ignored accordingly.
- Pre-processor instructions all begin with ";", the .ini file comment
- character, followed by a "#" and then the instruction name. Valid
- instructions are:
+ Pre-processor instructions all begin with ;, the .ini file comment character, followed by a # and then the instruction name. Valid instructions are:
-
+
+
- if-ver-eq <version>
+ if-ver-eq <version>
Checks if application version is equal to <version>.
+
- if-ver-neq <version>
+ if-ver-neq <version>
- Checks if application version is not equal to <version>.
+ Checks if the application version is not equal to <version>.
+
- if-ver-lt <version>
+ if-ver-lt <version>
- Checks if application version is less than <version>.
+ Checks if the application version is less than <version>.
+
- if-ver-lte <version>
+ if-ver-lte <version>
- Checks if application version is less than or equal to
- <version>. †
+ Checks if the application version is less than or equal to
+ <version>.3
+
- if-ver-gt <version>
+ if-ver-gt <version>
- Checks if application version is greater than <version>.
+ Checks if the application version is greater than <version>.
+
- if-ver-gte <version>
+ if-ver-gte <version>
- Checks if application version is greater than or equal to
- <version>. †
+ Checks if the application version is greater than or equal to
+ <version>.3
- Checks if application version is in the range of versions specified from
+ Checks if the application version is in the range of versions specified from
<version-lo> to <version-hi>, inclusive.
+
- end-if
+ end-if
- Ends a block started by any of the if-xxx instructions above. The block of
- text is only evaluated if the if-xxx instruction evaluates true.
+ Ends a block started by any of the if-xxx instructions above. The block of text is only evaluated if the if-xxx instruction evaluates true.
+
- † Due to a bug going back to CodeSnip v3.0 if-ver-gte
- and if-ver-lte have never worked correctly: they have always been
- interpreted as if-ver-gt and if-ver-lt respectively. A fix
- to this could now cause more problems than it solves in older version of
- CodeSnip, so the implementation of the problematic directives has
- been removed from later versions of the program and all occurrences of the
- directives in the database have been replaced by suitable
- if-ver-inrange directives.
+ In all cases version numbers are dotted quads of the form X.X.X.X where X is a sequence of digits. All except the first digit can be left out: omitted digits are assumed to be zero, so that 1.0.0.0, 1.0.0, 1.0 and 1 are all equivalent.
- In all cases version numbers are dotted quads of the form X.X.X.X where X is
- a sequence of digits. All except the first digit can be left out: omitted
- digits are assumed to be zero, so that 1.0.0.0, 1.0.0, 1.0 and 1 are all
- equivalent.
+ if-ver-lt 3 can be used to ignore a whole snippet definition in a normal .ini file, leaving the possibility of having a duplicate definition for CodeSnip v3 or later stored in a matching .3.ini file. E.g.:
-
- if-ver-lt 3 can be used to ignore a whole snippet definition in a
- normal .ini file, leaving the possibility of having a duplicate definition for
- CodeSnip v3 or later stored in a matching .3.ini file. E.g.
-
[Snippet1]
+ Desc="My second description"
+ Snip=044.3.dat
+ ...
-
[Snippet1]
-Desc="My second description"
-Snip=044.3.dat
-...
+
- Additional .ini Files For CodeSnip v3 and v4
+ Additional .ini Files For CodeSnip v3 and v4
+
+ Additional .ini files are supported only in v1 of the database.
+
+
- From CodeSnip v3 additional .ini files with .3 interposed between the file
- name and extension are supported (e.g. category.3.ini and
- date.3.ini are valid names).
+ From CodeSnip v3 additional .ini files with .3 interposed between the file name and extension are supported (e.g. category.3.ini and date.3.ini are valid names).
- From v4 similar files using the interposed .4 extension are supported in
- addition to the .3 files (e.g winsys.4.ini).
+ From CodeSnip v4 similar files using the interposed .4 extension are supported in addition to the .3 files (e.g winsys.4.ini).
- CodeSnip concatenates all .ini files with the same base name before analysing
- the file. For example if date.ini, date.3.ini and
- date.4.ini all exist then date.3.ini and
- date.4.ini are appended to date.ini before the files
- are analysed.
+ CodeSnip concatenates all .ini files with the same base name before analysing the file. For example if date.ini, date.3.ini and date.4.ini all exist then date.3.ini and date.4.ini are appended to date.ini before the files are analysed.
- The .3 "inner" extension was provided for category files so that
- constant and type definition snippets could be hidden from CodeSnip versions
- below v3 but be visible to CodeSnip v3 and later. The new style constant and
- type definition snippets are only recorded in .3 style files.
+ The .3 "inner" extension was provided for category files so that constant and type definition snippets could be hidden from CodeSnip versions below v3 but be visible to CodeSnip v3 and later. The new style constant and type definition snippets are only recorded in .3 style files.
@@ -670,57 +729,237 @@
- .4 "inner" extensions are there to support any CodeSnip v4 specific
- features that can't be hidden from earlier versions.
+ .4 "inner" extensions are there to support any CodeSnip v4 specific features that can't be hidden from earlier versions.
- Finally, it is possible that a name.3.ini or
- name.4.ini file will exist with no matching
- name.ini. In this case categories.ini (or
- categories.3.ini) must still refer to name.ini, not
- name.3.ini or name.4.ini. The program works out
- which files to load.
+ Finally, it is possible that a name.3.ini or name.4.ini file will exist with no matching name.ini. In this case categories.ini (or categories.3.ini) must still refer to name.ini, not name.3.ini or name.4.ini. The program works out which files to load.
+
Source Code Files
- Source code is stored separately from the category .ini files. Each snippet
- has its own uniquely named file. Files can have any name providing it doesn't
- clash with the master file name or the names of the category files. By
- convention, source code files are named numerically in sequence and have a
- .dat file extension. So 102.dat is a typical source code file
- name. Sometimes there is a separate file for later versions of CodeSnip, so
- an occasional file named, for example, 102.3.dat may be found.
+ There is a separate source code file for each snippet. These file names must be named exactly as specified in the related category .ini file's Snip key. They are usually numbered from 001 and have a .dat extension, but this is not a requirement.
+
+
+
+ For example 102.dat is a typical source code file name.
- Source code files are referenced by the Snip field in category .ini
- files.
+ v1 only: Sometimes there is a separate file for later versions of CodeSnip, so an occasional file named, for example, 102.3.dat may be found.
- Subsidiary "Credits" Text Files
+ Credits Files
- There are two credits files, contrib.txt and
- testers.txt that list the people who have contributed code to the
- main database or helped to test the code, respectively.
+ There are two credits files that list the people who have contributed code to the database or helped to test the code, respectively.
+
+
+
+ The files are named, respectively:
+
+
+
+
+ v1:contrib.txt and testers.txt.
+
+
+ v2:CONTRIBUTORS and TESTERS.
+
+
+
+
+ Each file is simply a list of names, in plain text format, with each name on a separate line. No blank lines are permitted.
- Each file is simply a list of names, each name on a separate line.
+ The files may be empty if there are no contributors and/or testers, but they must be present.
- The credits files stand alone from the other files in the database in that
- they are not referenced by, and do not reference, any of the other files.
+ The credits files are not referenced by, and do not reference, any of the other files in the database.
+
+
+
+ License Files
+
+
+
+ License files are supported only in v2 of the database.
+
+ There are two files relating to license (and copyright) information: the full text of the license in human readable format and a file providing machine readable meta data about the license and copyright.
+
+
+
+ Full License Text
+
+
+
+ This is a plain UTF-8 text file named LICENSE that contains the license that applies to the source code in the collection.
+
+
+ This file must be present and non-empty.
+
+
+ The LICENSE file is not referenced by, and does not reference, any of the other files in the collection.
+
+
+
+ License Meta Information
+
+
+
+ A file named LICENSE-INFO is provided that contains information about the license in machine readable form. Information is in Key=Value format as follows:
+
+ The name of the license as plain text. E.g. MIT License or Mozilla Public License 2.0.
+
+
+
+
+ LicenseSPDX
+
+
+
+ The Open Source Initiative (OSI) SPDX short identifier of the license, if any. E.g. MIT or MPL-2.0. If the license does not have a SPDX identifier this key must either be omitted or be empty.
+
+ The URL of an online copy of the license. E.g. https://opensource.org/licenses/MIT. If the license has no URL then this key must be omitted or be empty.
+
+
+
+
+ CopyrightDate
+
+
+
+ The date of the copyright or range of copyright dates as plain text. E.g. 2020 or 2005-2020.
+
+
+
+
+ CopyrightHolder
+
+
+
+ The name of the copyright holder as plain text. Where there are contributors either list them all or append and contributors4 to the primary copyright holder's name. E.g. Joe Bloggs or Annie Smith, Joe Bloggs and Jessie Sharp or Annie Smith and Contributors.
+
+
+
+
+ CopyrightHolderURL
+
+
+
+ The URL of a web page where details of the copyright holder(s) or primary copyright holder can be found. E.g. https://example.com/joe-blogs-bio. This key is optional.
+
+
+
+
+
+
+ The LICENSE-INFO file is not referenced by, and does not reference, any of the other files in the collection.
+
+
+
+ Version Information File
+
+
+
+ The version information file is supported only in v2 of the database.
+
+
+
+ There is a plain UTF-8 text file named VERSION that contains the version number of the database in the form vX.X.X. where X represents a non-negative integer. The file is required and must be non-empty.
+
+
+
+ Version numbers must be incremented according to to the principles of semantic versioning.
+
+ The VERSION file is not referenced by, and does not reference, any of the other files in the collection.
+
+
+
+ Footnotes
+
+
+
+
+
+ REML is a text markup language used to format text. REML version 6 is supported. The REML format is documented here.
+
+
+
+
+ Here is an example of how the Credits and Credits_URL key work together.
+
+
+ If Credits="See [example]" and Credits_URL="https://example.com" and the Extra key is empty or missing then the extra text generated will be See <a href="example.com">example 1</a>.
+
+
+
+
+ Due to a bug going back to CodeSnip v3.0 if-ver-gte and if-ver-lte have never worked correctly: they have always been interpreted as if-ver-gt and if-ver-lt respectively.
+
+
+ A fix to this could now cause more problems than it solves in older version of CodeSnip, so the implementation of the problematic directives has been removed from later versions of the program and all occurrences of the directives in the database have been replaced by suitable if-ver-inrange directives.
+
+
+
+
+ If "contributors" is specified as part of the CopyrightHolder key value in LICENSE-INFO then the CONTRIBUTORS file must contain a list of all the contributors.
+
+
+
+
+ Version tracking was not done before v2.0.0. However it is safe to assume, using semantic versioning, that the current format is the second major release. This is because all previous database versions were backwards compatible and therefore all belonged to the same major version, which, logically, must have been v1. The fact that this version of the database breaks that backward compatibility means the major version must be bumped.
+
+
+
+
+
diff --git a/Docs/Design/FileFormats/main.css b/Docs/Design/FileFormats/main.css
index 946ec8b04..fcbdefa1b 100644
--- a/Docs/Design/FileFormats/main.css
+++ b/Docs/Design/FileFormats/main.css
@@ -1,12 +1,9 @@
/*
* 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 http://mozilla.org/MPL/2.0/
+ * obtain one at https://mozilla.org/MPL/2.0/
*
- * Copyright (C) 2012, Peter Johnson (www.delphidabbler.com).
- *
- * $Rev$
- * $Date$
+ * Copyright (C) 2012-2021, Peter Johnson (gravatar.com/delphidabbler).
*
* CodeSnip File Format Documentation: CSS used by all documentation HTML files.
*/
@@ -117,6 +114,17 @@ code {
font-family: "Courier New", Courier, monospace;
}
+code.key {
+ font-weight: bold;
+ font-style: none;
+}
+
+code.value {
+ padding: 1px 2px;
+ background-color: #f5f5f5;
+ font-style: normal;
+}
+
del {
text-decoration: line-through;
color: gray;
@@ -165,3 +173,13 @@ acronym {
font-style: italic;
font-weight: bold;
}
+
+.del {
+ text-decoration: line-through;
+ color: gray;
+}
+
+.very-strong{
+ font-variant: small-caps;
+ font-weight: bold;
+}
diff --git a/Docs/Design/FileFormats/news-rss.html b/Docs/Design/FileFormats/news-rss.html
deleted file mode 100644
index 2b38cbefe..000000000
--- a/Docs/Design/FileFormats/news-rss.html
+++ /dev/null
@@ -1,75 +0,0 @@
-
-
-
-
-
-
-
- CodeSnip File Format Documentation - News RSS Stream
-
-
-
-
-
-
-
-
-
-
- DelphiDabbler CodeSnip
-
-
- File Format Documentation
-
-
-
-
- News RSS Stream
-
-
-
- CodeSnip downloads news about the program and database as an RSS feed from
- DelphiDabbler.com.
-
-
-
- The feed is generated as an RSS XML document using the default encoding used
- by the DelphiDabbler web server, ISO-8859-1. The XML document has no encoding
- information embedded in it.
-
-
-
- CodeSnip's HTTP handling code gets the RSS document as text and converts it to
- a Unicode string using the encoding indicated by the web service (ISO-8859-1
- by default).
-
-
-
- The XML is then parsed as a Unicode string.
-
-
-
- Therefore, although no explicit encoding information is embedded in the XML,
- the document is translated to Unicode correctly and information is preserved.
-
- CodeSnip saves external files in two different ways:
+ CodeSnip saves external files in three different ways:
- By saving snippets to file from the File | Save Snippet menu.
+ By saving snippet information using the File | Save Snippet Information menu option.
+
+
+ By saving snippets using the File | Save Snippet menu option.
- By saving units to file from the File | Save Unit menu.
+ By saving units using the File | Save Unit menu option.
- In each case the following file types can be chosen by the user:
+ In the first case the snippet information can be saved as one of the following file types:
+
+
+
+
+ Plain text.
+
+
+ HTML 5 files.
+
+
+ XHTML files.
+
+
+ Rich text files.
+
+
+ Markdown files.
+
+
+
+
+ In the second two cases the following file types can be chosen by the user:
@@ -72,6 +94,9 @@
Pascal source files (either .inc or .pas files).
+
+ HTML 5 files.
+
XHTML files.
@@ -81,7 +106,7 @@
- There is no specific file format for these files, other than XHTML and RTF
+ There is no specific file format for these files, except that HTML 5, XHTML, RTF and Markdown
files conform to published specifications.
@@ -90,7 +115,7 @@
- The encodings used depend on the file type and user choice. Different file
+ The available encodings depend on the file type and user choice. Different file
types have different encoding choices, as follows:
- CodeSnip saves temporary test units that are valid Pascal unit. These units
+ CodeSnip saves temporary test units that are valid Pascal units. These units
are used to perform test compiles.
@@ -68,8 +65,7 @@
If the unit's source code contains only characters that are supported by the
- system default ANSI code page the file is saved using the default ANSI
- encoding.
+ system default ANSI code page then the file is saved using that encoding.
@@ -86,7 +82,7 @@
- Unit filenames are limited to ANSI characters again for reasons of
+ Unit filenames are limited to ANSI characters also for reasons of
compatibility with earlier Delphis because they will report Unicode file names
as "not found".
- The source code for each snippet is stored in separate sequentially numbered
- .dat data files – one per snippet. Each source code file is referenced
- by the XML file.
+ The source code for each snippet is stored in separate, sequentially numbered, .dat data files – one per snippet. Each source code file is referenced by the XML file.
- There have been several different versions of the XML file format. Each of
- these is explained below.
+ There have been several different versions of the XML file format. The differences between versions are explained below. Details of all the changes between versions are listed in the Change Log at the end of this document
+
+
+
+
Encoding
@@ -83,21 +117,23 @@
- Prior to CodeSnip v4 source code data files were encoded using the system
- default ANSI code page. The XML file was in UTF-8, but its XML processing
- instruction had no "encoding" atrribute.
+ Prior to CodeSnip v4 (and database v5) source code data files were encoded using ANSI code page 1252. The XML file was in UTF-8, but its XML processing instruction had no "encoding" atrribute.
- CodeSnip v4 must be able to work with all these encoding because it may
+ CodeSnip v4 must be able to work with all these encodings because it may
inherit a copy of a user database in an earlier format.
+
+
+
+
File Format
-
+
XML File
@@ -163,7 +199,7 @@
version
- Identifies version of file. Determines which tags are valid and rules
+ Identifies major version of file. Determines which tags are valid and rules
concerning content. Valid versions are 1..6.
@@ -285,8 +321,16 @@
of plain text.
- version 6: Content is formatted text
- encoded in REML markup. REML v3 is supported.
+ version 6.0 to 6.10: Content is formatted text
+ encoded in REML markup. REML v4 is supported.
+
+
+ version 6.11 & 6.12: Content is formatted text
+ encoded in REML markup. REML v5 is supported.
+
+
+ version 6.13 & later: Content is formatted text
+ encoded in REML markup. REML v6 is supported.
- d2010 – Delphi 2010 compiler
+ dXE4 – Delphi XE4 compiler (v4.5 only)
+ Note: CodeSnip 3 used correct dXE4 id, but CodeSnip 4 did not (see dDX4 below).
- dXE – Delphi XE compiler
+ dDX4 – Delphi XE4 compiler (v6.2 & later)
+ Note: CodeSnip 4 dDX4 in error instead of dXE4 used by CodeSnip 3 (see above). The erroneous value was retained for backwards compatibility reasons.
- dDX4 – Delphi XE4 compiler. Note:
- This value was named dDX4 in error: it should have been
- named dXE4 but the erroneous value has been retained for
- backwards compatibility reasons.
+ dXE7 – Delphi XE7 compiler (v6.5 & later)
Source code is stored separately from the main XML file. The source code of
- each snippet has its file. Files are numbered sequentially and have a .dat
- extension, for example 6.dat.
+ each snippet has its own file. Files are numbered sequentially and have a
+ .dat extension, for example 6.dat.
@@ -683,29 +756,63 @@
XML file.
+
+
+
+
- Differences Between File Versions
+ Change Log
- The differences between different user database file versions is summarised
- below:
+ This section describes the changes between versions of the file format.
+
+
+
+ There were small changes within versions, that probably should have been given minor version numbers - but weren't. Such minor numbers have been assigned retrospectively below in order to better explain when in-version changes actually took place.
+
+
+
+ File formats v4 and v5/v6 actually overlapped in the dates they were in use. This is because v4 was used by CodeSnip v3 and v5/v6 were used by CodeSnip 4. Those two versions of CodeSnip were maintained in parallel for a while.
- Version 1
+ Version 1 - 15 September 2008
- First version of database.
+
+ Introduced with CodeSnip v2.0.
+
+
+ Supported Delphi compilers from Delphi 2 to Delphi 2007 plus Free Pascal.
+
+ The version of REML supported by the
+ codesnip-data/routines/routine/extra tag was v1.
+
+
- Version 3
+ Version 3 - 29 June 2009
-
+
+ Introduced with CodeSnip v3.0.
+
+
The following tag is no longer supported:
-
+
codesnip-data/routines/routine/standard-format
-
+
The following tag was introduced:
-
+
codesnip-data/routines/routine/kind
-
- The version of REML supported by the
- codesnip-data/routines/routine/extra tag was updated to v2.
-
+
+ The version of REML supported by the
+ codesnip-data/routines/routine/extra tag was updated to v2.
+
+
- Version 4
+ Version 4 - 06 July 2009
- The version of REML supported by the
- codesnip-data/routines/routine/extra tag was updated to v3.
+
+ Introduced with CodeSnip v3.0.1.
+
+
+ The version of REML supported by the
+ codesnip-data/routines/routine/extra tag was updated to v3.
+
+
+
+ Version 4.1 - 24 September 2009
+
+
+ Updated with CodeSnip v3.4 to add support for Delphi 2010.
+
+
+ Version 4.2 - 23 October 2010
+
+
+ Updated with CodeSnip v3.8.0 to add support for Delphi XE.
+
+
+ Version 4.3 - 07 September 2011
+
+
+ Updated with CodeSnip v3.9.0 to add support for Delphi XE2.
+
+
+ Version 4.4 - 17 September 2012
+
+
+ Updated with CodeSnip v3.11.0 to add support for Delphi XE3.
+
+
+ Version 4.5 - 02 May 2013
+
+
+ Updated with CodeSnip v3.12.0 to add support for Delphi XE4.
+
+
+
- Version 5
+ Version 5 - 21 April 2012
-
+
+ Introduced with CodeSnip v4.0 alpha 2.
+
+
The XML file's encoding was explicitly set to "UTF-8" by setting
the encoding attribute of the XML processing instruction to this value.
-
-
+
+
Snippet names, wherever they occur in the XML file, can now begin with
any character that is a valid first character of a Unicode Pascal
identifier. Previously the first character of the attribute had to be one
of 'A'..'Z', 'a'..'z' or '_'.
-
-
+
+
Data files changed to use UTF-8 encoding with no BOM instead of the system
default encoding.
-
-
+
+
New "class" and "unit" snippet kinds supported.
-
+
+
+ The version of REML supported by the
+ codesnip-data/routines/routine/extra tag was updated to v4.
+
+
- Version 6
+ Version 6 - 11 August 2012
-
- A snippet's description is now stored as formatted text using REML markup.
- Previously the description was plain text.
-
-
- The following tag was introduced:
-
+
+ Introduced with CodeSnip v4.0 beta 1.
+
+
+ A snippet's description is now stored as formatted text using REML v4 markup. Previously the description was plain text.
+
+ Updated with CodeSnip v4.0 RC 1 to add support for Delphi XE3.
+
+
+ Version 6.2 - 02 May 2013
+
+
+ Updated with CodeSnip v4.5.0 to add support for Delphi XE4.
+
+
+ Version 6.3 - 12 September 2013
+
+
+ Updated with CodeSnip v4.8.0 to add support for Delphi XE5.
+
+
+ Version 6.4 - 30 April 2014
+
+
+ Updated with CodeSnip v4.9.0 to add support for Delphi XE6.
+
+
+ Version 6.5 - 12 September 2014
+
+
+ Updated with CodeSnip v4.10.0 to add support for Delphi XE7.
+
+
+ Version 6.6 - 06 May 2015
+
+
+ Updated with CodeSnip v4.12.0 to add support for Delphi XE8.
+
+
+ Version 6.7 - 05 September 2015
+
+
+ Updated with CodeSnip v4.13.0 to add support for Delphi 10 Seattle.
+
+
+ Version 6.8 - 13 July 2016
+
+
+ Updated with CodeSnip v4.15.0 to add support for Delphi 10.1 Berlin.
+
+
+ Version 6.9 - 31 July 2020
+
+
+ Updated with CodeSnip v4.17.0 to add support for Delphi 10.2 Tokyo, Delphi 10.3 Rio and Delphi 10.4 Sydney.
+
+
+ Version 6.10 - 13 September 2021
+
+
+ Updated with CodeSnip v4.18.0 to add support for Delphi 11.x Alexandria.
+
+
+ Version 6.11 - 16 December 2022
+
+
+ Updated with CodeSnip v4.21.0 to add support for REML v5, which is backwards compatible with REML v4.
+
+
+ Version 6.12 - 7 November 2023
+
+
+ Updated in time for CodeSnip v4.22.0 to add support for Delphi 12 Athens.
+
+
+ Version 6.13 - 2 April 2024
+
+
+ Updated with CodeSnip v4.23.0 to add support for REML v6, which is backwards compatible with REML v4.
+
+
-
+
+
+
+
+
Notes for File Readers
+
+
+
+ To ensure backwards compatibility with all user database versions file reader software that works with the latest version of CodeSnip needs to be able to interpret older formats as follows.
+
+
+
+ Handling redundant XML tags
- Readers of version 1 files must convert the contents of the
- codesnip-data/routines/routine/comments,
- codesnip-data/routines/routine/credits and
- codesnip-data/routines/routine/credits-url tags into formatted text
- that simulates the parsed content of the
- codesnip-data/routines/routine/extra tag.
+ Readers of version 1 files must convert the contents of the the following tags:
+
+
+
+
codesnip-data/routines/routine/comments
+
codesnip-data/routines/routine/credits
+
codesnip-data/routines/routine/credits-url
+
+
+
+ into valid REML code that simulates the parsed content of the codesnip-data/routines/routine/extra tag.
@@ -825,18 +1086,37 @@
Readers of v1 to v5 files must:
-
+
+
Convert the plain text snippet description read from
- codesnip-data/routines/routine/description into the formatted text
+ codesnip-data/routines/routine/description into the REML
equivalent of a single paragraph containing the description.
- Proceed as if a codesnip-export/routines/routine/highlight-source
+ Proceed as if a codesnip-data/routines/routine/highlight-source
tag with value "1" had been specified.
+
+ Readers of v2 and later files may parse REML from any file version as if it were REML v6, since all versions of REML up to v6 are compatible.
+
+
+
+ Handling Text File Encodings
+
+
+
+ Readers of v1 to v4 files should interpret all source code .dat files as encoded in ANSI code page 1252 - the files were created using the default code page in the UK, which is 1252. The XML file should be assumed to be in UTF-8 format, regardless of the absence of an encoding attribute.
+
+
+
+ v5 and later files will always be encoded in UTF-8.
+
+
+
+
diff --git a/Docs/Design/Warnings.txt b/Docs/Design/Warnings.txt
index c00758683..1e2ddd6a1 100644
--- a/Docs/Design/Warnings.txt
+++ b/Docs/Design/Warnings.txt
@@ -5,8 +5,3 @@ XE warning options as follows:
"Platform Symbol" is switched OFF.
"Widening given AnsiChar constant to WideChar lost information" is switched ON.
"Widening given AnsiString constant lost information" is switched ON.
-
---------------------------------------------------------------------------------
-$Rev$
-$Date$
---------------------------------------------------------------------------------
\ No newline at end of file
diff --git a/Docs/Design/WebServices.txt b/Docs/Design/WebServices.txt
deleted file mode 100644
index 321967fb8..000000000
--- a/Docs/Design/WebServices.txt
+++ /dev/null
@@ -1,67 +0,0 @@
-================================================================================
-
-Documentation of classes that access web-services on behalf of CodeSnip.
-
-================================================================================
-
-
-DelphiDabbler Standard Web Service
---------------------------------------------------------------------------------
-
-A DelphiDabbler Standard Web Service object has the following attributes:
-
-* It connects to the web service over HTTP.
-
-* Requests are made using HTTP Post. Information is POSTed to the web service
- either in the form of URL encoded query strings or as raw post data. Which
- format is used depends on web service.
-
-* Web services respond with plain text. The text is encoded as the default for
- the server which defaults to ISO-8859-1.
-
-* The response text is split into lines by CRLF pairs. There is always at least
- one line in a response. Any trailing CRLFs should be stripped from the
- response text.
-
-* The first line of the response always contains a status code. A zero code
- indicates success, while non-zero codes indicate an error. The meaning of the
- error code is specific to the web service. Consult the documentation of the
- service for details.
-
-* A successful response *may* include further information, starting from the
- second line of the text. The meaning of this text depends on the web service.
- Consult the documentation of the service for details.
-
-* An error response *must* include an error message starting from the second
- line of the text. Error messages *may* have more than one line.
-
-Some web services also require that the correct user agent string for the
-service is used. Such web services return HTTP error 403 if the user agent is
-not valid. User agent strings *may* also specify the version of the web service
-to be used.
-
-The response format in ABNF is:
-
- response = status_code [CRLF data] [CRLF]
- status_code = success_code / error_code
- success_code = "0"
- error_code = ["-"] 1*DIGIT
- data = data_line [CRLF data]
- data_line = 0*[VCHAR | WSP]
-
-The class TStdWebService, which inherits from TBaseWebService, provides core
-functionality for working with standard web services. In particular it:
-
-* Provides methods for posting data in the form of query strings to the web
- service.
-
-* Handles the response, checking the status code. When an error code is received
- an exception is raised using the error message from the response. In the case
- of a successful response the status code line is stripped and the remaining
- data made available for processing by descendant classes.
-
-
---------------------------------------------------------------------------------
-$Rev$
-$Date$
---------------------------------------------------------------------------------
diff --git a/Docs/Design/reml.html b/Docs/Design/reml.html
new file mode 100644
index 000000000..fb8b0ce15
--- /dev/null
+++ b/Docs/Design/reml.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ REML Documentation
+
+
+
+
+
+
+
+
+
+
+ REML Markup Language
+
+
+
+
+
+
+
+
+
+
+ About REML
+
+
+
+ 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.
+
+ 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.
+
+
+
+ CodeSnip currently supports REML v6. Earlier versions of CodeSnip supported different versions of REML:
+
+
+
+
REML v1 was first supported by CodeSnip v2.2.5
+
REML v2 was first supported by CodeSnip v3.0
+
REML v3 was first supported by CodeSnip v3.0.1
+
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
+
+
+
+ All CodeSnip versions are backward compatible with earlier versions of REML.
+
+ This dialogue box is displayed when you choose the Database | Delete
+ User Database menu option.
+
+
+ Proceed with caution. If you give
+ permission here, all your user-defined snippets will be
+ deleted without further confirmation. This action
+ can't be undone.
+
+
+ Click Cancel to back out of this dialogue box.
+
+
+ If you decide you really want to do this you must enter the upper case
+ text DELETEMYSNIPPETS in the edit
+ box, then press OK. You will get an error message, and the
+ snippets won't be deleted, if the text you entered is incorrect.
+
+
+ Once you enter the required text and click OK all user-defined
+ snippets will be deleted straight away and the main display will be
+ re-loaded.
+
+
+ You are strongly advised to take a backup of your
+ snippets before deleting them, in case you change you mind. To do this
+ first cancel this dialogue box then use the Database | Backup User
+ Database menu option.
+
+
+ Why would you do this?
+
+
+ It's very unlikely you will need to delete all your snippets, but there
+ is one use case where this facility is useful. That is when you are moving
+ snippets from the standard version of CodeSnip to a portable version, or
+ vice versa.
+
+
+
\ No newline at end of file
diff --git a/Src/Help/HTML/dlg_dependencies.htm b/Src/Help/HTML/dlg_dependencies.htm
index 5cf9290db..a165e0879 100644
--- a/Src/Help/HTML/dlg_dependencies.htm
+++ b/Src/Help/HTML/dlg_dependencies.htm
@@ -2,12 +2,9 @@
@@ -31,14 +28,21 @@
This dialogue box is displayed by choosing the View |
- Dependencies main menu item. It has two tabs: Depends Upon
- and Required By.
+ Dependencies menu item or by pressing
+ Ctrl+D.
- Depends Upon Tab
+ Tabs
- If the selected snippet has dependenciess (i.e. snippets it requires in
+ The dialogue box has two tabs: Depends Upon and Required
+ By.
+
+
+ Depends Upon Tab
+
+
+ If the selected snippet has dependencies (i.e. snippets it depends upon in
order to compile) a tree of snippets is displayed that shows the direct
and indirect dependencies. When there are no dependencies a message is
displayed to that effect.
@@ -49,13 +53,27 @@
error message is displayed. Such a dependency indicates there is an error
in the database.
-
+
Required By Tab
-
+
This tab displays a simple list of snippets that immediately depend on the
- selected snippet. Again, if there are no snippets to list a message is
+ selected snippet. Again, if there are no snippets to list, a message is
displayed to that effect.
+
+ Select & Close button
+
+
+ This button appears to the left of the Close and Help
+ buttons. It's purpose is to select the snippets listed on the currently
+ active tab and to display that selection when the dialogue box is closed.
+ If the active tab lists no snippets then the button is disabled.
+
+
+ Warning: Any selection made using this
+ button will replace any search results that were previously displayed. No
+ warning will be displayed.
+
- If the snippet being edited has dependenciess selected in the
+ If the snippet being edited has dependencies selected in the
Dependencies list box then a tree of those snippets is displayed
- that shows both the direct and indirect dependencies. When there are no
+ that shows both direct and indirect dependencies. When there are no
dependencies a message is displayed to that effect.
- This dialogue box is used to duplicate the currently selected snippet,
- creating a new user defined snippet. The dialogue box is accessed from the
- Snippet | Duplicate Snippet menu option.
+ This dialogue box is used to create a new, user-defined, snippet that is
+ a duplicate the currently selected snippet. The dialogue box is accessed
+ from the Snippet | Duplicate Snippet menu option.
Enter a unique name for the duplicated snippet in the Unique name for
@@ -47,7 +44,7 @@
When duplicating a snippet from the main database it may be possible to
use the same name, providing a snippet of that name does not already
exist in the user database. If this is the case the suggested name will be
- the same as the original snippet.
+ the same as that of the original snippet.
The display name of the duplicated snippet can be edited or entered in the
@@ -58,25 +55,23 @@
edit box as the display name.
- The new snippet's category can be changed using the Choose categegory
- for duplicate snippet drop-down list. The category of the original
- snippet will already be selected, making it easy to create the new snippet
- in the same category.
+ The new snippet's category can be changed using the Category
+ drop-down list. The category of the original snippet will already be
+ selected, making it easy to create the new snippet in the same category.
- Click OK to go ahead and create the new snippet. If the snippet
- name is invalid or is not unique an error message will be displayed.
+ Click OK to create the new snippet. If the snippet name is
+ invalid or is not unique then an error message will be displayed.
- The newly duplicated snippet can be edited in the Snippets Editor immediately after clicking the OK button. To
do this tick the Edit in Snippets Editor check box. If you don't
want to display the Snippets Editor leave the check box clear.
- Note: The duplicated snippet is added to the database
- when this dialogue box closes, before the Snippets Editor is
- displayed. Therefore cancelling the Snippets Editor will not
- remove the duplicated snippet from the database.
+ Note that when automatically opening the Snippets Editor the
+ duplicated snippet is added to the database before the
+ Snippets Editor is displayed.
This dialogue box is displayed when either the Snippets | New
Snippet or Snippets | Edit Snippet menu options are
- selected. It is used to enter details of a new user defined code snippet
+ selected. It is used to enter details of a new user-defined code snippet
or to edit the details of an existing user-defined snippet.
@@ -45,10 +42,10 @@
Editing the snippet
- The dialogue has multiple tabs. All but the Code tab are optional
- – others can be used to provide additional information about the
- snippet. However, if you plan to test compile the snippet you must ensure
- that the snippet's dependencies and units are properly set up on the
+ The dialogue has multiple tabs. All but the Code tab are
+ optional: they are used to enter additional information that can be useful
+ but is not required. However, if you plan to test compile a Pascal snippet
+ you must ensure that the snippet's dependencies are properly set up on the
References tab.
@@ -56,116 +53,116 @@
This tab gathers all the information needed to define a snippet. All the
- fields are required. They are:
+ fields except Display Name are required. They are:
-
+
Name
-
-
+
+
Enter a name for the snippet in the edit box. The name must be a valid
Unicode Pascal identifier. It must also be unique within the user
- database, it may duplicate names in the main database.
-
-
+ database, although it may duplicate names in the main database.
+
+
It is customary to name functions or procedures using the routine's
name. Overloaded routines are often named by suffixing the routine
name with '_A', '_B', '_C' and so on.
-
+
-
+
Display Name
-
-
+
+
Enter a display name for the snippet. When present this name will be
- displayed in the main display instead of the snippet's name entered
- above. This name may contain any characters and does not have to be
+ displayed in the main display instead of the name entered above. The
+ display name may contain any Unicode character and does not need to be
unique.
-
-
+
+
This is an optional entry. If it is not supplied the value of the
Name control is used as the display name.
-
-
- The display name is useful where the entry in Name field does
- not display well. For example overloaded snippets named
+
+
+ The display name is useful where the entry in the Name field
+ does not display well. For example overloaded snippets named
"Foo" may have names "Foo_A", "Foo_B",
"Foo_C" etc., which are not too friendly. To improve this
you could use display names like "Foo (Integer overload)",
"Foo (string overload)", "Foo (Integer,string
overload)" etc.
-
+
-
+
Description
-
-
+
+
Enter a description of the code snippet in the
- markup editor. You can use more than
- one paragraph of text. You have the choice of styling the text and
- using hyperlinks.
-
-
+ markup editor. More than one paragraph
+ of text can be used. You can enter either plain text or text formatted
+ using CodeSnip's REML markup language.
+
+
The description field should not contain "}" characters
- since the field's text is used in comments in exported Pascal code and
- the "}" character will terminate the comment early.
-
-
+ since the field's text may be enclosed in comments in exported Pascal
+ code and the "}" character will terminate the comment early.
+
+
The description can be previewed using the Preview button.
Clicking this button also validates markup if you have used it.
-
Select the category to which the snippet belongs from the drop down
list.
-
+
-
+
Source code
-
-
+
+
Enter the snippet's source code in this text box. The format of the
source code is important unless you are using the freeform snippet
kind. Learn more.
-
+
-
+
Syntax highlight this snippet as Pascal code
-
-
+
+
Tick this box if your snippet is written in Pascal and you would like
the source to be syntax highlighted. Otherwise clear the box. Note
that the built in highlighter only understands Pascal code and will
not render code in other languages correctly.
-
-
+
+
If you prefer to turn off syntax highlighting completely go to the Syntax Highlighter tab of the Syntax Highlighter page of the Preferences dialogue box, click the Use Predefined
Styles button and select the No Highliter option.
-
+
References Tab
@@ -174,132 +171,124 @@
Use this tab to specify the snippets and units that are associated with
the snippet being edited. If it is intended to test compile the snippet
then the Dependencies and Units list boxes must be
- completed if the snippet depends on a Delphi unit or if it uses another
- snippet from the database.
+ completed correctly whenever the snippet depends on a Delphi unit or if it
+ relies upon another snippet from the database.
The available controls are:
-
+
Cross-references list box
-
-
+
+
Use this list box to specify any other snippets to be cross-referenced
- from this snippet. Check the boxes next to desired snippets. Cross
+ from this snippet. Check the boxes next to the desired snippets. Cross
references are for information only. All snippets are listed, except
for the one being edited.
-
-
+
+
To deselect all cross-references right click the list box and select
the Deselect All Cross-References option from the context
menu.
-
-
- User defined snippets are displayed in blue.
-
+
-
+
Dependencies list box
-
-
+
+
Specify any other snippets that this snippet depends upon by checking
the boxes next to the desired snippets in this list box. If this
snippet is to be test compiled then any other snippets it requires
must be specified here or the test compile will fail. The exception is
that unit snippets never have any
dependencies.
-
-
+
+
To deselect all dependencies right click the list box and select the
Deselect All Dependencies option from the context menu.
-
-
- You can use the context menu to to see all dependencies for the
- snippet being edited. This displayed the
+
+
+ You can use the context menu to see all dependencies for the
+ snippet being edited. This information is displayed in the
Dependencies dialogue box.
All entries checked in the Dependencies list box are
included, along with all their own dependencies, and so on. You must
not create a circular dependency; the Dependencies dialogue
box will help you detect them.
-
-
- The available entries in this list box will vary according to the
- snippet kind and the kind of snippets
- it can depend on. For example, constant
- snippets can't depend on routine
- snippets and unit snippets can't depend
- on anything, so the list is empty.
- Freeform snippets are never
- included.
-
-
- User defined snippets are displayed in blue.
-
+
+
+ The available snippets in this list box will vary according to the
+ snippet kind. For example,
+ constant snippets can't depend on
+ routine snippets and unit snippets can't depend on anything, so the
+ list will be empty. Freeform
+ snippets are never included in the list.
+
-
+
Units list box
-
-
- Select any units that this snippet requires in order to compile using
- this list box. Required units must be specified if test compilation is
- to be attempted. A selection of common units is provided, along with
- any units already associated with the snippet.
-
-
- If the unit you need is not in the list box simply enter its name in
+
+
+ Use this list box to select any units that this snippet requires in
+ order to compile. Required units must be specified if test compilation
+ is to be attempted. A selection of common units is provided, along
+ with any units already associated with the snippet.
+
+
+ If the unit you need is not in the list box, simply enter its name in
the edit box next to the Add Unit button and click the
button.
-
-
+
+
Each unit you use is remembered and will appear in the list box in
future. If the list box is getting too full you can remove most units
by right clicking them and selecting Delete Selected Unit
from the context menu. Note that the SysUtils,
Classes, Windows and Graphics
units cannot be deleted.
-
-
+
+
The list box's context menu also gives options to restore the unit
list to it's "factory" default and to deselect all the units
in the list.
-
-
+
+
Units are "used" in the order they appear in the list. If
- this order causes namespace clashes you should prefix ambiguous
+ this ordering causes namespace clashes you should prefix ambiguous
identifiers in the source code with the unit name, e.g.
Graphics.TBitmap.
-
-
- If you intend to test compile your snippet with Delphi XE2 or later
- you will need to make sure the appropriate compiler is configured to
- search the namespaces containing the units you list here. Do this in
- the Configure Compilers dialogue
- box. Use the Namespaces tab to enter the required namespaces.
- Click the Defaults button to use a set of namespaces that
- works with many of the commonly used units. You can see a list of
- namespaces with the units they contain in the Unit Scope Names topic of the Embarcadero RADStudio
- documentation.
-
-
- If any unit is not part of the Delphi RTL or VCL you will need to let
- the compiler know where to find the unit. Use the Search
- Paths tab of the Configure
- Compilers dialogue box to specify the required path. You need to
- do this for each compiler separately.
-
+ If you intend to test compile your snippet with Delphi XE2 or later
+ you will need to make sure the appropriate compiler is configured to
+ search the namespaces containing the units you list here. Do this
+ using the Namespaces tab of the
+ Configure Compilers dialogue
+ box. You need to do this for each compiler separately. You can
+ find a list of namespaces and the units they contain in the
+ Unit Scope Names topic of the Embarcadero RADStudio
+ documentation.
+
+
+ If any unit is not part of the Delphi RTL or VCL you will need to let
+ the compiler know where to find the unit. Use the Search
+ Paths tab of the Configure
+ Compilers dialogue box to specify the required path. You need to
+ do this for each compiler separately.
+
+
+ Notes:Unit snippets
must declare their used units in the unit source code, so this list
box is disabled when the snippet kind is unit.
-
+
@@ -313,7 +302,7 @@
Enter the required information in the Extra informationmarkup editor. You can enter either plain
- text of formatted text and hyperlinks using the custom
+ text or text formatted using CodeSnip's
REML markup language.
@@ -324,19 +313,23 @@
Compile Results Tab
- Use this tab to specify any known compiler results for the snippet. You
- can specify the required compiler in several ways:
+ Use this tab to specify any known compilation results for the snippet. You
+ can specify such results in several ways:
- Manually, one compiler at a time using the Set a compile
- results list box. Click the drop down button next to the required
- compiler then choose the required compile result from the drop down
- menu, i.e. one of Success, Warning, Error and
- Unknown. To use the keyboard to modify compile results proceed
- as follows:
+
+ Manually, one compiler at a time using the Set compile
+ results list box. Click the drop down button next to the required
+ compiler then choose a compilation result from the drop down
+ menu, i.e. one of Success, Warning, Error
+ and Unknown.
+
+
+ To use the keyboard to modify compile results proceed as follows:
+
-
+
Move the keyboard focus to the list box using the
Tab key.
@@ -368,22 +361,22 @@
result "query" (grey LED).
-
+
Use the Test Compile button to compile the snippet and set
- the compile results accordingly. This button is disabled if no
+ the compile results automatically. This button is disabled if no
compilers are configured or if the snippet is
freeform.
-
-
+
+
If one or more compilers report warnings or errors, a link appears
below the Test Compile button that can be clicked to display
details of the warnings or errors.
-
-
+
+
You can display the unit used to perform the test compilation by
clicking the View Test Unit button. This can be useful when
tracking down errors.
-
You specify the snippets to be exported by checking the required snippets
in the Select snippets to be exported check list box. Only user
- defined snippets are listed and any user defined snippet that is selected
- in the main display when the dialogue box is displayed is pre-selected.
- Checking or unchecking a category selects or deselects all the snippets in
- that category. At least one snippet must be selected.
+ defined snippets are listed. Any user defined snippet that is selected in
+ the main display is pre-selected in the list. Checking or unchecking a
+ category selects or deselects all the snippets in that category. At least
+ one snippet must be selected.
Next you specify the name of the export file by entering it in the
@@ -57,9 +54,13 @@
Click the OK button to export the snippets. If no snippet is
selected or no file name is specified then an error message is displayed
- and the dialogue box is not closed. The export can be aborted by clicking
+ and the dialogue box remains open. The export can be aborted by clicking
the Cancel button.
+
+ Note: Snippet categories and cross references are not
+ included in the export file.
+
adjusted using the Transparency slider (see below).
- Favourite snippets are listed in the main list view control. To the right
- of each snippet is the date and time it was created or last accessed. As
- usual snippets from the main and user database are displayed in different
- colours (black and blue by default).
+ Favourite snippets are listed in the dialogue's list view control. To the
+ right of each snippet is the date and time it was created or last
+ accessed. As usual snippets from the main and user database are displayed
+ in different colours (black and blue by default).
- Snippets can be sorted in either alphabetic order by clicking the
+ Snippets can be sorted in alphabetic order by clicking the
"Snippet" header. You can also sort by accessed date if you
click the "Last used" header.
@@ -62,9 +59,9 @@
By default snippets are displayed in a new tab in CodeSnip's detail pane. You change this to display all snippets in the same tab
- by clearing the tick mark from the Open favourites in new tabs
- check box. This setting is persistent.
+ >detail pane. You can change this to display all snippets in the same
+ tab by clearing the tick mark from the Open favourites in new
+ tabs check box. This setting is persistent.
You can remove a snippet from favourites by selecting it and clicking the
@@ -91,7 +88,7 @@
fades down to the selected transparency when the Transparency
slider is used and the transparency changes as the slider is moved. When
the mouse or arrow key is released the dialogue's opacity is restored. To
- view the current transparency without changing it press the
+ view the current transparency without changing it press and hold the
Space key when the slider has focus.
The dialogue box will have remembered details of your previous search,
- so deselect Delphi 7, 2006 2010 and select Delphi XE and XE2 in the
+ so deselect Delphi 7, 2006 & 2010 and select Delphi XE and XE2 in the
Compilers list. Now choose Does not compile in the
Criteria drop down list and change the search logic to Find
all compilers. Ensure that Refine existing search scope is
diff --git a/Src/Help/HTML/dlg_findtext.htm b/Src/Help/HTML/dlg_findtext.htm
index 37c3610d9..fc919b00d 100644
--- a/Src/Help/HTML/dlg_findtext.htm
+++ b/Src/Help/HTML/dlg_findtext.htm
@@ -2,12 +2,9 @@
@@ -44,17 +41,18 @@
Enter the text you want to search for in the Text to find combo
- box.
+ box. Recent search text can be accessed from the drop down list.
When more than one search word is entered you have a choice of whether to
search for snippets containing all the words, or any of them. You specify
which of these options you want by choosing the relevant radio button in
the Search logic group box. For example, choosing the Find
- all words option and searching for "Foo Bar" would match
- the text "Foo and Bar" but would not match "Foo" or
- "Bar". Choosing Find and word instead and again
- searching for "Foo Bar" would match all the previous examples.
+ all words option and searching for "Foo Bar"
+ would match the text "Foo and Bar" but would not match
+ "Foo" or "Bar". Choosing Find any word
+ instead and again searching for "Foo Bar" would
+ match all the previous examples.
There are two more options for further refining the search:
@@ -62,18 +60,20 @@
Use the Whole words only check box to ensure that the search
- only looks up words that exactly match those specified. If the check box
+ only matches words that exactly match those specified. If the check box
is cleared then words containing the specified text will also be found.
- For example when the check box is ticked search for "Foo" will
- not match "FooBar", but when the check box is cleared, the two
- words will match.
+ For example when the check box is ticked a search for
+ "Foo" will match "Foo" in
+ "Foo Bar" but will not match "FooBar". When the
+ check box is cleared, "Foo" will match both
+ examples.
Make the search case sensitive by checking the Case sensitive
- check box. In this case searching for "Foo" would only match
- the exact text and would not match "foo" or "FOO".
- If the check box is cleared then case is ignored. Now searching for
- "Foo;" will match both "foo" and "FOO".
+ check box. In this case searching for "Foo" will
+ match "Foo" but not "foo" or "FOO". If the
+ check box is cleared then case is ignored and searching for
+ "Foo" again will match all three examples.
@@ -91,10 +91,9 @@
remains unchanged.
- The Search scope group box is disabled if there was no existing
- search when this dialogue box was opened, and the search operates on the
- entire database.
+ The Search scope group box is disabled if there was no previous
+ search active when this dialogue box was opened. The search will operate
+ on the entire database.
Use this dialogue box to find snippets that are referenced by the
- currently selected snippet and / or those snippets reference that snippet.
- The dialogue is displayed from the Search | Find Cross Refs menu
- option.
+ currently selected snippet and / or those snippets that reference the
+ snippet. The dialogue is displayed from the Search | Find Cross
+ Refs menu option.
+
+
+ The dialogue enables two kinds of cross-references to be found:
+
+
+ Snippet dependencies, which are snippets that the selected snippet
+ depends upon in order to compile. Alternatively the search can find
+ snippets that depend on the selected one.
+
+
+ "See also" references, which are snippets that are related to
+ the selected snippet conceptually. Such snippets are not necessarily
+ needed to compile the selected snippet. Alternatively the search can
+ find snippets that refer to the selected one as a "see also"
+ snippet.
+
+
- The search can be customised by checking or clearing the following check
+ The search is customised by checking or clearing the following check
boxes:
- Search for required snippets. Selecting this option causes
- all snippets that are needed to compile the selected snippet to be
- included in the search result. If the related Search
- recursively box is checked the search continues through the found
- snippets.
+
+ Search for required snippets
+
+
+ Selecting this option includes all snippets that the selected snippet
+ depends upon in the search result.
+
+
+ If the related Search recursively box is checked the search
+ is applied recursively to all the found snippets.
+
- Search for snippets that depend on this one. Choose this option
- to include in the search results all snippets that depend upon (i.e.
- require) this one.
+
+ Search for snippets that depend on this one
+
+
+ Choose this option to include in the search results all snippets that
+ depend upon this one.
+
- Search for "see also" cross references. This option
- includes snippets referenced as "see also" to be included in
- the search result. These snippets are not necessarily needed to compile
- the selected snippet, but are related to it conceptually. Again,
- checking the related Search recursively check box causes the
- search to recurse through the found "see also" cross
- references.
+
+ Search for "see also" cross references
+
+
+ This option includes all snippets referenced as "see also"
+ in the search result.
+
+
+ Checking the related Search recursively check box causes the
+ search to recurse through all the found snippets' "see also"
+ cross references.
+
- Search for snippets that cross-reference this one. Choose this
- option to include in the search results all snippets that
- cross-reference this one.
+
+ Search for snippets that cross-reference this one
+
+
+ Choose this option to include all snippets that cross-reference this
+ one in the search results.
+
- Include "xxxx" in search (where xxxx is the name of
- the selected snippet). Checking this box simply includes the selected
- snippet in the search results.
+
+ Include "xxxx" in search (where xxxx is the name of
+ the selected snippet).
+
+
+ Checking this box simply includes the selected snippet in the search
+ results.
+
@@ -77,10 +115,10 @@
or Search for "see also" cross references options.
- NOTE: Any cross references selected using this dialogue
- box will replace any search results that were previously displayed. A
+ Note: Snippets selected by the use of this dialogue box
+ will replace any search results that were previously displayed. A
message to this effect will be displayed in the dialogue box if it is
- displayed when search results are being displayed.
+ opened while a previous search is active.
Its purpose is to enable you to preserve preferences from the earlier
- version of CodeSnip and to import any user snippets database you
- may have created.
+ version of CodeSnip and to import any user defined snippets
+ database you may have created.
- Notes: If you run CodeSnip 4 as a different user you may see this
- dialogue box again since it performs configuration on a per-user basis.
+ Note: If you run CodeSnip 4 as a different user
+ you may see this dialogue box again since it performs configuration on a
+ per-user basis.
The dialogue box takes the form of a multi-page wizard. You can't cancel
@@ -87,24 +85,11 @@
- If you are updating from v3.6.0 or earlier and have set up a password
- protected proxy server for internet access you will need to re-enter
- the password since it will have been lost. This is because format for
- storing passwords changed at v3.6.1.
-
- If you are updating from v1.8.11 or earlier and have registered
- CodeSnip you registration information will have been lost.
-
-
- You can check this by displaying the About dialogue box and checking the About The Program
- tab. If it displays a Register CodeSnip button the program
- is not registered. You can (re)register if you wish by clicking the
- button.
-
-
- Once you have decided whether to preserve preferences or not, click the
+ Once you have decided whether to preserve preferences, click the
Next button. This will take you to the Snippets database
page or the Summary page, depending on whether a user defined
snippets database has been found.
@@ -149,18 +120,19 @@
you prefer to abandon the database, clear the check box.
- If you do create a copy of the database any changes you make to it will
- not be reflected in the earlier copy, or vice versa. This is because a
- snippets database updated by CodeSnip 4 ceases to be readable by
- earlier versions.
+ If you do create a copy of the database any changes you make to it in
+ CodeSnip 4 will not be reflected in the earlier copy, and vice
+ versa. This is because a snippets database updated by CodeSnip 4
+ ceases to be readable by earlier versions.
This page is displayed after the configuration is complete.
- If you preversed your preference and any loss of information has been
- detected, or is possible, the information is listed here. See the
+ If you preserved your preferences and any loss of information has been
+ detected, or is possible, that information is listed here. See the
"Preferences" page section above for details. Otherwise the
page simply reports that the process is complete.
Click Finish to close the wizard. CodeSnip 4 will now
- load.
+ load normally.
- User Defined Highlighters Dialogue Box
+ User Defined Highlighters Dialogue Box
This dialogue box is displayed from the User Defined Styles
option of the drop-down menu displayed by the Use Named Style
button located on the Syntax
- Highlighter tab of the Preferences
+ Highlighter page of the Preferences
dialogue box.
- The dialogue box is used to manage and display saved user-defined syntax
- highlighter styles. The available styles are listed in the Available
- highlighter styles list box.
+ The dialogue box is used to manage saved user-defined syntax highlighter
+ styles. The available styles are listed in the Available highlighter
+ styles list box.
- To display a style either select the required style and press the Use
+ To display a style in the Syntax
+ Highlighter tab either select the required style and press the Use
& Close button or, alternatively, double click the style in the
list box. The dialogue box will be closed immediately and the style will
be displayed in the main dialogue box ready for editing.
diff --git a/Src/Help/HTML/dlg_import.htm b/Src/Help/HTML/dlg_import.htm
index 3ca2c13de..e9e71a5b1 100644
--- a/Src/Help/HTML/dlg_import.htm
+++ b/Src/Help/HTML/dlg_import.htm
@@ -2,12 +2,9 @@
@@ -66,43 +63,11 @@
Files exported from CodeSnip usually have a .csexp extension.
- Once a suitable file has be specified click the Next button to
+ Once a suitable file has been specified click the Next button to
load the file and move to the next page of the wizard. The database is
not updated at this stage, so if you made a mistake you can return to this
page and choose another file.
-
- "User information" page
-
-
- Note: This page is not shown if the selected import file
- does not contain any user information.
-
-
- The User information page simply displays any information that
- the person who created the file provided. There are three items of
- information that may be present:
-
-
-
- Name - the name or nickname of the person who created the file.
-
-
- Email - the email address of the person who created the file.
-
-
- Comments - any comments about the content of the file.
-
-
-
- Any of these items of information can be empty. Comments are for
- information only but the name and email will be added to the end of the
- imported snippet's Extra information field. This will be in the
- form "Contributed by Name <Email>".
-
-
- Click Next to go to the next page.
-
"Edit import and update database" page
@@ -122,7 +87,7 @@
Import Using Name
- This is that name that will be used for the snippet when it is imported.
+ This is the name that will be used for the snippet when it is imported.
If there is already a snippet in your database with the same name as
that given in the Snippet Name column, the entry in this column
will have been altered to make it unique in your database. Any names in
@@ -139,11 +104,11 @@
Selecting one of the rows in the grid copies the snippet name from the
Import Using Name column into the Selected Snippet edit
- control. You can rename the snippet by entering a new name here then
- clicking the Rename button. The new name is validated before
- being displayed in the grid. You can't use the name of a snippet that is
- already in your user database or is the name one of the other snippets in
- the import list.
+ control. You can rename the snippet by entering a new name in the edit
+ control then clicking the Rename button. The new name is
+ validated before being displayed in the grid. You can't use the name of a
+ snippet that is already in your user database or is the name of another
+ snippet in the import list.
When you are ready to perform the import click the Update button
diff --git a/Src/Help/HTML/dlg_importfile.htm b/Src/Help/HTML/dlg_importfile.htm
index 09c05e274..c6fb74b3a 100644
--- a/Src/Help/HTML/dlg_importfile.htm
+++ b/Src/Help/HTML/dlg_importfile.htm
@@ -2,12 +2,9 @@
diff --git a/Src/Help/HTML/dlg_loadselection.htm b/Src/Help/HTML/dlg_loadselection.htm
index 889b36813..b8601123e 100644
--- a/Src/Help/HTML/dlg_loadselection.htm
+++ b/Src/Help/HTML/dlg_loadselection.htm
@@ -2,12 +2,9 @@
@@ -27,22 +24,21 @@
This Windows standard dialogue box is displayed when the File | Load
Selection menu option is chosen.
- Use this dialogue box to specify the name of the file containing the
- details of database selection to be loaded. By default only files with the
+ Use this dialogue box to specify the name of the file containing details
+ of the database selection to be loaded. By default only files with the
".cssel" extension are displayed. This can be changed using the
Files of type drop-down list and chosing "All files".
- Click OK to confirm the selection. If the file aleady exists you
- will be prompted for permission to overwrite it. Choosing an invalid file
- will result in an error message.
+ Click OK to load the selection. Choosing an invalid file will
+ result in an error message.
- Note: This dialogue box is not available in the portable
- edition of CodeSnip.
+ Note: This dialogue box is not available
+ in the portable edition of CodeSnip.
The purpose of this dialogue box is to enable the user to move the user
defined snippets database from its default location to a new directory.
You may wish to do this to enable the database to be easily backed up.
For example you could move the database to a sub-directory of a
- Dropbox or GoogleDrive directory.
+ Dropbox or Google Drive directory.
- You have the option to restore a previously moved database to its default
- location. Both options are described below.
+ You also have the option to restore a previously moved database to its
+ default location. Both options are described below.
Important: You a strongly advised to make a backup of the
@@ -57,7 +54,7 @@
Database menu option to do this.
- Move the database to a new directory
+ Move database to new directory group box
To move the database enter the full path of the new
@@ -70,10 +67,10 @@
- the directory must be empty;
+ it must be empty;
- it must not be a sub-directory of the current database location;
+ it must not be a sub-directory of the current database location.
@@ -85,22 +82,22 @@
The new location of the database will be recorded in the per user config
- file and it is important that this file is not modified or deleted
+ file. It is important that this config file is not modified or deleted
otherwise the database will not be found.
- Restore database to default directory
+ Restore database to default directory group box
The database can be moved back to its default directory simply by clicking
- the Restore Default Path button. If the default directory is not
- empty this action will fail and an error message will be displayed. As
- above, a progress bar gives an indication of how long the process may
+ the large Restore Default Path button. If the default directory
+ is not empty this action will fail and an error message will be displayed.
+ As above, a progress bar gives an indication of how long the process may
take.
- The Restore Default Path button will be disabled if database is
- already in its default location.
+ The Restore Default Path button will be disabled if the database
+ is already in its default location.
- This dialogue box is displayed from the Help | CodeSnip News menu
- item.
-
-
- It shows the latest news about CodeSnip and the online database.
- The news is obtained from CodeSnip's online RSS news feed. The
- titles of most items are clickable and will display a web page relevant
- to the news item when clicked.
-
-
- The maximum age of the news items is shown at the top of the window. By
- default this is 92 days. You can change this by clicking the
- Change button, which will display the News tab of the Preferences dialogue box. Enter a new value there and click
- OK. If the value has changed the news will be re-loaded, showing
- items from the date range specified.
-
-
- If the news feed is not available or there is an error, a message to that
- effect is displayed.
-
-
- You can display the RSS feed in your default web browser by clicking the
- RSS Feed button. Depending on your browser, you may be able to
- subscribe to the feed from there.
-
Select the size of each margin by entering a value in the appropriate edit
box.
+
+ The default margin sizes can be specified using the
+ Printing page of the
+ Preferences dialogue box.
+
The unit of measurement used to set margins is displayed in the group box
label. This can be changed on the
- Misc. tab of the
+ Misc. page of the
Preferences dialogue box.
dialogue box is accessed via the Tools | Preferences menu option.
- The dialogue box is in several sections, accessed by tabs across the top
- of the page. These are:
+ The dialogue box is divided into different "pages". Each page is listed by name in the pane on the left hand side of the dialogue box. Selecting one of these names displays the related page of options on the right.
+
Click OK to accept all the changes or Cancel to close
the dialogue without making changes.
+
+ The last page you selected is remembered and is displayed again the next time you open the dialogue box. This happens regardless of whether you close the dialogue box with OK or Cancel.
+
Note: On some occasions this dialogue box may be
- displayed with just one tab visible. An example of this is when the
+ displayed with just one page visible. An example of this is when the
Default Options button of the Print
dialogue box is clicked – only the
- Printing tab is displayed.
+ Printing page is displayed.
- This tab of the Preferences dialogue box
- is used to customise the source code emitted by the code generator for
- test compilations and generated units.
+ This page of the Preferences dialogue
+ box is used to customise the source code emitted by the code generator
+ when creating test compilations and when outputting units.
+
+
+ The page is accessed by selecting the Tools | Preferences menu
+ item then clicking on Code Generation in the list on the left of
+ the window.
+
- The tab is accessed by selecting the Tools | Preferences menu
- item then clicking the Code Generation tab.
- Note: This tab is not used to modify the style
+ Note: This page is not used to modify the style
of the source code: use the Code
- Formatting tab for that.
+ Formatting page for that.
- The Code Generator can be configured to generate $WARN compiler directives
- to switch specified warning messages on or off. These directives are
- supported by Delphi 6 and later.
+ The Code Generator can be configured to generate $WARN
+ compiler directives to switch specified warning messages on or off. These
+ directives are supported by Delphi 6 and later. Free Pascal is not
+ supported.
To enable this facility you must check the Emit $WARN directives
@@ -53,14 +55,12 @@
The warnings for which compiler directives are to be generated are those
listed in the list view control situated below the check box. Warnings
are identified by the text in the Symbol column. These symbols
- must be valid parameters for Delphi's $WARN directive. Since new symbols
- have been introduced in different versions of Delphi, the minimum version
- of the compiler that supports the warning must also be specified. This is
- shown in the Min. Compiler column of the list view. The version
- number is that specified by the Delphi's CompilerVersion constant.. Finally, whether a warning is
+ must be valid parameters for Delphi's $WARN directive. Since
+ new symbols have been introduced in different versions of Delphi, the
+ minimum version of the compiler that supports the warning must also be
+ specified. This is shown in the Min. Compiler column of the list
+ view. The version number is that specified by Delphi's
+ CompilerVersion constant. Finally, whether a warning is
switched on or off is shown in the State column.
@@ -78,12 +78,12 @@
Add a symbol
Enter the symbol name in the Symbol edit control, specify the
earliest compiler version that supports it in the Min. Compiler
- edit control and specify whether the $WARN directive will switch the
- warning on or off by selecting the appropriate Warning State
- radio button. Click the Add button to add the symbol to the
- list. If the Add button remains disabled check that the
+ edit control and specify whether the $WARN directive will
+ switch the warning on or off by selecting the appropriate Warning
+ State radio button. Click the Add button to add the symbol
+ to the list. If the Add button remains disabled check that the
compiler version is valid and that the symbol name does not already
- exist.
+ exist in the list view.
Delete a symbol
@@ -96,9 +96,9 @@
copied into the Symbol and Min. Compiler edit
controls and the appropriate Warning State radio button will be
selected. Change the details as required then click the Update
- button to modify the symbol. The changes will be reflected in the list
- view. If the entered information is not valid then the Update
- button will be disabled.
+ button. The changes will be reflected in the list view. If the entered
+ information is not valid then the Update button will be
+ disabled.
@@ -110,12 +110,12 @@
supported compiler version is 14.0.
- The Preview button at the top right of the tab displays the
+ The Preview button at the top right of the page displays the
source code that will be emitted by the code generator.
- The Restore Defaults button discards the current list of $WARN
- directives and replaces it with a default set.
+ The Restore Defaults button discards the current list of
+ $WARN directives and replaces it with a default set.
- Using this tab of the Preferences dialogue box you can configure various aspects of the
- program's display. The tab is accessed by selecting the
- Tools | Preferences menu item then clicking the Display
- tab.
+ program's display. The page is accessed by selecting the
+ Tools | Preferences menu item then clicking on Display
+ in the list on the left of the window.
The options are:
@@ -46,7 +43,7 @@
href="overview_pane.htm"
>overview pane appears when the program starts. Do this using the
Start overview pane treeview as drop down list to choose either
- Fully expanded to make the treeview display all entries) or
+ Fully expanded to make the treeview display all entries or
Fully collapsed to display only section headers.
@@ -54,21 +51,22 @@
tab or in a new tab in the detail pane. Check the Display newly added snippets &
- categories in new tabs check box to add a new tab for each item
- created or clear the check box to overwrite the content of the currently
- selected tab.
+ categories in new tabs check box to add a new tab for each item,
+ or clear the check box to overwrite the content of the currently
+ selected tab. Note that Ctrl clicking an
+ item always displays the item in a new tab, regardless of this setting.
Choose whether empty section headings are hidden in the overview pane. Check the Hide empty section headings in
- overiew check box to hide empty section headings or clear the check
- box to display them.
+ overview check box to hide empty section headings or clear the
+ check box to display them.
-
+
Specify the colours used for the following interface elements:
-
+
Snippet and category headings in the main database.
@@ -82,14 +80,37 @@
>detail pane.
-
+
Choose the required colours from the appropriate drop-down colour
- lists. Custom colours can be created: just select the
- Custom... option from the drop down list and choose or create
- the colour in the displayed colour dialogue box. Default colours for
- any of the above interface elements can be restored by clicking the
- Use Default Colours button.
-
+ lists. Custom colours can be created: just select the
+ Custom... option from the top of the drop down list and
+ choose or create the colour in the displayed colour dialogue box.
+
+
+ Default colours for all the above interface elements can be restored
+ by clicking the Use Default Colours button.
+
+
+
+ Choose the size of font used in the overview pane's tree view using the Overview tree font
+ size combo box.
+
+
+
+ Similarly, the size of font used in the details pane is set using the Detail pane font size
+ combo box.
+
+
+ Note: this combo box does
+ not affect the size of the font used to display source code
+ – this can be changed on the Syntax Highlighter Preferences page.
+
- This tab of the Preferences dialogue box is used for miscellaneous preferences that
- don't merit a tab of their own. The tab is accessed by selecting the
- Tools | Preferences menu item then clicking the Misc.
- tab.
+ don't merit a page of their own. The page is accessed by selecting the
+ Tools | Preferences menu item then clicking on Misc. in
+ the list on the left of the window.
- There is only a single option that can be set on this tab.
+ There is only a single option that can be set on this page.
Measurement
@@ -47,7 +44,7 @@
Select the measurement units to be used by the application from the
Preferred units of measurement drop down list. Options are
Inches and Millimeters. If you have not set this option
- before, the measurement units will default to your locale settings.
+ before, the measurement units will be appropriate to your locale.
diff --git a/Src/Help/HTML/dlg_prefs_hiliter.htm b/Src/Help/HTML/dlg_prefs_hiliter.htm
index 5e436496c..aacd45b21 100644
--- a/Src/Help/HTML/dlg_prefs_hiliter.htm
+++ b/Src/Help/HTML/dlg_prefs_hiliter.htm
@@ -2,14 +2,11 @@
@@ -28,13 +25,14 @@
The appearance of syntax highlighted source files can be customised using
- this tab of the Preferences dialogue
- box. The tab is accessed by selecting the Tools | Preferences
- menu item then clicking the Syntax Highlighter tab.
+ this page of the Preferences dialogue
+ box. The page is accessed by selecting the Tools | Preferences
+ menu item then clicking on Syntax Highlighter in the list on the
+ left of the window.
Note
@@ -43,11 +41,12 @@
Syntax highlighter customisation applies to the
Detail Pane, exported files and source
code copied to the clipboard. Highlighting used in printed documents is
- configured from the Printing tab.
+ configured from the Printing
+ preferences page.
Different syntax highlighter styles can be saved and given identifying
- names for later user.
+ names for later use.
Highlighter Font
@@ -59,7 +58,7 @@
Note: The highlighter font is ignored in code previews in
- other tabs in the Preferences dialogue
+ other pages of the Preferences dialogue
box to ensure that previews fit the available space.
@@ -68,14 +67,14 @@
The colour and font style used for various syntactic elements of the
source code can be changed. Select an element in the Elements
- list box then using the Font style check boxes and
- Colour drop down list. A preview of the element is displayed.
+ list box then edit its style using the Font style check boxes and
+ the Colour drop down list. A preview of the element is displayed.
Named Styles
- CodeSnip provides five pre-defined styles that are applied by
+ CodeSnip provides some pre-defined styles that are applied by
clicking the Use Predefined Style button and selecting the style
from the drop-down menu that appears.
@@ -84,7 +83,7 @@
- CodeSnip Classic – style of highlighting used in main
+ CodeSnip Classic – style of highlighting used in the main
display of CodeSnip v2 and earlier.
@@ -105,9 +104,7 @@
highlighters can also be deleted from this dialogue box.
- No Highlighter – no syntax highlighting used. You might
- want to use this style if you are storing code other than Pascal in
- CodeSnip.
+ No Highlighter – no syntax highlighting is used.
@@ -137,7 +134,7 @@
(see above).
- Any number of custom highlighter style can be saved.
+ Any number of custom highlighter styles can be saved.
- Preferences concerning the CodeSnip new feed can be modified by
- using this tab of the
- Preferences dialogue box. The tab is accessed by selecting the
- Tools | Preferences menu item then clicking the News
- tab. You can also display this tab from the CodeSnip News dialogue box.
-
-
- There is only one setting that can be changed, and that is the maximum
- number of days old a news item may be to be displayed in the CodeSnip News dialogue box.
-
-
- Simply enter the required number of days in the spin edit control. The
- minimum number of days is 14 and the maximum is 365. If you enter values
- outside this range a valid value will be substituted.
-
- This tab of the Preferences dialogue box
- is used customise the default appearance of printed output.
-
-
- The tab is accessed by selecting the Tools | Preferences menu
- item then clicking the Printing tab. You can also display this
- tab from the Print dialogue box.
+ This page of the Preferences dialogue
+ box is used customise the default appearance of printed output.
+
+
+ The page is accessed by selecting the Tools | Preferences menu
+ item then clicking on Printing in the list on the left of the
+ window. You can also display this page from the
+ Print dialogue box.
- Note: Options set in this tab usually take effect the
- next time the application is started. The exception is when the tab is
- displayed from the Print dialogue box, when you can choose to
- apply the new options straight away.
+ Warning: When this page is displayed via
+ the Tools | Preferences menu option options usually only take
+ effect the next time the application is started. But when the page is
+ displayed from the Print dialogue box, the changed options take
+ effect straight away.
Document Formatting Options
@@ -50,7 +49,7 @@
There are two options that change the way printed documents are formatted:
-
+
The Syntax highlight source code check box specifies whether
source code included in the output is syntax highlighted by default.
@@ -65,6 +64,12 @@
A preview of the effect of the options is displayed to the right of the
check boxes.
+
+ When syntax highlighting is enabled the style used is as specified in the
+ Syntax Highlighter peferences page.
+ When black and white printing is specified the highlighter's font styles
+ are used but colours are ignored.
+
Page Margins
@@ -75,8 +80,9 @@
Margins are displayed and entered either in inches or millimeters. The
units being used are displayed in the group box caption.
- Note: measurement units can be specified on the
- Misc. tab, if it is visible.
+ Note: measurement units can be changed on the
+ Misc. preferences page, if it is
+ visible.
- This tab of the Preferences dialogue box is used to customise the layout of pages
- that display the various kinds of snippet in the kinds of snippet
+ in the Detail Pane.
- The tab is accessed by selecting the Tools | Preferences menu
- item then clicking the Display tab in the Preferences dialogue box.
+ The page is accessed by selecting the Tools | Preferences menu
+ item then clicking on Snippet Layout in the list on the left of
+ the window.
Overview
@@ -80,8 +79,8 @@
Type
- Snippet's type or kind, e.g. "Routine" or "Type
- Definition"
+ Snippet's type or kind, e.g.
+ "Routine" or "Type Definition"
@@ -89,7 +88,7 @@
Category
- Category that snippet belongs to. Renders as a link.
+ Category that a snippet belongs to. Renders as a link.
- Contains links to any required snippets. Always empty for Unit snippets.
@@ -117,7 +117,7 @@
Cross Reference List
- Contains links to any cross referenced snippets.
+ List of links to any cross referenced snippets.
@@ -160,10 +160,10 @@
The current page components will be displayed in the right hand
Displayed page components list box. Any unused page components
- are listed in the Unused page components list box.
+ are listed in the Unused page components list box on the left.
- You customise the page using this list boxes. Here are the available
+ You customise the page using these list boxes. Here are the available
actions:
- This tab of the Preferences dialogue box
- is used configure the format of source code that CodeSnip writes
- to file or copies to the clipboard. The tab is accessed by selecting the
- Tools | Preferences menu item then clicking the Code
- Formatting tab.
-
-
- Source code formatting
-
-
- Descriptions of snippets can be included as comments in generated source
- code. The placing of such comments can be customised using the
- Commenting style drop down list. Options are:
-
-
-
- No descriptive comments – descriptions are not included.
-
-
- Comments after snippet header – comments appear between
- a snippet's header and the body of the snippet. For functions and
- procedures the header is the function or procedure prototype. For
- types and constants the comment is placed after the
- type or const keyword and before any
- other code.
-
-
- Comments before snippet – comments are placed before the
- snippet. The snippet's name is included in the comment.
-
-
-
- A preview of the comment style is displayed below the drop down list.
-
-
- Some snippets have multi-paragraph descriptions, all of which would normally
- appear in the snippet's comment in generated code. You can limit the comment
- to use just the first paragraph of the snippet's description by ticking the
- Truncate comments to one paragraph check box.
-
-
- Note: Descriptive comments are not applicable to
- freeform snippets.
-
-
- File formatting
-
-
- The default format of output files is configurable. The available output
- types are HTML, rich text and two types of unformatted text, i.e. Pascal
- files and plain text files. You choose the default output type using the
- Output file type drop down list.
-
-
- HTML and rich text file types can be syntax highlighted. To enable this
- option check the Enable syntax highlighting check box. The
- highlighting can be customised using the
- Syntax Highlighter tab.
-
+
+
+
+ Code Formatting Preferences Page
+
+
+ This page of the Preferences dialogue
+ box is used to configure the format of source code that CodeSnip
+ writes to file or copies to the clipboard. The page is accessed by
+ selecting the Tools | Preferences menu item then clicking on
+ Code Formatting in the list on the left of the window.
+
+
+ Source code formatting
+
+
+ Descriptions of snippets can be included as comments in generated source
+ code. The placing of such comments can be customised using the
+ Commenting style drop down list. Options are:
+
+
+
+ No descriptive comments – descriptions are not included.
+
+
+ Comments after snippet header – comments appear between
+ a snippet's header and the body of the snippet. For functions and
+ procedures the header is the function or procedure prototype. For
+ types and constants the comment is placed after the
+ type or const keyword and before any
+ other code.
+
+
+ Comments before snippet – comments are placed before the
+ snippet. The snippet's name is included in the comment.
+
+
+
+ A preview of the commenting style is displayed below the drop down list.
+
+
+ Some snippets have multi-paragraph descriptions, all of which normally
+ appear in the snippet's comment in generated code. You can limit the
+ comment to use just the first paragraph of the snippet's description by
+ ticking the Truncate comments to one paragraph check box.
+
+
+ When descriptive comments are enabled, they are included in the interface
+ section of generated units. You can choose whether or not such comments
+ are repeated in the unit's implementation section using the Repeat
+ comments in unit implementation section check box.
+
+
+ Note: Descriptive comments are not applicable to
+ freeform or
+ unit snippets.
+
+
+ File formatting
+
+
+ The default format of output files is configurable. The available output
+ types are HTML, rich text and two types of unformatted text, i.e. Pascal
+ files and plain text files. You choose the default output type using the
+ Output file type drop down list.
+
+
+ HTML and rich text file types can be syntax highlighted. To enable this
+ option check the Enable syntax highlighting check box. The
+ highlighting can be customised using the
+ Syntax Highlighter preferences page.
+
+
+ You can override the default format when saving source code to file by
+ choosing a different format in the save dialogue box.
+
- Use this tab of the Preferences dialogue box to determine if and when CodeSnip
- checks for program and database updates. The tab is accessed by selecting
- the Tools | Preferences menu item then clicking the
- Updates tab.
-
-
- There are two combo boxes, Check for program updates and
- Check for database updates. They allow you to determine if, and
- how often, CodeSnip checks to see if updates to the program and
- the online Code Snippets Database are available, respectively.
-
-
- The available choices are:
-
-
-
- Never
-
-
- Daily
-
-
- Every 3 Days
-
-
- Weekly
-
-
- Fornightly
-
-
- Monthly
-
-
-
- The default value is Weekly.
-
-
- Select Never if you don't want CodeSnip to check for
- updates automatically. You can still check manually as follows:
-
-
-
- For program updates use the Tools | Check For Program Updates
- menu option.
-
-
- For database updates use the Database | Update From Web menu
- option.
-
-
-
- CodeSnip performs update checking in a background thread shortly
- after starting up. If there are no updates available you will see nothing.
- If any updates are available a small notification window is displayed in
- the bottom right hand side of the main window. The notification window
- will be displayed for about 20 seconds or until you close it.
-
-
- The notification window will describe the available update and provide a
- button to click to enable it to be downloaded.
-
- This dialogue box is displayed when the Tools | Check For Program
- Updates menu option is selected.
-
-
- As soon as the dialogue box appears the DelphiDabbler web site is
- contacted to find out if any new versions of CodeSnip are
- available. "Checking..." is displayed while this is in progress.
-
-
- If a new version is available then a button is displayed that, when
- clicked, uses your default web browser to download a zip file containing
- the latest version of CodeSnip†. You can then
- close CodeSnip and install the updated program from the installer
- contained in the zip file.
-
-
- If there is no new version‡, a message is displayed to
- that effect.
-
-
- Notes:
-
-
- † Should a download fail you can also get the latest version from
- CodeSnip's download web page.
-
-
- ‡ Only stable releases of CodeSnip are made available via
- this dialogue box. If you are interested trying any pre-release or beta
- versions, please check the CodeSnip News Feed which carries announcements of all such
- releases.
-
-
- By default CodeSnip performs a check for program updates
- automatically from time to time. A pop-up notification window is displayed
- in the main window if an update is available. The notification includes
- a button that causes the update to be downloaded via the default browser,
- in an exactly similar way to this dialogue box. You can switch this
- automatic checking feature off, or change the frequency with which checks
- are made, by using the Updates tab of the Preferences dialogue box.
-
- Use this dialogue to specify any proxy server that you want
- CodeSnip to use when it accesses the internet. The dialogue is
- accessed from the Tools | Proxy Server menu option.
-
-
- To use a proxy server tick the User Proxy Server check box then
- provide the required information in the rest of the dialogue box.
-
-
-
- Server IP address – Enter the IP address of your server
- in dotted quad format, i.e. xxx.xxx.xxx.xxx where xxx is a number
- between 0 and 255.
-
-
- Port – Enter the number of the port used by the proxy
- server.
-
-
- User Name – Provide any user name you need to access the
- proxy server. This may be left blank if your server does not require a
- user name.
-
-
- Password – Enter any required password here. May be left
- blank if no password is required.
-
-
- Re-enter Password – If you entered a password above you
- should type it again here.
-
-
-
- If you wish to stop using a proxy server you should clear the Use
- proxy server check box.
-
-
- Click OK once you have entered the correct details. If a proxy
- server has been specified CodeSnip will use it whenever accessing
- the internet.
-
-
- Note:CodeSnip does not use this proxy when it
- displays web links in your default browser: you must configure your
- browser to use the required proxy server.
-
- This dialogue box is used to register CodeSnip.
-
-
- Note You do not have to register CodeSnip to
- use it. However, the author hopes you will register so that he knows that
- CodeSnip is being used and is worth maintaining.
-
-
- The dialogue takes the form of a multi-page wizard that gathers
- registration information and submits it online. You move through the
- pages by clicking the Next button and can return to a previous
- page using the Back button. The Cancel button closes
- the wizard without registering the application.
-
-
- First page
-
-
- This page simply displays some introductory text.
-
-
- Second page
-
-
- You use this page to provide information about yourself. All you need to
- provide is your name or a nickname.
-
-
- Third page
-
-
- Along with the information you have entered CodeSnip will have
- collected some information about itself and your operating system that it
- will send to the web server. All the information that will be sent is
- displayed on this page.
-
-
- If you are happy to send the information please make sure you are
- connected to the internet and click the Submit button.
-
-
- The program will now attempt to connect to delphidabbler.com and send the registration information. If the
- report is sent successfully the wizard's final page will be displayed.
- Should an error be detected an error message describing the problem will
- be displayed.
-
-
- If you have concerns about privacy, please read the privacy statement before submitting.
-
-
- Fourth page
-
-
- This page is shown when the registration has been successful. The
- program's registration code will be displayed in a box. This value
- is automatically stored by CodeSnip in its configuration file.
-
-
- You can now close the dialogue box by clicking the Finish button.
-
-
- Please note CodeSnip should be registered only once per computer,
- regardless of the number of users. If other users wish to join the mailing
- list they can do so using the Tools | Join Mailing List menu
- option.
-
+ This dialogue box is displayed at program start-up if CodeSnip
+ detects that Delphi compilers are installed on the user's system that have
+ not yet been registered for use by CodeSnip.
+
+
+ The available compilers are listed at the top of the dialogue box. Each
+ compiler has a check box to its left. You should tick this check box to
+ permit CodeSnip to register the compiler or leave it clear if you
+ don't want to register the compiler with CodeSnip.
+
+
+ Underneath the list of compilers are some instructions about how to
+ disable auto-registration of some or all compilers.
+
+
+ Once you have made your selection click the OK button to register
+ the selected compilers with CodeSnip. A message box will pop up
+ to confirm that the compilers have been registered.
+
+
+ Preventing automatic detection
+
+
+ You can prevent CodeSnip from checking for any
+ new compilers on startup in future by ticking the Don't show this
+ again check box before clicking OK.
+
+
+ If you change your mind startup checks can be re-enabled. Alternatively
+ you can exclude individual Delphi compilers from automatic detection.
+ For information about how to do this see Register Compilers with CodeSnip.
+
- Open Backup Dialogue Box
+ Open Backup File Dialogue Box
This Windows standard dialogue box is displayed when the Database |
Restore User Database menu option is selected. Use the dialogue to
- specify the name and location of the previously created backup file that
- contains the database to be restored.
+ specify the name and location of the backup file that contains the
+ database to be restored.
+
+
+ An error message will be displayed if the selected file is not a valid
+ backup file.
- Click OK restore the database. The existing user database will be
- overwritten.
+ Click OK to restore the backup. The existing user database will
+ be overwritten.
The dialogue box is used to save a custom syntax highlighter style.
Provide a name for the style in the Save current highlighter as
- combo box. You can overwrite an existing style by selecting its name from
+ combo box. You can overwrite any existing style by selecting its name from
the combo box's drop down list.
@@ -47,7 +44,7 @@
You can use a named style by selecting it in the
User Defined Highlighters dialogue box,
accessed from the Syntax Highlighter
- preferences tab.
+ preferences page's Use Named Style drop-down button.
diff --git a/Src/Help/HTML/dlg_saveinfo.htm b/Src/Help/HTML/dlg_saveinfo.htm
new file mode 100644
index 000000000..e35745cdb
--- /dev/null
+++ b/Src/Help/HTML/dlg_saveinfo.htm
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+
+ Save Snippet Information Dialogue Box
+
+
+
+
+
+
+
+ Save Snippet Information Dialogue Box
+
+
+ This dialogue box is displayed when the File | Save Snippet
+ Information menu option is clicked. It is used to specify the file
+ name, file type and encoding information for the snippet information
+ that is to be saved.
+
+
+ The dialogue is a standard Windows save dialogue box with a few added
+ options.
+
+
+ You specify the name and folder for the file where the snippet information
+ is to be written in in the usual way.
+
+
+ Use the Save as type drop down list to specify the type of file
+ to be saved. Options are:
+
+
+
Plain text.
+
HTML
+
XHTML
+
Rich text format
+
Markdown
+
+
+ The HTML 5 and XHTML options are very similar and differ only in the
+ type of HTML that is written. For either type an embedded CSS style
+ sheet is used to style the document.
+
+
+ When any of the HTML 5, XHTML or rich text file types are selected source
+ code embedded in the snippet information will be syntax highlighted if
+ the Use syntax highlighting check box is checked.
+
+
+ The output file encoding can be be specified in the File Encoding
+ drop down list. Options vary depending on the file type. Some file types
+ support only a single encoding. The encodings are:
+
+
+
+ ANSI Code Page nnn – ANSI encoding for the system default code page,
+ where nnn is the code page for the user's locale.
+ Available as an option for plain text and Markdown file formats.
+
+
+ UTF-8 – UTF-8 encoding, with BOM†.
+ Available as an option for plain text and Markdown file formats and
+ as the only encoding available for HTML 5 and XHTML file formats.
+
+
+ UTF-16 Little Endian – UTF-16 LE encoding, with
+ BOM†. Available as an option for plain text and Markdown file formats.
+
+
+ UTF-18 Big Endian – UTF-16 BE encoding, with
+ BOM†. Available as an option for plain text and Markdown file formats.
+
+
+ ASCII – The only encoding available for the rich text file.
+
+
+
+ The output can be previewed by clicking the Preview button. This
+ displays the snippet information in a dialogue box, formatted according to your
+ selections. Text in the preview can be selected and copied to the
+ clipboard if required.
+
+
+ Use the Save button to write the snippet information to disk or choose
+ Cancel to abort.
+
+
+ Warning: When plain text or Markdown formatted
+ snippet information is written in ANSI format it is possibe that the information
+ contains characters that can't be represented in the system default ANSI encoding.
+ If this happens a warning
+ dialogue box is displayed whenever the snippet information is written to file
+ or is previewed.
+
+
+ Footnote
+
+
+ † BOM = Byte Order Mark or Preamble: a sequence of bytes at the
+ start of a text file that identifies its encoding.
+
+
+
+
\ No newline at end of file
diff --git a/Src/Help/HTML/dlg_saveselection.htm b/Src/Help/HTML/dlg_saveselection.htm
index c3cd33d86..8d3ee9153 100644
--- a/Src/Help/HTML/dlg_saveselection.htm
+++ b/Src/Help/HTML/dlg_saveselection.htm
@@ -2,12 +2,9 @@
@@ -27,7 +24,7 @@
- Save Selection Dialogue Box
+ Save Selection Dialogue Box
This Windows standard dialogue box is displayed when the File | Save
@@ -40,8 +37,8 @@
Save as type drop-down list and chosing "All files".
- Click OK to confirm the selection. If the file aleady exists you
- will be prompted for permission to overwrite it. Note that if the
+ Click OK to confirm the save. If the chosen file aleady exists
+ you will be prompted for permission to overwrite it. Note that if the
"CodeSnip selection files" file type is selected and a file name
with no extension is entered then ".cssel" will be appended to
it.
diff --git a/Src/Help/HTML/dlg_savesnippet.htm b/Src/Help/HTML/dlg_savesnippet.htm
index dff0a2de8..3e8eba30a 100644
--- a/Src/Help/HTML/dlg_savesnippet.htm
+++ b/Src/Help/HTML/dlg_savesnippet.htm
@@ -2,12 +2,9 @@
@@ -68,21 +65,29 @@
- A Pascal include file (.inc) - The code is written to a file with
- extension *.inc that can be included in any Pascal source file.
+ A Pascal include file (.inc) – The code is written to a file with
+ extension .inc that can be included in any Pascal source file. The file
+ should be valid for inclusion in a Pascal unit using the
+ $INCLUDE (or $I) directive.
+
+
+ A plain text file (.txt) – This is the same as the Pascal include
+ file except that the extension is .txt rather than .inc.
- A plain text file (.txt) - This is the same as the Pascal include file
- except that the extension is .txt rather than .inc.
+ A HTML 5 file (.html) – This option writes the source code out as a
+ valid HTML 5 document that uses embedded CSS to format the code. The
+ source code will be syntax highlighted if the Use syntax
+ highlighting check box is checked.
- An HTML file (.html) - This option writes the source code out as a
- valid XHTML document that uses CSS to format the code. The document can
- be syntax highlighted if the Use syntax highlighting
- check box is checked.
+ An XHTML file (.html) – This option writes the source code out as a
+ valid XHTML document that uses embedded CSS to format the code. The
+ source code will be syntax highlighted if the Use syntax
+ highlighting check box is checked.
- A rich text file (.rtf) - The source code is written out as an RTF
+ A rich text file (.rtf) – The source code is written out as an RTF
document. Again syntax highlighting can be used if the Use syntax
highlighting check box is checked.
@@ -90,12 +95,44 @@
Snippet descriptions can be written as a Pascal comment to the output
file. Use the Comment style drop down list to specify the style
- of commenting to be used. Comments can be inhibited using by selecting the
- No comments option from the list. If the Truncate comments to
- 1st paragraph check box is ticked then only the first paragraph of
- the snippet's description is used. Clearing this check box means that all
- of the description is used.
+ of commenting to be used. Such comments can be inhibited by selecting the
+ No descriptive comments option from the list. If the Truncate
+ comments to 1st paragraph check box is ticked then only the first
+ paragraph of the snippet's description is used. Clearing this check box
+ means that the full text of the description is used.
+
+ The output file encoding can be be specified in the File Encoding
+ drop down list. Options vary depending on the file type. Some file types
+ support only a single encoding, in which case the drop down list will be
+ disabled. The encodings are:
+
+
+
+ ANSI Code Page nnn – ANSI encoding for the system default code page,
+ where nnn is the code page for the user's locale.
+ Available for both plain text and Pascal include files.
+
+
+ UTF-8 – UTF-8 encoding, with BOM†.
+ Available for both plain text and Pascal include files and as the only
+ option for HTML5 and XHTML files. If used for Pascal include files be warned that
+ the files will only compile with compilers that support Unicode source
+ files.
+
+
+ UTF-16 Little Endian – UTF-16 LE encoding, with
+ BOM†. Available for plain text files only.
+
+
+ UTF-18 Big Endian – UTF-16 BE encoding, with
+ BOM†. Available for plain text files only.
+
+
+ ASCII – ASCII encoding. Available as the only option for
+ rich text files.
+
+
The output can be previewed by clicking the Preview button. This
displays the source code in a dialogue box, formatted according to your
@@ -106,6 +143,13 @@
Use the Save button to write the file to disk or press
Cancel to abort.
+
+ Footnote
+
+
+ † BOM = Byte Order Mark or Preamble: a sequence of bytes at the
+ start of a text file that identifies its encoding.
+
This dialogue box is displayed when the File | Save Unit menu
option is clicked. It is used to specify the file name, file type and
- formatting information for the source code unit that is to be saved.
+ formatting information for the unit that is to be saved.
All currently selected snippets, with the exception of any
@@ -46,7 +43,7 @@
You specify the name and folder for the file where the unit will be saved
- in in the usual way. Note that the chosen file name, minus its extension
+ in in the usual way. Warning: the chosen file name, minus its extension
must be a valid Pascal unit name.
@@ -55,21 +52,27 @@
- A Pascal unit file (.pas) - The code is written to a file with
+ A Pascal unit file (.pas) – The code is written to a file with
extension .pas. The unit is given a name based on the file name.
- A plain text file (.txt) - This is the same as the Pascal unit file
- except that the extension is .txt rather than .pas.
+ A plain text file (.txt) – This is the same as the Pascal unit
+ file except that the extension is .txt rather than .pas.
+
+
+ A HTML 5 file (.html) – This option writes the source code out as a
+ valid HTML 5 document that uses embedded CSS to format the code. The
+ source code will be syntax highlighted if the Use syntax
+ highlighting check box is checked.
- An HTML file (.html) - This option writes the source code out as a
- valid XHTML document that uses CSS to format the code. The document can
- contain syntax highlighting if the Use syntax highlighting
- check box is checked.
+ An XHTML file (.html) – This option writes the source code out as a
+ valid XHTML document that uses embedded CSS to format the code. The
+ source code will be syntax highlighted if the Use syntax
+ highlighting check box is checked.
- A rich text file (.rtf) - The source code is written out as an RTF
+ A rich text file (.rtf) – The source code is written out as an RTF
document. Again syntax highlighting can be used if the Use syntax
highlighting check box is checked.
@@ -77,12 +80,44 @@
Each snippet's description can be written as a Pascal comment to the
output file. Use the Comment style drop down list to specify the
- style of commenting to be used. Comments can be inhibited using by
- selecting the No comments option from the list. If the
- Truncate comments to 1st paragraph check box is ticked then only
- the first paragraph of the snippet's description is used. Clearing this
- check box means that all of the description is used.
+ style of commenting to be used. Such comments can be inhibited by
+ selecting the No descriptive comments option from the list. If
+ the Truncate comments to 1st paragraph check box is ticked then
+ only the first paragraph of each snippet's description is used. Clearing
+ this check box means that the full text of snippet descriptions are used.
+
+ The output file encoding can be be specified in the File Encoding
+ drop down list. Options vary depending on the file type. Some file types
+ support only a single encoding, in which case the drop down list will be
+ disabled. The encodings are:
+
+
+
+ ANSI Code Page nnn – ANSI encoding for the system default code page,
+ where nnn is the code page for the user's locale.
+ Available for both plain text and Pascal unit files.
+
+
+ UTF-8 – UTF-8 encoding, with BOM†.
+ Available for both plain text and Pascal unit files and as the only
+ option for HTML 5 and XHTML files. If used for Pascal units be warned that the
+ unit will only compile with compilers that support Unicode source
+ files.
+
+
+ UTF-16 Little Endian – UTF-16 LE encoding, with
+ BOM†. Available for plain text files only.
+
+
+ UTF-18 Big Endian – UTF-16 BE encoding, with
+ BOM†. Available for plain text files only.
+
+
+ ASCII – ASCII encoding. Available as the only option for
+ rich text files.
+
+
The output can be previewed by clicking the Preview button. This
displays the source code in a dialogue box, formatted according to your
@@ -90,8 +125,15 @@
clipboard if required.
- Use the Save button to write the source code to disk or
- Cancel to abort.
+ Use the Save button to write the unit to disk or Cancel
+ to abort.
+
+
+ Footnote
+
+
+ † BOM = Byte Order Mark or Preamble: a sequence of bytes at the
+ start of a text file that identifies its encoding.
Click OK to confirm the selection. This will close the dialogue
- box and enter the selected file name into the edit box next the the
+ box and enter the selected file name into the edit box next to the
ellipsis button. If the selected file does not exist an error message will
be displayed and the dialogue box will not close.
- Click the Cancel to cancel the selection.
+ Click the Cancel button to cancel the selection.