From 4e4f0b0a2e035500944acdd403f0937f2596692c Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 27 Apr 2021 09:41:35 +0100 Subject: [PATCH] docs: update documentation --- docs/classes/Footnotes-Admin.html | 66 ++++- docs/classes/Footnotes-Config.html | 59 +---- docs/classes/Footnotes-Layout-Engine.html | 117 +++++++-- docs/classes/Footnotes-Layout-Init.html | 101 +++++++- docs/classes/Footnotes-Layout-Settings.html | 233 ++++++++++++++---- docs/classes/Footnotes-Loader.html | 70 +----- docs/classes/Footnotes-Public.html | 146 ++++++++++- docs/classes/Footnotes-WYSIWYG.html | 231 ++++++++++------- .../Footnotes-Widget-Reference-Container.html | 140 +++++++---- docs/classes/Footnotes.html | 28 ++- docs/files/src-footnotes.html | 6 +- docs/index.html | 6 +- docs/js/searchIndex.js | 67 +++-- docs/namespaces/default.html | 6 +- docs/packages/footnotes.html | 6 +- 15 files changed, 884 insertions(+), 398 deletions(-) diff --git a/docs/classes/Footnotes-Admin.html b/docs/classes/Footnotes-Admin.html index 6a623c5..5d2d554 100644 --- a/docs/classes/Footnotes-Admin.html +++ b/docs/classes/Footnotes-Admin.html @@ -141,7 +141,14 @@ and JavaScript.

-
+
+ $wysiwyg + +  : Footnotes_WYSIWYG +
+
The WYSIWYG editor integration object.
+ +
$plugin_name  : string @@ -203,6 +210,53 @@ and JavaScript.

+

+ $wysiwyg + + + +

+ + +

The WYSIWYG editor integration object.

+ + + public + Footnotes_WYSIWYG + $wysiwyg + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ +
+
class-footnotes-admin.php : - 47 + 55

Initialize the class and set its properties.

@@ -404,7 +458,7 @@ and JavaScript.

Register the JavaScript for the admin area.

@@ -453,7 +507,7 @@ and JavaScript.

Register the stylesheets for the admin area.

@@ -502,7 +556,7 @@ and JavaScript.

Appends the Plugin links for display in the dashboard Plugins page.

@@ -574,7 +628,7 @@ and JavaScript.

Load the required admin-specific dependencies.

diff --git a/docs/classes/Footnotes-Config.html b/docs/classes/Footnotes-Config.html index 389b7c4..6df4245 100644 --- a/docs/classes/Footnotes-Config.html +++ b/docs/classes/Footnotes-Config.html @@ -165,13 +165,6 @@
Public Plugin name for dashboard heading
-
- C_STR_PLUGIN_NAME - -  = 'footnotes' -
-
Internal Plugin name.
-
C_STR_PLUGIN_PUBLIC_NAME @@ -198,7 +191,7 @@

Html tag for the LOVE symbol.

@@ -240,7 +233,7 @@

HTML code for the 'love' symbol used in dashboard heading

@@ -282,7 +275,7 @@

Short code to DON'T display the 'LOVE ME' slug on certain pages.

@@ -324,7 +317,7 @@

Public Plugin name for dashboard heading

@@ -361,48 +354,6 @@ that isn’t translated, and dropping the logo in another, translatable heading.
- -
-

- C_STR_PLUGIN_NAME - -

- - - -

Internal Plugin name.

- - - public - string - C_STR_PLUGIN_NAME - = 'footnotes' - - - -
- - -
- Tags - -
-
-
- since -
-
- 1.5.0 - -
- -
-
-

@@ -413,7 +364,7 @@ that isn’t translated, and dropping the logo in another, translatable heading.

Public Plugin name.

diff --git a/docs/classes/Footnotes-Layout-Engine.html b/docs/classes/Footnotes-Layout-Engine.html index 1d5d9d1..b7b46c7 100644 --- a/docs/classes/Footnotes-Layout-Engine.html +++ b/docs/classes/Footnotes-Layout-Engine.html @@ -151,6 +151,13 @@
Stores the Hook connection string for the child sub page.
+
+ $plugin_name + +  : string +
+
The ID of this plugin.
+
description() @@ -354,7 +361,7 @@

Stores all Sections for the child sub page.

@@ -401,7 +408,7 @@

Stores the Hook connection string for the child sub page.

@@ -432,6 +439,62 @@ ull +

+
+

+ $plugin_name + + + +

+ + +

The ID of this plugin.

+ + + protected + string + $plugin_name + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+
@@ -453,7 +516,7 @@ ull

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

@@ -502,7 +565,7 @@ ull

Displays the content of specific sub page.

@@ -551,7 +614,7 @@ ull

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

@@ -600,7 +663,7 @@ ull

Registers all sections for a sub page.

@@ -649,7 +712,7 @@ ull

Registers a sub page.

@@ -698,7 +761,7 @@ ull

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

@@ -759,7 +822,7 @@ ull

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

@@ -820,7 +883,7 @@ ull

Returns the html tag for an input/select label.

@@ -890,7 +953,7 @@ ull

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

@@ -939,7 +1002,7 @@ ull

Returns an array describing a meta box.

@@ -1028,7 +1091,7 @@ ull

Returns a line break to start a new line.

@@ -1077,7 +1140,7 @@ ull

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

@@ -1176,7 +1239,7 @@ ull

Returns an array describing a sub page section.

@@ -1265,7 +1328,7 @@ ull

Returns the html tag for a select box.

@@ -1376,7 +1439,7 @@ ull

Returns a simple text inside html <span> text.

@@ -1437,7 +1500,7 @@ ull

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

@@ -1525,7 +1588,7 @@ ull

Returns the html tag for a text area.

@@ -1586,7 +1649,7 @@ ull

Returns an array of all registered meta boxes.

@@ -1635,7 +1698,7 @@ ull

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

@@ -1684,7 +1747,7 @@ ull

Returns the unique slug of the child sub page.

@@ -1733,7 +1796,7 @@ ull

Returns the title of the child sub page.

@@ -1782,7 +1845,7 @@ ull

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

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

Append javascript and css files for specific sub page.

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

Registers all Meta boxes for a sub page.

@@ -2020,7 +2083,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 c9cf583..1c22af9 100644 --- a/docs/classes/Footnotes-Layout-Init.html +++ b/docs/classes/Footnotes-Layout-Init.html @@ -145,6 +145,13 @@
Slug for the Plugin main menu.
+ $plugin_name + +  : string +
+
The ID of this plugin.
+ +
$settings_page  : array<string|int, mixed> @@ -205,7 +212,7 @@

Slug for the Plugin main menu.

@@ -252,6 +259,62 @@ -property -private " +> +

+ $plugin_name + + + +

+ + +

The ID of this plugin.

+ + + private + string + $plugin_name + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+ + +

$settings_page @@ -262,7 +325,7 @@

Contains the settings layoutEngine

@@ -313,18 +376,28 @@

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

public - __construct() : mixed + __construct(mixed $plugin_name) : mixed
- +

Parameters
+
+
+ $plugin_name + : mixed +
+
+ +
+
+
Tags @@ -339,6 +412,16 @@
+ +
+ since +
+
+ 2.8.0 + +

Added $plugin_name parameter.

+
+
@@ -362,7 +445,7 @@

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

@@ -411,7 +494,7 @@

Registers the settings and initialises the settings page.

@@ -460,7 +543,7 @@

Registers the footnotes submenu page.

@@ -518,7 +601,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 1517d65..1739c81 100644 --- a/docs/classes/Footnotes-Layout-Settings.html +++ b/docs/classes/Footnotes-Layout-Settings.html @@ -154,7 +154,21 @@
Stores the Hook connection string for the child sub page.
+
+ $plugin_name + +  : string +
+
The ID of this plugin.
+
+ __construct() + +  : mixed +
+
Initialize the class and set its properties.
+ +
amp_compat()  : mixed @@ -525,7 +539,7 @@

Stores all Sections for the child sub page.

@@ -572,7 +586,7 @@

Stores the Hook connection string for the child sub page.

@@ -603,6 +617,62 @@ ull + +
+

+ $plugin_name + + + +

+ + +

The ID of this plugin.

+ + + protected + string + $plugin_name + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+
@@ -616,6 +686,67 @@ ull -method -public " +> +

+ __construct() + +

+ + +

Initialize the class and set its properties.

+ + + public + __construct(string $plugin_name) : mixed + +
+ +
Parameters
+
+
+ $plugin_name + : string +
+
+

The name of this plugin.

+
+ +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ +
Return values
+ mixed + — +
+ + + +

amp_compat() @@ -624,7 +755,7 @@ ull

Displays the AMP compatibility mode option.

@@ -684,7 +815,7 @@ ull

Displays the Custom CSS box.

@@ -784,7 +915,7 @@ list directly in the template, as CSS is in English anyway

Displays transitional legacy Custom CSS box.

@@ -833,7 +964,7 @@ list directly in the template, as CSS is in English anyway

Displays the new Custom CSS box.

@@ -882,7 +1013,7 @@ list directly in the template, as CSS is in English anyway

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

@@ -931,7 +1062,7 @@ list directly in the template, as CSS is in English anyway

Displays the content of specific sub page.

@@ -980,7 +1111,7 @@ list directly in the template, as CSS is in English anyway

Displays all Donate button to support the developers.

@@ -1029,7 +1160,7 @@ list directly in the template, as CSS is in English anyway

Displays the footnotes in excerpt setting.

@@ -1113,7 +1244,7 @@ list directly in the template, as CSS is in English anyway

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

@@ -1162,7 +1293,7 @@ list directly in the template, as CSS is in English anyway

Displays all options for the fragment identifier configuration.

@@ -1222,7 +1353,7 @@ list directly in the template, as CSS is in English anyway

Displays a short introduction to the Plugin.

@@ -1288,7 +1419,7 @@ list directly in the template, as CSS is in English anyway

Displays all settings for the backlink symbol.

@@ -1410,7 +1541,7 @@ list directly in the template, as CSS is in English anyway

Displays the setting for the input label issue solution.

@@ -1459,7 +1590,7 @@ list directly in the template, as CSS is in English anyway

Displays available Hooks to look for Footnote short codes.

@@ -1554,7 +1685,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for 'I love Footnotes'.

@@ -1624,7 +1755,7 @@ define -1 as PHP_INT_MAX instead

Displays enabled status for the footnotes mouse-over box.

@@ -1694,7 +1825,7 @@ define -1 as PHP_INT_MAX instead

Displays style settings for the footnotes mouse-over box.

@@ -1743,7 +1874,7 @@ define -1 as PHP_INT_MAX instead

Displays dimensions setting for the footnotes mouse-over box.

@@ -1792,7 +1923,7 @@ define -1 as PHP_INT_MAX instead

Displays position settings for the footnotes mouse-over box.

@@ -1841,7 +1972,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -1890,7 +2021,7 @@ define -1 as PHP_INT_MAX instead

Displays timing settings for the footnotes mouse-over box.

@@ -1939,7 +2070,7 @@ define -1 as PHP_INT_MAX instead

Displays truncation settings for the footnotes mouse-over box.

@@ -1988,7 +2119,7 @@ define -1 as PHP_INT_MAX instead

Displays all options for the footnotes numbering.

@@ -2037,7 +2168,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for the reference container.

@@ -2114,7 +2245,7 @@ define -1 as PHP_INT_MAX instead

Registers all sections for a sub page.

@@ -2163,7 +2294,7 @@ define -1 as PHP_INT_MAX instead

Registers a sub page.

@@ -2212,7 +2343,7 @@ define -1 as PHP_INT_MAX instead

Displays all options for the scrolling behavior.

@@ -2261,7 +2392,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -2392,7 +2523,7 @@ define -1 as PHP_INT_MAX instead

Displays all settings for the footnote referrers.

@@ -2462,7 +2593,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -2523,7 +2654,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -2584,7 +2715,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for an input/select label.

@@ -2654,7 +2785,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -2703,7 +2834,7 @@ define -1 as PHP_INT_MAX instead

Returns an array describing a meta box.

@@ -2792,7 +2923,7 @@ define -1 as PHP_INT_MAX instead

Returns a line break to start a new line.

@@ -2841,7 +2972,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -2940,7 +3071,7 @@ define -1 as PHP_INT_MAX instead

Returns an array describing a sub page section.

@@ -3029,7 +3160,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for a select box.

@@ -3140,7 +3271,7 @@ define -1 as PHP_INT_MAX instead

Returns a simple text inside html <span> text.

@@ -3201,7 +3332,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -3289,7 +3420,7 @@ define -1 as PHP_INT_MAX instead

Returns the html tag for a text area.

@@ -3350,7 +3481,7 @@ define -1 as PHP_INT_MAX instead

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

@@ -3464,7 +3595,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

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

@@ -3541,7 +3672,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Returns the unique slug of the sub page.

@@ -3590,7 +3721,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

Returns the title of the sub page.

@@ -3639,7 +3770,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay

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

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

Append javascript and css files for specific sub page.

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

Registers all Meta boxes for a sub page.

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

Save all Plugin settings.

diff --git a/docs/classes/Footnotes-Loader.html b/docs/classes/Footnotes-Loader.html index 296324e..045b65a 100644 --- a/docs/classes/Footnotes-Loader.html +++ b/docs/classes/Footnotes-Loader.html @@ -177,13 +177,6 @@ run function to execute the list of actions and filters.

Add a new filter to the collection to be registered with WordPress.
-
- initialize_widgets() - -  : mixed -
-
Initializes all Widgets of the Plugin.
-
run() @@ -572,65 +565,6 @@ collection.
- -
-

- initialize_widgets() - -

- - -

Initializes all Widgets of the Plugin.

- - - public - initialize_widgets() : mixed - -
- - - -
- Tags - -
-
-
- since -
-
- 1.5.0 - -
- -
-
- since -
-
- 2.8.0 - -

Moved to Footnotes_Loader class.

-
- -
-
- -
Return values
- mixed - — -
- -
class-footnotes-loader.php : - 126 + 113

Register the filters and actions with WordPress.

@@ -694,7 +628,7 @@ collection.

A utility function that is used to register the actions and hooks into a single diff --git a/docs/classes/Footnotes-Public.html b/docs/classes/Footnotes-Public.html index 1800669..2cc1450 100644 --- a/docs/classes/Footnotes-Public.html +++ b/docs/classes/Footnotes-Public.html @@ -165,9 +165,9 @@ and JavaScript.

$a_obj_task -  : Task +  : Footnote_Parser
-
The Plugin task.
+
The footnote parser.
$a_str_script_mode @@ -183,6 +183,13 @@ and JavaScript.

The ID of this plugin.
+
+ $reference_container_widget + +  : Footnotes_Widget_Reference_Container +
+
The reference container widget.
+
$version @@ -211,6 +218,13 @@ and JavaScript.

Register the stylesheets for the public-facing side of the site.
+
+ register_widgets() + +  : mixed +
+
Register the widget(s) for the public-facing side of the site.
+
load_dependencies() @@ -246,7 +260,7 @@ and JavaScript.

Allows to determine whether alternative tooltips are enabled.

@@ -303,7 +317,7 @@ and JavaScript.

Allows to determine whether AMP compatibility mode is enabled.

@@ -361,7 +375,7 @@ and JavaScript.

Flag for using tooltips.

@@ -418,14 +432,14 @@ and JavaScript.

-

The Plugin task.

+

The footnote parser.

public - Task + Footnote_Parser $a_obj_task = ull @@ -476,7 +490,7 @@ ull

Allows to determine the script mode among jQuery or plain JS.

@@ -572,6 +586,53 @@ ull +
+
class-footnotes-public.php : - 93 + 101

Initialize the class and set its properties.

@@ -719,7 +780,7 @@ ull

Register the JavaScript for the public-facing side of the site.

@@ -808,7 +869,7 @@ ull

Register the stylesheets for the public-facing side of the site.

@@ -865,6 +926,65 @@ is true (set in footnotes.php).

+
+
+

+ register_widgets() + +

+ + +

Register the widget(s) for the public-facing side of the site.

+ + + public + register_widgets() : mixed + +
+ + + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ since +
+
+ 2.8.0 + +

Moved to Footnotes_Public class.

+
+ +
+
+ +
Return values
+ mixed + — +
+ +
footnotes.php).

Load the required public-facing dependencies.

diff --git a/docs/classes/Footnotes-WYSIWYG.html b/docs/classes/Footnotes-WYSIWYG.html index 5c8f76d..d84e06f 100644 --- a/docs/classes/Footnotes-WYSIWYG.html +++ b/docs/classes/Footnotes-WYSIWYG.html @@ -137,7 +137,21 @@
-
+
+ $plugin_name + +  : string +
+
The ID of this plugin.
+ +
+ __construct() + +  : mixed +
+
Initialize the class and set its properties.
+ +
ajax_callback()  : mixed @@ -165,13 +179,6 @@
Append a new Button to the WYSIWYG editor of Posts and Pages.
-
- register_hooks() - -  : void -
-
Registers Button hooks.
-
@@ -179,6 +186,68 @@ +
+

+ Properties + +

+
+

+ $plugin_name + + + +

+ + +

The ID of this plugin.

+ + + private + string + $plugin_name + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+ +
+

@@ -186,6 +255,67 @@

+

+ __construct() + +

+ + +

Initialize the class and set its properties.

+ + + public + __construct(string $plugin_name) : mixed + +
+ +
Parameters
+
+
+ $plugin_name + : string +
+
+

The name of this plugin.

+
+ +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ +
Return values
+ mixed + — +
+ + +
+ -
-

- register_hooks() - -

- - -

Registers Button hooks.

- - - public - static register_hooks() : void - -
- - - -
- Tags - -
-
-
- since -
-
- 1.5.0 - -
    -
  • Bugfix: Editor buttons: debug button by reverting name change in PHP file while JS file and HTML template remained unsynced, thanks to @gova bug report.
    • -
-
- -
-
- since -
-
- 2.6.5 - -
- -
-
- reporter -
-
- -

@gova

-
- -
-
- link -
-
- https://wordpress.org/support/topic/back-end-footnotes-not-working-400-bad-erro/ - -
-
- -
Return values
- void - — -
- -
diff --git a/docs/classes/Footnotes-Widget-Reference-Container.html b/docs/classes/Footnotes-Widget-Reference-Container.html index 6c7c8b7..eea901e 100644 --- a/docs/classes/Footnotes-Widget-Reference-Container.html +++ b/docs/classes/Footnotes-Widget-Reference-Container.html @@ -140,12 +140,19 @@
-
- __construct() +
+ $plugin_name + +  : string +
+
The ID of this plugin.
+ +
+ __construct()  : mixed
-
Class Constructor. Registers the child Widget to WordPress.
+
Initialize the class and set its properties.
form() @@ -196,6 +203,68 @@ +
+

+ Properties + +

+
+

+ $plugin_name + + + +

+ + +

The ID of this plugin.

+ + + private + string + $plugin_name + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+ +
+

@@ -210,23 +279,35 @@ >

__construct() - +

-

Class Constructor. Registers the child Widget to WordPress.

+

Initialize the class and set its properties.

public - __construct() : mixed + __construct(string $plugin_name) : mixed
- +
Parameters
+
+
+ $plugin_name + : string +
+
+

The name of this plugin.

+
+ +
+
+
Tags @@ -237,39 +318,10 @@ since
- 1.5.0 - -
    -
  • Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.
    • -
-
- -
-
- since -
-
- 1.6.4 + 2.8.0
-
-
- contributor -
-
- -

@dartiss

-
- -
-
- link -
-
-

“The called constructor method for WP_Widget in Footnotes_Widget_ReferenceContainer is deprecated since version 4.3.0! Use __construct() instead.”

- -
@@ -293,7 +345,7 @@

Outputs the Settings of the Widget.

@@ -355,7 +407,7 @@

Outputs the Content of the Widget.

@@ -425,7 +477,7 @@

Returns the Description of the child widget.

@@ -475,7 +527,7 @@

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

@@ -524,7 +576,7 @@

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

diff --git a/docs/classes/Footnotes.html b/docs/classes/Footnotes.html index 1a72f62..6bd73c0 100644 --- a/docs/classes/Footnotes.html +++ b/docs/classes/Footnotes.html @@ -165,7 +165,7 @@ the plugin.  : string
-
The unique identifier of this plugin.
+
The unique identifier of this plugin
$version @@ -328,7 +328,7 @@ the plugin.

45 -

The unique identifier of this plugin.

+

The unique identifier of this plugin

protected @@ -493,7 +493,7 @@ the public-facing side of the site.

The reference to the class that orchestrates the hooks with the plugin.

@@ -543,7 +543,7 @@ the public-facing side of the site.

The name of the plugin used to uniquely identify it within the context of @@ -594,7 +594,7 @@ WordPress and to define internationalization functionality.

Retrieve the version number of the plugin.

@@ -644,7 +644,7 @@ WordPress and to define internationalization functionality.

Run the loader to execute all of the hooks with WordPress.

@@ -702,7 +702,7 @@ WordPress and to define internationalization functionality.

Register all of the hooks related to the admin area functionality @@ -725,10 +725,20 @@ of the plugin.

since
- 2.8.0 + 1.5.0
+
+
+ since +
+
+ 2.8.0 + +

Moved registrating from various classes into Footnotes_Admin.

+
+
access @@ -761,7 +771,7 @@ of the plugin.

Register all of the hooks related to the public-facing functionality diff --git a/docs/files/src-footnotes.html b/docs/files/src-footnotes.html index 62b5816..781f640 100644 --- a/docs/files/src-footnotes.html +++ b/docs/files/src-footnotes.html @@ -136,7 +136,7 @@

The code that runs during plugin activation.

@@ -161,7 +161,7 @@

The code that runs during plugin deactivation.

@@ -186,7 +186,7 @@

Begins execution of the plugin.

diff --git a/docs/index.html b/docs/index.html index 66de63d..8b6c20f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -185,7 +185,7 @@

The code that runs during plugin activation.

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

The code that runs during plugin deactivation.

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

Begins execution of the plugin.

diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 3c4013d..344df55 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -93,7 +93,7 @@ Search.appendIndex( }, { "fqsen": "\\Footnotes\u003A\u003A\u0024plugin_name", "name": "plugin_name", - "summary": "The\u0020unique\u0020identifier\u0020of\u0020this\u0020plugin.", + "summary": "The\u0020unique\u0020identifier\u0020of\u0020this\u0020plugin", "url": "classes/Footnotes.html#property_plugin_name" }, { "fqsen": "\\Footnotes\u003A\u003A\u0024version", @@ -140,16 +140,21 @@ Search.appendIndex( "name": "version", "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", "url": "classes/Footnotes-Admin.html#property_version" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003A\u0024wysiwyg", + "name": "wysiwyg", + "summary": "The\u0020WYSIWYG\u0020editor\u0020integration\u0020object.", + "url": "classes/Footnotes-Admin.html#property_wysiwyg" }, { "fqsen": "\\Footnotes_WYSIWYG", "name": "Footnotes_WYSIWYG", "summary": "Handles\u0020the\u0020WSYIWYG\u002DButtons.", "url": "classes/Footnotes-WYSIWYG.html" }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Aregister_hooks\u0028\u0029", - "name": "register_hooks", - "summary": "Registers\u0020Button\u0020hooks.", - "url": "classes/Footnotes-WYSIWYG.html#method_register_hooks" + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-WYSIWYG.html#method___construct" }, { "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", "name": "new_visual_editor_button", @@ -170,6 +175,11 @@ Search.appendIndex( "name": "ajax_callback", "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", "url": "classes/Footnotes-WYSIWYG.html#method_ajax_callback" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-WYSIWYG.html#property_plugin_name" }, { "fqsen": "\\Footnotes_Layout_Engine", "name": "Footnotes_Layout_Engine", @@ -300,6 +310,11 @@ Search.appendIndex( "name": "add_num_box", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020num\u005D.", "url": "classes/Footnotes-Layout-Engine.html#method_add_num_box" + }, { + "fqsen": "\\Footnotes_Layout_Engine\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Layout-Engine.html#property_plugin_name" }, { "fqsen": "\\Footnotes_Layout_Engine\u003A\u003A\u0024a_str_sub_page_hook", "name": "a_str_sub_page_hook", @@ -345,6 +360,11 @@ Search.appendIndex( "name": "C_STR_MAIN_MENU_SLUG", "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Layout-Init.html#property_plugin_name" }, { "fqsen": "\\Footnotes_Layout_Init\u003A\u003A\u0024settings_page", "name": "settings_page", @@ -355,6 +375,11 @@ Search.appendIndex( "name": "Footnotes_Layout_Settings", "summary": "Displays\u0020and\u0020handles\u0020all\u0020Settings\u0020of\u0020the\u0020Plugin.", "url": "classes/Footnotes-Layout-Settings.html" + }, { + "fqsen": "\\Footnotes_Layout_Settings\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Layout-Settings.html#method___construct" }, { "fqsen": "\\Footnotes_Layout_Settings\u003A\u003Aget_priority\u0028\u0029", "name": "get_priority", @@ -505,11 +530,6 @@ Search.appendIndex( "name": "Footnotes_Config", "summary": "Contains\u0020all\u0020Plugin\u0020Constants.\u0020Contains\u0020no\u0020Method\u0020or\u0020Property.", "url": "classes/Footnotes-Config.html" - }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_NAME", - "name": "C_STR_PLUGIN_NAME", - "summary": "Internal\u0020Plugin\u0020name.", - "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" }, { "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_PUBLIC_NAME", "name": "C_STR_PLUGIN_PUBLIC_NAME", @@ -605,11 +625,6 @@ Search.appendIndex( "name": "add_filter", "summary": "Add\u0020a\u0020new\u0020filter\u0020to\u0020the\u0020collection\u0020to\u0020be\u0020registered\u0020with\u0020WordPress.", "url": "classes/Footnotes-Loader.html#method_add_filter" - }, { - "fqsen": "\\Footnotes_Loader\u003A\u003Ainitialize_widgets\u0028\u0029", - "name": "initialize_widgets", - "summary": "Initializes\u0020all\u0020Widgets\u0020of\u0020the\u0020Plugin.", - "url": "classes/Footnotes-Loader.html#method_initialize_widgets" }, { "fqsen": "\\Footnotes_Loader\u003A\u003Aadd\u0028\u0029", "name": "add", @@ -1310,6 +1325,11 @@ Search.appendIndex( "name": "enqueue_scripts", "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020public\u002Dfacing\u0020side\u0020of\u0020the\u0020site.", "url": "classes/Footnotes-Public.html#method_enqueue_scripts" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003Aregister_widgets\u0028\u0029", + "name": "register_widgets", + "summary": "Register\u0020the\u0020widget\u0028s\u0029\u0020for\u0020the\u0020public\u002Dfacing\u0020side\u0020of\u0020the\u0020site.", + "url": "classes/Footnotes-Public.html#method_register_widgets" }, { "fqsen": "\\Footnotes_Public\u003A\u003A\u0024plugin_name", "name": "plugin_name", @@ -1320,10 +1340,15 @@ Search.appendIndex( "name": "version", "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", "url": "classes/Footnotes-Public.html#property_version" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024reference_container_widget", + "name": "reference_container_widget", + "summary": "The\u0020reference\u0020container\u0020widget.", + "url": "classes/Footnotes-Public.html#property_reference_container_widget" }, { "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_obj_task", "name": "a_obj_task", - "summary": "The\u0020Plugin\u0020task.", + "summary": "The\u0020footnote\u0020parser.", "url": "classes/Footnotes-Public.html#property_a_obj_task" }, { "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_bool_tooltips_enabled", @@ -1380,6 +1405,11 @@ Search.appendIndex( "name": "Footnotes_Widget_Reference_Container", "summary": "Registers\u0020a\u0020Widget\u0020to\u0020put\u0020the\u0020Reference\u0020Container\u0020to\u0020the\u0020widget\u0020area.", "url": "classes/Footnotes-Widget-Reference-Container.html" + }, { + "fqsen": "\\Footnotes_Widget_Reference_Container\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Widget-Reference-Container.html#method___construct" }, { "fqsen": "\\Footnotes_Widget_Reference_Container\u003A\u003Aget_id\u0028\u0029", "name": "get_id", @@ -1405,6 +1435,11 @@ Search.appendIndex( "name": "widget", "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", "url": "classes/Footnotes-Widget-Reference-Container.html#method_widget" + }, { + "fqsen": "\\Footnotes_Widget_Reference_Container\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Widget-Reference-Container.html#property_plugin_name" }, { "fqsen": "\\Footnotes_Parser", "name": "Footnotes_Parser", diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index ec6bbf8..87aeecb 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -179,7 +179,7 @@

The code that runs during plugin activation.

@@ -204,7 +204,7 @@

The code that runs during plugin deactivation.

@@ -229,7 +229,7 @@

Begins execution of the plugin.

diff --git a/docs/packages/footnotes.html b/docs/packages/footnotes.html index 755e0b2..70aac1c 100644 --- a/docs/packages/footnotes.html +++ b/docs/packages/footnotes.html @@ -177,7 +177,7 @@

The code that runs during plugin activation.

@@ -202,7 +202,7 @@

The code that runs during plugin deactivation.

@@ -227,7 +227,7 @@

Begins execution of the plugin.