|
| 1 | +# Change Log |
| 2 | + |
| 3 | +This is the change log for _DelphiDabbler PasHi_ and _PasHiGUI_. |
| 4 | + |
| 5 | +All notable changes to this project are documented in this file. |
| 6 | + |
| 7 | +This change log begins with the first ever pre-release version of what was then known as _PasH_. Releases are listed in reverse version number order. |
| 8 | + |
| 9 | +From release 2.0.0 the version numbering has attempted to adhere to the principles of [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 10 | + |
| 11 | +## Release 2.1.0 - 2021-09-22 |
| 12 | + |
| 13 | +This release includes _PasHi_ v2.1.0 and _PasHiGUI_ v1.1.0. Change are as follows: |
| 14 | + |
| 15 | +### PasHi v2.1.0 [build 12] |
| 16 | + |
| 17 | +* Implemented a blacklist of commands that can't be included in the `config` file and halt the program with an error when such commands are detected. Only the `help` command is so blacklisted. |
| 18 | +* Added new `--viewport` command that can write a mobile-friendly meta tag to the `<head>` section of complete (X)HTML documents. |
| 19 | +* Added new `--edge-compatibility` command that can write a `http-equiv=X-UA-Compatible` meta tag for Microsoft Edge to the `<head>` section of complete (X)HTML documents. |
| 20 | +* Added new facility to emit warning message for deprecated items. |
| 21 | +* Added new `--verbosity no-warn` option to suppress warning messages. |
| 22 | +* Flagged various v1 compatibility options as deprecated and generated warnings for most. |
| 23 | +* Deprecated intermixing of input file names with commands in favour of input file names having to be listed first. Warnings are generated when this intermixing is detected. |
| 24 | +* Improved code that ensures that HTML text elements are escaped correctly. |
| 25 | +* Updated text of help screen re changes. |
| 26 | +* Some refactoring |
| 27 | + |
| 28 | +### PasHiGUI v1.1.0 [build 6] |
| 29 | + |
| 30 | +* Updated Options pane to provide support for new `--viewport` and `--edge-compatibility` options. |
| 31 | +* Flagged deprecated commands and options as such in Options pane. |
| 32 | +* Changed about box to note that _PasHi_ v2.1.0 is required. |
| 33 | + |
| 34 | +### General |
| 35 | + |
| 36 | +* Updated user guide `UserGuide.html`: |
| 37 | + * with details of new commands. |
| 38 | + * re deprecation of certain commands / options. |
| 39 | + * fixed display issues on phones and tablets. |
| 40 | +* Converted license file to markdown format and renamed from `LICENSE` to `LICENSE.md`. |
| 41 | +* Converted this change log to markdown format, moved from `Docs` directory to project root and renamed from `ChangeLog.txt` to `CHANGELOG.md`. |
| 42 | +* Updated `config-template` comments: |
| 43 | + * flagged deprecated commands and parameters |
| 44 | + * noted fact that the `help` command can no longer be used in the `config` file |
| 45 | + * added details of new `viewport` and `edge-compatibility` commands |
| 46 | + * noted new command parameters |
| 47 | +* Commented all v1 CSS classes as deprecated in `.css` files. |
| 48 | + |
| 49 | +## Release 2.0.0 - 2016-09-22 |
| 50 | + |
| 51 | +This is a major release. Changes from v1.1.0 include the changes below along with all changes from releases 2.0 beta 1 and beta 2. |
| 52 | + |
| 53 | +### PasHi v2.0.0 [build 11] |
| 54 | + |
| 55 | +* Help screen text corrected and clarified. |
| 56 | +* Manifested program as being compatible with Windows Vista through to Windows 10 and updated program version number in manifest. |
| 57 | + |
| 58 | +### PasHiGUI v1.0.0 [build 5] |
| 59 | + |
| 60 | +* Main window size and position now persists between runs. |
| 61 | +* Hints are now displayed in main window. |
| 62 | +* Help menu option to display online help replaced with option to display user guide that is installed with the program. |
| 63 | +* Updates to About box: |
| 64 | + * Program version number and copyright details are now extracted from program resources instead of being hard coded. |
| 65 | + * The name of the license file was updated. |
| 66 | +* Fixed potential bug in synchronising visibility of Options Bar with state of Show/Hide Options Bar menu option and toolbar button. |
| 67 | +* Manifested program as being compatible with Windows Vista through to Windows 10. |
| 68 | + |
| 69 | +### General |
| 70 | + |
| 71 | +* Standardised format of version information for PasHi and PasHiGUI. |
| 72 | +* Programs now compiled with Delphi XE instead of Delphi. |
| 73 | +* Major overhaul of documentation including: |
| 74 | + * Former read-me HTML file was split into two documents: an HTML user guide named `UserGuide.html` that is installed with the programs and a read-me text file that is included with the installer in the program download. |
| 75 | + * All license information was consolidated in a new `LICENSE` file that is installed with the programs. This replaces `License.txt` and `SourceCodeLicenses.txt`. |
| 76 | + * Minor modification were made to license summary displayed by installer. |
| 77 | + * Many documents were updated re changes in v2 and were corrected and/or clarified. |
| 78 | +* Corrections were made to config file templates and some of the optionally installed CSS files. Some comments were also clarified. |
| 79 | +* Some code re-factored and commenting standardised. |
| 80 | + |
| 81 | +## Release 2.0-beta 2 - 2014-08-12 |
| 82 | + |
| 83 | +### PasHi v1.99.2 [build 10] (aka v2.0.0 beta 2) |
| 84 | + |
| 85 | +* Changed some parameters to `--encoding` command. |
| 86 | +* Fixed bug where blank source code lines were not being displayed by browsers. |
| 87 | +* Sign-on message now shows this is a v2.0.0 beta version. |
| 88 | + |
| 89 | +### PasHiGUI v0.99.2 [build 4] (aka v1.0.0 beta 2) |
| 90 | + |
| 91 | +* Removed descriptive text that was shown in main display when code fragments were displayed. |
| 92 | +* `--default-css` option is no longer hard wired: now user configured or taken from gui-config file. |
| 93 | +* Changed name of Help menu item that accesses online documentation. |
| 94 | +* Changed main icon to be same as PasHi. |
| 95 | +* Changed program title and caption to "PasHi GUI". |
| 96 | +* Main window now animates correctly when minimized to task bar. |
| 97 | +* Adjusted size of, and arrangement of controls on, option frame. |
| 98 | +* About box now shows this is a v1.0.0 beta version. |
| 99 | +* Some refactoring. |
| 100 | + |
| 101 | +### General |
| 102 | + |
| 103 | +* Updated documentation. |
| 104 | +* Some code refactoring and removed some redundant code. |
| 105 | +* Some tweaks to default CSS files to fix problem displaying colours on Blogger.com. |
| 106 | +* New simplified EULA: installer now displays a summary instead of the full license. |
| 107 | + |
| 108 | +## Release 2.0-beta 1 - 2011-04-11 |
| 109 | + |
| 110 | +### PasHi v1.99.1 [build 9] (aka v2.0.0 beta 1) |
| 111 | + |
| 112 | +* Improved Pascal syntax highlighter: |
| 113 | +* Now understands Delphi 2010 keywords and directives. |
| 114 | + * Support added for some context sensitive directives. |
| 115 | + * Reserved words prefixed with '&' now treated as identifiers. |
| 116 | +* New input handling: |
| 117 | + * Source files may now be in UTF-16 (LE and BE), UTF-8 or default ANSI. Unicode formats are detected using byte order mark. |
| 118 | + * Input source can now be read directly from files passed on command line in addition to standard input and clipboard. |
| 119 | + * Where more than one input file is specified, files are concatenated before highlighting, separated by user specified number of blank lines. |
| 120 | + * Input source code can optionally have leading and trailing blank lines removed. |
| 121 | +* Changes to generated XHTML files: |
| 122 | + * Output can now be in HTML 4 or HTML 5 in addition to XHTML and HTML fragments. |
| 123 | + * HTML file encoding is now user configurable and defaults to UTF-8. Byte order marks and HTML character set attributes are used as necessary. |
| 124 | + * User can specify language attribute of HTML output. |
| 125 | + * Source code can now be preceded by line numbers. |
| 126 | + * Alternate source code lines can now be styled differently. |
| 127 | + * Custom style sheets can now be used. They can be either embedded or external. |
| 128 | + * CSS class names changed but user can specify that old style names are used for compatibility with existing CSS code. |
| 129 | + * Document title can be changed. |
| 130 | + * "Branding" (comments or meta tags declaring PasHi as generator) can be inhibited. |
| 131 | + * Output file name can now be specified on command line as an alternative to using shell redirection. |
| 132 | + * HTML mark-up changed and requires some additional CSS classes to be defined. |
| 133 | +* Program now has full Unicode support. |
| 134 | +* Support for a `config` file added to allow program defaults to be configured. |
| 135 | +* Heavily revised command line options: |
| 136 | + * Many new commands to control new options. |
| 137 | + * Some new commands to reinstate program defaults that may have been overridden by config file. |
| 138 | + * All commands now have a long form beginning with double dashes. Some commands also have a short form comprising a single dash and a single letter. |
| 139 | + * Commands from earlier program versions retained but made into aliases to relevant new commands. |
| 140 | +* Help screen completely re-written. |
| 141 | +* Bug fixes: |
| 142 | + * Exceptions are no longer raised on checking clipboard when another program has it open. |
| 143 | + * Parser no longer crashes when unexpected characters are encountered in source code. |
| 144 | +* Significant refactoring of source code. |
| 145 | + |
| 146 | +### PasHiGUI v0.99.1 [build 3] (aka v1.0.0 beta 1) |
| 147 | + |
| 148 | +* Now requires PasHi v2 beta or later. |
| 149 | +* Now Unicode compatible. |
| 150 | +* UI changes: |
| 151 | + * "Source Code" tab removed from display: input source code is no longer displayed. |
| 152 | + * Options to be passed to PasHi can now be set in new "Options Side Bar" displayed at the right of the main window. The side bar can be shown or hidden as required. |
| 153 | + * "Fragments" tool button removed: this option is now set in Options side bar. |
| 154 | + * Status bar removed: hints and document type are no longer displayed. |
| 155 | + * A new styling is used to display HTML code fragments. |
| 156 | + * Menus and toolbar revised to reflect program changes. |
| 157 | + * Main window now constrained to a minimum size. |
| 158 | +* Multiple file names can now be passed to PasHi via file open dialog box or by dragging and dropping from Explorer. |
| 159 | +* Input files are now passed directly to the PasHi command line rather than being opened and sent to PasHi via a pipe. (Text from clipboard or drag/drop is still piped to PasHi). |
| 160 | +* Interaction with PasHi changed to permit user defined options to be passed on command line. |
| 161 | +* Options entered in Options Side Bar are persisted in PasHiGUI's own config file. |
| 162 | +* Errors returned from PasHi are now reported to user. |
| 163 | +* Online documentation can now be accessed from Help menu. |
| 164 | +* Some refactoring. |
| 165 | + |
| 166 | +### General |
| 167 | +* Recompiled PasHi and PasHiGUI with Delphi 2010. |
| 168 | +* Re-licensed source code: changed from Mozilla Public License v1.1 to v2.0. |
| 169 | +* New sample CSS style sheets and config template files. |
| 170 | +* New installer program that installs PasHi and its support files and provides options to: |
| 171 | + * Install PasHiGUI. |
| 172 | + * Install sample CSS and config templates files. |
| 173 | + * Add PasHi's install directory to the all-user system path. |
| 174 | +* Updated and expanded documentation. |
| 175 | + |
| 176 | +## Release 1.1.0 - 2010-02-15 |
| 177 | + |
| 178 | +### PasHi v1.0.1 [build 8] |
| 179 | + |
| 180 | +* Renamed PasH to PasHi to avoid clash with another open source project name PasH. |
| 181 | +* Rebuilt with Delphi 2006 instead of Delphi 7. Brings into line with PasHiGUI. |
| 182 | +* Updated documentation and merged in PasHiGUI docs. |
| 183 | + |
| 184 | +### PasHiGUI v0.1.1 Beta [build 2] |
| 185 | + |
| 186 | +* Added PasHiGUI (renamed from PasHGUI) to release. No longer to be released separately. |
| 187 | +* Merged documentation with PasHi |
| 188 | + |
| 189 | +> For before _PasHi_ release 1.1.0, listed below, _PasH_ and _PasHGUI_ (as they were then known) were released as separate products and are labelled as such. Releases 1.1.0 and above above have both programs as part of the main release. |
| 190 | +
|
| 191 | +## PasH Release 1.0 [build 7] - 2009-05-31 |
| 192 | + |
| 193 | +* Added new -hidecss switch to hide contents of `<style>` tag in HTML comments. Default is now not to hide contents. |
| 194 | +* Replaced on-the-fly generation of embedded style sheets for XHTML documents with a default style sheet read from resources. |
| 195 | +* Updated to use Delphi 2006 keyword and directives list instead of those from Delphi 7. |
| 196 | +* Replaced generic DelphiDabbler icon with custom PasH icon set. |
| 197 | +* Added Vista manifest. |
| 198 | +* Removed unnecessary compiler directives in units, i.e. those that replicate directives in project file. |
| 199 | +* Made localisable string literals into resource strings. |
| 200 | +* Fixed potential future bug in clipboard handling code. |
| 201 | + |
| 202 | +## PasH Release 0.1.5-beta [build 6] - 2007-03-10 |
| 203 | + |
| 204 | +* Heavily refactored main program and parameter handling code. |
| 205 | +* Invalid command line parameters now halt program with error message. |
| 206 | +* Cosmetic changes to help display. |
| 207 | +* Added new batch file to build program. |
| 208 | +* Changed to new end user license agreement for the executable program. The program remains open source. |
| 209 | + |
| 210 | +## PasHGUI Release 0.1.0-beta [build 1] - 2006-06-17 |
| 211 | + |
| 212 | +* Original beta release of PasHGUI as stand-alone program. Merged into main PasHi release at release 1.1.0. |
| 213 | + |
| 214 | +## PasH Release 0.1.4-beta [build 5] - 2006-04-17 |
| 215 | + |
| 216 | +* Corrected title tag written to XHTML documents. Previously referred to CodeSnip Database, now refers to PasH. |
| 217 | + |
| 218 | +## PasH Release 0.1.3-beta [build 4] - 2005-12-09 |
| 219 | + |
| 220 | +* Fixed bug that was causing program to crash when standard error output was redirected to a pipe when under control of an external program. |
| 221 | + |
| 222 | +## PasH Release 0.1.2-beta [build 3] - 2005-11-03 |
| 223 | + |
| 224 | +* Program now traps exceptions and displays error message before terminating rather than exceptions crashing program. |
| 225 | +* Documentation updated and changed to HTML from plain text. |
| 226 | +* Moved program from alpha to beta release status. |
| 227 | + |
| 228 | +## PasH Release 0.1.1-alpha [build 2] - 2005-06-04 |
| 229 | + |
| 230 | +* Made multi-line comments generate correctly formatted HTML when processed by syntax highlighter. |
| 231 | +* Corrected minor typo in help screen. |
| 232 | + |
| 233 | +## PasH Release 0.1.0-alpha [build 1] - 2005-05-28 |
| 234 | + |
| 235 | +* Original alpha version. |
0 commit comments