From 748eda717b752d89e7372f724631448a93683935 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Tue, 27 Apr 2021 08:42:43 +0100 Subject: [PATCH] docs: update documentation --- docs/classes/Footnotes-Activator.html | 2 + docs/classes/Footnotes-Admin.html | 30 +- docs/classes/Footnotes-Config.html | 2 + docs/classes/Footnotes-Convert.html | 2 + docs/classes/Footnotes-Deactivator.html | 2 + docs/classes/Footnotes-Layout-Engine.html | 2 + docs/classes/Footnotes-Layout-Init.html | 141 +- docs/classes/Footnotes-Layout-Settings.html | 2 + docs/classes/Footnotes-Loader.html | 2 + docs/classes/Footnotes-Parser.html | 3288 +++++++++++++++++ docs/classes/Footnotes-Public.html | 88 +- docs/classes/Footnotes-Settings.html | 240 +- docs/classes/Footnotes-Template.html | 2 + docs/classes/Footnotes-WYSIWYG.html | 14 +- docs/classes/Footnotes-Widget-Base.html | 2 + .../Footnotes-Widget-Reference-Container.html | 14 +- docs/classes/Footnotes-i18n.html | 2 + docs/classes/Footnotes.html | 38 +- .../src-admin-class-footnotes-admin.html | 2 + .../src-admin-class-footnotes-wysiwyg.html | 2 + docs/files/src-admin-index.html | 2 + ...-layout-class-footnotes-layout-engine.html | 2 + ...in-layout-class-footnotes-layout-init.html | 3 + ...ayout-class-footnotes-layout-settings.html | 3 + docs/files/src-footnotes.html | 2 + ...rc-includes-class-footnotes-activator.html | 2 + .../src-includes-class-footnotes-config.html | 2 + .../src-includes-class-footnotes-convert.html | 2 + ...-includes-class-footnotes-deactivator.html | 2 + .../src-includes-class-footnotes-i18n.html | 2 + .../src-includes-class-footnotes-loader.html | 2 + ...src-includes-class-footnotes-settings.html | 3 + ...src-includes-class-footnotes-template.html | 3 + docs/files/src-includes-class-footnotes.html | 2 + docs/files/src-includes-index.html | 2 + docs/files/src-index.html | 2 + .../src-public-class-footnotes-parser.html | 133 + .../src-public-class-footnotes-public.html | 2 + docs/files/src-public-index.html | 2 + ...ic-widget-class-footnotes-widget-base.html | 3 + ...-footnotes-widget-reference-container.html | 3 + docs/files/src-uninstall.html | 2 + docs/graphs/classes.html | 2 + docs/index.html | 6 +- docs/indices/files.html | 8 +- docs/js/searchIndex.js | 396 +- docs/namespaces/default.html | 6 +- docs/packages/Default.html | 2 + docs/packages/default.html | 2 + docs/packages/footnotes-footnotesadmin.html | 2 + .../footnotes-footnotesadminlayout.html | 120 + .../packages/footnotes-footnotesincludes.html | 2 + docs/packages/footnotes-footnotespublic.html | 2 + .../footnotes-footnotespublicwidget.html | 120 + docs/packages/footnotes.html | 8 +- docs/reports/deprecated.html | 2 + docs/reports/errors.html | 2 + docs/reports/markers.html | 2 + 58 files changed, 4308 insertions(+), 432 deletions(-) create mode 100644 docs/classes/Footnotes-Parser.html create mode 100644 docs/files/src-public-class-footnotes-parser.html create mode 100644 docs/packages/footnotes-footnotesadminlayout.html create mode 100644 docs/packages/footnotes-footnotespublicwidget.html diff --git a/docs/classes/Footnotes-Activator.html b/docs/classes/Footnotes-Activator.html index 5dff791..ff00480 100644 --- a/docs/classes/Footnotes-Activator.html +++ b/docs/classes/Footnotes-Activator.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Admin.html b/docs/classes/Footnotes-Admin.html index 85b55d7..6a623c5 100644 --- a/docs/classes/Footnotes-Admin.html +++ b/docs/classes/Footnotes-Admin.html @@ -59,7 +59,9 @@

Default

@@ -175,7 +177,7 @@ and JavaScript.

Register the stylesheets for the admin area.
- get_plugin_links() + footnotes_action_links()  : array<string|int, string>
@@ -402,7 +404,7 @@ and JavaScript.

Register the JavaScript for the admin area.

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

Register the stylesheets for the admin area.

@@ -491,34 +493,34 @@ and JavaScript.

class="phpdocumentor-element -method -public - -static " + " > -

- get_plugin_links() - +

+ footnotes_action_links() +

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

public - static get_plugin_links(array<string|int, mixed> $plugin_links) : array<string|int, string> + footnotes_action_links(array<string|int, string> $links) : array<string|int, string>
Parameters
- $plugin_links - : array<string|int, mixed> + $links + : array<string|int, string>
-

The WP-default set of links to display.

+

The default set of links to display.

@@ -585,9 +587,9 @@ and JavaScript.

of this plugin:

diff --git a/docs/classes/Footnotes-Config.html b/docs/classes/Footnotes-Config.html index c96b051..389b7c4 100644 --- a/docs/classes/Footnotes-Config.html +++ b/docs/classes/Footnotes-Config.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Convert.html b/docs/classes/Footnotes-Convert.html index 70b4c6d..40a8827 100644 --- a/docs/classes/Footnotes-Convert.html +++ b/docs/classes/Footnotes-Convert.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Deactivator.html b/docs/classes/Footnotes-Deactivator.html index d25fc4e..5f6c533 100644 --- a/docs/classes/Footnotes-Deactivator.html +++ b/docs/classes/Footnotes-Deactivator.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Layout-Engine.html b/docs/classes/Footnotes-Layout-Engine.html index 0f717e2..1d5d9d1 100644 --- a/docs/classes/Footnotes-Layout-Engine.html +++ b/docs/classes/Footnotes-Layout-Engine.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Layout-Init.html b/docs/classes/Footnotes-Layout-Init.html index 75bcd0f..c9cf583 100644 --- a/docs/classes/Footnotes-Layout-Init.html +++ b/docs/classes/Footnotes-Layout-Init.html @@ -59,7 +59,9 @@

Default

@@ -100,7 +102,7 @@

Handles the Settings interface of the Plugin.

@@ -142,13 +144,6 @@
Slug for the Plugin main menu.
-
- C_STR_MAIN_MENU_TITLE - -  = 'ManFisher' -
-
Plugin main menu name.
-
$settings_page @@ -184,6 +179,13 @@
Registers the footnotes submenu page.
+
+ load_dependencies() + +  : mixed +
+
Load the required dependencies for this plugin.
+
@@ -203,7 +205,7 @@

Slug for the Plugin main menu.

@@ -235,48 +237,6 @@ - -
-

- C_STR_MAIN_MENU_TITLE - -

- - - -

Plugin main menu name.

- - - public - string - C_STR_MAIN_MENU_TITLE - = 'ManFisher' - - - -
- - -
- Tags - -
-
-
- since -
-
- 1.5.0 - -
- -
-
-
@@ -302,7 +262,7 @@

Contains the settings layoutEngine

@@ -353,7 +313,7 @@

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

@@ -402,7 +362,7 @@

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

@@ -451,7 +411,7 @@

Registers the settings and initialises the settings page.

@@ -500,7 +460,7 @@

Registers the footnotes submenu page.

@@ -544,6 +504,75 @@
+ +
+

+ load_dependencies() + +

+ + +

Load the required dependencies for this plugin.

+ + + private + load_dependencies() : mixed + +

Include the following files that make up the plugin:

+
    +
  • +Footnotes_Config. Defines constant plugin values.
    • +
  • +Footnotes_Settings. Defines configurable plugin settings.
    • +
  • +Footnotes_Layout_Settings. Defines the plugin settings page.
    • +
+

Create an instance of the loader which will be used to register the hooks +with WordPress.

+
+ + + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ access +
+
+ +

private

+
+ +
+
+ +
Return values
+ mixed + — +
+ +
diff --git a/docs/classes/Footnotes-Layout-Settings.html b/docs/classes/Footnotes-Layout-Settings.html index 67f34dc..1517d65 100644 --- a/docs/classes/Footnotes-Layout-Settings.html +++ b/docs/classes/Footnotes-Layout-Settings.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Loader.html b/docs/classes/Footnotes-Loader.html index 8b2c87a..296324e 100644 --- a/docs/classes/Footnotes-Loader.html +++ b/docs/classes/Footnotes-Loader.html @@ -59,7 +59,9 @@

Default

diff --git a/docs/classes/Footnotes-Parser.html b/docs/classes/Footnotes-Parser.html new file mode 100644 index 0000000..a840b42 --- /dev/null +++ b/docs/classes/Footnotes-Parser.html @@ -0,0 +1,3288 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
+

Documentation

+ + +
+ +
+ + +
+ +
+
+ + + + +
+ + +
+

+ Footnotes_Parser + + +
+ in package + +
+ + +

+ + + +

Searches and replaces the footnotes and generates the reference container.

+ +
+ + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ since +
+
+ 2.8.0 + +

Rename class from Footnotes_Task to Footnotes_Parser.

+
+ +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ $a_arr_footnotes + +  : array<string|int, mixed> +
+
Contains all footnotes found in the searched content.
+ +
+ $a_bool_allow_love_me + +  : bool +
+
Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.
+ +
+ $a_bool_hard_links_enabled + +  : bool +
+
Hard links for AMP compatibility.
+ +
+ $a_bool_mirror_tooltip_text + +  : bool +
+
Whether to mirror the tooltip text in the reference container.
+ +
+ $a_bool_syntax_error_flag + +  : bool +
+
Footnote delimiter syntax validation enabled.
+ +
+ $a_int_post_id + +  : int +
+
Autoload a.k.a. infinite scroll, or archive view.
+ +
+ $a_int_reference_container_id + +  : int +
+
Multiple reference containers in content and widgets.
+ +
+ $a_int_scroll_offset + +  : int +
+
Scroll offset.
+ +
+ $a_int_tooltip_shortcode_length + +  : int +
+
The tooltip delimiter shortcode length.
+ +
+ $a_str_end_tag + +  : str +
+
Footnote delimiter end short code.
+ +
+ $a_str_end_tag_regex + +  : str +
+
Footnote delimiter end short code in regex format.
+ +
+ $a_str_footnote_link_slug + +  : str +
+
The footnote slug.
+ +
+ $a_str_link_close_tag + +  : str +
+
The closing tag.
+ +
+ $a_str_link_open_tag + +  : str +
+
The opening tag.
+ +
+ $a_str_link_span + +  : str +
+
The span element name.
+ +
+ $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_referrer_link_slug + +  : str +
+
The referrer slug.
+ +
+ $a_str_start_tag + +  : 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.
+ +
+ __construct() + +  : mixed +
+
Initialize the class and set its properties.
+ +
+ exec() + +  : string +
+
Replaces all footnotes that occur in the given content.
+ +
+ 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.
+ +
+ register_hooks() + +  : mixed +
+
Register WordPress hooks to replace Footnotes in the content of a public page.
+ +
+ search() + +  : string +
+
Replaces all footnotes in the given content and appends them to the static property.
+ +
+ unify_delimiters() + +  : mixed +
+
Brings the delimiters and unifies their various HTML escapement schemas.
+ +
+ + + + + + +
+

+ Properties + +

+
+

+ $a_arr_footnotes + + + +

+ + +

Contains all footnotes found in the searched content.

+ + + public + static array<string|int, mixed> + $a_arr_footnotes + = array() + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ $a_bool_allow_love_me + + + +

+ + +

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

+ + + public + static bool + $a_bool_allow_love_me + = rue + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ $a_bool_hard_links_enabled + + + +

+ + +

Hard links for AMP compatibility.

+ + + public + static bool + $a_bool_hard_links_enabled + = alse + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.0.0 + +

Bugfix: footnote links script independent.

+
    +
  • Bugfix: Referrers and backlinks: remove hard links to streamline browsing history, thanks to @theroninjedi47 bug report.
    • +
+
+ +
+
+ since +
+
+ 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.
    • +
+
+ +
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ reporter +
+
+ +

@theroninjedi47

+
+ +
+
+ reporter +
+
+ +

@psykonevro

+
+ +
+
+ link +
+
+ https://wordpress.org/support/topic/hyperlinked-footnotes-creating-excessive-back-history/ + +
+
+ link +
+
+ https://wordpress.org/support/topic/making-it-amp-compatible/ + +
+
+ link +
+
+ https://wordpress.org/support/topic/footnotes-is-not-amp-compatible/ + +
+
+ contributor +
+
+ +

@martinneumannat

+
+ +
+
+ +
+
+

+ $a_bool_mirror_tooltip_text + + + +

+ + +

Whether to mirror the tooltip text in the reference container.

+ + + public + static bool + $a_bool_mirror_tooltip_text + = alse + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.5.2 + +
+ +
+
+ +
+
+

+ $a_bool_syntax_error_flag + + + +

+ + +

Footnote delimiter syntax validation enabled.

+ + + public + static bool + $a_bool_syntax_error_flag + = rue + +
    +
  • Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.
    • +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.4.0 + +
+ +
+
+ +
+
+

+ $a_int_post_id + + + +

+ + +

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

+ + + public + static int + $a_int_post_id + = 0 + +
    +
  • Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness issue report and code contribution
    • +
+
+ + +
+ Tags + +
+
+
+ reporter +
+
+ +

@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 +
+
+ +

@docteurfitness

+
+ +
+
+ since +
+
+ 2.0.6 + +
+ +
+
+ +
+
+

+ $a_int_reference_container_id + + + +

+ + +

Multiple reference containers in content and widgets.

+ + + public + static int + $a_int_reference_container_id + = 1 + +
    +
  • Bugfix: Reference container, widget_text hook: support for multiple containers in a page, thanks to @justbecuz bug report.
    • +
+
+ + +
+ Tags + +
+
+
+ reporter +
+
+ +

@justbecuz

+
+ +
+
+ link +
+
+ https://wordpress.org/support/topic/reset-footnotes-to-1/ + +
+
+ link +
+
+ https://wordpress.org/support/topic/reset-footnotes-to-1/#post-13662830 + +
+
+ since +
+
+ 2.2.9 + +
+ +
+
+ +
+
+

+ $a_int_scroll_offset + + + +

+ + +

Scroll offset.

+ + + public + static int + $a_int_scroll_offset + = 34 + +
    +
  • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
    • +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.1.4 + +
    +
  • Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report.
    • +
+
+ +
+
+ since +
+
+ 2.4.0 + +
+ +
+
+ reporter +
+
+ +

@lukashuggenberg

+
+ +
+
+ link +
+
+ https://wordpress.org/support/topic/2-2-6-breaks-all-footnotes/#post-13857922 + +
+
+ +
+
+

+ $a_int_tooltip_shortcode_length + + + +

+ + +

The tooltip delimiter shortcode length.

+ + + public + static int + $a_int_tooltip_shortcode_length + = 12 + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.5.2 + +
+ +
+
+ +
+
+

+ $a_str_end_tag + + + +

+ + +

Footnote delimiter end short code.

+ + + public + 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 + +
+ +
+
+ +
+
+

+ $a_str_link_close_tag + + + +

+ + +

The closing tag.

+ + + public + static str + $a_str_link_close_tag + = '' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ +
+
+

+ $a_str_link_open_tag + + + +

+ + +

The opening tag.

+ + + public + static str + $a_str_link_open_tag + = '' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ +
+
+

+ $a_str_link_span + + + +

+ + +

The span element name.

+ + + public + static str + $a_str_link_span + = 'span' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ +
+
+

+ $a_str_post_container_id_compound + + + +

+ + +

Contains the concatenated fragment ID base.

+ + + public + static str + $a_str_post_container_id_compound + = '' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ +
+
+

+ $a_str_prefix + + + +

+ + +

Prefix for the Footnote html element ID.

+ + + public + static string + $a_str_prefix + = '' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 1.5.8 + +
+ +
+
+ +
+
+

+ $a_str_referrer_link_slug + + + +

+ + +

The referrer slug.

+ + + public + static str + $a_str_referrer_link_slug + = 'r' + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.3.0 + +
+ +
+
+ +
+
+

+ $a_str_start_tag + + + +

+ + +

Footnote delimiter start short code.

+ + + public + 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 + +
+ +
+
+ +
+
+ +
+

+ Methods + +

+
+

+ __construct() + +

+ + +

Initialize the class and set its properties.

+ + + public + __construct() : mixed + +
+ + + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ +
Return values
+ mixed + — +
+ + +
+
+

+ exec() + +

+ + +

Replaces all footnotes that occur in the given content.

+ + + public + exec(string $p_str_content[, bool $p_bool_output_references = false ][, bool $p_bool_hide_footnotes_text = false ]) : string + +
+ +
Parameters
+
+
+ $p_str_content + : string +
+
+

Any string that may contain footnotes to be replaced.

+
+ +
+
+ $p_bool_output_references + : bool + = false
+
+

Appends the Reference Container to the output if set to true, default true.

+
+ +
+
+ $p_bool_hide_footnotes_text + : bool + = false
+
+

Hide footnotes found in the string.

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

+ footnotes_in_content() + +

+ + +

Replaces footnotes in the content of the current page/post.

+ + + public + footnotes_in_content(string $p_str_content) : string + +
+ +
Parameters
+
+
+ $p_str_content + : string +
+
+

Page/Post content.

+
+ +
+
+ + +
+ Tags + +
+
+
+ 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 + — +

$p_str_content Content with replaced footnotes.

+
+ + +
+
+

+ footnotes_in_excerpt() + +

+ + +

Processes existing excerpt or replaces it with a new one generated on the basis of the post.

+ + + public + footnotes_in_excerpt(string $p_str_excerpt) : string + +
+ +
Parameters
+
+
+ $p_str_excerpt + : string +
+
+

Excerpt content.

+
+ +
+
+ + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ 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 + — +

$p_str_excerpt Processed or new excerpt.

+
+ + +
+
+

+ footnotes_in_title() + +

+ + +

Replaces footnotes in the post/page title.

+ + + public + footnotes_in_title(string $p_str_content) : string + +
+ +
Parameters
+
+
+ $p_str_content + : string +
+
+

Title.

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

$p_str_content Title with replaced footnotes.

+
+ + +
+
+

+ footnotes_in_widget_text() + +

+ + +

Replaces footnotes in the content of the current widget.

+ + + public + footnotes_in_widget_text(string $p_str_content) : string + +
+ +
Parameters
+
+
+ $p_str_content + : string +
+
+

Widget content.

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

$p_str_content Content with replaced footnotes.

+
+ + +
+
+

+ footnotes_in_widget_title() + +

+ + +

Replaces footnotes in the widget title.

+ + + public + footnotes_in_widget_title(string $p_str_content) : string + +
+ +
Parameters
+
+
+ $p_str_content + : string +
+
+

Widget content.

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

$p_str_content Content with replaced footnotes.

+
+ + +
+
+

+ footnotes_output_footer() + +

+ + +

Displays the 'LOVE FOOTNOTES' slug if enabled.

+ + + public + footnotes_output_footer() : mixed + +
+ + + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ since +
+
+ 2.2.0 + +

More options.

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

+ footnotes_output_head() + +

+ + +

Outputs the custom css to the header of the public page.

+ + + public + footnotes_output_head() : mixed + +
+ + + +
+ Tags + +
+
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ since +
+
+ 2.1.1 + +

Bugfix: Reference container: fix start pages by making its display optional, thanks to @dragon013 bug report.

+
+ +
+
+ since +
+
+ 2.1.1 + +

Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.

+
+ +
+
+ since +
+
+ 2.1.3 + +

raise settings priority to override theme stylesheets

+
+ +
+
+ since +
+
+ 2.1.4 + +

Bugfix: Tooltips: Styling: fix font size issue by adding font size to settings with legacy as default.

+
+ +
+
+ since +
+
+ 2.1.4 + +

Bugfix: Reference container: fix layout issues by moving backlink column width to settings.

+
+ +
+
+ since +
+
+ 2.2.5 + +

Bugfix: Reference container: Label: make bottom border an option, thanks to @markhillyer issue report.

+
+ +
+
+ since +
+
+ 2.2.5 + +

Bugfix: Reference container: Label: option to select paragraph or heading element, thanks to @markhillyer issue report.

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

Bugfix: Reference container: convert top padding to margin and make it a setting, thanks to @hamshe bug report.

+
+ +
+
+ since +
+
+ 2.5.4 + +

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.

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

+ generate_excerpt() + +

+ + +

Generates excerpt on the basis of the 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_str_content + : string +
+
+

The post.

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

@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 +
+
+ 2.6.2 + +
+ +
+
+ +
Return values
+ 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 + — +
+ + +
+
+ +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + diff --git a/docs/classes/Footnotes-Public.html b/docs/classes/Footnotes-Public.html index 3927580..1800669 100644 --- a/docs/classes/Footnotes-Public.html +++ b/docs/classes/Footnotes-Public.html @@ -59,7 +59,9 @@

    Default

    @@ -278,7 +280,7 @@ and JavaScript.

    2.8.0 -

    Moved to Footnotes_Public class.

    +

    Moved from Footnotes to Footnotes_Public class.

    @@ -336,7 +338,7 @@ and JavaScript.

    2.8.0 -

    Moved to Footnotes_Public class.

    +

    Moved from Footnotes to Footnotes_Public class.

    @@ -393,7 +395,7 @@ and JavaScript.

    2.8.0 -

    Moved to Footnotes_Public class.

    +

    Moved from Footnotes to Footnotes_Public class.

    @@ -451,7 +453,7 @@ ull
    2.8.0 -

    Moved to Footnotes_Public class.

    +

    Moved from Footnotes to Footnotes_Public class.

    @@ -508,7 +510,7 @@ ull
    2.8.0 -

    Moved to Footnotes_Public class.

    +

    Moved from Footnotes to Footnotes_Public class.

    @@ -717,7 +719,7 @@ ull

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

    @@ -739,10 +741,50 @@ ull since
    - 2.8.0 + 1.5.0
    +
    +
    + since +
    +
    + 2.0.0 + +

    Add jQueryUI dependency.

    +
    + +
    +
    + since +
    +
    + 2.1.2 + +

    Add jQuery Tools dependency.

    +
    + +
    +
    + since +
    +
    + 2.5.6 + +

    Add jQuery dependency.

    +
    + +
    +
    + since +
    +
    + 2.8.0 + +

    Moved from Footnotes to Footnotes_Public class.

    +
    +
    @@ -766,7 +808,7 @@ ull

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

    @@ -775,7 +817,9 @@ ull public enqueue_styles() : mixed -
    +

    Enables enqueuing the formatted individual stylesheets if PRODCUTION_ENV +is true (set in footnotes.php).

    +
    @@ -788,10 +832,30 @@ ull since
    - 2.8.0 + 1.5.0
    +
    +
    + since +
    +
    + 2.5.5 + +

    Change stylesheet scheme.

    +
    + +
    +
    + since +
    +
    + 2.8.0 + +

    Moved from Footnotes to Footnotes_Public class.

    +
    +
    @@ -828,9 +892,9 @@ ull of this plugin:

    diff --git a/docs/classes/Footnotes-Settings.html b/docs/classes/Footnotes-Settings.html index 86bf800..bb6ecab 100644 --- a/docs/classes/Footnotes-Settings.html +++ b/docs/classes/Footnotes-Settings.html @@ -59,7 +59,9 @@

    Default

    @@ -100,7 +102,7 @@

    Loads the settings values, sets to default values if undefined.

    @@ -980,7 +982,7 @@

    Settings container key for the scalar value of the tooltip font size.

    @@ -1022,7 +1024,7 @@

    Settings container key for the backlinks column max width scalar.

    @@ -1064,7 +1066,7 @@

    Settings container key for the backlinks column width scalar.

    @@ -1106,7 +1108,7 @@

    Settings container key for 'the_content' hook priority level.

    @@ -1280,7 +1282,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for 'the_excerpt' hook priority level.

    @@ -1322,7 +1324,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for 'the_title' hook priority level.

    @@ -1383,7 +1385,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for 'widget_text' hook priority level.

    @@ -1425,7 +1427,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for 'widget_title' hook priority level.

    @@ -1467,7 +1469,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for alternative tooltip x offset.

    @@ -1509,7 +1511,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for alternative tooltip y offset.

    @@ -1551,7 +1553,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for alternative tooltip width.

    @@ -1593,7 +1595,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

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

    @@ -1645,7 +1647,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

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

    @@ -1687,7 +1689,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

    Settings container key for the mouse-over box to define the max. length of the enabled excerpt.

    @@ -1739,7 +1741,7 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

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

    @@ -1792,7 +1794,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the mouse-over box to define the offset (x).

    @@ -1834,7 +1836,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the mouse-over box to define the offset (y).

    @@ -1876,7 +1878,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for scroll down delay.

    @@ -1918,7 +1920,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for scroll down duration.

    @@ -1960,7 +1962,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for scroll duration.

    @@ -2005,7 +2007,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for scroll offset.

    @@ -2050,7 +2052,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for scroll up delay.

    @@ -2092,7 +2094,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for tooltip display fade-in delay.

    @@ -2134,7 +2136,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for tooltip display fade-in duration.

    @@ -2176,7 +2178,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for tooltip display fade-out delay.

    @@ -2218,7 +2220,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for tooltip display fade-out duration.

    @@ -2260,7 +2262,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for reference container bottom margin.

    @@ -2321,7 +2323,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for reference container top margin.

    @@ -2382,7 +2384,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable a max width for the backlinks column.

    @@ -2424,7 +2426,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the backlinks column max width unit.

    @@ -2466,7 +2468,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable the backlinks column width.

    @@ -2508,7 +2510,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the backlinks column width unit.

    @@ -2550,7 +2552,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable line breaks between backlinks.

    @@ -2592,7 +2594,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for a custom backlink separator.

    @@ -2634,7 +2636,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable the presence of a backlink separator.

    @@ -2695,7 +2697,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the backlink separator options.

    @@ -2737,7 +2739,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for a custom backlink terminator.

    @@ -2779,7 +2781,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable the presence of a backlink terminator.

    @@ -2821,7 +2823,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the backlink terminator options.

    @@ -2863,7 +2865,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for combining identical footnotes.

    @@ -2905,7 +2907,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key for the Custom CSS.

    @@ -2957,7 +2959,7 @@ The width should be limited to start with, for the box to have shape.

    Settings container key to enable display of legacy Custom CSS metaboxes.

    @@ -3010,7 +3012,7 @@ because when saving, all missing constants are emptied, and to_bool() converts e

    Settings container key for the Custom CSS migrated to a dedicated tab.

    @@ -3055,7 +3057,7 @@ because when saving, all missing constants are emptied, and to_bool() converts e

    Settings container key to enable the 'the_content' hook.

    @@ -3097,7 +3099,7 @@ because when saving, all missing constants are emptied, and to_bool() converts e

    Settings container key to enable the 'the_excerpt' hook.

    @@ -3235,7 +3237,7 @@ because when saving, all missing constants are emptied, and to_bool() converts e

    Settings container key to enable the 'the_title' hook.

    @@ -3287,7 +3289,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key to enable the 'widget_text' hook.

    @@ -3329,7 +3331,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key to enable the 'widget_title' hook.

    @@ -3371,7 +3373,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key for the fragment ID slug in footnotes.

    @@ -3413,7 +3415,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key to enable superscript style normalization.

    @@ -3472,7 +3474,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key for the footnote section shortcode.

    @@ -3533,7 +3535,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key to enable shortcode syntax validation.

    @@ -3575,7 +3577,7 @@ Footnotes doesn’t delete footnotes therein.

    Settings container key for URL wrap option.

    @@ -3619,7 +3621,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key for alternative tooltip position.

    @@ -3661,7 +3663,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key to enable AMP compatibility mode.

    @@ -3765,7 +3767,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key to enable backlink tooltips.

    @@ -3833,7 +3835,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key to configure the backlink tooltip.

    @@ -3894,7 +3896,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key for the counter style of the footnotes.

    @@ -3936,7 +3938,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key to enable CSS smooth scrolling.

    @@ -4013,7 +4015,7 @@ Unicode-compliant browsers break URLs at slashes.

    Settings container key for the Expert mode.

    @@ -4067,7 +4069,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 976 + 977

    Settings container key to enable hard links.

    @@ -4144,7 +4146,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 138 + 139

    Settings container key to look for footnotes in post excerpts.

    @@ -4243,7 +4245,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 1174 + 1175

    Settings container key to set the solution of the input element label issue.

    @@ -4292,7 +4294,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 179 + 180

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

    @@ -4334,7 +4336,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 445 + 446

    Settings container key to enable the alternative tooltips.

    @@ -4395,7 +4397,7 @@ All users, not experts only, need to be able to control relative positioning.

    class-footnotes-settings.php : - 338 + 339

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

    @@ -4525,7 +4527,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -4567,7 +4569,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -4646,7 +4648,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key to enable the mouse-over box.

    @@ -4688,7 +4690,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key to enable tooltip truncation.

    @@ -4730,7 +4732,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -4772,7 +4774,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -4814,7 +4816,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key for basic responsive page layout support options.

    @@ -4856,7 +4858,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -4917,7 +4919,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key for the referrer element.

    @@ -4978,7 +4980,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key for scroll duration asymmetricity.

    @@ -5020,7 +5022,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -5062,7 +5064,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -5104,7 +5106,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -5146,7 +5148,7 @@ But theme default background color doesn’t seem to exist.

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

    @@ -5188,7 +5190,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key for the string after the footnote referrer.

    @@ -5230,7 +5232,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key for the string before the footnote referrer.

    @@ -5272,7 +5274,7 @@ But theme default background color doesn’t seem to exist.

    Settings container key to configure the tooltip excerpt delimiter.

    @@ -5335,7 +5337,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5392,7 +5394,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5434,7 +5436,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5495,7 +5497,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the ID separator in fragment IDs.

    @@ -5537,7 +5539,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the backlink symbol selection.

    @@ -5607,7 +5609,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the user-defined backlink symbol.

    @@ -5649,7 +5651,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the link element option.

    @@ -5710,7 +5712,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key to enable setting the tooltip font size.

    @@ -5752,7 +5754,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5794,7 +5796,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5839,7 +5841,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -5900,7 +5902,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key to get the backlink symbol switch side.

    @@ -5961,7 +5963,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key to collapse the reference container by default.

    @@ -6012,7 +6014,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -6073,7 +6075,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the reference container label element.

    @@ -6134,7 +6136,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the label of the reference container.

    @@ -6176,7 +6178,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the position of the reference container.

    @@ -6218,7 +6220,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for reference container position shortcode.

    @@ -6279,7 +6281,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key to enable reference container table row borders.

    @@ -6340,7 +6342,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -6401,7 +6403,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Settings container key for the fragment ID slug in referrers.

    @@ -6458,7 +6460,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Contains all Settings Container names.

    @@ -6505,7 +6507,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Contains all Default Settings for each Settings Container.

    @@ -6691,7 +6693,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

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

    @@ -6738,7 +6740,7 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

    Stores a singleton reference of this class.

    @@ -6790,7 +6792,7 @@ ull

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

    @@ -6852,7 +6854,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns the value of specified Settings name.

    @@ -6914,7 +6916,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns the name of a specified Settings Container.

    @@ -6976,7 +6978,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns the default values of a specific Settings Container.

    @@ -7037,7 +7039,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Returns a singleton of this class.

    @@ -7086,7 +7088,7 @@ done by deleting and reinstalling (see the warning about database backup).

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

    @@ -7136,7 +7138,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Updates a whole Settings container.

    @@ -7206,7 +7208,7 @@ done by deleting and reinstalling (see the warning about database backup).

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

    @@ -7255,7 +7257,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Loads all settings from specified settings container.

    @@ -7345,7 +7347,7 @@ done by deleting and reinstalling (see the warning about database backup).

    Loads all Settings from each Settings container.

    diff --git a/docs/classes/Footnotes-Template.html b/docs/classes/Footnotes-Template.html index b4bdfd1..7c574cc 100644 --- a/docs/classes/Footnotes-Template.html +++ b/docs/classes/Footnotes-Template.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/classes/Footnotes-WYSIWYG.html b/docs/classes/Footnotes-WYSIWYG.html index 841207b..5c8f76d 100644 --- a/docs/classes/Footnotes-WYSIWYG.html +++ b/docs/classes/Footnotes-WYSIWYG.html @@ -59,7 +59,9 @@

    Default

    @@ -100,7 +102,7 @@

    Handles the WSYIWYG-Buttons.

    @@ -196,7 +198,7 @@

    AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.

    @@ -246,7 +248,7 @@

    Includes the Plugins WYSIWYG editor script.

    @@ -307,7 +309,7 @@

    Add a new button to the plain text editor.

    @@ -356,7 +358,7 @@

    Append a new Button to the WYSIWYG editor of Posts and Pages.

    @@ -417,7 +419,7 @@

    Registers Button hooks.

    diff --git a/docs/classes/Footnotes-Widget-Base.html b/docs/classes/Footnotes-Widget-Base.html index c31e2aa..5e0ae21 100644 --- a/docs/classes/Footnotes-Widget-Base.html +++ b/docs/classes/Footnotes-Widget-Base.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/classes/Footnotes-Widget-Reference-Container.html b/docs/classes/Footnotes-Widget-Reference-Container.html index 4a409a9..6c7c8b7 100644 --- a/docs/classes/Footnotes-Widget-Reference-Container.html +++ b/docs/classes/Footnotes-Widget-Reference-Container.html @@ -59,7 +59,9 @@

    Default

    @@ -103,7 +105,7 @@

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

    @@ -291,7 +293,7 @@

    Outputs the Settings of the Widget.

    @@ -353,7 +355,7 @@

    Outputs the Content of the Widget.

    @@ -423,7 +425,7 @@

    Returns the Description of the child widget.

    @@ -473,7 +475,7 @@

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

    @@ -522,7 +524,7 @@

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

    diff --git a/docs/classes/Footnotes-i18n.html b/docs/classes/Footnotes-i18n.html index 2ec15bd..0c38fdf 100644 --- a/docs/classes/Footnotes-i18n.html +++ b/docs/classes/Footnotes-i18n.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/classes/Footnotes.html b/docs/classes/Footnotes.html index 9fc4fd8..1a72f62 100644 --- a/docs/classes/Footnotes.html +++ b/docs/classes/Footnotes.html @@ -59,7 +59,9 @@

    Default

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

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

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

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

    Retrieve the version number of the plugin.

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

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

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

    Register all of the hooks related to the admin area functionality @@ -759,7 +761,7 @@ of the plugin.

    Register all of the hooks related to the public-facing functionality @@ -818,7 +820,7 @@ of the plugin.

    Load the required dependencies for this plugin.

    @@ -829,10 +831,22 @@ of the plugin.

    Include the following files that make up the plugin:

    Create an instance of the loader which will be used to register the hooks with WordPress.

    @@ -885,7 +899,7 @@ with WordPress.

    Define the locale for this plugin for internationalization.

    diff --git a/docs/files/src-admin-class-footnotes-admin.html b/docs/files/src-admin-class-footnotes-admin.html index dc2146e..d9eb86f 100644 --- a/docs/files/src-admin-class-footnotes-admin.html +++ b/docs/files/src-admin-class-footnotes-admin.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-admin-class-footnotes-wysiwyg.html b/docs/files/src-admin-class-footnotes-wysiwyg.html index 24cf02d..0b0e6ec 100644 --- a/docs/files/src-admin-class-footnotes-wysiwyg.html +++ b/docs/files/src-admin-class-footnotes-wysiwyg.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-admin-index.html b/docs/files/src-admin-index.html index 4827a6d..b37484d 100644 --- a/docs/files/src-admin-index.html +++ b/docs/files/src-admin-index.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-admin-layout-class-footnotes-layout-engine.html b/docs/files/src-admin-layout-class-footnotes-layout-engine.html index 6cfd198..2358f0e 100644 --- a/docs/files/src-admin-layout-class-footnotes-layout-engine.html +++ b/docs/files/src-admin-layout-class-footnotes-layout-engine.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-admin-layout-class-footnotes-layout-init.html b/docs/files/src-admin-layout-class-footnotes-layout-init.html index 65a1547..c57da17 100644 --- a/docs/files/src-admin-layout-class-footnotes-layout-init.html +++ b/docs/files/src-admin-layout-class-footnotes-layout-init.html @@ -59,7 +59,9 @@

    Default

    @@ -80,6 +82,7 @@
    diff --git a/docs/files/src-admin-layout-class-footnotes-layout-settings.html b/docs/files/src-admin-layout-class-footnotes-layout-settings.html index 95b4419..e822e7e 100644 --- a/docs/files/src-admin-layout-class-footnotes-layout-settings.html +++ b/docs/files/src-admin-layout-class-footnotes-layout-settings.html @@ -59,7 +59,9 @@

    Default

    @@ -80,6 +82,7 @@
    diff --git a/docs/files/src-footnotes.html b/docs/files/src-footnotes.html index ee94d33..62b5816 100644 --- a/docs/files/src-footnotes.html +++ b/docs/files/src-footnotes.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-activator.html b/docs/files/src-includes-class-footnotes-activator.html index 23ebe44..76d8421 100644 --- a/docs/files/src-includes-class-footnotes-activator.html +++ b/docs/files/src-includes-class-footnotes-activator.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-config.html b/docs/files/src-includes-class-footnotes-config.html index 7c1fac2..cd4844a 100644 --- a/docs/files/src-includes-class-footnotes-config.html +++ b/docs/files/src-includes-class-footnotes-config.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-convert.html b/docs/files/src-includes-class-footnotes-convert.html index 876dff2..1149140 100644 --- a/docs/files/src-includes-class-footnotes-convert.html +++ b/docs/files/src-includes-class-footnotes-convert.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-deactivator.html b/docs/files/src-includes-class-footnotes-deactivator.html index 5da7018..67f4b9f 100644 --- a/docs/files/src-includes-class-footnotes-deactivator.html +++ b/docs/files/src-includes-class-footnotes-deactivator.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-i18n.html b/docs/files/src-includes-class-footnotes-i18n.html index 1c28315..24b4a7e 100644 --- a/docs/files/src-includes-class-footnotes-i18n.html +++ b/docs/files/src-includes-class-footnotes-i18n.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-loader.html b/docs/files/src-includes-class-footnotes-loader.html index 149e066..6056a40 100644 --- a/docs/files/src-includes-class-footnotes-loader.html +++ b/docs/files/src-includes-class-footnotes-loader.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-class-footnotes-settings.html b/docs/files/src-includes-class-footnotes-settings.html index 658d74e..57a9e56 100644 --- a/docs/files/src-includes-class-footnotes-settings.html +++ b/docs/files/src-includes-class-footnotes-settings.html @@ -59,7 +59,9 @@

    Default

    @@ -80,6 +82,7 @@
    diff --git a/docs/files/src-includes-class-footnotes-template.html b/docs/files/src-includes-class-footnotes-template.html index 56d379d..cd3b781 100644 --- a/docs/files/src-includes-class-footnotes-template.html +++ b/docs/files/src-includes-class-footnotes-template.html @@ -59,7 +59,9 @@

    Default

    @@ -80,6 +82,7 @@
    diff --git a/docs/files/src-includes-class-footnotes.html b/docs/files/src-includes-class-footnotes.html index 1ece9e5..894d895 100644 --- a/docs/files/src-includes-class-footnotes.html +++ b/docs/files/src-includes-class-footnotes.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-includes-index.html b/docs/files/src-includes-index.html index 2e12629..1aeefe2 100644 --- a/docs/files/src-includes-index.html +++ b/docs/files/src-includes-index.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-index.html b/docs/files/src-index.html index 5166573..68b376a 100644 --- a/docs/files/src-index.html +++ b/docs/files/src-index.html @@ -59,7 +59,9 @@

    Default

    diff --git a/docs/files/src-public-class-footnotes-parser.html b/docs/files/src-public-class-footnotes-parser.html new file mode 100644 index 0000000..773676e --- /dev/null +++ b/docs/files/src-public-class-footnotes-parser.html @@ -0,0 +1,133 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
    +

    Documentation

    + + +
    + +
    + + +
    + +
    +
    + + + + +
    + + +
    +

    class-footnotes-parser.php

    + + + +

    + Interfaces, Classes and Traits + +

    + +
    + +
    Footnotes_Parser
    +
    Searches and replaces the footnotes and generates the reference container.
    + +
    + + + + + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + diff --git a/docs/files/src-public-class-footnotes-public.html b/docs/files/src-public-class-footnotes-public.html index a1f03bc..0a147e0 100644 --- a/docs/files/src-public-class-footnotes-public.html +++ b/docs/files/src-public-class-footnotes-public.html @@ -59,7 +59,9 @@

      Default

      diff --git a/docs/files/src-public-index.html b/docs/files/src-public-index.html index b09f9b2..e20cf79 100644 --- a/docs/files/src-public-index.html +++ b/docs/files/src-public-index.html @@ -59,7 +59,9 @@

      Default

      diff --git a/docs/files/src-public-widget-class-footnotes-widget-base.html b/docs/files/src-public-widget-class-footnotes-widget-base.html index 069bbb2..8a03533 100644 --- a/docs/files/src-public-widget-class-footnotes-widget-base.html +++ b/docs/files/src-public-widget-class-footnotes-widget-base.html @@ -59,7 +59,9 @@

      Default

      @@ -80,6 +82,7 @@
      diff --git a/docs/files/src-public-widget-class-footnotes-widget-reference-container.html b/docs/files/src-public-widget-class-footnotes-widget-reference-container.html index 9c7f5ca..a4484f5 100644 --- a/docs/files/src-public-widget-class-footnotes-widget-reference-container.html +++ b/docs/files/src-public-widget-class-footnotes-widget-reference-container.html @@ -59,7 +59,9 @@

      Default

      @@ -80,6 +82,7 @@
      diff --git a/docs/files/src-uninstall.html b/docs/files/src-uninstall.html index 1e0e617..0e29253 100644 --- a/docs/files/src-uninstall.html +++ b/docs/files/src-uninstall.html @@ -59,7 +59,9 @@

      Default

      diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html index 8361330..3a06465 100644 --- a/docs/graphs/classes.html +++ b/docs/graphs/classes.html @@ -52,7 +52,9 @@

      Default

      diff --git a/docs/index.html b/docs/index.html index 5637e63..66de63d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -59,7 +59,9 @@

      Default

      @@ -129,12 +131,12 @@
      Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
      Footnotes_Public
      The public-facing functionality of the plugin.
      -
      Footnotes_Task
      -
      Searches and replaces the footnotes and generates the reference container.
      Footnotes_Widget_Base
      Base Class for all Plugin Widgets. Registers each Widget to WordPress.
      Footnotes_Widget_Reference_Container
      Registers a Widget to put the Reference Container to the widget area.
      +
      Footnotes_Parser
      +
      Searches and replaces the footnotes and generates the reference container.
      diff --git a/docs/indices/files.html b/docs/indices/files.html index c68514a..70fc831 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -59,7 +59,9 @@

      Default

      @@ -92,9 +94,9 @@
    • class-footnotes-layout-init.php
    • class-footnotes-layout-settings.php
    • class-footnotes-loader.php
      • +
    • class-footnotes-parser.php
    • class-footnotes-public.php
    • class-footnotes-settings.php
      • -
    • class-footnotes-task.php
    • class-footnotes-template.php
    • class-footnotes-widget-base.php
    • class-footnotes-widget-reference-container.php
      • @@ -107,10 +109,10 @@

      I

      U

        diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 25edadf..3c4013d 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -126,10 +126,10 @@ Search.appendIndex( "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020admin\u0020area.", "url": "classes/Footnotes-Admin.html#method_enqueue_scripts" }, { - "fqsen": "\\Footnotes_Admin\u003A\u003Aget_plugin_links\u0028\u0029", - "name": "get_plugin_links", + "fqsen": "\\Footnotes_Admin\u003A\u003Afootnotes_action_links\u0028\u0029", + "name": "footnotes_action_links", "summary": "Appends\u0020the\u0020Plugin\u0020links\u0020for\u0020display\u0020in\u0020the\u0020dashboard\u0020Plugins\u0020page.", - "url": "classes/Footnotes-Admin.html#method_get_plugin_links" + "url": "classes/Footnotes-Admin.html#method_footnotes_action_links" }, { "fqsen": "\\Footnotes_Admin\u003A\u003A\u0024plugin_name", "name": "plugin_name", @@ -320,6 +320,11 @@ Search.appendIndex( "name": "__construct", "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", "url": "classes/Footnotes-Layout-Init.html#method___construct" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020dependencies\u0020for\u0020this\u0020plugin.", + "url": "classes/Footnotes-Layout-Init.html#method_load_dependencies" }, { "fqsen": "\\Footnotes_Layout_Init\u003A\u003Ainitialize_settings\u0028\u0029", "name": "initialize_settings", @@ -340,11 +345,6 @@ Search.appendIndex( "name": "C_STR_MAIN_MENU_SLUG", "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" - }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_TITLE", - "name": "C_STR_MAIN_MENU_TITLE", - "summary": "Plugin\u0020main\u0020menu\u0020name.", - "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" }, { "fqsen": "\\Footnotes_Layout_Init\u003A\u003A\u0024settings_page", "name": "settings_page", @@ -1345,196 +1345,6 @@ Search.appendIndex( "name": "a_str_script_mode", "summary": "Allows\u0020to\u0020determine\u0020the\u0020script\u0020mode\u0020among\u0020jQuery\u0020or\u0020plain\u0020JS.", "url": "classes/Footnotes-Public.html#property_a_str_script_mode" - }, { - "fqsen": "\\Footnotes_Task", - "name": "Footnotes_Task", - "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes\u0020and\u0020generates\u0020the\u0020reference\u0020container.", - "url": "classes/Footnotes-Task.html" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", - "url": "classes/Footnotes-Task.html#method___construct" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_register_hooks" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_footnotes_output_head" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Afootnotes_output_footer\u0028\u0029", - "name": "footnotes_output_footer", - "summary": "Displays\u0020the\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020slug\u0020if\u0020enabled.", - "url": "classes/Footnotes-Task.html#method_footnotes_output_footer" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Afootnotes_in_title\u0028\u0029", - "name": "footnotes_in_title", - "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020post\/page\u0020title.", - "url": "classes/Footnotes-Task.html#method_footnotes_in_title" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_footnotes_in_content" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_footnotes_in_excerpt" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Agenerate_excerpt\u0028\u0029", - "name": "generate_excerpt", - "summary": "Generates\u0020excerpt\u0020on\u0020the\u0020basis\u0020of\u0020the\u0020post.", - "url": "classes/Footnotes-Task.html#method_generate_excerpt" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_generate_excerpt_with_footnotes" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Afootnotes_in_widget_title\u0028\u0029", - "name": "footnotes_in_widget_title", - "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020widget\u0020title.", - "url": "classes/Footnotes-Task.html#method_footnotes_in_widget_title" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_footnotes_in_widget_text" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Aexec\u0028\u0029", - "name": "exec", - "summary": "Replaces\u0020all\u0020footnotes\u0020that\u0020occur\u0020in\u0020the\u0020given\u0020content.", - "url": "classes/Footnotes-Task.html#method_exec" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Aunify_delimiters\u0028\u0029", - "name": "unify_delimiters", - "summary": "Brings\u0020the\u0020delimiters\u0020and\u0020unifies\u0020their\u0020various\u0020HTML\u0020escapement\u0020schemas.", - "url": "classes/Footnotes-Task.html#method_unify_delimiters" - }, { - "fqsen": "\\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/Footnotes-Task.html#method_search" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003Areference_container\u0028\u0029", - "name": "reference_container", - "summary": "Generates\u0020the\u0020reference\u0020container.", - "url": "classes/Footnotes-Task.html#method_reference_container" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_arr_footnotes", - "name": "a_arr_footnotes", - "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020in\u0020the\u0020searched\u0020content.", - "url": "classes/Footnotes-Task.html#property_a_arr_footnotes" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_bool_allow_love_me" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_prefix", - "name": "a_str_prefix", - "summary": "Prefix\u0020for\u0020the\u0020Footnote\u0020html\u0020element\u0020ID.", - "url": "classes/Footnotes-Task.html#property_a_str_prefix" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_int_post_id" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_int_reference_container_id" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_bool_hard_links_enabled", - "name": "a_bool_hard_links_enabled", - "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility.", - "url": "classes/Footnotes-Task.html#property_a_bool_hard_links_enabled" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_referrer_link_slug", - "name": "a_str_referrer_link_slug", - "summary": "The\u0020referrer\u0020slug.", - "url": "classes/Footnotes-Task.html#property_a_str_referrer_link_slug" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_footnote_link_slug", - "name": "a_str_footnote_link_slug", - "summary": "The\u0020footnote\u0020slug.", - "url": "classes/Footnotes-Task.html#property_a_str_footnote_link_slug" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_link_ids_separator", - "name": "a_str_link_ids_separator", - "summary": "The\u0020slug\u0020and\u0020identifier\u0020separator.", - "url": "classes/Footnotes-Task.html#property_a_str_link_ids_separator" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_str_post_container_id_compound" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_int_scroll_offset", - "name": "a_int_scroll_offset", - "summary": "Scroll\u0020offset.", - "url": "classes/Footnotes-Task.html#property_a_int_scroll_offset" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_link_span", - "name": "a_str_link_span", - "summary": "The\u0020span\u0020element\u0020name.", - "url": "classes/Footnotes-Task.html#property_a_str_link_span" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_link_open_tag", - "name": "a_str_link_open_tag", - "summary": "The\u0020opening\u0020tag.", - "url": "classes/Footnotes-Task.html#property_a_str_link_open_tag" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_link_close_tag", - "name": "a_str_link_close_tag", - "summary": "The\u0020closing\u0020tag.", - "url": "classes/Footnotes-Task.html#property_a_str_link_close_tag" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_tooltip_shortcode", - "name": "a_str_tooltip_shortcode", - "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode.", - "url": "classes/Footnotes-Task.html#property_a_str_tooltip_shortcode" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_int_tooltip_shortcode_length", - "name": "a_int_tooltip_shortcode_length", - "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode\u0020length.", - "url": "classes/Footnotes-Task.html#property_a_int_tooltip_shortcode_length" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_bool_mirror_tooltip_text" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_start_tag", - "name": "a_str_start_tag", - "summary": "Footnote\u0020delimiter\u0020start\u0020short\u0020code.", - "url": "classes/Footnotes-Task.html#property_a_str_start_tag" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_str_end_tag", - "name": "a_str_end_tag", - "summary": "Footnote\u0020delimiter\u0020end\u0020short\u0020code.", - "url": "classes/Footnotes-Task.html#property_a_str_end_tag" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_str_start_tag_regex" - }, { - "fqsen": "\\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/Footnotes-Task.html#property_a_str_end_tag_regex" - }, { - "fqsen": "\\Footnotes_Task\u003A\u003A\u0024a_bool_syntax_error_flag", - "name": "a_bool_syntax_error_flag", - "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation\u0020enabled.", - "url": "classes/Footnotes-Task.html#property_a_bool_syntax_error_flag" }, { "fqsen": "\\Footnotes_Widget_Base", "name": "Footnotes_Widget_Base", @@ -1595,6 +1405,196 @@ Search.appendIndex( "name": "widget", "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", "url": "classes/Footnotes-Widget-Reference-Container.html#method_widget" + }, { + "fqsen": "\\Footnotes_Parser", + "name": "Footnotes_Parser", + "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes\u0020and\u0020generates\u0020the\u0020reference\u0020container.", + "url": "classes/Footnotes-Parser.html" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Parser.html#method___construct" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", + "summary": "Register\u0020WordPress\u0020hooks\u0020to\u0020replace\u0020Footnotes\u0020in\u0020the\u0020content\u0020of\u0020a\u0020public\u0020page.", + "url": "classes/Footnotes-Parser.html#method_register_hooks" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_output_head\u0028\u0029", + "name": "footnotes_output_head", + "summary": "Outputs\u0020the\u0020custom\u0020css\u0020to\u0020the\u0020header\u0020of\u0020the\u0020public\u0020page.", + "url": "classes/Footnotes-Parser.html#method_footnotes_output_head" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_output_footer\u0028\u0029", + "name": "footnotes_output_footer", + "summary": "Displays\u0020the\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020slug\u0020if\u0020enabled.", + "url": "classes/Footnotes-Parser.html#method_footnotes_output_footer" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_in_title\u0028\u0029", + "name": "footnotes_in_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020post\/page\u0020title.", + "url": "classes/Footnotes-Parser.html#method_footnotes_in_title" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_in_content\u0028\u0029", + "name": "footnotes_in_content", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020page\/post.", + "url": "classes/Footnotes-Parser.html#method_footnotes_in_content" + }, { + "fqsen": "\\Footnotes_Parser\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/Footnotes-Parser.html#method_footnotes_in_excerpt" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Agenerate_excerpt\u0028\u0029", + "name": "generate_excerpt", + "summary": "Generates\u0020excerpt\u0020on\u0020the\u0020basis\u0020of\u0020the\u0020post.", + "url": "classes/Footnotes-Parser.html#method_generate_excerpt" + }, { + "fqsen": "\\Footnotes_Parser\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/Footnotes-Parser.html#method_generate_excerpt_with_footnotes" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_in_widget_title\u0028\u0029", + "name": "footnotes_in_widget_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020widget\u0020title.", + "url": "classes/Footnotes-Parser.html#method_footnotes_in_widget_title" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Afootnotes_in_widget_text\u0028\u0029", + "name": "footnotes_in_widget_text", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020widget.", + "url": "classes/Footnotes-Parser.html#method_footnotes_in_widget_text" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Aexec\u0028\u0029", + "name": "exec", + "summary": "Replaces\u0020all\u0020footnotes\u0020that\u0020occur\u0020in\u0020the\u0020given\u0020content.", + "url": "classes/Footnotes-Parser.html#method_exec" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Aunify_delimiters\u0028\u0029", + "name": "unify_delimiters", + "summary": "Brings\u0020the\u0020delimiters\u0020and\u0020unifies\u0020their\u0020various\u0020HTML\u0020escapement\u0020schemas.", + "url": "classes/Footnotes-Parser.html#method_unify_delimiters" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Asearch\u0028\u0029", + "name": "search", + "summary": "Replaces\u0020all\u0020footnotes\u0020in\u0020the\u0020given\u0020content\u0020and\u0020appends\u0020them\u0020to\u0020the\u0020static\u0020property.", + "url": "classes/Footnotes-Parser.html#method_search" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003Areference_container\u0028\u0029", + "name": "reference_container", + "summary": "Generates\u0020the\u0020reference\u0020container.", + "url": "classes/Footnotes-Parser.html#method_reference_container" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_arr_footnotes", + "name": "a_arr_footnotes", + "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020in\u0020the\u0020searched\u0020content.", + "url": "classes/Footnotes-Parser.html#property_a_arr_footnotes" + }, { + "fqsen": "\\Footnotes_Parser\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/Footnotes-Parser.html#property_a_bool_allow_love_me" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_prefix", + "name": "a_str_prefix", + "summary": "Prefix\u0020for\u0020the\u0020Footnote\u0020html\u0020element\u0020ID.", + "url": "classes/Footnotes-Parser.html#property_a_str_prefix" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_int_post_id", + "name": "a_int_post_id", + "summary": "Autoload\u0020a.k.a.\u0020infinite\u0020scroll,\u0020or\u0020archive\u0020view.", + "url": "classes/Footnotes-Parser.html#property_a_int_post_id" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_int_reference_container_id", + "name": "a_int_reference_container_id", + "summary": "Multiple\u0020reference\u0020containers\u0020in\u0020content\u0020and\u0020widgets.", + "url": "classes/Footnotes-Parser.html#property_a_int_reference_container_id" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_bool_hard_links_enabled", + "name": "a_bool_hard_links_enabled", + "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility.", + "url": "classes/Footnotes-Parser.html#property_a_bool_hard_links_enabled" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_referrer_link_slug", + "name": "a_str_referrer_link_slug", + "summary": "The\u0020referrer\u0020slug.", + "url": "classes/Footnotes-Parser.html#property_a_str_referrer_link_slug" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_footnote_link_slug", + "name": "a_str_footnote_link_slug", + "summary": "The\u0020footnote\u0020slug.", + "url": "classes/Footnotes-Parser.html#property_a_str_footnote_link_slug" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_link_ids_separator", + "name": "a_str_link_ids_separator", + "summary": "The\u0020slug\u0020and\u0020identifier\u0020separator.", + "url": "classes/Footnotes-Parser.html#property_a_str_link_ids_separator" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_post_container_id_compound", + "name": "a_str_post_container_id_compound", + "summary": "Contains\u0020the\u0020concatenated\u0020fragment\u0020ID\u0020base.", + "url": "classes/Footnotes-Parser.html#property_a_str_post_container_id_compound" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_int_scroll_offset", + "name": "a_int_scroll_offset", + "summary": "Scroll\u0020offset.", + "url": "classes/Footnotes-Parser.html#property_a_int_scroll_offset" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_link_span", + "name": "a_str_link_span", + "summary": "The\u0020span\u0020element\u0020name.", + "url": "classes/Footnotes-Parser.html#property_a_str_link_span" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_link_open_tag", + "name": "a_str_link_open_tag", + "summary": "The\u0020opening\u0020tag.", + "url": "classes/Footnotes-Parser.html#property_a_str_link_open_tag" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_link_close_tag", + "name": "a_str_link_close_tag", + "summary": "The\u0020closing\u0020tag.", + "url": "classes/Footnotes-Parser.html#property_a_str_link_close_tag" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_tooltip_shortcode", + "name": "a_str_tooltip_shortcode", + "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode.", + "url": "classes/Footnotes-Parser.html#property_a_str_tooltip_shortcode" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_int_tooltip_shortcode_length", + "name": "a_int_tooltip_shortcode_length", + "summary": "The\u0020tooltip\u0020delimiter\u0020shortcode\u0020length.", + "url": "classes/Footnotes-Parser.html#property_a_int_tooltip_shortcode_length" + }, { + "fqsen": "\\Footnotes_Parser\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/Footnotes-Parser.html#property_a_bool_mirror_tooltip_text" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_start_tag", + "name": "a_str_start_tag", + "summary": "Footnote\u0020delimiter\u0020start\u0020short\u0020code.", + "url": "classes/Footnotes-Parser.html#property_a_str_start_tag" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_end_tag", + "name": "a_str_end_tag", + "summary": "Footnote\u0020delimiter\u0020end\u0020short\u0020code.", + "url": "classes/Footnotes-Parser.html#property_a_str_end_tag" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_start_tag_regex", + "name": "a_str_start_tag_regex", + "summary": "Footnote\u0020delimiter\u0020start\u0020short\u0020code\u0020in\u0020regex\u0020format.", + "url": "classes/Footnotes-Parser.html#property_a_str_start_tag_regex" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_str_end_tag_regex", + "name": "a_str_end_tag_regex", + "summary": "Footnote\u0020delimiter\u0020end\u0020short\u0020code\u0020in\u0020regex\u0020format.", + "url": "classes/Footnotes-Parser.html#property_a_str_end_tag_regex" + }, { + "fqsen": "\\Footnotes_Parser\u003A\u003A\u0024a_bool_syntax_error_flag", + "name": "a_bool_syntax_error_flag", + "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation\u0020enabled.", + "url": "classes/Footnotes-Parser.html#property_a_bool_syntax_error_flag" }, { "fqsen": "\\", "name": "\\", diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index 00764db..ec6bbf8 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -59,7 +59,9 @@

        Default

        @@ -123,12 +125,12 @@
        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
        Footnotes_Public
        The public-facing functionality of the plugin.
        -
        Footnotes_Task
        -
        Searches and replaces the footnotes and generates the reference container.
        Footnotes_Widget_Base
        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
        Footnotes_Widget_Reference_Container
        Registers a Widget to put the Reference Container to the widget area.
        +
        Footnotes_Parser
        +
        Searches and replaces the footnotes and generates the reference container.
        diff --git a/docs/packages/Default.html b/docs/packages/Default.html index d3d3168..7e0dfad 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -59,7 +59,9 @@

        Default

        diff --git a/docs/packages/default.html b/docs/packages/default.html index 1b1ea46..2de5554 100644 --- a/docs/packages/default.html +++ b/docs/packages/default.html @@ -59,7 +59,9 @@

        Default

        diff --git a/docs/packages/footnotes-footnotesadmin.html b/docs/packages/footnotes-footnotesadmin.html index cdf4e42..48f7963 100644 --- a/docs/packages/footnotes-footnotesadmin.html +++ b/docs/packages/footnotes-footnotesadmin.html @@ -59,7 +59,9 @@

        Default

        diff --git a/docs/packages/footnotes-footnotesadminlayout.html b/docs/packages/footnotes-footnotesadminlayout.html new file mode 100644 index 0000000..44afbef --- /dev/null +++ b/docs/packages/footnotes-footnotesadminlayout.html @@ -0,0 +1,120 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
        +

        Documentation

        + + +
        + +
        + + +
        + +
        +
        + + + + +
        + + +
        +

        footnotesadminlayout

        + + + + + + + + + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + diff --git a/docs/packages/footnotes-footnotesincludes.html b/docs/packages/footnotes-footnotesincludes.html index 5550b48..4e5c6fa 100644 --- a/docs/packages/footnotes-footnotesincludes.html +++ b/docs/packages/footnotes-footnotesincludes.html @@ -59,7 +59,9 @@

          Default

          diff --git a/docs/packages/footnotes-footnotespublic.html b/docs/packages/footnotes-footnotespublic.html index 4ecfc5a..ff24bbb 100644 --- a/docs/packages/footnotes-footnotespublic.html +++ b/docs/packages/footnotes-footnotespublic.html @@ -59,7 +59,9 @@

          Default

          diff --git a/docs/packages/footnotes-footnotespublicwidget.html b/docs/packages/footnotes-footnotespublicwidget.html new file mode 100644 index 0000000..550ab65 --- /dev/null +++ b/docs/packages/footnotes-footnotespublicwidget.html @@ -0,0 +1,120 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
          +

          Documentation

          + + +
          + +
          + + +
          + +
          +
          + + + + +
          + + +
          +

          footnotespublicwidget

          + + + + + + + + + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + diff --git a/docs/packages/footnotes.html b/docs/packages/footnotes.html index eba3109..755e0b2 100644 --- a/docs/packages/footnotes.html +++ b/docs/packages/footnotes.html @@ -59,7 +59,9 @@

            Default

            @@ -92,7 +94,9 @@
            footnotesincludes
            footnotesadmin
            +
            footnotesadminlayout
            footnotespublic
            +
            footnotespublicwidget
            @@ -119,12 +123,12 @@
            Loads the settings values, sets to default values if undefined.
            Footnotes_Template
            Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
            -
            Footnotes_Task
            -
            Searches and replaces the footnotes and generates the reference container.
            Footnotes_Widget_Base
            Base Class for all Plugin Widgets. Registers each Widget to WordPress.
            Footnotes_Widget_Reference_Container
            Registers a Widget to put the Reference Container to the widget area.
            +
            Footnotes_Parser
            +
            Searches and replaces the footnotes and generates the reference container.
            diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html index a499816..5a8db38 100644 --- a/docs/reports/deprecated.html +++ b/docs/reports/deprecated.html @@ -60,7 +60,9 @@

            Default

            diff --git a/docs/reports/errors.html b/docs/reports/errors.html index 82b1d2a..c8dd37c 100644 --- a/docs/reports/errors.html +++ b/docs/reports/errors.html @@ -60,7 +60,9 @@

            Default

            diff --git a/docs/reports/markers.html b/docs/reports/markers.html index aa69429..937ebb0 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -60,7 +60,9 @@

            Default