Fix Markdown formatting issues in HotLabel docs

delphidabbler · delphidabbler · commit 4af0ff1045ab · 2023-05-07T02:45:08.000+01:00
diff --git a/HotLabel/2/API.md b/HotLabel/2/API.md
@@ -13,7 +13,7 @@ The _Hot Label Component_ is supplied in a single unit,  _PJHotLabel_.
 _PJHotLabel_ contains the following classes and other types. They are:
 
 | Type | Description |
-| -------- | --------- |
+|------|-------------|
 | _[TPJHotLabel](./API/TPJHotLabel.md)_ | The Hot Label Component itself. |
 | _[EPJURLError](./API/EPJURLError.md)_  | A custom exception that is raised by _[TPJHotLabel](./API/TPJHotLabel.md)_ when URL related errors are encountered. |
 | _TPJHLHintStyle_ | An enumeration of hint styles used by the _[HintStyle](./API/TPJHotLabel-HintStyle.md)_ property. See the property's documentation for details. |
diff --git a/HotLabel/2/API/EPJURLError.md b/HotLabel/2/API/EPJURLError.md
@@ -1,9 +1,9 @@
-# EPJURLError #
+# EPJURLError
 
 **Project:** [Hot Label Component](../API.md).
 
 **Unit:** _PJHotLabel_.
 
 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.
+_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
@@ -1,4 +1,4 @@
-# Caption property #
+# Caption property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property Caption: TCaption;
 ```
 
-## Description ##
+## Description
 
 This property specifies a text string that that may be displayed in the label.
 
@@ -22,4 +22,4 @@ If the _[ValidateURL](../API/TPJHotLabel-ValidateURL.md)_ and _[CaptionIsURL](..
 
 _Caption_'s behaviour with regard to accelerator characters and the ampersand (`&`) is identical to that of _TLabel_. See Delphi help for further information.
 
-The default value of the _Caption_ property is the default URL `http://localhost/`.
+The default value of the _Caption_ property is the default URL `http://localhost/`.
diff --git a/HotLabel/2/API/TPJHotLabel-CaptionIsURL.md b/HotLabel/2/API/TPJHotLabel-CaptionIsURL.md
@@ -1,4 +1,4 @@
-# CaptionIsURL property #
+# CaptionIsURL property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,12 +10,12 @@
 property CaptionIsURL: Boolean;
 ```
 
-## Description ##
+## Description
 
 The _CaptionIsURL_ property is used to determine whether the _[Caption](../API/TPJHotLabel-Caption.md)_ property displays the URL assigned to the _[URL](../API/TPJHotLabel-URL.md)_ property or whether it can display descriptive text.
 
 Set _CaptionIsURL_ to `True` to link the _[Caption](../API/TPJHotLabel-Caption.md)_ property to the _[URL](../API/TPJHotLabel-URL.md)_ property - so that assigning one property also assigns the other. This makes it easy to display a URL in the label without assigning two properties with the same value.
 
 Setting _CaptionIsURL_ to `False` enables any text to be assigned to the _[Caption](../API/TPJHotLabel-Caption.md)_ property. This permits descriptive text to be displayed in the label that accesses the separately stored URL when the label is clicked. **Tip:** to give the user visual feedback of the actual URL when the mouse hovers over the label set the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property to `hsURL`.
 
-The default value of _CaptionIsURL_ is `True`.
+The default value of _CaptionIsURL_ is `True`.
diff --git a/HotLabel/2/API/TPJHotLabel-Cursor.md b/HotLabel/2/API/TPJHotLabel-Cursor.md
@@ -1,4 +1,4 @@
-# Cursor property #
+# Cursor property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property Cursor: TCursor;
 ```
 
-## Description ##
+## Description
 
 _Cursor_ specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
 
@@ -20,4 +20,4 @@ The value of _Cursor_ is the index of the cursor in the list of cursors maintain
 
 The _Cursor_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ differs from the inherited property in that its default cursor is `crHandPoint` rather than `crDefault`.
 
-**Note:** Earlier versions of the component used a custom cursor named `crHand`. For backward compatibility this constant is defined in the _PJHotLabel_ unit to have the same value as `crHandPoint`.
+**Note:** Earlier versions of the component used a custom cursor named `crHand`. For backward compatibility this constant is defined in the _PJHotLabel_ unit to have the same value as `crHandPoint`.
diff --git a/HotLabel/2/API/TPJHotLabel-Font.md b/HotLabel/2/API/TPJHotLabel-Font.md
@@ -1,4 +1,4 @@
-# Font property #
+# Font property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property Font: TFont;
 ```
 
-## Description ##
+## Description
 
 _Font_ controls the attributes font used to display the label when it is not highlighted.
 
@@ -22,4 +22,4 @@ The default value of _[TPJHotLabel](../API/TPJHotLabel.md)_'s _Font_ property is
 
 Since the default font attributes are likely to be different to those of the inherited _Font_ property the _[ParentFont](../API/TPJHotLabel-ParentFont.md)_ property defaults to `False` rather than `True` in the ancestor property. This means that any change to the parent control's font will not be echoed in this component.
 
-Note that _Font_ is always used as the component's display font at design time.
+Note that _Font_ is always used as the component's display font at design time.
diff --git a/HotLabel/2/API/TPJHotLabel-HighlightFont.md b/HotLabel/2/API/TPJHotLabel-HighlightFont.md
@@ -1,4 +1,4 @@
-# HighlightFont property #
+# HighlightFont property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,12 +10,12 @@
 property HighlightFont: TFont;
 ```
 
-## Description ##
+## Description
 
 This property controls the appearance of the label when the mouse passes over it.
 
 A _[TPJHotLabel](../API/TPJHotLabel.md)_ can highlight its text when the mouse passes over the control. The font that is used to highlight the text is determined by the _HighlightFont_ property. The property defaults to the same font as the _[Font](../API/TPJHotLabel-Font.md)_ property but with the colour changed to `clRed`.
 
 Note that the highlighting only takes place when the _[HighlightURL](../API/TPJHotLabel-HighlightURL.md)_ property is `True`.
 
-It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow and shrink when the cursor passes over it. See the [highlighting example](../Examples/Example1.md) for details of two suitable designs.
+It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow and shrink when the cursor passes over it. See the [highlighting example](../Examples/Example1.md) for details of two suitable designs.
diff --git a/HotLabel/2/API/TPJHotLabel-HighlightURL.md b/HotLabel/2/API/TPJHotLabel-HighlightURL.md
@@ -1,4 +1,4 @@
-# HighlightURL property #
+# HighlightURL property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,10 +10,10 @@
 property HighlightURL: Boolean;
 ```
 
-## Description ##
+## Description
 
 _HighlightURL_ determines whether the label's text is highlighted when the mouse passes of the control.
 
 When this property is `True` the label's text is highlighted using the font defined by the _[HighlightFont](TPJHotLabelHighlightFont.md)_ property. When _HighlightURL_ is `False` the text is not highlighted and the _[HighlightFont](TPJHotLabelHighlightFont.md)_ property is ignored.
 
-This property is provided to maintain backward compatibility with previous versions of the component that did not support text highlighting. The default value of the property is `False` so that by default the control does not highlight its text.
+This property is provided to maintain backward compatibility with previous versions of the component that did not support text highlighting. The default value of the property is `False` so that by default the control does not highlight its text.
diff --git a/HotLabel/2/API/TPJHotLabel-Hint.md b/HotLabel/2/API/TPJHotLabel-Hint.md
@@ -1,4 +1,4 @@
-# Hint property #
+# Hint property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,8 +10,8 @@
 property Hint: string;
 ```
 
-## Description ##
+## Description
 
 _Hint_ contains a text string that can appear when the user moves the mouse over the control.
 
-With one exception, the _Hint_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ operates in the same way as the inherited property. The exception is that the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property can change the source of the hint's text. The hint text can be taken from the _[URL](../API/TPJHotLabel-URL.md)_ property or a custom value can be supplied by handling the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event. If the _[URL](../API/TPJHotLabel-URL.md)_ property value is used _Hint_ is ignored. If custom hints are used, the value of the _Hint_ property is supplied to the event handler for modification.
+With one exception, the _Hint_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ operates in the same way as the inherited property. The exception is that the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property can change the source of the hint's text. The hint text can be taken from the _[URL](../API/TPJHotLabel-URL.md)_ property or a custom value can be supplied by handling the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event. If the _[URL](../API/TPJHotLabel-URL.md)_ property value is used _Hint_ is ignored. If custom hints are used, the value of the _Hint_ property is supplied to the event handler for modification.
diff --git a/HotLabel/2/API/TPJHotLabel-HintStyle.md b/HotLabel/2/API/TPJHotLabel-HintStyle.md
@@ -1,4 +1,4 @@
-# HintStyle property #
+# HintStyle property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -13,16 +13,16 @@ type
 property HintStyle: TPJHLHintStyle;
 ```
 
-## Description ##
+## Description
 
 The _HintStyle_ property determines how the text displayed in the component's pop-up hint is derived. There are three possible sources of the hint text:
 
-| **Style** | **Notes** |
-|:----------|:----------|
+| Style | Notes |
+|:------|:------|
 | `hsNormal` | The pop-up hint displays as normal - i.e. the hint's text is taken from the _[Hint](../API/TPJHotLabel-Hint.md)_ property. |
 | `hsURL` | The pop-up hint displays the _[URL](../API/TPJHotLabel-URL.md)_ property value. The _[Hint](../API/TPJHotLabel-Hint.md)_ property is ignored. |
 | `hsCustom` | The user can specify a custom hint by handling the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event. See the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ topic for details of how the hint is set in the event handler. If the _[OnCustomHint](../API/TPJHotLabel-OnCustomHint.md)_ event is not handled then the hint's text comes from the _[Hint](../API/TPJHotLabel-Hint.md)_ property as normal. |
 
 Note that no pop-up hint will display unless hints are enabled. This is done by ensuring the inherited _ShowHint_ property is `True`.
 
-The default value of _HintStyle_ is `hsNormal`.
+The default value of _HintStyle_ is `hsNormal`.
diff --git a/HotLabel/2/API/TPJHotLabel-OnCustomHint.md b/HotLabel/2/API/TPJHotLabel-OnCustomHint.md
@@ -1,4 +1,4 @@
-# OnCustomHint event #
+# OnCustomHint event
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -15,12 +15,12 @@ type
 property OnCustomHint: TPJHLCustomHintEvent;
 ```
 
-## Description ##
+## Description
 
 _OnCustomHint_ is an event that enables the user to specify a custom hint to be displayed by the component.
 
 This event is triggered only when the _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ property is set to `hsCustom` and a hint is about to be displayed. Handling the event enables the user to specify the text that is displayed in the pop-up hint. The event handler is passed the current _[Hint](../API/TPJHotLabel-Hint.md)_ property value in the _HintStr_ parameter. Specify the hint text by setting _HintStr_ to the required value.
 
 If _[HintStyle](../API/TPJHotLabel-HintStyle.md)_ is `hsCustom` and the event is not handled then the value of the _[Hint](../API/TPJHotLabel-Hint.md)_ property is displayed as normal.
 
-See the [Using the OnCustomHint event](../Examples/Example2.md) example for one possible use of the _OnCustomHint_ event.
+See the [Using the OnCustomHint event](../Examples/Example2.md) example for one possible use of the _OnCustomHint_ event.
diff --git a/HotLabel/2/API/TPJHotLabel-ParentFont.md b/HotLabel/2/API/TPJHotLabel-ParentFont.md
@@ -1,4 +1,4 @@
-# ParentFont property #
+# ParentFont property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property ParentFont: Boolean;
 ```
 
-## Description ##
+## Description
 
 This property determines where a control looks for its font information.
 
@@ -20,4 +20,4 @@ Normally _ParentFont_ is set to `True` for all controls in order to ensure that
 
 Changing this component's _[Font](../API/TPJHotLabel-Font.md)_ property causes _ParentFont_ to be set to `False` automatically.
 
-The _ParentFont_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ defaults to `False` since the default attributes of the _[Font](../API/TPJHotLabel-Font.md)_ property differ from the parent control in order to make the hot-link stand out.
+The _ParentFont_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ defaults to `False` since the default attributes of the _[Font](../API/TPJHotLabel-Font.md)_ property differ from the parent control in order to make the hot-link stand out.
diff --git a/HotLabel/2/API/TPJHotLabel-TrackVisits.md b/HotLabel/2/API/TPJHotLabel-TrackVisits.md
@@ -1,4 +1,4 @@
-# TrackVisits property #
+# TrackVisits property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -12,10 +12,10 @@
 property TrackVisits: Boolean;
 ```
 
-## Description ##
+## 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.
 
 _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)_<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.
diff --git a/HotLabel/2/API/TPJHotLabel-URL.md b/HotLabel/2/API/TPJHotLabel-URL.md
@@ -1,4 +1,4 @@
-# URL property #
+# URL property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property URL: string;
 ```
 
-## Description ##
+## Description
 
 This property stores the URL that is to be accessed when the label is clicked. The default web browser or mail client are used to display the URL.
 
@@ -20,4 +20,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`<sup>[v2.0]</sup>  or `http://example.com/`<sup>[v2.2]</sup>
diff --git a/HotLabel/2/API/TPJHotLabel-ValidateURL.md b/HotLabel/2/API/TPJHotLabel-ValidateURL.md
@@ -1,4 +1,4 @@
-# ValidateURL property #
+# ValidateURL property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -10,7 +10,7 @@
 property ValidateURL: Boolean;
 ```
 
-## Description ##
+## Description
 
 This property determines whether the URL stored in the component is validated or not.
 
@@ -28,4 +28,4 @@ If validation fails a _[EPJURLError](../API/EPJURLError.md)_ exception is raised
 
 When the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ and _ValidateURL_ properties are both `True`, assigning text to the _[Caption](../API/TPJHotLabel-Caption.md)_ property also causes the text to be validated. This is because setting the _[Caption](../API/TPJHotLabel-Caption.md)_ property in this case automatically updates the _[URL](../API/TPJHotLabel-URL.md)_ property.
 
-The default property value is `True`.
+The default property value is `True`.
diff --git a/HotLabel/2/API/TPJHotLabel-Visited.md b/HotLabel/2/API/TPJHotLabel-Visited.md
@@ -1,4 +1,4 @@
-# Visited property #
+# Visited property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -12,7 +12,7 @@
 property Visited: Boolean;
 ```
 
-## Description ##
+## 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.
 
@@ -22,4 +22,4 @@ The property can also be set automatically each time the component's URL is navi
 
 Note that, unlike in a browser, the value of _Visited_ does not persist between program executions.
 
-† The component deems a URL to be "navigated to" if the label is clicked **and** the component was able to resolve the URL and execute it in a linked application such and a web browser. This is not a guarantee that the URL exists, only that the linked application could be started.
+† The component deems a URL to be "navigated to" if the label is clicked **and** the component was able to resolve the URL and execute it in a linked application such and a web browser. This is not a guarantee that the URL exists, only that the linked application could be started.
diff --git a/HotLabel/2/API/TPJHotLabel-VisitedFont.md b/HotLabel/2/API/TPJHotLabel-VisitedFont.md
@@ -1,4 +1,4 @@
-# VisitedFont property #
+# VisitedFont property
 
 **Project:** [Hot Label Component](../API.md).
 
@@ -12,12 +12,12 @@
 property VisitedFont: TFont;
 ```
 
-## Description ##
+## 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.
 
 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.
 
 The property defaults to the same font as the _[Font](../API/TPJHotLabel-Font.md)_ property but with the colour changed to `clBlue`.
 
-It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow or shrink when changing to and from the visited state or when highlighted.
+It is recommended that only the colour and certain styles of the font are altered and the font size and name remain unchanged so that the label does not grow or shrink when changing to and from the visited state or when highlighted.
diff --git a/HotLabel/2/API/TPJHotLabel.md b/HotLabel/2/API/TPJHotLabel.md
diff --git a/HotLabel/2/Examples/Example1.md b/HotLabel/2/Examples/Example1.md
diff --git a/HotLabel/2/Examples/Example2.md b/HotLabel/2/Examples/Example2.md
diff --git a/HotLabel/2/Examples/Example3.md b/HotLabel/2/Examples/Example3.md
