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

Author: delphidabbler

Docs/ReadMe.txt

@@ -132,6 +132,10 @@ code snippets.
 No files are written outside the folder where you copied the files and the
 registry is not modified.
 
+** WARNING: When updating an existing portable installation with a new version
+of CodeSnip it is important that you do not change or delete the AppData and
+UserData folders. If you do this you risk loosing your settings and/or database.
+
 
 Uninstallation
 ================================================================================

Src/FmAboutDlg.pas

@@ -196,7 +196,8 @@ implementation
   UMessageBox,
   UResourceUtils,
   UStrUtils,
-  UThemesEx;
+  UThemesEx,
+  UVersionInfo;
 
 {$R *.dfm}
 
@@ -424,49 +425,58 @@ procedure TAboutDlg.InitHTMLFrames;
       var
         IsDBAvalable: Boolean;
         IsMetaDataAvailable: Boolean;
-        IsLicenseInfomAvailable: Boolean;
+        IsLicenseInfoAvailable: Boolean;
+
+        function DBVersion: string;
+        var
+          Ver: TVersionNumber;
+        begin
+          Ver := fMetaData.GetVersion;
+          if Ver.V1 = 1 then
+            Result := '1'
+          else
+            Result := Ver;
+        end;
+
       begin
         // Resolve conditionally displayed block placeholders
         IsDBAvalable := Database.Snippets.Count(False) > 0;
         IsMetaDataAvailable := fMetaData.IsSupportedVersion
           and not fMetaData.IsCorrupt;
-        IsLicenseInfomAvailable := IsMetaDataAvailable
+        IsLicenseInfoAvailable := IsMetaDataAvailable
           and (fMetaData.GetLicenseInfo.Name <> '')
           and (fMetaData.GetCopyrightInfo.Date <> '')
           and (fMetaData.GetCopyrightInfo.Holder <> '');
         Tplt.ResolvePlaceholderHTML(
-          'DBAvailable',
-          TCSS.BlockDisplayProp(IsDBAvalable)
+          'DBAvailable', TCSS.BlockDisplayProp(IsDBAvalable)
+        );
+        Tplt.ResolvePlaceholderHTML(
+          'DBNotAvailable', TCSS.BlockDisplayProp(not IsDBAvalable)
         );
         Tplt.ResolvePlaceholderHTML(
-          'DBNotAvailable',
-          TCSS.BlockDisplayProp(not IsDBAvalable)
+          'MetaDataAvailable', TCSS.BlockDisplayProp(IsMetaDataAvailable)
         );
         Tplt.ResolvePlaceholderHTML(
-          'MetaDataAvailable',
-          TCSS.BlockDisplayProp(IsMetaDataAvailable)
+          'MetaDataNotAvailable', TCSS.BlockDisplayProp(not IsMetaDataAvailable)
         );
         Tplt.ResolvePlaceholderHTML(
-          'MetaDataNotAvailable',
-          TCSS.BlockDisplayProp(not IsMetaDataAvailable)
+          'LicenseInfoAvailable', TCSS.BlockDisplayProp(IsLicenseInfoAvailable)
         );
         Tplt.ResolvePlaceholderHTML(
-          'LicenseInfoAvailable',
-          TCSS.BlockDisplayProp(IsLicenseInfomAvailable)
+          'LicenseInfoAvailableInline',
+          TCSS.InlineDisplayProp(IsLicenseInfoAvailable)
         );
         Tplt.ResolvePlaceholderHTML(
           'LicenseInfoNotAvailable',
-          TCSS.BlockDisplayProp(not IsLicenseInfomAvailable)
+          TCSS.BlockDisplayProp(not IsLicenseInfoAvailable)
         );
 
-        // Rsolve content placeholders
+        // Resolve content placeholders
         Tplt.ResolvePlaceholderText(
-          'CopyrightYear',
-          fMetaData.GetCopyrightInfo.Date
+          'CopyrightYear', fMetaData.GetCopyrightInfo.Date
         );
         Tplt.ResolvePlaceholderText(
-          'CopyrightHolders',
-          fMetaData.GetCopyrightInfo.Holder
+          'CopyrightHolders', fMetaData.GetCopyrightInfo.Holder
         );
         Tplt.ResolvePlaceholderHTML(
           'DBLicense',
@@ -489,6 +499,7 @@ procedure TAboutDlg.InitHTMLFrames;
         Tplt.ResolvePlaceholderHTML(
           'TesterList', ContribListHTML(fMetaData.GetTesters)
         );
+        Tplt.ResolvePlaceholderText('Version', DBVersion);
       end
     );
   end;

Src/Help/HTML/snippet_class.htm

@@ -58,8 +58,7 @@ <h1>
     </ul>
     <p>
       <strong class="warning">Warning:</strong> It is an error to use this
-      snippet kind for records or classes that have no methods (for example pure
-      abstract classes) &ndash; use a <a
+      snippet kind for records or classes that have no method implementations (for example pure abstract classes) &ndash; use a <a
         href="snippet_type.htm"
       >simple type definition</a> snippet instead.
     </p>

Src/Res/HTML/dlg-about-database-tplt.html

@@ -46,7 +46,7 @@
       <a
         class="external-link"
         href="https://github.com/delphidabbler/code-snippets"
-      >Code Snippets Database</a> is a resource containing numerous fragments of useful Object Pascal code.
+      >Code Snippets Database</a> is a resource containing numerous fragments of useful Object Pascal code.<span style="<%LicenseInfoAvailableInline%>"> You are using version <%Version%>.</span>
     </p>
 
     <div style="<%DBAvailable%>">

Src/Res/HTML/dlg-dbupdate-intro-tplt.html

@@ -35,7 +35,7 @@
       First go to <a
         class="external-link"
         href="<%CSDBReleaseURL%>"
-      ><%CSDBReleaseURL%></a> and find the latest release of the database built for <em>CodeSnip</em> v4.16 and later. Look for a zip file whose name has the form <code>csdb416-v2.x.x.zip</code> where <code>2.x.x</code> is the database version number.
+      ><%CSDBReleaseURL%></a> and find the latest version 2 release of the database. Look for a zip file whose name has the form <code>csdb-v2.x.x-data.zip</code> where <code>2.x.x</code> is the database version number.
     </p>
 
     <p>

Src/Res/HTML/welcome-tplt.html

@@ -64,19 +64,12 @@ <h1>
 
       <div id="main-db" class="box">
         <div class="caption">
-          Code Snippets database
+          DelphiDabbler Code Snippets database
         </div>
         <div style="<%HaveMainDB%>">
           <div class="content">
-            There are <em><%MainDBCount%></em> snippets in the Code Snippets
-            database.
-          </div>
-          <div class="content">
-            <a
-              href="#"
-              class="command-link"
-              onclick="updateDbase();return false;"
-            >Check for updates</a>
+            There are <em><%MainDBCount%></em> snippets in the DelphiDabbler 
+            Code Snippets database.
           </div>
         </div>
         <div style="<%NoMainDB%>">
@@ -86,13 +79,17 @@ <h1>
               class="external-link"
             >DelphiDabbler Code Snippets Database</a> has not been
             installed.</em>
+            <a
+              href="help:TaskUpdateCSDB"
+              class="help-link"
+            >Learn more</a>
           </div>
           <div class="content">
             <a
               href="#"
               class="command-link"
               onclick="updateDbase();return false;"
-            >Download it now</a>
+            >Install it now</a>
           </div>
         </div>
 
@@ -204,5 +201,5 @@ <h1>
     </div>
 
   </body>
-  
+
 </html>

Src/UCSSUtils.pas

@@ -403,6 +403,13 @@   TCSS = record
     ///  <returns>string. Required CSS property.</returns>
     class function BlockDisplayProp(const Show: Boolean): string; static;
 
+    ///  <summary>Creates a CSS "display" property that causes its element to be
+    ///  either hidden or displayed as "inline".</summary>
+    ///  <param name="Show">Boolean [in] Flag indicating if block is to be
+    ///  displayed (True) or hidden (False).</param>
+    ///  <returns>string. Required CSS property.</returns>
+    class function InlineDisplayProp(const Show: Boolean): string; static;
+
     ///  <summary>Creates a CSS "overflow", "overflow-x" or overflow-y"
     ///  property.</summary>
     ///  <param name="Value">TCSSOverflowValue [in] Required overflow handling.
@@ -586,6 +593,14 @@ class function TCSS.HideBorderProp(const Side: TCSSSide): string;
   Result := BorderProp(Side, 0, cbsNone, clNone);
 end;
 
+class function TCSS.InlineDisplayProp(const Show: Boolean): string;
+const
+  // Map of flag onto required display style
+  BlockDisplayStyles: array[Boolean] of TCSSDisplayStyle = (cdsNone, cdsInline);
+begin
+  Result := DisplayProp(BlockDisplayStyles[Show]);
+end;
+
 class function TCSS.LengthList(const List: array of Integer;
   const LU: TCSSLengthUnit): string;
 var

Src/UVersionInfo.pas

@@ -30,6 +30,9 @@ interface
     Record representing the four fields of a version number.
   }
   TVersionNumber = record
+  strict private
+    ///  <summary>Converts version number to a string.</summary>
+    function ToString: string;
   public
     V1: Word;   // Major version number
     V2: Word;   // Minor version number
@@ -107,6 +110,12 @@   TVersionNumber = record
         @return Converted version number.
         @except EConvertError. raised if string in wrong format.
       }
+    class operator Implicit(Ver: TVersionNumber): string;
+      {Operator overload that performs implicit conversion of a version number
+      to a string in dotted quad format.
+        @param Ver [in] Version number to be converted.
+        @return Dotted quad string.
+      }
     class operator Explicit(Ver: TVersionNumber): TPJVersionNumber;
       {Operator overload that performs an explicit conversion of a
       TVersionNumber to a TPJVersionNumber (from PJVersionInfo unit).
@@ -269,7 +278,7 @@ class function TVersionInfo.SpecialBuildStr: string;
     @return Dotted quad string.
   }
 begin
-  Result := Format('%d.%d.%d.%d', [Ver.V1, Ver.V2, Ver.V3, Ver.V4]);
+  Result := Ver.ToString;
 end;
 
 class operator TVersionNumber.GreaterThan(Ver1, Ver2: TVersionNumber): Boolean;
@@ -327,6 +336,16 @@ function TVersionNumber.IsNull: Boolean;
   Result.V4 := Ver.V4;
 end;
 
+class operator TVersionNumber.Implicit(Ver: TVersionNumber): string;
+  {Operator overload that performs implicit conversion of a version number to a
+  string in dotted quad format.
+    @param Ver [in] Version number to be converted.
+    @return Dotted quad string.
+  }
+begin
+  Result := Ver.ToString;
+end;
+
 class operator TVersionNumber.LessThan(Ver1, Ver2: TVersionNumber): Boolean;
   {Operator overload that compares two version numbers to check if first is
   less than second.
@@ -371,6 +390,11 @@ class function TVersionNumber.Nul: TVersionNumber;
   Result.V4 := 0;
 end;
 
+function TVersionNumber.ToString: string;
+begin
+  Result := Format('%d.%d.%d.%d', [V1, V2, V3, V4]);
+end;
+
 class function TVersionNumber.TryStrToVersionNumber(const S: string;
   out V: TVersionNumber): Boolean;
 var