Merge branch 'about'

delphidabbler · delphidabbler · commit 223f5ccc6238 · 2023-05-10T12:35:13.000+01:00
diff --git a/AboutBox/3.6/API.md b/AboutBox/3.6/API.md
@@ -0,0 +1,45 @@
+# [About Box Component](../index.md) Programmers' Guide
+
+**Applies to:** ~>3.6
+
+## Introduction
+
+This section of the _About Box Component_ documentation describes the API exposed by the unit to programmers.
+
+## Contents
+
+### Units
+
+| Unit | Descriptions |
+|:-----|:-------------|
+| _PJAbout_ | The only unit in this project. Contains all the types and routines noted below. | 
+
+### Classes
+
+| Class | Descriptions |
+|:------|:-------------|
+| [_TPJAboutBoxDlg_](./API/TPJAboutBoxDlg.md) | The About Box component. |
+| _TPJAboutBoxForm_ | ⛔ The form class that implements the actual about box. This class **must not** be accessed directly and is not documented here. |
+
+### Enumerated Types 
+
+| Type | Descriptions |
+|:-----|:-------------|
+| _TPJAboutBtnPlacing_ | Determines horizontal placement of OK button in about dialog. This is the type of the [_ButtonPlacing_](./API/TPJAboutBoxDlg-ButtonPlacing.md) property. |
+| _TPJAboutBtnKinds_ | Determines caption of about dialog's OK button. This is the type of the [_ButtonKind_](./API/TPJAboutBoxDlg-ButtonKind.md) property. |
+| _TPJAboutBtnGlyphs_ | Determines what, if any, glyph is displayed on about dialog's OK button. This is the type of the [_ButtonGlyph_](./API/TPJAboutBoxDlg-ButtonGlyph.md) property. |
+| _TPJAboutPosition_ | Determines whether about dialog's position (centred or offset) is relative to screen, desktop or owning form. This is the type of the [_Position_](./API/TPJAboutBoxDlg-Position.md) property. |
+
+### Other
+
+| Item | Description |
+|:-----|:------------|
+| _Register_ | ⛔ Component registration routine, called by the Delphi IDE to register the component. **Do not call**. |
+ 
+## Conventions
+
+This documentation complies with [these conventions](../../common/conventions.md).
+
+## Links
+
+* [Overview](./Overview.md)
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonGlyph.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonGlyph.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ButtonGlyph: TPJAboutBtnGlyphs;
 
@@ -19,7 +21,7 @@ type TPJAboutBtnGlyphs = (
 The About box contains one button which is used to close the dialog box. The button can display a glyph (bitmap) to indicate its use. This property is used to determine which (if any) glyph to display. Valid values for the property and their meanings are as follows:
 
 |   Value   |   Meaning   |
-|-----------|-------------|
+|:----------|:------------|
 | _abgOK_ | A green check mark appears on the button face. |
 | _abgCancel_ | A red cross appears on the button face. |
 | _abgIgnore_ | A green man walking away appears on the button face. |
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonHeight.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonHeight.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ButtonHeight: Integer;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonKind.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonKind.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ButtonKind: TPJAboutBtnKinds;
 
@@ -19,7 +21,7 @@ type TPJAboutBtnKinds = (
 The About box contains one button which is used to close the dialog box. The button can display different text to indicate its use. The _ButtonKind_ property is used to determine which text to display. Valid values for the property and their meanings are as follows:
 
 |   Value   |   Text   |
-|-----------|----------|
+|:----------|:---------|
 | _abkOK_ | `OK` |
 | _abkDone_ | `Done` |
 | _abkClose_ | `Close` |
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonPlacing.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonPlacing.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ButtonPlacing: TPJAboutBtnPlacing;
 
@@ -17,7 +19,7 @@ type TPJAboutBtnPlacing = (abpLeft, abpCentre, abpRight);
 The About box contains one button which is used to close the dialog box. The button is positioned at the bottom of the dialog box, but can be aligned left, centre or right. The _ButtonPlacing_ property is used to determine which position the button occupies. Valid values for the property and their meanings are as follows:
 
 |   Value   |   Meaning   |
-|-----------|-------------|
+|:----------|:------------|
 | _abpLeft_ | Display the button at the bottom left of the dialog box. |
 | _abpCentre_ | Display the button at the bottom centre  of the dialog box. |
 | _abpRight_ | Display the button at the bottom right of the dialog box. |
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonWidth.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ButtonWidth.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ButtonWidth: Integer;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-CentreDlg.md b/AboutBox/3.6/API/TPJAboutBoxDlg-CentreDlg.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property CentreDlg: Boolean;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Copyright.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Copyright.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Copyright: string;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-DlgLeft.md b/AboutBox/3.6/API/TPJAboutBoxDlg-DlgLeft.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property DlgLeft: Integer;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-DlgTop.md b/AboutBox/3.6/API/TPJAboutBoxDlg-DlgTop.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property DlgTop: Integer;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Execute.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Execute.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 procedure Execute;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Font.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Font.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Font: TFont;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-HelpContext.md b/AboutBox/3.6/API/TPJAboutBoxDlg-HelpContext.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property HelpContext: THelpContext;
 
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Notes.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Notes.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Notes: string;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Position.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Position.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Position: TPJAboutPosition;
 
@@ -17,7 +19,7 @@ type TPJAboutPosition = (abpScreen, abpDesktop, abpOwner);
 The _Position_ property determines whether the [_CentreDlg_](./TPJAboutBoxDlg-CentreDlg.md), [_DlgTop_](./TPJAboutBoxDlg-DlgTop.md) and [_DlgLeft_](./TPJAboutBoxDlg-DlgLeft.md) properties act relative  to screen, desktop or owning form. Valid values for the property and their meanings are as follows:
 
 |   Value   |   Text   |
-|-----------|----------|
+|:----------|:---------|
 | _abpScreen_ | The dialog is positioned relative to the screen. |
 | _abpDesktop_ | The dialog is positioned relative to the desktop's work area (this takes into account the taskbar and toolbars). |
 | _abpOwner_ | The dialog is positioned relative to its owner - usually the form on which the component is dropped. If the component has no owner, or the owner is not a window control, then this setting has no effect and positioning is per _abpScreen_. |
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-ProgramName.md b/AboutBox/3.6/API/TPJAboutBoxDlg-ProgramName.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property ProgramName: string;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Title.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Title.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Title: string;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-UseOSStdFonts.md b/AboutBox/3.6/API/TPJAboutBoxDlg-UseOSStdFonts.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property UseOSStdFonts: Boolean;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-UseOwnerAsParent.md b/AboutBox/3.6/API/TPJAboutBoxDlg-UseOwnerAsParent.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property UseOwnerAsParent: Boolean;
 ```
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-Version.md b/AboutBox/3.6/API/TPJAboutBoxDlg-Version.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property Version: string;
 ```
@@ -16,4 +18,4 @@ The _Version_ property defines the version number (or other text) to appear on t
 
 The default value of this property is an empty string, which displays nothing.
 
-Note: If the [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) property is not nil then _Version_ is ignored.
+**Note**: If the [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) property is not nil then _Version_ is ignored.
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg-VersionInfo.md b/AboutBox/3.6/API/TPJAboutBoxDlg-VersionInfo.md
@@ -6,6 +6,8 @@
 
 **Class:** [_TPJAboutBoxDlg_](./TPJAboutBoxDlg.md)
 
+**Applies to:** ~>3.6
+
 ```pascal
 property VersionInfo: TPJVersionInfo;
 ```
@@ -14,12 +16,12 @@ property VersionInfo: TPJVersionInfo;
 
 This property allows information from a string information block in a program file's _VERSIONINFO_ resource to be displayed in the dialog box.
 
-To enable this to happen a [_TPJVersionInfo_](../../VerInfo/API/TPJVersionInfo.md) component must be placed on the form and this property must reference it. The _TPJVersionInfo_ component's [_FileName_](../../VerInfo/API/TPJVersionInfo-FileName.md) property must be set to the name of the executable file from which version information is to be extracted, or set to '' to get the version information of the parent executable file.
+To enable this to happen a [_TPJVersionInfo_](../../../VerInfo/3/API/TPJVersionInfo.md) component must be placed on the form and this property must reference it. The _TPJVersionInfo_ component's [_FileName_](../../../VerInfo/3/API/TPJVersionInfo-FileName.md) property must be set to the name of the executable file from which version information is to be extracted, or set to '' to get the version information of the parent executable file.
 
 The following table shows which version information string values are used, along with the properties whose values they replace:
 
 | _VERSIONINFO_ string  | Replaces property |
-|-----------------------|-------------------|
+|:----------------------|:------------------|
 | ProductName | [_ProgramName_](./TPJAboutBoxDlg-ProgramName.md) |
 | ProductVersion | [_Version_](./TPJAboutBoxDlg-Version.md) |
 | LegalCopyright | [_Copyright_](./TPJAboutBoxDlg-Copyright.md) |
diff --git a/AboutBox/3.6/API/TPJAboutBoxDlg.md b/AboutBox/3.6/API/TPJAboutBoxDlg.md
@@ -4,9 +4,11 @@
 
 **Unit:** _PJAbout_.
 
+**Applies to:** ~>3.6
+
 This non-visual component encapsulates an About Box in a non-visual component. It is displayed by calling its [_Execute_](./TPJAboutBoxDlg-Execute.md) method. It has string properties to display five different pieces of information in the about box. They are: [_Copyright_](./TPJAboutBoxDlg-Copyright.md), [_Notes_](./TPJAboutBoxDlg-Notes.md), [_ProgramName_](./TPJAboutBoxDlg-ProgramName.md), [_Title_](./TPJAboutBoxDlg-Title.md) and [_Version_](./TPJAboutBoxDlg-Version.md).
 
-Alternatively, the about box can display information from a _VERSIONINFO_ resource included in a program file. This is achieved by setting the [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) property to reference a [_TPJVersionInfo_](../../VerInfo/API/TPJVersionInfo.md) component which extracts the required version information from an executable file.
+Alternatively, the about box can display information from a _VERSIONINFO_ resource included in a program file. This is achieved by setting the [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) property to reference a [_TPJVersionInfo_](../../../VerInfo/3/API/TPJVersionInfo.md) component which extracts the required version information from an executable file.
 
 The application's icon is displayed in the dialog box. This is the icon specified by the _Icon_ property of the _TApplication_ object. If no icon has been specified for the application then default Delphi icon is used.
 
@@ -17,13 +19,13 @@ The [_HelpContext_](./TPJAboutBoxDlg-HelpContext.md) property allows Windows Hel
 ## Methods
 
 | Method | Description |
-|--------|-------------|
+|:-------|:------------|
 | [_Execute_](./TPJAboutBoxDlg-Execute.md) | Displays the about box. |
 
 ## Properties
 
 | Property | Description |
-|----------|-------------|
+|:---------|:------------|
 | [_ButtonGlyph_](./TPJAboutBoxDlg-ButtonGlyph.md) | Determines which, if any, glyph is displayed on the dialog's close button. |
 | [_ButtonHeight_](./TPJAboutBoxDlg-ButtonHeight.md) | Specifies the height of the dialog's close button. |
 | [_ButtonKind_](./TPJAboutBoxDlg-ButtonKind.md) | Determines the text displayed on the dialog's close button. |
@@ -42,7 +44,7 @@ The [_HelpContext_](./TPJAboutBoxDlg-HelpContext.md) property allows Windows Hel
 | [_UseOSStdFonts_](./TPJAboutBoxDlg-UseOSStdFonts.md) | Specifies whether the dialog box should use the system's default font. |
 | [_UseOwnerAsParent_](./TPJAboutBoxDlg-UseOwnerAsParent.md) | Determines if the dialog box should to be forced to be a child window of any owning control. |
 | [_Version_](./TPJAboutBoxDlg-Version.md) | The version number information to be displayed in the dialog box. |
-| [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) | Reference to any [_TPJVersionInfo_](../../VerInfo/API/TPJVersionInfo.md) component that provides the text displayed in the about box. |
+| [_VersionInfo_](./TPJAboutBoxDlg-VersionInfo.md) | Reference to any [_TPJVersionInfo_](../../../VerInfo/3/API/TPJVersionInfo.md) component that provides the text displayed in the about box. |
 
 ## Events
 
diff --git a/AboutBox/3.6/Overview.md b/AboutBox/3.6/Overview.md
@@ -0,0 +1,39 @@
+# [About Box Component](../index.md) Overview 
+
+**Applies to:** ~>3.6
+
+## Description
+
+> This page provides an overview of the features of the About Box Component. If you are looking for information on programming with the component please see the [Programmers' Guide](./API.md).
+
+This project provides a single non-visual component, [_TPJAboutBoxDlg_](./API/TPJAboutBoxDlg.md) that encapsulates an "About" dialogue box.
+
+When displayed the about box appears like this:
+
+![DelphiDabbler About Box component screenshot](./images/aboutbox.png)
+
+ -- _screen shot taken on Windows Vista_
+
+The text displayed in the about box can be set using properties exposed by the component, or can be extracted from version information using a linked DelphiDabbler _Version Information Component_.
+
+The dialogue's position can be specified relative to the screen, desktop or parent application. There is a single close button whose appearance and position can be customised. The about box also displays the program's icon. Finally, the dialogue box's font can be altered.
+
+### Required component
+
+In order to compile, _TPJAboutBoxDlg_ requires that a DelphiDabbler [_Version Information Component_](../../VerInfo/index.md) is installed.
+
+### Demo program
+
+A demo program is available that can be used to exercise the component.
+
+## Compatibility
+
+The component is believed to compile with any Delphi compiler from Delphi 2 through to 11.3. It is compatible with 32 bit and 64 bit Windows targets.
+
+This is a VCL component and so is not compatible with the FireMonkey framework.
+
+The component not suitable for compilation on platoforms other than Windows.
+
+## Links
+
+* [Programmers' Guide](./API.md).
diff --git a/AboutBox/3.6/images/aboutbox.png b/AboutBox/3.6/images/aboutbox.png
diff --git a/AboutBox/index.md b/AboutBox/index.md
@@ -0,0 +1,32 @@
+# About Box Component Documentation
+
+## Introduction
+
+This is the home page for the on-line documentation of the DelphiDabbler [About Box Component](https://delphidabbler.com/software/aboutbox) project.
+
+This project implements a single non-visual component that encapsulates an "About" dialogue box.
+
+The unit is:
+
+* Windows only
+* 32 & 64 bit compatible
+* VCL compatible
+* **Not** FireMonkey compatible
+
+## Supported Versions
+
+This documentation applies to About Box Component ~>3.6.
+
+> Versions 1, 2 and 3.0.0 to 3.5.1 are no longer supported and there is no documentation available.
+
+## Contents
+
+* [Overview](./3.6/Overview.md)
+* [Programmer's Guide](./3.6/API.md)
+
+## Links
+
+* Back to [Documentation Home Page](../index.md)
+* [About Box Component Web Page](https://delphidabbler.com/software/aboutbox)
+* [Releases](https://github.com/ddablib/aboutbox/releases)
+* [Source Code](https://github.com/ddablib/aboutbox)
diff --git a/Docs/AboutBox.md b/Docs/AboutBox.md
diff --git a/Docs/AboutBox/API.md b/Docs/AboutBox/API.md
diff --git a/Docs/AboutBox/Overview.md b/Docs/AboutBox/Overview.md
diff --git a/README.md b/README.md
diff --git a/index.md b/index.md
