From 4dd3345685866243ae057e9c66ac50c3450fd7f4 Mon Sep 17 00:00:00 2001 From: Mark Cheret Date: Sun, 18 Apr 2021 21:30:42 +0200 Subject: [PATCH] docs: update readme and PHPDoc settings (#120) * update readme.txt * Test * Test * docs: update documentation * docs: add package tag * docs: add PHPDoc config, alter Composer script Co-authored-by: Rumperuu --- class/dashboard/subpage-main.php | 3 +- composer.json | 2 +- docs/classes/MCI-Footnotes-Config.html | 65 +- docs/classes/MCI-Footnotes-Convert.html | 189 +- docs/classes/MCI-Footnotes-Hooks.html | 137 +- docs/classes/MCI-Footnotes-Language.html | 94 +- .../MCI-Footnotes-Layout-Diagnostics.html | 2290 ----- ....html => MCI-Footnotes-Layout-Engine.html} | 1322 ++- docs/classes/MCI-Footnotes-Layout-Init.html | 286 +- .../MCI-Footnotes-Layout-Settings.html | 2212 ++-- docs/classes/MCI-Footnotes-Settings.html | 8970 ++++++++++------- docs/classes/MCI-Footnotes-Task.html | 3051 +++--- docs/classes/MCI-Footnotes-Template.html | 428 +- docs/classes/MCI-Footnotes-WYSIWYG.html | 169 +- ...se.html => MCI-Footnotes-Widget-Base.html} | 109 +- ...Footnotes-Widget-Reference-Container.html} | 163 +- docs/classes/MCI-Footnotes.html | 465 +- docs/files/class-config.html | 2 +- docs/files/class-convert.html | 2 +- docs/files/class-dashboard-init.html | 2 +- docs/files/class-dashboard-layout.html | 4 +- docs/files/class-dashboard-subpage-main.html | 2 +- docs/files/class-hooks.html | 2 +- docs/files/class-init.html | 2 +- docs/files/class-language.html | 2 +- docs/files/class-settings.html | 2 +- docs/files/class-task.html | 4 +- docs/files/class-template.html | 2 +- docs/files/class-widgets-base.html | 4 +- .../class-widgets-reference-container.html | 4 +- docs/files/class-wysiwyg.html | 4 +- docs/files/footnotes.html | 110 - docs/files/includes.html | 190 - docs/index.html | 92 +- docs/indices/files.html | 10 +- docs/js/searchIndex.js | 1558 +-- docs/namespaces/default.html | 94 +- docs/packages/default.html | 2 +- .../footdnotes.html} | 20 +- .../packages/{Default.html => footnotes.html} | 98 +- docs/reports/errors.html | 43 +- docs/reports/markers.html | 28 +- phpdoc.dist.xml | 29 + readme.txt | 9 +- 44 files changed, 10272 insertions(+), 12004 deletions(-) delete mode 100644 docs/classes/MCI-Footnotes-Layout-Diagnostics.html rename docs/classes/{MCI-Footnotes-LayoutEngine.html => MCI-Footnotes-Layout-Engine.html} (71%) rename docs/classes/{MCI-Footnotes-WidgetBase.html => MCI-Footnotes-Widget-Base.html} (78%) rename docs/classes/{MCI-Footnotes-Widget-ReferenceContainer.html => MCI-Footnotes-Widget-Reference-Container.html} (76%) delete mode 100644 docs/files/footnotes.html delete mode 100644 docs/files/includes.html rename docs/{files/class-dashboard-subpage-diagnostics.html => packages/footdnotes.html} (84%) rename docs/packages/{Default.html => footnotes.html} (61%) create mode 100644 phpdoc.dist.xml diff --git a/class/dashboard/subpage-main.php b/class/dashboard/subpage-main.php index 419e1c8..e337d65 100644 --- a/class/dashboard/subpage-main.php +++ b/class/dashboard/subpage-main.php @@ -1,8 +1,9 @@ -
@@ -85,7 +85,7 @@

Contains all Plugin Constants. Contains no Method or Property.

@@ -99,15 +99,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -160,7 +151,7 @@
C_STR_PLUGIN_NAME -  = "footnotes" +  = 'footnotes'
Internal Plugin name.
@@ -190,7 +181,7 @@

Html tag for the LOVE symbol.

@@ -212,15 +203,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -241,7 +223,7 @@

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

@@ -283,7 +265,7 @@

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

@@ -305,15 +287,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -334,7 +307,7 @@

Public Plugin name for dashboard heading

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

Internal Plugin name.

@@ -390,7 +363,7 @@ that isn’t translated, and dropping the logo in another, translatable heading. public string C_STR_PLUGIN_NAME - = "footnotes" + = 'footnotes' @@ -403,15 +376,6 @@ that isn’t translated, and dropping the logo in another, translatable heading.
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -432,7 +396,7 @@ that isn’t translated, and dropping the logo in another, translatable heading.

Public Plugin name.

@@ -454,15 +418,6 @@ that isn’t translated, and dropping the logo in another, translatable heading.
- author -
-
- -

Stefan Herndler

-
- -
-
since
diff --git a/docs/classes/MCI-Footnotes-Convert.html b/docs/classes/MCI-Footnotes-Convert.html index ebb56d9..1c4f91a 100644 --- a/docs/classes/MCI-Footnotes-Convert.html +++ b/docs/classes/MCI-Footnotes-Convert.html @@ -70,7 +70,7 @@
@@ -85,7 +85,7 @@

Converts data types and Footnotes specific values.

@@ -99,15 +99,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -132,47 +123,47 @@
debug() -  : mixed +  : void
Displays a Variable.
- getArrow() + get_arrow()  : array<string|int, mixed>|string
Get a html Array short code depending on Arrow-Array key index.
- Index() + index()  : string
Converts a integer into the user-defined counter style for the footnotes.
- toBool() + to_bool()  : bool
Converts a string depending on its value to a boolean.
- toArabicLeading() + to_arabic_leading()  : string
Converts an integer to a leading-0 integer.
- toLatin() + to_latin()  : string
Converts an integer into latin ascii characters, either lower or upper-case.
- toRomanic() + to_romanic()  : string
@@ -204,25 +195,26 @@

Displays a Variable.

public - static debug(mixed $p_mixed_Value) : mixed + static debug(mixed $p_mixed_value) : void
Parameters
- $p_mixed_Value + $p_mixed_value : mixed
-
+

The variable to display.

+
@@ -234,15 +226,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -254,7 +237,7 @@
Return values
- mixed + void —
@@ -266,28 +249,28 @@ -public -static " > -

- getArrow() - +

+ get_arrow() +

Get a html Array short code depending on Arrow-Array key index.

public - static getArrow([int $p_int_Index = -1 ]) : array<string|int, mixed>|string + static get_arrow([int $p_int_index = -1 ]) : array<string|int, mixed>|string
Parameters
- $p_int_Index + $p_int_index : int = -1
@@ -304,15 +287,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -337,28 +311,28 @@ -public -static " > -

- Index() - +

+ index() +

Converts a integer into the user-defined counter style for the footnotes.

public - static Index(int $p_int_Index[, string $p_str_ConvertStyle = "arabic_plain" ]) : string + static index(int $p_int_index[, string $p_str_convert_style = 'arabic_plain' ]) : string
Parameters
- $p_int_Index + $p_int_index : int
@@ -367,9 +341,9 @@
- $p_str_ConvertStyle + $p_str_convert_style : string - = "arabic_plain"
+ = 'arabic_plain'

Style of the new/converted Index.

@@ -384,15 +358,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -428,28 +393,28 @@ -public -static " > -

- toBool() - +

+ to_bool() +

Converts a string depending on its value to a boolean.

public - static toBool(string $p_str_Value) : bool + static to_bool(string $p_str_value) : bool
Parameters
- $p_str_Value + $p_str_value : string
@@ -466,15 +431,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -499,28 +455,28 @@ -private -static " > -

- toArabicLeading() - +

+ to_arabic_leading() +

Converts an integer to a leading-0 integer.

private - static toArabicLeading(int $p_int_Value) : string + static to_arabic_leading(int $p_int_value) : string
Parameters
- $p_int_Value + $p_int_value : int
@@ -537,15 +493,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -570,21 +517,21 @@ -private -static " > -

- toLatin() - +

+ to_latin() +

Converts an integer into latin ascii characters, either lower or upper-case.

private - static toLatin(int $p_int_Value, bool $p_bool_UpperCase) : string + static to_latin(int $p_int_value, bool $p_bool_upper_case) : string

Function available from A to ZZ ( means 676 footnotes at 1 page possible).

@@ -592,7 +539,7 @@
Parameters
- $p_int_Value + $p_int_value : int
@@ -601,7 +548,7 @@
- $p_bool_UpperCase + $p_bool_upper_case : bool
@@ -618,15 +565,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -650,28 +588,28 @@ -private -static " > -

- toRomanic() - +

+ to_romanic() +

Converts an integer to a romanic letter.

private - static toRomanic(int $p_int_Value, mixed $p_bool_UpperCase) : string + static to_romanic(int $p_int_value, bool $p_bool_upper_case) : string
Parameters
- $p_int_Value + $p_int_value : int
@@ -680,11 +618,13 @@
- $p_bool_UpperCase - : mixed + $p_bool_upper_case + : bool
- +

Whether to uppercase.

+
+
@@ -695,15 +635,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -718,7 +649,7 @@
2.2.0 -

optionally lowercase (code from Latin) 2020-12-12T1538+0100

+

optionally lowercase (code from Latin)

diff --git a/docs/classes/MCI-Footnotes-Hooks.html b/docs/classes/MCI-Footnotes-Hooks.html index eb710f1..d0c5978 100644 --- a/docs/classes/MCI-Footnotes-Hooks.html +++ b/docs/classes/MCI-Footnotes-Hooks.html @@ -70,7 +70,7 @@
@@ -85,7 +85,7 @@

Registers all WordPress Hooks and executes them on demand.

@@ -99,15 +99,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -130,35 +121,35 @@
- activatePlugin() + activate_plugin()  : mixed
Executed when the Plugin gets activated.
- deactivatePlugin() + deactivate_plugin()  : mixed
Executed when the Plugin gets deactivated.
- PluginLinks() + plugin_links()  : array<string|int, mixed>
Add Links to the Plugin in the "installed Plugins" page.
- registerHooks() + register_hooks()  : mixed
Registers all WordPress hooks.
- uninstallPlugin() + uninstall_plugin()  : mixed
@@ -183,21 +174,21 @@ -public -static " > -

- activatePlugin() - +

+ activate_plugin() +

Executed when the Plugin gets activated.

public - static activatePlugin() : mixed + static activate_plugin() : mixed
@@ -209,15 +200,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -241,21 +223,21 @@ -public -static " > -

- deactivatePlugin() - +

+ deactivate_plugin() +

Executed when the Plugin gets deactivated.

public - static deactivatePlugin() : mixed + static deactivate_plugin() : mixed
@@ -267,15 +249,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -299,28 +272,28 @@ -public -static " > -

- PluginLinks() - +

+ plugin_links() +

Add Links to the Plugin in the "installed Plugins" page.

public - static PluginLinks(array<string|int, mixed> $p_arr_Links, string $p_str_PluginFileName) : array<string|int, mixed> + static plugin_links(array<string|int, mixed> $p_arr_links, string $p_str_plugin_file_name) : array<string|int, mixed>
Parameters
- $p_arr_Links + $p_arr_links : array<string|int, mixed>
@@ -329,7 +302,7 @@
- $p_str_PluginFileName + $p_str_plugin_file_name : string
@@ -346,15 +319,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -378,21 +342,21 @@ -public -static " > -

- registerHooks() - +

+ register_hooks() +

Registers all WordPress hooks.

public - static registerHooks() : mixed + static register_hooks() : mixed
@@ -404,15 +368,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -436,21 +391,21 @@ -public -static " > -

- uninstallPlugin() - +

+ uninstall_plugin() +

Executed when the Plugin gets uninstalled.

public - static uninstallPlugin() : mixed + static uninstall_plugin() : mixed
@@ -462,22 +417,12 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
1.5.0 -

Edit: ClearAll didn’t actually work.

-
+
@@ -486,7 +431,17 @@
2.2.0 -

this function is not called any longer when deleting the plugin

+

this function is not called any longer when deleting the plugin. +Note: clear_all() didn't actually work.

+
+ +
+
+ see +
+
+ +

class/settings.php

diff --git a/docs/classes/MCI-Footnotes-Language.html b/docs/classes/MCI-Footnotes-Language.html index ebf670f..430c205 100644 --- a/docs/classes/MCI-Footnotes-Language.html +++ b/docs/classes/MCI-Footnotes-Language.html @@ -70,7 +70,7 @@
@@ -85,7 +85,7 @@

Loads text domain of current or default language for localization.

@@ -99,15 +99,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -130,14 +121,14 @@
- loadTextDomain() + load_text_domain()  : mixed
Loads the text domain for current WordPress language if exists.
- registerHooks() + register_hooks()  : mixed
@@ -169,21 +160,21 @@ -public -static " > -

- loadTextDomain() - +

+ load_text_domain() +

Loads the text domain for current WordPress language if exists.

public - static loadTextDomain() : mixed + static load_text_domain() : mixed

Otherwise fallback "en_GB" will be loaded.

@@ -196,15 +187,6 @@
- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -224,15 +206,6 @@
-
-
- date -
-
- -

2020-10-26T1609+0100

-
-
contributor @@ -247,7 +220,7 @@ link
-

Add 3rd (empty) argument in apply_filters() to prevent PHP from throwing an error: +

Add 3rd (empty) argument in apply_filters() to prevent PHP from throwing an error. “Fatal error: Uncaught ArgumentCountError: Too few arguments to function apply_filters()”

Yet get_locale() is defined w/o parameters in wp-includes/l10n.php:30, and apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugin.php:181.

@@ -260,7 +233,7 @@ apply_filters() is defined as apply_filters( $tag, $value ) in wp-includes/plugi

But apply_filters() is defined with a 3rd parameter (and w/o the first one) in wp-includes/class-wp-hook.php:264, as public function apply_filters( $value, $args ).

-

Taking it all together, probably the full function definition would be: +

Taking it all together, probably the full function definition would be public function apply_filters( $tag, $value, $args ). In the case of get_locale(), $args is empty.

The bug was lurking in WP. PHP 7.1 promoted the warning to an error.

@@ -296,21 +269,21 @@ In the case of get_locale(), $args is empty.

-public -static " > -

- registerHooks() - +

+ register_hooks() +

Register WordPress Hook.

public - static registerHooks() : mixed + static register_hooks() : mixed
@@ -322,15 +295,6 @@ In the case of get_locale(), $args is empty.

- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -361,21 +325,21 @@ In the case of get_locale(), $args is empty.

Loads a specific text domain.

private - static load(string $p_str_LanguageCode) : bool + static load(string $p_str_language_code) : bool
Parameters
- $p_str_LanguageCode + $p_str_language_code : string
@@ -392,15 +356,6 @@ In the case of get_locale(), $args is empty.

- author -
-
- -

Stefan Herndler

-
- -
-
since
@@ -417,15 +372,6 @@ In the case of get_locale(), $args is empty.

-
-
- date -
-
- -

2020-12-08T1931+0100

-
-
reporter @@ -440,7 +386,7 @@ In the case of get_locale(), $args is empty.

link
-

That is done by using load_plugin_textdomain(): +

That is done by using load_plugin_textdomain(). “The .mo file should be named based on the text domain with a dash, and then the locale exactly.”

diff --git a/docs/classes/MCI-Footnotes-Layout-Diagnostics.html b/docs/classes/MCI-Footnotes-Layout-Diagnostics.html deleted file mode 100644 index d00152d..0000000 --- a/docs/classes/MCI-Footnotes-Layout-Diagnostics.html +++ /dev/null @@ -1,2290 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
-

Documentation

- - -
- -
- - -
- -
-
- - - - -
- - -
-

- MCI_Footnotes_Layout_Diagnostics - - - extends MCI_Footnotes_LayoutEngine - - - - -

- - - -

Displays Diagnostics of the web server, PHP and WordPress.

- -
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- - - - - - -

- Table of Contents - -

- -
-
- $a_arr_Sections - -  : array<string|int, mixed> -
-
Stores all Sections for the child sub page.
- -
- $a_str_SubPageHook - -  : null|string -
-
Stores the Hook connection string for the child sub page.
- -
- Description() - -  : mixed -
-
Output the Description of a section. May be overwritten in any section.
- -
- Diagnostics() - -  : mixed -
-
Displays a diagnostics about the web server, php and WordPress.
- -
- displayContent() - -  : mixed -
-
Displays the content of specific sub page.
- -
- getPriority() - -  : int -
-
Returns a Priority index. Lower numbers have a higher Priority.
- -
- registerSections() - -  : mixed -
-
Registers all sections for a sub page.
- -
- registerSubPage() - -  : mixed -
-
Registers a sub page.
- -
- addCheckbox() - -  : string -
-
Returns the html tag for an input [type = checkbox].
- -
- addColorSelection() - -  : string -
-
Returns the html tag for an input [type = text] with color selection class.
- -
- addLabel() - -  : string -
-
Returns the html tag for an input/select label.
- -
- addLineSpace() - -  : string -
-
Returns a line break to have a space between two lines.
- -
- addMetaBox() - -  : array<string|int, mixed> -
-
Returns an array describing a meta box.
- -
- addNewline() - -  : string -
-
Returns a line break to start a new line.
- -
- addNumBox() - -  : string -
-
Returns the html tag for an input [type = num].
- -
- addSection() - -  : array<string|int, mixed> -
-
Returns an array describing a sub page section.
- -
- addSelectBox() - -  : string -
-
Returns the html tag for a select box.
- -
- addText() - -  : string -
-
Returns a simple text inside html <span> text.
- -
- addTextArea() - -  : string -
-
Returns the html tag for a text area.
- -
- addTextBox() - -  : string -
-
Returns the html tag for an input [type = text].
- -
- getMetaBoxes() - -  : array<string|int, mixed> -
-
Returns an array of all registered meta boxes for each section of the sub page.
- -
- getSections() - -  : array<string|int, mixed> -
-
Returns an array of all registered sections for the sub page.
- -
- getSubPageSlug() - -  : string -
-
Returns the unique slug of the sub page.
- -
- getSubPageTitle() - -  : string -
-
Returns the title of the sub page.
- -
- LoadSetting() - -  : array<string|int, mixed> -
-
Loads specific setting and returns an array with the keys [id, name, value].
- -
- appendScripts() - -  : mixed -
-
Append javascript and css files for specific sub page.
- -
- registerMetaBoxes() - -  : mixed -
-
Registers all Meta boxes for a sub page.
- -
- saveSettings() - -  : bool -
-
Save all Plugin settings.
- -
- - - - - - -
-

- Properties - -

-
-

- $a_arr_Sections - - - -

- - -

Stores all Sections for the child sub page.

- - - protected - array<string|int, mixed> - $a_arr_Sections - = array() - -
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
-
-

- $a_str_SubPageHook - - - -

- - -

Stores the Hook connection string for the child sub page.

- - - protected - null|string - $a_str_SubPageHook - = -ull - -
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
-
- -
-

- Methods - -

-
-

- Description() - -

- - -

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

- - - public - Description() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- Diagnostics() - -

- - -

Displays a diagnostics about the web server, php and WordPress.

- - - public - Diagnostics() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- displayContent() - -

- - -

Displays the content of specific sub page.

- - - public - displayContent() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- getPriority() - -

- - -

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

- - - public - getPriority() : int - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- int - — -
- - -
-
-

- registerSections() - -

- - -

Registers all sections for a sub page.

- - - public - registerSections() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- registerSubPage() - -

- - -

Registers a sub page.

- - - public - registerSubPage() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- addCheckbox() - -

- - -

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

- - - protected - addCheckbox(string $p_str_SettingName) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre load the input field.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addColorSelection() - -

- - -

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

- - - protected - addColorSelection(string $p_str_SettingName) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre load the input field.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.6 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addLabel() - -

- - -

Returns the html tag for an input/select label.

- - - protected - addLabel(string $p_str_SettingName, string $p_str_Caption) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to connect the Label with the input/select field.

-
- -
-
- $p_str_Caption - : string -
-
-

Label caption.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- since -
-
- 2.1.6 - -

no colon

-
- -
-
- -
Return values
- string - — -

Edited 2020-12-01T0159+0100..

-
- - -
-
-

- addLineSpace() - -

- - -

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

- - - protected - addLineSpace() : string - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addMetaBox() - -

- - -

Returns an array describing a meta box.

- - - protected - addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> - -
- -
Parameters
-
-
- $p_str_SectionID - : string -
-
-

Parent Section ID.

-
- -
-
- $p_str_ID - : string -
-
-

Unique ID suffix.

-
- -
-
- $p_str_Title - : string -
-
-

Title for the meta box.

-
- -
-
- $p_str_CallbackFunctionName - : string -
-
-

Class method name for callback.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- array<string|int, mixed> - — -

meta box description to be able to append a meta box to the output.

-
- - -
-
-

- addNewline() - -

- - -

Returns a line break to start a new line.

- - - protected - addNewline() : string - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addNumBox() - -

- - -

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

- - - protected - addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre load the input field.

-
- -
-
- $p_in_Min - : int -
-
-

Minimum value.

-
- -
-
- $p_int_Max - : int -
-
-

Maximum value.

-
- -
-
- $p_bool_Deci - : bool - = false
-
-

true if 0.1 steps and floating to string, false if integer (default)

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- since -
-
- 2.1.4 - -

step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

-
- -
-
- -
Return values
- string - — -

Edited:

-
- - -
-
-

- addSection() - -

- - -

Returns an array describing a sub page section.

- - - protected - addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> - -
- -
Parameters
-
-
- $p_str_ID - : string -
-
-

Unique ID suffix.

-
- -
-
- $p_str_Title - : string -
-
-

Title of the section.

-
- -
-
- $p_int_SettingsContainerIndex - : int -
-
-

Settings Container Index.

-
- -
-
- $p_bool_hasSubmitButton - : bool - = true
-
-

Should a Submit Button be displayed for this section, default: true.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- array<string|int, mixed> - — -

Array describing the section.

-
- - -
-
-

- addSelectBox() - -

- - -

Returns the html tag for a select box.

- - - protected - addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre select the current value.

-
- -
-
- $p_arr_Options - : array<string|int, mixed> -
-
-

Possible options to be selected.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addText() - -

- - -

Returns a simple text inside html <span> text.

- - - protected - addText(string $p_str_Text) : string - -
- -
Parameters
-
-
- $p_str_Text - : string -
-
-

Message to be surrounded with simple html tag (span).

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addTextArea() - -

- - -

Returns the html tag for a text area.

- - - protected - addTextArea(string $p_str_SettingName) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre fill the text area.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- addTextBox() - -

- - -

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

- - - protected - addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string - -
- -
Parameters
-
-
- $p_str_SettingName - : string -
-
-

Name of the Settings key to pre load the input field.

-
- -
-
- $p_str_MaxLength - : int - = 999
-
-

Maximum length of the input, default 999 characters.

-
- -
-
- $p_bool_Readonly - : bool - = false
-
-

Set the input to be read only, default false.

-
- -
-
- $p_bool_Hidden - : bool - = false
-
-

Set the input to be hidden, default false.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- getMetaBoxes() - -

- - -

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

- - - protected - getMetaBoxes() : array<string|int, mixed> - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- array<string|int, mixed> - — -
- - -
-
-

- getSections() - -

- - -

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

- - - protected - getSections() : array<string|int, mixed> - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- array<string|int, mixed> - — -
- - -
-
-

- getSubPageSlug() - -

- - -

Returns the unique slug of the sub page.

- - - protected - getSubPageSlug() : string - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- getSubPageTitle() - -

- - -

Returns the title of the sub page.

- - - protected - getSubPageTitle() : string - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- string - — -
- - -
-
-

- LoadSetting() - -

- - -

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

- - - protected - LoadSetting(string $p_str_SettingKeyName) : array<string|int, mixed> - -
- -
Parameters
-
-
- $p_str_SettingKeyName - : string -
-
-

Settings Array key name.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- array<string|int, mixed> - — -

Contains Settings ID, Settings Name and Settings Value.

-
- - -
-
-

- appendScripts() - -

- - -

Append javascript and css files for specific sub page.

- - - private - appendScripts() : mixed - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- registerMetaBoxes() - -

- - -

Registers all Meta boxes for a sub page.

- - - private - registerMetaBoxes(string $p_str_ParentID) : mixed - -
- -
Parameters
-
-
- $p_str_ParentID - : string -
-
-

Parent section unique id.

-
- -
-
- - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- mixed - — -
- - -
-
-

- saveSettings() - -

- - -

Save all Plugin settings.

- - - private - saveSettings() : bool - -
- - - -
- Tags - -
-
-
- author -
-
- -

Stefan Herndler

-
- -
-
- since -
-
- 1.5.0 - -
- -
-
- -
Return values
- bool - — -
- - -
-
- -
-
-
-
-

Search results

- -
-
-
    -
    -
    -
    -
    -
    - - -
    - - - - diff --git a/docs/classes/MCI-Footnotes-LayoutEngine.html b/docs/classes/MCI-Footnotes-Layout-Engine.html similarity index 71% rename from docs/classes/MCI-Footnotes-LayoutEngine.html rename to docs/classes/MCI-Footnotes-Layout-Engine.html index ff9e0f2..2b36d2f 100644 --- a/docs/classes/MCI-Footnotes-LayoutEngine.html +++ b/docs/classes/MCI-Footnotes-Layout-Engine.html @@ -70,12 +70,12 @@

    - MCI_Footnotes_LayoutEngine + MCI_Footnotes_Layout_Engine @@ -85,7 +85,7 @@

    Layout Engine for the administration dashboard.

    @@ -99,15 +99,6 @@

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -130,189 +121,189 @@
    - $a_arr_Sections + $a_arr_sections  : array<string|int, mixed>
    Stores all Sections for the child sub page.
    - $a_str_SubPageHook + $a_str_sub_page_hook  : null|string
    Stores the Hook connection string for the child sub page.
    - Description() + description()  : mixed
    Output the Description of a section. May be overwritten in any section.
    - displayContent() + display_content()  : mixed
    Displays the content of specific sub page.
    - getPriority() + get_priority()  : int
    Returns a Priority index. Lower numbers have a higher Priority.
    - registerSections() + register_sections()  : mixed
    Registers all sections for a sub page.
    - registerSubPage() + register_sub_page()  : mixed
    Registers a sub page.
    - addCheckbox() + add_checkbox()  : string
    Returns the html tag for an input [type = checkbox].
    - addColorSelection() + add_color_selection()  : string
    Returns the html tag for an input [type = text] with color selection class.
    - addLabel() + add_label()  : string
    Returns the html tag for an input/select label.
    - addLineSpace() + add_line_space()  : string
    Returns a line break to have a space between two lines.
    - addMetaBox() + add_meta_box()  : array<string|int, mixed>
    Returns an array describing a meta box.
    - addNewline() + add_newline()  : string
    Returns a line break to start a new line.
    - addNumBox() + add_num_box()  : string
    Returns the html tag for an input [type = num].
    - addSection() + add_section()  : array<string|int, mixed>
    Returns an array describing a sub page section.
    - addSelectBox() + add_select_box()  : string
    Returns the html tag for a select box.
    - addText() + add_text()  : string
    Returns a simple text inside html <span> text.
    - addTextArea() - -  : string -
    -
    Returns the html tag for a text area.
    - -
    - addTextBox() + add_text_box()  : string
    Returns the html tag for an input [type = text].
    - getMetaBoxes() + add_textarea() + +  : string +
    +
    Returns the html tag for a text area.
    + +
    + get_meta_boxes()  : array<string|int, mixed>
    Returns an array of all registered meta boxes.
    - getSections() + get_sections()  : array<string|int, mixed>
    Returns an array of all registered sections for a sub page.
    - getSubPageSlug() + get_sub_page_slug()  : string
    Returns the unique slug of the child sub page.
    - getSubPageTitle() + get_sub_page_title()  : string
    Returns the title of the child sub page.
    - LoadSetting() + load_setting()  : array<string|int, mixed>
    Loads specific setting and returns an array with the keys [id, name, value].
    - appendScripts() + append_scripts()  : mixed
    Append javascript and css files for specific sub page.
    - registerMetaBoxes() + register_meta_boxes()  : mixed
    Registers all Meta boxes for a sub page.
    - saveSettings() + save_settings()  : bool
    @@ -328,7 +319,7 @@

    Properties - +

    -

    - $a_arr_Sections - +

    + $a_arr_sections +

    Stores all Sections for the child sub page.

    @@ -354,7 +345,7 @@ protected array<string|int, mixed> - $a_arr_Sections + $a_arr_sections = array()
    @@ -366,15 +357,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -393,16 +375,16 @@ -protected " > -

    - $a_str_SubPageHook - +

    + $a_str_sub_page_hook +

    Stores the Hook connection string for the child sub page.

    @@ -410,7 +392,7 @@ protected null|string - $a_str_SubPageHook + $a_str_sub_page_hook = ull @@ -423,15 +405,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -448,7 +421,7 @@ ull

    Methods - +

    -

    - Description() - +

    + description() +

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

    public - Description() : mixed + description() : mixed
    @@ -482,15 +455,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -514,21 +478,21 @@ ull -public " > -

    - displayContent() - +

    + display_content() +

    Displays the content of specific sub page.

    public - displayContent() : mixed + display_content() : mixed
    @@ -540,15 +504,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -572,21 +527,21 @@ ull -public -abstract " > -

    - getPriority() - +

    + get_priority() +

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

    public - abstract getPriority() : int + abstract get_priority() : int
    @@ -598,15 +553,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -630,21 +576,21 @@ ull -public " > -

    - registerSections() - +

    + register_sections() +

    Registers all sections for a sub page.

    public - registerSections() : mixed + register_sections() : mixed
    @@ -656,15 +602,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -688,21 +625,21 @@ ull -public " > -

    - registerSubPage() - +

    + register_sub_page() +

    Registers a sub page.

    public - registerSubPage() : mixed + register_sub_page() : mixed
    @@ -714,15 +651,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -746,28 +674,28 @@ ull -protected " > -

    - addCheckbox() - +

    + add_checkbox() +

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

    protected - addCheckbox(string $p_str_SettingName) : string + add_checkbox(string $p_str_setting_name) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -784,15 +712,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -816,28 +735,28 @@ ull -protected " > -

    - addColorSelection() - +

    + add_color_selection() +

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

    protected - addColorSelection(string $p_str_SettingName) : string + add_color_selection(string $p_str_setting_name) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -854,15 +773,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -886,28 +796,28 @@ ull -protected " > -

    - addLabel() - +

    + add_label() +

    Returns the html tag for an input/select label.

    protected - addLabel(string $p_str_SettingName, string $p_str_Caption) : string + add_label(string $p_str_setting_name, string $p_str_caption) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -916,7 +826,7 @@ ull
    - $p_str_Caption + $p_str_caption : string
    @@ -933,84 +843,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 2.1.6 - -

    no colon

    -
    - -
    -
    - -
    Return values
    - string - — -

    Edited 2020-12-01T0159+0100..

    -
    - - -
    -
    -

    - addLineSpace() - -

    - - -

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

    - - - protected - addLineSpace() : string - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1034,28 +866,77 @@ ull -protected " > -

    - addMetaBox() - +

    + add_line_space() +

    + +

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

    + + + protected + add_line_space() : string + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + add_meta_box() + +

    +

    Returns an array describing a meta box.

    protected - addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> + add_meta_box(string $p_str_section_id, string $p_str_id, string $p_str_title, string $p_str_callback_function_name) : array<string|int, mixed>
    Parameters
    - $p_str_SectionID + $p_str_section_id : string
    @@ -1064,7 +945,7 @@ ull
    - $p_str_ID + $p_str_id : string
    @@ -1073,7 +954,7 @@ ull
    - $p_str_Title + $p_str_title : string
    @@ -1082,7 +963,7 @@ ull
    - $p_str_CallbackFunctionName + $p_str_callback_function_name : string
    @@ -1099,15 +980,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1132,21 +1004,21 @@ ull -protected " > -

    - addNewline() - +

    + add_newline() +

    Returns a line break to start a new line.

    protected - addNewline() : string + add_newline() : string
    @@ -1158,15 +1030,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1190,28 +1053,28 @@ ull -protected " > -

    - addNumBox() - +

    + add_num_box() +

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

    protected - addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string + add_num_box(string $p_str_setting_name, int $p_in_min, int $p_int_max[, bool $p_bool_deci = false ]) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -1220,7 +1083,7 @@ ull
    - $p_in_Min + $p_in_min : int
    @@ -1229,7 +1092,7 @@ ull
    - $p_int_Max + $p_int_max : int
    @@ -1238,11 +1101,11 @@ ull
    - $p_bool_Deci + $p_bool_deci : bool = false
    -

    true if 0.1 steps and floating to string, false if integer (default)

    +

    true if 0.1 steps and floating to string, false if integer (default).

    @@ -1255,15 +1118,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1278,7 +1132,7 @@ ull
    2.1.4 -

    step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

    +

    step argument and number_format() to allow decimals ..

    @@ -1298,28 +1152,28 @@ ull -protected " > -

    - addSection() - +

    + add_section() +

    Returns an array describing a sub page section.

    protected - addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> + add_section(string $p_str_id, string $p_str_title, int $p_int_settings_container_index[, bool $p_bool_has_submit_button = true ]) : array<string|int, mixed>
    Parameters
    - $p_str_ID + $p_str_id : string
    @@ -1328,7 +1182,7 @@ ull
    - $p_str_Title + $p_str_title : string
    @@ -1337,7 +1191,7 @@ ull
    - $p_int_SettingsContainerIndex + $p_int_settings_container_index : int
    @@ -1346,7 +1200,7 @@ ull
    - $p_bool_hasSubmitButton + $p_bool_has_submit_button : bool = true
    @@ -1363,15 +1217,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1396,28 +1241,28 @@ ull -protected " > -

    - addSelectBox() - +

    + add_select_box() +

    Returns the html tag for a select box.

    protected - addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string + add_select_box(string $p_str_setting_name, array<string|int, mixed> $p_arr_options) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -1426,7 +1271,7 @@ ull
    - $p_arr_Options + $p_arr_options : array<string|int, mixed>
    @@ -1443,22 +1288,54 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 +
      +
    • Bugfix: Dashboard: Referrers and tooltips: Backlink symbol: debug select box by reverting identity check to equality check, thanks to @lolzim bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.5.13 +
    +
    +
    + since +
    +
    + 2.5.15 + +

    Bugfix: Dashboard: General settings: Footnote start and end short codes: debug select box for shortcodes with pointy brackets.

    +
    + +
    +
    + since +
    +
    + 2.6.1 + +

    Restore esc_attr() in load_setting(), remove htmlspecialchars() here.

    +
    + +
    +
    + reporter +
    +
    + +

    @lolzim

    +
    +
    @@ -1475,28 +1352,28 @@ ull -protected " > -

    - addText() - +

    + add_text() +

    Returns a simple text inside html <span> text.

    protected - addText(string $p_str_Text) : string + add_text(string $p_str_text) : string
    Parameters
    - $p_str_Text + $p_str_text : string
    @@ -1513,15 +1390,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1545,98 +1413,28 @@ ull -protected " > -

    - addTextArea() - +

    + add_text_box() +

    - -

    Returns the html tag for a text area.

    - - - protected - addTextArea(string $p_str_SettingName) : string - -
    - -
    Parameters
    -
    -
    - $p_str_SettingName - : string -
    -
    -

    Name of the Settings key to pre fill the text area.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - string - — -
    - - -
    -
    -

    - addTextBox() - -

    -

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

    protected - addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string + add_text_box(string $p_str_setting_name[, int $p_str_max_length = 999 ][, bool $p_bool_readonly = false ][, bool $p_bool_hidden = false ]) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -1645,7 +1443,7 @@ ull
    - $p_str_MaxLength + $p_str_max_length : int = 999
    @@ -1654,7 +1452,7 @@ ull
    - $p_bool_Readonly + $p_bool_readonly : bool = false
    @@ -1663,7 +1461,7 @@ ull
    - $p_bool_Hidden + $p_bool_hidden : bool = false
    @@ -1680,247 +1478,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - string - — -
    - - -
    -
    -

    - getMetaBoxes() - -

    - - -

    Returns an array of all registered meta boxes.

    - - - protected - abstract getMetaBoxes() : array<string|int, mixed> - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - array<string|int, mixed> - — -
    - - -
    -
    -

    - getSections() - -

    - - -

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

    - - - protected - abstract getSections() : array<string|int, mixed> - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - array<string|int, mixed> - — -
    - - -
    -
    -

    - getSubPageSlug() - -

    - - -

    Returns the unique slug of the child sub page.

    - - - protected - abstract getSubPageSlug() : string - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - string - — -
    - - -
    -
    -

    - getSubPageTitle() - -

    - - -

    Returns the title of the child sub page.

    - - - protected - abstract getSubPageTitle() : string - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1944,9 +1501,266 @@ ull -protected " > -

    - LoadSetting() - +

    + add_textarea() + +

    + + +

    Returns the html tag for a text area.

    + + + protected + add_textarea(string $p_str_setting_name) : string + +
    + +
    Parameters
    +
    +
    + $p_str_setting_name + : string +
    +
    +

    Name of the Settings key to pre fill the text area.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + get_meta_boxes() + +

    + + +

    Returns an array of all registered meta boxes.

    + + + protected + abstract get_meta_boxes() : array<string|int, mixed> + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + array<string|int, mixed> + — +
    + + +
    +
    +

    + get_sections() + +

    + + +

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

    + + + protected + abstract get_sections() : array<string|int, mixed> + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + array<string|int, mixed> + — +
    + + +
    +
    +

    + get_sub_page_slug() + +

    + + +

    Returns the unique slug of the child sub page.

    + + + protected + abstract get_sub_page_slug() : string + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + get_sub_page_title() + +

    + + +

    Returns the title of the child sub page.

    + + + protected + abstract get_sub_page_title() : string + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + load_setting() +

    - + diff --git a/docs/classes/MCI-Footnotes-Layout-Init.html b/docs/classes/MCI-Footnotes-Layout-Init.html index 0ec0d29..2d791b4 100644 --- a/docs/classes/MCI-Footnotes-Layout-Init.html +++ b/docs/classes/MCI-Footnotes-Layout-Init.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@

    Handles the Settings interface of the Plugin.

    @@ -99,15 +99,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -132,23 +123,23 @@
    C_STR_MAIN_MENU_SLUG -  = "mfmmf" +  = 'footnotes'
    Slug for the Plugin main menu.
    C_STR_MAIN_MENU_TITLE -  = "ManFisher" +  = 'ManFisher'
    Plugin main menu name.
    - $a_arr_SubPageClasses + $settings_page  : array<string|int, mixed>
    -
    +
    Contains the settings layoutEngine
    __construct() @@ -158,39 +149,25 @@
    Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
    - displayOtherPlugins() - -  : mixed -
    -
    Displays other Plugins from the developers.
    - -
    - getPluginMetaInformation() + get_plugin_meta_information()  : mixed
    AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
    - initializeSettings() + initialize_settings()  : mixed
    -
    Initializes all sub pages and registers the settings.
    +
    Registers the settings and initialises the settings page.
    - registerMainMenu() + register_options_submenu()  : mixed
    -
    Registers the new main menu for the WordPress dashboard.
    - -
    - registerSubPages() - -  : mixed -
    -
    Registers all SubPages for this Plugin.
    +
    Registers the footnotes submenu page.
    @@ -211,7 +188,7 @@

    Slug for the Plugin main menu.

    @@ -220,7 +197,7 @@ public string C_STR_MAIN_MENU_SLUG - = "mfmmf" + = 'footnotes' @@ -233,15 +210,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -262,7 +230,7 @@

    Plugin main menu name.

    @@ -271,7 +239,7 @@ public string C_STR_MAIN_MENU_TITLE - = "ManFisher" + = 'ManFisher' @@ -284,15 +252,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -319,24 +278,25 @@ -private " > -

    - $a_arr_SubPageClasses - +

    + $settings_page +

    - +

    Contains the settings layoutEngine

    + private array<string|int, mixed> - $a_arr_SubPageClasses - = array() + $settings_page +
    @@ -347,15 +307,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -387,7 +338,7 @@

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

    @@ -406,15 +357,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -438,79 +380,21 @@ -public " > -

    - displayOtherPlugins() - +

    + get_plugin_meta_information() +

    - -

    Displays other Plugins from the developers.

    - - - public - displayOtherPlugins() : mixed - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - getPluginMetaInformation() - -

    -

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

    public - getPluginMetaInformation() : mixed + get_plugin_meta_information() : mixed
    @@ -522,15 +406,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -554,21 +429,21 @@ -public " > -

    - initializeSettings() - +

    + initialize_settings() +

    -

    Initializes all sub pages and registers the settings.

    +

    Registers the settings and initialises the settings page.

    public - initializeSettings() : mixed + initialize_settings() : mixed
    @@ -580,15 +455,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -612,24 +478,23 @@ -public " > -

    - registerMainMenu() - +

    + register_options_submenu() +

    -

    Registers the new main menu for the WordPress dashboard.

    +

    Registers the footnotes submenu page.

    public - registerMainMenu() : mixed + register_options_submenu() : mixed -

    Registers all sub menu pages for the new main menu.

    -
    +
    @@ -639,15 +504,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -673,64 +529,6 @@
    -
    -
    -

    - registerSubPages() - -

    - - -

    Registers all SubPages for this Plugin.

    - - - private - registerSubPages() : mixed - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - mixed - — -
    - -
    diff --git a/docs/classes/MCI-Footnotes-Layout-Settings.html b/docs/classes/MCI-Footnotes-Layout-Settings.html index 5b4da79..eebfb57 100644 --- a/docs/classes/MCI-Footnotes-Layout-Settings.html +++ b/docs/classes/MCI-Footnotes-Layout-Settings.html @@ -70,7 +70,7 @@
    @@ -78,7 +78,7 @@ MCI_Footnotes_Layout_Settings - extends MCI_Footnotes_LayoutEngine + extends MCI_Footnotes_Layout_Engine @@ -88,7 +88,7 @@

    Displays and handles all Settings of the Plugin.

    @@ -102,15 +102,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -133,338 +124,357 @@
    - $a_arr_Sections + $a_arr_sections  : array<string|int, mixed>
    Stores all Sections for the child sub page.
    - $a_str_SubPageHook + $a_str_sub_page_hook  : null|string
    Stores the Hook connection string for the child sub page.
    - CustomCSS() + amp_compat()  : mixed
    -
    Displays the custom css box.
    +
    Displays the AMP compatibility mode option.
    - CustomCSSMigration() + custom_css()  : mixed
    -
    +
    Displays the Custom CSS box.
    - CustomCSSNew() + custom_css_migration()  : mixed
    -
    +
    Displays transitional legacy Custom CSS box.
    - Description() + custom_css_new() + +  : mixed +
    +
    Displays the new Custom CSS box.
    + +
    + description()  : mixed
    Output the Description of a section. May be overwritten in any section.
    - displayContent() + display_content()  : mixed
    Displays the content of specific sub page.
    - Donate() + donate()  : mixed
    Displays all Donate button to support the developers.
    - Excerpts() + excerpts()  : mixed
    -
    Displays the excerpt setting
    +
    Displays the footnotes in excerpt setting.
    - getPriority() + get_priority()  : int
    Returns a Priority index. Lower numbers have a higher Priority.
    +
    + hard_links() + +  : mixed +
    +
    Displays all options for the fragment identifier configuration.
    +
    Help()  : mixed
    -
    Displays a short introduction of the Plugin.
    +
    Displays a short introduction to the Plugin.
    - HyperlinkArrow() + hyperlink_arrow()  : mixed
    -
    Displays all settings for the prepended symbol
    +
    Displays all settings for the backlink symbol.
    - LookupHooks() + label_solution() + +  : mixed +
    +
    Displays the setting for the input label issue solution.
    + +
    + lookup_hooks()  : mixed
    Displays available Hooks to look for Footnote short codes.
    - Love() + love()  : mixed
    Displays all settings for 'I love Footnotes'.
    - MouseOverBox() + mouseover_box()  : mixed
    -
    Displays all settings for the footnotes mouse-over box.
    +
    Displays enabled status for the footnotes mouse-over box.
    - MouseOverBoxAppearance() + mouseover_box_appearance()  : mixed
    -
    +
    Displays style settings for the footnotes mouse-over box.
    - MouseOverBoxDimensions() + mouseover_box_dimensions()  : mixed
    -
    +
    Displays dimensions setting for the footnotes mouse-over box.
    - MouseOverBoxPosition() + mouseover_box_position()  : mixed
    -
    +
    Displays position settings for the footnotes mouse-over box.
    - MouseOverBoxText() + mouseover_box_text()  : mixed
    -
    +
    Displays dedicated tooltip text settings for the footnotes mouse-over box.
    - MouseOverBoxTiming() + mouseover_box_timing()  : mixed
    -
    +
    Displays timing settings for the footnotes mouse-over box.
    - MouseOverBoxTruncation() + mouseover_box_truncation()  : mixed
    -
    +
    Displays truncation settings for the footnotes mouse-over box.
    - Numbering() + numbering()  : mixed
    -
    +
    Displays all options for the footnotes numbering.
    - ReferenceContainer() + reference_container()  : mixed
    Displays all settings for the reference container.
    - registerSections() + register_sections()  : mixed
    Registers all sections for a sub page.
    - registerSubPage() + register_sub_page()  : mixed
    Registers a sub page.
    - Scrolling() + scrolling()  : mixed
    -
    +
    Displays all options for the scrolling behavior.
    - StartEnd() + start_end()  : mixed
    -
    Displays all options for the footnotes start and end tag short codes -Displays all options for the footnotes numbering -Displays all options for the scrolling behavior
    +
    Displays all options for the footnotes start and end tag short codes.
    - Superscript() + superscript()  : mixed
    -
    Displays all settings for the footnote referrers
    +
    Displays all settings for the footnote referrers.
    - addCheckbox() + add_checkbox()  : string
    Returns the html tag for an input [type = checkbox].
    - addColorSelection() + add_color_selection()  : string
    Returns the html tag for an input [type = text] with color selection class.
    - addLabel() + add_label()  : string
    Returns the html tag for an input/select label.
    - addLineSpace() + add_line_space()  : string
    Returns a line break to have a space between two lines.
    - addMetaBox() + add_meta_box()  : array<string|int, mixed>
    Returns an array describing a meta box.
    - addNewline() + add_newline()  : string
    Returns a line break to start a new line.
    - addNumBox() + add_num_box()  : string
    Returns the html tag for an input [type = num].
    - addSection() + add_section()  : array<string|int, mixed>
    Returns an array describing a sub page section.
    - addSelectBox() + add_select_box()  : string
    Returns the html tag for a select box.
    - addText() + add_text()  : string
    Returns a simple text inside html <span> text.
    - addTextArea() - -  : string -
    -
    Returns the html tag for a text area.
    - -
    - addTextBox() + add_text_box()  : string
    Returns the html tag for an input [type = text].
    - getMetaBoxes() + add_textarea() + +  : string +
    +
    Returns the html tag for a text area.
    + +
    + get_meta_boxes()  : array<string|int, mixed>
    Returns an array of all registered meta boxes for each section of the sub page.
    - getSections() + get_sections()  : array<string|int, mixed>
    Returns an array of all registered sections for the sub page.
    - getSubPageSlug() + get_sub_page_slug()  : string
    Returns the unique slug of the sub page.
    - getSubPageTitle() + get_sub_page_title()  : string
    Returns the title of the sub page.
    - LoadSetting() + load_setting()  : array<string|int, mixed>
    Loads specific setting and returns an array with the keys [id, name, value].
    - appendScripts() + append_scripts()  : mixed
    Append javascript and css files for specific sub page.
    - registerMetaBoxes() + register_meta_boxes()  : mixed
    Registers all Meta boxes for a sub page.
    - saveSettings() + save_settings()  : bool
    @@ -489,16 +499,16 @@ Displays all options for the scrolling behavior
    -protected " > -

    - $a_arr_Sections - +

    + $a_arr_sections +

    Stores all Sections for the child sub page.

    @@ -506,7 +516,7 @@ Displays all options for the scrolling behavior
    protected array<string|int, mixed> - $a_arr_Sections + $a_arr_sections = array()
    @@ -518,15 +528,6 @@ Displays all options for the scrolling behavior
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -545,16 +546,16 @@ Displays all options for the scrolling behavior
    -protected " > -

    - $a_str_SubPageHook - +

    + $a_str_sub_page_hook +

    Stores the Hook connection string for the child sub page.

    @@ -562,7 +563,7 @@ Displays all options for the scrolling behavior
    protected null|string - $a_str_SubPageHook + $a_str_sub_page_hook = ull @@ -575,15 +576,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -608,21 +600,21 @@ ull -public " > -

    - CustomCSS() - +

    + amp_compat() +

    -

    Displays the custom css box.

    +

    Displays the AMP compatibility mode option.

    public - CustomCSS() : mixed + amp_compat() : mixed
    @@ -634,15 +626,66 @@ ull
    - author + since
    + 2.5.11 -

    Stefan Herndler

    +

    (draft)

    -
    +
    + since +
    +
    + 2.6.0 + +

    (release)

    +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + custom_css() + +

    + + +

    Displays the Custom CSS box.

    + + + public + custom_css() : mixed + +
    + + + +
    + Tags + +
    +
    +
    since
    @@ -669,7 +712,7 @@ list directly in the template, as CSS is in English anyway

    2.2.2 -

    migrate Custom CSS to a dedicated tab 2020-12-15T0506+0100

    +

    migrate Custom CSS to a dedicated tab

    @@ -679,7 +722,7 @@ list directly in the template, as CSS is in English anyway

    2.3.0 -

    say 'copy-paste' instead of 'cut and paste' since cutting is not needed 2020-12-27T1257+0100

    +

    say 'copy-paste' instead of 'cut and paste' since cutting is not needed

    @@ -698,8 +741,7 @@ list directly in the template, as CSS is in English anyway

    -

    templates/dashboard/customize-css.html -2020-12-09T1113+0100

    +

    templates/dashboard/customize-css.html

    @@ -718,24 +760,41 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - CustomCSSMigration() - +

    + custom_css_migration() +

    - +

    Displays transitional legacy Custom CSS box.

    + public - CustomCSSMigration() : mixed + custom_css_migration() : mixed + +
    - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.2 + +
    + +
    +
    Return values
    mixed @@ -750,24 +809,41 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - CustomCSSNew() - +

    + custom_css_new() +

    - +

    Displays the new Custom CSS box.

    + public - CustomCSSNew() : mixed + custom_css_new() : mixed + +
    - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.2 + +
    + +
    +
    Return values
    mixed @@ -782,21 +858,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - Description() - +

    + description() +

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

    public - Description() : mixed + description() : mixed
    @@ -808,15 +884,6 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -840,21 +907,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - displayContent() - +

    + display_content() +

    Displays the content of specific sub page.

    public - displayContent() : mixed + display_content() : mixed
    @@ -866,15 +933,6 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -898,21 +956,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - Donate() - +

    + donate() +

    Displays all Donate button to support the developers.

    public - Donate() : mixed + donate() : mixed
    @@ -924,15 +982,6 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -956,21 +1005,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - Excerpts() - +

    + excerpts() +

    -

    Displays the excerpt setting

    +

    Displays the footnotes in excerpt setting.

    public - Excerpts() : mixed + excerpts() : mixed
    @@ -982,21 +1031,12 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 -

    Edited heading 2020-12-12T1453+0100

    +

    Edited heading

    @@ -1016,7 +1056,7 @@ list directly in the template, as CSS is in English anyway

    2.2.0 -

    dedicated to the excerpt setting and its notices 2020-12-12T1454+0100

    +

    dedicated to the excerpt setting and its notices

    @@ -1049,21 +1089,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - getPriority() - +

    + get_priority() +

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

    public - getPriority() : int + get_priority() : int
    @@ -1075,15 +1115,6 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1107,21 +1138,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - Help() - +

    + hard_links() +

    -

    Displays a short introduction of the Plugin.

    +

    Displays all options for the fragment identifier configuration.

    public - Help() : mixed + hard_links() : mixed
    @@ -1133,21 +1164,23 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    - 1.5.0 + 2.2.0 -
    +

    in scrolling().

    +
    + +
    +
    + since +
    +
    + 2.5.12 + +

    separate metabox.

    +
    @@ -1165,21 +1198,21 @@ list directly in the template, as CSS is in English anyway

    -public " > -

    - HyperlinkArrow() - +

    + Help() +

    -

    Displays all settings for the prepended symbol

    +

    Displays a short introduction to the Plugin.

    public - HyperlinkArrow() : mixed + Help() : mixed
    @@ -1191,26 +1224,116 @@ list directly in the template, as CSS is in English anyway

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 -

    Edited heading for v2.0.4

    -

    The former 'hyperlink arrow', incompatible with combined identical footnotes, -became 'prepended arrow' in v2.0.3 after a user complaint about missing backlinking semantics -of the footnote number.

    +
    + +
    +
    + since +
    +
    + 2.7.0 + +

    Sanitize Lorem Ipsum filler text.

    +
    +
    + link +
    +
    + https://blog.prototypr.io/why-testing-with-real-content-is-better-than-lorem-ipsum-c7c79586ee72 + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + hyperlink_arrow() + +

    + + +

    Displays all settings for the backlink symbol.

    + + + public + hyperlink_arrow() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
      +
    • Update: symbol for backlinks removed; hyperlink moved to the reference number.
      • +
    +
    + +
    +
    + since +
    +
    + 2.0.0 + +

    The former 'hyperlink arrow' is incompatible with combined identical footnotes.

    +
      +
    • Update: Reference container: clarify backlink semantics by prepended transitional up arrow, thanks to @mmallett issue report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.0.3 + +
      +
    • Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.0.4 + +
    +
    since @@ -1231,6 +1354,22 @@ of the footnote number.

    and 2.2.4 back here

    +
    +
    + reporter +
    +
    + +

    @mmallett

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/mouse-over-broken/#post-13593037 +
    @@ -1247,21 +1386,21 @@ of the footnote number.

    -public " > -

    - LookupHooks() - +

    + label_solution() +

    -

    Displays available Hooks to look for Footnote short codes.

    +

    Displays the setting for the input label issue solution.

    public - LookupHooks() : mixed + label_solution() : mixed
    @@ -1273,15 +1412,55 @@ of the footnote number.

    - author + since
    + 2.5.12 -

    Stefan Herndler

    -
    +
    -
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + lookup_hooks() + +

    + + +

    Displays available Hooks to look for Footnote short codes.

    + + + public + lookup_hooks() : mixed + +
    + + + +
    + Tags + +
    +
    +
    since
    @@ -1297,7 +1476,7 @@ of the footnote number.

    2.1.1 -

    priority level setting for the_content 2020-11-16T2152+0100

    +

    priority level setting for the_content

    @@ -1307,7 +1486,7 @@ of the footnote number.

    2.1.4 -

    priority level settings for the other hooks 2020-11-19T1421+0100

    +

    priority level settings for the other hooks

    priority level was initially hard-coded default shows "9223372036854775807" in the numbox empty should be interpreted as PHP_INT_MAX, @@ -1322,7 +1501,7 @@ define -1 as PHP_INT_MAX instead

    2.2.9 -

    removed the warning about the widget text hook 2020-12-25T0348+0100

    +

    removed the warning about the widget text hook

    @@ -1332,7 +1511,7 @@ define -1 as PHP_INT_MAX instead

    2.2.9 -

    added guidance for the widget text hook 2020-12-25T0353+0100

    +

    added guidance for the widget text hook

    @@ -1351,21 +1530,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - Love() - +

    + love() +

    Displays all settings for 'I love Footnotes'.

    public - Love() : mixed + love() : mixed
    @@ -1377,15 +1556,6 @@ define -1 as PHP_INT_MAX instead

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1401,7 +1571,7 @@ define -1 as PHP_INT_MAX instead

    2.2.0 -

    position-sensitive placeholders to support more locales 2020-12-11T0432+0100

    +

    position-sensitive placeholders to support more locales

    @@ -1411,7 +1581,7 @@ define -1 as PHP_INT_MAX instead

    2.2.0 -

    more options 2020-12-11T0432+0100

    +

    more options

    @@ -1430,21 +1600,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - MouseOverBox() - +

    + mouseover_box() +

    -

    Displays all settings for the footnotes mouse-over box.

    +

    Displays enabled status for the footnotes mouse-over box.

    public - MouseOverBox() : mixed + mouseover_box() : mixed
    @@ -1456,15 +1626,6 @@ define -1 as PHP_INT_MAX instead

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1509,245 +1670,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - MouseOverBoxAppearance() - +

    + mouseover_box_appearance() +

    - - - public - MouseOverBoxAppearance() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - MouseOverBoxDimensions() - -

    - - - - - public - MouseOverBoxDimensions() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - MouseOverBoxPosition() - -

    - - - - - public - MouseOverBoxPosition() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - MouseOverBoxText() - -

    - - - - - public - MouseOverBoxText() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - MouseOverBoxTiming() - -

    - - - - - public - MouseOverBoxTiming() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - MouseOverBoxTruncation() - -

    - - - - - public - MouseOverBoxTruncation() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - Numbering() - -

    - - - - - public - Numbering() : mixed - - - - - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - ReferenceContainer() - -

    - - -

    Displays all settings for the reference container.

    +

    Displays style settings for the footnotes mouse-over box.

    public - ReferenceContainer() : mixed + mouseover_box_appearance() : mixed
    @@ -1759,15 +1696,349 @@ define -1 as PHP_INT_MAX instead

    - author + since
    + 2.2.0 -

    Stefan Herndler

    -
    +
    -
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + mouseover_box_dimensions() + +

    + + +

    Displays dimensions setting for the footnotes mouse-over box.

    + + + public + mouseover_box_dimensions() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + mouseover_box_position() + +

    + + +

    Displays position settings for the footnotes mouse-over box.

    + + + public + mouseover_box_position() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + mouseover_box_text() + +

    + + +

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

    + + + public + mouseover_box_text() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + mouseover_box_timing() + +

    + + +

    Displays timing settings for the footnotes mouse-over box.

    + + + public + mouseover_box_timing() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + mouseover_box_truncation() + +

    + + +

    Displays truncation settings for the footnotes mouse-over box.

    + + + public + mouseover_box_truncation() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + numbering() + +

    + + +

    Displays all options for the footnotes numbering.

    + + + public + numbering() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + reference_container() + +

    + + +

    Displays all settings for the reference container.

    + + + public + reference_container() : mixed + +
    + + + +
    + Tags + +
    +
    +
    since
    @@ -1783,7 +2054,7 @@ define -1 as PHP_INT_MAX instead

    2.1.4: -

    layout and typography options 2020-11-30T0548+0100

    +

    layout and typography options

    @@ -1793,7 +2064,7 @@ define -1 as PHP_INT_MAX instead

    2.2.5 -

    options for label element and label bottom border, thanks to @markhillyer 2020-12-18T1447+0100

    +

    options for label element and label bottom border, thanks to @markhillyer

    @@ -1819,21 +2090,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - registerSections() - +

    + register_sections() +

    Registers all sections for a sub page.

    public - registerSections() : mixed + register_sections() : mixed
    @@ -1845,15 +2116,6 @@ define -1 as PHP_INT_MAX instead

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1877,21 +2139,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - registerSubPage() - +

    + register_sub_page() +

    Registers a sub page.

    public - registerSubPage() : mixed + register_sub_page() : mixed
    @@ -1903,15 +2165,6 @@ define -1 as PHP_INT_MAX instead

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1935,24 +2188,41 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - Scrolling() - +

    + scrolling() +

    - +

    Displays all options for the scrolling behavior.

    + public - Scrolling() : mixed + scrolling() : mixed + +
    - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.0 + +
    + +
    +
    Return values
    mixed @@ -1967,23 +2237,21 @@ define -1 as PHP_INT_MAX instead

    -public " > -

    - StartEnd() - +

    + start_end() +

    -

    Displays all options for the footnotes start and end tag short codes -Displays all options for the footnotes numbering -Displays all options for the scrolling behavior

    +

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

    public - StartEnd() : mixed + start_end() : mixed
    @@ -1995,21 +2263,12 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 -

    Edited heading 2020-12-12T1412+0100

    +

    Edited heading

    @@ -2019,7 +2278,7 @@ Displays all options for the scrolling behavior

    2.2.0 -

    start/end short codes: more predefined options 2020-12-12T1412+0100

    +

    start/end short codes: more predefined options

    @@ -2029,7 +2288,7 @@ Displays all options for the scrolling behavior

    2.2.0 -

    3 boxes for clarity 2020-12-12T1422+0100

    +

    3 boxes for clarity

    @@ -2039,7 +2298,7 @@ Displays all options for the scrolling behavior

    2.2.5 -

    support for Ibid. notation thanks to @meglio 2020-12-17T2019+0100

    +

    support for Ibid. notation thanks to @meglio

    @@ -2049,7 +2308,7 @@ Displays all options for the scrolling behavior

    2.4.0 -

    added warning about Block Editor escapement disruption 2021-01-02T2324+0100

    +

    added warning about Block Editor escapement disruption

    @@ -2059,7 +2318,7 @@ Displays all options for the scrolling behavior

    2.4.0 -

    removed the HTML comment tag option 2021-01-02T2325+0100

    +

    removed the HTML comment tag option

    @@ -2109,21 +2368,21 @@ Displays all options for the scrolling behavior

    -public " > -

    - Superscript() - +

    + superscript() +

    -

    Displays all settings for the footnote referrers

    +

    Displays all settings for the footnote referrers.

    public - Superscript() : mixed + superscript() : mixed
    @@ -2135,21 +2394,12 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 -

    Edited heading 2020-12-12T1513+0100

    +

    Edited heading

    @@ -2169,7 +2419,7 @@ Displays all options for the scrolling behavior

    2.2.0 -

    option for link element moved here 2020-12-12T1514+0100

    +

    option for link element moved here

    @@ -2188,28 +2438,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addCheckbox() - +

    + add_checkbox() +

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

    protected - addCheckbox(string $p_str_SettingName) : string + add_checkbox(string $p_str_setting_name) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -2226,15 +2476,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2258,28 +2499,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addColorSelection() - +

    + add_color_selection() +

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

    protected - addColorSelection(string $p_str_SettingName) : string + add_color_selection(string $p_str_setting_name) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -2296,15 +2537,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2328,28 +2560,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addLabel() - +

    + add_label() +

    Returns the html tag for an input/select label.

    protected - addLabel(string $p_str_SettingName, string $p_str_Caption) : string + add_label(string $p_str_setting_name, string $p_str_caption) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -2358,7 +2590,7 @@ Displays all options for the scrolling behavior

    - $p_str_Caption + $p_str_caption : string
    @@ -2375,84 +2607,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 2.1.6 - -

    no colon

    -
    - -
    -
    - -
    Return values
    - string - — -

    Edited 2020-12-01T0159+0100..

    -
    - - -
    -
    -

    - addLineSpace() - -

    - - -

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

    - - - protected - addLineSpace() : string - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2476,28 +2630,77 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addMetaBox() - +

    + add_line_space() +

    + +

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

    + + + protected + add_line_space() : string + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + add_meta_box() + +

    +

    Returns an array describing a meta box.

    protected - addMetaBox(string $p_str_SectionID, string $p_str_ID, string $p_str_Title, string $p_str_CallbackFunctionName) : array<string|int, mixed> + add_meta_box(string $p_str_section_id, string $p_str_id, string $p_str_title, string $p_str_callback_function_name) : array<string|int, mixed>
    Parameters
    - $p_str_SectionID + $p_str_section_id : string
    @@ -2506,7 +2709,7 @@ Displays all options for the scrolling behavior

    - $p_str_ID + $p_str_id : string
    @@ -2515,7 +2718,7 @@ Displays all options for the scrolling behavior

    - $p_str_Title + $p_str_title : string
    @@ -2524,7 +2727,7 @@ Displays all options for the scrolling behavior

    - $p_str_CallbackFunctionName + $p_str_callback_function_name : string
    @@ -2541,15 +2744,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2574,21 +2768,21 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addNewline() - +

    + add_newline() +

    Returns a line break to start a new line.

    protected - addNewline() : string + add_newline() : string
    @@ -2600,15 +2794,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2632,28 +2817,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addNumBox() - +

    + add_num_box() +

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

    protected - addNumBox(string $p_str_SettingName, int $p_in_Min, int $p_int_Max[, bool $p_bool_Deci = false ]) : string + add_num_box(string $p_str_setting_name, int $p_in_min, int $p_int_max[, bool $p_bool_deci = false ]) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -2662,7 +2847,7 @@ Displays all options for the scrolling behavior

    - $p_in_Min + $p_in_min : int
    @@ -2671,7 +2856,7 @@ Displays all options for the scrolling behavior

    - $p_int_Max + $p_int_max : int
    @@ -2680,11 +2865,11 @@ Displays all options for the scrolling behavior

    - $p_bool_Deci + $p_bool_deci : bool = false
    -

    true if 0.1 steps and floating to string, false if integer (default)

    +

    true if 0.1 steps and floating to string, false if integer (default).

    @@ -2697,15 +2882,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2720,7 +2896,7 @@ Displays all options for the scrolling behavior

    2.1.4 -

    step argument and number_format() to allow decimals 2020-12-03T0631+0100..2020-12-12T1110+0100

    +

    step argument and number_format() to allow decimals ..

    @@ -2740,28 +2916,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addSection() - +

    + add_section() +

    Returns an array describing a sub page section.

    protected - addSection(string $p_str_ID, string $p_str_Title, int $p_int_SettingsContainerIndex[, bool $p_bool_hasSubmitButton = true ]) : array<string|int, mixed> + add_section(string $p_str_id, string $p_str_title, int $p_int_settings_container_index[, bool $p_bool_has_submit_button = true ]) : array<string|int, mixed>
    Parameters
    - $p_str_ID + $p_str_id : string
    @@ -2770,7 +2946,7 @@ Displays all options for the scrolling behavior

    - $p_str_Title + $p_str_title : string
    @@ -2779,7 +2955,7 @@ Displays all options for the scrolling behavior

    - $p_int_SettingsContainerIndex + $p_int_settings_container_index : int
    @@ -2788,7 +2964,7 @@ Displays all options for the scrolling behavior

    - $p_bool_hasSubmitButton + $p_bool_has_submit_button : bool = true
    @@ -2805,15 +2981,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2838,28 +3005,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addSelectBox() - +

    + add_select_box() +

    Returns the html tag for a select box.

    protected - addSelectBox(string $p_str_SettingName, array<string|int, mixed> $p_arr_Options) : string + add_select_box(string $p_str_setting_name, array<string|int, mixed> $p_arr_options) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -2868,7 +3035,7 @@ Displays all options for the scrolling behavior

    - $p_arr_Options + $p_arr_options : array<string|int, mixed>
    @@ -2885,22 +3052,54 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 +
      +
    • Bugfix: Dashboard: Referrers and tooltips: Backlink symbol: debug select box by reverting identity check to equality check, thanks to @lolzim bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.5.13 +
    +
    +
    + since +
    +
    + 2.5.15 + +

    Bugfix: Dashboard: General settings: Footnote start and end short codes: debug select box for shortcodes with pointy brackets.

    +
    + +
    +
    + since +
    +
    + 2.6.1 + +

    Restore esc_attr() in load_setting(), remove htmlspecialchars() here.

    +
    + +
    +
    + reporter +
    +
    + +

    @lolzim

    +
    +
    @@ -2917,28 +3116,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addText() - +

    + add_text() +

    Returns a simple text inside html <span> text.

    protected - addText(string $p_str_Text) : string + add_text(string $p_str_text) : string
    Parameters
    - $p_str_Text + $p_str_text : string
    @@ -2955,15 +3154,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2987,98 +3177,28 @@ Displays all options for the scrolling behavior

    -protected " > -

    - addTextArea() - +

    + add_text_box() +

    - -

    Returns the html tag for a text area.

    - - - protected - addTextArea(string $p_str_SettingName) : string - -
    - -
    Parameters
    -
    -
    - $p_str_SettingName - : string -
    -
    -

    Name of the Settings key to pre fill the text area.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    Return values
    - string - — -
    - - -
    -
    -

    - addTextBox() - -

    -

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

    protected - addTextBox(string $p_str_SettingName[, int $p_str_MaxLength = 999 ][, bool $p_bool_Readonly = false ][, bool $p_bool_Hidden = false ]) : string + add_text_box(string $p_str_setting_name[, int $p_str_max_length = 999 ][, bool $p_bool_readonly = false ][, bool $p_bool_hidden = false ]) : string
    Parameters
    - $p_str_SettingName + $p_str_setting_name : string
    @@ -3087,7 +3207,7 @@ Displays all options for the scrolling behavior

    - $p_str_MaxLength + $p_str_max_length : int = 999
    @@ -3096,7 +3216,7 @@ Displays all options for the scrolling behavior

    - $p_bool_Readonly + $p_bool_readonly : bool = false
    @@ -3105,7 +3225,7 @@ Displays all options for the scrolling behavior

    - $p_bool_Hidden + $p_bool_hidden : bool = false
    @@ -3122,15 +3242,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -3154,21 +3265,82 @@ Displays all options for the scrolling behavior

    -protected " > -

    - getMetaBoxes() - +

    + add_textarea() + +

    + + +

    Returns the html tag for a text area.

    + + + protected + add_textarea(string $p_str_setting_name) : string + +
    + +
    Parameters
    +
    +
    + $p_str_setting_name + : string +
    +
    +

    Name of the Settings key to pre fill the text area.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + get_meta_boxes() +

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

    protected - getMetaBoxes() : array<string|int, mixed> + get_meta_boxes() : array<string|int, mixed>
    @@ -3180,15 +3352,6 @@ Displays all options for the scrolling behavior

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -3235,7 +3398,7 @@ Displays all options for the scrolling behavior

    to reflect changes in meta box label display since WPv5.5 spans need position:fixed and become unlocalizable -fix: logo is kept only in the label that doesn’t need to be translated: +fix: logo is kept only in the label that doesn't need to be translated: Change string "%s styling" to "Footnotes styling" to fix layout in WPv5.5

    @@ -3266,7 +3429,7 @@ Change string "%s styling" to "Footnotes styling" to fix lay array<string|int, mixed> —

    Edited for 2.0.0 and later.

    -

    HyperlinkArrow meta box:

    +

    hyperlink_arrow meta box:

    @@ -3277,21 +3440,21 @@ Change string "%s styling" to "Footnotes styling" to fix lay -protected " > -

    - getSections() - +

    + get_sections() +

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

    protected - getSections() : array<string|int, mixed> + get_sections() : array<string|int, mixed>
    @@ -3303,15 +3466,6 @@ Change string "%s styling" to "Footnotes styling" to fix lay
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -3363,21 +3517,21 @@ Change string "%s styling" to "Footnotes styling" to fix lay -protected " > -

    - getSubPageSlug() - +

    + get_sub_page_slug() +

    Returns the unique slug of the sub page.

    protected - getSubPageSlug() : string + get_sub_page_slug() : string
    @@ -3389,15 +3543,6 @@ Change string "%s styling" to "Footnotes styling" to fix lay
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -3421,21 +3566,21 @@ Change string "%s styling" to "Footnotes styling" to fix lay -protected " > -

    - getSubPageTitle() - +

    + get_sub_page_title() +

    Returns the title of the sub page.

    protected - getSubPageTitle() : string + get_sub_page_title() : string
    @@ -3447,15 +3592,6 @@ Change string "%s styling" to "Footnotes styling" to fix lay
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -3479,9 +3615,9 @@ Change string "%s styling" to "Footnotes styling" to fix lay -protected " > -

    - LoadSetting() - +

    + load_setting() +

    -

    - C_BOOL_FOOTNOTE_URL_WRAP_ENABLED - +

    + C_STR_FOOTNOTE_URL_WRAP_ENABLED +

    -

    Settings Container Key for URL wrap option

    +

    Settings container key for URL wrap option.

    public str - C_BOOL_FOOTNOTE_URL_WRAP_ENABLED - = "footnote_inputfield_url_wrap_enabled" + C_STR_FOOTNOTE_URL_WRAP_ENABLED + = 'footnote_inputfield_url_wrap_enabled' @@ -1516,15 +3596,161 @@ Unicode-compliant browsers break URLs at slashes.

    -

    - C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE - +

    + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION +

    + +

    Settings container key for alternative tooltip position.

    + + + public + str + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + = 'footnotes_inputfield_alternative_mouse_over_box_position' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.2.5 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE + +

    + + + +

    Settings container key to enable AMP compatibility mode.

    + + + public + str + C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE + = 'footnotes_inputfield_amp_compatibility_enable' + + + +
      +
    • Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.
      • +
    • Bugfix: Tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.
      • +
    • Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + contributor +
    +
    + +

    @milindmore22

    +
    + +
    +
    + contributor +
    +
    + +

    @westonruter

    +
    + +
    +
    + link +
    +
    + https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + +
    +
    + link +
    +
    + https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 + +
    +
    + link +
    +
    + https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854 + +
    +
    + link +
    +
    + https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394 + +
    +
    + since +
    +
    + 2.5.11 + +

    (draft)

    +
    + +
    +
    + since +
    +
    + 2.6.0 + +

    (release)

    +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + +

    + +

    Settings container key to enable backlink tooltips.

    @@ -1532,8 +3758,8 @@ Unicode-compliant browsers break URLs at slashes.

    public str - C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE - = "footnotes_inputfield_backlink_tooltip_enable" + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + = 'footnotes_inputfield_backlink_tooltip_enable' @@ -1549,15 +3775,6 @@ Unicode-compliant browsers break URLs at slashes.

    - since -
    -
    - 2.5.4 - -
    - -
    -
    reporter
    @@ -1570,10 +3787,7 @@ Unicode-compliant browsers break URLs at slashes.

    link
    -

    When hard links are enabled, clicks on the backlinks are logged in the browsing history, -along with clicks on the referrers. -This tooltip hints to use the backbutton instead, so the history gets streamlined again.

    -     + https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/
    @@ -1582,29 +3796,99 @@ This tooltip hints to use the backbutton instead, so the history gets streamline
    https://wordpress.org/support/topic/making-it-amp-compatible/#post-13837359 +
    +
    + since +
    +
    + 2.5.4 + +
    +
    -

    - C_BOOL_FOOTNOTES_EXPERT_MODE - +

    + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT +

    -

    Settings Container Key for the Expert mode.

    +

    Settings container key to configure the backlink tooltip.

    public str - C_BOOL_FOOTNOTES_EXPERT_MODE - = "footnote_inputfield_enable_expert_mode" + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + = 'footnotes_inputfield_backlink_tooltip_text' + + + +
      +
    • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @theroninjedi47

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/ + +
    +
    + since +
    +
    + 2.5.4 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_COUNTER_STYLE + +

    + + + +

    Settings container key for the counter style of the footnotes.

    + + + public + str + C_STR_FOOTNOTES_COUNTER_STYLE + = 'footnote_inputfield_counter_style' @@ -1617,15 +3901,125 @@ This tooltip hints to use the backbutton instead, so the history gets streamline
    - author + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING + +

    + + + +

    Settings container key to enable CSS smooth scrolling.

    + + + public + str + C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING + = 'footnotes_inputfield_css_smooth_scrolling' + + + +
      +
    • Update: Scrolling: CSS-based smooth scroll behavior (optional), thanks to @paulgpetty and @bogosavljev issue reports.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter
    -

    Stefan Herndler

    +

    @paulgpetty

    +
    + +
    +
    + reporter +
    +
    + +

    @bogosavljev

    + link +
    +
    + https://wordpress.org/support/topic/functionally-great/#post-13607795 + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/compatibility-issue-with-wpforms/#post-14214720 + +
    +
    + since +
    +
    + 2.5.12 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_EXPERT_MODE + +

    + + + +

    Settings container key for the Expert mode.

    + + + public + str + C_STR_FOOTNOTES_EXPERT_MODE + = 'footnote_inputfield_enable_expert_mode' + + + +
    + + +
    + Tags + +
    +
    +
    since
    @@ -1641,15 +4035,6 @@ This tooltip hints to use the backbutton instead, so the history gets streamline 2.1.6

    This setting removed as irrelevant since priority level settings need permanent visibility.

    -
    - -
    -
    - date -
    -
    - -

    2020-12-09T2107+0100

    Since the removal of the the_post hook, the tab is no danger zone any longer. All users, not experts only, need to be able to control relative positioning.

    @@ -1659,49 +4044,101 @@ All users, not experts only, need to be able to control relative positioning.

    -

    - C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE - +

    + C_STR_FOOTNOTES_HARD_LINKS_ENABLE +

    - - - public - mixed - C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE - = "footnotes_inputfield_hard_links_enable" - - - - - - -
    -
    -

    - C_BOOL_FOOTNOTES_IN_EXCERPT - -

    - - - -

    Settings Container Key to look for footnotes in post excerpts.

    +

    Settings container key to enable hard links.

    public str - C_BOOL_FOOTNOTES_IN_EXCERPT - = "footnote_inputfield_search_in_excerpt" + C_STR_FOOTNOTES_HARD_LINKS_ENABLE + = 'footnotes_inputfield_hard_links_enable' + + + +
      +
    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro issue report, thanks to @martinneumannat issue report and code contribution.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + contributor +
    +
    + +

    @martinneumannat

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/making-it-amp-compatible/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-is-not-amp-compatible/ + +
    +
    + reporter +
    +
    + +

    @psykonevro

    +
    + +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_IN_EXCERPT + +

    + + + +

    Settings container key to look for footnotes in post excerpts.

    + + + public + str + C_STR_FOOTNOTES_IN_EXCERPT + = 'footnote_inputfield_search_in_excerpt' @@ -1714,15 +4151,154 @@ All users, not experts only, need to be able to control relative positioning.

    - author + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.6.2 + +

    Debug No option.

    +
    + +
    +
    + since +
    +
    + 2.6.3 + +

    Enable by default after debugging both Yes and No options.

    +
      +
    • Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.7.0 + +
    + +
    +
    + reporter
    -

    Stefan Herndler

    +

    @mfessler

    + link +
    +
    + https://github.com/markcheret/footnotes/issues/65 + +
    +
    + see +
    +
    + C_STR_EXPERT_LOOKUP_THE_EXCERPT + +
    + +
    +
    + +
    + +
    +

    + C_STR_FOOTNOTES_LOVE + +

    + + + +

    Settings container key for the 'I love footnotes' text.

    + + + public + str + C_STR_FOOTNOTES_LOVE + = 'footnote_inputfield_love' + + + +
    + + +
    + Tags + +
    +
    +
    since
    @@ -1735,24 +4311,24 @@ All users, not experts only, need to be able to control relative positioning.

    -

    - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE - +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE +

    -

    Settings Container Key to enable the alternative tooltips.

    +

    Settings container key to enable the alternative tooltips.

    public str - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE - = "footnote_inputfield_custom_mouse_over_box_alternative" + C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + = 'footnote_inputfield_custom_mouse_over_box_alternative' @@ -1768,24 +4344,6 @@ All users, not experts only, need to be able to control relative positioning.

    - since -
    -
    - 2.1.1 - -
    - -
    -
    - date -
    -
    - -

    2020-11-11T1817+0100

    -
    - -
    -
    reporter
    @@ -1800,29 +4358,38 @@ All users, not experts only, need to be able to control relative positioning.

    https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566 +
    +
    + since +
    +
    + 2.1.1 + +
    +
    -

    - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED - +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND +

    -

    Settings Container Key to enable the mouse-over box.

    +

    Settings container key for the mouse-over box to define the background color.

    public str - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED - = "footnote_inputfield_custom_mouse_over_box_enabled" + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + = 'footnote_inputfield_custom_mouse_over_box_background' @@ -1835,15 +4402,257 @@ All users, not experts only, need to be able to control relative positioning.

    - author + since
    + 1.5.6 -

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.2.5..1.5.5 + +

    #fff7a7 hard-coded.

    +
    + +
    +
    + since +
    +
    + 1.5.6..2.0.6 + +

    #fff7a7 setting default. +The mouse over box shouldn’t feature a colored background. +By default, due to diverging user preferences. White is neutral.

    +
    + +
    +
    + since +
    +
    + 2.0.7..2.5.10 + +

    #ffffff setting default.

    +
      +
    • Bugfix: Tooltips: Styling: Background color: empty default value to adopt theme background, thanks to 4msc bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.5.11 + +

    Theme default background color is best. +But theme default background color doesn’t seem to exist.

    +
    + +
    +
    + since +
    +
    + 2.6.1 + +

    default #ffffff again along with #000000 as font color.

    + reporter +
    +
    + +

    @4msc

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/tooltip-not-showing-on-dark-theme-with-white-text/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/#post-14241849 + +
    +
    + see +
    +
    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + +

    + + + +

    Settings container key for the mouse-over box to define the border color.

    + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + = 'footnote_inputfield_custom_mouse_over_box_border_color' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.6 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +

    + + + +

    Settings container key for the mouse-over box to define the color.

    + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + = 'footnote_inputfield_custom_mouse_over_box_color' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.6 + +
      +
    • Bugfix: Tooltips: Styling: Font color: set to black for maximum contrast with respect to white default background, thanks to 4msc bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.6.1 + +
    + +
    +
    + reporter +
    +
    + +

    @4msc

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/tooltip-not-showing-on-dark-theme-with-white-text/ + +
    +
    + see +
    +
    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + +

    + + + +

    Settings container key to enable the mouse-over box.

    + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + = 'footnote_inputfield_custom_mouse_over_box_enabled' + + + +
    + + +
    + Tags + +
    +
    +
    since
    @@ -1856,24 +4665,24 @@ All users, not experts only, need to be able to control relative positioning.

    -

    - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED - +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED +

    -

    Settings Container Key to enable tooltip truncation.

    +

    Settings container key to enable tooltip truncation.

    public str - C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED - = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled" + C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + = 'footnote_inputfield_custom_mouse_over_box_excerpt_enabled' @@ -1886,15 +4695,6 @@ All users, not experts only, need to be able to control relative positioning.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1907,24 +4707,211 @@ All users, not experts only, need to be able to control relative positioning.

    -

    - C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS - +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION +

    -

    Settings Container Key for the referrer element.

    +

    Settings container key for the mouse-over box to define the position.

    public str - C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS - = "footnotes_inputfield_referrer_superscript_tags" + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + = 'footnote_inputfield_custom_mouse_over_box_position' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.7 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + +

    + + + +

    Settings container key for the mouse-over box to define the box-shadow color.

    + + + public + str + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + = 'footnote_inputfield_custom_mouse_over_box_shadow_color' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.8 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + +

    + + + +

    Settings container key for basic responsive page layout support options.

    + + + public + str + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + = 'footnotes_inputfield_page_layout_support' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.1.4 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + +

    + + + +

    Settings container key to select the script mode for the reference container.

    + + + public + str + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + = 'footnotes_inputfield_reference_container_script_mode' + + + +
      +
    • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @hopper87it

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-wp-rocket/ + +
    +
    + since +
    +
    + 2.5.6 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + +

    + + + +

    Settings container key for the referrer element.

    + + + public + str + C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + = 'footnotes_inputfield_referrer_superscript_tags' @@ -1940,24 +4927,6 @@ All users, not experts only, need to be able to control relative positioning.

    - since -
    -
    - 2.1.1 - -
    - -
    -
    - date -
    -
    - -

    2020-11-16T0859+0100

    -
    - -
    -
    reporter
    @@ -1972,20 +4941,386 @@ All users, not experts only, need to be able to control relative positioning.

    https://wordpress.org/support/topic/footnote-number-in-text-superscript-disrupts-leading/ +
    +
    + since +
    +
    + 2.1.1 + +
    +
    -

    - C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE - +

    + C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY +

    + +

    Settings container key for scroll duration asymmetricity.

    + + + public + str + C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY + = 'footnotes_inputfield_scroll_duration_asymmetricity' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.5.11 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_SHORT_CODE_END + +

    + + + +

    Settings container key for the short code of the footnote’s end.

    + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_END + = 'footnote_inputfield_placeholder_end' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + +

    + + + +

    Settings container key for the user-defined short code of the footnotes end.

    + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + = 'footnote_inputfield_placeholder_end_user_defined' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_SHORT_CODE_START + +

    + + + +

    Settings container key for the short code of the footnote’s start.

    + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_START + = 'footnote_inputfield_placeholder_start' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + +

    + + + +

    Settings container key for the user-defined short code of the footnotes start.

    + + + public + str + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + = 'footnote_inputfield_placeholder_start_user_defined' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_STYLING_AFTER + +

    + + + +

    Settings container key for the string after the footnote referrer.

    + + + public + str + C_STR_FOOTNOTES_STYLING_AFTER + = 'footnote_inputfield_custom_styling_after' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_STYLING_BEFORE + +

    + + + +

    Settings container key for the string before the footnote referrer.

    + + + public + str + C_STR_FOOTNOTES_STYLING_BEFORE + = 'footnote_inputfield_custom_styling_before' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + +

    + + + +

    Settings container key to configure the tooltip excerpt delimiter.

    + + + public + str + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + = 'footnotes_inputfield_tooltip_excerpt_delimiter' + + + +
      +
    • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
      • +
    +

    The first implementation used a fixed shortcode provided in the changelog. +But Footnotes’ UI design policy is to make shortcodes freely configurable.

    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @jbj2199

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/change-tooltip-text/ + +
    +
    + since +
    +
    + 2.5.4 + +
    + +
    +
    + +
    +
    +

    + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + +

    + +

    Settings container key to enable mirroring the tooltip excerpt in the reference container.

    @@ -1993,8 +5328,8 @@ All users, not experts only, need to be able to control relative positioning.

    public str - C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE - = "footnotes_inputfield_tooltip_excerpt_mirror_enable" + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + = 'footnotes_inputfield_tooltip_excerpt_mirror_enable' @@ -2032,2615 +5367,6 @@ All users, not experts only, need to be able to control relative positioning.

    -
    -
    -

    - C_BOOL_LINK_ELEMENT_ENABLED - -

    - - - -

    Settings Container Keys for the link element option -Settings Container Keys for backlink typography and layout -Settings Container Keys for tooltip font size -Settings Container Keys for page layout support -Settings Container Keys for scroll offset and duration -Settings Container Keys for tooltip display durations

    - - - public - str|bool|int|flo - C_BOOL_LINK_ELEMENT_ENABLED - = "footnote_inputfield_link_element_enabled" - - - -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.4 - -
    - -
    -
    - -
    -
    -

    - C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED - -

    - - - - - - public - mixed - C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED - = "footnotes_inputfield_mouse_over_box_font_size_enabled" - - - - - - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE - -

    - - - -

    Settings Container Key to enable the legacy layout of the reference container.

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE - = "footnotes_inputfield_reference_container_3column_layout_enable" - - - -
      -
    • Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.1 - -
    - -
    -
    - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE - -

    - - - -

    Settings Container Key to enable the display of a backlink symbol.

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE - = "footnotes_inputfield_reference_container_backlink_symbol_enable" - - - -
      -
    • Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.1 - -
    - -
    -
    - reporter -
    -
    - -

    @spaceling

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/change-the-position-5/page/2/#post-13671138 - -
    -
    - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH - -

    - - - -

    Settings Container Key to get the backlink symbol switch side.

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH - = "footnotes_inputfield_reference_container_backlink_symbol_switch" - - - -
      -
    • Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.1 - -
    - -
    -
    - date -
    -
    - -

    2020-11-16T2024+0100

    -
    - -
    -
    - contributor -
    -
    - -

    @spaceling

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/change-the-position-5/#post-13615994 - -
    -
    - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_COLLAPSE - -

    - - - -

    Settings Container Key to collapse the reference container by default.

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_COLLAPSE - = "footnote_inputfield_collapse_references" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - see -
    -
    - MCI_Footnotes_Convert::toBool() - -

    The type in the variable name is useful to show the intention.

    -
    - -
    -
    - todo -
    -
    - -

    Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).

    -
    - -
    -
    - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER - -

    - - - - - - public - mixed - C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER - = "footnotes_inputfield_reference_container_label_bottom_border" - - - - - - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE - -

    - - - -

    Settings Container Key for table cell borders, thanks to @noobishh

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE - = "footnotes_inputfield_reference_container_row_borders_enable" - - - -
    - - -
    - Tags - -
    -
    -
    - link -
    -
    - https://wordpress.org/support/topic/borders-25/ - -
    -
    - since -
    -
    - 2.2.10 - -
    - -
    -
    - -
    -
    -

    - C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE - -

    - - - -

    Settings Container Key to not display the reference container on the homepage.

    - - - public - str - C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE - = "footnotes_inputfield_reference_container_start_page_enable" - - - -
      -
    • Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.1 - -
    - -
    -
    - reporter -
    -
    - -

    @dragon013

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/possible-to-hide-it-from-start-page/ - -
    -
    - -
    -
    -

    - C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR - -

    - - - - - - public - mixed - C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR - = "footnotes_inputfield_mouse_over_box_font_size_scalar" - - - - - - -
    -
    -

    - C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR - -

    - - - - - - public - mixed - C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR - = "footnotes_inputfield_backlinks_column_max_width_scalar" - - - - - - -
    -
    -

    - C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR - -

    - - - - - - public - mixed - C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR - = "footnotes_inputfield_backlinks_column_width_scalar" - - - - - - -
    -
    -

    - C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL - -

    - - - -

    Settings Container Key for 'the_content' hook priority level.

    - - - public - str - C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL - = "footnote_inputfield_expert_lookup_the_content_priority_level" - - - -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.1 - -
    - -
    -
    - date -
    -
    - -

    2020-11-16T0859+0100

    -
    - -
    -
    - -
    -
    -

    - C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL - -

    - - - - - - public - mixed - C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL - = "footnote_inputfield_expert_lookup_the_excerpt_priority_level" - - - - - - -
    -
    -

    - C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL - -

    - - - -

    Settings Container Key for '' hook priority level

    - - - public - str - C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL - = "footnote_inputfield_expert_lookup_the_title_priority_level" - - - -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.2 - -
    - -
    -
    - date -
    -
    - -

    2020-11-20T0620+0100

    -
    - -
    -
    - -
    -
    -

    - C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL - -

    - - - - - - public - mixed - C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL - = "footnote_inputfield_expert_lookup_widget_text_priority_level" - - - - - - -
    -
    -

    - C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL - -

    - - - - - - public - mixed - C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL - = "footnote_inputfield_expert_lookup_widget_title_priority_level" - - - - - - -
    -
    -

    - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X - -

    - - - - - - public - mixed - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X - = "footnotes_inputfield_alternative_mouse_over_box_offset_x" - - - - - - -
    -
    -

    - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y - -

    - - - - - - public - mixed - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y - = "footnotes_inputfield_alternative_mouse_over_box_offset_y" - - - - - - -
    -
    -

    - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH - -

    - - - - - - public - mixed - C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH - = "footnotes_inputfield_alternative_mouse_over_box_width" - - - - - - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS - -

    - - - -

    Settings Container Key for the mouse-over box to define the border radius.

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS - = "footnote_inputfield_custom_mouse_over_box_border_radius" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH - -

    - - - -

    Settings Container Key for the mouse-over box to define the border width.

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH - = "footnote_inputfield_custom_mouse_over_box_border_width" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH - -

    - - - -

    Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH - = "footnote_inputfield_custom_mouse_over_box_excerpt_length" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.4 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH - -

    - - - -

    Settings Container Key for the mouse-over box to define the max. width.

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH - = "footnote_inputfield_custom_mouse_over_box_max_width" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X - -

    - - - -

    Settings Container Key for the mouse-over box to define the offset (x).

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X - = "footnote_inputfield_custom_mouse_over_box_offset_x" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.7 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y - -

    - - - -

    Settings Container Key for the mouse-over box to define the offset (y).

    - - - public - str - C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y - = "footnote_inputfield_custom_mouse_over_box_offset_y" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.7 - -
    - -
    -
    - -
    -
    -

    - C_INT_FOOTNOTES_SCROLL_DURATION - -

    - - - - - - public - mixed - C_INT_FOOTNOTES_SCROLL_DURATION - = "footnotes_inputfield_scroll_duration" - - - - - - -
    -
    -

    - C_INT_FOOTNOTES_SCROLL_OFFSET - -

    - - - -

    Scroll offset and duration

    - - - public - mixed - C_INT_FOOTNOTES_SCROLL_OFFSET - = "footnotes_inputfield_scroll_offset" - - - -
      -
    • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
      • -
    • Bugfix: Scroll duration: make configurable to conform to website content and style requirements.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.1.4 - -
    - -
    -
    - date -
    -
    - -

    2020-12-05T0538+0100

    -
    - -
    -
    - -
    -
    -

    - C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY - -

    - - - - - - public - mixed - C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY - = "footnotes_inputfield_mouse_over_box_fade_in_delay" - - - - - - -
    -
    -

    - C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION - -

    - - - - - - public - mixed - C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION - = "footnotes_inputfield_mouse_over_box_fade_in_duration" - - - - - - -
    -
    -

    - C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY - -

    - - - - - - public - mixed - C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY - = "footnotes_inputfield_mouse_over_box_fade_out_delay" - - - - - - -
    -
    -

    - C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION - -

    - - - - - - public - mixed - C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION - = "footnotes_inputfield_mouse_over_box_fade_out_duration" - - - - - - -
    -
    -

    - C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN - -

    - - - - - - public - mixed - C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN - = "footnotes_inputfield_reference_container_bottom_margin" - - - - - - -
    -
    -

    - C_INT_REFERENCE_CONTAINER_TOP_MARGIN - -

    - - - -

    Settings container keys for reference container top and bottom margins -Settings container keys for hard link enabling -Settings container keys for hard link anchors in referrers and footnotes

    - - - public - int|bool|str - C_INT_REFERENCE_CONTAINER_TOP_MARGIN - = "footnotes_inputfield_reference_container_top_margin" - - - -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.3.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT - -

    - - - - - - public - mixed - C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT - = "footnotes_inputfield_backlinks_column_max_width_unit" - - - - - - -
    -
    -

    - C_STR_BACKLINKS_COLUMN_WIDTH_UNIT - -

    - - - - - - public - mixed - C_STR_BACKLINKS_COLUMN_WIDTH_UNIT - = "footnotes_inputfield_backlinks_column_width_unit" - - - - - - -
    -
    -

    - C_STR_BACKLINKS_SEPARATOR_CUSTOM - -

    - - - - - - public - mixed - C_STR_BACKLINKS_SEPARATOR_CUSTOM - = "footnotes_inputfield_backlinks_separator_custom" - - - - - - -
    -
    -

    - C_STR_BACKLINKS_SEPARATOR_OPTION - -

    - - - - - - public - mixed - C_STR_BACKLINKS_SEPARATOR_OPTION - = "footnotes_inputfield_backlinks_separator_option" - - - - - - -
    -
    -

    - C_STR_BACKLINKS_TERMINATOR_CUSTOM - -

    - - - - - - public - mixed - C_STR_BACKLINKS_TERMINATOR_CUSTOM - = "footnotes_inputfield_backlinks_terminator_custom" - - - - - - -
    -
    -

    - C_STR_BACKLINKS_TERMINATOR_OPTION - -

    - - - - - - public - mixed - C_STR_BACKLINKS_TERMINATOR_OPTION - = "footnotes_inputfield_backlinks_terminator_option" - - - - - - -
    -
    -

    - C_STR_CUSTOM_CSS - -

    - - - -

    Settings Container Key for the Custom CSS.

    - - - public - str - C_STR_CUSTOM_CSS - = "footnote_inputfield_custom_css" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 1.3.0 - -

    Adding: new settings tab for custom CSS settings.

    -
    - -
    -
    - -
    -
    -

    - C_STR_CUSTOM_CSS_NEW - -

    - - - -

    Settings Container Key for the Custom CSS migrated to a dedicated tab.

    - - - public - str - C_STR_CUSTOM_CSS_NEW - = "footnote_inputfield_custom_css_new" - - - -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.2.2 - -

    Bugfix: Dashboard: Custom CSS: unearth text area and migrate to dedicated tab as designed.

    -
    - -
    -
    - date -
    -
    - -

    2020-12-15T0520+0100

    -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTE_FRAGMENT_ID_SLUG - -

    - - - - - - public - mixed - C_STR_FOOTNOTE_FRAGMENT_ID_SLUG - = "footnotes_inputfield_footnote_fragment_id_slug" - - - - - - -
    -
    -

    - C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT - -

    - - - -

    Settings container key to enable superscript style normalization.

    - - - public - str - C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT - = "footnotes_inputfield_referrers_normal_superscript" - - - -

    -Bugfix: Referrers: optional fixes to vertical alignment, font size and position (static) for in-theme consistency and cross-theme stability, thanks to @tomturowski bug report.

    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.5.4 - -
    - -
    -
    - reporter -
    -
    - -

    @tomturowski

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/in-line-superscript-ref-rides-to-high/ - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION - -

    - - - -

    Settings Container Keys for alternative tooltip position -Settings Container Keys for reference container label element, thanks to @markhillyer

    - - - public - int - C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION - = "footnotes_inputfield_alternative_mouse_over_box_position" - - - -
    - - -
    - Tags - -
    -
    -
    - link -
    -
    - https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ - -
    -
    - since -
    -
    - 2.2.5 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT - -

    - - - -

    Settings container key to configure the backlink tooltip.

    - - - public - str - C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT - = "footnotes_inputfield_backlink_tooltip_text" - - - -
      -
    • Update: Reference container: Hard backlinks (optional): optional configurable tooltip hinting to use the backbutton instead, thanks to @theroninjedi47 bug report.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.5.4 - -
    - -
    -
    - reporter -
    -
    - -

    @theroninjedi47

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/ - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_COUNTER_STYLE - -

    - - - -

    Settings Container Key for the counter style of the footnotes.

    - - - public - str - C_STR_FOOTNOTES_COUNTER_STYLE - = "footnote_inputfield_counter_style" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_LOVE - -

    - - - -

    Settings Container Key for the 'I love footnotes' text.

    - - - public - str - C_STR_FOOTNOTES_LOVE - = "footnote_inputfield_love" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND - -

    - - - -

    Settings Container Key for the mouse-over box to define the background color.

    - - - public - str - C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND - = "footnote_inputfield_custom_mouse_over_box_background" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR - -

    - - - -

    Settings Container Key for the mouse-over box to define the border color.

    - - - public - str - C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR - = "footnote_inputfield_custom_mouse_over_box_border_color" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR - -

    - - - -

    Settings Container Key for the mouse-over box to define the color.

    - - - public - str - C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR - = "footnote_inputfield_custom_mouse_over_box_color" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.6 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION - -

    - - - -

    Settings Container Key for the mouse-over box to define the position.

    - - - public - str - C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION - = "footnote_inputfield_custom_mouse_over_box_position" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.7 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR - -

    - - - -

    Settings Container Key for the mouse-over box to define the box-shadow color.

    - - - public - str - C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR - = "footnote_inputfield_custom_mouse_over_box_shadow_color" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.8 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT - -

    - - - - - - public - mixed - C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT - = "footnotes_inputfield_page_layout_support" - - - - - - -
    -
    -

    - C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE - -

    - - - -

    Settings container key to select the script mode for the reference container.

    - - - public - str - C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE - = "footnotes_inputfield_reference_container_script_mode" - - - -
      -
    • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.5.6 - -
    - -
    -
    - reporter -
    -
    - -

    @hopper87it

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/footnotes-wp-rocket/ - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_SHORT_CODE_END - -

    - - - -

    Settings Container Key for the short code of the footnote’s end.

    - - - public - str - C_STR_FOOTNOTES_SHORT_CODE_END - = "footnote_inputfield_placeholder_end" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED - -

    - - - -

    Settings Container Key for the user-defined short code of the footnotes end.

    - - - public - str - C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED - = "footnote_inputfield_placeholder_end_user_defined" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_SHORT_CODE_START - -

    - - - -

    Settings Container Key for the short code of the footnote’s start.

    - - - public - str - C_STR_FOOTNOTES_SHORT_CODE_START - = "footnote_inputfield_placeholder_start" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED - -

    - - - -

    Settings Container Key for the user-defined short code of the footnotes start.

    - - - public - str - C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED - = "footnote_inputfield_placeholder_start_user_defined" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_STYLING_AFTER - -

    - - - -

    Settings Container Key for the string after the footnote referrer.

    - - - public - str - C_STR_FOOTNOTES_STYLING_AFTER - = "footnote_inputfield_custom_styling_after" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_STYLING_BEFORE - -

    - - - -

    Settings Container Key for the string before the footnote referrer.

    - - - public - str - C_STR_FOOTNOTES_STYLING_BEFORE - = "footnote_inputfield_custom_styling_before" - - - -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - -
    -
    -

    - C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER - -

    - - - -

    Settings container key to configure the tooltip excerpt delimiter.

    - - - public - str - C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER - = "footnotes_inputfield_tooltip_excerpt_delimiter" - - - -
      -
    • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
      • -
    -

    The first implementation used a fixed shortcode provided in the changelog. -But Footnotes’ UI design policy is to make shortcodes freely configurable.

    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.5.4 - -
    - -
    -
    - reporter -
    -
    - -

    @jbj2199

    -
    - -
    -
    - link -
    -
    -

    Tooltips can display another content than the footnote entry -in the reference container. The trigger is a shortcode in -the footnote text separating the tooltip text from the note. -That is consistent with what WordPress does for excerpts.

    -     - -
    -
    -

    @@ -4651,7 +5377,7 @@ That is consistent with what WordPress does for excerpts.

    Settings container key to configure the tooltip excerpt separator in the reference container.

    @@ -4660,7 +5386,7 @@ That is consistent with what WordPress does for excerpts.

    public str C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR - = "footnotes_inputfield_tooltip_excerpt_mirror_separator" + = 'footnotes_inputfield_tooltip_excerpt_mirror_separator' @@ -4693,16 +5419,16 @@ That is consistent with what WordPress does for excerpts.

    -

    Settings Container Key for the label of the Read-on button in truncated tooltips.

    +

    Settings container key for the label of the Read-on button in truncated tooltips.

    public str C_STR_FOOTNOTES_TOOLTIP_READON_LABEL - = "footnote_inputfield_readon_label" + = 'footnote_inputfield_readon_label' @@ -4718,24 +5444,6 @@ That is consistent with what WordPress does for excerpts.

    - since -
    -
    - 2.1.0 - -
    - -
    -
    - date -
    -
    - -

    2020-11-08T2106+0100

    -
    - -
    -
    reporter
    @@ -4750,6 +5458,15 @@ That is consistent with what WordPress does for excerpts.

    https://wordpress.org/support/topic/offset-x-axis-and-offset-y-axis-does-not-working/ +
    +
    + since +
    +
    + 2.1.0 + +
    +
    @@ -4763,41 +5480,16 @@ That is consistent with what WordPress does for excerpts.

    - - - public - mixed - C_STR_HARD_LINK_IDS_SEPARATOR - = "footnotes_inputfield_hard_link_ids_separator" - - - - - - -
    -
    -

    - C_STR_HYPERLINK_ARROW - -

    - - - -

    Settings Container Key for the backlink symbol selection.

    +

    Settings container key for the ID separator in fragment IDs.

    public str - C_STR_HYPERLINK_ARROW - = "footnote_inputfield_custom_hyperlink_symbol" + C_STR_HARD_LINK_IDS_SEPARATOR + = 'footnotes_inputfield_hard_link_ids_separator' @@ -4810,22 +5502,83 @@ That is consistent with what WordPress does for excerpts.

    - author + since
    + 2.3.0 -

    Stefan Herndler

    -
    +
    -
    +
    + +
    +
    +

    + C_STR_HYPERLINK_ARROW + +

    + + + +

    Settings container key for the backlink symbol selection.

    + + + public + str + C_STR_HYPERLINK_ARROW + = 'footnote_inputfield_custom_hyperlink_symbol' + + + +
    + + +
    + Tags + +
    +
    +
    since
    1.5.0 +
      +
    • Update: Restore arrow settings to customize or disable the now prepended arrow symbol, thanks to @mmallett issue report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.0.4 +
    +
    +
    + reporter +
    +
    + +

    @mmallett

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/mouse-over-broken/#post-13593037 +
    @@ -4839,16 +5592,16 @@ That is consistent with what WordPress does for excerpts.

    -

    Settings Container Key for the user-defined backlink symbol.

    +

    Settings container key for the user-defined backlink symbol.

    public str C_STR_HYPERLINK_ARROW_USER_DEFINED - = "footnote_inputfield_custom_hyperlink_symbol_user" + = 'footnote_inputfield_custom_hyperlink_symbol_user' @@ -4861,19 +5614,113 @@ That is consistent with what WordPress does for excerpts.

    - author + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    +
    +

    + C_STR_LINK_ELEMENT_ENABLED + +

    + + + +

    Settings container key for the link element option.

    + + + public + str + C_STR_LINK_ELEMENT_ENABLED + = 'footnote_inputfield_link_element_enabled' + + + +
      +
    • Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + contributor
    -

    Stefan Herndler

    +

    @docteurfitness

    +
    +
    + link +
    +
    + https://wordpress.org/support/topic/update-2-1-3/#post-13704194 +
    since
    - 1.5.0 + 2.1.4 + +
    + +
    +
    + +
    +
    +

    + C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + +

    + + + +

    Settings container key to enable setting the tooltip font size.

    + + + public + str + C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + = 'footnotes_inputfield_mouse_over_box_font_size_enabled' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.1.4
    @@ -4890,66 +5737,16 @@ That is consistent with what WordPress does for excerpts.

    - - - public - mixed - C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT - = "footnotes_inputfield_mouse_over_box_font_size_unit" - - - - - - -
    -
    -

    - C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT - -

    - - - - - - public - mixed - C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT - = "footnotes_inputfield_reference_container_label_element" - - - - - - -
    -
    -

    - C_STR_REFERENCE_CONTAINER_NAME - -

    - - - -

    Settings Container Key for the label of the reference container.

    +

    Settings container key for the unit of the tooltip font size.

    public str - C_STR_REFERENCE_CONTAINER_NAME - = "footnote_inputfield_references_label" + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + = 'footnotes_inputfield_mouse_over_box_font_size_unit' @@ -4962,15 +5759,388 @@ That is consistent with what WordPress does for excerpts.

    - author + since +
    +
    + 2.1.4 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + +

    + + + +

    Settings container key to enable the legacy layout of the reference container.

    + + + public + str + C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + = 'footnotes_inputfield_reference_container_3column_layout_enable' + + + +
      +
    • Bugfix: Reference container: option to restore pre-2.0.0 layout with the backlink symbol in an extra column.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.1.1 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + +

    + + + +

    Settings container key to enable the display of a backlink symbol.

    + + + public + str + C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + = 'footnotes_inputfield_reference_container_backlink_symbol_enable' + + + +
      +
    • Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter
    -

    Stefan Herndler

    +

    @spaceling

    + link +
    +
    + https://wordpress.org/support/topic/change-the-position-5/page/2/#post-13671138 + +
    +
    + since +
    +
    + 2.1.1 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + +

    + + + +

    Settings container key to get the backlink symbol switch side.

    + + + public + str + C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + = 'footnotes_inputfield_reference_container_backlink_symbol_switch' + + + +
      +
    • Bugfix: Reference container: option to append symbol (prepended by default), thanks to @spaceling code contribution.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + contributor +
    +
    + +

    @spaceling

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/change-the-position-5/#post-13615994 + +
    +
    + since +
    +
    + 2.1.1 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_COLLAPSE + +

    + + + +

    Settings container key to collapse the reference container by default.

    + + + public + str + C_STR_REFERENCE_CONTAINER_COLLAPSE + = 'footnote_inputfield_collapse_references' + + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + see +
    +
    + MCI_Footnotes_Convert::to_bool() + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + +

    + + + +

    Settings container key to enable the reference container label bottom border.

    + + + public + str + C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + = 'footnotes_inputfield_reference_container_label_bottom_border' + + + +
      +
    • Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @markhillyer

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + +
    +
    + since +
    +
    + 2.2.5 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + +

    + + + +

    Settings container key for the reference container label element.

    + + + public + str + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + = 'footnotes_inputfield_reference_container_label_element' + + + +
      +
    • Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @markhillyer

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + +
    +
    + since +
    +
    + 2.2.5 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_NAME + +

    + + + +

    Settings container key for the label of the reference container.

    + + + public + str + C_STR_REFERENCE_CONTAINER_NAME + = 'footnote_inputfield_references_label' + + + +
    + + +
    + Tags + +
    +
    +
    since
    @@ -4991,16 +6161,16 @@ That is consistent with what WordPress does for excerpts.

    -

    Settings Container Key for the position of the reference container.

    +

    Settings container key for the position of the reference container.

    public str C_STR_REFERENCE_CONTAINER_POSITION - = "footnote_inputfield_reference_container_place" + = 'footnote_inputfield_reference_container_place' @@ -5013,15 +6183,6 @@ That is consistent with what WordPress does for excerpts.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5042,20 +6203,23 @@ That is consistent with what WordPress does for excerpts.

    -

    Settings Container Key for reference container position shortcode

    +

    Settings container key for reference container position shortcode.

    public str C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE - = "footnote_inputfield_reference_container_position_shortcode" + = 'footnote_inputfield_reference_container_position_shortcode' -
    +
      +
    • Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report.
      • +
    +
    @@ -5064,6 +6228,22 @@ That is consistent with what WordPress does for excerpts.

    + reporter +
    +
    + +

    @hamshe

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/reference-container-in-elementor/ + +
    +
    since
    @@ -5074,6 +6254,128 @@ That is consistent with what WordPress does for excerpts.

    +
    +
    +

    + C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + +

    + + + +

    Settings container key to enable reference container table row borders.

    + + + public + str + C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + = 'footnotes_inputfield_reference_container_row_borders_enable' + + + +
      +
    • Bugfix: Reference container: add option for table borders to restore pre-2.0.0 design, thanks to @noobishh issue report.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @noobishh

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/borders-25/ + +
    +
    + since +
    +
    + 2.2.10 + +
    + +
    +
    + +
    +
    +

    + C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE + +

    + + + +

    Settings container key to not display the reference container on the homepage.

    + + + public + str + C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE + = 'footnotes_inputfield_reference_container_start_page_enable' + + + +
      +
    • Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @dragon013

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/possible-to-hide-it-from-start-page/ + +
    +
    + since +
    +
    + 2.1.1 + +
    + +
    +
    +

    @@ -5084,20 +6386,37 @@ That is consistent with what WordPress does for excerpts.

    - +

    Settings container key for the fragment ID slug in referrers.

    + public - mixed + str C_STR_REFERRER_FRAGMENT_ID_SLUG - = "footnotes_inputfield_referrer_fragment_id_slug" + = 'footnotes_inputfield_referrer_fragment_id_slug' +
    + - +

    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    @@ -5115,16 +6434,16 @@ That is consistent with what WordPress does for excerpts.

    -private " > -

    - $a_arr_Container - +

    + $a_arr_container +

    Contains all Settings Container names.

    @@ -5132,8 +6451,8 @@ That is consistent with what WordPress does for excerpts.

    private array<string|int, mixed> - $a_arr_Container - = array("footnotes_storage", "footnotes_storage_custom", "footnotes_storage_expert", "footnotes_storage_custom_css") + $a_arr_container + = array('footnotes_storage', 'footnotes_storage_custom', 'footnotes_storage_expert', 'footnotes_storage_custom_css')
    @@ -5144,15 +6463,6 @@ That is consistent with what WordPress does for excerpts.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5171,16 +6481,16 @@ That is consistent with what WordPress does for excerpts.

    -private " > -

    - $a_arr_Default - +

    + $a_arr_default +

    Contains all Default Settings for each Settings Container.

    @@ -5188,162 +6498,147 @@ That is consistent with what WordPress does for excerpts.

    private array<string|int, mixed> - $a_arr_Default - = array("footnotes_storage" => array( - self::C_STR_FOOTNOTES_SHORT_CODE_START => '((', - self::C_STR_FOOTNOTES_SHORT_CODE_END => '))', - self::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED => '', - self::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED => '', - self::C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE => 'yes', - self::C_STR_FOOTNOTES_COUNTER_STYLE => 'arabic_plain', - self::C_BOOL_COMBINE_IDENTICAL_FOOTNOTES => 'yes', - self::C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE => 'no', - self::C_STR_REFERRER_FRAGMENT_ID_SLUG => 'r', - self::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG => 'f', - self::C_STR_HARD_LINK_IDS_SEPARATOR => '+', - self::C_INT_FOOTNOTES_SCROLL_OFFSET => 20, - self::C_INT_FOOTNOTES_SCROLL_DURATION => 380, - // 2.5.4 fast-tracked: - self::C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE => 'yes', - self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT => 'Alt+ ←', - self::C_STR_REFERENCE_CONTAINER_NAME => 'References', - self::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT => 'p', - self::C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER => 'yes', - self::C_BOOL_REFERENCE_CONTAINER_COLLAPSE => 'no', - self::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE => 'jquery', - self::C_STR_REFERENCE_CONTAINER_POSITION => 'post_end', - self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]', - self::C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', - // whether to enqueue additional stylesheet: - self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none', - // top and bottom margins: - self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24, - self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0, - // table cell borders: - self::C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE => 'no', - // backlink symbol: - self::C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no', - self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', - self::C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no', - // backlink separators and terminators are often not preferred. - // but a choice must be provided along with the ability to customize: - self::C_BOOL_BACKLINKS_SEPARATOR_ENABLED => 'yes', - self::C_STR_BACKLINKS_SEPARATOR_OPTION => 'comma', - self::C_STR_BACKLINKS_SEPARATOR_CUSTOM => '', - self::C_BOOL_BACKLINKS_TERMINATOR_ENABLED => 'no', - self::C_STR_BACKLINKS_TERMINATOR_OPTION => 'full_stop', - self::C_STR_BACKLINKS_TERMINATOR_CUSTOM => '', - // set backlinks column width: - self::C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED => 'no', - self::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR => '50', - self::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT => 'px', - // set backlinks column max. width: - self::C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED => 'no', - self::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR => '140', - self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT => 'px', - // whether a <br /> tag is inserted: - self::C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED => 'no', - // whether to enable URL line wrapping: - self::C_BOOL_FOOTNOTE_URL_WRAP_ENABLED => 'yes', - // whether to use link elements: - self::C_BOOL_LINK_ELEMENT_ENABLED => 'yes', - // excerpt should be disabled: - self::C_BOOL_FOOTNOTES_IN_EXCERPT => 'no', - self::C_BOOL_FOOTNOTES_EXPERT_MODE => 'yes', - self::C_STR_FOOTNOTES_LOVE => 'no', -), "footnotes_storage_custom" => array( - self::C_STR_HYPERLINK_ARROW => '&#8593;', - self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '', - self::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL => 'Continue reading', - self::C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS => 'yes', - self::C_STR_FOOTNOTES_STYLING_BEFORE => '[', - self::C_STR_FOOTNOTES_STYLING_AFTER => ']', - self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes', - self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE => 'no', - // The mouse over content truncation should be enabled by default - // to raise awareness of the functionality and to prevent the screen - // from being filled at mouse-over, and to allow the Continue reading: - self::C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes', - // The truncation length is raised from 150 to 200 chars: - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200, - // 2.5.4 fast-tracked: - self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER => '[[/tooltip]]', - self::C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE => 'no', - self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR => ' — ', - self::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT => 'no', - // The default position should not be lateral because of the risk - // the box gets squeezed between note anchor at line end and window edge, - // and top because reading at the bottom of the window is more likely: - self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center', - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0, - // The vertical offset must be negative for the box not to cover - // the current line of text (web coordinates origin is top left): - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7, - // The width should be limited to start with, for the box to have shape: - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450, - // fixed width is for alternative tooltips, cannot reuse max-width nor offsets: - self::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION => 'top right', - self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X => -50, - self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y => 24, - self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH => 400, - // tooltip display durations: - // called mouse over box not tooltip for consistency - self::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY => 0, - self::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION => 200, - self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY => 400, - self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION => 200, - // tooltip font size reset to legacy by default since 2.1.4; - // was set to inherit since 2.1.1 as it overrode custom CSS, - // is moved to settings since 2.1.4 2020-12-04T1023+0100 - self::C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED => 'yes', - self::C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR => 13, - self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT => 'px', - self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR => '', - // The mouse over box shouldn’t feature a colored background - // by default, due to diverging user preferences. White is neutral: - self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#ffffff', - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH => 1, - self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR => '#cccc99', - // The mouse over box corners mustn’t be rounded as that is outdated: - self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0, - self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666', - // Custom CSS migrates to a dedicated tab: - self::C_STR_CUSTOM_CSS => '', -), "footnotes_storage_expert" => array( - // These are checkboxes; keyword 'checked' is converted to Boolean true, - // empty string to false (default): - // Titles should all be enabled by default to prevent users from - // thinking at first that the feature is broken in post titles. - // See <https://wordpress.org/support/topic/more-feature-ideas/> - // Yet in titles, footnotes are still buggy, because WordPress - // uses the title string in menus and in the title element. - self::C_BOOL_EXPERT_LOOKUP_THE_TITLE => '', - self::C_BOOL_EXPERT_LOOKUP_THE_CONTENT => 'checked', - // And the_excerpt is disabled by default following @nikelaos in - // <https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879> - // <https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068> - self::C_BOOL_EXPERT_LOOKUP_THE_EXCERPT => '', - self::C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE => '', - // The widget_text hook must be disabled by default, because it causes - // multiple reference containers to appear in Elementor accordions, but - // it must be enabled if multiple reference containers are desired, as - // in Elementor toggles. - self::C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT => '', - // initially hard-coded default - // shows "9223372036854780000" instead of 9223372036854775807 in the numbox - // empty should be interpreted as PHP_INT_MAX, but a numbox cannot be set to empty: - // <https://github.com/Modernizr/Modernizr/issues/171> - // interpret -1 as PHP_INT_MAX instead - self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, - // Priority level of the_content and of widget_text as the only relevant - // hooks must be less than 99 because social buttons may yield scripts - // that contain the strings '((' and '))', i.e. the default footnote - // start and end short codes, causing issues with fake footnotes. - self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98, - self::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL => PHP_INT_MAX, - self::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, - self::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL => 98, -), "footnotes_storage_custom_css" => array(self::C_BOOL_CUSTOM_CSS_LEGACY_ENABLE => 'yes', self::C_STR_CUSTOM_CSS_NEW => '')) + $a_arr_default + = array( + // General settings. + 'footnotes_storage' => array( + // AMP compatibility. + self::C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE => '', + // Footnote start and end short codes. + self::C_STR_FOOTNOTES_SHORT_CODE_START => '((', + self::C_STR_FOOTNOTES_SHORT_CODE_END => '))', + self::C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED => '', + self::C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED => '', + self::C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE => 'yes', + // Footnotes numbering. + self::C_STR_FOOTNOTES_COUNTER_STYLE => 'arabic_plain', + self::C_STR_COMBINE_IDENTICAL_FOOTNOTES => 'yes', + // Scrolling behavior. + self::C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING => 'no', + self::C_INT_FOOTNOTES_SCROLL_OFFSET => 20, + self::C_INT_FOOTNOTES_SCROLL_DURATION => 380, + self::C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY => 'no', + self::C_INT_FOOTNOTES_SCROLL_DOWN_DURATION => 150, + self::C_INT_FOOTNOTES_SCROLL_DOWN_DELAY => 0, + self::C_INT_FOOTNOTES_SCROLL_UP_DELAY => 0, + self::C_STR_FOOTNOTES_HARD_LINKS_ENABLE => 'no', + self::C_STR_REFERRER_FRAGMENT_ID_SLUG => 'r', + self::C_STR_FOOTNOTE_FRAGMENT_ID_SLUG => 'f', + self::C_STR_HARD_LINK_IDS_SEPARATOR => '+', + self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE => 'yes', + self::C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT => 'Alt+ ←', + // Reference container. + self::C_STR_REFERENCE_CONTAINER_NAME => 'References', + self::C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT => 'p', + self::C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER => 'yes', + self::C_STR_REFERENCE_CONTAINER_COLLAPSE => 'no', + self::C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE => 'jquery', + self::C_STR_REFERENCE_CONTAINER_POSITION => 'post_end', + self::C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE => '[[references]]', + self::C_STR_FOOTNOTE_SECTION_SHORTCODE => '[[/footnotesection]]', + self::C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE => 'yes', + self::C_INT_REFERENCE_CONTAINER_TOP_MARGIN => 24, + self::C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN => 0, + self::C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT => 'none', + self::C_STR_FOOTNOTE_URL_WRAP_ENABLED => 'yes', + self::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE => 'yes', + self::C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH => 'no', + self::C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE => 'no', + self::C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE => 'no', + self::C_STR_BACKLINKS_SEPARATOR_ENABLED => 'yes', + self::C_STR_BACKLINKS_SEPARATOR_OPTION => 'comma', + self::C_STR_BACKLINKS_SEPARATOR_CUSTOM => '', + self::C_STR_BACKLINKS_TERMINATOR_ENABLED => 'no', + self::C_STR_BACKLINKS_TERMINATOR_OPTION => 'full_stop', + self::C_STR_BACKLINKS_TERMINATOR_CUSTOM => '', + self::C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED => 'no', + self::C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR => '50', + self::C_STR_BACKLINKS_COLUMN_WIDTH_UNIT => 'px', + self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED => 'no', + self::C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR => '140', + self::C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT => 'px', + self::C_STR_BACKLINKS_LINE_BREAKS_ENABLED => 'no', + self::C_STR_LINK_ELEMENT_ENABLED => 'yes', + // Footnotes in excerpts. + self::C_STR_FOOTNOTES_IN_EXCERPT => 'manual', + // Footnotes love. + self::C_STR_FOOTNOTES_LOVE => 'no', + // Deprecated. + self::C_STR_FOOTNOTES_EXPERT_MODE => 'yes', + ), + // Referrers and tooltips. + 'footnotes_storage_custom' => array( + // Backlink symbol. + self::C_STR_HYPERLINK_ARROW => '&#8593;', + self::C_STR_HYPERLINK_ARROW_USER_DEFINED => '', + // Referrers. + self::C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS => 'yes', + self::C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT => 'no', + self::C_STR_FOOTNOTES_STYLING_BEFORE => '[', + self::C_STR_FOOTNOTES_STYLING_AFTER => ']', + // Referrers in labels. + self::C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION => 'none', + // Tooltips. + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED => 'yes', + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE => 'no', + // Tooltip position. + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION => 'top center', + self::C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION => 'top right', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X => 0, + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X => -50, + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y => -7, + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y => 24, + // Tooltip dimensions. + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH => 450, + self::C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH => 400, + // Tooltip timing. + self::C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY => 0, + self::C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION => 200, + self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY => 400, + self::C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION => 200, + // Tooltip truncation. + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED => 'yes', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH => 200, + self::C_STR_FOOTNOTES_TOOLTIP_READON_LABEL => 'Continue reading', + // Tooltip text. + self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER => '[[/tooltip]]', + self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE => 'no', + self::C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR => ' — ', + // Tooltip appearance. + self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED => 'yes', + self::C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR => 13, + self::C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT => 'px', + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR => '#000000', + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND => '#ffffff', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH => 1, + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR => '#cccc99', + self::C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS => 0, + self::C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR => '#666666', + // Your existing Custom CSS code. + self::C_STR_CUSTOM_CSS => '', + ), + // Scope and priority. + 'footnotes_storage_expert' => array( + // WordPress hooks with priority level. + self::C_STR_EXPERT_LOOKUP_THE_TITLE => '', + self::C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, + self::C_STR_EXPERT_LOOKUP_THE_CONTENT => 'checked', + self::C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL => 98, + self::C_STR_EXPERT_LOOKUP_THE_EXCERPT => '', + self::C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL => PHP_INT_MAX, + self::C_STR_EXPERT_LOOKUP_WIDGET_TITLE => '', + self::C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL => PHP_INT_MAX, + self::C_STR_EXPERT_LOOKUP_WIDGET_TEXT => '', + self::C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL => 98, + ), + // Custom CSS. + 'footnotes_storage_custom_css' => array( + // Your existing Custom CSS code. + self::C_STR_CUSTOM_CSS_LEGACY_ENABLE => 'yes', + // Custom CSS. + self::C_STR_CUSTOM_CSS_NEW => '', + ), +)
    @@ -5354,15 +6649,6 @@ That is consistent with what WordPress does for excerpts.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5370,23 +6656,6 @@ That is consistent with what WordPress does for excerpts.

    -
    -
    - since -
    -
    - 2.1.3 - -

    excerpt hook: disable by default, thanks to @nikelaos

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 -
    @@ -5398,16 +6667,16 @@ That is consistent with what WordPress does for excerpts.

    -private " > -

    - $a_arr_Settings - +

    + $a_arr_settings +

    Contains all Settings from each Settings container as soon as this class is initialized.

    @@ -5415,7 +6684,7 @@ That is consistent with what WordPress does for excerpts.

    private array<string|int, mixed> - $a_arr_Settings + $a_arr_settings = array()
    @@ -5427,15 +6696,6 @@ That is consistent with what WordPress does for excerpts.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5454,16 +6714,16 @@ That is consistent with what WordPress does for excerpts.

    -private -static " > -

    - $a_obj_Instance - +

    + $a_obj_instance +

    Stores a singleton reference of this class.

    @@ -5471,7 +6731,7 @@ That is consistent with what WordPress does for excerpts.

    private static MCI_Footnotes_Settings - $a_obj_Instance + $a_obj_instance = ull @@ -5484,15 +6744,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5517,21 +6768,21 @@ ull -public " > -

    - ClearAll() - +

    + clear_all() +

    Deletes each Settings Container and loads the default values for each Settings Container.

    public - ClearAll() : mixed + clear_all() : mixed
    @@ -5543,15 +6794,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5569,8 +6811,7 @@ ull

    this function is not called any longer when deleting the plugin, to protect user data against loss, since manually updating a plugin is safer -done by deleting and reinstalling (see the warning about database backup). -2020-12-13T1353+0100

    +done by deleting and reinstalling (see the warning about database backup).

    @@ -5596,21 +6837,21 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns the value of specified Settings name.

    public - get(string $p_str_Key) : mixed + get(string $p_str_key) : mixed
    Parameters
    - $p_str_Key + $p_str_key : string
    @@ -5627,15 +6868,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5660,28 +6892,28 @@ done by deleting and reinstalling (see the warning about database backup). -public " > -

    - getContainer() - +

    + get_container() +

    Returns the name of a specified Settings Container.

    public - getContainer(int $p_int_Index) : str + get_container(int $p_int_index) : str
    Parameters
    - $p_int_Index + $p_int_index : int
    @@ -5698,15 +6930,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5731,28 +6954,28 @@ done by deleting and reinstalling (see the warning about database backup). -public " > -

    - getDefaults() - +

    + get_defaults() +

    Returns the default values of a specific Settings Container.

    public - getDefaults(int $p_int_Index) : array<string|int, mixed> + get_defaults(int $p_int_index) : array<string|int, mixed>
    Parameters
    - $p_int_Index + $p_int_index : int
    @@ -5769,15 +6992,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5808,7 +7022,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns a singleton of this class.

    @@ -5827,15 +7041,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5859,21 +7064,21 @@ done by deleting and reinstalling (see the warning about database backup). -public " > -

    - RegisterSettings() - +

    + register_settings() +

    Register all Settings Container for the Plugin Settings Page in the Dashboard.

    public - RegisterSettings() : mixed + register_settings() : mixed

    Settings Container Label will be the same as the Settings Container Name.

    @@ -5886,15 +7091,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -5918,28 +7114,28 @@ done by deleting and reinstalling (see the warning about database backup). -public " > -

    - saveOptions() - +

    + save_options() +

    Updates a whole Settings container.

    public - saveOptions(int $p_int_Index, array<string|int, mixed> $p_arr_newValues) : bool + save_options(int $p_int_index, array<string|int, mixed> $p_arr_new_values) : bool
    Parameters
    - $p_int_Index + $p_int_index : int
    @@ -5948,7 +7144,7 @@ done by deleting and reinstalling (see the warning about database backup).
    - $p_arr_newValues + $p_arr_new_values : array<string|int, mixed>
    @@ -5965,15 +7161,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -6004,7 +7191,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Class Constructor. Loads all Settings from each WordPress Settings container.

    @@ -6023,15 +7210,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -6055,32 +7233,32 @@ done by deleting and reinstalling (see the warning about database backup). -private " > -

    - Load() - +

    + load() +

    -

    Loads all Settings from specified Settings Container.

    +

    Loads all settings from specified settings container.

    private - Load(int $p_int_Index) : array<string|int, mixed> + load(int $p_int_index) : array<string|int, mixed>
    Parameters
    - $p_int_Index + $p_int_index : int
    -

    Settings Container Array Key Index.

    +

    Settings container array key index.

    @@ -6093,29 +7271,32 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 -
    +
      +
    • Bugfix: Removed the 'trim' function to allow leading and trailing whitespace in settings text boxes, thanks to @compasscare bug report.
      • +
    +
    since
    + 1.5.2 -

    ditched trimming whitespace from text box content in response to user request.

    +
    + +
    +
    + reporter +
    +
    + +

    @compasscare

    @@ -6123,7 +7304,7 @@ done by deleting and reinstalling (see the warning about database backup). link
    - https://wordpress.org/support/topic/leading-space-in-footnotes-tag/#post-5347966 + https://wordpress.org/support/topic/leading-space-in-footnotes-tag/
    @@ -6131,7 +7312,7 @@ done by deleting and reinstalling (see the warning about database backup).
    Return values
    array<string|int, mixed> — -

    Settings loaded from Container of Default Settings if Settings Container is empty (first usage).

    +

    Settings loaded from defaults if container is empty (first usage).

    @@ -6142,21 +7323,21 @@ done by deleting and reinstalling (see the warning about database backup). -private " > -

    - loadAll() - +

    + load_all() +

    Loads all Settings from each Settings container.

    private - loadAll() : mixed + load_all() : mixed
    @@ -6168,15 +7349,6 @@ done by deleting and reinstalling (see the warning about database backup).
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    diff --git a/docs/classes/MCI-Footnotes-Task.html b/docs/classes/MCI-Footnotes-Task.html index b8cddb3..60c8960 100644 --- a/docs/classes/MCI-Footnotes-Task.html +++ b/docs/classes/MCI-Footnotes-Task.html @@ -70,7 +70,7 @@
    @@ -88,10 +88,9 @@ 95 -

    Searches and replaces the footnotes.

    +

    Searches and replaces the footnotes and generates the reference container.

    -

    Generates the reference container.

    -
    +
    @@ -100,15 +99,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -131,144 +121,158 @@
    - $a_arr_Footnotes + $a_arr_footnotes  : array<string|int, mixed>
    -
    Contains all footnotes found on current public page.
    +
    Contains all footnotes found in the searched content.
    - $a_bool_AllowLoveMe + $a_bool_allow_love_me  : bool
    Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.
    - $a_bool_AlternativeTooltipsEnabled - -  : mixed -
    -
    - -
    - $a_bool_HardLinksEnable - -  : bool|str|int -
    -
    Hard links for AMP compatibility
    - -
    - $a_bool_MirrorTooltipText - -  : mixed -
    -
    Dedicated tooltip text
    - -
    - $a_bool_SyntaxErrorFlag + $a_bool_hard_links_enabled  : bool
    -
    Footnote delimiter syntax validation
    +
    Hard links for AMP compatibility.
    - $a_bool_TooltipsEnabled + $a_bool_mirror_tooltip_text  : bool
    -
    Template process optimization
    +
    Whether to mirror the tooltip text in the reference container.
    - $a_int_PostId + $a_bool_syntax_error_flag + +  : bool +
    +
    Footnote delimiter syntax validation enabled.
    + +
    + $a_int_post_id  : int
    -
    Infinite scroll / autoload or archive view
    +
    Autoload a.k.a. infinite scroll, or archive view.
    - $a_int_ReferenceContainerId + $a_int_reference_container_id  : int
    -
    Multiple reference containers in content and widgets
    +
    Multiple reference containers in content and widgets.
    - $a_int_ScrollOffset + $a_int_scroll_offset  : int
    -
    Scroll offset
    +
    Scroll offset.
    - $a_int_TooltipShortcodeLength + $a_int_tooltip_shortcode_length -  : mixed +  : int
    -
    +
    The tooltip delimiter shortcode length.
    - $a_str_FootnoteLinkSlug + $a_str_end_tag -  : mixed +  : str
    -
    +
    Footnote delimiter end short code.
    - $a_str_LinkCloseTag + $a_str_end_tag_regex -  : mixed +  : str
    -
    +
    Footnote delimiter end short code in regex format.
    - $a_str_LinkIdsSeparator + $a_str_footnote_link_slug -  : mixed +  : str
    -
    +
    The footnote slug.
    - $a_str_LinkOpenTag + $a_str_link_close_tag -  : mixed +  : str
    -
    +
    The closing tag.
    - $a_str_LinkSpan + $a_str_link_open_tag -  : mixed +  : str
    -
    Optional link element for footnote referrers and backlinks
    +
    The opening tag.
    - $a_str_PostContainerIdCompound + $a_str_link_span -  : mixed +  : str
    -
    +
    The span element name.
    - $a_str_Prefix + $a_str_post_container_id_compound + +  : str +
    +
    Contains the concatenated fragment ID base.
    + +
    + $a_str_prefix  : string
    Prefix for the Footnote html element ID.
    - $a_str_ReferrerLinkSlug + $a_str_referrer_link_slug -  : mixed +  : str
    -
    +
    The referrer slug.
    - $a_str_TooltipShortcode + $a_str_start_tag -  : mixed +  : str
    -
    +
    Footnote delimiter start short code.
    + +
    + $a_str_start_tag_regex + +  : str +
    +
    Footnote delimiter start short code in regex format.
    + +
    + $a_str_tooltip_shortcode + +  : str +
    +
    The tooltip delimiter shortcode.
    + +
    + $a_str_link_ids_separator + +  : str +
    +
    The slug and identifier separator.
    exec() @@ -278,14 +282,77 @@
    Replaces all footnotes that occur in the given content.
    - ReferenceContainer() + footnotes_in_content() + +  : string +
    +
    Replaces footnotes in the content of the current page/post.
    + +
    + footnotes_in_excerpt() + +  : string +
    +
    Processes existing excerpt or replaces it with a new one generated on the basis of the post.
    + +
    + footnotes_in_title() + +  : string +
    +
    Replaces footnotes in the post/page title.
    + +
    + footnotes_in_widget_text() + +  : string +
    +
    Replaces footnotes in the content of the current widget.
    + +
    + footnotes_in_widget_title() + +  : string +
    +
    Replaces footnotes in the widget title.
    + +
    + footnotes_output_footer() + +  : mixed +
    +
    Displays the 'LOVE FOOTNOTES' slug if enabled.
    + +
    + footnotes_output_head() + +  : mixed +
    +
    Outputs the custom css to the header of the public page.
    + +
    + generate_excerpt() + +  : string +
    +
    Generates excerpt on the basis of the post.
    + +
    + generate_excerpt_with_footnotes() + +  : string +
    +
    Generates excerpt with footnotes on the basis of the post.
    + +
    + reference_container()  : string
    Generates the reference container.
    - registerHooks() + register_hooks()  : mixed
    @@ -299,67 +366,11 @@
    Replaces all footnotes in the given content and appends them to the static property.
    - the_content() - -  : string -
    -
    Replaces footnotes in the content of the current page/post.
    - -
    - the_excerpt() - -  : string -
    -
    Replaces footnotes in the excerpt of the current page/post.
    - -
    - the_post() + unify_delimiters()  : mixed
    -
    Replaces footnotes in each Content var of the current Post object.
    - -
    - the_title() - -  : string -
    -
    Replaces footnotes in the post/page title.
    - -
    - widget_text() - -  : string -
    -
    Replaces footnotes in the content of the current widget.
    - -
    - widget_title() - -  : string -
    -
    Replaces footnotes in the widget title.
    - -
    - wp_footer() - -  : mixed -
    -
    Displays the 'LOVE FOOTNOTES' slug if enabled.
    - -
    - wp_head() - -  : mixed -
    -
    Outputs the custom css to the header of the public page.
    - -
    - replacePostObject() - -  : WP_Post -
    -
    Replace all Footnotes in a WP_Post object.
    +
    Brings the delimiters and unifies their various HTML escapement schemas.
    @@ -380,24 +391,24 @@ -public -static " > -

    - $a_arr_Footnotes - +

    + $a_arr_footnotes +

    -

    Contains all footnotes found on current public page.

    +

    Contains all footnotes found in the searched content.

    public static array<string|int, mixed> - $a_arr_Footnotes + $a_arr_footnotes = array()
    @@ -409,15 +420,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -436,16 +438,16 @@ -public -static " > -

    - $a_bool_AllowLoveMe - +

    + $a_bool_allow_love_me +

    Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.

    @@ -453,7 +455,7 @@ public static bool - $a_bool_AllowLoveMe + $a_bool_allow_love_me = rue
    @@ -465,15 +467,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -492,54 +485,24 @@ -public -static " > -

    - $a_bool_AlternativeTooltipsEnabled - +

    + $a_bool_hard_links_enabled +

    - - - public - static mixed - $a_bool_AlternativeTooltipsEnabled - = alse - - - - -
    -
    -

    - $a_bool_HardLinksEnable - - - -

    - - -

    Hard links for AMP compatibility

    +

    Hard links for AMP compatibility.

    public - static bool|str|int - $a_bool_HardLinksEnable + static bool + $a_bool_hard_links_enabled = alse
    @@ -569,7 +532,10 @@
    2.0.4 -
    +
      +
    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro issue report, thanks to @martinneumannat issue report and code contribution.
      • +
    +
    @@ -603,10 +569,7 @@ link
    -
      -
    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
      • -
    -     + https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/
    @@ -620,10 +583,7 @@ link
    -

    The official AMP plugin strips off JavaScript, breaking Footnotes’ -animated scrolling. -When the alternative reference container is enabled, hard links are too.

    -     + https://wordpress.org/support/topic/footnotes-is-not-amp-compatible/
    @@ -645,30 +605,27 @@ When the alternative reference container is enabled, hard links are too.

    -public -static " > -

    - $a_bool_MirrorTooltipText - +

    + $a_bool_mirror_tooltip_text +

    -

    Dedicated tooltip text

    +

    Whether to mirror the tooltip text in the reference container.

    public - static mixed - $a_bool_MirrorTooltipText + static bool + $a_bool_mirror_tooltip_text = alse -
      -
    • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
      • -
    -
    +
    @@ -684,35 +641,6 @@ When the alternative reference container is enabled, hard links are too.

    -
    -
    - date -
    -
    - -

    2021-01-19T2223+0100

    -
    - -
    -
    - reporter -
    -
    - -

    @jbj2199

    -
    - -
    -
    - link -
    -
    -

    Tooltips can display another content than the footnote entry -in the reference container. The trigger is a shortcode in -the footnote text separating the tooltip text from the note. -That is consistent with what WordPress does for excerpts.

    -     -
    @@ -724,24 +652,24 @@ That is consistent with what WordPress does for excerpts.

    -public -static " > -

    - $a_bool_SyntaxErrorFlag - +

    + $a_bool_syntax_error_flag +

    -

    Footnote delimiter syntax validation

    +

    Footnote delimiter syntax validation enabled.

    public static bool - $a_bool_SyntaxErrorFlag + $a_bool_syntax_error_flag = rue
      @@ -763,15 +691,6 @@ That is consistent with what WordPress does for excerpts.

      -
    -
    - date -
    -
    - -

    2021-01-01T0227+0100

    -
    -
    @@ -783,119 +702,28 @@ That is consistent with what WordPress does for excerpts.

    -public -static " > -

    - $a_bool_TooltipsEnabled - +

    + $a_int_post_id +

    -

    Template process optimization

    - - - public - static bool - $a_bool_TooltipsEnabled - = alse - -
      -
    • Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.
      • -
    -
    - - -
    - Tags - -
    -
    -
    - since -
    -
    - 2.4.0 - -
    - -
    -
    - date -
    -
    - -

    2021-01-04T1355+0100

    -
    - -
    -
    - author -
    -
    - -

    Patrizia Lutz @misfist

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/template-override-filter/#post-13864301 - -
    -
    - link -
    -
    -

    repository

    -     - -
    -
    - link -
    -
    -

    diff

    -     - -
    -
    - -
    -
    -

    - $a_int_PostId - - - -

    - - -

    Infinite scroll / autoload or archive view

    +

    Autoload a.k.a. infinite scroll, or archive view.

    public static int - $a_int_PostId + $a_int_post_id = 0
      -
    • Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness code contribution
      • +
    • Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness issue report and code contribution
    @@ -906,13 +734,27 @@ That is consistent with what WordPress does for excerpts.

    - since + reporter
    - 2.0.6 -
    +

    @docteurfitness

    +
    +
    +
    + link +
    +
    + https://wordpress.org/support/topic/auto-load-post-compatibility-update/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/auto-load-post-compatibility-update/#post-13618833 +
    contributor @@ -924,28 +766,12 @@ That is consistent with what WordPress does for excerpts.

    - link -
    -
    - https://wordpress.org/support/topic/auto-load-post-compatibility-update/#post-13618833 - -
    -
    - link -
    -
    -

    As multiple posts are appended to each other, functions and fragment IDs must be disambiguated. -post ID to make everything unique wrt infinite scroll and archive view:

    -     - -
    -
    - reporter + since
    + 2.0.6 -

    @docteurfitness

    -
    +
    @@ -958,24 +784,24 @@ post ID to make everything unique wrt infinite scroll and archive view:

    -public -static " > -

    - $a_int_ReferenceContainerId - +

    + $a_int_reference_container_id +

    -

    Multiple reference containers in content and widgets

    +

    Multiple reference containers in content and widgets.

    public static int - $a_int_ReferenceContainerId + $a_int_reference_container_id = 1
      @@ -990,24 +816,6 @@ post ID to make everything unique wrt infinite scroll and archive view:

      - since -
      -
      - 2.2.9 - -
      - -
      -
      - date -
      -
      - -

      2020-12-25T0338+0100

      -
      - -
      -
      reporter
      @@ -1029,6 +837,15 @@ post ID to make everything unique wrt infinite scroll and archive view:

      https://wordpress.org/support/topic/reset-footnotes-to-1/#post-13662830 +
      +
      + since +
      +
      + 2.2.9 + +
      +
      @@ -1040,24 +857,24 @@ post ID to make everything unique wrt infinite scroll and archive view:

      -public -static " > -

      - $a_int_ScrollOffset - +

      + $a_int_scroll_offset +

      -

      Scroll offset

      +

      Scroll offset.

      public static int - $a_int_ScrollOffset + $a_int_scroll_offset = 34
        @@ -1077,7 +894,10 @@ post ID to make everything unique wrt infinite scroll and archive view:

        2.1.4 -
        +
          +
        • Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report.
          • +
        +
        @@ -1088,36 +908,6 @@ post ID to make everything unique wrt infinite scroll and archive view:

        -
    -
    - date -
    -
    - -

    2020-12-05T0538+0100

    -
      -
    • Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report.
      • -
    -
    - -
    -
    - date -
    -
    - -

    2021-01-03T2055+0100

    -
    - -
    -
    - date -
    -
    - -

    2021-01-04T0504+0100

    -
    -
    reporter @@ -1145,27 +935,44 @@ post ID to make everything unique wrt infinite scroll and archive view:

    -public -static " > -

    - $a_int_TooltipShortcodeLength - +

    + $a_int_tooltip_shortcode_length +

    - +

    The tooltip delimiter shortcode length.

    + public - static mixed - $a_int_TooltipShortcodeLength + static int + $a_int_tooltip_shortcode_length = 12 +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.5.2 + +
    + +
    +
    -public -static " > -

    - $a_str_FootnoteLinkSlug - +

    + $a_str_end_tag +

    - +

    Footnote delimiter end short code.

    + public - static mixed - $a_str_FootnoteLinkSlug + static str + $a_str_end_tag + = '' + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +

    (constant, variable)

    +
    + +
    +
    + since +
    +
    + 2.6.2 + +

    (property)

    +
    + +
    +
    + +
    +
    +

    + $a_str_end_tag_regex + + + +

    + + +

    Footnote delimiter end short code in regex format.

    + + + public + static str + $a_str_end_tag_regex + = '' + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.4.0 + +

    (variable)

    +
    + +
    +
    + since +
    +
    + 2.6.2 + +

    (property)

    +
    + +
    +
    + +
    +
    +

    + $a_str_footnote_link_slug + + + +

    + + +

    The footnote slug.

    + + + public + static str + $a_str_footnote_link_slug = 'f' +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    -public -static " > -

    - $a_str_LinkCloseTag - +

    + $a_str_link_close_tag +

    - +

    The closing tag.

    + public - static mixed - $a_str_LinkCloseTag + static str + $a_str_link_close_tag = '' +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    -public -static " > -

    - $a_str_LinkIdsSeparator - +

    + $a_str_link_open_tag +

    - +

    The opening tag.

    + public - static mixed - $a_str_LinkIdsSeparator - = '+' - - - - -
    -
    -

    - $a_str_LinkOpenTag - - - -

    - - - - - public - static mixed - $a_str_LinkOpenTag + static str + $a_str_link_open_tag = '' +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    -public -static " > -

    - $a_str_LinkSpan - +

    + $a_str_link_span +

    -

    Optional link element for footnote referrers and backlinks

    +

    The span element name.

    public - static mixed - $a_str_LinkSpan + static str + $a_str_link_span = 'span'
    @@ -1326,147 +1270,11 @@ post ID to make everything unique wrt infinite scroll and archive view:

    since
    -
    - 2.0.0 - -

    add link elements along with hard links.

    -
      -
    • Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution.
      • -
    -
    - -
    -
    - since -
    -
    - 2.1.4 - -
    - -
    -
    - since -
    2.3.0
    -
    -
    - date -
    -
    - -

    2020-11-25T1306+0100

    -
    - -
    -
    - date -
    -
    - -

    2020-11-26T1051+0100

    -
    - -
    -
    - date -
    -
    - -

    2020-12-30T2313+0100

    -
    - -
    -
    - contributor -
    -
    - -

    @docteurfitness

    -
    - -
    -
    - contributor -
    -
    - -

    @martinneumannat

    -
    - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/update-2-1-3/#post-13704194 - -
    -
    - link -
    -
    -
      -
    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
      • -
    -     - -
    -
    - link -
    -
    - https://wordpress.org/support/topic/making-it-amp-compatible/ - -
    -
    - link -
    -
    -

    Although widely used for that purpose, hyperlinks are disliked for footnote linking. -Browsers may need to be prevented from logging these clicks in the browsing history, -as logging compromises the usability of the 'return to previous' button in browsers. -For that purpose, and for scroll animation, this linking is performed by JavaScript.

    -

    Link elements raise concerns, so that mitigating their proliferation may be desired.

    -

    By contrast, due to an insufficiency in the CSS standard, coloring elements with the -theme’s link color requires real link elements and cannot be done with named colors, -as CSS does not support 'color: link|hover|active|visited', after the pseudo-classes -of the link element.

    -

    Yet styling these elements with the link color is not universally preferred, so that -the very presence of these link elements may need to be avoided.

    -     - -
    -
    - reporter -
    -
    - -

    @docteurfitness

    -
    - -
    -
    - reporter -
    -
    - -

    @psykonevro

    -
    - -
    -
    - see -
    -
    - self::$a_bool_HardLinksEnable - -
    -
    @@ -1478,56 +1286,26 @@ the very presence of these link elements may need to be avoided.

    -public -static " > -

    - $a_str_PostContainerIdCompound - +

    + $a_str_post_container_id_compound +

    - +

    Contains the concatenated fragment ID base.

    + public - static mixed - $a_str_PostContainerIdCompound + static str + $a_str_post_container_id_compound = '' - - - -
    -
    -

    - $a_str_Prefix - - - -

    - - -

    Prefix for the Footnote html element ID.

    - - - public - static string - $a_str_Prefix - = "" -
    @@ -1537,15 +1315,53 @@ the very presence of these link elements may need to be avoided.

    - author + since
    + 2.3.0 -

    Stefan Herndler

    -
    +
    -
    +
    + +
    +
    +

    + $a_str_prefix + + + +

    + + +

    Prefix for the Footnote html element ID.

    + + + public + static string + $a_str_prefix + = '' + +
    + + +
    + Tags + +
    +
    +
    since
    @@ -1564,27 +1380,44 @@ the very presence of these link elements may need to be avoided.

    -public -static " > -

    - $a_str_ReferrerLinkSlug - +

    + $a_str_referrer_link_slug +

    - +

    The referrer slug.

    + public - static mixed - $a_str_ReferrerLinkSlug + static str + $a_str_referrer_link_slug = 'r' +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    -public -static " > -

    - $a_str_TooltipShortcode - +

    + $a_str_start_tag +

    - +

    Footnote delimiter start short code.

    + public - static mixed - $a_str_TooltipShortcode - = '[[/tooltip]]' + static str + $a_str_start_tag + = '' + +
    +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +

    (constant, variable)

    +
    + +
    +
    + since +
    +
    + 2.6.2 + +

    (property)

    +
    + +
    +
    + +
    +
    +

    + $a_str_start_tag_regex + + + +

    + + +

    Footnote delimiter start short code in regex format.

    + + + public + static str + $a_str_start_tag_regex + = '' + +
    + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.4.0 + +

    (variable)

    +
    + +
    +
    + since +
    +
    + 2.6.2 + +

    (property)

    +
    + +
    +
    + +
    +
    +

    + $a_str_tooltip_shortcode + + + +

    + + +

    The tooltip delimiter shortcode.

    + + + public + static str + $a_str_tooltip_shortcode + = '[[/tooltip]]' + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.5.2 + +
    + +
    +
    + +
    +
    +

    + $a_str_link_ids_separator + + + +

    + + +

    The slug and identifier separator.

    + + + private + static str + $a_str_link_ids_separator + = '+' + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.3.0 + +
    + +
    +
    @@ -1637,21 +1650,21 @@ the very presence of these link elements may need to be avoided.

    Replaces all footnotes that occur in the given content.

    public - exec(string $p_str_Content[, bool $p_bool_OutputReferences = false ][, bool $p_bool_HideFootnotesText = false ]) : string + exec(string $p_str_content[, bool $p_bool_output_references = false ][, bool $p_bool_hide_footnotes_text = false ]) : string
    Parameters
    - $p_str_Content + $p_str_content : string
    @@ -1660,7 +1673,7 @@ the very presence of these link elements may need to be avoided.

    - $p_bool_OutputReferences + $p_bool_output_references : bool = false
    @@ -1669,7 +1682,7 @@ the very presence of these link elements may need to be avoided.

    - $p_bool_HideFootnotesText + $p_bool_hide_footnotes_text : bool = false
    @@ -1686,15 +1699,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -1702,26 +1706,6 @@ the very presence of these link elements may need to be avoided.

    -
    -
    - since -
    -
    - 2.2.0 - -

    Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report.

    -
    - -
    -
    - since -
    -
    - 2.2.5 - -

    Bugfix: Reference container: delete position shortcode if unused because position may be widget or footer, thanks to @hamshe bug report.

    -
    -
    @@ -1738,462 +1722,28 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - ReferenceContainer() - +

    + footnotes_in_content() +

    - -

    Generates the reference container.

    - - - public - ReferenceContainer() : string - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 2.0.0 - -

    Update: remove backlink symbol along with column 2 of the reference container

    -
    - -
    -
    - since -
    -
    - 2.0.3 - -

    Bugfix: prepend an arrow on user request

    -
    - -
    -
    - since -
    -
    - 2.0.6 - -

    Bugfix: Reference container: fix line breaking behavior in footnote number clusters.

    -
    - -
    -
    - since -
    -
    - 2.0.4 - -

    Bugfix: restore the arrow select and backlink symbol input settings

    -
    - -
    -
    - since -
    -
    - 2.1.1 - -

    Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report.

    -
    - -
    -
    - since -
    -
    - 2.1.1 - -

    Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.

    -
    - -
    -
    - -
    Return values
    - string - — -
    - - - -
    -

    - registerHooks() - -

    - - -

    Register WordPress Hooks to replace Footnotes in the content of a public page.

    - - - public - registerHooks() : mixed - -
    - - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 1.5.4 - -

    Adding: Hooks: support 'the_post' in response to user request for custom post types.

    -
    - -
    -
    - since -
    -
    - 2.0.5 - -

    Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution.

    -
    - -
    -
    - since -
    -
    - 2.0.5 - -

    Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts.

    -
    - -
    -
    - since -
    -
    - 2.0.6 - -

    Bugfix: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility).

    -
    - -
    -
    - since -
    -
    - 2.0.7 - -

    BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports.

    -
    - -
    -
    - since -
    -
    - 2.0.7 - -

    Bugfix: Set priority level back to 10 assuming it is unproblematic 2020-11-06T1344+0100.

    -
    - -
    -
    - since -
    -
    - 2.0.8 - -

    Bugfix: Priority level back to PHP_INT_MAX (need to get in touch with other plugins).

    -
    - -
    -
    - since -
    -
    - 2.1.0 - -

    UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook.

    -
    - -
    -
    - since -
    -
    - 2.1.1 - -

    Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report.

    -
    - -
    -
    - since -
    -
    - 2.1.2 - -

    Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report.

    -
    - -
    -
    - since -
    -
    - 2.5.0 - -

    Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution.

    -
    - -
    -
    - since -
    -
    - 2.5.1 - -

    Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report.

    -
    - -
    -
    - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - search() - -

    - - -

    Replaces all footnotes in the given content and appends them to the static property.

    - - - public - search(string $p_str_Content, bool $p_bool_ConvertHtmlChars, bool $p_bool_HideFootnotesText) : string - -
    - -
    Parameters
    -
    -
    - $p_str_Content - : string -
    -
    -

    Content to be searched for footnotes.

    -
    - -
    -
    - $p_bool_ConvertHtmlChars - : bool -
    -
    -

    html encode settings, default true.

    -
    - -
    -
    - $p_bool_HideFootnotesText - : bool -
    -
    -

    Hide footnotes found in the string.

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.0 - -
    - -
    -
    - since -
    -
    - 2.0.0 - -

    various.

    -
    - -
    -
    - since -
    -
    - 2.4.0 - -

    Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.

    -
    - -
    -
    - since -
    -
    - 2.5.0 - -

    Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report.

    -
    - -
    -
    - since -
    -
    - 2.5.0 - -

    Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report.

    -
    - -
    -
    - since -
    -
    - 2.5.0 - -

    Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report.

    -
    - -
    -
    - -
    Return values
    - string - — -
    - - -
    -
    -

    - the_content() - -

    -

    Replaces footnotes in the content of the current page/post.

    public - the_content(string $p_str_Content) : string + footnotes_in_content(string $p_str_content) : string
    Parameters
    - $p_str_Content + $p_str_content : string
    @@ -2210,29 +1760,48 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    1.5.0 +
      +
    • Adding: Reference container: optionally per section by shortcode, thanks to @grflukas issue report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.7.0 +
    +
    +
    + reporter +
    +
    + +

    @grflukas

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/multiple-reference-containers-in-single-post/ +
    Return values
    string — -

    Content with replaced footnotes.

    +

    $p_str_content Content with replaced footnotes.

    @@ -2243,32 +1812,32 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - the_excerpt() - +

    + footnotes_in_excerpt() +

    -

    Replaces footnotes in the excerpt of the current page/post.

    +

    Processes existing excerpt or replaces it with a new one generated on the basis of the post.

    public - the_excerpt(string $p_str_Content) : string + footnotes_in_excerpt(string $p_str_excerpt) : string
    Parameters
    - $p_str_Content + $p_str_excerpt : string
    -

    Page/Post content.

    +

    Excerpt content.

    @@ -2281,15 +1850,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2297,13 +1857,64 @@ the very presence of these link elements may need to be avoided.

    +
    +
    + since +
    +
    + 2.6.2 + +

    Debug No option.

    +
    + +
    +
    + since +
    +
    + 2.6.3 + +

    Debug Yes option, the setting becomes fully effective.

    +
      +
    • Bugfix: Excerpts: make excerpt handling backward compatible, thanks to @mfessler bug report.
      • +
    +
    + +
    +
    + since +
    +
    + 2.7.0 + +

    The input was already the processed excerpt, no more footnotes to search. +But issue #65 brought up that manual excerpts can include processable footnotes. +Default 'manual' is fallback and is backward compatible with the initial setup.

    +
    + +
    +
    + reporter +
    +
    + +

    @mfessler

    +
    + +
    +
    + link +
    +
    + https://github.com/markcheret/footnotes/issues/65 +
    Return values
    string — -

    Content with replaced footnotes.

    +

    $p_str_excerpt Processed or new excerpt.

    @@ -2314,101 +1925,32 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - the_post() - +

    + footnotes_in_title() +

    - -

    Replaces footnotes in each Content var of the current Post object.

    - - - public - the_post(array<string|int, mixed>|WP_Post &$p_mixed_Posts) : mixed - -
    - -
    Parameters
    -
    -
    - $p_mixed_Posts - : array<string|int, mixed>|WP_Post -
    -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    - since -
    -
    - 1.5.4 - -
    - -
    -
    - -
    Return values
    - mixed - — -
    - - -
    -
    -

    - the_title() - -

    -

    Replaces footnotes in the post/page title.

    public - the_title(string $p_str_Content) : string + footnotes_in_title(string $p_str_content) : string
    Parameters
    - $p_str_Content + $p_str_content : string
    -

    Widget content.

    +

    Title.

    @@ -2421,15 +1963,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2443,7 +1976,7 @@ the very presence of these link elements may need to be avoided.

    Return values
    string — -

    Content with replaced footnotes.

    +

    $p_str_content Title with replaced footnotes.

    @@ -2454,28 +1987,28 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - widget_text() - +

    + footnotes_in_widget_text() +

    Replaces footnotes in the content of the current widget.

    public - widget_text(string $p_str_Content) : string + footnotes_in_widget_text(string $p_str_content) : string
    Parameters
    - $p_str_Content + $p_str_content : string
    @@ -2492,15 +2025,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2514,7 +2038,7 @@ the very presence of these link elements may need to be avoided.

    Return values
    string — -

    Content with replaced footnotes.

    +

    $p_str_content Content with replaced footnotes.

    @@ -2525,28 +2049,28 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - widget_title() - +

    + footnotes_in_widget_title() +

    Replaces footnotes in the widget title.

    public - widget_title(string $p_str_Content) : string + footnotes_in_widget_title(string $p_str_content) : string
    Parameters
    - $p_str_Content + $p_str_content : string
    @@ -2563,15 +2087,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2585,7 +2100,7 @@ the very presence of these link elements may need to be avoided.

    Return values
    string — -

    Content with replaced footnotes.

    +

    $p_str_content Content with replaced footnotes.

    @@ -2596,21 +2111,21 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - wp_footer() - +

    + footnotes_output_footer() +

    Displays the 'LOVE FOOTNOTES' slug if enabled.

    public - wp_footer() : mixed + footnotes_output_footer() : mixed
    @@ -2622,15 +2137,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2645,7 +2151,7 @@ the very presence of these link elements may need to be avoided.

    2.2.0 -

    more options 2020-12-11T0506+0100

    +

    More options.

    @@ -2664,21 +2170,21 @@ the very presence of these link elements may need to be avoided.

    -public " > -

    - wp_head() - +

    + footnotes_output_head() +

    Outputs the custom css to the header of the public page.

    public - wp_head() : mixed + footnotes_output_head() : mixed
    @@ -2690,15 +2196,6 @@ the very presence of these link elements may need to be avoided.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -2809,35 +2306,39 @@ the very presence of these link elements may need to be avoided.

    -

    - replacePostObject() - +

    + generate_excerpt() +

    -

    Replace all Footnotes in a WP_Post object.

    +

    Generates excerpt on the basis of the post.

    - private - replacePostObject(WP_Post $p_obj_Post) : WP_Post + public + generate_excerpt(string $p_str_content) : string -
    +
      +
    • Bugfix: Excerpts: debug the 'No' option by generating excerpts on the basis of the post without footnotes, thanks to @nikelaos @markcheret @martinneumannat bug reports.
      • +
    +
    Parameters
    - $p_obj_Post - : WP_Post + $p_str_content + : string
    -
    +

    The post.

    +
    @@ -2849,19 +2350,79 @@ the very presence of these link elements may need to be avoided.

    - author + reporter
    -

    Stefan Herndler

    +

    @nikelaos

    +
    +
    + reporter +
    +
    + +

    @markcheret

    +
    + +
    +
    + reporter +
    +
    + +

    @martinneumannat

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-now-appear-in-summaries-even-though-this-is-marked-no/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/ + +
    +
    + link +
    +
    + https://developer.wordpress.org/reference/functions/wp_trim_excerpt/ + +
    +
    + link +
    +
    + https://developer.wordpress.org/reference/functions/wp_trim_words/ +
    since
    - 1.5.6 + 2.6.2
    @@ -2869,7 +2430,749 @@ the very presence of these link elements may need to be avoided.

    Return values
    - WP_Post + string + — +

    $p_str_content An excerpt of the post. +Applies full WordPress excerpt processing.

    +
    + + +
    +
    +

    + generate_excerpt_with_footnotes() + +

    + + +

    Generates excerpt with footnotes on the basis of the post.

    + + + public + generate_excerpt_with_footnotes(string $p_str_content) : string + +
      +
    • Bugfix: Excerpts: debug the 'Yes' option by generating excerpts with footnotes on the basis of the posts, thanks to @nikelaos @martinneumannat bug reports.
      • +
    +
    + +
    Parameters
    +
    +
    + $p_str_content + : string +
    +
    +

    The post.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @nikelaos

    +
    + +
    +
    + reporter +
    +
    + +

    @martinneumannat

    +
    + +
    +
    + reporter +
    +
    + +

    @scroom

    +
    + +
    +
    + reporter +
    +
    + +

    @copylefter

    +
    + +
    +
    + reporter +
    +
    + +

    @lagoon24

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/problem-with-footnotes-in-excerpts-of-the-blog-page/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/update-crashed-my-website-3/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14259151 + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/update-crashed-my-website-3/#post-14259396 + +
    +
    + link +
    +
    + https://wordpress.org/plugins/advanced-excerpt/ + +
    +
    + since +
    +
    + 2.6.3 + +
      +
    • Bugfix: Process: remove trailing comma after last argument in multiline function calls for PHP < 7.3, thanks to @scroom @copylefter @lagoon24 bug reports.
      • +
    +
    + +
    +
    + since +
    +
    + 2.6.4 + +
    + +
    +
    + see +
    +
    + self::generate_excerpt() + +

    Uses information and some code from Advanced Excerpt.

    +
    + +
    +
    + +
    Return values
    + string + — +

    $p_str_content An excerpt of the post. +Does not apply full WordPress excerpt processing.

    +
    + + +
    +
    +

    + reference_container() + +

    + + +

    Generates the reference container.

    + + + public + reference_container() : string + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.0.0 + +

    Update: remove backlink symbol along with column 2 of the reference container

    +
    + +
    +
    + since +
    +
    + 2.0.3 + +

    Bugfix: prepend an arrow on user request

    +
    + +
    +
    + since +
    +
    + 2.0.6 + +

    Bugfix: Reference container: fix line breaking behavior in footnote number clusters.

    +
    + +
    +
    + since +
    +
    + 2.0.4 + +

    Bugfix: restore the arrow select and backlink symbol input settings

    +
    + +
    +
    + since +
    +
    + 2.1.1 + +

    Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report.

    +
    + +
    +
    + since +
    +
    + 2.1.1 + +

    Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.

    +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + register_hooks() + +

    + + +

    Register WordPress Hooks to replace Footnotes in the content of a public page.

    + + + public + register_hooks() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 1.5.4 + +

    Adding: Hooks: support 'the_post' in response to user request for custom post types.

    +
    + +
    +
    + since +
    +
    + 2.0.5 + +

    Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution.

    +
    + +
    +
    + since +
    +
    + 2.0.5 + +

    Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts.

    +
    + +
    +
    + since +
    +
    + 2.0.6 + +

    Bugfix: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility).

    +
    + +
    +
    + since +
    +
    + 2.0.7 + +

    BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports.

    +
    + +
    +
    + since +
    +
    + 2.0.7 + +

    Bugfix: Set priority level back to 10 assuming it is unproblematic.

    +
    + +
    +
    + since +
    +
    + 2.0.8 + +

    Bugfix: Priority level back to PHP_INT_MAX (need to get in touch with other plugins).

    +
    + +
    +
    + since +
    +
    + 2.1.0 + +

    UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook.

    +
    + +
    +
    + since +
    +
    + 2.1.1 + +

    Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report.

    +
    + +
    +
    + since +
    +
    + 2.1.2 + +

    Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report.

    +
    + +
    +
    + since +
    +
    + 2.5.0 + +

    Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution.

    +
    + +
    +
    + since +
    +
    + 2.5.1 + +

    Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report.

    +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + search() + +

    + + +

    Replaces all footnotes in the given content and appends them to the static property.

    + + + public + search(string $p_str_content, bool $p_bool_hide_footnotes_text) : string + +
    + +
    Parameters
    +
    +
    + $p_str_content + : string +
    +
    +

    Any content to be searched for footnotes.

    +
    + +
    +
    + $p_bool_hide_footnotes_text + : bool +
    +
    +

    Hide footnotes found in the string.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.0.0 + +

    various.

    +
    + +
    +
    + since +
    +
    + 2.4.0 + +

    Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.

    +
    + +
    +
    + since +
    +
    + 2.5.0 + +

    Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report.

    +
    + +
    +
    + since +
    +
    + 2.5.0 + +

    Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report.

    +
    + +
    +
    + since +
    +
    + 2.5.0 + +

    Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report.

    +
      +
    • Bugfix: Footnote delimiter short codes: debug closing pointy brackets in the Block Editor by accounting for unbalanced HTML escapement, thanks to @patrick_here @alifarahani8000 bug reports.
      • +
    +
    + +
    +
    + since +
    +
    + 2.5.13 + +
    + +
    +
    + reporter +
    +
    + +

    @patrick_here

    +
    + +
    +
    + reporter +
    +
    + +

    @alifarahani8000

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/how-to-add-footnotes-shortcode-in-elementor/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/after-version-2-5-10-the-ref-or-tags-are-not-longer-working/ + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + unify_delimiters() + +

    + + +

    Brings the delimiters and unifies their various HTML escapement schemas.

    + + + public + unify_delimiters(string $p_str_content) : mixed + +
    + +
    Parameters
    +
    +
    + $p_str_content + : string +
    +
    +

    TODO.

    +
      +
    • Bugfix: Footnote delimiter short codes: fix numbering bug by cross-editor HTML escapement schema unification, thanks to @patrick_here @alifarahani8000 @gova bug reports.
      • +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + reporter +
    +
    + +

    @patrick_here

    +
    + +
    +
    + reporter +
    +
    + +

    @alifarahani8000

    +
    + +
    +
    + reporter +
    +
    + +

    @gova

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/how-to-add-footnotes-shortcode-in-elementor/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/after-version-2-5-10-the-ref-or-tags-are-not-longer-working/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-content-number-not-sequential/ + +
    +
    + since +
    +
    + 2.1.14 + +

    While the Classic Editor (visual mode) escapes both pointy brackets, +the Block Editor enforces balanced escapement only in code editor mode +when the opening tag is already escaped. In visual mode, the Block Editor +does not escape the greater-than sign.

    +
    + +
    +
    + +
    Return values
    + mixed —
    diff --git a/docs/classes/MCI-Footnotes-Template.html b/docs/classes/MCI-Footnotes-Template.html index 98bc1ed..e40f2e6 100644 --- a/docs/classes/MCI-Footnotes-Template.html +++ b/docs/classes/MCI-Footnotes-Template.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@

    Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).

    @@ -100,15 +100,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -133,14 +124,14 @@
    C_STR_DASHBOARD -  = "dashboard" +  = 'dashboard'
    Directory name for dashboard templates.
    C_STR_PUBLIC -  = "public" +  = 'public'
    Directory name for public templates.
    @@ -152,14 +143,14 @@
    Plugin Directory
    - $a_str_OriginalContent + $a_str_original_content  : string
    Contains the content of the template after initialize.
    - $a_str_ReplacedContent + $a_str_replaced_content  : string
    @@ -173,25 +164,25 @@
    Class Constructor. Reads and loads the template file without replace any placeholder.
    - get_template() - -  : mixed -
    -
    Get the template
    - -
    - getContent() + get_content()  : string
    Returns the content of the template file with replaced placeholders.
    +
    + get_template() + +  : mixed +
    +
    Get the template.
    +
    process_template()  : void
    -
    Process template file
    +
    Process template file.
    reload() @@ -226,7 +217,7 @@

    Directory name for dashboard templates.

    @@ -235,7 +226,7 @@ public string C_STR_DASHBOARD - = "dashboard" + = 'dashboard' @@ -248,15 +239,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -277,7 +259,7 @@

    Directory name for public templates.

    @@ -286,7 +268,7 @@ public string C_STR_PUBLIC - = "public" + = 'public' @@ -299,15 +281,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -343,7 +316,7 @@

    Plugin Directory

    @@ -363,15 +336,6 @@
    - author -
    -
    - -

    Patrizia Lutz @misfist

    -
    - -
    -
    since
    @@ -390,16 +354,16 @@ -private " > -

    - $a_str_OriginalContent - +

    + $a_str_original_content +

    Contains the content of the template after initialize.

    @@ -407,8 +371,8 @@ private string - $a_str_OriginalContent - = "" + $a_str_original_content + = ''
    @@ -419,15 +383,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -446,16 +401,16 @@ -private " > -

    - $a_str_ReplacedContent - +

    + $a_str_replaced_content +

    Contains the content of the template after initialize with replaced place holders.

    @@ -463,8 +418,8 @@ private string - $a_str_ReplacedContent - = "" + $a_str_replaced_content + = ''
    @@ -475,15 +430,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -515,21 +461,21 @@

    Class Constructor. Reads and loads the template file without replace any placeholder.

    public - __construct(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed + __construct(string $p_str_file_type, string $p_str_file_name[, string $p_str_extension = 'html' ]) : mixed
    Parameters
    - $p_str_FileType + $p_str_file_type : string
    @@ -538,7 +484,7 @@
    - $p_str_FileName + $p_str_file_name : string
    @@ -547,11 +493,14 @@
    - $p_str_Extension + $p_str_extension : string - = "html"
    + = 'html'
    -

    Optional Template file extension (default: html)

    +

    Optional Template file extension (default: html).

    +
      +
    • Adding: Templates: support for custom templates in sibling folder, thanks to @misfist issue report.
      • +
    @@ -564,15 +513,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -587,17 +527,15 @@
    2.2.6 -

    support for custom templates 2020-12-19T0606+0100

    -
    +
    -
    - since +
    + reporter
    - 2.4.0 -

    look for custom template in the active theme first, thanks to @misfist

    +

    @misfist

    @@ -607,13 +545,6 @@
    https://wordpress.org/support/topic/template-override-filter/ -
    -
    - link -
    -
    - https://wordpress.org/support/topic/template-override-filter/#post-13846598 -
    @@ -630,107 +561,21 @@ -public " > -

    - get_template() - +

    + get_content() +

    - -

    Get the template

    - - - public - get_template(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed - -
    - -
    Parameters
    -
    -
    - $p_str_FileType - : string -
    -
    -
    - -
    -
    - $p_str_FileName - : string -
    -
    -
    - -
    -
    - $p_str_Extension - : string - = "html"
    -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - author -
    -
    - -

    Patrizia Lutz @misfist

    -
    - -
    -
    - since -
    -
    - 2.4.0d3 - -
    - -
    -
    - -
    Return values
    - mixed - — -

    false | template path

    -
    - - -
    -
    -

    - getContent() - -

    -

    Returns the content of the template file with replaced placeholders.

    public - getContent() : string + get_content() : string
    @@ -742,15 +587,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -768,6 +604,116 @@
    +
    +
    +

    + get_template() + +

    + + +

    Get the template.

    + + + public + get_template(string $p_str_file_type, string $p_str_file_name[, string $p_str_extension = 'html' ]) : mixed + +
      +
    • Adding: Templates: Enable template location stack, thanks to @misfist issue report and code contribution.
      • +
    +
    + +
    Parameters
    +
    +
    + $p_str_file_type + : string +
    +
    +

    The file type of the template.

    +
    + +
    +
    + $p_str_file_name + : string +
    +
    +

    The file name of the template.

    +
    + +
    +
    + $p_str_extension + : string + = 'html'
    +
    +

    The file extension of the template.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.4.0d3 + +

    Contribution.

    +
    + +
    +
    + since +
    +
    + 2.5.0 + +

    Release.

    +
    + +
    +
    + contributor +
    +
    + +

    @misfist

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/template-override-filter/#post-13864301 + +
    +
    + +
    Return values
    + mixed + — +

    false | template path

    +
    + +
    template.php : - 196 + 161 -

    Process template file

    +

    Process template file.

    public @@ -800,7 +746,8 @@ : string
    -
    +

    The template to be processed.

    +
    @@ -812,15 +759,6 @@
    - author -
    -
    - -

    Patrizia Lutz @misfist

    -
    - -
    -
    since
    @@ -835,7 +773,7 @@
    2.0.3 -

    replace tab with a space

    +

    Replace tab with a space.

    @@ -845,7 +783,7 @@
    2.0.3 -

    replace 2 spaces with 1

    +

    Replace 2 spaces with 1.

    @@ -855,7 +793,7 @@
    2.0.4 -

    collapse multiple spaces

    +

    Collapse multiple spaces.

    @@ -865,7 +803,7 @@
    2.2.6 -

    delete a space before a closing pointy bracket

    +

    Delete a space before a closing pointy bracket.

    @@ -875,7 +813,7 @@
    2.5.4 -

    collapse HTML comments and PHP/JS docblocks (only)

    +

    Collapse HTML comments and PHP/JS docblocks (only).

    @@ -901,7 +839,7 @@

    Reloads the original content of the template file.

    @@ -920,15 +858,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -959,21 +888,21 @@

    Replace all placeholders specified in array.

    public - replace(array<string|int, mixed> $p_arr_Placeholders) : bool + replace(array<string|int, mixed> $p_arr_placeholders) : bool
    Parameters
    - $p_arr_Placeholders + $p_arr_placeholders : array<string|int, mixed>
    @@ -990,15 +919,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    diff --git a/docs/classes/MCI-Footnotes-WYSIWYG.html b/docs/classes/MCI-Footnotes-WYSIWYG.html index 08eae4a..1e69579 100644 --- a/docs/classes/MCI-Footnotes-WYSIWYG.html +++ b/docs/classes/MCI-Footnotes-WYSIWYG.html @@ -70,7 +70,7 @@
    @@ -88,7 +88,8 @@ 15 - +

    Handles the WSYIWYG-Buttons.

    +
    @@ -98,15 +99,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -129,39 +121,39 @@
    - ajaxCallback() + ajax_callback()  : mixed
    AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.
    - includeScripts() + include_scripts()  : array<string|int, mixed>
    Includes the Plugins WYSIWYG editor script.
    - newPlainTextEditorButton() + new_plain_text_editor_button()  : mixed
    Add a new button to the plain text editor.
    - newVisualEditorButton() + new_visual_editor_button()  : array<string|int, mixed>
    Append a new Button to the WYSIWYG editor of Posts and Pages.
    - registerHooks() + register_hooks() -  : mixed +  : void
    -
    +
    Registers Button hooks.
    @@ -182,21 +174,21 @@ -public -static " > -

    - ajaxCallback() - +

    + ajax_callback() +

    AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.

    public - static ajaxCallback() : mixed + static ajax_callback() : mixed

    Returns an JSON encoded array with the Footnotes start and end short code.

    @@ -209,15 +201,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -241,28 +224,28 @@ -public -static " > -

    - includeScripts() - +

    + include_scripts() +

    Includes the Plugins WYSIWYG editor script.

    public - static includeScripts(array<string|int, mixed> $p_arr_Plugins) : array<string|int, mixed> + static include_scripts(array<string|int, mixed> $p_arr_plugins) : array<string|int, mixed>
    Parameters
    - $p_arr_Plugins + $p_arr_plugins : array<string|int, mixed>
    @@ -279,15 +262,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -311,21 +285,21 @@ -public -static " > -

    - newPlainTextEditorButton() - +

    + new_plain_text_editor_button() +

    Add a new button to the plain text editor.

    public - static newPlainTextEditorButton() : mixed + static new_plain_text_editor_button() : mixed
    @@ -337,15 +311,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -369,28 +334,28 @@ -public -static " > -

    - newVisualEditorButton() - +

    + new_visual_editor_button() +

    Append a new Button to the WYSIWYG editor of Posts and Pages.

    public - static newVisualEditorButton(array<string|int, mixed> $p_arr_Buttons) : array<string|int, mixed> + static new_visual_editor_button(array<string|int, mixed> $p_arr_buttons) : array<string|int, mixed>
    Parameters
    - $p_arr_Buttons + $p_arr_buttons : array<string|int, mixed>
    @@ -407,15 +372,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -439,27 +395,72 @@ -public -static " > -

    - registerHooks() - +

    + register_hooks() +

    - +

    Registers Button hooks.

    + public - static registerHooks() : mixed + 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
    - mixed + void —
    diff --git a/docs/classes/MCI-Footnotes-WidgetBase.html b/docs/classes/MCI-Footnotes-Widget-Base.html similarity index 78% rename from docs/classes/MCI-Footnotes-WidgetBase.html rename to docs/classes/MCI-Footnotes-Widget-Base.html index 31cc342..46f4f29 100644 --- a/docs/classes/MCI-Footnotes-WidgetBase.html +++ b/docs/classes/MCI-Footnotes-Widget-Base.html @@ -70,12 +70,12 @@

    - MCI_Footnotes_WidgetBase + MCI_Footnotes_Widget_Base extends WP_Widget @@ -88,7 +88,7 @@

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

    @@ -136,35 +136,35 @@
    - __construct() + __construct()  : mixed
    Class Constructor. Registers the child Widget to WordPress.
    - getDescription() + get_description()  : string
    Returns the Description of the child widget.
    - getID() + get_id()  : string
    Returns an unique ID as string used for the Widget Base ID.
    - getName() + get_name()  : string
    Returns the Public name of child Widget to be displayed in the Configuration page.
    - getWidgetWidth() + get_widget_width()  : int
    @@ -181,7 +181,7 @@

    Methods - +

    __construct() - +

    Class Constructor. Registers the child Widget to WordPress.

    @@ -215,15 +215,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -276,21 +267,21 @@ -protected -abstract " > -

    - getDescription() - +

    + get_description() +

    Returns the Description of the child widget.

    protected - abstract getDescription() : string + abstract get_description() : string
    @@ -302,15 +293,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -334,21 +316,21 @@ -protected -abstract " > -

    - getID() - +

    + get_id() +

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

    protected - abstract getID() : string + abstract get_id() : string
    @@ -360,15 +342,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -392,21 +365,21 @@ -protected -abstract " > -

    - getName() - +

    + get_name() +

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

    protected - abstract getName() : string + abstract get_name() : string
    @@ -418,15 +391,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -450,21 +414,21 @@ -protected " > -

    - getWidgetWidth() - +

    + get_widget_width() +

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

    protected - getWidgetWidth() : int + get_widget_width() : int
    @@ -476,15 +440,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -518,7 +473,7 @@
    - + diff --git a/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html b/docs/classes/MCI-Footnotes-Widget-Reference-Container.html similarity index 76% rename from docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html rename to docs/classes/MCI-Footnotes-Widget-Reference-Container.html index 8ef7d35..ced319b 100644 --- a/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html +++ b/docs/classes/MCI-Footnotes-Widget-Reference-Container.html @@ -70,15 +70,15 @@

    - MCI_Footnotes_Widget_ReferenceContainer + MCI_Footnotes_Widget_Reference_Container - extends MCI_Footnotes_WidgetBase + extends MCI_Footnotes_Widget_Base @@ -88,7 +88,7 @@

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

    @@ -102,15 +102,6 @@

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -133,49 +124,49 @@
    - __construct() + __construct()  : mixed
    Class Constructor. Registers the child Widget to WordPress.
    - form() + form()  : void
    Outputs the Settings of the Widget.
    - widget() + widget()  : mixed
    Outputs the Content of the Widget.
    - getDescription() + get_description()  : string
    Returns the Description of the child widget.
    - getID() + get_id()  : string
    Returns an unique ID as string used for the Widget Base ID.
    - getName() + get_name()  : string
    Returns the Public name of the Widget to be displayed in the Configuration page.
    - getWidgetWidth() + get_widget_width()  : int
    @@ -192,7 +183,7 @@

    Methods - +

    __construct() - +

    Class Constructor. Registers the child Widget to WordPress.

    @@ -226,15 +217,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -289,12 +271,12 @@ >

    form() - +

    Outputs the Settings of the Widget.

    @@ -312,7 +294,8 @@ : mixed
    -
    +

    The instance of the widget.

    +
    @@ -324,15 +307,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -346,7 +320,7 @@
    Return values
    void — -

    Edit: curly quotes 2.2.0 2020-12-12T2130+0100

    +

    Edit: curly quotes 2.2.0

    @@ -359,12 +333,12 @@ >

    widget() - +

    Outputs the Content of the Widget.

    @@ -382,7 +356,8 @@ : mixed
    -
    +

    The widget's arguments.

    +
    @@ -390,7 +365,8 @@ : mixed
    -
    +

    The instance of the widget.

    +
    @@ -402,15 +378,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -434,21 +401,21 @@ -protected " > -

    - getDescription() - +

    + get_description() +

    Returns the Description of the child widget.

    protected - getDescription() : string + get_description() : string
    @@ -460,15 +427,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -482,7 +440,7 @@
    Return values
    string — -

    Edit: curly quotes 2.2.0 2020-12-12T2130+0100

    +

    Edit: curly quotes 2.2.0

    @@ -493,21 +451,21 @@ -protected " > -

    - getID() - +

    + get_id() +

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

    protected - getID() : string + get_id() : string
    @@ -519,15 +477,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -551,21 +500,21 @@ -protected " > -

    - getName() - +

    + get_name() +

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

    protected - getName() : string + get_name() : string
    @@ -577,15 +526,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -609,21 +549,21 @@ -protected " > -

    - getWidgetWidth() - +

    + get_widget_width() +

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

    protected - getWidgetWidth() : int + get_widget_width() : int
    @@ -635,15 +575,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -677,7 +608,7 @@
    - + diff --git a/docs/classes/MCI-Footnotes.html b/docs/classes/MCI-Footnotes.html index d09558a..19479a2 100644 --- a/docs/classes/MCI-Footnotes.html +++ b/docs/classes/MCI-Footnotes.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@

    Entry point of the Plugin. Loads the Dashboard and executes the Task.

    @@ -99,15 +99,6 @@
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -130,35 +121,49 @@
    - $a_bool_AlternativeTooltipsEnabled - -  : mixed -
    -
    - -
    - $a_bool_TooltipsEnabled + $a_bool_alternative_tooltips_enabled  : bool
    -
    Template process and script / stylesheet load optimization.
    +
    Allows to determine whether alternative tooltips are enabled.
    - $a_obj_Task + $a_bool_amp_enabled + +  : bool +
    +
    Allows to determine whether AMP compatibility mode is enabled.
    + +
    + $a_bool_tooltips_enabled + +  : bool +
    +
    Allows to determine whether tooltips are enabled.
    + +
    + $a_obj_task  : null|MCI_Footnotes_Task
    Reference to the Plugin Task object.
    +
    + $a_str_script_mode + +  : str +
    +
    Allows to determine the script mode among jQuery or plain JS.
    +
    - initializeWidgets() + initialize_widgets()  : mixed
    Initializes all Widgets of the Plugin.
    - registerPublic() + register_public()  : mixed
    @@ -172,14 +177,14 @@
    Executes the Plugin.
    - initializeDashboard() + initialize_dashboard()  : mixed
    Initializes the Dashboard of the Plugin and loads them.
    - initializeTask() + initialize_task()  : mixed
    @@ -204,27 +209,81 @@ -public -static " > -

    - $a_bool_AlternativeTooltipsEnabled - +

    + $a_bool_alternative_tooltips_enabled +

    - +

    Allows to determine whether alternative tooltips are enabled.

    + public - static mixed - $a_bool_AlternativeTooltipsEnabled + static bool + $a_bool_alternative_tooltips_enabled = alse +
      +
    • Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
      • +
    +
    + - +
    + Tags + +
    +
    +
    + since +
    +
    + 2.1.1 + +
    + +
    +
    + since +
    +
    + 2.4.0 + +
    + +
    +
    + reporter +
    +
    + +

    @andreasra

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566 + +
    +
    + contributor +
    +
    + +

    Patrizia Lutz @misfist

    +
    + +
    +
    -

    - $a_bool_TooltipsEnabled - +

    + $a_bool_amp_enabled +

    -

    Template process and script / stylesheet load optimization.

    +

    Allows to determine whether AMP compatibility mode is enabled.

    public static bool - $a_bool_TooltipsEnabled + $a_bool_amp_enabled = alse
      +
    • Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.
      • +
    • Bugfix: Tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.
      • +
    • Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.5.11 + +

    (draft)

    +
    + +
    +
    + since +
    +
    + 2.6.0 + +

    (release)

    +
    + +
    +
    + contributor +
    +
    + +

    @milindmore22

    +
    + +
    +
    + contributor +
    +
    + +

    @westonruter

    +
    + +
    +
    + link +
    +
    + https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 + +
    +
    + link +
    +
    + https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 + +
    +
    + link +
    +
    + https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854 + +
    +
    + link +
    +
    + https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394 + +
    +
    + +
    +
    +

    + $a_bool_tooltips_enabled + + + +

    + + +

    Allows to determine whether tooltips are enabled.

    + + + public + static bool + $a_bool_tooltips_enabled + = alse + +

    The actual value of these properties is configurable.

    +
    • Bugfix: Templates: optimize template load and processing based on settings, thanks to @misfist code contribution.
    @@ -275,16 +444,7 @@
    - date -
    -
    - -

    2021-01-04T1355+0100

    -
    - -
    -
    - author + contributor
    @@ -325,16 +485,16 @@ -public " > -

    - $a_obj_Task - +

    + $a_obj_task +

    Reference to the Plugin Task object.

    @@ -342,7 +502,7 @@ public null|MCI_Footnotes_Task - $a_obj_Task + $a_obj_task = ull @@ -355,15 +515,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -374,6 +525,88 @@ ull
    + +
    +

    + $a_str_script_mode + + + +

    + + +

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

    + + + public + static str + $a_str_script_mode + = 'js' + +
      +
    • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
      • +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.5.6 + +
    + +
    +
    + reporter +
    +
    + +

    @hopper87it

    +
    + +
    +
    + reporter +
    +
    + +

    @pkverma99

    +
    + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-wp-rocket/ + +
    +
    + link +
    +
    + https://wordpress.org/support/topic/footnotes-wp-rocket/#post-14076188 + +
    +
    +
    @@ -388,21 +621,21 @@ ull -public " > -

    - initializeWidgets() - +

    + initialize_widgets() +

    Initializes all Widgets of the Plugin.

    public - initializeWidgets() : mixed + initialize_widgets() : mixed
    @@ -414,15 +647,6 @@ ull
    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -514,7 +738,7 @@ and use the bare register_widget() here.

    self::run() -

    Also, the visibility of initializeWidgets() is not private any longer.

    +

    Also, the visibility of initialize_widgets() is not private any longer.

    @@ -533,21 +757,21 @@ and use the bare register_widget() here.

    -public " > -

    - registerPublic() - +

    + register_public() +

    Registers and enqueues scripts and stylesheets to the public pages.

    public - registerPublic() : mixed + register_public() : mixed
    @@ -559,15 +783,6 @@ and use the bare register_widget() here.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -592,7 +807,7 @@ and use the bare register_widget() here.

    2.0.3 -

    add versioning of public.css for cache busting 2020-10-29T1413+0100

    +

    add versioning of public.css for cache busting

    @@ -602,7 +817,7 @@ and use the bare register_widget() here.

    2.0.4 -

    add jQuery UI from WordPress 2020-11-01T1902+0100

    +

    add jQuery UI from WordPress

    @@ -612,7 +827,7 @@ and use the bare register_widget() here.

    2.1.4 -

    automate passing version number for cache busting 2020-11-30T0646+0100

    +

    automate passing version number for cache busting

    @@ -622,7 +837,7 @@ and use the bare register_widget() here.

    2.1.4 -

    optionally enqueue an extra stylesheet 2020-12-04T2231+0100

    +

    optionally enqueue an extra stylesheet

    @@ -648,7 +863,7 @@ and use the bare register_widget() here.

    Executes the Plugin.

    @@ -667,15 +882,6 @@ and use the bare register_widget() here.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -708,6 +914,13 @@ and use the bare register_widget() here.

    link
    +
    + https://github.com/benleyjyc/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 + +
    +
    + link +
    https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 @@ -716,7 +929,7 @@ and use the bare register_widget() here.

    see
    - self::initializeWidgets() + self::initialize_widgets()
    @@ -736,21 +949,21 @@ and use the bare register_widget() here.

    -private " > -

    - initializeDashboard() - +

    + initialize_dashboard() +

    Initializes the Dashboard of the Plugin and loads them.

    private - initializeDashboard() : mixed + initialize_dashboard() : mixed
    @@ -762,15 +975,6 @@ and use the bare register_widget() here.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    @@ -794,21 +998,21 @@ and use the bare register_widget() here.

    -private " > -

    - initializeTask() - +

    + initialize_task() +

    Initializes the Plugin Task and registers the Task hooks.

    private - initializeTask() : mixed + initialize_task() : mixed
    @@ -820,15 +1024,6 @@ and use the bare register_widget() here.

    - author -
    -
    - -

    Stefan Herndler

    -
    - -
    -
    since
    diff --git a/docs/files/class-config.html b/docs/files/class-config.html index 27fa852..c1359b8 100644 --- a/docs/files/class-config.html +++ b/docs/files/class-config.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-convert.html b/docs/files/class-convert.html index 332a478..66f4091 100644 --- a/docs/files/class-convert.html +++ b/docs/files/class-convert.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-dashboard-init.html b/docs/files/class-dashboard-init.html index b64a13d..7e5b4a5 100644 --- a/docs/files/class-dashboard-init.html +++ b/docs/files/class-dashboard-init.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-dashboard-layout.html b/docs/files/class-dashboard-layout.html index 18778f8..5a9fb76 100644 --- a/docs/files/class-dashboard-layout.html +++ b/docs/files/class-dashboard-layout.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@
    -
    MCI_Footnotes_LayoutEngine
    +
    MCI_Footnotes_Layout_Engine
    Layout Engine for the administration dashboard.
    diff --git a/docs/files/class-dashboard-subpage-main.html b/docs/files/class-dashboard-subpage-main.html index 62a90fc..adeed4c 100644 --- a/docs/files/class-dashboard-subpage-main.html +++ b/docs/files/class-dashboard-subpage-main.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-hooks.html b/docs/files/class-hooks.html index b57ef84..e44dc10 100644 --- a/docs/files/class-hooks.html +++ b/docs/files/class-hooks.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-init.html b/docs/files/class-init.html index 27020fe..fd2f2f1 100644 --- a/docs/files/class-init.html +++ b/docs/files/class-init.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-language.html b/docs/files/class-language.html index db941a6..012b3be 100644 --- a/docs/files/class-language.html +++ b/docs/files/class-language.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-settings.html b/docs/files/class-settings.html index 910ad5e..0528806 100644 --- a/docs/files/class-settings.html +++ b/docs/files/class-settings.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-task.html b/docs/files/class-task.html index d4b6618..a0b2eb4 100644 --- a/docs/files/class-task.html +++ b/docs/files/class-task.html @@ -70,7 +70,7 @@
    @@ -86,7 +86,7 @@
    MCI_Footnotes_Task
    -
    Searches and replaces the footnotes.
    +
    Searches and replaces the footnotes and generates the reference container.
    diff --git a/docs/files/class-template.html b/docs/files/class-template.html index 09b8714..0af2ead 100644 --- a/docs/files/class-template.html +++ b/docs/files/class-template.html @@ -70,7 +70,7 @@
    diff --git a/docs/files/class-widgets-base.html b/docs/files/class-widgets-base.html index edfbc18..97da848 100644 --- a/docs/files/class-widgets-base.html +++ b/docs/files/class-widgets-base.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@
    -
    MCI_Footnotes_WidgetBase
    +
    MCI_Footnotes_Widget_Base
    Base Class for all Plugin Widgets. Registers each Widget to WordPress.
    diff --git a/docs/files/class-widgets-reference-container.html b/docs/files/class-widgets-reference-container.html index 9553b8a..849ffe7 100644 --- a/docs/files/class-widgets-reference-container.html +++ b/docs/files/class-widgets-reference-container.html @@ -70,7 +70,7 @@
    @@ -85,7 +85,7 @@
    -
    MCI_Footnotes_Widget_ReferenceContainer
    +
    MCI_Footnotes_Widget_Reference_Container
    Registers a Widget to put the Reference Container to the widget area.
    diff --git a/docs/files/class-wysiwyg.html b/docs/files/class-wysiwyg.html index 59d1315..c72bef1 100644 --- a/docs/files/class-wysiwyg.html +++ b/docs/files/class-wysiwyg.html @@ -70,7 +70,7 @@
    @@ -86,7 +86,7 @@
    MCI_Footnotes_WYSIWYG
    -
    +
    Handles the WSYIWYG-Buttons.
    diff --git a/docs/files/footnotes.html b/docs/files/footnotes.html deleted file mode 100644 index 132a72c..0000000 --- a/docs/files/footnotes.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
    -

    Documentation

    - - -
    - -
    - - -
    - -
    -
    - - - - -
    - - -
    -

    footnotes.php

    - - - - - - - - - - -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      -
      - - -
      - - - - diff --git a/docs/files/includes.html b/docs/files/includes.html deleted file mode 100644 index de8700d..0000000 --- a/docs/files/includes.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - Documentation - - - - - - - - - - - - - - - -
      -

      Documentation

      - - -
      - -
      - - -
      - -
      -
      - - - - -
      - - -
      -

      includes.php

      - - - - - -

      - Table of Contents - -

      - -
      -
      - MCI_Footnotes_requirePhpFiles() - -  : mixed -
      -
      Requires (require_once) all *.php files inside a specific Directory.
      - -
      - - - - -
      -

      - Functions - -

      -
      -

      - MCI_Footnotes_requirePhpFiles() - -

      - - -

      Requires (require_once) all *.php files inside a specific Directory.

      - - - - MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed - -
      - -
      Parameters
      -
      -
      - $p_str_Directory - : string -
      -
      -

      Absolute Directory path to lookup for *.php files

      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - author -
      -
      - -

      Stefan Herndler

      -
      - -
      -
      - since -
      -
      - 1.5.0 - -
      - -
      -
      - - -
      -
      - -
      -
      -
      -
      -

      Search results

      - -
      -
      -
        -
        -
        -
        -
        -
        - - -
        - - - - diff --git a/docs/index.html b/docs/index.html index 003b277..b101070 100644 --- a/docs/index.html +++ b/docs/index.html @@ -87,10 +87,8 @@
        Converts data types and Footnotes specific values.
        MCI_Footnotes_Layout_Init
        Handles the Settings interface of the Plugin.
        -
        MCI_Footnotes_LayoutEngine
        +
        MCI_Footnotes_Layout_Engine
        Layout Engine for the administration dashboard.
        -
        MCI_Footnotes_Layout_Diagnostics
        -
        Displays Diagnostics of the web server, PHP and WordPress.
        MCI_Footnotes_Layout_Settings
        Displays and handles all Settings of the Plugin.
        MCI_Footnotes_Hooks
        @@ -102,103 +100,23 @@
        MCI_Footnotes_Settings
        Loads the settings values, sets to default values if undefined.
        MCI_Footnotes_Task
        -
        Searches and replaces the footnotes.
        +
        Searches and replaces the footnotes and generates the reference container.
        MCI_Footnotes_Template
        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
        -
        MCI_Footnotes_WidgetBase
        +
        MCI_Footnotes_Widget_Base
        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
        -
        MCI_Footnotes_Widget_ReferenceContainer
        +
        MCI_Footnotes_Widget_Reference_Container
        Registers a Widget to put the Reference Container to the widget area.
        MCI_Footnotes_WYSIWYG
        -
        +
        Handles the WSYIWYG-Buttons.
        -

        - Table of Contents - -

        - -
        -
        - MCI_Footnotes_requirePhpFiles() - -  : mixed -
        -
        Requires (require_once) all *.php files inside a specific Directory.
        - -
        -
        -

        - Functions - -

        -
        -

        - MCI_Footnotes_requirePhpFiles() - -

        - - -

        Requires (require_once) all *.php files inside a specific Directory.

        - - - - MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed - -
        - -
        Parameters
        -
        -
        - $p_str_Directory - : string -
        -
        -

        Absolute Directory path to lookup for *.php files

        -
        - -
        -
        - -
        - Tags - -
        -
        -
        - author -
        -
        - -

        Stefan Herndler

        -
        - -
        -
        - since -
        -
        - 1.5.0 - -
        - -
        -
        - - -
        -
        -
        diff --git a/docs/indices/files.html b/docs/indices/files.html index 7ac73fe..41fea3e 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -80,19 +80,14 @@
      • config.php
      • convert.php
        • -

        F

        - -

        H

        +

        H

        I

        L

          @@ -106,7 +101,6 @@

          S

          T

          diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index ca8f2cc..3bdcd45 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -41,35 +41,35 @@ Search.appendIndex( "summary": "Converts\u0020data\u0020types\u0020and\u0020Footnotes\u0020specific\u0020values.", "url": "classes/MCI-Footnotes-Convert.html" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AIndex\u0028\u0029", - "name": "Index", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Aindex\u0028\u0029", + "name": "index", "summary": "Converts\u0020a\u0020integer\u0020into\u0020the\u0020user\u002Ddefined\u0020counter\u0020style\u0020for\u0020the\u0020footnotes.", - "url": "classes/MCI-Footnotes-Convert.html#method_Index" + "url": "classes/MCI-Footnotes-Convert.html#method_index" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoLatin\u0028\u0029", - "name": "toLatin", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Ato_latin\u0028\u0029", + "name": "to_latin", "summary": "Converts\u0020an\u0020integer\u0020into\u0020latin\u0020ascii\u0020characters,\u0020either\u0020lower\u0020or\u0020upper\u002Dcase.", - "url": "classes/MCI-Footnotes-Convert.html#method_toLatin" + "url": "classes/MCI-Footnotes-Convert.html#method_to_latin" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoArabicLeading\u0028\u0029", - "name": "toArabicLeading", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Ato_arabic_leading\u0028\u0029", + "name": "to_arabic_leading", "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020leading\u002D0\u0020integer.", - "url": "classes/MCI-Footnotes-Convert.html#method_toArabicLeading" + "url": "classes/MCI-Footnotes-Convert.html#method_to_arabic_leading" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoRomanic\u0028\u0029", - "name": "toRomanic", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Ato_romanic\u0028\u0029", + "name": "to_romanic", "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020romanic\u0020letter.", - "url": "classes/MCI-Footnotes-Convert.html#method_toRomanic" + "url": "classes/MCI-Footnotes-Convert.html#method_to_romanic" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoBool\u0028\u0029", - "name": "toBool", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Ato_bool\u0028\u0029", + "name": "to_bool", "summary": "Converts\u0020a\u0020string\u0020depending\u0020on\u0020its\u0020value\u0020to\u0020a\u0020boolean.", - "url": "classes/MCI-Footnotes-Convert.html#method_toBool" + "url": "classes/MCI-Footnotes-Convert.html#method_to_bool" }, { - "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AgetArrow\u0028\u0029", - "name": "getArrow", + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Aget_arrow\u0028\u0029", + "name": "get_arrow", "summary": "Get\u0020a\u0020html\u0020Array\u0020short\u0020code\u0020depending\u0020on\u0020Arrow\u002DArray\u0020key\u0020index.", - "url": "classes/MCI-Footnotes-Convert.html#method_getArrow" + "url": "classes/MCI-Footnotes-Convert.html#method_get_arrow" }, { "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Adebug\u0028\u0029", "name": "debug", @@ -86,30 +86,20 @@ Search.appendIndex( "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", "url": "classes/MCI-Footnotes-Layout-Init.html#method___construct" }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AinitializeSettings\u0028\u0029", - "name": "initializeSettings", - "summary": "Initializes\u0020all\u0020sub\u0020pages\u0020and\u0020registers\u0020the\u0020settings.", - "url": "classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings" + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003Ainitialize_settings\u0028\u0029", + "name": "initialize_settings", + "summary": "Registers\u0020the\u0020settings\u0020and\u0020initialises\u0020the\u0020settings\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_initialize_settings" }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterMainMenu\u0028\u0029", - "name": "registerMainMenu", - "summary": "Registers\u0020the\u0020new\u0020main\u0020menu\u0020for\u0020the\u0020WordPress\u0020dashboard.", - "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu" + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003Aregister_options_submenu\u0028\u0029", + "name": "register_options_submenu", + "summary": "Registers\u0020the\u0020footnotes\u0020submenu\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_register_options_submenu" }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterSubPages\u0028\u0029", - "name": "registerSubPages", - "summary": "Registers\u0020all\u0020SubPages\u0020for\u0020this\u0020Plugin.", - "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AdisplayOtherPlugins\u0028\u0029", - "name": "displayOtherPlugins", - "summary": "Displays\u0020other\u0020Plugins\u0020from\u0020the\u0020developers.", - "url": "classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AgetPluginMetaInformation\u0028\u0029", - "name": "getPluginMetaInformation", + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003Aget_plugin_meta_information\u0028\u0029", + "name": "get_plugin_meta_information", "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", - "url": "classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation" + "url": "classes/MCI-Footnotes-Layout-Init.html#method_get_plugin_meta_information" }, { "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_SLUG", "name": "C_STR_MAIN_MENU_SLUG", @@ -121,350 +111,330 @@ Search.appendIndex( "summary": "Plugin\u0020main\u0020menu\u0020name.", "url": "classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" }, { - "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A\u0024a_arr_SubPageClasses", - "name": "a_arr_SubPageClasses", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses" + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A\u0024settings_page", + "name": "settings_page", + "summary": "Contains\u0020the\u0020settings\u0020layoutEngine", + "url": "classes/MCI-Footnotes-Layout-Init.html#property_settings_page" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine", - "name": "MCI_Footnotes_LayoutEngine", + "fqsen": "\\MCI_Footnotes_Layout_Engine", + "name": "MCI_Footnotes_Layout_Engine", "summary": "Layout\u0020Engine\u0020for\u0020the\u0020administration\u0020dashboard.", - "url": "classes/MCI-Footnotes-LayoutEngine.html" + "url": "classes/MCI-Footnotes-Layout-Engine.html" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetPriority\u0028\u0029", - "name": "getPriority", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aget_priority\u0028\u0029", + "name": "get_priority", "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getPriority" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_get_priority" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageSlug\u0028\u0029", - "name": "getSubPageSlug", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aget_sub_page_slug\u0028\u0029", + "name": "get_sub_page_slug", "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020child\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageSlug" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_get_sub_page_slug" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageTitle\u0028\u0029", - "name": "getSubPageTitle", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aget_sub_page_title\u0028\u0029", + "name": "get_sub_page_title", "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020child\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageTitle" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_get_sub_page_title" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSections\u0028\u0029", - "name": "getSections", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aget_sections\u0028\u0029", + "name": "get_sections", "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020a\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSections" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_get_sections" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetMetaBoxes\u0028\u0029", - "name": "getMetaBoxes", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aget_meta_boxes\u0028\u0029", + "name": "get_meta_boxes", "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getMetaBoxes" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_get_meta_boxes" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSection\u0028\u0029", - "name": "addSection", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_section\u0028\u0029", + "name": "add_section", "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020sub\u0020page\u0020section.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSection" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_section" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddMetaBox\u0028\u0029", - "name": "addMetaBox", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_meta_box\u0028\u0029", + "name": "add_meta_box", "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020meta\u0020box.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addMetaBox" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_meta_box" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSubPage\u0028\u0029", - "name": "registerSubPage", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aregister_sub_page\u0028\u0029", + "name": "register_sub_page", "summary": "Registers\u0020a\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSubPage" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_register_sub_page" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSections\u0028\u0029", - "name": "registerSections", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aregister_sections\u0028\u0029", + "name": "register_sections", "summary": "Registers\u0020all\u0020sections\u0020for\u0020a\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSections" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_register_sections" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterMetaBoxes\u0028\u0029", - "name": "registerMetaBoxes", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aregister_meta_boxes\u0028\u0029", + "name": "register_meta_boxes", "summary": "Registers\u0020all\u0020Meta\u0020boxes\u0020for\u0020a\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerMetaBoxes" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_register_meta_boxes" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AappendScripts\u0028\u0029", - "name": "appendScripts", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aappend_scripts\u0028\u0029", + "name": "append_scripts", "summary": "Append\u0020javascript\u0020and\u0020css\u0020files\u0020for\u0020specific\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_appendScripts" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_append_scripts" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AdisplayContent\u0028\u0029", - "name": "displayContent", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Adisplay_content\u0028\u0029", + "name": "display_content", "summary": "Displays\u0020the\u0020content\u0020of\u0020specific\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_displayContent" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_display_content" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AsaveSettings\u0028\u0029", - "name": "saveSettings", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Asave_settings\u0028\u0029", + "name": "save_settings", "summary": "Save\u0020all\u0020Plugin\u0020settings.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_saveSettings" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_save_settings" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ADescription\u0028\u0029", - "name": "Description", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Adescription\u0028\u0029", + "name": "description", "summary": "Output\u0020the\u0020Description\u0020of\u0020a\u0020section.\u0020May\u0020be\u0020overwritten\u0020in\u0020any\u0020section.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_Description" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_description" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ALoadSetting\u0028\u0029", - "name": "LoadSetting", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aload_setting\u0028\u0029", + "name": "load_setting", "summary": "Loads\u0020specific\u0020setting\u0020and\u0020returns\u0020an\u0020array\u0020with\u0020the\u0020keys\u0020\u005Bid,\u0020name,\u0020value\u005D.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_LoadSetting" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_load_setting" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNewline\u0028\u0029", - "name": "addNewline", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_newline\u0028\u0029", + "name": "add_newline", "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020start\u0020a\u0020new\u0020line.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNewline" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_newline" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLineSpace\u0028\u0029", - "name": "addLineSpace", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_line_space\u0028\u0029", + "name": "add_line_space", "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020have\u0020a\u0020space\u0020between\u0020two\u0020lines.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLineSpace" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_line_space" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddText\u0028\u0029", - "name": "addText", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_text\u0028\u0029", + "name": "add_text", "summary": "Returns\u0020a\u0020simple\u0020text\u0020inside\u0020html\u0020\u003Cspan\u003E\u0020text.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addText" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_text" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLabel\u0028\u0029", - "name": "addLabel", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_label\u0028\u0029", + "name": "add_label", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\/select\u0020label.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLabel" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_label" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextBox\u0028\u0029", - "name": "addTextBox", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_text_box\u0028\u0029", + "name": "add_text_box", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextBox" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_text_box" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddCheckbox\u0028\u0029", - "name": "addCheckbox", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_checkbox\u0028\u0029", + "name": "add_checkbox", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020checkbox\u005D.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addCheckbox" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_checkbox" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSelectBox\u0028\u0029", - "name": "addSelectBox", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_select_box\u0028\u0029", + "name": "add_select_box", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020select\u0020box.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSelectBox" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_select_box" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextArea\u0028\u0029", - "name": "addTextArea", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_textarea\u0028\u0029", + "name": "add_textarea", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020text\u0020area.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextArea" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_textarea" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddColorSelection\u0028\u0029", - "name": "addColorSelection", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_color_selection\u0028\u0029", + "name": "add_color_selection", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D\u0020with\u0020color\u0020selection\u0020class.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addColorSelection" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_color_selection" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNumBox\u0028\u0029", - "name": "addNumBox", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003Aadd_num_box\u0028\u0029", + "name": "add_num_box", "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020num\u005D.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNumBox" + "url": "classes/MCI-Footnotes-Layout-Engine.html#method_add_num_box" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_str_SubPageHook", - "name": "a_str_SubPageHook", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003A\u0024a_str_sub_page_hook", + "name": "a_str_sub_page_hook", "summary": "Stores\u0020the\u0020Hook\u0020connection\u0020string\u0020for\u0020the\u0020child\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_str_SubPageHook" + "url": "classes/MCI-Footnotes-Layout-Engine.html#property_a_str_sub_page_hook" }, { - "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_arr_Sections", - "name": "a_arr_Sections", + "fqsen": "\\MCI_Footnotes_Layout_Engine\u003A\u003A\u0024a_arr_sections", + "name": "a_arr_sections", "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_arr_Sections" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics", - "name": "MCI_Footnotes_Layout_Diagnostics", - "summary": "Displays\u0020Diagnostics\u0020of\u0020the\u0020web\u0020server,\u0020PHP\u0020and\u0020WordPress.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetPriority\u0028\u0029", - "name": "getPriority", - "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getPriority" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageSlug\u0028\u0029", - "name": "getSubPageSlug", - "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageSlug" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageTitle\u0028\u0029", - "name": "getSubPageTitle", - "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageTitle" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSections\u0028\u0029", - "name": "getSections", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSections" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetMetaBoxes\u0028\u0029", - "name": "getMetaBoxes", - "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getMetaBoxes" - }, { - "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003ADiagnostics\u0028\u0029", - "name": "Diagnostics", - "summary": "Displays\u0020a\u0020diagnostics\u0020about\u0020the\u0020web\u0020server,\u0020php\u0020and\u0020WordPress.", - "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_Diagnostics" + "url": "classes/MCI-Footnotes-Layout-Engine.html#property_a_arr_sections" }, { "fqsen": "\\MCI_Footnotes_Layout_Settings", "name": "MCI_Footnotes_Layout_Settings", "summary": "Displays\u0020and\u0020handles\u0020all\u0020Settings\u0020of\u0020the\u0020Plugin.", "url": "classes/MCI-Footnotes-Layout-Settings.html" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetPriority\u0028\u0029", - "name": "getPriority", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aget_priority\u0028\u0029", + "name": "get_priority", "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getPriority" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_get_priority" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageSlug\u0028\u0029", - "name": "getSubPageSlug", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aget_sub_page_slug\u0028\u0029", + "name": "get_sub_page_slug", "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageSlug" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_get_sub_page_slug" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageTitle\u0028\u0029", - "name": "getSubPageTitle", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aget_sub_page_title\u0028\u0029", + "name": "get_sub_page_title", "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageTitle" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_get_sub_page_title" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSections\u0028\u0029", - "name": "getSections", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aget_sections\u0028\u0029", + "name": "get_sections", "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSections" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_get_sections" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetMetaBoxes\u0028\u0029", - "name": "getMetaBoxes", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aget_meta_boxes\u0028\u0029", + "name": "get_meta_boxes", "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getMetaBoxes" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_get_meta_boxes" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AReferenceContainer\u0028\u0029", - "name": "ReferenceContainer", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aamp_compat\u0028\u0029", + "name": "amp_compat", + "summary": "Displays\u0020the\u0020AMP\u0020compatibility\u0020mode\u0020option.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_amp_compat" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Areference_container\u0028\u0029", + "name": "reference_container", "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020reference\u0020container.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_ReferenceContainer" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_reference_container" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AStartEnd\u0028\u0029", - "name": "StartEnd", - "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_StartEnd" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Astart_end\u0028\u0029", + "name": "start_end", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_start_end" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ANumbering\u0028\u0029", - "name": "Numbering", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Numbering" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Anumbering\u0028\u0029", + "name": "numbering", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_numbering" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AScrolling\u0028\u0029", - "name": "Scrolling", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Scrolling" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Ascrolling\u0028\u0029", + "name": "scrolling", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_scrolling" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALove\u0028\u0029", - "name": "Love", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Ahard_links\u0028\u0029", + "name": "hard_links", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020fragment\u0020identifier\u0020configuration.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_hard_links" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Alove\u0028\u0029", + "name": "love", "summary": "Displays\u0020all\u0020settings\u0020for\u0020\u0027I\u0020love\u0020Footnotes\u0027.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Love" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_love" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AExcerpts\u0028\u0029", - "name": "Excerpts", - "summary": "Displays\u0020the\u0020excerpt\u0020setting", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Excerpts" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Aexcerpts\u0028\u0029", + "name": "excerpts", + "summary": "Displays\u0020the\u0020footnotes\u0020in\u0020excerpt\u0020setting.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_excerpts" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ASuperscript\u0028\u0029", - "name": "Superscript", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Superscript" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Asuperscript\u0028\u0029", + "name": "superscript", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_superscript" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBox\u0028\u0029", - "name": "MouseOverBox", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBox" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Alabel_solution\u0028\u0029", + "name": "label_solution", + "summary": "Displays\u0020the\u0020setting\u0020for\u0020the\u0020input\u0020label\u0020issue\u0020solution.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_label_solution" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxPosition\u0028\u0029", - "name": "MouseOverBoxPosition", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxPosition" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box\u0028\u0029", + "name": "mouseover_box", + "summary": "Displays\u0020enabled\u0020status\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxDimensions\u0028\u0029", - "name": "MouseOverBoxDimensions", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxDimensions" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_position\u0028\u0029", + "name": "mouseover_box_position", + "summary": "Displays\u0020position\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_position" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTiming\u0028\u0029", - "name": "MouseOverBoxTiming", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTiming" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_dimensions\u0028\u0029", + "name": "mouseover_box_dimensions", + "summary": "Displays\u0020dimensions\u0020setting\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_dimensions" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTruncation\u0028\u0029", - "name": "MouseOverBoxTruncation", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTruncation" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_timing\u0028\u0029", + "name": "mouseover_box_timing", + "summary": "Displays\u0020timing\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_timing" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxText\u0028\u0029", - "name": "MouseOverBoxText", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxText" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_truncation\u0028\u0029", + "name": "mouseover_box_truncation", + "summary": "Displays\u0020truncation\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_truncation" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxAppearance\u0028\u0029", - "name": "MouseOverBoxAppearance", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxAppearance" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_text\u0028\u0029", + "name": "mouseover_box_text", + "summary": "Displays\u0020dedicated\u0020tooltip\u0020text\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_text" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHyperlinkArrow\u0028\u0029", - "name": "HyperlinkArrow", - "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020prepended\u0020symbol", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_HyperlinkArrow" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Amouseover_box_appearance\u0028\u0029", + "name": "mouseover_box_appearance", + "summary": "Displays\u0020style\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_mouseover_box_appearance" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSS\u0028\u0029", - "name": "CustomCSS", - "summary": "Displays\u0020the\u0020custom\u0020css\u0020box.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSS" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Ahyperlink_arrow\u0028\u0029", + "name": "hyperlink_arrow", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_hyperlink_arrow" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSMigration\u0028\u0029", - "name": "CustomCSSMigration", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSMigration" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Acustom_css\u0028\u0029", + "name": "custom_css", + "summary": "Displays\u0020the\u0020Custom\u0020CSS\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_custom_css" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSNew\u0028\u0029", - "name": "CustomCSSNew", - "summary": "", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSNew" + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Acustom_css_migration\u0028\u0029", + "name": "custom_css_migration", + "summary": "Displays\u0020transitional\u0020legacy\u0020Custom\u0020CSS\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_custom_css_migration" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALookupHooks\u0028\u0029", - "name": "LookupHooks", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Acustom_css_new\u0028\u0029", + "name": "custom_css_new", + "summary": "Displays\u0020the\u0020new\u0020Custom\u0020CSS\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_custom_css_new" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Alookup_hooks\u0028\u0029", + "name": "lookup_hooks", "summary": "Displays\u0020available\u0020Hooks\u0020to\u0020look\u0020for\u0020Footnote\u0020short\u0020codes.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_LookupHooks" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_lookup_hooks" }, { "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHelp\u0028\u0029", "name": "Help", - "summary": "Displays\u0020a\u0020short\u0020introduction\u0020of\u0020the\u0020Plugin.", + "summary": "Displays\u0020a\u0020short\u0020introduction\u0020to\u0020the\u0020Plugin.", "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Help" }, { - "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ADonate\u0028\u0029", - "name": "Donate", + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003Adonate\u0028\u0029", + "name": "donate", "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", - "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Donate" + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_donate" }, { "fqsen": "\\MCI_Footnotes_Hooks", "name": "MCI_Footnotes_Hooks", "summary": "Registers\u0020all\u0020WordPress\u0020Hooks\u0020and\u0020executes\u0020them\u0020on\u0020demand.", "url": "classes/MCI-Footnotes-Hooks.html" }, { - "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AregisterHooks\u0028\u0029", - "name": "registerHooks", + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", "summary": "Registers\u0020all\u0020WordPress\u0020hooks.", - "url": "classes/MCI-Footnotes-Hooks.html#method_registerHooks" + "url": "classes/MCI-Footnotes-Hooks.html#method_register_hooks" }, { - "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AactivatePlugin\u0028\u0029", - "name": "activatePlugin", + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003Aactivate_plugin\u0028\u0029", + "name": "activate_plugin", "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020activated.", - "url": "classes/MCI-Footnotes-Hooks.html#method_activatePlugin" + "url": "classes/MCI-Footnotes-Hooks.html#method_activate_plugin" }, { - "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AdeactivatePlugin\u0028\u0029", - "name": "deactivatePlugin", + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003Adeactivate_plugin\u0028\u0029", + "name": "deactivate_plugin", "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020deactivated.", - "url": "classes/MCI-Footnotes-Hooks.html#method_deactivatePlugin" + "url": "classes/MCI-Footnotes-Hooks.html#method_deactivate_plugin" }, { - "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AuninstallPlugin\u0028\u0029", - "name": "uninstallPlugin", + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003Auninstall_plugin\u0028\u0029", + "name": "uninstall_plugin", "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020uninstalled.", - "url": "classes/MCI-Footnotes-Hooks.html#method_uninstallPlugin" + "url": "classes/MCI-Footnotes-Hooks.html#method_uninstall_plugin" }, { - "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003APluginLinks\u0028\u0029", - "name": "PluginLinks", + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003Aplugin_links\u0028\u0029", + "name": "plugin_links", "summary": "Add\u0020Links\u0020to\u0020the\u0020Plugin\u0020in\u0020the\u0020\u0022installed\u0020Plugins\u0022\u0020page.", - "url": "classes/MCI-Footnotes-Hooks.html#method_PluginLinks" + "url": "classes/MCI-Footnotes-Hooks.html#method_plugin_links" }, { "fqsen": "\\MCI_Footnotes", "name": "MCI_Footnotes", @@ -476,55 +446,65 @@ Search.appendIndex( "summary": "Executes\u0020the\u0020Plugin.", "url": "classes/MCI-Footnotes.html#method_run" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeWidgets\u0028\u0029", - "name": "initializeWidgets", + "fqsen": "\\MCI_Footnotes\u003A\u003Ainitialize_widgets\u0028\u0029", + "name": "initialize_widgets", "summary": "Initializes\u0020all\u0020Widgets\u0020of\u0020the\u0020Plugin.", - "url": "classes/MCI-Footnotes.html#method_initializeWidgets" + "url": "classes/MCI-Footnotes.html#method_initialize_widgets" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeDashboard\u0028\u0029", - "name": "initializeDashboard", + "fqsen": "\\MCI_Footnotes\u003A\u003Ainitialize_dashboard\u0028\u0029", + "name": "initialize_dashboard", "summary": "Initializes\u0020the\u0020Dashboard\u0020of\u0020the\u0020Plugin\u0020and\u0020loads\u0020them.", - "url": "classes/MCI-Footnotes.html#method_initializeDashboard" + "url": "classes/MCI-Footnotes.html#method_initialize_dashboard" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeTask\u0028\u0029", - "name": "initializeTask", + "fqsen": "\\MCI_Footnotes\u003A\u003Ainitialize_task\u0028\u0029", + "name": "initialize_task", "summary": "Initializes\u0020the\u0020Plugin\u0020Task\u0020and\u0020registers\u0020the\u0020Task\u0020hooks.", - "url": "classes/MCI-Footnotes.html#method_initializeTask" + "url": "classes/MCI-Footnotes.html#method_initialize_task" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003AregisterPublic\u0028\u0029", - "name": "registerPublic", + "fqsen": "\\MCI_Footnotes\u003A\u003Aregister_public\u0028\u0029", + "name": "register_public", "summary": "Registers\u0020and\u0020enqueues\u0020scripts\u0020and\u0020stylesheets\u0020to\u0020the\u0020public\u0020pages.", - "url": "classes/MCI-Footnotes.html#method_registerPublic" + "url": "classes/MCI-Footnotes.html#method_register_public" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_obj_Task", - "name": "a_obj_Task", + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_obj_task", + "name": "a_obj_task", "summary": "Reference\u0020to\u0020the\u0020Plugin\u0020Task\u0020object.", - "url": "classes/MCI-Footnotes.html#property_a_obj_Task" + "url": "classes/MCI-Footnotes.html#property_a_obj_task" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_TooltipsEnabled", - "name": "a_bool_TooltipsEnabled", - "summary": "Template\u0020process\u0020and\u0020script\u0020\/\u0020stylesheet\u0020load\u0020optimization.", - "url": "classes/MCI-Footnotes.html#property_a_bool_TooltipsEnabled" + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_tooltips_enabled", + "name": "a_bool_tooltips_enabled", + "summary": "Allows\u0020to\u0020determine\u0020whether\u0020tooltips\u0020are\u0020enabled.", + "url": "classes/MCI-Footnotes.html#property_a_bool_tooltips_enabled" }, { - "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", - "name": "a_bool_AlternativeTooltipsEnabled", - "summary": "", - "url": "classes/MCI-Footnotes.html#property_a_bool_AlternativeTooltipsEnabled" + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_alternative_tooltips_enabled", + "name": "a_bool_alternative_tooltips_enabled", + "summary": "Allows\u0020to\u0020determine\u0020whether\u0020alternative\u0020tooltips\u0020are\u0020enabled.", + "url": "classes/MCI-Footnotes.html#property_a_bool_alternative_tooltips_enabled" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_amp_enabled", + "name": "a_bool_amp_enabled", + "summary": "Allows\u0020to\u0020determine\u0020whether\u0020AMP\u0020compatibility\u0020mode\u0020is\u0020enabled.", + "url": "classes/MCI-Footnotes.html#property_a_bool_amp_enabled" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_str_script_mode", + "name": "a_str_script_mode", + "summary": "Allows\u0020to\u0020determine\u0020the\u0020script\u0020mode\u0020among\u0020jQuery\u0020or\u0020plain\u0020JS.", + "url": "classes/MCI-Footnotes.html#property_a_str_script_mode" }, { "fqsen": "\\MCI_Footnotes_Language", "name": "MCI_Footnotes_Language", "summary": "Loads\u0020text\u0020domain\u0020of\u0020current\u0020or\u0020default\u0020language\u0020for\u0020localization.", "url": "classes/MCI-Footnotes-Language.html" }, { - "fqsen": "\\MCI_Footnotes_Language\u003A\u003AregisterHooks\u0028\u0029", - "name": "registerHooks", + "fqsen": "\\MCI_Footnotes_Language\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", "summary": "Register\u0020WordPress\u0020Hook.", - "url": "classes/MCI-Footnotes-Language.html#method_registerHooks" + "url": "classes/MCI-Footnotes-Language.html#method_register_hooks" }, { - "fqsen": "\\MCI_Footnotes_Language\u003A\u003AloadTextDomain\u0028\u0029", - "name": "loadTextDomain", + "fqsen": "\\MCI_Footnotes_Language\u003A\u003Aload_text_domain\u0028\u0029", + "name": "load_text_domain", "summary": "Loads\u0020the\u0020text\u0020domain\u0020for\u0020current\u0020WordPress\u0020language\u0020if\u0020exists.", - "url": "classes/MCI-Footnotes-Language.html#method_loadTextDomain" + "url": "classes/MCI-Footnotes-Language.html#method_load_text_domain" }, { "fqsen": "\\MCI_Footnotes_Language\u003A\u003Aload\u0028\u0029", "name": "load", @@ -546,495 +526,495 @@ Search.appendIndex( "summary": "Returns\u0020a\u0020singleton\u0020of\u0020this\u0020class.", "url": "classes/MCI-Footnotes-Settings.html#method_instance" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetContainer\u0028\u0029", - "name": "getContainer", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aget_container\u0028\u0029", + "name": "get_container", "summary": "Returns\u0020the\u0020name\u0020of\u0020a\u0020specified\u0020Settings\u0020Container.", - "url": "classes/MCI-Footnotes-Settings.html#method_getContainer" + "url": "classes/MCI-Footnotes-Settings.html#method_get_container" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetDefaults\u0028\u0029", - "name": "getDefaults", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aget_defaults\u0028\u0029", + "name": "get_defaults", "summary": "Returns\u0020the\u0020default\u0020values\u0020of\u0020a\u0020specific\u0020Settings\u0020Container.", - "url": "classes/MCI-Footnotes-Settings.html#method_getDefaults" + "url": "classes/MCI-Footnotes-Settings.html#method_get_defaults" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AloadAll\u0028\u0029", - "name": "loadAll", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aload_all\u0028\u0029", + "name": "load_all", "summary": "Loads\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container.", - "url": "classes/MCI-Footnotes-Settings.html#method_loadAll" + "url": "classes/MCI-Footnotes-Settings.html#method_load_all" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ALoad\u0028\u0029", - "name": "Load", - "summary": "Loads\u0020all\u0020Settings\u0020from\u0020specified\u0020Settings\u0020Container.", - "url": "classes/MCI-Footnotes-Settings.html#method_Load" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aload\u0028\u0029", + "name": "load", + "summary": "Loads\u0020all\u0020settings\u0020from\u0020specified\u0020settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method_load" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AsaveOptions\u0028\u0029", - "name": "saveOptions", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Asave_options\u0028\u0029", + "name": "save_options", "summary": "Updates\u0020a\u0020whole\u0020Settings\u0020container.", - "url": "classes/MCI-Footnotes-Settings.html#method_saveOptions" + "url": "classes/MCI-Footnotes-Settings.html#method_save_options" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aget\u0028\u0029", "name": "get", "summary": "Returns\u0020the\u0020value\u0020of\u0020specified\u0020Settings\u0020name.", "url": "classes/MCI-Footnotes-Settings.html#method_get" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AClearAll\u0028\u0029", - "name": "ClearAll", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aclear_all\u0028\u0029", + "name": "clear_all", "summary": "Deletes\u0020each\u0020Settings\u0020Container\u0020and\u0020loads\u0020the\u0020default\u0020values\u0020for\u0020each\u0020Settings\u0020Container.", - "url": "classes/MCI-Footnotes-Settings.html#method_ClearAll" + "url": "classes/MCI-Footnotes-Settings.html#method_clear_all" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ARegisterSettings\u0028\u0029", - "name": "RegisterSettings", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aregister_settings\u0028\u0029", + "name": "register_settings", "summary": "Register\u0020all\u0020Settings\u0020Container\u0020for\u0020the\u0020Plugin\u0020Settings\u0020Page\u0020in\u0020the\u0020Dashboard.", - "url": "classes/MCI-Footnotes-Settings.html#method_RegisterSettings" + "url": "classes/MCI-Footnotes-Settings.html#method_register_settings" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_NAME", "name": "C_STR_REFERENCE_CONTAINER_NAME", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020reference\u0020container.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020reference\u0020container.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_NAME" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_COLLAPSE", - "name": "C_BOOL_REFERENCE_CONTAINER_COLLAPSE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020collapse\u0020the\u0020reference\u0020container\u0020by\u0020default.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_COLLAPSE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_COLLAPSE", + "name": "C_STR_REFERENCE_CONTAINER_COLLAPSE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020collapse\u0020the\u0020reference\u0020container\u0020by\u0020default.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_COLLAPSE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION", "name": "C_STR_REFERENCE_CONTAINER_POSITION", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020position\u0020of\u0020the\u0020reference\u0020container.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020position\u0020of\u0020the\u0020reference\u0020container.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_COMBINE_IDENTICAL_FOOTNOTES", - "name": "C_BOOL_COMBINE_IDENTICAL_FOOTNOTES", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020combining\u0020identical\u0020footnotes.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_COMBINE_IDENTICAL_FOOTNOTES" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_COMBINE_IDENTICAL_FOOTNOTES", + "name": "C_STR_COMBINE_IDENTICAL_FOOTNOTES", + "summary": "Settings\u0020container\u0020key\u0020for\u0020combining\u0020identical\u0020footnotes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_COMBINE_IDENTICAL_FOOTNOTES" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START", "name": "C_STR_FOOTNOTES_SHORT_CODE_START", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020start.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020start.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END", "name": "C_STR_FOOTNOTES_SHORT_CODE_END", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020end.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020end.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", "name": "C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020start.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020start.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", "name": "C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020end.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020end.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_COUNTER_STYLE", "name": "C_STR_FOOTNOTES_COUNTER_STYLE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020counter\u0020style\u0020of\u0020the\u0020footnotes.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020counter\u0020style\u0020of\u0020the\u0020footnotes.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_COUNTER_STYLE" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_LOVE", - "name": "C_STR_FOOTNOTES_LOVE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020\u0027I\u0020love\u0020footnotes\u0027\u0020text.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_LOVE" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_IN_EXCERPT", - "name": "C_BOOL_FOOTNOTES_IN_EXCERPT", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020look\u0020for\u0020footnotes\u0020in\u0020post\u0020excerpts.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_IN_EXCERPT" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_EXPERT_MODE", - "name": "C_BOOL_FOOTNOTES_EXPERT_MODE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Expert\u0020mode.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_EXPERT_MODE" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_BEFORE", - "name": "C_STR_FOOTNOTES_STYLING_BEFORE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020before\u0020the\u0020footnote\u0020referrer.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_BEFORE" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_AFTER", - "name": "C_STR_FOOTNOTES_STYLING_AFTER", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020after\u0020the\u0020footnote\u0020referrer.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_AFTER" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", - "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020mouse\u002Dover\u0020box.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", - "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020alternative\u0020tooltips.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", - "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020tooltip\u0020truncation.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020length\u0020of\u0020the\u0020enabled\u0020excerpt.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", - "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020position.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028x\u0029.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028y\u0029.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", - "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020color.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", - "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020background\u0020color.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020width.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", - "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020color.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020radius.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", - "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020width.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH" - }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", - "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020box\u002Dshadow\u0020color.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW", "name": "C_STR_HYPERLINK_ARROW", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020backlink\u0020symbol\u0020selection.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlink\u0020symbol\u0020selection.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW_USER_DEFINED", "name": "C_STR_HYPERLINK_ARROW_USER_DEFINED", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020backlink\u0020symbol.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020user\u002Ddefined\u0020backlink\u0020symbol.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_IN_EXCERPT", + "name": "C_STR_FOOTNOTES_IN_EXCERPT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020look\u0020for\u0020footnotes\u0020in\u0020post\u0020excerpts.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_IN_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_BEFORE", + "name": "C_STR_FOOTNOTES_STYLING_BEFORE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020string\u0020before\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_BEFORE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_AFTER", + "name": "C_STR_FOOTNOTES_STYLING_AFTER", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020string\u0020after\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_AFTER" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS", "name": "C_STR_CUSTOM_CSS", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020Custom\u0020CSS.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS_NEW", - "name": "C_STR_CUSTOM_CSS_NEW", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS\u0020migrated\u0020to\u0020a\u0020dedicated\u0020tab.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS_NEW" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_LOVE", + "name": "C_STR_FOOTNOTES_LOVE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020\u0027I\u0020love\u0020footnotes\u0027\u0020text.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_LOVE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_CUSTOM_CSS_LEGACY_ENABLE", - "name": "C_BOOL_CUSTOM_CSS_LEGACY_ENABLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020display\u0020of\u0020legacy\u0020Custom\u0020CSS\u0020metaboxes.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_CUSTOM_CSS_LEGACY_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_ENABLED" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_TITLE", - "name": "C_BOOL_EXPERT_LOOKUP_THE_TITLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_title\u0027\u0020hook.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_TITLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020tooltip\u0020truncation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_CONTENT", - "name": "C_BOOL_EXPERT_LOOKUP_THE_CONTENT", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_content\u0027\u0020hook.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_CONTENT" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020length\u0020of\u0020the\u0020enabled\u0020excerpt.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_EXCERPT", - "name": "C_BOOL_EXPERT_LOOKUP_THE_EXCERPT", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_excerpt\u0027\u0020hook.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_EXCERPT" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_EXPERT_LOOKUP_THE_TITLE", + "name": "C_STR_EXPERT_LOOKUP_THE_TITLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020\u0027the_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_EXPERT_LOOKUP_THE_TITLE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", - "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_title\u0027\u0020hook.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_EXPERT_LOOKUP_THE_CONTENT", + "name": "C_STR_EXPERT_LOOKUP_THE_CONTENT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020\u0027the_content\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_EXPERT_LOOKUP_THE_CONTENT" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", - "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_text\u0027\u0020hook.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_EXPERT_LOOKUP_THE_EXCERPT", + "name": "C_STR_EXPERT_LOOKUP_THE_EXCERPT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020\u0027the_excerpt\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_EXPERT_LOOKUP_THE_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_EXPERT_LOOKUP_WIDGET_TITLE", + "name": "C_STR_EXPERT_LOOKUP_WIDGET_TITLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020\u0027widget_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_EXPERT_LOOKUP_WIDGET_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_EXPERT_LOOKUP_WIDGET_TEXT", + "name": "C_STR_EXPERT_LOOKUP_WIDGET_TEXT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020\u0027widget_text\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_EXPERT_LOOKUP_WIDGET_TEXT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_EXPERT_MODE", + "name": "C_STR_FOOTNOTES_EXPERT_MODE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020Expert\u0020mode.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_EXPERT_MODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020background\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020radius.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020position.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028x\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028y\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020box\u002Dshadow\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_READON_LABEL", "name": "C_STR_FOOTNOTES_TOOLTIP_READON_LABEL", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020Read\u002Don\u0020button\u0020in\u0020truncated\u0020tooltips.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020Read\u002Don\u0020button\u0020in\u0020truncated\u0020tooltips.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_READON_LABEL" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", - "name": "C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020referrer\u0020element.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020alternative\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", - "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020display\u0020of\u0020a\u0020backlink\u0020symbol.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "name": "C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020referrer\u0020element.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", - "name": "C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020not\u0020display\u0020the\u0020reference\u0020container\u0020on\u0020the\u0020homepage.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "name": "C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020display\u0020of\u0020a\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", - "name": "C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020legacy\u0020layout\u0020of\u0020the\u0020reference\u0020container.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "name": "C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020not\u0020display\u0020the\u0020reference\u0020container\u0020on\u0020the\u0020homepage.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_START_PAGE_ENABLE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", - "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", - "summary": "Settings\u0020Container\u0020Key\u0020to\u0020get\u0020the\u0020backlink\u0020symbol\u0020switch\u0020side.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "name": "C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020legacy\u0020layout\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "name": "C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "summary": "Settings\u0020container\u0020key\u0020to\u0020get\u0020the\u0020backlink\u0020symbol\u0020switch\u0020side.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", "name": "C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027the_content\u0027\u0020hook\u0020priority\u0020level.", + "summary": "Settings\u0020container\u0020key\u0020for\u0020\u0027the_content\u0027\u0020hook\u0020priority\u0020level.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", "name": "C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027\u0027\u0020hook\u0020priority\u0020level", + "summary": "Settings\u0020container\u0020key\u0020for\u0020\u0027the_title\u0027\u0020hook\u0020priority\u0020level.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", "name": "C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020\u0027widget_title\u0027\u0020hook\u0020priority\u0020level.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", "name": "C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020\u0027widget_text\u0027\u0020hook\u0020priority\u0020level.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", "name": "C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020\u0027the_excerpt\u0027\u0020hook\u0020priority\u0020level.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_LINK_ELEMENT_ENABLED", - "name": "C_BOOL_LINK_ELEMENT_ENABLED", - "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020the\u0020link\u0020element\u0020option\nSettings\u0020Container\u0020Keys\u0020for\u0020backlink\u0020typography\u0020and\u0020layout\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020font\u0020size\nSettings\u0020Container\u0020Keys\u0020for\u0020page\u0020layout\u0020support\nSettings\u0020Container\u0020Keys\u0020for\u0020scroll\u0020offset\u0020and\u0020duration\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020display\u0020durations", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_LINK_ELEMENT_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_LINK_ELEMENT_ENABLED", + "name": "C_STR_LINK_ELEMENT_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020link\u0020element\u0020option.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_LINK_ELEMENT_ENABLED" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_SEPARATOR_ENABLED", - "name": "C_BOOL_BACKLINKS_SEPARATOR_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_SEPARATOR_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_ENABLED", + "name": "C_STR_BACKLINKS_SEPARATOR_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020presence\u0020of\u0020a\u0020backlink\u0020separator.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_OPTION", "name": "C_STR_BACKLINKS_SEPARATOR_OPTION", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlink\u0020separator\u0020options.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_OPTION" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_CUSTOM", "name": "C_STR_BACKLINKS_SEPARATOR_CUSTOM", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020a\u0020custom\u0020backlink\u0020separator.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_CUSTOM" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_TERMINATOR_ENABLED", - "name": "C_BOOL_BACKLINKS_TERMINATOR_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_TERMINATOR_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_ENABLED", + "name": "C_STR_BACKLINKS_TERMINATOR_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020presence\u0020of\u0020a\u0020backlink\u0020terminator.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_OPTION", "name": "C_STR_BACKLINKS_TERMINATOR_OPTION", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlink\u0020terminator\u0020options.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_OPTION" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_CUSTOM", "name": "C_STR_BACKLINKS_TERMINATOR_CUSTOM", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020a\u0020custom\u0020backlink\u0020terminator.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_CUSTOM" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", - "name": "C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_WIDTH_ENABLED", + "name": "C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020backlinks\u0020column\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_WIDTH_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", "name": "C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlinks\u0020column\u0020width\u0020scalar.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_WIDTH_UNIT", "name": "C_STR_BACKLINKS_COLUMN_WIDTH_UNIT", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlinks\u0020column\u0020width\u0020unit.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_WIDTH_UNIT" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", - "name": "C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "name": "C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020a\u0020max\u0020width\u0020for\u0020the\u0020backlinks\u0020column.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", "name": "C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlinks\u0020column\u0020max\u0020width\u0020scalar.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", "name": "C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020backlinks\u0020column\u0020max\u0020width\u0020unit.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", - "name": "C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_LINE_BREAKS_ENABLED", + "name": "C_STR_BACKLINKS_LINE_BREAKS_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020line\u0020breaks\u0020between\u0020backlinks.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_LINE_BREAKS_ENABLED" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", - "name": "C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "name": "C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020setting\u0020the\u0020tooltip\u0020font\u0020size.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_MOUSE_OVER_BOX_FONT_SIZE_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", "name": "C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020scalar\u0020value\u0020of\u0020the\u0020tooltip\u0020font\u0020size.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", "name": "C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020unit\u0020of\u0020the\u0020tooltip\u0020font\u0020size.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", "name": "C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020basic\u0020responsive\u0020page\u0020layout\u0020support\u0020options.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_OFFSET", "name": "C_INT_FOOTNOTES_SCROLL_OFFSET", - "summary": "Scroll\u0020offset\u0020and\u0020duration", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020offset.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_OFFSET" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_DURATION", "name": "C_INT_FOOTNOTES_SCROLL_DURATION", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020duration.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_DURATION" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020tooltip\u0020display\u0020fade\u002Din\u0020delay.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020tooltip\u0020display\u0020fade\u002Din\u0020duration.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020tooltip\u0020display\u0020fade\u002Dout\u0020delay.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020tooltip\u0020display\u0020fade\u002Dout\u0020duration.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_URL_WRAP_ENABLED", - "name": "C_BOOL_FOOTNOTE_URL_WRAP_ENABLED", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020URL\u0020wrap\u0020option", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_URL_WRAP_ENABLED" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_URL_WRAP_ENABLED", + "name": "C_STR_FOOTNOTE_URL_WRAP_ENABLED", + "summary": "Settings\u0020container\u0020key\u0020for\u0020URL\u0020wrap\u0020option.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_URL_WRAP_ENABLED" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", "name": "C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020reference\u0020container\u0020position\u0020shortcode", + "summary": "Settings\u0020container\u0020key\u0020for\u0020reference\u0020container\u0020position\u0020shortcode.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS_NEW", + "name": "C_STR_CUSTOM_CSS_NEW", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020Custom\u0020CSS\u0020migrated\u0020to\u0020a\u0020dedicated\u0020tab.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS_NEW" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS_LEGACY_ENABLE", + "name": "C_STR_CUSTOM_CSS_LEGACY_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020display\u0020of\u0020legacy\u0020Custom\u0020CSS\u0020metaboxes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS_LEGACY_ENABLE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", "name": "C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", - "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020alternative\u0020tooltip\u0020position\nSettings\u0020Container\u0020Keys\u0020for\u0020reference\u0020container\u0020label\u0020element,\u0020thanks\u0020to\u0020\u0040markhillyer", + "summary": "Settings\u0020container\u0020key\u0020for\u0020alternative\u0020tooltip\u0020position.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020alternative\u0020tooltip\u0020x\u0020offset.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020alternative\u0020tooltip\u0020y\u0020offset.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020alternative\u0020tooltip\u0020width.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", "name": "C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020reference\u0020container\u0020label\u0020element.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", - "name": "C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "name": "C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020the\u0020reference\u0020container\u0020label\u0020bottom\u0020border.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", - "name": "C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", - "summary": "Settings\u0020Container\u0020Key\u0020for\u0020table\u0020cell\u0020borders,\u0020thanks\u0020to\u0020\u0040noobishh", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "name": "C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020reference\u0020container\u0020table\u0020row\u0020borders.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_TOP_MARGIN", "name": "C_INT_REFERENCE_CONTAINER_TOP_MARGIN", - "summary": "Settings\u0020container\u0020keys\u0020for\u0020reference\u0020container\u0020top\u0020and\u0020bottom\u0020margins\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020enabling\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020anchors\u0020in\u0020referrers\u0020and\u0020footnotes", + "summary": "Settings\u0020container\u0020key\u0020for\u0020reference\u0020container\u0020top\u0020margin.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_TOP_MARGIN" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", "name": "C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020reference\u0020container\u0020bottom\u0020margin.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", - "name": "C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", - "summary": "", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_HARD_LINKS_ENABLE", + "name": "C_STR_FOOTNOTES_HARD_LINKS_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020hard\u0020links.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_HARD_LINKS_ENABLE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERRER_FRAGMENT_ID_SLUG", "name": "C_STR_REFERRER_FRAGMENT_ID_SLUG", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020fragment\u0020ID\u0020slug\u0020in\u0020referrers.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERRER_FRAGMENT_ID_SLUG" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_FRAGMENT_ID_SLUG", "name": "C_STR_FOOTNOTE_FRAGMENT_ID_SLUG", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020fragment\u0020ID\u0020slug\u0020in\u0020footnotes.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_FRAGMENT_ID_SLUG" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HARD_LINK_IDS_SEPARATOR", "name": "C_STR_HARD_LINK_IDS_SEPARATOR", - "summary": "", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020ID\u0020separator\u0020in\u0020fragment\u0020IDs.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HARD_LINK_IDS_SEPARATOR" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", - "name": "C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", - "summary": "Settings\u0020container\u0020key\u0020for\u0020shortcode\u0020syntax\u0020validation.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE" + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "name": "C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020shortcode\u0020syntax\u0020validation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", - "name": "C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "name": "C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020backlink\u0020tooltips.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE" + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", "name": "C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", @@ -1046,10 +1026,10 @@ Search.appendIndex( "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020tooltip\u0020excerpt\u0020delimiter.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", - "name": "C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020mirroring\u0020the\u0020tooltip\u0020excerpt\u0020in\u0020the\u0020reference\u0020container.", - "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE" + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE" }, { "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", @@ -1066,195 +1046,250 @@ Search.appendIndex( "summary": "Settings\u0020container\u0020key\u0020to\u0020select\u0020the\u0020script\u0020mode\u0020for\u0020the\u0020reference\u0020container.", "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_obj_Instance", - "name": "a_obj_Instance", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE", + "name": "C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020AMP\u0020compatibility\u0020mode.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_AMP_COMPATIBILITY_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY", + "name": "C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020duration\u0020asymmetricity.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SCROLL_DURATION_ASYMMETRICITY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_DOWN_DURATION", + "name": "C_INT_FOOTNOTES_SCROLL_DOWN_DURATION", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020down\u0020duration.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_DOWN_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_DOWN_DELAY", + "name": "C_INT_FOOTNOTES_SCROLL_DOWN_DELAY", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020down\u0020delay.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_DOWN_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_UP_DELAY", + "name": "C_INT_FOOTNOTES_SCROLL_UP_DELAY", + "summary": "Settings\u0020container\u0020key\u0020for\u0020scroll\u0020up\u0020delay.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_UP_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION", + "name": "C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION", + "summary": "Settings\u0020container\u0020key\u0020to\u0020set\u0020the\u0020solution\u0020of\u0020the\u0020input\u0020element\u0020label\u0020issue.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_LABEL_ISSUE_SOLUTION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING", + "name": "C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020CSS\u0020smooth\u0020scrolling.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_CSS_SMOOTH_SCROLLING" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_SECTION_SHORTCODE", + "name": "C_STR_FOOTNOTE_SECTION_SHORTCODE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020the\u0020footnote\u0020section\u0020shortcode.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_SECTION_SHORTCODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_obj_instance", + "name": "a_obj_instance", "summary": "Stores\u0020a\u0020singleton\u0020reference\u0020of\u0020this\u0020class.", - "url": "classes/MCI-Footnotes-Settings.html#property_a_obj_Instance" + "url": "classes/MCI-Footnotes-Settings.html#property_a_obj_instance" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Container", - "name": "a_arr_Container", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_container", + "name": "a_arr_container", "summary": "Contains\u0020all\u0020Settings\u0020Container\u0020names.", - "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Container" + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_container" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Default", - "name": "a_arr_Default", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_default", + "name": "a_arr_default", "summary": "Contains\u0020all\u0020Default\u0020Settings\u0020for\u0020each\u0020Settings\u0020Container.", - "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Default" + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_default" }, { - "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Settings", - "name": "a_arr_Settings", + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_settings", + "name": "a_arr_settings", "summary": "Contains\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container\u0020as\u0020soon\u0020as\u0020this\u0020class\u0020is\u0020initialized.", - "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Settings" + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_settings" }, { "fqsen": "\\MCI_Footnotes_Task", "name": "MCI_Footnotes_Task", - "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes.", + "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes\u0020and\u0020generates\u0020the\u0020reference\u0020container.", "url": "classes/MCI-Footnotes-Task.html" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003AregisterHooks\u0028\u0029", - "name": "registerHooks", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", "summary": "Register\u0020WordPress\u0020Hooks\u0020to\u0020replace\u0020Footnotes\u0020in\u0020the\u0020content\u0020of\u0020a\u0020public\u0020page.", - "url": "classes/MCI-Footnotes-Task.html#method_registerHooks" + "url": "classes/MCI-Footnotes-Task.html#method_register_hooks" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_head\u0028\u0029", - "name": "wp_head", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_output_head\u0028\u0029", + "name": "footnotes_output_head", "summary": "Outputs\u0020the\u0020custom\u0020css\u0020to\u0020the\u0020header\u0020of\u0020the\u0020public\u0020page.", - "url": "classes/MCI-Footnotes-Task.html#method_wp_head" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_output_head" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_footer\u0028\u0029", - "name": "wp_footer", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_output_footer\u0028\u0029", + "name": "footnotes_output_footer", "summary": "Displays\u0020the\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020slug\u0020if\u0020enabled.", - "url": "classes/MCI-Footnotes-Task.html#method_wp_footer" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_output_footer" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_title\u0028\u0029", - "name": "the_title", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_in_title\u0028\u0029", + "name": "footnotes_in_title", "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020post\/page\u0020title.", - "url": "classes/MCI-Footnotes-Task.html#method_the_title" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_in_title" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_content\u0028\u0029", - "name": "the_content", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_in_content\u0028\u0029", + "name": "footnotes_in_content", "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020page\/post.", - "url": "classes/MCI-Footnotes-Task.html#method_the_content" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_in_content" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_excerpt\u0028\u0029", - "name": "the_excerpt", - "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020excerpt\u0020of\u0020the\u0020current\u0020page\/post.", - "url": "classes/MCI-Footnotes-Task.html#method_the_excerpt" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_in_excerpt\u0028\u0029", + "name": "footnotes_in_excerpt", + "summary": "Processes\u0020existing\u0020excerpt\u0020or\u0020replaces\u0020it\u0020with\u0020a\u0020new\u0020one\u0020generated\u0020on\u0020the\u0020basis\u0020of\u0020the\u0020post.", + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_in_excerpt" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_title\u0028\u0029", - "name": "widget_title", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Agenerate_excerpt\u0028\u0029", + "name": "generate_excerpt", + "summary": "Generates\u0020excerpt\u0020on\u0020the\u0020basis\u0020of\u0020the\u0020post.", + "url": "classes/MCI-Footnotes-Task.html#method_generate_excerpt" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Agenerate_excerpt_with_footnotes\u0028\u0029", + "name": "generate_excerpt_with_footnotes", + "summary": "Generates\u0020excerpt\u0020with\u0020footnotes\u0020on\u0020the\u0020basis\u0020of\u0020the\u0020post.", + "url": "classes/MCI-Footnotes-Task.html#method_generate_excerpt_with_footnotes" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_in_widget_title\u0028\u0029", + "name": "footnotes_in_widget_title", "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020widget\u0020title.", - "url": "classes/MCI-Footnotes-Task.html#method_widget_title" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_in_widget_title" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_text\u0028\u0029", - "name": "widget_text", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Afootnotes_in_widget_text\u0028\u0029", + "name": "footnotes_in_widget_text", "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020widget.", - "url": "classes/MCI-Footnotes-Task.html#method_widget_text" - }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_post\u0028\u0029", - "name": "the_post", - "summary": "Replaces\u0020footnotes\u0020in\u0020each\u0020Content\u0020var\u0020of\u0020the\u0020current\u0020Post\u0020object.", - "url": "classes/MCI-Footnotes-Task.html#method_the_post" - }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003AreplacePostObject\u0028\u0029", - "name": "replacePostObject", - "summary": "Replace\u0020all\u0020Footnotes\u0020in\u0020a\u0020WP_Post\u0020object.", - "url": "classes/MCI-Footnotes-Task.html#method_replacePostObject" + "url": "classes/MCI-Footnotes-Task.html#method_footnotes_in_widget_text" }, { "fqsen": "\\MCI_Footnotes_Task\u003A\u003Aexec\u0028\u0029", "name": "exec", "summary": "Replaces\u0020all\u0020footnotes\u0020that\u0020occur\u0020in\u0020the\u0020given\u0020content.", "url": "classes/MCI-Footnotes-Task.html#method_exec" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Aunify_delimiters\u0028\u0029", + "name": "unify_delimiters", + "summary": "Brings\u0020the\u0020delimiters\u0020and\u0020unifies\u0020their\u0020various\u0020HTML\u0020escapement\u0020schemas.", + "url": "classes/MCI-Footnotes-Task.html#method_unify_delimiters" }, { "fqsen": "\\MCI_Footnotes_Task\u003A\u003Asearch\u0028\u0029", "name": "search", "summary": "Replaces\u0020all\u0020footnotes\u0020in\u0020the\u0020given\u0020content\u0020and\u0020appends\u0020them\u0020to\u0020the\u0020static\u0020property.", "url": "classes/MCI-Footnotes-Task.html#method_search" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003AReferenceContainer\u0028\u0029", - "name": "ReferenceContainer", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Areference_container\u0028\u0029", + "name": "reference_container", "summary": "Generates\u0020the\u0020reference\u0020container.", - "url": "classes/MCI-Footnotes-Task.html#method_ReferenceContainer" + "url": "classes/MCI-Footnotes-Task.html#method_reference_container" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_arr_Footnotes", - "name": "a_arr_Footnotes", - "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020on\u0020current\u0020public\u0020page.", - "url": "classes/MCI-Footnotes-Task.html#property_a_arr_Footnotes" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_arr_footnotes", + "name": "a_arr_footnotes", + "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020in\u0020the\u0020searched\u0020content.", + "url": "classes/MCI-Footnotes-Task.html#property_a_arr_footnotes" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AllowLoveMe", - "name": "a_bool_AllowLoveMe", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_allow_love_me", + "name": "a_bool_allow_love_me", "summary": "Flag\u0020if\u0020the\u0020display\u0020of\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020is\u0020allowed\u0020on\u0020the\u0020current\u0020public\u0020page.", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AllowLoveMe" + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_allow_love_me" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_Prefix", - "name": "a_str_Prefix", + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_prefix", + "name": "a_str_prefix", "summary": "Prefix\u0020for\u0020the\u0020Footnote\u0020html\u0020element\u0020ID.", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_Prefix" + "url": "classes/MCI-Footnotes-Task.html#property_a_str_prefix" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_PostId", - "name": "a_int_PostId", - "summary": "Infinite\u0020scroll\u0020\/\u0020autoload\u0020or\u0020archive\u0020view", - "url": "classes/MCI-Footnotes-Task.html#property_a_int_PostId" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_post_id", + "name": "a_int_post_id", + "summary": "Autoload\u0020a.k.a.\u0020infinite\u0020scroll,\u0020or\u0020archive\u0020view.", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_post_id" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ReferenceContainerId", - "name": "a_int_ReferenceContainerId", - "summary": "Multiple\u0020reference\u0020containers\u0020in\u0020content\u0020and\u0020widgets", - "url": "classes/MCI-Footnotes-Task.html#property_a_int_ReferenceContainerId" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_reference_container_id", + "name": "a_int_reference_container_id", + "summary": "Multiple\u0020reference\u0020containers\u0020in\u0020content\u0020and\u0020widgets.", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_reference_container_id" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_TooltipsEnabled", - "name": "a_bool_TooltipsEnabled", - "summary": "Template\u0020process\u0020optimization", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_TooltipsEnabled" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_hard_links_enabled", + "name": "a_bool_hard_links_enabled", + "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility.", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_hard_links_enabled" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", - "name": "a_bool_AlternativeTooltipsEnabled", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AlternativeTooltipsEnabled" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_referrer_link_slug", + "name": "a_str_referrer_link_slug", + "summary": "The\u0020referrer\u0020slug.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_referrer_link_slug" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_HardLinksEnable", - "name": "a_bool_HardLinksEnable", - "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_HardLinksEnable" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_footnote_link_slug", + "name": "a_str_footnote_link_slug", + "summary": "The\u0020footnote\u0020slug.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_footnote_link_slug" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_ReferrerLinkSlug", - "name": "a_str_ReferrerLinkSlug", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_ReferrerLinkSlug" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_link_ids_separator", + "name": "a_str_link_ids_separator", + "summary": "The\u0020slug\u0020and\u0020identifier\u0020separator.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_link_ids_separator" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_FootnoteLinkSlug", - "name": "a_str_FootnoteLinkSlug", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_FootnoteLinkSlug" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_post_container_id_compound", + "name": "a_str_post_container_id_compound", + "summary": "Contains\u0020the\u0020concatenated\u0020fragment\u0020ID\u0020base.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_post_container_id_compound" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkIdsSeparator", - "name": "a_str_LinkIdsSeparator", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkIdsSeparator" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_scroll_offset", + "name": "a_int_scroll_offset", + "summary": "Scroll\u0020offset.", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_scroll_offset" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_PostContainerIdCompound", - "name": "a_str_PostContainerIdCompound", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_PostContainerIdCompound" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_link_span", + "name": "a_str_link_span", + "summary": "The\u0020span\u0020element\u0020name.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_link_span" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ScrollOffset", - "name": "a_int_ScrollOffset", - "summary": "Scroll\u0020offset", - "url": "classes/MCI-Footnotes-Task.html#property_a_int_ScrollOffset" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_link_open_tag", + "name": "a_str_link_open_tag", + "summary": "The\u0020opening\u0020tag.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_link_open_tag" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkSpan", - "name": "a_str_LinkSpan", - "summary": "Optional\u0020link\u0020element\u0020for\u0020footnote\u0020referrers\u0020and\u0020backlinks", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkSpan" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_link_close_tag", + "name": "a_str_link_close_tag", + "summary": "The\u0020closing\u0020tag.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_link_close_tag" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkOpenTag", - "name": "a_str_LinkOpenTag", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkOpenTag" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_tooltip_shortcode", + "name": "a_str_tooltip_shortcode", + "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_tooltip_shortcode" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkCloseTag", - "name": "a_str_LinkCloseTag", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkCloseTag" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_tooltip_shortcode_length", + "name": "a_int_tooltip_shortcode_length", + "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode\u0020length.", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_tooltip_shortcode_length" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_MirrorTooltipText", - "name": "a_bool_MirrorTooltipText", - "summary": "Dedicated\u0020tooltip\u0020text", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_MirrorTooltipText" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_mirror_tooltip_text", + "name": "a_bool_mirror_tooltip_text", + "summary": "Whether\u0020to\u0020mirror\u0020the\u0020tooltip\u0020text\u0020in\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_mirror_tooltip_text" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_TooltipShortcode", - "name": "a_str_TooltipShortcode", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_str_TooltipShortcode" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_start_tag", + "name": "a_str_start_tag", + "summary": "Footnote\u0020delimiter\u0020start\u0020short\u0020code.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_start_tag" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_TooltipShortcodeLength", - "name": "a_int_TooltipShortcodeLength", - "summary": "", - "url": "classes/MCI-Footnotes-Task.html#property_a_int_TooltipShortcodeLength" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_end_tag", + "name": "a_str_end_tag", + "summary": "Footnote\u0020delimiter\u0020end\u0020short\u0020code.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_end_tag" }, { - "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_SyntaxErrorFlag", - "name": "a_bool_SyntaxErrorFlag", - "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation", - "url": "classes/MCI-Footnotes-Task.html#property_a_bool_SyntaxErrorFlag" + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_start_tag_regex", + "name": "a_str_start_tag_regex", + "summary": "Footnote\u0020delimiter\u0020start\u0020short\u0020code\u0020in\u0020regex\u0020format.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_start_tag_regex" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_end_tag_regex", + "name": "a_str_end_tag_regex", + "summary": "Footnote\u0020delimiter\u0020end\u0020short\u0020code\u0020in\u0020regex\u0020format.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_end_tag_regex" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_syntax_error_flag", + "name": "a_bool_syntax_error_flag", + "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation\u0020enabled.", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_syntax_error_flag" }, { "fqsen": "\\MCI_Footnotes_Template", "name": "MCI_Footnotes_Template", @@ -1276,19 +1311,19 @@ Search.appendIndex( "summary": "Reloads\u0020the\u0020original\u0020content\u0020of\u0020the\u0020template\u0020file.", "url": "classes/MCI-Footnotes-Template.html#method_reload" }, { - "fqsen": "\\MCI_Footnotes_Template\u003A\u003AgetContent\u0028\u0029", - "name": "getContent", + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aget_content\u0028\u0029", + "name": "get_content", "summary": "Returns\u0020the\u0020content\u0020of\u0020the\u0020template\u0020file\u0020with\u0020replaced\u0020placeholders.", - "url": "classes/MCI-Footnotes-Template.html#method_getContent" + "url": "classes/MCI-Footnotes-Template.html#method_get_content" }, { "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aprocess_template\u0028\u0029", "name": "process_template", - "summary": "Process\u0020template\u0020file", + "summary": "Process\u0020template\u0020file.", "url": "classes/MCI-Footnotes-Template.html#method_process_template" }, { "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aget_template\u0028\u0029", "name": "get_template", - "summary": "Get\u0020the\u0020template", + "summary": "Get\u0020the\u0020template.", "url": "classes/MCI-Footnotes-Template.html#method_get_template" }, { "fqsen": "\\MCI_Footnotes_Template\u003A\u003AC_STR_DASHBOARD", @@ -1301,115 +1336,110 @@ Search.appendIndex( "summary": "Directory\u0020name\u0020for\u0020public\u0020templates.", "url": "classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC" }, { - "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_OriginalContent", - "name": "a_str_OriginalContent", + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_original_content", + "name": "a_str_original_content", "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize.", - "url": "classes/MCI-Footnotes-Template.html#property_a_str_OriginalContent" + "url": "classes/MCI-Footnotes-Template.html#property_a_str_original_content" }, { - "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_ReplacedContent", - "name": "a_str_ReplacedContent", + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_replaced_content", + "name": "a_str_replaced_content", "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize\u0020with\u0020replaced\u0020place\u0020holders.", - "url": "classes/MCI-Footnotes-Template.html#property_a_str_ReplacedContent" + "url": "classes/MCI-Footnotes-Template.html#property_a_str_replaced_content" }, { "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024plugin_directory", "name": "plugin_directory", "summary": "Plugin\u0020Directory", "url": "classes/MCI-Footnotes-Template.html#property_plugin_directory" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase", - "name": "MCI_Footnotes_WidgetBase", + "fqsen": "\\MCI_Footnotes_Widget_Base", + "name": "MCI_Footnotes_Widget_Base", "summary": "Base\u0020Class\u0020for\u0020all\u0020Plugin\u0020Widgets.\u0020Registers\u0020each\u0020Widget\u0020to\u0020WordPress.", - "url": "classes/MCI-Footnotes-WidgetBase.html" + "url": "classes/MCI-Footnotes-Widget-Base.html" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetID\u0028\u0029", - "name": "getID", + "fqsen": "\\MCI_Footnotes_Widget_Base\u003A\u003Aget_id\u0028\u0029", + "name": "get_id", "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", - "url": "classes/MCI-Footnotes-WidgetBase.html#method_getID" + "url": "classes/MCI-Footnotes-Widget-Base.html#method_get_id" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetName\u0028\u0029", - "name": "getName", + "fqsen": "\\MCI_Footnotes_Widget_Base\u003A\u003Aget_name\u0028\u0029", + "name": "get_name", "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020child\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", - "url": "classes/MCI-Footnotes-WidgetBase.html#method_getName" + "url": "classes/MCI-Footnotes-Widget-Base.html#method_get_name" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetDescription\u0028\u0029", - "name": "getDescription", + "fqsen": "\\MCI_Footnotes_Widget_Base\u003A\u003Aget_description\u0028\u0029", + "name": "get_description", "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", - "url": "classes/MCI-Footnotes-WidgetBase.html#method_getDescription" + "url": "classes/MCI-Footnotes-Widget-Base.html#method_get_description" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetWidgetWidth\u0028\u0029", - "name": "getWidgetWidth", + "fqsen": "\\MCI_Footnotes_Widget_Base\u003A\u003Aget_widget_width\u0028\u0029", + "name": "get_widget_width", "summary": "Returns\u0020the\u0020width\u0020of\u0020the\u0020Widget.\u0020Default\u0020width\u0020is\u0020250\u0020pixel.", - "url": "classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth" + "url": "classes/MCI-Footnotes-Widget-Base.html#method_get_widget_width" }, { - "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003A__construct\u0028\u0029", + "fqsen": "\\MCI_Footnotes_Widget_Base\u003A\u003A__construct\u0028\u0029", "name": "__construct", "summary": "Class\u0020Constructor.\u0020Registers\u0020the\u0020child\u0020Widget\u0020to\u0020WordPress.", - "url": "classes/MCI-Footnotes-WidgetBase.html#method___construct" + "url": "classes/MCI-Footnotes-Widget-Base.html#method___construct" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer", - "name": "MCI_Footnotes_Widget_ReferenceContainer", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container", + "name": "MCI_Footnotes_Widget_Reference_Container", "summary": "Registers\u0020a\u0020Widget\u0020to\u0020put\u0020the\u0020Reference\u0020Container\u0020to\u0020the\u0020widget\u0020area.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetID\u0028\u0029", - "name": "getID", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container\u003A\u003Aget_id\u0028\u0029", + "name": "get_id", "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getID" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_id" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetName\u0028\u0029", - "name": "getName", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container\u003A\u003Aget_name\u0028\u0029", + "name": "get_name", "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020the\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getName" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_name" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetDescription\u0028\u0029", - "name": "getDescription", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container\u003A\u003Aget_description\u0028\u0029", + "name": "get_description", "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getDescription" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html#method_get_description" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Aform\u0028\u0029", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container\u003A\u003Aform\u0028\u0029", "name": "form", "summary": "Outputs\u0020the\u0020Settings\u0020of\u0020the\u0020Widget.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_form" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html#method_form" }, { - "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Awidget\u0028\u0029", + "fqsen": "\\MCI_Footnotes_Widget_Reference_Container\u003A\u003Awidget\u0028\u0029", "name": "widget", "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", - "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_widget" + "url": "classes/MCI-Footnotes-Widget-Reference-Container.html#method_widget" }, { "fqsen": "\\MCI_Footnotes_WYSIWYG", "name": "MCI_Footnotes_WYSIWYG", - "summary": "", + "summary": "Handles\u0020the\u0020WSYIWYG\u002DButtons.", "url": "classes/MCI-Footnotes-WYSIWYG.html" }, { - "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AregisterHooks\u0028\u0029", - "name": "registerHooks", - "summary": "", - "url": "classes/MCI-Footnotes-WYSIWYG.html#method_registerHooks" + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", + "summary": "Registers\u0020Button\u0020hooks.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_register_hooks" }, { - "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewVisualEditorButton\u0028\u0029", - "name": "newVisualEditorButton", + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", + "name": "new_visual_editor_button", "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", - "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newVisualEditorButton" + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_new_visual_editor_button" }, { - "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewPlainTextEditorButton\u0028\u0029", - "name": "newPlainTextEditorButton", + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003Anew_plain_text_editor_button\u0028\u0029", + "name": "new_plain_text_editor_button", "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", - "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newPlainTextEditorButton" + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_new_plain_text_editor_button" }, { - "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AincludeScripts\u0028\u0029", - "name": "includeScripts", + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003Ainclude_scripts\u0028\u0029", + "name": "include_scripts", "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", - "url": "classes/MCI-Footnotes-WYSIWYG.html#method_includeScripts" + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_include_scripts" }, { - "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AajaxCallback\u0028\u0029", - "name": "ajaxCallback", + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003Aajax_callback\u0028\u0029", + "name": "ajax_callback", "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", - "url": "classes/MCI-Footnotes-WYSIWYG.html#method_ajaxCallback" - }, { - "fqsen": "\\MCI_Footnotes_requirePhpFiles\u0028\u0029", - "name": "MCI_Footnotes_requirePhpFiles", - "summary": "Requires\u0020\u0028require_once\u0029\u0020all\u0020\u002A.php\u0020files\u0020inside\u0020a\u0020specific\u0020Directory.", - "url": "namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_ajax_callback" }, { "fqsen": "\\", "name": "\\", diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index c9f9b75..fa047c0 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -90,10 +90,8 @@
          Converts data types and Footnotes specific values.
          MCI_Footnotes_Layout_Init
          Handles the Settings interface of the Plugin.
          -
          MCI_Footnotes_LayoutEngine
          +
          MCI_Footnotes_Layout_Engine
          Layout Engine for the administration dashboard.
          -
          MCI_Footnotes_Layout_Diagnostics
          -
          Displays Diagnostics of the web server, PHP and WordPress.
          MCI_Footnotes_Layout_Settings
          Displays and handles all Settings of the Plugin.
          MCI_Footnotes_Hooks
          @@ -105,103 +103,23 @@
          MCI_Footnotes_Settings
          Loads the settings values, sets to default values if undefined.
          MCI_Footnotes_Task
          -
          Searches and replaces the footnotes.
          +
          Searches and replaces the footnotes and generates the reference container.
          MCI_Footnotes_Template
          Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
          -
          MCI_Footnotes_WidgetBase
          +
          MCI_Footnotes_Widget_Base
          Base Class for all Plugin Widgets. Registers each Widget to WordPress.
          -
          MCI_Footnotes_Widget_ReferenceContainer
          +
          MCI_Footnotes_Widget_Reference_Container
          Registers a Widget to put the Reference Container to the widget area.
          MCI_Footnotes_WYSIWYG
          -
          +
          Handles the WSYIWYG-Buttons.
        -

        - Table of Contents - -

        - -
        -
        - MCI_Footnotes_requirePhpFiles() - -  : mixed -
        -
        Requires (require_once) all *.php files inside a specific Directory.
        - -
        -
        -

        - Functions - -

        -
        -

        - MCI_Footnotes_requirePhpFiles() - -

        - - -

        Requires (require_once) all *.php files inside a specific Directory.

        - - - - MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed - -
        - -
        Parameters
        -
        -
        - $p_str_Directory - : string -
        -
        -

        Absolute Directory path to lookup for *.php files

        -
        - -
        -
        - - -
        - Tags - -
        -
        -
        - author -
        -
        - -

        Stefan Herndler

        -
        - -
        -
        - since -
        -
        - 1.5.0 - -
        - -
        -
        - - -
        -
        - +
        diff --git a/docs/packages/default.html b/docs/packages/default.html index 3d3e60c..7d8bcbd 100644 --- a/docs/packages/default.html +++ b/docs/packages/default.html @@ -81,7 +81,7 @@
        -
        Default
        +
        footnotes
        diff --git a/docs/files/class-dashboard-subpage-diagnostics.html b/docs/packages/footdnotes.html similarity index 84% rename from docs/files/class-dashboard-subpage-diagnostics.html rename to docs/packages/footdnotes.html index e6ed92b..7ad135b 100644 --- a/docs/files/class-dashboard-subpage-diagnostics.html +++ b/docs/packages/footdnotes.html @@ -51,9 +51,13 @@

        Namespaces

        -

        Global

        -
        +
        +
        +

        Packages

        +

        footnotes

        +

        footdnotes

        +

        Reports

        @@ -70,11 +74,10 @@
        -
        -

        subpage-diagnostics.php

        +
        - + diff --git a/docs/packages/Default.html b/docs/packages/footnotes.html similarity index 61% rename from docs/packages/Default.html rename to docs/packages/footnotes.html index d4680ea..2f0c434 100644 --- a/docs/packages/Default.html +++ b/docs/packages/footnotes.html @@ -73,7 +73,7 @@
        -

        Default

        +

        footnotes

        @@ -90,10 +90,8 @@
        Converts data types and Footnotes specific values.
        MCI_Footnotes_Layout_Init
        Handles the Settings interface of the Plugin.
        -
        MCI_Footnotes_LayoutEngine
        +
        MCI_Footnotes_Layout_Engine
        Layout Engine for the administration dashboard.
        -
        MCI_Footnotes_Layout_Diagnostics
        -
        Displays Diagnostics of the web server, PHP and WordPress.
        MCI_Footnotes_Layout_Settings
        Displays and handles all Settings of the Plugin.
        MCI_Footnotes_Hooks
        @@ -105,103 +103,23 @@
        MCI_Footnotes_Settings
        Loads the settings values, sets to default values if undefined.
        MCI_Footnotes_Task
        -
        Searches and replaces the footnotes.
        +
        Searches and replaces the footnotes and generates the reference container.
        MCI_Footnotes_Template
        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
        -
        MCI_Footnotes_WidgetBase
        +
        MCI_Footnotes_Widget_Base
        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
        -
        MCI_Footnotes_Widget_ReferenceContainer
        +
        MCI_Footnotes_Widget_Reference_Container
        Registers a Widget to put the Reference Container to the widget area.
        MCI_Footnotes_WYSIWYG
        -
        +
        Handles the WSYIWYG-Buttons.
        -

        - Table of Contents - -

        - -
        -
        - MCI_Footnotes_requirePhpFiles() - -  : mixed -
        -
        Requires (require_once) all *.php files inside a specific Directory.
        - -
        -
        -

        - Functions - -

        -
        -

        - MCI_Footnotes_requirePhpFiles() - -

        - - -

        Requires (require_once) all *.php files inside a specific Directory.

        - - - - MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed - -
        - -
        Parameters
        -
        -
        - $p_str_Directory - : string -
        -
        -

        Absolute Directory path to lookup for *.php files

        -
        - -
        -
        - - -
        - Tags - -
        -
        -
        - author -
        -
        - -

        Stefan Herndler

        -
        - -
        -
        - since -
        -
        - 1.5.0 - -
        - -
        -
        - - -
        -
        - +
        @@ -216,7 +134,7 @@
        - + diff --git a/docs/reports/errors.html b/docs/reports/errors.html index 340516e..a28a4bc 100644 --- a/docs/reports/errors.html +++ b/docs/reports/errors.html @@ -84,11 +84,11 @@ 1 - class/language.php + class/hooks.php 1 - class/settings.php + class/language.php 1 @@ -108,8 +108,25 @@ ERROR 0 - Tag "see" with body "@see templates/dashboard/customize-css.html - 2020-12-09T1113+0100" has error "\templates/dashboard/customize-css.html" is not a valid Fqsen. + Tag "see" with body "@see templates/dashboard/customize-css.html" has error "\templates/dashboard/customize-css.html" is not a valid Fqsen. + + + + +

        hooks.php

        + + + + + + + + + + + + +
        TypeLineDescription
        ERROR0Tag "see" with body "@see class/settings.php" has error "\class/settings.php" is not a valid Fqsen.
        @@ -131,24 +148,6 @@ - -

        settings.php

        - - - - - - - - - - - - - - - -
        TypeLineDescription
        ERROR0Tag "since" with body "@since ditched trimming whitespace from text box content in response to user request." has error
        diff --git a/docs/reports/markers.html b/docs/reports/markers.html index 67e0a4e..fffdf71 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -77,32 +77,10 @@

        Markers

        -

        Table of Contents

        - - - - - -
        class/settings.php1
        +
        + No markers have been found in this project. +
        - -

        settings.php

        - - - - - - - - - - - - - - - -
        TypeLineDescription
        TODO89Eventually change misleading variable names C_BOOL_… to C_STR_… (that’s how Hungarian screws things up).
        diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 0000000..7a2d501 --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,29 @@ + + + + docs + + + + + class + + docs + + + php + + Footnotes + true + + + + diff --git a/readme.txt b/readme.txt index 9ee130e..f8ad2e5 100644 --- a/readme.txt +++ b/readme.txt @@ -10,14 +10,13 @@ License URI: https://www.gnu.org/licenses/gpl-3.0.html == Description == -Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ -Cheers for the review, folks! - -https://www.youtube.com/watch?v=HzHaMAAJwbI - **footnotes** aims to be the all-in-one solution for displaying an automatically generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes are being displayed. **footnotes** gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts, as well as in post excerpts with fully functional tooltips if enabled. +Featured on wpmudev: http://premium.wpmudev.org/blog/12-surprisingly-useful-wordpress-plugins-you-dont-know-about/ Cheers for the review, folks! + +https://www.youtube.com/watch?v=HzHaMAAJwbI + = Main Features = - Fully customizable **footnote** start and end shortcodes; - Styled tooltips supporting hyperlinks display **footnotes** or a dedicated text;