Skip to content

Commit 44a0181

Browse files
committed
Fix errors and inconsistencies in links in HotLabel
Some links fixed in commit 2f5f136 were broken. Other links had paths containing ../API/ when ./ would suffice. These were changed.
1 parent 00dcc90 commit 44a0181

17 files changed

+71
-71
lines changed

HotLabel/2/API/EPJURLError.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66

77
**Applies to:** ~>2.0
88

9-
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.
9+
Exceptions of this class are used to report URL related errors by _[TPJHotLabel](./TPJHotLabel.md)_. The exceptions are raised either when URLs fail validation or when default browsers or mail clients can't be started.
1010

1111
_EPJURLError_ inherits directly from _Exception_ and adds no new methods, properties or events.

HotLabel/2/API/TPJHotLabel-Caption.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,11 +16,11 @@ property Caption: TCaption;
1616

1717
This property specifies a text string that that may be displayed in the label.
1818

19-
Use _Caption_ to set the text displayed in the label. If the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ property is `True` then the _Caption_ and _[URL](../API/TPJHotLabel-URL.md)_ properties are equivalent, i.e. assigning a value to one will also assign the the same value to the other. This makes it easy to display the URL in the label itself. To display text on the label that is different to the URL make sure that the _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ property is `False`.
19+
Use _Caption_ to set the text displayed in the label. If the _[CaptionIsURL](./TPJHotLabel-CaptionIsURL.md)_ property is `True` then the _Caption_ and _[URL](./TPJHotLabel-URL.md)_ properties are equivalent, i.e. assigning a value to one will also assign the the same value to the other. This makes it easy to display the URL in the label itself. To display text on the label that is different to the URL make sure that the _[CaptionIsURL](./TPJHotLabel-CaptionIsURL.md)_ property is `False`.
2020

21-
For reasons of backward compatibilty with earlier versions of the component the default behaviour is for the _Caption_ property to display the URL (i.e. _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ is `True` by default).
21+
For reasons of backward compatibilty with earlier versions of the component the default behaviour is for the _Caption_ property to display the URL (i.e. _[CaptionIsURL](./TPJHotLabel-CaptionIsURL.md)_ is `True` by default).
2222

23-
If the _[ValidateURL](../API/TPJHotLabel-ValidateURL.md)_ and _[CaptionIsURL](../API/TPJHotLabel-CaptionIsURL.md)_ properties are both `True` then any text assigned to the _Caption_ property must be a valid URL or an exception will be raised.
23+
If the _[ValidateURL](./TPJHotLabel-ValidateURL.md)_ and _[CaptionIsURL](./TPJHotLabel-CaptionIsURL.md)_ properties are both `True` then any text assigned to the _Caption_ property must be a valid URL or an exception will be raised.
2424

2525
_Caption_'s behaviour with regard to accelerator characters and the ampersand (`&`) is identical to that of _TLabel_. See Delphi help for further information.
2626

HotLabel/2/API/TPJHotLabel-CaptionIsURL.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -14,10 +14,10 @@ property CaptionIsURL: Boolean;
1414

1515
## Description
1616

17-
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.
17+
The _CaptionIsURL_ property is used to determine whether the _[Caption](./TPJHotLabel-Caption.md)_ property displays the URL assigned to the _[URL](./TPJHotLabel-URL.md)_ property or whether it can display descriptive text.
1818

19-
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.
19+
Set _CaptionIsURL_ to `True` to link the _[Caption](./TPJHotLabel-Caption.md)_ property to the _[URL](./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.
2020

21-
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`.
21+
Setting _CaptionIsURL_ to `False` enables any text to be assigned to the _[Caption](./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](./TPJHotLabel-HintStyle.md)_ property to `hsURL`.
2222

2323
The default value of _CaptionIsURL_ is `True`.

HotLabel/2/API/TPJHotLabel-Cursor.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -20,6 +20,6 @@ Change the value of _Cursor_ to provide feedback to the user about what action i
2020

2121
The value of _Cursor_ is the index of the cursor in the list of cursors maintained by the global variable, _Screen_. In addition to the built-in cursors provided by _TScreen_, applications can add custom cursors to the list. See the inherited _Cursor_ property of _TControl_ for further details.
2222

23-
The _Cursor_ property of _[TPJHotLabel](../API/TPJHotLabel.md)_ differs from the inherited property in that its default cursor is `crHandPoint` rather than `crDefault`.
23+
The _Cursor_ property of _[TPJHotLabel](./TPJHotLabel.md)_ differs from the inherited property in that its default cursor is `crHandPoint` rather than `crDefault`.
2424

2525
**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`.

HotLabel/2/API/TPJHotLabel-Font.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,12 +16,12 @@ property Font: TFont;
1616

1717
_Font_ controls the attributes font used to display the label when it is not highlighted.
1818

19-
[~>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.
19+
[~>2.2] At run-time the _Font_ property is only displayed if the _[Visited](./TPJHotLabel-Visited.md)_ [~>2.2] property is `False`, otherwise the label's display font is that specified by the _[VisitedFont](./TPJHotLabel-VisitedFont.md)_ [~>2.2] property.
2020

2121
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.
2222

23-
The default value of _[TPJHotLabel](../API/TPJHotLabel.md)_'s _Font_ property is different from that of the inherited property: the font _Color_ defaults to `clNavy` and the font _Style_ defaults to `[fsUnderline]`. The other attributes are those of the parent control when the component was first dropped on the form.
23+
The default value of _[TPJHotLabel](./TPJHotLabel.md)_'s _Font_ property is different from that of the inherited property: the font _Color_ defaults to `clNavy` and the font _Style_ defaults to `[fsUnderline]`. The other attributes are those of the parent control when the component was first dropped on the form.
2424

25-
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.
25+
Since the default font attributes are likely to be different to those of the inherited _Font_ property the _[ParentFont](./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.
2626

2727
Note that _Font_ is always used as the component's display font at design time.

HotLabel/2/API/TPJHotLabel-HighlightFont.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,8 +16,8 @@ property HighlightFont: TFont;
1616

1717
This property controls the appearance of the label when the mouse passes over it.
1818

19-
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`.
19+
A _[TPJHotLabel](./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](./TPJHotLabel-Font.md)_ property but with the colour changed to `clRed`.
2020

21-
Note that the highlighting only takes place when the _[HighlightURL](../API/TPJHotLabel-HighlightURL.md)_ property is `True`.
21+
Note that the highlighting only takes place when the _[HighlightURL](./TPJHotLabel-HighlightURL.md)_ property is `True`.
2222

2323
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.

HotLabel/2/API/TPJHotLabel-HighlightURL.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,6 +16,6 @@ property HighlightURL: Boolean;
1616

1717
_HighlightURL_ determines whether the label's text is highlighted when the mouse passes of the control.
1818

19-
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.
19+
When this property is `True` the label's text is highlighted using the font defined by the _[HighlightFont](./TPJHotLabel-HighlightFont.md)_ property. When _HighlightURL_ is `False` the text is not highlighted and the _[HighlightFont](./TPJHotLabel-HighlightFont.md)_ property is ignored.
2020

2121
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.

HotLabel/2/API/TPJHotLabel-Hint.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,4 +16,4 @@ property Hint: string;
1616

1717
_Hint_ contains a text string that can appear when the user moves the mouse over the control.
1818

19-
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.
19+
With one exception, the _Hint_ property of _[TPJHotLabel](./TPJHotLabel.md)_ operates in the same way as the inherited property. The exception is that the _[HintStyle](./TPJHotLabel-HintStyle.md)_ property can change the source of the hint's text. The hint text can be taken from the _[URL](./TPJHotLabel-URL.md)_ property or a custom value can be supplied by handling the _[OnCustomHint](./TPJHotLabel-OnCustomHint.md)_ event. If the _[URL](./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.

HotLabel/2/API/TPJHotLabel-HintStyle.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -21,9 +21,9 @@ The _HintStyle_ property determines how the text displayed in the component's po
2121

2222
| Style | Notes |
2323
|:------|:------|
24-
| `hsNormal` | The pop-up hint displays as normal - i.e. the hint's text is taken from the _[Hint](../API/TPJHotLabel-Hint.md)_ property. |
25-
| `hsURL` | The pop-up hint displays the _[URL](../API/TPJHotLabel-URL.md)_ property value. The _[Hint](../API/TPJHotLabel-Hint.md)_ property is ignored. |
26-
| `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. |
24+
| `hsNormal` | The pop-up hint displays as normal - i.e. the hint's text is taken from the _[Hint](./TPJHotLabel-Hint.md)_ property. |
25+
| `hsURL` | The pop-up hint displays the _[URL](./TPJHotLabel-URL.md)_ property value. The _[Hint](./TPJHotLabel-Hint.md)_ property is ignored. |
26+
| `hsCustom` | The user can specify a custom hint by handling the _[OnCustomHint](./TPJHotLabel-OnCustomHint.md)_ event. See the _[OnCustomHint](./TPJHotLabel-OnCustomHint.md)_ topic for details of how the hint is set in the event handler. If the _[OnCustomHint](./TPJHotLabel-OnCustomHint.md)_ event is not handled then the hint's text comes from the _[Hint](./TPJHotLabel-Hint.md)_ property as normal. |
2727

2828
Note that no pop-up hint will display unless hints are enabled. This is done by ensuring the inherited _ShowHint_ property is `True`.
2929

HotLabel/2/API/TPJHotLabel-OnCustomHint.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -21,8 +21,8 @@ property OnCustomHint: TPJHLCustomHintEvent;
2121

2222
_OnCustomHint_ is an event that enables the user to specify a custom hint to be displayed by the component.
2323

24-
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.
24+
This event is triggered only when the _[HintStyle](./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](./TPJHotLabel-Hint.md)_ property value in the _HintStr_ parameter. Specify the hint text by setting _HintStr_ to the required value.
2525

26-
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.
26+
If _[HintStyle](./TPJHotLabel-HintStyle.md)_ is `hsCustom` and the event is not handled then the value of the _[Hint](./TPJHotLabel-Hint.md)_ property is displayed as normal.
2727

2828
See the [Using the OnCustomHint event](../Examples/Example2.md) example for one possible use of the _OnCustomHint_ event.

HotLabel/2/API/TPJHotLabel-ParentFont.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.0
1010

@@ -16,10 +16,10 @@ property ParentFont: Boolean;
1616

1717
This property determines where a control looks for its font information.
1818

19-
To have the component use the same font in its _[Font](../API/TPJHotLabel-Font.md)_ property as its parent control, set _ParentFont_ to `True`.
19+
To have the component use the same font in its _[Font](./TPJHotLabel-Font.md)_ property as its parent control, set _ParentFont_ to `True`.
2020

2121
Normally _ParentFont_ is set to `True` for all controls in order to ensure that all the controls on a form have a uniform appearance. For example, if _ParentFont_ is `True` for all controls in a form, changing the form's _Font_ property to 12 point Courier causes all controls on the form to use that font.
2222

23-
Changing this component's _[Font](../API/TPJHotLabel-Font.md)_ property causes _ParentFont_ to be set to `False` automatically.
23+
Changing this component's _[Font](./TPJHotLabel-Font.md)_ property causes _ParentFont_ to be set to `False` automatically.
2424

25-
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.
25+
The _ParentFont_ property of _[TPJHotLabel](./TPJHotLabel.md)_ defaults to `False` since the default attributes of the _[Font](./TPJHotLabel-Font.md)_ property differ from the parent control in order to make the hot-link stand out.

HotLabel/2/API/TPJHotLabel-TrackVisits.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
**Unit:** _PJHotLabel_.
66

7-
**Class:** _[TPJHotLabel](../API/TPJHotLabel.md)_
7+
**Class:** _[TPJHotLabel](./TPJHotLabel.md)_
88

99
**Applies to:** ~>2.2
1010

@@ -14,8 +14,8 @@ property TrackVisits: Boolean;
1414

1515
## Description
1616

17-
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.
17+
The component has the ability to detect when its URL is visited†, and to automatically set its _[Visited](./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](./TPJHotLabel-VisitedFont.md)_ [~>2.2] property.
1818

1919
_TrackVists_ determines whether this feature is enabled (`True`) or not (`False`). The default value is `False`.
2020

21-
† 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.
21+
† 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](./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.

0 commit comments

Comments
 (0)