Use twiddle wakkas to indicate minimum versions

delphidabbler · delphidabbler · commit 5a50d2640546 · 2023-05-07T03:04:11.000+01:00
Each API page was given and "Applies to: ~&gt;2.x" twiddle-wakka to
indicate the versions of HotLabel that apply to the page.

Replaced all v2.2 superscripts with "[~&gt;2.2]"

Removed supperscripting from dagger footnote symbols.

Some content changes to clarify version resitrictions.
diff --git a/HotLabel/2/API/EPJURLError.md b/HotLabel/2/API/EPJURLError.md
@@ -4,6 +4,8 @@
 
 **Unit:** _PJHotLabel_.
 
+**Applies to:** ~>2.0
+
 Exceptions of this class are used to report URL related errors by _[TPJHotLabel](../API/TPJHotLabel.md)_. The exceptions are raised either when URLs fail validation or when default browsers or mail clients can't be started.
 
 _EPJURLError_ inherits directly from _Exception_ and adds no new methods, properties or events.
diff --git a/HotLabel/2/API/TPJHotLabel-Caption.md b/HotLabel/2/API/TPJHotLabel-Caption.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property Caption: TCaption;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-CaptionIsURL.md b/HotLabel/2/API/TPJHotLabel-CaptionIsURL.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property CaptionIsURL: Boolean;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-Cursor.md b/HotLabel/2/API/TPJHotLabel-Cursor.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property Cursor: TCursor;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-Font.md b/HotLabel/2/API/TPJHotLabel-Font.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property Font: TFont;
 ```
@@ -14,7 +16,7 @@ property Font: TFont;
 
 _Font_ controls the attributes font used to display the label when it is not highlighted.
 
-<sup>[v2.2]</sup> At run-time the _Font_ property is only displayed if the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is `False`, otherwise the label's display font is that specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_<sup>[v2.2]</sup> property.
+[~>2.2] At run-time the _Font_ property is only displayed if the _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property is `False`, otherwise the label's display font is that specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_ [~>2.2] property.
 
 To change to a new font, specify a new _TFont_ object. To modify a font, change the value of the _Color_, _Height_, _Name_, _Pitch_, _Size_, or _Style_ of the _TFont_ object.
 
diff --git a/HotLabel/2/API/TPJHotLabel-HighlightFont.md b/HotLabel/2/API/TPJHotLabel-HighlightFont.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property HighlightFont: TFont;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-HighlightURL.md b/HotLabel/2/API/TPJHotLabel-HighlightURL.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property HighlightURL: Boolean;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-Hint.md b/HotLabel/2/API/TPJHotLabel-Hint.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property Hint: string;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-HintStyle.md b/HotLabel/2/API/TPJHotLabel-HintStyle.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 type
   TPJHLHintStyle = (hsNormal, hsURL, hsCustom);
diff --git a/HotLabel/2/API/TPJHotLabel-OnCustomHint.md b/HotLabel/2/API/TPJHotLabel-OnCustomHint.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 type
   TPJHLCustomHintEvent = procedure(
diff --git a/HotLabel/2/API/TPJHotLabel-ParentFont.md b/HotLabel/2/API/TPJHotLabel-ParentFont.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property ParentFont: Boolean;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-TrackVisits.md b/HotLabel/2/API/TPJHotLabel-TrackVisits.md
@@ -6,16 +6,16 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
-**Introduced:** v2.2
+**Applies to:** ~>2.2
 
 ```pascal
 property TrackVisits: Boolean;
 ```
 
 ## Description
 
-The component has the ability to detect when its URL is visited<sup>†</sup>, and to automatically set its _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property to `True` when that happens. This then changes the font used when the label is not highlighted to that specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_<sup>[v2.2]</sup> property.
+The component has the ability to detect when its URL is visited†, and to automatically set its _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property to `True` when that happens. This then changes the font used when the label is not highlighted to that specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_ [~>2.2] property.
 
 _TrackVists_ determines whether this feature is enabled (`True`) or not (`False`). The default value is `False`.
 
-† The component deems its URL to be visited if the label is clicked **and** the navigation to the URL succeeded. If the navigation fails the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is not set to `True`. When navigation to succeeds it does not mean the URL exists, it simply means that the component was able to resolve the URL and execute it in a linked application such and a web browser.
+† The component deems its URL to be visited if the label is clicked **and** the navigation to the URL succeeded. If the navigation fails the _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property is not set to `True`. When navigation to succeeds it does not mean the URL exists, it simply means that the component was able to resolve the URL and execute it in a linked application such and a web browser.
diff --git a/HotLabel/2/API/TPJHotLabel-URL.md b/HotLabel/2/API/TPJHotLabel-URL.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property URL: string;
 ```
@@ -20,4 +22,4 @@ When the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ property is `True`
 
 The URL can be displayed in the component's _[Hint](../API/TPJHotLabel-Hint.md)_ property by setting the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property to `hsURL`.
 
-The default value of this property is either `http://localhost`<sup>[v2.0]</sup>  or `http://example.com/`<sup>[v2.2]</sup>
+The default value of this property is either `http://localhost` [2.0 to ~>2.1.0]  or `http://example.com/` [~>2.2].
diff --git a/HotLabel/2/API/TPJHotLabel-ValidateURL.md b/HotLabel/2/API/TPJHotLabel-ValidateURL.md
@@ -6,6 +6,8 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
+**Applies to:** ~>2.0
+
 ```pascal
 property ValidateURL: Boolean;
 ```
diff --git a/HotLabel/2/API/TPJHotLabel-Visited.md b/HotLabel/2/API/TPJHotLabel-Visited.md
@@ -6,19 +6,19 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
-**Introduced:** v2.2
+**Applies to:** ~>2.2
 
 ```pascal
 property Visited: Boolean;
 ```
 
 ## Description
 
-This property indicates whether the label is in its "visited" state (`True`) or not (`False`). When _Visited_ is `True` the label is displayed using the font specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_<sup>[v2.2]</sup>, whenever the label is not highlighted. When the property is `False` the display font reverts to that given by the _[Font](../API/TPJHotLabel-Font.md)_ property.
+This property indicates whether the label is in its "visited" state (`True`) or not (`False`). When _Visited_ is `True` the label is displayed using the font specified by the _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_ [~>2.2], whenever the label is not highlighted. When the property is `False` the display font reverts to that given by the _[Font](../API/TPJHotLabel-Font.md)_ property.
 
 Writing the property changes the "visited" state. The default value is `False`.
 
-The property can also be set automatically each time the component's URL is navigated to. This feature is enabled by setting the _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_<sup>[v2.2]</sup> property to `True`.
+The property can also be set automatically each time the component's URL is navigated to. This feature is enabled by setting the _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_ [~>2.2] property to `True`.
 
 Note that, unlike in a browser, the value of _Visited_ does not persist between program executions.
 
diff --git a/HotLabel/2/API/TPJHotLabel-VisitedFont.md b/HotLabel/2/API/TPJHotLabel-VisitedFont.md
@@ -6,15 +6,15 @@
 
 **Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
 
-**Introduced:** v2.2
+**Applies to:** ~>2.2
 
 ```pascal
 property VisitedFont: TFont;
 ```
 
 ## Description
 
-_VisitedFont_ controls the attributes font used to display the label when the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is `True` and the label is not highlighted.
+_VisitedFont_ controls the attributes font used to display the label when the _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property is `True` and the label is not highlighted.
 
 To change to a new font, specify a new _TFont_ object. To modify a font, change the value of the _Color_, _Height_, _Name_, _Pitch_, _Size_, or _Style_ of the _TFont_ object.
 
diff --git a/HotLabel/2/API/TPJHotLabel.md b/HotLabel/2/API/TPJHotLabel.md
@@ -4,6 +4,8 @@
 
 **Unit:** _PJHotLabel_.
 
+**Applies to:** ~>2.0
+
 This component provides a label that can access a user-defined URL when clicked. The URL is displayed in the default browser or email client.
 
 In addition to the properties of _TLabel_, from which this component descends, additional properties for working with URLs are provided. The effect of some of _TLabel_'s properties is modified in _TPJHotLabel_.
@@ -45,10 +47,10 @@ _TPJHotLabel_ defines no new methods over and above those inherited from _TLabel
 | _[Hint](../API/TPJHotLabel-Hint.md)_ | Contains the text string that can appear when the user moves the mouse over the control. How _[Hint](../API/TPJHotLabel-Hint.md)_ is used depends on the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property. |
 | _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ | Determines the source of the text displayed in the component's hint. |
 | _[ParentFont](../API/TPJHotLabel-ParentFont.md)_ | Determines where the control looks for its font information. |
-| _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_<sup>[v2.2]</sup> | Determines whether or not the label automatically displays in its visible state when the user clicks the link. |
+| _[TrackVisits](../API/TPJHotLabel-TrackVisits.md) [~>2.2]_ | Determines whether or not the label automatically displays in its visible state when the user clicks the link. |
 | _[URL](../API/TPJHotLabel-URL.md)_ | Stores the URL that is to be accessed when the label is clicked. |
-| _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> | Determines whether or not the label is in its visited state. |
-| _[VisitedFont](../API/TPJHotLabel-VisitedFont.md)_<sup>[v2.2]</sup> | Specifies the label's font when in its visited state and not highlighted. |
+| _[Visited](../API/TPJHotLabel-Visited.md) [~>2.2]_ | Determines whether or not the label is in its visited state. |
+| _[VisitedFont](../API/TPJHotLabel-VisitedFont.md) [~>2.2]_ | Specifies the label's font when in its visited state and not highlighted. |
 | _[ValidateURL](../API/TPJHotLabel-ValidateURL.md)_ | Determines whether the URL stored in the component is validated or not. |
 
 ## Events
diff --git a/HotLabel/2/Examples/Example1.md b/HotLabel/2/Examples/Example1.md
@@ -1,5 +1,7 @@
 # Examples: Using Highlighting
 
+**Applies to:** ~>2.0
+
 These examples present two possible designs for _[TPJHotLabel](../API/TPJHotLabel.md)_ components that use text highlighting to indicate that the label is clickable.
 
 ## Example 1
diff --git a/HotLabel/2/Examples/Example2.md b/HotLabel/2/Examples/Example2.md
@@ -1,5 +1,7 @@
 # Examples: Using the OnCustomHint Event
 
+**Applies to:** ~>2.0
+
 These examples show how to use the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event of _[TPJHotLabel](../API/TPJHotLabel.md)_. We handle the event to display a hint containing some descriptive text along with the URL in brackets.
 
 ## Example 1
diff --git a/HotLabel/2/Examples/Example3.md b/HotLabel/2/Examples/Example3.md
@@ -1,14 +1,16 @@
-# Example: Tracking visits to URLs<sup>[v2.2]</sup>
+# Example: Tracking Visits to URLs
 
-The component provides the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property to enable visits to the URLs associated with hot label components to be tracked. Furthermore, the _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_<sup>[v2.2]</sup> property enables the tracking to be done automatically whenever the label is clicked and the underlying action completes successfully.
+**Applies to:** ~>2.2
 
-So, assuming we have a number of _[TPJHotLabel](../API/TPJHotLabel.md)_ components on a form, each of which has the _[URL](../API/TPJHotLabel-URL.md)_ property set to some valid URL and their _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_<sup>[v2.2]</sup> property set to `True` then simply by running the application and clicking a few links we will see that each label changes colour when visited.
+The component provides the _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property to enable visits to the URLs associated with hot label components to be tracked. Furthermore, the _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_ [~>2.2] property enables the tracking to be done automatically whenever the label is clicked and the underlying action completes successfully.
 
-However when the application is restarted we find that the tracking information is lost and all labels are reset to their un-visited state. This behaviour is to be epected because the _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> does not maintain state.
+So, assuming we have a number of _[TPJHotLabel](../API/TPJHotLabel.md)_ components on a form, each of which has the _[URL](../API/TPJHotLabel-URL.md)_ property set to some valid URL and their _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_ [~>2.2] property set to `True` then simply by running the application and clicking a few links we will see that each label changes colour when visited.
+
+However when the application is restarted we find that the tracking information is lost and all labels are reset to their un-visited state. This behaviour is to be epected because the _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] does not maintain state.
 
 In this example we will implement a scheme that persists the visited state of the hot label controls between executions.
 
-Start a new VCL forms application and drop a few _[TPJHotLabel](../API/TPJHotLabel.md)_ components on the form. Give each component's _[URL](../API/TPJHotLabel-URL.md)_ property a valid value and set all the component's _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_<sup>[v2.2]</sup> properties to `True`.
+Start a new VCL forms application and drop a few _[TPJHotLabel](../API/TPJHotLabel.md)_ components on the form. Give each component's _[URL](../API/TPJHotLabel-URL.md)_ property a valid value and set all the component's _[TrackVisits](../API/TPJHotLabel-TrackVisits.md)_ [~>2.2] properties to `True`.
 
 In this example we will use an ini file to persist the visited state of the hot label controls and we will use the hot label component's _Name_ property to uniquely identify the individual controls. If there is no ini file present we will assume that no hot labels have been visited.
 
@@ -35,7 +37,7 @@ begin
 end;
 ```
 
-This simply creates an ini file with the name given by _IniFileName_ (which we'll come back to) then loops across all components on the form and, whenever a _[TPJHotLabel](../API/TPJHotLabel.md)_ is found, writes its name and the value of its _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property to the ini file.
+This simply creates an ini file with the name given by _IniFileName_ (which we'll come back to) then loops across all components on the form and, whenever a _[TPJHotLabel](../API/TPJHotLabel.md)_ is found, writes its name and the value of its _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property to the ini file.
 
 Having recorded the information all we need to do is to read it in when the program starts and set the visited state of the required hot label components. We do this in the form's _OnCreate_ handler:
 
@@ -61,7 +63,7 @@ begin
 end;
 ```
 
-This code is the inverse of the code we used to write the file. It loops through every component as before, looking for hot label components. When it finds one it tries to read a value from the ini file that matches the component's name. If it finds the required value the component's _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is set to the value read from the ini file. If the component's name is not in the ini file then its _[Visited](../API/TPJHotLabel-Visited.md)_<sup>[v2.2]</sup> property is set to `False`. Note that this code works even if there is no ini file.
+This code is the inverse of the code we used to write the file. It loops through every component as before, looking for hot label components. When it finds one it tries to read a value from the ini file that matches the component's name. If it finds the required value the component's _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property is set to the value read from the ini file. If the component's name is not in the ini file then its _[Visited](../API/TPJHotLabel-Visited.md)_ [~>2.2] property is set to `False`. Note that this code works even if there is no ini file.
 
 That just leaves _IniFileName_. You can implement this as a function or method that returns the required file name. For example, you could store the file in the same directory as the executable by implementing _IniFileName_ as a private form method follows:
 
