Merge branch 'feature/finalise-docs-for-v4.16' into develop

Author: delphidabbler

Build.html

@@ -222,8 +222,15 @@ <h3>
 </h3>
 
 <p>
-  The Unicode version of the Inno setup command line compiler is needed to
-  create <em>CodeSnip</em>'s install program. v5.5.2(u) or later is required.
+  The Unicode version of the Inno Setup <strong>v5</strong> command line
+	compiler is needed to create <em>CodeSnip</em>'s install program. v5.5.2(u) or
+	later is required.
+</p>
+
+<p class="note">
+	<strong>Warning:</strong> 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
+	<em>CodeSnip</em> still does.
 </p>
 
 <p>
@@ -283,10 +290,6 @@ <h3>
   You do not need Zip if you do not intend to create release files.
 </p>
 
-<p class="note">
-  <strong>Note:</strong> You can use the Delphi IDE to edit the code and test compile it. However you will need to build the code from the makefile first to ensure all the required resource files and auto-generated files are present. If you change any resource files or type libraries you also need to re-run the makefile. Final builds should always be created using the makefile.
-</p>
-
 
 <h2>
   Preparation
@@ -538,6 +541,12 @@ <h4>
   <code>CodeSnip.exe</code>. You can rename the file manually.
 </p>
 
+<p>
+	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.
+</p>
+
 <p>
   Note that building with the make file insted of the IDE performs all the above
   steps automatically.

Docs/ReadMe.txt

@@ -144,7 +144,8 @@ Uninstalling the Standard Edition
 ---------------------------------
 
 CodeSnip can be uninstalled via "Apps and Features" (a.k.a. "Programs and
-Features", a.k.a. "Add / Remove Programs") from the Windows Control Panel or by choosing "Uninstall DelphiDabbler CodeSnip" from the program's start menu group.
+Features", a.k.a. "Add / Remove Programs") from the Windows Control Panel or by
+choosing "Uninstall DelphiDabbler CodeSnip" from the program's start menu group.
 
 Administrator privileges will be required to uninstall CodeSnip. Windows Vista
 to Windows 10 with UAC prompts enabled will prompt for an admin password if

README.md

@@ -7,7 +7,8 @@ A code bank designed with Pascal in mind.
 * [Support](#support)
 * [Source Code](#source-code)
 * [Change Log](#change-log)
-* [CodeSnip 5 Development](#codesnip-5-development) -- **frozen**
+* [License](#license)
+* [Bug Reports and Features](#bug-reports-and-features)
 
 ## Overview
 
@@ -21,41 +22,53 @@ CodeSnip requires Windows 2000 or later and Internet Explorer 6 or later, althou
 
 ## Installation
 
-CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
+The standard edition of CodeSnip is installed and removed using a standard Windows installer. Administrator privileges are required for installation.
+
+The portable edition has no installer. Simply follow the instructions in the [read me file](https://github.com/delphidabbler/codesnip/blob/master/Docs/ReadMe.txt) that is included in the download zip file.
 
 ## Support
 
-The following support is available for CodeSnip:
+The following support is available CodeSnip users:
 
 * A comprehensive help file.
 * A [read-me file](https://github.com/delphidabbler/codesnip/master/Docs/ReadMe.txt)<sup> *</sup> that discusses installation, configuration, updating and known issues.
-* An [FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md)
+* A [Using CodeSnip FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/UsingCodeSnip.md).
 * A [Blog](http://codesnip-app.blogspot.co.uk/).
 
 There's also plenty of info available on how to compile CodeSnip from source - see below.
 
 <sup>*</sup> These links take you to the most recent version of the documents -- they can change from release to release.
 
-
 ## Source Code
 
-Up to and including release 4.13.1 the project's source code was maintained in a Subversion repository on [SourceForge](https://sourceforge.net/p/codesnip/code/). The Subversion repo was converted to Git in October 2015 and imported to GitHub. All releases from v3.0.0 are marked by tags in the form `version-x.x.x` where `x.x.x` is the version number.
+CodeSnip's source code is maintained in the [`delphidabbler/codesnip`](https://github.com/delphidabbler/codesnip) Git repository on GitHub†.
+
+[Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology has been adopted, with the exception of some branches that have been used in abortive attempts to start work on CodeSnip 5.
+
+The following branches existed at the time when CodeSnip v4.16.0 was released:
+
+* `master`: Always reflects the state of the source code as of the latest release.‡
+* `develop`: Main development branch. The head of this branch contains the latest development code.
+* `pagoda`: An abortive attempt at developing CodeSnip 5. Work on this branch has halted. It does not follow GitFlow methodology. ***Do not use this branch: it may be pruned.***
+* `pavilion`: Another attempt at working on CodeSnip 5. It branched off `pagoda` and it's future is uncertain. Again it does not follow GitFlow methodology.
+
+New features and most bug fixes are worked on in `feature/xxxx` branches locally. They are merged into `develop` as they are completed and the branches are deleted.
 
-> Note that any branches that were created and deleted in the Subversion repo are missing from the Git history. So, for full details of the the project's history from v3.0.0 to v4.13.1 please refer to the old Subversion repo on SourceForge.
+**Note** that the default branch on GitHub is `develop` rather than `master`. This is because that's where all the work takes place. If you want to see the state of play at the last release make sure to switch to `master`.
 
-Following tag `version-4.13.1` the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology was adopted. The exception is the `pagoda` branch that sits outside Git Flow. This branch was originally planned to be the CodeSnip v5 development branch (see [below](#codesnip-5-development) for details).
+> † Up to and including v4.13.1 the source code was kept in a Subversion repository on SourceForge. It was converted to Git in October 2015 and imported into GitHub. All releases from v3.0.0 are marked by tags in the form `version-x.x.x` where `x.x.x` is the version number. None of the Subversion branches made it through the conversion to Git, so to see a full history look at the old [SourceForge repository](https://sourceforge.net/p/codesnip/code/).
 
-Up to and including release 4.13.1, `master` is simply a copy of the old Subversion `trunk` and, as such, contains various development commits along with numerous commits related to management of Subversion. After release 4.13.1, and the addition of this read-me file, `master` contains only commits relating to an actual release.
+> ‡ All the converted Subversion code was committed to `master`, making it a copy of the old Subversion `trunk`. As such `master` contains various development commits along with numerous commits related to management of Subversion. After release 4.13.1, and the the first commit of this read-me file, `master` contains only commits relating to actual releases.
 
 ### Contributions
 
-To contribute to the project please fork the repository on GitHub. Create a feature branch off the development branch. Make your changes to that branch then submit a pull request on GitHub.
+To contribute to the project please fork the repository on GitHub. Create a feature branch off the `develop` branch. Make your changes to the feature branch then submit a pull request via GitHub.
 
 ### Compiling
 
-`master` and each branch will have a file in the root directory named `Build.html` that gives detailed information about how to compile CodeSnip.
+`master` has a file in the root directory named [`Build.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Build.html) that gives detailed information about how to compile the current release of CodeSnip.
 
-There is also an [FAQ](https://github.com/delphidabbler/codesnip-faq) -- (see [Support](#support) above).
+There is also a [Compiling & Source Code FAQ](https://github.com/delphidabbler/codesnip-faq/blob/master/SourceCode.md).
 
 ## Change Log
 
@@ -65,7 +78,7 @@ The program's current change log can be found in the file `CHANGELOG.md` in the
 
 ## License
 
-The program's EULA, which gives full details of the license applying to the latest release, can be found in the file `Docs\License.html` in the `master` branch. The license has changed between releases, so if you need to see an older one, select the appropriate `version-x.x.x` tag and read the older version of the file.
+The program's EULA, which gives full details of the license applying to the latest release, can be found in the file [`Docs\License.html`](https://htmlpreview.github.io/?https://github.com/delphidabbler/codesnip/blob/master/Docs/License.html) in the `master` branch. The license has changed between releases, so if you need to see an older one, select the appropriate `version-x.x.x` tag and read the older version of the file.
 
 Most of the original code is made available under the [Mozilla Public License v2](https://www.mozilla.org/MPL/2.0/).
 

Src/CodeSnip.dpr

@@ -78,6 +78,8 @@ uses
   Favourites.UFavourites in 'Favourites.UFavourites.pas',
   Favourites.UPersist in 'Favourites.UPersist.pas',
   FirstRun.FmV4ConfigDlg in 'FirstRun.FmV4ConfigDlg.pas' {V4ConfigDlg},
+  FirstRun.FmWhatsNew in 'FirstRun.FmWhatsNew.pas' {WhatsNewDlg},
+  FirstRun.FmWhatsNew.FrHTML in 'FirstRun.FmWhatsNew.FrHTML.pas' {WhatsNewHTMLFrame: TFrame},
   FirstRun.UConfigFile in 'FirstRun.UConfigFile.pas',
   FirstRun.UDatabase in 'FirstRun.UDatabase.pas',
   FirstRun.UIniFile in 'FirstRun.UIniFile.pas',

Src/CodeSnip.dproj

@@ -83,6 +83,13 @@
 			<DCCReference Include="FirstRun.FmV4ConfigDlg.pas">
 				<Form>V4ConfigDlg</Form>
 			</DCCReference>
+			<DCCReference Include="FirstRun.FmWhatsNew.pas">
+				<Form>WhatsNewDlg</Form>
+			</DCCReference>
+			<DCCReference Include="FirstRun.FmWhatsNew.FrHTML.pas">
+				<Form>WhatsNewHTMLFrame</Form>
+				<DesignClass>TFrame</DesignClass>
+			</DCCReference>
 			<DCCReference Include="FirstRun.UConfigFile.pas"/>
 			<DCCReference Include="FirstRun.UDatabase.pas"/>
 			<DCCReference Include="FirstRun.UIniFile.pas"/>
@@ -566,7 +573,6 @@
 			<DCCReference Include="UXMLDocConsts.pas"/>
 			<DCCReference Include="UXMLDocHelper.pas"/>
 			<DCCReference Include="UXMLDocumentEx.pas"/>
-			<DCCReference Include="SWAG.UVersion.pas"/>
 			<None Include="CodeSnip.todo"/>
 			<BuildConfiguration Include="Base">
 				<Key>Base</Key>

Src/FirstRun.FmWhatsNew.FrHTML.dfm

@@ -0,0 +1,12 @@
+inherited WhatsNewHTMLFrame: TWhatsNewHTMLFrame
+  inherited pnlBrowser: TPanel
+    inherited wbBrowser: TWebBrowser
+      ControlData = {
+        4C000000A9200000641800000000000000000000000000000000000000000000
+        000000004C000000000000000000000001000000E0D057007335CF11AE690800
+        2B2E126208000000000000004C0000000114020000000000C000000000000046
+        8000000000000000000000000000000000000000000000000000000000000000
+        00000000000000000100000000000000000000000000000000000000}
+    end
+  end
+end

Src/FirstRun.FmWhatsNew.FrHTML.pas

@@ -0,0 +1,104 @@
+unit FirstRun.FmWhatsNew.FrHTML;
+
+interface
+
+uses
+  // VCL
+  OleCtrls,
+  SHDocVw,
+  Classes,
+  Controls,
+  ExtCtrls,
+  // Project
+  FrBrowserBase,
+  UCSSBuilder;
+
+
+type
+  TWhatsNewHTMLFrame = class(TBrowserBaseFrame)
+  strict protected
+    procedure BuildCSS(const CSSBuilder: TCSSBuilder); override;
+      {Generates CSS classes specific to this frame. This CSS is added
+      to that provided by parent class.
+        @param CSSBuilder [in] Object used to build the CSS code.
+      }
+  public
+    constructor Create(AOwner: TComponent); override;
+      {Object constructor. Sets up frame and initialises web browser.
+        @param AOwner [in] Component that owns the frame (must be a form).
+      }
+    procedure Initialise(const HTML: string);
+  end;
+
+
+implementation
+
+
+uses
+  // VCL
+  Graphics,
+  // Project
+  Browser.UUIMgr,
+  UCSSUtils,
+  UFontHelper;
+
+{$R *.dfm}
+
+
+{ TWhatsNewHTMLFrame }
+
+procedure TWhatsNewHTMLFrame.BuildCSS(const CSSBuilder: TCSSBuilder);
+var
+  CSSFont: TFont; // font used to set CSS properties
+begin
+  inherited;
+  CSSFont := TFont.Create;
+  try
+    TFontHelper.SetContentFont(CSSFont);
+    CSSFont.Size := CSSFont.Size + 2;
+    with CSSBuilder.AddSelector('body') do
+    begin
+      AddProperty(TCSS.FontProps(CSSFont));
+      AddProperty(TCSS.MarginProp(0, 8, 0, 8));
+    end;
+    with CSSBuilder.AddSelector('.lead') do
+    begin
+      AddProperty(TCSS.FontSizeProp(CSSFont.Size + 2));
+      AddProperty(TCSS.FontWeightProp(cfwBold));
+      AddProperty(TCSS.ColorProp($233bc2));
+    end;
+    // Sets paragraph margins and padding
+    with CSSBuilder.AddSelector('p') do
+    begin
+      AddProperty(TCSS.MarginProp(cssTop, 6));
+      AddProperty(TCSS.MarginProp(cssBottom, 0));
+      AddProperty(TCSS.PaddingProp(0));
+    end;
+    with CSSBuilder.AddSelector('ul') do
+    begin
+      AddProperty(TCSS.MarginProp(cssTop, 6));
+      AddProperty(TCSS.MarginProp(cssBottom, 0));
+      AddProperty(TCSS.PaddingProp(0));
+    end;
+    with CSSBuilder.AddSelector('li') do
+    begin
+      AddProperty(TCSS.MarginProp(cssTop, 6));
+    end;
+   finally
+    CSSFont.Free;
+  end;
+end;
+
+constructor TWhatsNewHTMLFrame.Create(AOwner: TComponent);
+begin
+  inherited;
+  WBController.UIMgr.ScrollbarStyle := sbsNormal;
+  WBController.UIMgr.AllowTextSelection := False;
+end;
+
+procedure TWhatsNewHTMLFrame.Initialise(const HTML: string);
+begin
+  WBController.IOMgr.LoadFromString(HTML);
+end;
+
+end.

Src/FirstRun.FmWhatsNew.dfm

@@ -0,0 +1,41 @@
+inherited WhatsNewDlg: TWhatsNewDlg
+  Caption = 'What'#39's New'
+  ExplicitWidth = 474
+  ExplicitHeight = 375
+  PixelsPerInch = 96
+  TextHeight = 13
+  inherited pnlBody: TPanel
+    inline frmHTML: TWhatsNewHTMLFrame
+      Left = 0
+      Top = 0
+      Width = 377
+      Height = 281
+      Align = alClient
+      TabOrder = 0
+      TabStop = True
+      ExplicitWidth = 377
+      ExplicitHeight = 281
+      inherited pnlBrowser: TPanel
+        Width = 377
+        Height = 281
+        ExplicitWidth = 377
+        ExplicitHeight = 281
+        inherited wbBrowser: TWebBrowser
+          Width = 377
+          Height = 281
+          ExplicitWidth = 377
+          ExplicitHeight = 281
+          ControlData = {
+            4C000000F72600000B1D00000000000000000000000000000000000000000000
+            000000004C000000000000000000000001000000E0D057007335CF11AE690800
+            2B2E126208000000000000004C0000000114020000000000C000000000000046
+            8000000000000000000000000000000000000000000000000000000000000000
+            00000000000000000100000000000000000000000000000000000000}
+        end
+      end
+    end
+  end
+  inherited btnHelp: TButton
+    Visible = False
+  end
+end