From a8e85d4edd25ca9411472e8b2a4d19e0cc4d2fb6 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 27 Apr 2021 10:06:06 +0100 Subject: [PATCH] docs: update documentation --- docs/classes/Footnotes-Layout-Engine.html | 71 +++++----- docs/classes/Footnotes-Layout-Init.html | 31 +++-- docs/classes/Footnotes-Layout-Settings.html | 121 ++++++++++-------- docs/classes/Footnotes-Widget-Base.html | 25 +++- .../Footnotes-Widget-Reference-Container.html | 31 +++-- docs/packages/footnotes-admin-layout.html | 15 +++ docs/packages/footnotes-public-widget.html | 13 ++ docs/packages/footnotes.html | 10 -- 8 files changed, 200 insertions(+), 117 deletions(-) diff --git a/docs/classes/Footnotes-Layout-Engine.html b/docs/classes/Footnotes-Layout-Engine.html index 3605433..b18bbd1 100644 --- a/docs/classes/Footnotes-Layout-Engine.html +++ b/docs/classes/Footnotes-Layout-Engine.html @@ -80,6 +80,8 @@
@@ -100,7 +104,7 @@

Layout Engine for the administration dashboard.

@@ -121,6 +125,15 @@
+ +
+ subpackage +
+
+ +

admin_layout

+
+
@@ -359,7 +372,7 @@

Stores all Sections for the child sub page.

@@ -406,7 +419,7 @@

Stores the Hook connection string for the child sub page.

@@ -454,7 +467,7 @@ ull

The ID of this plugin.

@@ -514,7 +527,7 @@ ull

Output the Description of a section. May be overwritten in any section.

@@ -563,7 +576,7 @@ ull

Displays the content of specific sub page.

@@ -612,7 +625,7 @@ ull

Returns a Priority index. Lower numbers have a higher Priority.

@@ -661,7 +674,7 @@ ull

Registers all sections for a sub page.

@@ -710,7 +723,7 @@ ull

Registers a sub page.

@@ -759,7 +772,7 @@ ull

Returns the html tag for an input [type = checkbox].

@@ -820,7 +833,7 @@ ull

Returns the html tag for an input [type = text] with color selection class.

@@ -881,7 +894,7 @@ ull

Returns the html tag for an input/select label.

@@ -951,7 +964,7 @@ ull

Returns a line break to have a space between two lines.

@@ -1000,7 +1013,7 @@ ull

Returns an array describing a meta box.

@@ -1089,7 +1102,7 @@ ull

Returns a line break to start a new line.

@@ -1138,7 +1151,7 @@ ull

Returns the html tag for an input [type = num].

@@ -1237,7 +1250,7 @@ ull

Returns an array describing a sub page section.

@@ -1326,7 +1339,7 @@ ull

Returns the html tag for a select box.

@@ -1437,7 +1450,7 @@ ull

Returns a simple text inside html <span> text.

@@ -1498,7 +1511,7 @@ ull

Returns the html tag for an input [type = text].

@@ -1586,7 +1599,7 @@ ull

Returns the html tag for a text area.

@@ -1647,7 +1660,7 @@ ull

Returns an array of all registered meta boxes.

@@ -1696,7 +1709,7 @@ ull

Returns an array of all registered sections for a sub page.

@@ -1745,7 +1758,7 @@ ull

Returns the unique slug of the child sub page.

@@ -1794,7 +1807,7 @@ ull

Returns the title of the child sub page.

@@ -1843,7 +1856,7 @@ ull

Loads specific setting and returns an array with the keys [id, name, value].

@@ -1971,7 +1984,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Append javascript and css files for specific sub page.

@@ -2020,7 +2033,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Registers all Meta boxes for a sub page.

@@ -2081,7 +2094,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Save all Plugin settings.

diff --git a/docs/classes/Footnotes-Layout-Init.html b/docs/classes/Footnotes-Layout-Init.html index 630d032..9bec724 100644 --- a/docs/classes/Footnotes-Layout-Init.html +++ b/docs/classes/Footnotes-Layout-Init.html @@ -80,6 +80,8 @@
@@ -100,7 +104,7 @@

Handles the Settings interface of the Plugin.

@@ -121,6 +125,15 @@
+ +
+ subpackage +
+
+ +

admin_layout

+
+
@@ -210,7 +223,7 @@

Slug for the Plugin main menu.

@@ -267,7 +280,7 @@

The ID of this plugin.

@@ -323,7 +336,7 @@

Contains the settings layoutEngine

@@ -374,7 +387,7 @@

Class Constructor. Initializes all WordPress hooks for the Plugin Settings.

@@ -445,7 +458,7 @@

AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.

@@ -494,7 +507,7 @@

Registers the settings and initialises the settings page.

@@ -543,7 +556,7 @@

Registers the footnotes submenu page.

@@ -601,7 +614,7 @@

Load the required dependencies for this plugin.

diff --git a/docs/classes/Footnotes-Layout-Settings.html b/docs/classes/Footnotes-Layout-Settings.html index 2ee37de..e082a68 100644 --- a/docs/classes/Footnotes-Layout-Settings.html +++ b/docs/classes/Footnotes-Layout-Settings.html @@ -80,6 +80,8 @@
@@ -103,7 +107,7 @@

Displays and handles all Settings of the Plugin.

@@ -124,6 +128,15 @@
+ +
+ subpackage +
+
+ +

admin_layout

+
+
@@ -537,7 +550,7 @@

Stores all Sections for the child sub page.

@@ -584,7 +597,7 @@

Stores the Hook connection string for the child sub page.

@@ -632,7 +645,7 @@ ull

The ID of this plugin.

@@ -692,7 +705,7 @@ ull

Initialize the class and set its properties.

@@ -753,7 +766,7 @@ ull

Displays the AMP compatibility mode option.

@@ -813,7 +826,7 @@ ull

Displays the Custom CSS box.

@@ -913,7 +926,7 @@ list directly in the template, as CSS is in English anyway

Displays transitional legacy Custom CSS box.

@@ -962,7 +975,7 @@ list directly in the template, as CSS is in English anyway

Displays the new Custom CSS box.

@@ -1011,7 +1024,7 @@ list directly in the template, as CSS is in English anyway

Output the Description of a section. May be overwritten in any section.

@@ -1060,7 +1073,7 @@ list directly in the template, as CSS is in English anyway

Displays the content of specific sub page.

@@ -1109,7 +1122,7 @@ list directly in the template, as CSS is in English anyway

Displays all Donate button to support the developers.

@@ -1158,7 +1171,7 @@ list directly in the template, as CSS is in English anyway

Displays the footnotes in excerpt setting.

@@ -1242,7 +1255,7 @@ list directly in the template, as CSS is in English anyway

Returns a Priority index. Lower numbers have a higher Priority.

@@ -1291,7 +1304,7 @@ list directly in the template, as CSS is in English anyway

Displays all options for the fragment identifier configuration.

@@ -1351,7 +1364,7 @@ list directly in the template, as CSS is in English anyway

Displays a short introduction to the Plugin.

@@ -1417,7 +1430,7 @@ list directly in the template, as CSS is in English anyway

Displays all settings for the backlink symbol.

@@ -1539,7 +1552,7 @@ list directly in the template, as CSS is in English anyway

Displays the setting for the input label issue solution.

@@ -1588,7 +1601,7 @@ list directly in the template, as CSS is in English anyway

Displays available Hooks to look for Footnote short codes.

@@ -1683,7 +1696,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for 'I love Footnotes'.

@@ -1753,7 +1766,7 @@ define -1 as PHP_INT_MAX instead

Displays enabled status for the footnotes mouse-over box.

@@ -1823,7 +1836,7 @@ define -1 as PHP_INT_MAX instead

Displays style settings for the footnotes mouse-over box.

@@ -1872,7 +1885,7 @@ define -1 as PHP_INT_MAX instead

Displays dimensions setting for the footnotes mouse-over box.

@@ -1921,7 +1934,7 @@ define -1 as PHP_INT_MAX instead

Displays position settings for the footnotes mouse-over box.

@@ -1970,7 +1983,7 @@ define -1 as PHP_INT_MAX instead

Displays dedicated tooltip text settings for the footnotes mouse-over box.

@@ -2019,7 +2032,7 @@ define -1 as PHP_INT_MAX instead

Displays timing settings for the footnotes mouse-over box.

@@ -2068,7 +2081,7 @@ define -1 as PHP_INT_MAX instead

Displays truncation settings for the footnotes mouse-over box.

@@ -2117,7 +2130,7 @@ define -1 as PHP_INT_MAX instead

Displays all options for the footnotes numbering.

@@ -2166,7 +2179,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for the reference container.

@@ -2243,7 +2256,7 @@ define -1 as PHP_INT_MAX instead

Registers all sections for a sub page.

@@ -2292,7 +2305,7 @@ define -1 as PHP_INT_MAX instead

Registers a sub page.

@@ -2341,7 +2354,7 @@ define -1 as PHP_INT_MAX instead

Displays all options for the scrolling behavior.

@@ -2390,7 +2403,7 @@ define -1 as PHP_INT_MAX instead

Displays all options for the footnotes start and end tag short codes.

@@ -2521,7 +2534,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for the footnote referrers.

@@ -2591,7 +2604,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input [type = checkbox].

@@ -2652,7 +2665,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input [type = text] with color selection class.

@@ -2713,7 +2726,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input/select label.

@@ -2783,7 +2796,7 @@ define -1 as PHP_INT_MAX instead

Returns a line break to have a space between two lines.

@@ -2832,7 +2845,7 @@ define -1 as PHP_INT_MAX instead

Returns an array describing a meta box.

@@ -2921,7 +2934,7 @@ define -1 as PHP_INT_MAX instead

Returns a line break to start a new line.

@@ -2970,7 +2983,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input [type = num].

@@ -3069,7 +3082,7 @@ define -1 as PHP_INT_MAX instead

Returns an array describing a sub page section.

@@ -3158,7 +3171,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for a select box.

@@ -3269,7 +3282,7 @@ define -1 as PHP_INT_MAX instead

Returns a simple text inside html <span> text.

@@ -3330,7 +3343,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input [type = text].

@@ -3418,7 +3431,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for a text area.

@@ -3479,7 +3492,7 @@ define -1 as PHP_INT_MAX instead

Returns an array of all registered meta boxes for each section of the sub page.

@@ -3593,7 +3606,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Returns an array of all registered sections for the sub page.

@@ -3670,7 +3683,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Returns the unique slug of the sub page.

@@ -3719,7 +3732,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Returns the title of the sub page.

@@ -3768,7 +3781,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Loads specific setting and returns an array with the keys [id, name, value].

@@ -3896,7 +3909,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Append javascript and css files for specific sub page.

@@ -3945,7 +3958,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Registers all Meta boxes for a sub page.

@@ -4006,7 +4019,7 @@ Removing this did not fix the quotation mark backslash escapement bug.

Save all Plugin settings.

diff --git a/docs/classes/Footnotes-Widget-Base.html b/docs/classes/Footnotes-Widget-Base.html index cb28e3d..b248cc1 100644 --- a/docs/classes/Footnotes-Widget-Base.html +++ b/docs/classes/Footnotes-Widget-Base.html @@ -80,6 +80,8 @@
@@ -103,7 +107,7 @@

Base Class for all Plugin Widgets. Registers each Widget to WordPress.

@@ -136,6 +140,15 @@
+ +
+ subpackage +
+
+ +

public_widget

+
+
@@ -211,7 +224,7 @@

Class Constructor. Registers the child Widget to WordPress.

@@ -289,7 +302,7 @@

Returns the Description of the child widget.

@@ -338,7 +351,7 @@

Returns an unique ID as string used for the Widget Base ID.

@@ -387,7 +400,7 @@

Returns the Public name of child Widget to be displayed in the Configuration page.

@@ -436,7 +449,7 @@

Returns the width of the Widget. Default width is 250 pixel.

diff --git a/docs/classes/Footnotes-Widget-Reference-Container.html b/docs/classes/Footnotes-Widget-Reference-Container.html index 534dbdb..305c32a 100644 --- a/docs/classes/Footnotes-Widget-Reference-Container.html +++ b/docs/classes/Footnotes-Widget-Reference-Container.html @@ -80,6 +80,8 @@
@@ -103,7 +107,7 @@

Registers a Widget to put the Reference Container to the widget area.

@@ -124,6 +128,15 @@
+ +
+ subpackage +
+
+ +

public_widget

+
+
@@ -222,7 +235,7 @@

The ID of this plugin.

@@ -282,7 +295,7 @@

Initialize the class and set its properties.

@@ -343,7 +356,7 @@

Outputs the Settings of the Widget.

@@ -405,7 +418,7 @@

Outputs the Content of the Widget.

@@ -475,7 +488,7 @@

Returns the Description of the child widget.

@@ -525,7 +538,7 @@

Returns an unique ID as string used for the Widget Base ID.

@@ -574,7 +587,7 @@

Returns the Public name of the Widget to be displayed in the Configuration page.

@@ -623,7 +636,7 @@

Returns the width of the Widget. Default width is 250 pixel.

diff --git a/docs/packages/footnotes-admin-layout.html b/docs/packages/footnotes-admin-layout.html index f4fa063..9fd6a23 100644 --- a/docs/packages/footnotes-admin-layout.html +++ b/docs/packages/footnotes-admin-layout.html @@ -88,6 +88,21 @@ +

+ Interfaces, Classes and Traits + +

+ +
+ +
Footnotes_Layout_Engine
+
Layout Engine for the administration dashboard.
+
Footnotes_Layout_Init
+
Handles the Settings interface of the Plugin.
+
Footnotes_Layout_Settings
+
Displays and handles all Settings of the Plugin.
+ +
diff --git a/docs/packages/footnotes-public-widget.html b/docs/packages/footnotes-public-widget.html index 473e5ff..76f02e8 100644 --- a/docs/packages/footnotes-public-widget.html +++ b/docs/packages/footnotes-public-widget.html @@ -88,6 +88,19 @@ +

+ Interfaces, Classes and Traits + +

+ +
+ +
Footnotes_Widget_Base
+
Base Class for all Plugin Widgets. Registers each Widget to WordPress.
+
Footnotes_Widget_Reference_Container
+
Registers a Widget to put the Reference Container to the widget area.
+ +
diff --git a/docs/packages/footnotes.html b/docs/packages/footnotes.html index fbb3020..1614c97 100644 --- a/docs/packages/footnotes.html +++ b/docs/packages/footnotes.html @@ -105,12 +105,6 @@
Footnotes_WYSIWYG
Handles the WSYIWYG-Buttons.
-
Footnotes_Layout_Engine
-
Layout Engine for the administration dashboard.
-
Footnotes_Layout_Init
-
Handles the Settings interface of the Plugin.
-
Footnotes_Layout_Settings
-
Displays and handles all Settings of the Plugin.
Footnotes_Config
Contains all Plugin Constants. Contains no Method or Property.
Footnotes_Convert
@@ -119,10 +113,6 @@
Loads the settings values, sets to default values if undefined.
Footnotes_Template
Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
-
Footnotes_Widget_Base
-
Base Class for all Plugin Widgets. Registers each Widget to WordPress.
-
Footnotes_Widget_Reference_Container
-
Registers a Widget to put the Reference Container to the widget area.
Footnotes_Parser
Searches and replaces the footnotes and generates the reference container.