Revised text of intro page and styling of intro and finish pages of SWAG import wizard

Author: delphidabbler

Src/FmSWAGImportDlg.dfm

@@ -25,32 +25,24 @@ inherited SWAGImportDlg: TSWAGImportDlg
       object tsIntro: TTabSheet
         Caption = 'tsIntro'
         TabVisible = False
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
-        inline frmIntro: TFixedHTMLDlgFrame
+        inline frmIntro: THTMLTpltDlgFrame
           Left = 0
           Top = 0
           Width = 663
-          Height = 446
+          Height = 236
           Align = alTop
           TabOrder = 0
           TabStop = True
-          ExplicitWidth = 663
-          ExplicitHeight = 446
+          ExplicitLeft = 8
+          ExplicitTop = 8
           inherited pnlBrowser: TPanel
             Width = 663
-            Height = 446
-            ExplicitWidth = 663
-            ExplicitHeight = 446
             inherited wbBrowser: TWebBrowser
               Width = 663
-              Height = 446
-              ExplicitWidth = 663
-              ExplicitHeight = 446
+              ExplicitWidth = 320
+              ExplicitHeight = 240
               ControlData = {
-                4C00000086440000182E00000000000000000000000000000000000000000000
+                4C00000086440000641800000000000000000000000000000000000000000000
                 000000004C000000000000000000000001000000E0D057007335CF11AE690800
                 2B2E126208000000000000004C0000000114020000000000C000000000000046
                 8000000000000000000000000000000000000000000000000000000000000000
@@ -63,10 +55,6 @@ inherited SWAGImportDlg: TSWAGImportDlg
         Caption = 'tsFolder'
         ImageIndex = 4
         TabVisible = False
-        ExplicitLeft = 0
-        ExplicitTop = 27
-        ExplicitWidth = 0
-        ExplicitHeight = 425
         object lblFolder: TLabel
           Left = 0
           Top = 8
@@ -110,10 +98,6 @@ inherited SWAGImportDlg: TSWAGImportDlg
         Caption = 'tsCategories'
         ImageIndex = 1
         TabVisible = False
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
         object lblCategories: TLabel
           Left = 0
           Top = 45
@@ -186,10 +170,6 @@ inherited SWAGImportDlg: TSWAGImportDlg
         Caption = 'tsUpdate'
         ImageIndex = 2
         TabVisible = False
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
         object lblUpdateDesc: TLabel
           Left = 0
           Top = 3
@@ -232,16 +212,14 @@ inherited SWAGImportDlg: TSWAGImportDlg
         Caption = 'tsFinish'
         ImageIndex = 3
         TabVisible = False
-        ExplicitLeft = 0
-        ExplicitTop = 0
-        ExplicitWidth = 0
-        ExplicitHeight = 0
         inline frmOutro: THTMLTpltDlgFrame
           Left = 0
           Top = 0
           Width = 663
           Height = 446
           Align = alTop
+          DoubleBuffered = False
+          ParentDoubleBuffered = False
           TabOrder = 0
           TabStop = True
           ExplicitWidth = 663

Src/FmSWAGImportDlg.pas

@@ -44,6 +44,7 @@ interface
   FrHTMLTpltDlg,
   UBaseObjects,
   UContainers,
+  UCSSBuilder,
   SWAG.UCommon,
   SWAG.UImporter,
   SWAG.UReader, ActnList;
@@ -57,7 +58,6 @@   TSWAGImportDlg = class(TWizardDlg, INoPublicConstruct)
     tsIntro: TTabSheet;
     tsCategories: TTabSheet;
     lblCategories: TLabel;
-    frmIntro: TFixedHTMLDlgFrame;
     lbCategories: TListBox;
     lblCategoriesDesc: TLabel;
     lblSelectSnippets: TLabel;
@@ -78,6 +78,7 @@   TSWAGImportDlg = class(TWizardDlg, INoPublicConstruct)
     lblFolderPageInfo: TLabel;
     btnBrowse: TButton;
     actBrowse: TAction;
+    frmIntro: THTMLTpltDlgFrame;
     ///  <summary>Handles clicks on the check boxes next to snippets in the
     ///  snippet selection list box by selecting and deselecting snippets for
     ///  inclusion in the import.</summary>
@@ -150,6 +151,13 @@   TSWAGImportDlg = class(TWizardDlg, INoPublicConstruct)
     ///  <summary>Validates entries on the wizard page identified by the given
     ///  page index.</summary>
     procedure ValidatePage(const PageIdx: Integer);
+    ///  <summary>Handles HTML template frame's OnBuildCSS event. Adds
+    ///  additional CSS required by HTML in this form.</summary>
+    ///  <param name="Sender">TObject [in] Reference to object triggering event.
+    ///  </param>
+    ///  <param name="CSSBuilder">TCSSBuilder [in] Object used to construct the
+    ///  CSS.</param>
+    procedure BuildCSS(Sender: TObject; const CSSBuilder: TCSSBuilder);
     ///  <summary>Displays snippets selected for import in list view on Update
     ///  page.</summary>
     procedure PopulateImportsLV;
@@ -246,14 +254,17 @@ implementation
   FmPreviewDlg,
   FmWaitDlg,
   UBrowseForFolderDlg,
+  UColours,
   UConsts,
+  UCSSUtils,
   UCtrlArranger,
   UEncodings,
   UExceptions,
   UHTMLTemplate,
   UMessageBox,
   UStrUtils,
-  UWaitForThreadUI;
+  UWaitForThreadUI,
+  Web.UInfo;
 
 {$R *.dfm}
 
@@ -403,6 +414,21 @@ procedure TSWAGImportDlg.BeginPage(const PageIdx: Integer);
   end;
 end;
 
+procedure TSWAGImportDlg.BuildCSS(Sender: TObject;
+  const CSSBuilder: TCSSBuilder);
+begin
+  inherited;
+  // Set body text spacing
+  with CSSBuilder.Selectors['body'] do
+    AddProperty(TCSS.LineHeightProp(120));
+  // Create .framed border style
+  with CSSBuilder.AddSelector('.framed') do
+  begin
+    AddProperty(TCSS.BorderProp(cssAll, 1, cbsSolid, clBorder));
+    AddProperty(TCSS.PaddingProp(4));
+  end;
+end;
+
 procedure TSWAGImportDlg.clbSelectSnippetsClickCheck(Sender: TObject);
 var
   SelIdx: Integer;
@@ -440,6 +466,7 @@ procedure TSWAGImportDlg.ConfigForm;
 begin
   inherited;
   pcWizard.ActivePage := tsFinish;
+  frmOutro.OnBuildCSS := BuildCSS;
   frmOutro.Initialise(
     'dlg-swag-import-outro-tplt.html',
     procedure (Tplt: THTMLTemplate)
@@ -451,7 +478,17 @@ procedure TSWAGImportDlg.ConfigForm;
     end
   );
   pcWizard.ActivePage := tsIntro;
-  frmIntro.Initialise('dlg-swag-import-intro.html');
+  frmIntro.OnBuildCSS := BuildCSS;
+  frmIntro.Initialise(
+    'dlg-swag-import-intro-tplt.html',
+    procedure (Tplt: THTMLTemplate)
+    begin
+      Tplt.ResolvePlaceholderText(
+        'SWAGReleaseURL',
+        TWebInfo.SWAGReleaseURL
+      );
+    end
+  );
 end;
 
 destructor TSWAGImportDlg.Destroy;

Src/HTML.hrc

@@ -41,7 +41,7 @@ Res\HTML\dlg-activetext-preview-tplt.html
 Res\HTML\dlg-rssnews.html
 
 # SWAG import dialogue
-Res\HTML\dlg-swag-import-intro.html
+Res\HTML\dlg-swag-import-intro-tplt.html
 Res\HTML\dlg-swag-import-outro-tplt.html
 
 # code submission wizard

Src/Res/HTML/dlg-swag-import-intro-tplt.html

@@ -0,0 +1,63 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE html
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<!--
+ * 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) 2013, Peter Johnson (www.delphidabbler.com).
+ *
+ * $Rev$
+ * $Date$
+ *
+ * Introductory information displayed on the first page of the SWAG Import
+ * Wizard.
+-->
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+  <head>
+    <title>dlg-swag-import-intro.html</title>
+  </head>
+
+  <body>
+
+    <p>
+      This wizard enables you to import snippets from the <a
+        class="help-link"
+        href="help:AboutSWAG"
+      >SWAG database</a> into your local user database.
+    </p>
+
+    <p class="framed">
+      You must have a copy of a specially prepared version of SWAG on your local system before continuing. If you haven't already got it then you need to download it from the <em>delphidabbler/swag</em> repository on GitHub. Go to <a
+        class="external-link"
+        href="<%SWAGReleaseURL%>"
+      ><%SWAGReleaseURL%></a> and find the latest release of the XML version of SWAG. The file name will be in the form <code>swag-xml-vX.X.X</code> where <code>X.X.X</code> is the version number. Download the file and unzip it into a folder on your computer. Make a note of the folder's location - it will be needed in the next step.
+
+    <p>
+      On the next page of the wizard you will be asked for the location of the folder containing the SWAG database. <em>CodeSnip</em> will then open the database and display all SWAG's categories on the following page. From there you can browse and display the snippets in each category before selecting those you want to import. You get a chance to review these before importing.
+    </p>
+
+    <p>
+      All snippets are imported as <a
+        class="help-link"
+        href="help:SnippetFreeform"
+      >freeform</a>.
+    </p>
+
+    <p>
+      <em>CodeSnip</em> does not keep a track of snippets imported from SWAG &ndash; it treats them just like any other user defined snippet. This means it is possible to import the same snippet more than once. It's up to you to keep track of this.
+    </p>
+
+    <p>
+      <strong>Note:</strong> It can take quite some time to import snippets from SWAG. You are advised not to import more than about 20 snippets in one go. If you want to import a lot of snippets you should run this wizard more than once.
+    </p>
+
+  </body>
+
+</html>