From 953427f0f7d4129431b6ffb5d2919b09784450a1 Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Sat, 20 Feb 2021 19:55:52 +0000 Subject: [PATCH] Generate HTML documentation using phpDocumentor --- docs/classes/MCI-Footnotes-Config.html | 504 ++ docs/classes/MCI-Footnotes-Convert.html | 759 ++ docs/classes/MCI-Footnotes-Hooks.html | 526 ++ docs/classes/MCI-Footnotes-Language.html | 493 ++ .../MCI-Footnotes-Layout-Diagnostics.html | 2290 ++++++ docs/classes/MCI-Footnotes-Layout-Init.html | 759 ++ .../MCI-Footnotes-Layout-Settings.html | 3757 ++++++++++ docs/classes/MCI-Footnotes-LayoutEngine.html | 2222 ++++++ docs/classes/MCI-Footnotes-Settings.html | 6221 +++++++++++++++++ docs/classes/MCI-Footnotes-Task.html | 2902 ++++++++ docs/classes/MCI-Footnotes-Template.html | 1044 +++ docs/classes/MCI-Footnotes-WYSIWYG.html | 492 ++ ...I-Footnotes-Widget-ReferenceContainer.html | 688 ++ docs/classes/MCI-Footnotes-WidgetBase.html | 529 ++ docs/classes/MCI-Footnotes.html | 873 +++ docs/css/base.css | 1002 +++ docs/css/normalize.css | 427 ++ docs/css/template.css | 169 + docs/files/class-config.html | 121 + docs/files/class-convert.html | 121 + docs/files/class-dashboard-init.html | 121 + docs/files/class-dashboard-layout.html | 121 + .../class-dashboard-subpage-diagnostics.html | 121 + docs/files/class-dashboard-subpage-main.html | 121 + docs/files/class-hooks.html | 121 + docs/files/class-init.html | 121 + docs/files/class-language.html | 121 + docs/files/class-settings.html | 121 + docs/files/class-task.html | 121 + docs/files/class-template.html | 121 + docs/files/class-widgets-base.html | 121 + .../class-widgets-reference-container.html | 121 + docs/files/class-wysiwyg.html | 121 + docs/files/footnotes.html | 110 + docs/files/includes.html | 190 + docs/graphs/classes.html | 97 + docs/index.html | 223 + docs/indices/files.html | 142 + docs/js/search.js | 173 + docs/js/searchIndex.js | 1419 ++++ docs/namespaces/default.html | 227 + docs/packages/Default.html | 227 + docs/packages/default.html | 116 + docs/reports/deprecated.html | 106 + docs/reports/errors.html | 174 + docs/reports/markers.html | 128 + 46 files changed, 30804 insertions(+) create mode 100644 docs/classes/MCI-Footnotes-Config.html create mode 100644 docs/classes/MCI-Footnotes-Convert.html create mode 100644 docs/classes/MCI-Footnotes-Hooks.html create mode 100644 docs/classes/MCI-Footnotes-Language.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Diagnostics.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Init.html create mode 100644 docs/classes/MCI-Footnotes-Layout-Settings.html create mode 100644 docs/classes/MCI-Footnotes-LayoutEngine.html create mode 100644 docs/classes/MCI-Footnotes-Settings.html create mode 100644 docs/classes/MCI-Footnotes-Task.html create mode 100644 docs/classes/MCI-Footnotes-Template.html create mode 100644 docs/classes/MCI-Footnotes-WYSIWYG.html create mode 100644 docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html create mode 100644 docs/classes/MCI-Footnotes-WidgetBase.html create mode 100644 docs/classes/MCI-Footnotes.html create mode 100644 docs/css/base.css create mode 100644 docs/css/normalize.css create mode 100644 docs/css/template.css create mode 100644 docs/files/class-config.html create mode 100644 docs/files/class-convert.html create mode 100644 docs/files/class-dashboard-init.html create mode 100644 docs/files/class-dashboard-layout.html create mode 100644 docs/files/class-dashboard-subpage-diagnostics.html create mode 100644 docs/files/class-dashboard-subpage-main.html create mode 100644 docs/files/class-hooks.html create mode 100644 docs/files/class-init.html create mode 100644 docs/files/class-language.html create mode 100644 docs/files/class-settings.html create mode 100644 docs/files/class-task.html create mode 100644 docs/files/class-template.html create mode 100644 docs/files/class-widgets-base.html create mode 100644 docs/files/class-widgets-reference-container.html create mode 100644 docs/files/class-wysiwyg.html create mode 100644 docs/files/footnotes.html create mode 100644 docs/files/includes.html create mode 100644 docs/graphs/classes.html create mode 100644 docs/index.html create mode 100644 docs/indices/files.html create mode 100644 docs/js/search.js create mode 100644 docs/js/searchIndex.js create mode 100644 docs/namespaces/default.html create mode 100644 docs/packages/Default.html create mode 100644 docs/packages/default.html create mode 100644 docs/reports/deprecated.html create mode 100644 docs/reports/errors.html create mode 100644 docs/reports/markers.html diff --git a/docs/classes/MCI-Footnotes-Config.html b/docs/classes/MCI-Footnotes-Config.html new file mode 100644 index 0000000..57b1506 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Config.html @@ -0,0 +1,504 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
+

Documentation

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

+ MCI_Footnotes_Config + + + + +

+ + + +

Contains all Plugin Constants. Contains no Method or Property.

+ +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ C_STR_LOVE_SYMBOL + +  = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' +
+
Html tag for the LOVE symbol.
+ +
+ C_STR_LOVE_SYMBOL_HEADING + +  = '<span class="footnotes_heart_heading">&hearts;</span>' +
+
HTML code for the 'love' symbol used in dashboard heading
+ +
+ C_STR_NO_LOVE_SLUG + +  = '[[no footnotes: love]]' +
+
Short code to DON'T display the 'LOVE ME' slug on certain pages.
+ +
+ C_STR_PLUGIN_HEADING_NAME + +  = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' +
+
Public Plugin name for dashboard heading
+ +
+ C_STR_PLUGIN_NAME + +  = "footnotes" +
+
Internal Plugin name.
+ +
+ C_STR_PLUGIN_PUBLIC_NAME + +  = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' +
+
Public Plugin name.
+ +
+ + + + +
+

+ Constants + +

+
+

+ C_STR_LOVE_SYMBOL + +

+ + + +

Html tag for the LOVE symbol.

+ + + public + string + C_STR_LOVE_SYMBOL + = '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_LOVE_SYMBOL_HEADING + +

+ + + +

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

+ + + public + string + C_STR_LOVE_SYMBOL_HEADING + = '<span class="footnotes_heart_heading">&hearts;</span>' + + + +
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.0.4 + +
+ +
+
+ +
+
+

+ C_STR_NO_LOVE_SLUG + +

+ + + +

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

+ + + public + string + C_STR_NO_LOVE_SLUG + = '[[no footnotes: love]]' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_HEADING_NAME + +

+ + + +

Public Plugin name for dashboard heading

+ + + public + string + C_STR_PLUGIN_HEADING_NAME + = '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' + + + +

After properly displaying in dashboard headings until WPv5.4, the above started +in WPv5.5 being torn apart as if the headline was text-align:justify and not +the last line. That ugly display bug badly affected the plugin’s communication. +The only working solution found so far is using position:fixed in one heading +that isn’t translated, and dropping the logo in another, translatable heading.

+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.0.4 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_NAME + +

+ + + +

Internal Plugin name.

+ + + public + string + C_STR_PLUGIN_NAME + = "footnotes" + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+

+ C_STR_PLUGIN_PUBLIC_NAME + +

+ + + +

Public Plugin name.

+ + + public + string + C_STR_PLUGIN_PUBLIC_NAME + = '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' + + + +
+ + +
+ Tags + +
+
+
+ author +
+
+ +

Stefan Herndler

+
+ +
+
+ since +
+
+ 1.5.0 + +
+ +
+
+ +
+
+ + + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + diff --git a/docs/classes/MCI-Footnotes-Convert.html b/docs/classes/MCI-Footnotes-Convert.html new file mode 100644 index 0000000..ebb56d9 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Convert.html @@ -0,0 +1,759 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
    +

    Documentation

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

    + MCI_Footnotes_Convert + + + + +

    + + + +

    Converts data types and Footnotes specific values.

    + +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + debug() + +  : mixed +
    +
    Displays a Variable.
    + +
    + getArrow() + +  : array<string|int, mixed>|string +
    +
    Get a html Array short code depending on Arrow-Array key index.
    + +
    + Index() + +  : string +
    +
    Converts a integer into the user-defined counter style for the footnotes.
    + +
    + toBool() + +  : bool +
    +
    Converts a string depending on its value to a boolean.
    + +
    + toArabicLeading() + +  : string +
    +
    Converts an integer to a leading-0 integer.
    + +
    + toLatin() + +  : string +
    +
    Converts an integer into latin ascii characters, either lower or upper-case.
    + +
    + toRomanic() + +  : string +
    +
    Converts an integer to a romanic letter.
    + +
    + + + + + + + +
    +

    + Methods + +

    +
    +

    + debug() + +

    + + +

    Displays a Variable.

    + + + public + static debug(mixed $p_mixed_Value) : mixed + +
    + +
    Parameters
    +
    +
    + $p_mixed_Value + : mixed +
    +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + getArrow() + +

    + + +

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

    + + + public + static getArrow([int $p_int_Index = -1 ]) : array<string|int, mixed>|string + +
    + +
    Parameters
    +
    +
    + $p_int_Index + : int + = -1
    +
    +

    Index representing the Arrow. If empty all Arrows are specified.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.3.2 + +
    + +
    +
    + +
    Return values
    + array<string|int, mixed>|string + — +

    Array of all Arrows if Index is empty otherwise html tag of a specific arrow.

    +
    + + +
    +
    +

    + Index() + +

    + + +

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

    + + + public + static Index(int $p_int_Index[, string $p_str_ConvertStyle = "arabic_plain" ]) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Index + : int +
    +
    +

    Index to be converted.

    +
    + +
    +
    + $p_str_ConvertStyle + : string + = "arabic_plain"
    +
    +

    Style of the new/converted Index.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.2.0 + +

    lowercase Roman numerals supported

    +
    + +
    +
    + +
    Return values
    + string + — +

    Converted Index as string in the defined counter style.

    +

    Edited:

    +
    + + +
    +
    +

    + toBool() + +

    + + +

    Converts a string depending on its value to a boolean.

    + + + public + static toBool(string $p_str_Value) : bool + +
    + +
    Parameters
    +
    +
    + $p_str_Value + : string +
    +
    +

    String to be converted to boolean.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-beta + +
    + +
    +
    + +
    Return values
    + bool + — +

    Boolean representing the string.

    +
    + + +
    +
    +

    + toArabicLeading() + +

    + + +

    Converts an integer to a leading-0 integer.

    + + + private + static toArabicLeading(int $p_int_Value) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + +
    Return values
    + string + — +

    Value with a leading zero.

    +
    + + +
    +
    +

    + toLatin() + +

    + + +

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

    + + + private + static toLatin(int $p_int_Value, bool $p_bool_UpperCase) : string + +

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

    +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + $p_bool_UpperCase + : bool +
    +
    +

    True to convert the value to upper case letter, otherwise to lower case.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + +
    Return values
    + string + — +
    + + +
    +
    +

    + toRomanic() + +

    + + +

    Converts an integer to a romanic letter.

    + + + private + static toRomanic(int $p_int_Value, mixed $p_bool_UpperCase) : string + +
    + +
    Parameters
    +
    +
    + $p_int_Value + : int +
    +
    +

    Value/Index to be converted.

    +
    + +
    +
    + $p_bool_UpperCase + : mixed +
    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + author +
    +
    + +

    Stefan Herndler

    +
    + +
    +
    + since +
    +
    + 1.0-gamma + +
    + +
    +
    + since +
    +
    + 2.2.0 + +

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

    +
    + +
    +
    + +
    Return values
    + string + — +

    Edited:

    +
    + + +
    +
    + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + diff --git a/docs/classes/MCI-Footnotes-Hooks.html b/docs/classes/MCI-Footnotes-Hooks.html new file mode 100644 index 0000000..eb710f1 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Hooks.html @@ -0,0 +1,526 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
      +

      Documentation

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

      + MCI_Footnotes_Hooks + + + + +

      + + + +

      Registers all WordPress Hooks and executes them on demand.

      + +
      + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + activatePlugin() + +  : mixed +
      +
      Executed when the Plugin gets activated.
      + +
      + deactivatePlugin() + +  : mixed +
      +
      Executed when the Plugin gets deactivated.
      + +
      + PluginLinks() + +  : array<string|int, mixed> +
      +
      Add Links to the Plugin in the "installed Plugins" page.
      + +
      + registerHooks() + +  : mixed +
      +
      Registers all WordPress hooks.
      + +
      + uninstallPlugin() + +  : mixed +
      +
      Executed when the Plugin gets uninstalled.
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + activatePlugin() + +

      + + +

      Executed when the Plugin gets activated.

      + + + public + static activatePlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + deactivatePlugin() + +

      + + +

      Executed when the Plugin gets deactivated.

      + + + public + static deactivatePlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + PluginLinks() + +

      + + +

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

      + + + public + static PluginLinks(array<string|int, mixed> $p_arr_Links, string $p_str_PluginFileName) : array<string|int, mixed> + +
      + +
      Parameters
      +
      +
      + $p_arr_Links + : array<string|int, mixed> +
      +
      +

      Current Links.

      +
      + +
      +
      + $p_str_PluginFileName + : string +
      +
      +

      Plugins init file name.

      +
      + +
      +
      + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

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

      + registerHooks() + +

      + + +

      Registers all WordPress hooks.

      + + + public + static registerHooks() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      +

      + uninstallPlugin() + +

      + + +

      Executed when the Plugin gets uninstalled.

      + + + public + static uninstallPlugin() : mixed + +
      + + + +
      + Tags + +
      +
      +
      + author +
      +
      + +

      Stefan Herndler

      +
      + +
      +
      + since +
      +
      + 1.5.0 + +

      Edit: ClearAll didn’t actually work.

      +
      + +
      +
      + since +
      +
      + 2.2.0 + +

      this function is not called any longer when deleting the plugin

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

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + diff --git a/docs/classes/MCI-Footnotes-Language.html b/docs/classes/MCI-Footnotes-Language.html new file mode 100644 index 0000000..ebf670f --- /dev/null +++ b/docs/classes/MCI-Footnotes-Language.html @@ -0,0 +1,493 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
        +

        Documentation

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

        + MCI_Footnotes_Language + + + + +

        + + + +

        Loads text domain of current or default language for localization.

        + +
        + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
        + +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + loadTextDomain() + +  : mixed +
        +
        Loads the text domain for current WordPress language if exists.
        + +
        + registerHooks() + +  : mixed +
        +
        Register WordPress Hook.
        + +
        + load() + +  : bool +
        +
        Loads a specific text domain.
        + +
        + + + + + + + +
        +

        + Methods + +

        +
        +

        + loadTextDomain() + +

        + + +

        Loads the text domain for current WordPress language if exists.

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

        Otherwise fallback "en_GB" will be loaded.

        +
        + + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
          +
        • Bugfix: Correct function call apply_filters() with all required arguments after PHP 7.1 promoted warning to error, thanks to @matkus2 bug report and code contribution.
          • +
        +
        + +
        +
        + since +
        +
        + 2.0.0 + +
        + +
        +
        + date +
        +
        + +

        2020-10-26T1609+0100

        +
        + +
        +
        + contributor +
        +
        + +

        @matkus2

        +
        + +
        +
        + link +
        +
        +

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

        +

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

        +         + +
        +
        + link +
        +
        +

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

        +

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

        +

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

        +         + +
        +
        + link +
        +
        + https://www.php.net/manual/en/migration71.incompatible.php + +
        +
        + link +
        +
        + https://www.php.net/manual/en/migration71.incompatible.php#migration71.incompatible.too-few-arguments-exception + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + registerHooks() + +

        + + +

        Register WordPress Hook.

        + + + public + static registerHooks() : mixed + +
        + + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + load() + +

        + + +

        Loads a specific text domain.

        + + + private + static load(string $p_str_LanguageCode) : bool + +
        + +
        Parameters
        +
        +
        + $p_str_LanguageCode + : string +
        +
        +

        Language Code to load a specific text domain.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + author +
        +
        + +

        Stefan Herndler

        +
        + +
        +
        + since +
        +
        + 1.5.1 + +
        + +
        +
        + since +
        +
        + 2.1.6 + +
        + +
        +
        + date +
        +
        + +

        2020-12-08T1931+0100

        +
        + +
        +
        + reporter +
        +
        + +

        @nikelaos

        +
        + +
        +
        + link +
        +
        +

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

        +         + +
        +
        + see +
        +
        + +

        wp-includes/l10n.php:857

        +
        + +
        +
        + +
        Return values
        + bool + — +
          +
        • Bugfix: Localization: conform to WordPress plugin language file name scheme, thanks to @nikelaos bug report.
          • +
        +
        + + +
        +
        + +
        +
        +
        +
        +

        Search results

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

          Documentation

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

          + MCI_Footnotes_Layout_Diagnostics + + + extends MCI_Footnotes_LayoutEngine + + + + +

          + + + +

          Displays Diagnostics of the web server, PHP and WordPress.

          + +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + + + + + + +

          + Table of Contents + +

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

          + Properties + +

          +
          +

          + $a_arr_Sections + + + +

          + + +

          Stores all Sections for the child sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          +
          +

          + $a_str_SubPageHook + + + +

          + + +

          Stores the Hook connection string for the child sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          +
          + +
          +

          + Methods + +

          +
          +

          + Description() + +

          + + +

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

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + Diagnostics() + +

          + + +

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

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + displayContent() + +

          + + +

          Displays the content of specific sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + getPriority() + +

          + + +

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

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + int + — +
          + + +
          +
          +

          + registerSections() + +

          + + +

          Registers all sections for a sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + registerSubPage() + +

          + + +

          Registers a sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + addCheckbox() + +

          + + +

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

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

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          + addColorSelection() + +

          + + +

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

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

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.6 + +
          + +
          +
          + +
          Return values
          + string + — +
          + + +
          +
          +

          + addLabel() + +

          + + +

          Returns the html tag for an input/select label.

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

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

          +
          + +
          +
          + $p_str_Caption + : string +
          +
          +

          Label caption.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + since +
          +
          + 2.1.6 + +

          no colon

          +
          + +
          +
          + +
          Return values
          + string + — +

          Edited 2020-12-01T0159+0100..

          +
          + + +
          +
          +

          + addLineSpace() + +

          + + +

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

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

          Stefan Herndler

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

          + addMetaBox() + +

          + + +

          Returns an array describing a meta box.

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

          Parent Section ID.

          +
          + +
          +
          + $p_str_ID + : string +
          +
          +

          Unique ID suffix.

          +
          + +
          +
          + $p_str_Title + : string +
          +
          +

          Title for the meta box.

          +
          + +
          +
          + $p_str_CallbackFunctionName + : string +
          +
          +

          Class method name for callback.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

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

          +
          + + +
          +
          +

          + addNewline() + +

          + + +

          Returns a line break to start a new line.

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

          Stefan Herndler

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

          + addNumBox() + +

          + + +

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

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

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

          +
          + +
          +
          + $p_in_Min + : int +
          +
          +

          Minimum value.

          +
          + +
          +
          + $p_int_Max + : int +
          +
          +

          Maximum value.

          +
          + +
          +
          + $p_bool_Deci + : bool + = false
          +
          +

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + since +
          +
          + 2.1.4 + +

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

          +
          + +
          +
          + +
          Return values
          + string + — +

          Edited:

          +
          + + +
          +
          +

          + addSection() + +

          + + +

          Returns an array describing a sub page section.

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

          Unique ID suffix.

          +
          + +
          +
          + $p_str_Title + : string +
          +
          +

          Title of the section.

          +
          + +
          +
          + $p_int_SettingsContainerIndex + : int +
          +
          +

          Settings Container Index.

          +
          + +
          +
          + $p_bool_hasSubmitButton + : bool + = true
          +
          +

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          Array describing the section.

          +
          + + +
          +
          +

          + addSelectBox() + +

          + + +

          Returns the html tag for a select box.

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

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

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

          Possible options to be selected.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          + addText() + +

          + + +

          Returns a simple text inside html <span> text.

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

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          + addTextArea() + +

          + + +

          Returns the html tag for a text area.

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

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

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          + addTextBox() + +

          + + +

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

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

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

          +
          + +
          +
          + $p_str_MaxLength + : int + = 999
          +
          +

          Maximum length of the input, default 999 characters.

          +
          + +
          +
          + $p_bool_Readonly + : bool + = false
          +
          +

          Set the input to be read only, default false.

          +
          + +
          +
          + $p_bool_Hidden + : bool + = false
          +
          +

          Set the input to be hidden, default false.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          + getMetaBoxes() + +

          + + +

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

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

          Stefan Herndler

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

          + getSections() + +

          + + +

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

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

          Stefan Herndler

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

          + getSubPageSlug() + +

          + + +

          Returns the unique slug of the sub page.

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

          Stefan Herndler

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

          + getSubPageTitle() + +

          + + +

          Returns the title of the sub page.

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

          Stefan Herndler

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

          + LoadSetting() + +

          + + +

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

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

          Settings Array key name.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

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

          Contains Settings ID, Settings Name and Settings Value.

          +
          + + +
          +
          +

          + appendScripts() + +

          + + +

          Append javascript and css files for specific sub page.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + registerMetaBoxes() + +

          + + +

          Registers all Meta boxes for a sub page.

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

          Parent section unique id.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + author +
          +
          + +

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + saveSettings() + +

          + + +

          Save all Plugin settings.

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

          Stefan Herndler

          +
          + +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + +
          Return values
          + bool + — +
          + + +
          +
          + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + diff --git a/docs/classes/MCI-Footnotes-Layout-Init.html b/docs/classes/MCI-Footnotes-Layout-Init.html new file mode 100644 index 0000000..0ec0d29 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Layout-Init.html @@ -0,0 +1,759 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
            +

            Documentation

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

            + MCI_Footnotes_Layout_Init + + + + +

            + + + +

            Handles the Settings interface of the Plugin.

            + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + + + + + + +

            + Table of Contents + +

            + +
            +
            + C_STR_MAIN_MENU_SLUG + +  = "mfmmf" +
            +
            Slug for the Plugin main menu.
            + +
            + C_STR_MAIN_MENU_TITLE + +  = "ManFisher" +
            +
            Plugin main menu name.
            + +
            + $a_arr_SubPageClasses + +  : array<string|int, mixed> +
            +
            + +
            + __construct() + +  : mixed +
            +
            Class Constructor. Initializes all WordPress hooks for the Plugin Settings.
            + +
            + displayOtherPlugins() + +  : mixed +
            +
            Displays other Plugins from the developers.
            + +
            + getPluginMetaInformation() + +  : mixed +
            +
            AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.
            + +
            + initializeSettings() + +  : mixed +
            +
            Initializes all sub pages and registers the settings.
            + +
            + registerMainMenu() + +  : mixed +
            +
            Registers the new main menu for the WordPress dashboard.
            + +
            + registerSubPages() + +  : mixed +
            +
            Registers all SubPages for this Plugin.
            + +
            + + + + +
            +

            + Constants + +

            +
            +

            + C_STR_MAIN_MENU_SLUG + +

            + + + +

            Slug for the Plugin main menu.

            + + + public + string + C_STR_MAIN_MENU_SLUG + = "mfmmf" + + + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            +

            + C_STR_MAIN_MENU_TITLE + +

            + + + +

            Plugin main menu name.

            + + + public + string + C_STR_MAIN_MENU_TITLE + = "ManFisher" + + + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            + + +
            +

            + Properties + +

            +
            +

            + $a_arr_SubPageClasses + + + +

            + + + + + private + array<string|int, mixed> + $a_arr_SubPageClasses + = array() + +
            + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            +
            + +
            +

            + Methods + +

            +
            +

            + __construct() + +

            + + +

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

            + + + public + __construct() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + displayOtherPlugins() + +

            + + +

            Displays other Plugins from the developers.

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

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + getPluginMetaInformation() + +

            + + +

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

            + + + public + getPluginMetaInformation() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + initializeSettings() + +

            + + +

            Initializes all sub pages and registers the settings.

            + + + public + initializeSettings() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + registerMainMenu() + +

            + + +

            Registers the new main menu for the WordPress dashboard.

            + + + public + registerMainMenu() : mixed + +

            Registers all sub menu pages for the new main menu.

            +
            + + + +
            + Tags + +
            +
            +
            + author +
            +
            + +

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + see +
            +
            + http://codex.wordpress.org/Function_Reference/add_menu_page + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            +

            + registerSubPages() + +

            + + +

            Registers all SubPages for this Plugin.

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

            Stefan Herndler

            +
            + +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + diff --git a/docs/classes/MCI-Footnotes-Layout-Settings.html b/docs/classes/MCI-Footnotes-Layout-Settings.html new file mode 100644 index 0000000..5b4da79 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Layout-Settings.html @@ -0,0 +1,3757 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
              +

              Documentation

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

              + MCI_Footnotes_Layout_Settings + + + extends MCI_Footnotes_LayoutEngine + + + + +

              + + + +

              Displays and handles all Settings of the Plugin.

              + +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + + + + + + +

              + Table of Contents + +

              + +
              +
              + $a_arr_Sections + +  : array<string|int, mixed> +
              +
              Stores all Sections for the child sub page.
              + +
              + $a_str_SubPageHook + +  : null|string +
              +
              Stores the Hook connection string for the child sub page.
              + +
              + CustomCSS() + +  : mixed +
              +
              Displays the custom css box.
              + +
              + CustomCSSMigration() + +  : mixed +
              +
              + +
              + CustomCSSNew() + +  : mixed +
              +
              + +
              + Description() + +  : mixed +
              +
              Output the Description of a section. May be overwritten in any section.
              + +
              + displayContent() + +  : mixed +
              +
              Displays the content of specific sub page.
              + +
              + Donate() + +  : mixed +
              +
              Displays all Donate button to support the developers.
              + +
              + Excerpts() + +  : mixed +
              +
              Displays the excerpt setting
              + +
              + getPriority() + +  : int +
              +
              Returns a Priority index. Lower numbers have a higher Priority.
              + +
              + Help() + +  : mixed +
              +
              Displays a short introduction of the Plugin.
              + +
              + HyperlinkArrow() + +  : mixed +
              +
              Displays all settings for the prepended symbol
              + +
              + LookupHooks() + +  : mixed +
              +
              Displays available Hooks to look for Footnote short codes.
              + +
              + Love() + +  : mixed +
              +
              Displays all settings for 'I love Footnotes'.
              + +
              + MouseOverBox() + +  : mixed +
              +
              Displays all settings for the footnotes mouse-over box.
              + +
              + MouseOverBoxAppearance() + +  : mixed +
              +
              + +
              + MouseOverBoxDimensions() + +  : mixed +
              +
              + +
              + MouseOverBoxPosition() + +  : mixed +
              +
              + +
              + MouseOverBoxText() + +  : mixed +
              +
              + +
              + MouseOverBoxTiming() + +  : mixed +
              +
              + +
              + MouseOverBoxTruncation() + +  : mixed +
              +
              + +
              + Numbering() + +  : mixed +
              +
              + +
              + ReferenceContainer() + +  : mixed +
              +
              Displays all settings for the reference container.
              + +
              + registerSections() + +  : mixed +
              +
              Registers all sections for a sub page.
              + +
              + registerSubPage() + +  : mixed +
              +
              Registers a sub page.
              + +
              + Scrolling() + +  : mixed +
              +
              + +
              + StartEnd() + +  : mixed +
              +
              Displays all options for the footnotes start and end tag short codes +Displays all options for the footnotes numbering +Displays all options for the scrolling behavior
              + +
              + Superscript() + +  : mixed +
              +
              Displays all settings for the footnote referrers
              + +
              + addCheckbox() + +  : string +
              +
              Returns the html tag for an input [type = checkbox].
              + +
              + addColorSelection() + +  : string +
              +
              Returns the html tag for an input [type = text] with color selection class.
              + +
              + addLabel() + +  : string +
              +
              Returns the html tag for an input/select label.
              + +
              + addLineSpace() + +  : string +
              +
              Returns a line break to have a space between two lines.
              + +
              + addMetaBox() + +  : array<string|int, mixed> +
              +
              Returns an array describing a meta box.
              + +
              + addNewline() + +  : string +
              +
              Returns a line break to start a new line.
              + +
              + addNumBox() + +  : string +
              +
              Returns the html tag for an input [type = num].
              + +
              + addSection() + +  : array<string|int, mixed> +
              +
              Returns an array describing a sub page section.
              + +
              + addSelectBox() + +  : string +
              +
              Returns the html tag for a select box.
              + +
              + addText() + +  : string +
              +
              Returns a simple text inside html <span> text.
              + +
              + addTextArea() + +  : string +
              +
              Returns the html tag for a text area.
              + +
              + addTextBox() + +  : string +
              +
              Returns the html tag for an input [type = text].
              + +
              + getMetaBoxes() + +  : array<string|int, mixed> +
              +
              Returns an array of all registered meta boxes for each section of the sub page.
              + +
              + getSections() + +  : array<string|int, mixed> +
              +
              Returns an array of all registered sections for the sub page.
              + +
              + getSubPageSlug() + +  : string +
              +
              Returns the unique slug of the sub page.
              + +
              + getSubPageTitle() + +  : string +
              +
              Returns the title of the sub page.
              + +
              + LoadSetting() + +  : array<string|int, mixed> +
              +
              Loads specific setting and returns an array with the keys [id, name, value].
              + +
              + appendScripts() + +  : mixed +
              +
              Append javascript and css files for specific sub page.
              + +
              + registerMetaBoxes() + +  : mixed +
              +
              Registers all Meta boxes for a sub page.
              + +
              + saveSettings() + +  : bool +
              +
              Save all Plugin settings.
              + +
              + + + + + + +
              +

              + Properties + +

              +
              +

              + $a_arr_Sections + + + +

              + + +

              Stores all Sections for the child sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              +
              +

              + $a_str_SubPageHook + + + +

              + + +

              Stores the Hook connection string for the child sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              +
              + +
              +

              + Methods + +

              +
              +

              + CustomCSS() + +

              + + +

              Displays the custom css box.

              + + + public + CustomCSS() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              drop localized notices for CSS classes as the number increased to 16 +list directly in the template, as CSS is in English anyway

              +
              + +
              +
              + since +
              +
              + 2.2.2 + +

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

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

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

              +
              + +
              +
              + since +
              +
              + 2.5.1 + +

              mention validity while visible, thanks to @rkupadhya bug report

              +
              + +
              +
              + see +
              +
              + +

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

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

              + CustomCSSMigration() + +

              + + + + + public + CustomCSSMigration() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + CustomCSSNew() + +

              + + + + + public + CustomCSSNew() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Description() + +

              + + +

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

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + displayContent() + +

              + + +

              Displays the content of specific sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Donate() + +

              + + +

              Displays all Donate button to support the developers.

              + + + public + Donate() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Excerpts() + +

              + + +

              Displays the excerpt setting

              + + + public + Excerpts() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1453+0100

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

              more settings and notices, thanks to @nikelaos

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

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

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/jquery-comes-up-in-feed-content/#post-13110879 + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + getPriority() + +

              + + +

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

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + int + — +
              + + +
              +
              +

              + Help() + +

              + + +

              Displays a short introduction of the Plugin.

              + + + public + Help() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + HyperlinkArrow() + +

              + + +

              Displays all settings for the prepended symbol

              + + + public + HyperlinkArrow() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading for v2.0.4

              +

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

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

              moved to Settings > Reference container > Display a backlink symbol

              +
              + +
              +
              + since +
              +
              + 2.2.1 + +

              and 2.2.4 back here

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

              + LookupHooks() + +

              + + +

              Displays available Hooks to look for Footnote short codes.

              + + + public + LookupHooks() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.5 + +

              Edited:

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

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

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

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

              +

              priority level was initially hard-coded default +shows "9223372036854775807" in the numbox +empty should be interpreted as PHP_INT_MAX, +but a numbox cannot be set to empty: https://github.com/Modernizr/Modernizr/issues/171 +define -1 as PHP_INT_MAX instead

              +
              + +
              +
              + since +
              +
              + 2.2.9 + +

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

              +
              + +
              +
              + since +
              +
              + 2.2.9 + +

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

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

              + Love() + +

              + + +

              Displays all settings for 'I love Footnotes'.

              + + + public + Love() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

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

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              more options 2020-12-11T0432+0100

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

              + MouseOverBox() + +

              + + +

              Displays all settings for the footnotes mouse-over box.

              + + + public + MouseOverBox() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.2 + +

              Edited:

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

              5 parts to address increased settings number

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

              position settings for alternative tooltips

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

              + MouseOverBoxAppearance() + +

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

              + MouseOverBoxDimensions() + +

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

              + MouseOverBoxPosition() + +

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

              + MouseOverBoxText() + +

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

              + MouseOverBoxTiming() + +

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

              + MouseOverBoxTruncation() + +

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

              + Numbering() + +

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

              + ReferenceContainer() + +

              + + +

              Displays all settings for the reference container.

              + + + public + ReferenceContainer() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Completed:

              +
              + +
              +
              + since +
              +
              + 2.1.4: + +

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

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

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

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/how-do-i-eliminate-the-horizontal-line-beneath-the-reference-container-heading/ + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerSections() + +

              + + +

              Registers all sections for a sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerSubPage() + +

              + + +

              Registers a sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Scrolling() + +

              + + + + + public + Scrolling() : mixed + + + + + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + StartEnd() + +

              + + +

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

              + + + public + StartEnd() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1412+0100

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

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

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

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

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

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

              +
              + +
              +
              + since +
              +
              + 2.4.0 + +

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

              +
              + +
              +
              + since +
              +
              + 2.4.0 + +

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

              +
              + +
              +
              + since +
              +
              + 2.5.0 + +

              Shortcode syntax validation: add more information around the setting, thanks to @andreasra

              +
              + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/doesnt-work-with-mailpoet/ + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/add-support-for-ibid-notation/ + +
              +
              + link +
              +
              + https://wordpress.org/support/topic/warning-unbalanced-footnote-start-tag-short-code-before/ + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + Superscript() + +

              + + +

              Displays all settings for the footnote referrers

              + + + public + Superscript() : mixed + +
              + + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +

              Edited heading 2020-12-12T1513+0100

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

              option for superscript (optionally baseline referrers)

              +
              + +
              +
              + since +
              +
              + 2.2.0 + +

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

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

              + addCheckbox() + +

              + + +

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

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

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              + addColorSelection() + +

              + + +

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

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

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.6 + +
              + +
              +
              + +
              Return values
              + string + — +
              + + +
              +
              +

              + addLabel() + +

              + + +

              Returns the html tag for an input/select label.

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

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

              +
              + +
              +
              + $p_str_Caption + : string +
              +
              +

              Label caption.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              no colon

              +
              + +
              +
              + +
              Return values
              + string + — +

              Edited 2020-12-01T0159+0100..

              +
              + + +
              +
              +

              + addLineSpace() + +

              + + +

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

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

              Stefan Herndler

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

              + addMetaBox() + +

              + + +

              Returns an array describing a meta box.

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

              Parent Section ID.

              +
              + +
              +
              + $p_str_ID + : string +
              +
              +

              Unique ID suffix.

              +
              + +
              +
              + $p_str_Title + : string +
              +
              +

              Title for the meta box.

              +
              + +
              +
              + $p_str_CallbackFunctionName + : string +
              +
              +

              Class method name for callback.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

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

              +
              + + +
              +
              +

              + addNewline() + +

              + + +

              Returns a line break to start a new line.

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

              Stefan Herndler

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

              + addNumBox() + +

              + + +

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

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

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

              +
              + +
              +
              + $p_in_Min + : int +
              +
              +

              Minimum value.

              +
              + +
              +
              + $p_int_Max + : int +
              +
              +

              Maximum value.

              +
              + +
              +
              + $p_bool_Deci + : bool + = false
              +
              +

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.4 + +

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

              +
              + +
              +
              + +
              Return values
              + string + — +

              Edited:

              +
              + + +
              +
              +

              + addSection() + +

              + + +

              Returns an array describing a sub page section.

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

              Unique ID suffix.

              +
              + +
              +
              + $p_str_Title + : string +
              +
              +

              Title of the section.

              +
              + +
              +
              + $p_int_SettingsContainerIndex + : int +
              +
              +

              Settings Container Index.

              +
              + +
              +
              + $p_bool_hasSubmitButton + : bool + = true
              +
              +

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              Array describing the section.

              +
              + + +
              +
              +

              + addSelectBox() + +

              + + +

              Returns the html tag for a select box.

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

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

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

              Possible options to be selected.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              + addText() + +

              + + +

              Returns a simple text inside html <span> text.

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

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              + addTextArea() + +

              + + +

              Returns the html tag for a text area.

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

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

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              + addTextBox() + +

              + + +

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

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

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

              +
              + +
              +
              + $p_str_MaxLength + : int + = 999
              +
              +

              Maximum length of the input, default 999 characters.

              +
              + +
              +
              + $p_bool_Readonly + : bool + = false
              +
              +

              Set the input to be read only, default false.

              +
              + +
              +
              + $p_bool_Hidden + : bool + = false
              +
              +

              Set the input to be hidden, default false.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              + getMetaBoxes() + +

              + + +

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

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.0.0 + +

              discontinued

              +
              + +
              +
              + since +
              +
              + 2.0.4 + +

              restored to meet user demand for arrow symbol semantics

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

              discontinued, content moved to Settings > Reference container > Display a backlink symbol

              +
              + +
              +
              + since +
              +
              + 2.0.4 + +

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

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              / 2.2.0 tabs reordered and renamed

              +
              + +
              +
              + see +
              +
              + details + +

              in class/config.php

              +
              + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Edited for 2.0.0 and later.

              +

              HyperlinkArrow meta box:

              +
              + + +
              +
              +

              + getSections() + +

              + + +

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

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              tabs reordered and renamed

              +
              + +
              +
              + since +
              +
              + 2.1.6 + +

              removed if statement around expert tab

              +
              + +
              +
              + link +
              +
              + https://www.linkedin.com/pulse/20140610191154-4746170-configuration-vs-customization-when-and-why-would-i-implement-each + +
              +
              + +
              Return values
              + array<string|int, mixed> + — +

              Edited:

              +
              + + +
              +
              +

              + getSubPageSlug() + +

              + + +

              Returns the unique slug of the sub page.

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

              Stefan Herndler

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

              + getSubPageTitle() + +

              + + +

              Returns the title of the sub page.

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

              Stefan Herndler

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

              + LoadSetting() + +

              + + +

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

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

              Settings Array key name.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

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

              Contains Settings ID, Settings Name and Settings Value.

              +
              + + +
              +
              +

              + appendScripts() + +

              + + +

              Append javascript and css files for specific sub page.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + registerMetaBoxes() + +

              + + +

              Registers all Meta boxes for a sub page.

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

              Parent section unique id.

              +
              + +
              +
              + + +
              + Tags + +
              +
              +
              + author +
              +
              + +

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + saveSettings() + +

              + + +

              Save all Plugin settings.

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

              Stefan Herndler

              +
              + +
              +
              + since +
              +
              + 1.5.0 + +
              + +
              +
              + +
              Return values
              + bool + — +
              + + +
              +
              + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + diff --git a/docs/classes/MCI-Footnotes-LayoutEngine.html b/docs/classes/MCI-Footnotes-LayoutEngine.html new file mode 100644 index 0000000..ff9e0f2 --- /dev/null +++ b/docs/classes/MCI-Footnotes-LayoutEngine.html @@ -0,0 +1,2222 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                +

                Documentation

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

                + MCI_Footnotes_LayoutEngine + + + + +

                + + + +

                Layout Engine for the administration dashboard.

                + +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + + + + + + +

                + Table of Contents + +

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

                + Properties + +

                +
                +

                + $a_arr_Sections + + + +

                + + +

                Stores all Sections for the child sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                +
                +

                + $a_str_SubPageHook + + + +

                + + +

                Stores the Hook connection string for the child sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                +
                + +
                +

                + Methods + +

                +
                +

                + Description() + +

                + + +

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

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + displayContent() + +

                + + +

                Displays the content of specific sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + getPriority() + +

                + + +

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

                + + + public + abstract getPriority() : int + +
                + + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + int + — +
                + + +
                +
                +

                + registerSections() + +

                + + +

                Registers all sections for a sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + registerSubPage() + +

                + + +

                Registers a sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + addCheckbox() + +

                + + +

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

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

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                + addColorSelection() + +

                + + +

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

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

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.6 + +
                + +
                +
                + +
                Return values
                + string + — +
                + + +
                +
                +

                + addLabel() + +

                + + +

                Returns the html tag for an input/select label.

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

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

                +
                + +
                +
                + $p_str_Caption + : string +
                +
                +

                Label caption.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + since +
                +
                + 2.1.6 + +

                no colon

                +
                + +
                +
                + +
                Return values
                + string + — +

                Edited 2020-12-01T0159+0100..

                +
                + + +
                +
                +

                + addLineSpace() + +

                + + +

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

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

                Stefan Herndler

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

                + addMetaBox() + +

                + + +

                Returns an array describing a meta box.

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

                Parent Section ID.

                +
                + +
                +
                + $p_str_ID + : string +
                +
                +

                Unique ID suffix.

                +
                + +
                +
                + $p_str_Title + : string +
                +
                +

                Title for the meta box.

                +
                + +
                +
                + $p_str_CallbackFunctionName + : string +
                +
                +

                Class method name for callback.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

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

                +
                + + +
                +
                +

                + addNewline() + +

                + + +

                Returns a line break to start a new line.

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

                Stefan Herndler

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

                + addNumBox() + +

                + + +

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

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

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

                +
                + +
                +
                + $p_in_Min + : int +
                +
                +

                Minimum value.

                +
                + +
                +
                + $p_int_Max + : int +
                +
                +

                Maximum value.

                +
                + +
                +
                + $p_bool_Deci + : bool + = false
                +
                +

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + since +
                +
                + 2.1.4 + +

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

                +
                + +
                +
                + +
                Return values
                + string + — +

                Edited:

                +
                + + +
                +
                +

                + addSection() + +

                + + +

                Returns an array describing a sub page section.

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

                Unique ID suffix.

                +
                + +
                +
                + $p_str_Title + : string +
                +
                +

                Title of the section.

                +
                + +
                +
                + $p_int_SettingsContainerIndex + : int +
                +
                +

                Settings Container Index.

                +
                + +
                +
                + $p_bool_hasSubmitButton + : bool + = true
                +
                +

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                Array describing the section.

                +
                + + +
                +
                +

                + addSelectBox() + +

                + + +

                Returns the html tag for a select box.

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

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

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

                Possible options to be selected.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                + addText() + +

                + + +

                Returns a simple text inside html <span> text.

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

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                + addTextArea() + +

                + + +

                Returns the html tag for a text area.

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

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

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                + addTextBox() + +

                + + +

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

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

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

                +
                + +
                +
                + $p_str_MaxLength + : int + = 999
                +
                +

                Maximum length of the input, default 999 characters.

                +
                + +
                +
                + $p_bool_Readonly + : bool + = false
                +
                +

                Set the input to be read only, default false.

                +
                + +
                +
                + $p_bool_Hidden + : bool + = false
                +
                +

                Set the input to be hidden, default false.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                + getMetaBoxes() + +

                + + +

                Returns an array of all registered meta boxes.

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

                Stefan Herndler

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

                + getSections() + +

                + + +

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

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

                Stefan Herndler

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

                + getSubPageSlug() + +

                + + +

                Returns the unique slug of the child sub page.

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

                Stefan Herndler

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

                + getSubPageTitle() + +

                + + +

                Returns the title of the child sub page.

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

                Stefan Herndler

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

                + LoadSetting() + +

                + + +

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

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

                Settings Array key name.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

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

                Contains Settings ID, Settings Name and Settings Value.

                +
                + + +
                +
                +

                + appendScripts() + +

                + + +

                Append javascript and css files for specific sub page.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + registerMetaBoxes() + +

                + + +

                Registers all Meta boxes for a sub page.

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

                Parent section unique id.

                +
                + +
                +
                + + +
                + Tags + +
                +
                +
                + author +
                +
                + +

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + mixed + — +
                + + +
                +
                +

                + saveSettings() + +

                + + +

                Save all Plugin settings.

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

                Stefan Herndler

                +
                + +
                +
                + since +
                +
                + 1.5.0 + +
                + +
                +
                + +
                Return values
                + bool + — +
                + + +
                +
                + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + diff --git a/docs/classes/MCI-Footnotes-Settings.html b/docs/classes/MCI-Footnotes-Settings.html new file mode 100644 index 0000000..e436525 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Settings.html @@ -0,0 +1,6221 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                  +

                  Documentation

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

                  + MCI_Footnotes_Settings + + + + +

                  + + + +

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

                  + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + + + + + + +

                  + Table of Contents + +

                  + +
                  +
                  + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + +  = "footnotes_inputfield_backlinks_column_max_width_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + +  = "footnotes_inputfield_backlinks_column_width_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + +  = "footnotes_inputfield_backlinks_line_breaks_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + +  = "footnotes_inputfield_backlinks_separator_enabled" +
                  +
                  + +
                  + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + +  = "footnotes_inputfield_backlinks_terminator_enabled" +
                  +
                  + +
                  + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + +  = "footnote_inputfield_combine_identical" +
                  +
                  Settings Container Key for combining identical footnotes.
                  + +
                  + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + +  = "footnote_inputfield_custom_css_legacy_enable" +
                  +
                  Settings Container Key to enable display of legacy Custom CSS metaboxes.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + +  = "footnote_inputfield_expert_lookup_the_content" +
                  +
                  Settings Container Key to enable the 'the_content' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + +  = "footnote_inputfield_expert_lookup_the_excerpt" +
                  +
                  Settings Container Key to enable the 'the_excerpt' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_THE_TITLE + +  = "footnote_inputfield_expert_lookup_the_title" +
                  +
                  Settings Container Key to enable the 'the_title' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + +  = "footnote_inputfield_expert_lookup_widget_text" +
                  +
                  Settings Container Key to enable the 'widget_text' hook.
                  + +
                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + +  = "footnote_inputfield_expert_lookup_widget_title" +
                  +
                  Settings Container Key to enable the 'widget_title' hook.
                  + +
                  + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + +  = "footnotes_inputfield_shortcode_syntax_validation_enable" +
                  +
                  Settings container key for shortcode syntax validation.
                  + +
                  + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + +  = "footnote_inputfield_url_wrap_enabled" +
                  +
                  Settings Container Key for URL wrap option
                  + +
                  + C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + +  = "footnotes_inputfield_backlink_tooltip_enable" +
                  +
                  Settings container key to enable backlink tooltips.
                  + +
                  + C_BOOL_FOOTNOTES_EXPERT_MODE + +  = "footnote_inputfield_enable_expert_mode" +
                  +
                  Settings Container Key for the Expert mode.
                  + +
                  + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + +  = "footnotes_inputfield_hard_links_enable" +
                  +
                  + +
                  + C_BOOL_FOOTNOTES_IN_EXCERPT + +  = "footnote_inputfield_search_in_excerpt" +
                  +
                  Settings Container Key to look for footnotes in post excerpts.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + +  = "footnote_inputfield_custom_mouse_over_box_alternative" +
                  +
                  Settings Container Key to enable the alternative tooltips.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + +  = "footnote_inputfield_custom_mouse_over_box_enabled" +
                  +
                  Settings Container Key to enable the mouse-over box.
                  + +
                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + +  = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled" +
                  +
                  Settings Container Key to enable tooltip truncation.
                  + +
                  + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + +  = "footnotes_inputfield_referrer_superscript_tags" +
                  +
                  Settings Container Key for the referrer element.
                  + +
                  + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + +  = "footnotes_inputfield_tooltip_excerpt_mirror_enable" +
                  +
                  Settings container key to enable mirroring the tooltip excerpt in the reference container.
                  + +
                  + C_BOOL_LINK_ELEMENT_ENABLED + +  = "footnote_inputfield_link_element_enabled" +
                  +
                  Settings Container Keys for the link element option +Settings Container Keys for backlink typography and layout +Settings Container Keys for tooltip font size +Settings Container Keys for page layout support +Settings Container Keys for scroll offset and duration +Settings Container Keys for tooltip display durations
                  + +
                  + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + +  = "footnotes_inputfield_mouse_over_box_font_size_enabled" +
                  +
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + +  = "footnotes_inputfield_reference_container_3column_layout_enable" +
                  +
                  Settings Container Key to enable the legacy layout of the reference container.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + +  = "footnotes_inputfield_reference_container_backlink_symbol_enable" +
                  +
                  Settings Container Key to enable the display of a backlink symbol.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + +  = "footnotes_inputfield_reference_container_backlink_symbol_switch" +
                  +
                  Settings Container Key to get the backlink symbol switch side.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_COLLAPSE + +  = "footnote_inputfield_collapse_references" +
                  +
                  Settings Container Key to collapse the reference container by default.
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + +  = "footnotes_inputfield_reference_container_label_bottom_border" +
                  +
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + +  = "footnotes_inputfield_reference_container_row_borders_enable" +
                  +
                  Settings Container Key for table cell borders, thanks to @noobishh
                  + +
                  + C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE + +  = "footnotes_inputfield_reference_container_start_page_enable" +
                  +
                  Settings Container Key to not display the reference container on the homepage.
                  + +
                  + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + +  = "footnotes_inputfield_mouse_over_box_font_size_scalar" +
                  +
                  + +
                  + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + +  = "footnotes_inputfield_backlinks_column_max_width_scalar" +
                  +
                  + +
                  + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + +  = "footnotes_inputfield_backlinks_column_width_scalar" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_content_priority_level" +
                  +
                  Settings Container Key for 'the_content' hook priority level.
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_excerpt_priority_level" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_the_title_priority_level" +
                  +
                  Settings Container Key for '' hook priority level
                  + +
                  + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_widget_text_priority_level" +
                  +
                  + +
                  + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + +  = "footnote_inputfield_expert_lookup_widget_title_priority_level" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + +  = "footnotes_inputfield_alternative_mouse_over_box_offset_x" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + +  = "footnotes_inputfield_alternative_mouse_over_box_offset_y" +
                  +
                  + +
                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + +  = "footnotes_inputfield_alternative_mouse_over_box_width" +
                  +
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS + +  = "footnote_inputfield_custom_mouse_over_box_border_radius" +
                  +
                  Settings Container Key for the mouse-over box to define the border radius.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH + +  = "footnote_inputfield_custom_mouse_over_box_border_width" +
                  +
                  Settings Container Key for the mouse-over box to define the border width.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH + +  = "footnote_inputfield_custom_mouse_over_box_excerpt_length" +
                  +
                  Settings Container Key for the mouse-over box to define the max. length of the enabled excerpt.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH + +  = "footnote_inputfield_custom_mouse_over_box_max_width" +
                  +
                  Settings Container Key for the mouse-over box to define the max. width.
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X + +  = "footnote_inputfield_custom_mouse_over_box_offset_x" +
                  +
                  Settings Container Key for the mouse-over box to define the offset (x).
                  + +
                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y + +  = "footnote_inputfield_custom_mouse_over_box_offset_y" +
                  +
                  Settings Container Key for the mouse-over box to define the offset (y).
                  + +
                  + C_INT_FOOTNOTES_SCROLL_DURATION + +  = "footnotes_inputfield_scroll_duration" +
                  +
                  + +
                  + C_INT_FOOTNOTES_SCROLL_OFFSET + +  = "footnotes_inputfield_scroll_offset" +
                  +
                  Scroll offset and duration
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + +  = "footnotes_inputfield_mouse_over_box_fade_in_delay" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + +  = "footnotes_inputfield_mouse_over_box_fade_in_duration" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + +  = "footnotes_inputfield_mouse_over_box_fade_out_delay" +
                  +
                  + +
                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + +  = "footnotes_inputfield_mouse_over_box_fade_out_duration" +
                  +
                  + +
                  + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + +  = "footnotes_inputfield_reference_container_bottom_margin" +
                  +
                  + +
                  + C_INT_REFERENCE_CONTAINER_TOP_MARGIN + +  = "footnotes_inputfield_reference_container_top_margin" +
                  +
                  Settings container keys for reference container top and bottom margins +Settings container keys for hard link enabling +Settings container keys for hard link anchors in referrers and footnotes
                  + +
                  + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + +  = "footnotes_inputfield_backlinks_column_max_width_unit" +
                  +
                  + +
                  + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + +  = "footnotes_inputfield_backlinks_column_width_unit" +
                  +
                  + +
                  + C_STR_BACKLINKS_SEPARATOR_CUSTOM + +  = "footnotes_inputfield_backlinks_separator_custom" +
                  +
                  + +
                  + C_STR_BACKLINKS_SEPARATOR_OPTION + +  = "footnotes_inputfield_backlinks_separator_option" +
                  +
                  + +
                  + C_STR_BACKLINKS_TERMINATOR_CUSTOM + +  = "footnotes_inputfield_backlinks_terminator_custom" +
                  +
                  + +
                  + C_STR_BACKLINKS_TERMINATOR_OPTION + +  = "footnotes_inputfield_backlinks_terminator_option" +
                  +
                  + +
                  + C_STR_CUSTOM_CSS + +  = "footnote_inputfield_custom_css" +
                  +
                  Settings Container Key for the Custom CSS.
                  + +
                  + C_STR_CUSTOM_CSS_NEW + +  = "footnote_inputfield_custom_css_new" +
                  +
                  Settings Container Key for the Custom CSS migrated to a dedicated tab.
                  + +
                  + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + +  = "footnotes_inputfield_footnote_fragment_id_slug" +
                  +
                  + +
                  + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + +  = "footnotes_inputfield_referrers_normal_superscript" +
                  +
                  Settings container key to enable superscript style normalization.
                  + +
                  + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + +  = "footnotes_inputfield_alternative_mouse_over_box_position" +
                  +
                  Settings Container Keys for alternative tooltip position +Settings Container Keys for reference container label element, thanks to @markhillyer
                  + +
                  + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + +  = "footnotes_inputfield_backlink_tooltip_text" +
                  +
                  Settings container key to configure the backlink tooltip.
                  + +
                  + C_STR_FOOTNOTES_COUNTER_STYLE + +  = "footnote_inputfield_counter_style" +
                  +
                  Settings Container Key for the counter style of the footnotes.
                  + +
                  + C_STR_FOOTNOTES_LOVE + +  = "footnote_inputfield_love" +
                  +
                  Settings Container Key for the 'I love footnotes' text.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + +  = "footnote_inputfield_custom_mouse_over_box_background" +
                  +
                  Settings Container Key for the mouse-over box to define the background color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_border_color" +
                  +
                  Settings Container Key for the mouse-over box to define the border color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_color" +
                  +
                  Settings Container Key for the mouse-over box to define the color.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + +  = "footnote_inputfield_custom_mouse_over_box_position" +
                  +
                  Settings Container Key for the mouse-over box to define the position.
                  + +
                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + +  = "footnote_inputfield_custom_mouse_over_box_shadow_color" +
                  +
                  Settings Container Key for the mouse-over box to define the box-shadow color.
                  + +
                  + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + +  = "footnotes_inputfield_page_layout_support" +
                  +
                  + +
                  + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + +  = "footnotes_inputfield_reference_container_script_mode" +
                  +
                  Settings container key to select the script mode for the reference container.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_END + +  = "footnote_inputfield_placeholder_end" +
                  +
                  Settings Container Key for the short code of the footnote’s end.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + +  = "footnote_inputfield_placeholder_end_user_defined" +
                  +
                  Settings Container Key for the user-defined short code of the footnotes end.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_START + +  = "footnote_inputfield_placeholder_start" +
                  +
                  Settings Container Key for the short code of the footnote’s start.
                  + +
                  + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + +  = "footnote_inputfield_placeholder_start_user_defined" +
                  +
                  Settings Container Key for the user-defined short code of the footnotes start.
                  + +
                  + C_STR_FOOTNOTES_STYLING_AFTER + +  = "footnote_inputfield_custom_styling_after" +
                  +
                  Settings Container Key for the string after the footnote referrer.
                  + +
                  + C_STR_FOOTNOTES_STYLING_BEFORE + +  = "footnote_inputfield_custom_styling_before" +
                  +
                  Settings Container Key for the string before the footnote referrer.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + +  = "footnotes_inputfield_tooltip_excerpt_delimiter" +
                  +
                  Settings container key to configure the tooltip excerpt delimiter.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + +  = "footnotes_inputfield_tooltip_excerpt_mirror_separator" +
                  +
                  Settings container key to configure the tooltip excerpt separator in the reference container.
                  + +
                  + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + +  = "footnote_inputfield_readon_label" +
                  +
                  Settings Container Key for the label of the Read-on button in truncated tooltips.
                  + +
                  + C_STR_HARD_LINK_IDS_SEPARATOR + +  = "footnotes_inputfield_hard_link_ids_separator" +
                  +
                  + +
                  + C_STR_HYPERLINK_ARROW + +  = "footnote_inputfield_custom_hyperlink_symbol" +
                  +
                  Settings Container Key for the backlink symbol selection.
                  + +
                  + C_STR_HYPERLINK_ARROW_USER_DEFINED + +  = "footnote_inputfield_custom_hyperlink_symbol_user" +
                  +
                  Settings Container Key for the user-defined backlink symbol.
                  + +
                  + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + +  = "footnotes_inputfield_mouse_over_box_font_size_unit" +
                  +
                  + +
                  + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + +  = "footnotes_inputfield_reference_container_label_element" +
                  +
                  + +
                  + C_STR_REFERENCE_CONTAINER_NAME + +  = "footnote_inputfield_references_label" +
                  +
                  Settings Container Key for the label of the reference container.
                  + +
                  + C_STR_REFERENCE_CONTAINER_POSITION + +  = "footnote_inputfield_reference_container_place" +
                  +
                  Settings Container Key for the position of the reference container.
                  + +
                  + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + +  = "footnote_inputfield_reference_container_position_shortcode" +
                  +
                  Settings Container Key for reference container position shortcode
                  + +
                  + C_STR_REFERRER_FRAGMENT_ID_SLUG + +  = "footnotes_inputfield_referrer_fragment_id_slug" +
                  +
                  + +
                  + $a_arr_Container + +  : array<string|int, mixed> +
                  +
                  Contains all Settings Container names.
                  + +
                  + $a_arr_Default + +  : array<string|int, mixed> +
                  +
                  Contains all Default Settings for each Settings Container.
                  + +
                  + $a_arr_Settings + +  : array<string|int, mixed> +
                  +
                  Contains all Settings from each Settings container as soon as this class is initialized.
                  + +
                  + $a_obj_Instance + +  : MCI_Footnotes_Settings +
                  +
                  Stores a singleton reference of this class.
                  + +
                  + ClearAll() + +  : mixed +
                  +
                  Deletes each Settings Container and loads the default values for each Settings Container.
                  + +
                  + get() + +  : mixed +
                  +
                  Returns the value of specified Settings name.
                  + +
                  + getContainer() + +  : str +
                  +
                  Returns the name of a specified Settings Container.
                  + +
                  + getDefaults() + +  : array<string|int, mixed> +
                  +
                  Returns the default values of a specific Settings Container.
                  + +
                  + instance() + +  : MCI_Footnotes_Settings +
                  +
                  Returns a singleton of this class.
                  + +
                  + RegisterSettings() + +  : mixed +
                  +
                  Register all Settings Container for the Plugin Settings Page in the Dashboard.
                  + +
                  + saveOptions() + +  : bool +
                  +
                  Updates a whole Settings container.
                  + +
                  + __construct() + +  : mixed +
                  +
                  Class Constructor. Loads all Settings from each WordPress Settings container.
                  + +
                  + Load() + +  : array<string|int, mixed> +
                  +
                  Loads all Settings from specified Settings Container.
                  + +
                  + loadAll() + +  : mixed +
                  +
                  Loads all Settings from each Settings container.
                  + +
                  + + + + +
                  +

                  + Constants + +

                  +
                  +

                  + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED + = "footnotes_inputfield_backlinks_column_max_width_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED + = "footnotes_inputfield_backlinks_column_width_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED + = "footnotes_inputfield_backlinks_line_breaks_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_SEPARATOR_ENABLED + = "footnotes_inputfield_backlinks_separator_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_BACKLINKS_TERMINATOR_ENABLED + = "footnotes_inputfield_backlinks_terminator_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + +

                  + + + +

                  Settings Container Key for combining identical footnotes.

                  + + + public + str + C_BOOL_COMBINE_IDENTICAL_FOOTNOTES + = "footnote_inputfield_combine_identical" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + +

                  + + + +

                  Settings Container Key to enable display of legacy Custom CSS metaboxes.

                  + + + public + str + C_BOOL_CUSTOM_CSS_LEGACY_ENABLE + = "footnote_inputfield_custom_css_legacy_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.2.2 + +
                  + +
                  +
                  + since +
                  +
                  + 2.3.0 + +

                  swap Boolean from 'migration complete' to 'show legacy'

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-15T0520+0100

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-27T1233+0100

                  +

                  The Boolean must be false if its setting is contained in the container to be hidden, +because when saving, all missing constants are emptied, and toBool() converts empty to false.

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + +

                  + + + +

                  Settings Container Key to enable the 'the_content' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_CONTENT + = "footnote_inputfield_expert_lookup_the_content" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + +

                  + + + +

                  Settings Container Key to enable the 'the_excerpt' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_EXCERPT + = "footnote_inputfield_expert_lookup_the_excerpt" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_THE_TITLE + +

                  + + + +

                  Settings Container Key to enable the 'the_title' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_THE_TITLE + = "footnote_inputfield_expert_lookup_the_title" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + +

                  + + + +

                  Settings Container Key to enable the 'widget_text' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT + = "footnote_inputfield_expert_lookup_widget_text" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + +

                  + + + +

                  Settings Container Key to enable the 'widget_title' hook.

                  + + + public + str + C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE + = "footnote_inputfield_expert_lookup_widget_title" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + +

                  + + + +

                  Settings container key for shortcode syntax validation.

                  + + + public + str + C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE + = "footnotes_inputfield_shortcode_syntax_validation_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.4.0 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2021-01-01T0616+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + +

                  + + + +

                  Settings Container Key for URL wrap option

                  + + + public + str + C_BOOL_FOOTNOTE_URL_WRAP_ENABLED + = "footnote_inputfield_url_wrap_enabled" + + + +

                  This is made optional because it causes weird line breaks. +Unicode-compliant browsers break URLs at slashes.

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE + +

                  + + + +

                  Settings container key to enable backlink tooltips.

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

                  @theroninjedi47

                  +
                  + +
                  +
                  + link +
                  +
                  +

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

                  +                   + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/making-it-amp-compatible/#post-13837359 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_EXPERT_MODE + +

                  + + + +

                  Settings Container Key for the Expert mode.

                  + + + public + str + C_BOOL_FOOTNOTES_EXPERT_MODE + = "footnote_inputfield_enable_expert_mode" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.5 + +
                  + +
                  +
                  + since +
                  +
                  + 2.1.6 + +

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

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-09T2107+0100

                  +

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

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + +

                  + + + + + + public + mixed + C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE + = "footnotes_inputfield_hard_links_enable" + + + + + + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_IN_EXCERPT + +

                  + + + +

                  Settings Container Key to look for footnotes in post excerpts.

                  + + + public + str + C_BOOL_FOOTNOTES_IN_EXCERPT + = "footnote_inputfield_search_in_excerpt" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + +

                  + + + +

                  Settings Container Key to enable the alternative tooltips.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE + = "footnote_inputfield_custom_mouse_over_box_alternative" + + + +
                    +
                  • Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-11T1817+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @andreasra

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

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + +

                  + + + +

                  Settings Container Key to enable the mouse-over box.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED + = "footnote_inputfield_custom_mouse_over_box_enabled" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.2 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + +

                  + + + +

                  Settings Container Key to enable tooltip truncation.

                  + + + public + str + C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED + = "footnote_inputfield_custom_mouse_over_box_excerpt_enabled" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + +

                  + + + +

                  Settings Container Key for the referrer element.

                  + + + public + str + C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS + = "footnotes_inputfield_referrer_superscript_tags" + + + +
                    +
                  • Bugfix: Referrers: new setting for vertical align: superscript (default) or baseline (optional), thanks to @cwbayer bug report.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.1 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-16T0859+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @cwbayer

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

                  + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + +

                  + + + +

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

                  + + + public + str + C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE + = "footnotes_inputfield_tooltip_excerpt_mirror_enable" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + link +
                  +
                  +

                  But this must not be the default behavior.

                  +                   + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/change-tooltip-text/#post-13935488 + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_LINK_ELEMENT_ENABLED + +

                  + + + +

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

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

                  + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + +

                  + + + + + + public + mixed + C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED + = "footnotes_inputfield_mouse_over_box_font_size_enabled" + + + + + + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE + +

                  + + + +

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

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

                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE + +

                  + + + +

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

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

                  @spaceling

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

                  + C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH + +

                  + + + +

                  Settings Container Key to get the backlink symbol switch side.

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

                  2020-11-16T2024+0100

                  +
                  + +
                  +
                  + contributor +
                  +
                  + +

                  @spaceling

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

                  + C_BOOL_REFERENCE_CONTAINER_COLLAPSE + +

                  + + + +

                  Settings Container Key to collapse the reference container by default.

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

                  Stefan Herndler

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

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

                  +
                  + +
                  +
                  + todo +
                  +
                  + +

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

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + +

                  + + + + + + public + mixed + C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER + = "footnotes_inputfield_reference_container_label_bottom_border" + + + + + + +
                  +
                  +

                  + C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE + +

                  + + + +

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

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

                  + C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE + +

                  + + + +

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

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

                  @dragon013

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

                  + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + +

                  + + + + + + public + mixed + C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR + = "footnotes_inputfield_mouse_over_box_font_size_scalar" + + + + + + +
                  +
                  +

                  + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + +

                  + + + + + + public + mixed + C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR + = "footnotes_inputfield_backlinks_column_max_width_scalar" + + + + + + +
                  +
                  +

                  + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + +

                  + + + + + + public + mixed + C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR + = "footnotes_inputfield_backlinks_column_width_scalar" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL + +

                  + + + +

                  Settings Container Key for 'the_content' hook priority level.

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

                  2020-11-16T0859+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_the_excerpt_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL + +

                  + + + +

                  Settings Container Key for '' hook priority level

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

                  2020-11-20T0620+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_widget_text_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + +

                  + + + + + + public + mixed + C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL + = "footnote_inputfield_expert_lookup_widget_title_priority_level" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X + = "footnotes_inputfield_alternative_mouse_over_box_offset_x" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y + = "footnotes_inputfield_alternative_mouse_over_box_offset_y" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH + = "footnotes_inputfield_alternative_mouse_over_box_width" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_FOOTNOTES_SCROLL_DURATION + +

                  + + + + + + public + mixed + C_INT_FOOTNOTES_SCROLL_DURATION + = "footnotes_inputfield_scroll_duration" + + + + + + +
                  +
                  +

                  + C_INT_FOOTNOTES_SCROLL_OFFSET + +

                  + + + +

                  Scroll offset and duration

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

                  2020-12-05T0538+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY + = "footnotes_inputfield_mouse_over_box_fade_in_delay" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION + = "footnotes_inputfield_mouse_over_box_fade_in_duration" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY + = "footnotes_inputfield_mouse_over_box_fade_out_delay" + + + + + + +
                  +
                  +

                  + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + +

                  + + + + + + public + mixed + C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION + = "footnotes_inputfield_mouse_over_box_fade_out_duration" + + + + + + +
                  +
                  +

                  + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + +

                  + + + + + + public + mixed + C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN + = "footnotes_inputfield_reference_container_bottom_margin" + + + + + + +
                  +
                  +

                  + C_INT_REFERENCE_CONTAINER_TOP_MARGIN + +

                  + + + +

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

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

                  + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT + = "footnotes_inputfield_backlinks_column_max_width_unit" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_COLUMN_WIDTH_UNIT + = "footnotes_inputfield_backlinks_column_width_unit" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_SEPARATOR_CUSTOM + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_SEPARATOR_CUSTOM + = "footnotes_inputfield_backlinks_separator_custom" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_SEPARATOR_OPTION + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_SEPARATOR_OPTION + = "footnotes_inputfield_backlinks_separator_option" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_TERMINATOR_CUSTOM + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_TERMINATOR_CUSTOM + = "footnotes_inputfield_backlinks_terminator_custom" + + + + + + +
                  +
                  +

                  + C_STR_BACKLINKS_TERMINATOR_OPTION + +

                  + + + + + + public + mixed + C_STR_BACKLINKS_TERMINATOR_OPTION + = "footnotes_inputfield_backlinks_terminator_option" + + + + + + +
                  +
                  +

                  + C_STR_CUSTOM_CSS + +

                  + + + +

                  Settings Container Key for the Custom CSS.

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + 1.3.0 + +

                  Adding: new settings tab for custom CSS settings.

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_CUSTOM_CSS_NEW + +

                  + + + +

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

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

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

                  +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-12-15T0520+0100

                  +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + +

                  + + + + + + public + mixed + C_STR_FOOTNOTE_FRAGMENT_ID_SLUG + = "footnotes_inputfield_footnote_fragment_id_slug" + + + + + + +
                  +
                  +

                  + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + +

                  + + + +

                  Settings container key to enable superscript style normalization.

                  + + + public + str + C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT + = "footnotes_inputfield_referrers_normal_superscript" + + + +

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

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @tomturowski

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

                  + C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION + +

                  + + + +

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

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

                  + C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT + +

                  + + + +

                  Settings container key to configure the backlink tooltip.

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

                  @theroninjedi47

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

                  + C_STR_FOOTNOTES_COUNTER_STYLE + +

                  + + + +

                  Settings Container Key for the counter style of the footnotes.

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_LOVE + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.7 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.8 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + +

                  + + + + + + public + mixed + C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT + = "footnotes_inputfield_page_layout_support" + + + + + + +
                  +
                  +

                  + C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE + +

                  + + + +

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

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

                  @hopper87it

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

                  + C_STR_FOOTNOTES_SHORT_CODE_END + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_START + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED + +

                  + + + +

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

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_STYLING_AFTER + +

                  + + + +

                  Settings Container Key for the string after the footnote referrer.

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_STYLING_BEFORE + +

                  + + + +

                  Settings Container Key for the string before the footnote referrer.

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER + +

                  + + + +

                  Settings container key to configure the tooltip excerpt delimiter.

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

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

                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @jbj2199

                  +
                  + +
                  +
                  + link +
                  +
                  +

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

                  +                   + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + +

                  + + + +

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

                  + + + public + str + C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR + = "footnotes_inputfield_tooltip_excerpt_mirror_separator" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.5.4 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + +

                  + + + +

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

                  + + + public + str + C_STR_FOOTNOTES_TOOLTIP_READON_LABEL + = "footnote_inputfield_readon_label" + + + +
                    +
                  • Adding: Tooltips: Read-on button: Label: configurable instead of localizable, thanks to @rovanov example provision.
                    • +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.1.0 + +
                  + +
                  +
                  + date +
                  +
                  + +

                  2020-11-08T2106+0100

                  +
                  + +
                  +
                  + reporter +
                  +
                  + +

                  @rovanov

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/offset-x-axis-and-offset-y-axis-does-not-working/ + +
                  +
                  + +
                  +
                  +

                  + C_STR_HARD_LINK_IDS_SEPARATOR + +

                  + + + + + + public + mixed + C_STR_HARD_LINK_IDS_SEPARATOR + = "footnotes_inputfield_hard_link_ids_separator" + + + + + + +
                  +
                  +

                  + C_STR_HYPERLINK_ARROW + +

                  + + + +

                  Settings Container Key for the backlink symbol selection.

                  + + + public + str + C_STR_HYPERLINK_ARROW + = "footnote_inputfield_custom_hyperlink_symbol" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_HYPERLINK_ARROW_USER_DEFINED + +

                  + + + +

                  Settings Container Key for the user-defined backlink symbol.

                  + + + public + str + C_STR_HYPERLINK_ARROW_USER_DEFINED + = "footnote_inputfield_custom_hyperlink_symbol_user" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + +

                  + + + + + + public + mixed + C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT + = "footnotes_inputfield_mouse_over_box_font_size_unit" + + + + + + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + +

                  + + + + + + public + mixed + C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT + = "footnotes_inputfield_reference_container_label_element" + + + + + + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_NAME + +

                  + + + +

                  Settings Container Key for the label of the reference container.

                  + + + public + str + C_STR_REFERENCE_CONTAINER_NAME + = "footnote_inputfield_references_label" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_POSITION + +

                  + + + +

                  Settings Container Key for the position of the reference container.

                  + + + public + str + C_STR_REFERENCE_CONTAINER_POSITION + = "footnote_inputfield_reference_container_place" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + +

                  + + + +

                  Settings Container Key for reference container position shortcode

                  + + + public + str + C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE + = "footnote_inputfield_reference_container_position_shortcode" + + + +
                  + + +
                  + Tags + +
                  +
                  +
                  + since +
                  +
                  + 2.2.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + C_STR_REFERRER_FRAGMENT_ID_SLUG + +

                  + + + + + + public + mixed + C_STR_REFERRER_FRAGMENT_ID_SLUG + = "footnotes_inputfield_referrer_fragment_id_slug" + + + + + + +
                  +
                  + + +
                  +

                  + Properties + +

                  +
                  +

                  + $a_arr_Container + + + +

                  + + +

                  Contains all Settings Container names.

                  + + + private + array<string|int, mixed> + $a_arr_Container + = array("footnotes_storage", "footnotes_storage_custom", "footnotes_storage_expert", "footnotes_storage_custom_css") + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + $a_arr_Default + + + +

                  + + +

                  Contains all Default Settings for each Settings Container.

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

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + 2.1.3 + +

                  excerpt hook: disable by default, thanks to @nikelaos

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/doesnt-work-any-more-11/#post-13687068 + +
                  +
                  + +
                  +
                  +

                  + $a_arr_Settings + + + +

                  + + +

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

                  + + + private + array<string|int, mixed> + $a_arr_Settings + = array() + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  +

                  + $a_obj_Instance + + + +

                  + + +

                  Stores a singleton reference of this class.

                  + + + private + static MCI_Footnotes_Settings + $a_obj_Instance + = +ull + +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  +
                  + +
                  +

                  + Methods + +

                  +
                  +

                  + ClearAll() + +

                  + + +

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

                  + + + public + ClearAll() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +

                  Edit: This didn’t actually work.

                  +
                  + +
                  +
                  + since +
                  +
                  + 2.2.0 + +

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

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

                  + get() + +

                  + + +

                  Returns the value of specified Settings name.

                  + + + public + get(string $p_str_Key) : mixed + +
                  + +
                  Parameters
                  +
                  +
                  + $p_str_Key + : string +
                  +
                  +

                  Settings Array Key name.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +

                  Value of the Setting on Success or Null in Settings name is invalid.

                  +
                  + + +
                  +
                  +

                  + getContainer() + +

                  + + +

                  Returns the name of a specified Settings Container.

                  + + + public + getContainer(int $p_int_Index) : str + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Settings Container Array Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + str + — +

                  Settings Container name.

                  +
                  + + +
                  +
                  +

                  + getDefaults() + +

                  + + +

                  Returns the default values of a specific Settings Container.

                  + + + public + getDefaults(int $p_int_Index) : array<string|int, mixed> + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Settings Container Aray Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.6 + +
                  + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed> + — +
                  + + +
                  +
                  +

                  + instance() + +

                  + + +

                  Returns a singleton of this class.

                  + + + public + static instance() : MCI_Footnotes_Settings + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + MCI_Footnotes_Settings + — +
                  + + +
                  +
                  +

                  + RegisterSettings() + +

                  + + +

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

                  + + + public + RegisterSettings() : mixed + +

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

                  +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + saveOptions() + +

                  + + +

                  Updates a whole Settings container.

                  + + + public + saveOptions(int $p_int_Index, array<string|int, mixed> $p_arr_newValues) : bool + +
                  + +
                  Parameters
                  +
                  +
                  + $p_int_Index + : int +
                  +
                  +

                  Index of the Settings container.

                  +
                  + +
                  +
                  + $p_arr_newValues + : array<string|int, mixed> +
                  +
                  +

                  new Settings.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + bool + — +
                  + + +
                  +
                  +

                  + __construct() + +

                  + + +

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

                  + + + private + __construct() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  +

                  + Load() + +

                  + + +

                  Loads all Settings from specified Settings Container.

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

                  Settings Container Array Key Index.

                  +
                  + +
                  +
                  + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + since +
                  +
                  + +

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

                  +
                  + +
                  +
                  + link +
                  +
                  + https://wordpress.org/support/topic/leading-space-in-footnotes-tag/#post-5347966 + +
                  +
                  + +
                  Return values
                  + array<string|int, mixed> + — +

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

                  +
                  + + +
                  +
                  +

                  + loadAll() + +

                  + + +

                  Loads all Settings from each Settings container.

                  + + + private + loadAll() : mixed + +
                  + + + +
                  + Tags + +
                  +
                  +
                  + author +
                  +
                  + +

                  Stefan Herndler

                  +
                  + +
                  +
                  + since +
                  +
                  + 1.5.0 + +
                  + +
                  +
                  + +
                  Return values
                  + mixed + — +
                  + + +
                  +
                  + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + diff --git a/docs/classes/MCI-Footnotes-Task.html b/docs/classes/MCI-Footnotes-Task.html new file mode 100644 index 0000000..b8cddb3 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Task.html @@ -0,0 +1,2902 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                    +

                    Documentation

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

                    + MCI_Footnotes_Task + + + + +

                    + + + +

                    Searches and replaces the footnotes.

                    + +

                    Generates the reference container.

                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + + + + + + +

                    + Table of Contents + +

                    + +
                    +
                    + $a_arr_Footnotes + +  : array<string|int, mixed> +
                    +
                    Contains all footnotes found on current public page.
                    + +
                    + $a_bool_AllowLoveMe + +  : bool +
                    +
                    Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.
                    + +
                    + $a_bool_AlternativeTooltipsEnabled + +  : mixed +
                    +
                    + +
                    + $a_bool_HardLinksEnable + +  : bool|str|int +
                    +
                    Hard links for AMP compatibility
                    + +
                    + $a_bool_MirrorTooltipText + +  : mixed +
                    +
                    Dedicated tooltip text
                    + +
                    + $a_bool_SyntaxErrorFlag + +  : bool +
                    +
                    Footnote delimiter syntax validation
                    + +
                    + $a_bool_TooltipsEnabled + +  : bool +
                    +
                    Template process optimization
                    + +
                    + $a_int_PostId + +  : int +
                    +
                    Infinite scroll / autoload or archive view
                    + +
                    + $a_int_ReferenceContainerId + +  : int +
                    +
                    Multiple reference containers in content and widgets
                    + +
                    + $a_int_ScrollOffset + +  : int +
                    +
                    Scroll offset
                    + +
                    + $a_int_TooltipShortcodeLength + +  : mixed +
                    +
                    + +
                    + $a_str_FootnoteLinkSlug + +  : mixed +
                    +
                    + +
                    + $a_str_LinkCloseTag + +  : mixed +
                    +
                    + +
                    + $a_str_LinkIdsSeparator + +  : mixed +
                    +
                    + +
                    + $a_str_LinkOpenTag + +  : mixed +
                    +
                    + +
                    + $a_str_LinkSpan + +  : mixed +
                    +
                    Optional link element for footnote referrers and backlinks
                    + +
                    + $a_str_PostContainerIdCompound + +  : mixed +
                    +
                    + +
                    + $a_str_Prefix + +  : string +
                    +
                    Prefix for the Footnote html element ID.
                    + +
                    + $a_str_ReferrerLinkSlug + +  : mixed +
                    +
                    + +
                    + $a_str_TooltipShortcode + +  : mixed +
                    +
                    + +
                    + exec() + +  : string +
                    +
                    Replaces all footnotes that occur in the given content.
                    + +
                    + ReferenceContainer() + +  : string +
                    +
                    Generates the reference container.
                    + +
                    + registerHooks() + +  : 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.
                    + +
                    + the_content() + +  : string +
                    +
                    Replaces footnotes in the content of the current page/post.
                    + +
                    + the_excerpt() + +  : string +
                    +
                    Replaces footnotes in the excerpt of the current page/post.
                    + +
                    + the_post() + +  : mixed +
                    +
                    Replaces footnotes in each Content var of the current Post object.
                    + +
                    + the_title() + +  : string +
                    +
                    Replaces footnotes in the post/page title.
                    + +
                    + widget_text() + +  : string +
                    +
                    Replaces footnotes in the content of the current widget.
                    + +
                    + widget_title() + +  : string +
                    +
                    Replaces footnotes in the widget title.
                    + +
                    + wp_footer() + +  : mixed +
                    +
                    Displays the 'LOVE FOOTNOTES' slug if enabled.
                    + +
                    + wp_head() + +  : mixed +
                    +
                    Outputs the custom css to the header of the public page.
                    + +
                    + replacePostObject() + +  : WP_Post +
                    +
                    Replace all Footnotes in a WP_Post object.
                    + +
                    + + + + + + +
                    +

                    + Properties + +

                    +
                    +

                    + $a_arr_Footnotes + + + +

                    + + +

                    Contains all footnotes found on current public page.

                    + + + public + static array<string|int, mixed> + $a_arr_Footnotes + = array() + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_AllowLoveMe + + + +

                    + + +

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

                    + + + public + static bool + $a_bool_AllowLoveMe + = rue + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_AlternativeTooltipsEnabled + + + +

                    + + + + + public + static mixed + $a_bool_AlternativeTooltipsEnabled + = alse + + + + +
                    +
                    +

                    + $a_bool_HardLinksEnable + + + +

                    + + +

                    Hard links for AMP compatibility

                    + + + public + static bool|str|int + $a_bool_HardLinksEnable + = 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 + +
                    + +
                    +
                    + since +
                    +
                    + 2.3.0 + +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @theroninjedi47

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @psykonevro

                    +
                    + +
                    +
                    + link +
                    +
                    +
                      +
                    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
                      • +
                    +                     + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/making-it-amp-compatible/ + +
                    +
                    + link +
                    +
                    +

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

                    +                     + +
                    +
                    + contributor +
                    +
                    + +

                    @martinneumannat

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_MirrorTooltipText + + + +

                    + + +

                    Dedicated tooltip text

                    + + + public + static mixed + $a_bool_MirrorTooltipText + = alse + +
                      +
                    • Update: Tooltips: ability to display dedicated content before [[/tooltip]], thanks to @jbj2199 issue report.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.5.2 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-19T2223+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @jbj2199

                    +
                    + +
                    +
                    + link +
                    +
                    +

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

                    +                     + +
                    +
                    + +
                    +
                    +

                    + $a_bool_SyntaxErrorFlag + + + +

                    + + +

                    Footnote delimiter syntax validation

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

                    2021-01-01T0227+0100

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_bool_TooltipsEnabled + + + +

                    + + +

                    Template process optimization

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

                    2021-01-04T1355+0100

                    +
                    + +
                    +
                    + author +
                    +
                    + +

                    Patrizia Lutz @misfist

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

                    repository

                    +                     + +
                    +
                    + link +
                    +
                    +

                    diff

                    +                     + +
                    +
                    + +
                    +
                    +

                    + $a_int_PostId + + + +

                    + + +

                    Infinite scroll / autoload or archive view

                    + + + public + static int + $a_int_PostId + = 0 + +
                      +
                    • Bugfix: Infinite scroll: debug autoload by adding post ID, thanks to @docteurfitness code contribution
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.0.6 + +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @docteurfitness

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

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

                    +                     + +
                    +
                    + reporter +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_int_ReferenceContainerId + + + +

                    + + +

                    Multiple reference containers in content and widgets

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

                    2020-12-25T0338+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @justbecuz

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

                    + $a_int_ScrollOffset + + + +

                    + + +

                    Scroll offset

                    + + + public + static int + $a_int_ScrollOffset + = 34 + +
                      +
                    • Bugfix: Scroll offset: make configurable to fix site-dependent issues related to fixed headers.
                      • +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.1.4 + +
                    + +
                    +
                    + since +
                    +
                    + 2.4.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-12-05T0538+0100

                    +
                      +
                    • Bugfix: Scroll offset: initialize to safer one third window height for more robustness, thanks to @lukashuggenberg bug report.
                      • +
                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-03T2055+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2021-01-04T0504+0100

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @lukashuggenberg

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

                    + $a_int_TooltipShortcodeLength + + + +

                    + + + + + public + static mixed + $a_int_TooltipShortcodeLength + = 12 + + + + +
                    +
                    +

                    + $a_str_FootnoteLinkSlug + + + +

                    + + + + + public + static mixed + $a_str_FootnoteLinkSlug + = 'f' + + + + +
                    +
                    +

                    + $a_str_LinkCloseTag + + + +

                    + + + + + public + static mixed + $a_str_LinkCloseTag + = '' + + + + +
                    +
                    +

                    + $a_str_LinkIdsSeparator + + + +

                    + + + + + public + static mixed + $a_str_LinkIdsSeparator + = '+' + + + + +
                    +
                    +

                    + $a_str_LinkOpenTag + + + +

                    + + + + + public + static mixed + $a_str_LinkOpenTag + = '' + + + + +
                    +
                    +

                    + $a_str_LinkSpan + + + +

                    + + +

                    Optional link element for footnote referrers and backlinks

                    + + + public + static mixed + $a_str_LinkSpan + = 'span' + +
                    + + +
                    + Tags + +
                    +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    add link elements along with hard links.

                    +
                      +
                    • Bugfix: Referrers and backlinks: Styling: make link elements optional to fix issues, thanks to @docteurfitness issue report and code contribution.
                      • +
                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.4 + +
                    + +
                    +
                    + since +
                    +
                    + 2.3.0 + +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-11-25T1306+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-11-26T1051+0100

                    +
                    + +
                    +
                    + date +
                    +
                    + +

                    2020-12-30T2313+0100

                    +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + contributor +
                    +
                    + +

                    @martinneumannat

                    +
                    + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/update-2-1-3/#post-13704194 + +
                    +
                    + link +
                    +
                    +
                      +
                    • Adding: Referrers and backlinks: optional hard links for AMP compatibility, thanks to @psykonevro bug report, thanks to @martinneumannat code contribution.
                      • +
                    +                     + +
                    +
                    + link +
                    +
                    + https://wordpress.org/support/topic/making-it-amp-compatible/ + +
                    +
                    + link +
                    +
                    +

                    Although widely used for that purpose, hyperlinks are disliked for footnote linking. +Browsers may need to be prevented from logging these clicks in the browsing history, +as logging compromises the usability of the 'return to previous' button in browsers. +For that purpose, and for scroll animation, this linking is performed by JavaScript.

                    +

                    Link elements raise concerns, so that mitigating their proliferation may be desired.

                    +

                    By contrast, due to an insufficiency in the CSS standard, coloring elements with the +theme’s link color requires real link elements and cannot be done with named colors, +as CSS does not support 'color: link|hover|active|visited', after the pseudo-classes +of the link element.

                    +

                    Yet styling these elements with the link color is not universally preferred, so that +the very presence of these link elements may need to be avoided.

                    +                     + +
                    +
                    + reporter +
                    +
                    + +

                    @docteurfitness

                    +
                    + +
                    +
                    + reporter +
                    +
                    + +

                    @psykonevro

                    +
                    + +
                    +
                    + see +
                    +
                    + self::$a_bool_HardLinksEnable + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_str_PostContainerIdCompound + + + +

                    + + + + + public + static mixed + $a_str_PostContainerIdCompound + = '' + + + + +
                    +
                    +

                    + $a_str_Prefix + + + +

                    + + +

                    Prefix for the Footnote html element ID.

                    + + + public + static string + $a_str_Prefix + = "" + +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.8 + +
                    + +
                    +
                    + +
                    +
                    +

                    + $a_str_ReferrerLinkSlug + + + +

                    + + + + + public + static mixed + $a_str_ReferrerLinkSlug + = 'r' + + + + +
                    +
                    +

                    + $a_str_TooltipShortcode + + + +

                    + + + + + public + static mixed + $a_str_TooltipShortcode + = '[[/tooltip]]' + + + + +
                    +
                    + +
                    +

                    + Methods + +

                    +
                    +

                    + exec() + +

                    + + +

                    Replaces all footnotes that occur in the given content.

                    + + + public + exec(string $p_str_Content[, bool $p_bool_OutputReferences = false ][, bool $p_bool_HideFootnotesText = false ]) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Any string that may contain footnotes to be replaced.

                    +
                    + +
                    +
                    + $p_bool_OutputReferences + : bool + = false
                    +
                    +

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

                    +
                    + +
                    +
                    + $p_bool_HideFootnotesText + : bool + = false
                    +
                    +

                    Hide footnotes found in the string.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.2.0 + +

                    Adding: Reference container: support for custom position shortcode, thanks to @hamshe issue report.

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

                    Bugfix: Reference container: delete position shortcode if unused because position may be widget or footer, thanks to @hamshe bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + ReferenceContainer() + +

                    + + +

                    Generates the reference container.

                    + + + public + ReferenceContainer() : string + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    Update: remove backlink symbol along with column 2 of the reference container

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.3 + +

                    Bugfix: prepend an arrow on user request

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

                    Bugfix: Reference container: fix line breaking behavior in footnote number clusters.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.4 + +

                    Bugfix: restore the arrow select and backlink symbol input settings

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

                    Bugfix: Referrers, reference container: Combining identical footnotes: fix dead links and ensure referrer-backlink bijectivity, thanks to @happyches bug report.

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

                    Bugfix: Reference container: Backlink symbol: make optional, not suggest configuring it to invisible, thanks to @spaceling feedback.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + registerHooks() + +

                    + + +

                    Register WordPress Hooks to replace Footnotes in the content of a public page.

                    + + + public + registerHooks() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 1.5.4 + +

                    Adding: Hooks: support 'the_post' in response to user request for custom post types.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.5 + +

                    Bugfix: Reference container: fix relative position through priority level, thanks to @june01 @imeson @spaceling bug reports, thanks to @spaceling code contribution.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.5 + +

                    Update: Hooks: Default-enable all hooks to prevent footnotes from seeming broken in some parts.

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

                    Bugfix: Priority level back to PHP_INT_MAX (ref container positioning not this plugin’s responsibility).

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.7 + +

                    BUGFIX: Hooks: Default-disable 'the_post', thanks to @spaceling @markcheret @nyamachi @whichgodsaves @spiralofhope2 @mmallett @andreasra @widecast @ymorin007 @tashi1es bug reports.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.7 + +

                    Bugfix: Set priority level back to 10 assuming it is unproblematic 2020-11-06T1344+0100.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.0.8 + +

                    Bugfix: Priority level back to PHP_INT_MAX (need to get in touch with other plugins).

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.1.0 + +

                    UPDATE: Hooks: remove 'the_post', the plugin stops supporting this hook.

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

                    Bugfix: Dashboard: priority level setting for the_content hook, thanks to @imeson bug report.

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

                    Bugfix: Dashboard: priority level settings for all other hooks, thanks to @nikelaos bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Hooks: support footnotes on category pages, thanks to @vitaefit bug report, thanks to @misfist code contribution.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.1 + +

                    Bugfix: Hooks: support footnotes in Popup Maker popups, thanks to @squatcher bug report.

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

                    + search() + +

                    + + +

                    Replaces all footnotes in the given content and appends them to the static property.

                    + + + public + search(string $p_str_Content, bool $p_bool_ConvertHtmlChars, bool $p_bool_HideFootnotesText) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Content to be searched for footnotes.

                    +
                    + +
                    +
                    + $p_bool_ConvertHtmlChars + : bool +
                    +
                    +

                    html encode settings, default true.

                    +
                    + +
                    +
                    + $p_bool_HideFootnotesText + : bool +
                    +
                    +

                    Hide footnotes found in the string.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.0.0 + +

                    various.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.4.0 + +

                    Adding: Footnote delimiters: syntax validation for balanced footnote start and end tag short codes.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: exclude certain cases involving scripts, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: complete message with hint about setting, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + since +
                    +
                    + 2.5.0 + +

                    Bugfix: Footnote delimiters: Syntax validation: limit length of quoted string to 300 characters, thanks to @andreasra bug report.

                    +
                    + +
                    +
                    + +
                    Return values
                    + string + — +
                    + + +
                    +
                    +

                    + the_content() + +

                    + + +

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

                    + + + public + the_content(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Page/Post content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + the_excerpt() + +

                    + + +

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

                    + + + public + the_excerpt(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Page/Post content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + the_post() + +

                    + + +

                    Replaces footnotes in each Content var of the current Post object.

                    + + + public + the_post(array<string|int, mixed>|WP_Post &$p_mixed_Posts) : mixed + +
                    + +
                    Parameters
                    +
                    +
                    + $p_mixed_Posts + : array<string|int, mixed>|WP_Post +
                    +
                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.4 + +
                    + +
                    +
                    + +
                    Return values
                    + mixed + — +
                    + + +
                    +
                    +

                    + the_title() + +

                    + + +

                    Replaces footnotes in the post/page title.

                    + + + public + the_title(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + widget_text() + +

                    + + +

                    Replaces footnotes in the content of the current widget.

                    + + + public + widget_text(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + widget_title() + +

                    + + +

                    Replaces footnotes in the widget title.

                    + + + public + widget_title(string $p_str_Content) : string + +
                    + +
                    Parameters
                    +
                    +
                    + $p_str_Content + : string +
                    +
                    +

                    Widget content.

                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    Content with replaced footnotes.

                    +
                    + + +
                    +
                    +

                    + wp_footer() + +

                    + + +

                    Displays the 'LOVE FOOTNOTES' slug if enabled.

                    + + + public + wp_footer() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.0 + +
                    + +
                    +
                    + since +
                    +
                    + 2.2.0 + +

                    more options 2020-12-11T0506+0100

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

                    + wp_head() + +

                    + + +

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

                    + + + public + wp_head() : mixed + +
                    + + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

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

                    + replacePostObject() + +

                    + + +

                    Replace all Footnotes in a WP_Post object.

                    + + + private + replacePostObject(WP_Post $p_obj_Post) : WP_Post + +
                    + +
                    Parameters
                    +
                    +
                    + $p_obj_Post + : WP_Post +
                    +
                    +
                    + +
                    +
                    + + +
                    + Tags + +
                    +
                    +
                    + author +
                    +
                    + +

                    Stefan Herndler

                    +
                    + +
                    +
                    + since +
                    +
                    + 1.5.6 + +
                    + +
                    +
                    + +
                    Return values
                    + WP_Post + — +
                    + + +
                    +
                    + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + diff --git a/docs/classes/MCI-Footnotes-Template.html b/docs/classes/MCI-Footnotes-Template.html new file mode 100644 index 0000000..98bc1ed --- /dev/null +++ b/docs/classes/MCI-Footnotes-Template.html @@ -0,0 +1,1044 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                      +

                      Documentation

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

                      + MCI_Footnotes_Template + + + + +

                      + + + +

                      Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).

                      + +

                      Loads a template file, replaces all Placeholders and returns the replaced file content.

                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + + + + + + +

                      + Table of Contents + +

                      + +
                      +
                      + C_STR_DASHBOARD + +  = "dashboard" +
                      +
                      Directory name for dashboard templates.
                      + +
                      + C_STR_PUBLIC + +  = "public" +
                      +
                      Directory name for public templates.
                      + +
                      + $plugin_directory + +  : string +
                      +
                      Plugin Directory
                      + +
                      + $a_str_OriginalContent + +  : string +
                      +
                      Contains the content of the template after initialize.
                      + +
                      + $a_str_ReplacedContent + +  : string +
                      +
                      Contains the content of the template after initialize with replaced place holders.
                      + +
                      + __construct() + +  : mixed +
                      +
                      Class Constructor. Reads and loads the template file without replace any placeholder.
                      + +
                      + get_template() + +  : mixed +
                      +
                      Get the template
                      + +
                      + getContent() + +  : string +
                      +
                      Returns the content of the template file with replaced placeholders.
                      + +
                      + process_template() + +  : void +
                      +
                      Process template file
                      + +
                      + reload() + +  : mixed +
                      +
                      Reloads the original content of the template file.
                      + +
                      + replace() + +  : bool +
                      +
                      Replace all placeholders specified in array.
                      + +
                      + + + + +
                      +

                      + Constants + +

                      +
                      +

                      + C_STR_DASHBOARD + +

                      + + + +

                      Directory name for dashboard templates.

                      + + + public + string + C_STR_DASHBOARD + = "dashboard" + + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      +

                      + C_STR_PUBLIC + +

                      + + + +

                      Directory name for public templates.

                      + + + public + string + C_STR_PUBLIC + = "public" + + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      + + +
                      +

                      + Properties + +

                      +
                      +

                      + $plugin_directory + + + +

                      + + +

                      Plugin Directory

                      + + + public + string + $plugin_directory + + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + +
                      +
                      +

                      + $a_str_OriginalContent + + + +

                      + + +

                      Contains the content of the template after initialize.

                      + + + private + string + $a_str_OriginalContent + = "" + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      +

                      + $a_str_ReplacedContent + + + +

                      + + +

                      Contains the content of the template after initialize with replaced place holders.

                      + + + private + string + $a_str_ReplacedContent + = "" + +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      +
                      + +
                      +

                      + Methods + +

                      +
                      +

                      + __construct() + +

                      + + +

                      Class Constructor. Reads and loads the template file without replace any placeholder.

                      + + + public + __construct(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed + +
                      + +
                      Parameters
                      +
                      +
                      + $p_str_FileType + : string +
                      +
                      +

                      Template file type (take a look on the Class constants).

                      +
                      + +
                      +
                      + $p_str_FileName + : string +
                      +
                      +

                      Template file name inside the Template directory without the file extension.

                      +
                      + +
                      +
                      + $p_str_Extension + : string + = "html"
                      +
                      +

                      Optional Template file extension (default: html)

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + since +
                      +
                      + 2.2.6 + +

                      support for custom templates 2020-12-19T0606+0100

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0 + +

                      look for custom template in the active theme first, thanks to @misfist

                      +
                      + +
                      +
                      + link +
                      +
                      + https://wordpress.org/support/topic/template-override-filter/ + +
                      +
                      + link +
                      +
                      + https://wordpress.org/support/topic/template-override-filter/#post-13846598 + +
                      +
                      + +
                      Return values
                      + mixed + — +
                      + + +
                      +
                      +

                      + get_template() + +

                      + + +

                      Get the template

                      + + + public + get_template(string $p_str_FileType, string $p_str_FileName[, string $p_str_Extension = "html" ]) : mixed + +
                      + +
                      Parameters
                      +
                      +
                      + $p_str_FileType + : string +
                      +
                      +
                      + +
                      +
                      + $p_str_FileName + : string +
                      +
                      +
                      + +
                      +
                      + $p_str_Extension + : string + = "html"
                      +
                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + +
                      Return values
                      + mixed + — +

                      false | template path

                      +
                      + + +
                      +
                      +

                      + getContent() + +

                      + + +

                      Returns the content of the template file with replaced placeholders.

                      + + + public + getContent() : string + +
                      + + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

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

                      Template content with replaced placeholders.

                      +
                      + + +
                      +
                      +

                      + process_template() + +

                      + + +

                      Process template file

                      + + + public + process_template(string $template) : void + +
                      + +
                      Parameters
                      +
                      +
                      + $template + : string +
                      +
                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Patrizia Lutz @misfist

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.4.0d3 + +
                      + +
                      +
                      + since +
                      +
                      + 2.0.3 + +

                      replace tab with a space

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.0.3 + +

                      replace 2 spaces with 1

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.0.4 + +

                      collapse multiple spaces

                      +
                      + +
                      +
                      + since +
                      +
                      + 2.2.6 + +

                      delete a space before a closing pointy bracket

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

                      collapse HTML comments and PHP/JS docblocks (only)

                      +
                      + +
                      +
                      + +
                      Return values
                      + void + — +
                      + + +
                      +
                      +

                      + reload() + +

                      + + +

                      Reloads the original content of the template file.

                      + + + public + reload() : mixed + +
                      + + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      Return values
                      + mixed + — +
                      + + +
                      +
                      +

                      + replace() + +

                      + + +

                      Replace all placeholders specified in array.

                      + + + public + replace(array<string|int, mixed> $p_arr_Placeholders) : bool + +
                      + +
                      Parameters
                      +
                      +
                      + $p_arr_Placeholders + : array<string|int, mixed> +
                      +
                      +

                      Placeholders (key = placeholder, value = value).

                      +
                      + +
                      +
                      + + +
                      + Tags + +
                      +
                      +
                      + author +
                      +
                      + +

                      Stefan Herndler

                      +
                      + +
                      +
                      + since +
                      +
                      + 1.5.0 + +
                      + +
                      +
                      + +
                      Return values
                      + bool + — +

                      True on Success, False if Placeholders invalid.

                      +
                      + + +
                      +
                      + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + diff --git a/docs/classes/MCI-Footnotes-WYSIWYG.html b/docs/classes/MCI-Footnotes-WYSIWYG.html new file mode 100644 index 0000000..08eae4a --- /dev/null +++ b/docs/classes/MCI-Footnotes-WYSIWYG.html @@ -0,0 +1,492 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                        +

                        Documentation

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

                        + MCI_Footnotes_WYSIWYG + + + + +

                        + + + + +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + + + + + + +

                        + Table of Contents + +

                        + +
                        +
                        + ajaxCallback() + +  : mixed +
                        +
                        AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.
                        + +
                        + includeScripts() + +  : array<string|int, mixed> +
                        +
                        Includes the Plugins WYSIWYG editor script.
                        + +
                        + newPlainTextEditorButton() + +  : mixed +
                        +
                        Add a new button to the plain text editor.
                        + +
                        + newVisualEditorButton() + +  : array<string|int, mixed> +
                        +
                        Append a new Button to the WYSIWYG editor of Posts and Pages.
                        + +
                        + registerHooks() + +  : mixed +
                        +
                        + +
                        + + + + + + + +
                        +

                        + Methods + +

                        +
                        +

                        + ajaxCallback() + +

                        + + +

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

                        + + + public + static ajaxCallback() : mixed + +

                        Returns an JSON encoded array with the Footnotes start and end short code.

                        +
                        + + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        +

                        + includeScripts() + +

                        + + +

                        Includes the Plugins WYSIWYG editor script.

                        + + + public + static includeScripts(array<string|int, mixed> $p_arr_Plugins) : array<string|int, mixed> + +
                        + +
                        Parameters
                        +
                        +
                        + $p_arr_Plugins + : array<string|int, mixed> +
                        +
                        +

                        Scripts to be included to the editor.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

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

                        + newPlainTextEditorButton() + +

                        + + +

                        Add a new button to the plain text editor.

                        + + + public + static newPlainTextEditorButton() : mixed + +
                        + + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

                        +
                        + +
                        +
                        + since +
                        +
                        + 1.5.0 + +
                        + +
                        +
                        + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        +

                        + newVisualEditorButton() + +

                        + + +

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

                        + + + public + static newVisualEditorButton(array<string|int, mixed> $p_arr_Buttons) : array<string|int, mixed> + +
                        + +
                        Parameters
                        +
                        +
                        + $p_arr_Buttons + : array<string|int, mixed> +
                        +
                        +

                        pre defined Buttons from WordPress.

                        +
                        + +
                        +
                        + + +
                        + Tags + +
                        +
                        +
                        + author +
                        +
                        + +

                        Stefan Herndler

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

                        + registerHooks() + +

                        + + + + + public + static registerHooks() : mixed + + + + + +
                        Return values
                        + mixed + — +
                        + + +
                        +
                        + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + diff --git a/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html b/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html new file mode 100644 index 0000000..8ef7d35 --- /dev/null +++ b/docs/classes/MCI-Footnotes-Widget-ReferenceContainer.html @@ -0,0 +1,688 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                          +

                          Documentation

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

                          + MCI_Footnotes_Widget_ReferenceContainer + + + extends MCI_Footnotes_WidgetBase + + + + +

                          + + + +

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

                          + +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + + + + + + +

                          + Table of Contents + +

                          + +
                          +
                          + __construct() + +  : mixed +
                          +
                          Class Constructor. Registers the child Widget to WordPress.
                          + +
                          + form() + +  : void +
                          +
                          Outputs the Settings of the Widget.
                          + +
                          + widget() + +  : mixed +
                          +
                          Outputs the Content of the Widget.
                          + +
                          + getDescription() + +  : string +
                          +
                          Returns the Description of the child widget.
                          + +
                          + getID() + +  : string +
                          +
                          Returns an unique ID as string used for the Widget Base ID.
                          + +
                          + getName() + +  : string +
                          +
                          Returns the Public name of the Widget to be displayed in the Configuration page.
                          + +
                          + getWidgetWidth() + +  : int +
                          +
                          Returns the width of the Widget. Default width is 250 pixel.
                          + +
                          + + + + + + + +
                          +

                          + Methods + +

                          +
                          +

                          + __construct() + +

                          + + +

                          Class Constructor. Registers the child Widget to WordPress.

                          + + + public + __construct() : mixed + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                            +
                          • Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.
                            • +
                          +
                          + +
                          +
                          + since +
                          +
                          + 1.6.4 + +
                          + +
                          +
                          + contributor +
                          +
                          + +

                          @dartiss

                          +
                          + +
                          +
                          + link +
                          +
                          +

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

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

                          + form() + +

                          + + +

                          Outputs the Settings of the Widget.

                          + + + public + form(mixed $instance) : void + +
                          + +
                          Parameters
                          +
                          +
                          + $instance + : mixed +
                          +
                          +
                          + +
                          +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + void + — +

                          Edit: curly quotes 2.2.0 2020-12-12T2130+0100

                          +
                          + + +
                          +
                          +

                          + widget() + +

                          + + +

                          Outputs the Content of the Widget.

                          + + + public + widget(mixed $args, mixed $instance) : mixed + +
                          + +
                          Parameters
                          +
                          +
                          + $args + : mixed +
                          +
                          +
                          + +
                          +
                          + $instance + : mixed +
                          +
                          +
                          + +
                          +
                          + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + mixed + — +
                          + + +
                          +
                          +

                          + getDescription() + +

                          + + +

                          Returns the Description of the child widget.

                          + + + protected + getDescription() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

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

                          Edit: curly quotes 2.2.0 2020-12-12T2130+0100

                          +
                          + + +
                          +
                          +

                          + getID() + +

                          + + +

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

                          + + + protected + getID() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

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

                          + getName() + +

                          + + +

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

                          + + + protected + getName() : string + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

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

                          + getWidgetWidth() + +

                          + + +

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

                          + + + protected + getWidgetWidth() : int + +
                          + + + +
                          + Tags + +
                          +
                          +
                          + author +
                          +
                          + +

                          Stefan Herndler

                          +
                          + +
                          +
                          + since +
                          +
                          + 1.5.0 + +
                          + +
                          +
                          + +
                          Return values
                          + int + — +
                          + + +
                          +
                          + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + diff --git a/docs/classes/MCI-Footnotes-WidgetBase.html b/docs/classes/MCI-Footnotes-WidgetBase.html new file mode 100644 index 0000000..31cc342 --- /dev/null +++ b/docs/classes/MCI-Footnotes-WidgetBase.html @@ -0,0 +1,529 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                            +

                            Documentation

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

                            + MCI_Footnotes_WidgetBase + + + extends WP_Widget + + + + +

                            + + + +

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

                            + +

                            The following Methods MUST be overwritten in each sub class: +public function widget($args, $instance) -> echo the Widget Content +public function form($instance) -> echo the Settings of the Widget

                            +
                            + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + + + + + + +

                            + Table of Contents + +

                            + +
                            +
                            + __construct() + +  : mixed +
                            +
                            Class Constructor. Registers the child Widget to WordPress.
                            + +
                            + getDescription() + +  : string +
                            +
                            Returns the Description of the child widget.
                            + +
                            + getID() + +  : string +
                            +
                            Returns an unique ID as string used for the Widget Base ID.
                            + +
                            + getName() + +  : string +
                            +
                            Returns the Public name of child Widget to be displayed in the Configuration page.
                            + +
                            + getWidgetWidth() + +  : int +
                            +
                            Returns the width of the Widget. Default width is 250 pixel.
                            + +
                            + + + + + + + +
                            +

                            + Methods + +

                            +
                            +

                            + __construct() + +

                            + + +

                            Class Constructor. Registers the child Widget to WordPress.

                            + + + public + __construct() : mixed + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                              +
                            • Update: replace deprecated function WP_Widget() with recommended __construct(), thanks to @dartiss code contribution.
                              • +
                            +
                            + +
                            +
                            + since +
                            +
                            + 1.6.4 + +
                            + +
                            +
                            + contributor +
                            +
                            + +

                            @dartiss

                            +
                            + +
                            +
                            + link +
                            +
                            +

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

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

                            + getDescription() + +

                            + + +

                            Returns the Description of the child widget.

                            + + + protected + abstract getDescription() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

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

                            + getID() + +

                            + + +

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

                            + + + protected + abstract getID() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

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

                            + getName() + +

                            + + +

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

                            + + + protected + abstract getName() : string + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

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

                            + getWidgetWidth() + +

                            + + +

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

                            + + + protected + getWidgetWidth() : int + +
                            + + + +
                            + Tags + +
                            +
                            +
                            + author +
                            +
                            + +

                            Stefan Herndler

                            +
                            + +
                            +
                            + since +
                            +
                            + 1.5.0 + +
                            + +
                            +
                            + +
                            Return values
                            + int + — +
                            + + +
                            +
                            + +
                            +
                            +
                            +
                            +

                            Search results

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

                              Documentation

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

                              + MCI_Footnotes + + + + +

                              + + + +

                              Entry point of the Plugin. Loads the Dashboard and executes the Task.

                              + +
                              + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + + + + + + +

                              + Table of Contents + +

                              + +
                              +
                              + $a_bool_AlternativeTooltipsEnabled + +  : mixed +
                              +
                              + +
                              + $a_bool_TooltipsEnabled + +  : bool +
                              +
                              Template process and script / stylesheet load optimization.
                              + +
                              + $a_obj_Task + +  : null|MCI_Footnotes_Task +
                              +
                              Reference to the Plugin Task object.
                              + +
                              + initializeWidgets() + +  : mixed +
                              +
                              Initializes all Widgets of the Plugin.
                              + +
                              + registerPublic() + +  : mixed +
                              +
                              Registers and enqueues scripts and stylesheets to the public pages.
                              + +
                              + run() + +  : mixed +
                              +
                              Executes the Plugin.
                              + +
                              + initializeDashboard() + +  : mixed +
                              +
                              Initializes the Dashboard of the Plugin and loads them.
                              + +
                              + initializeTask() + +  : mixed +
                              +
                              Initializes the Plugin Task and registers the Task hooks.
                              + +
                              + + + + + + +
                              +

                              + Properties + +

                              +
                              +

                              + $a_bool_AlternativeTooltipsEnabled + + + +

                              + + + + + public + static mixed + $a_bool_AlternativeTooltipsEnabled + = alse + + + + +
                              +
                              +

                              + $a_bool_TooltipsEnabled + + + +

                              + + +

                              Template process and script / stylesheet load optimization.

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

                              2021-01-04T1355+0100

                              +
                              + +
                              +
                              + author +
                              +
                              + +

                              Patrizia Lutz @misfist

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

                              repository

                              +                               + +
                              +
                              + link +
                              +
                              +

                              diff

                              +                               + +
                              +
                              + +
                              +
                              +

                              + $a_obj_Task + + + +

                              + + +

                              Reference to the Plugin Task object.

                              + + + public + null|MCI_Footnotes_Task + $a_obj_Task + = +ull + +
                              + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              +
                              + +
                              +

                              + Methods + +

                              +
                              +

                              + initializeWidgets() + +

                              + + +

                              Initializes all Widgets of the Plugin.

                              + + + public + initializeWidgets() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                                +
                              • Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution
                                • +
                              +
                              + +
                              +
                              + since +
                              +
                              + 1.6.5 + +
                              + +
                              +
                              + contributor +
                              +
                              + +

                              @felipelavinz

                              +
                              + +
                              +
                              + link +
                              +
                              + https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 + +
                              +
                              + link +
                              +
                              + https://wordpress.org/support/topic/bug-function-create_function-is-deprecated/ + +
                              +
                              + link +
                              +
                              + https://wordpress.org/support/topic/deprecated-function-create_function-14/ + +
                              +
                              + link +
                              +
                              +

                              create_function() was deprecated in PHP 7.2.0 and removed in PHP 8.0.0.

                              +                               + +
                              +
                              + link +
                              +
                              +

                              The fix is to move add_action() above into run(), +and use the bare register_widget() here.

                              +                               + +
                              +
                              + reporter +
                              +
                              + +

                              @psykonevro

                              +
                              + +
                              +
                              + reporter +
                              +
                              + +

                              @daliasued

                              +
                              + +
                              +
                              + see +
                              +
                              + self::run() + +

                              Also, the visibility of initializeWidgets() is not private any longer.

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

                              + registerPublic() + +

                              + + +

                              Registers and enqueues scripts and stylesheets to the public pages.

                              + + + public + registerPublic() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + since +
                              +
                              + 2.0.0 + +

                              Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett bug reports, thanks to @vonpiernik code contribution.

                              +
                              + +
                              +
                              + since +
                              +
                              + 2.0.3 + +

                              add versioning of public.css for cache busting 2020-10-29T1413+0100

                              +
                              + +
                              +
                              + since +
                              +
                              + 2.0.4 + +

                              add jQuery UI from WordPress 2020-11-01T1902+0100

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

                              automate passing version number for cache busting 2020-11-30T0646+0100

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

                              optionally enqueue an extra stylesheet 2020-12-04T2231+0100

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

                              + run() + +

                              + + +

                              Executes the Plugin.

                              + + + public + run() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                                +
                              • Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution.
                                • +
                              +
                              + +
                              +
                              + since +
                              +
                              + 1.6.5 + +
                              + +
                              +
                              + contributor +
                              +
                              + +

                              @felipelavinz

                              +
                              + +
                              +
                              + link +
                              +
                              + https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 + +
                              +
                              + see +
                              +
                              + self::initializeWidgets() + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + initializeDashboard() + +

                              + + +

                              Initializes the Dashboard of the Plugin and loads them.

                              + + + private + initializeDashboard() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              +

                              + initializeTask() + +

                              + + +

                              Initializes the Plugin Task and registers the Task hooks.

                              + + + private + initializeTask() : mixed + +
                              + + + +
                              + Tags + +
                              +
                              +
                              + author +
                              +
                              + +

                              Stefan Herndler

                              +
                              + +
                              +
                              + since +
                              +
                              + 1.5.0 + +
                              + +
                              +
                              + +
                              Return values
                              + mixed + — +
                              + + +
                              +
                              + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + diff --git a/docs/css/base.css b/docs/css/base.css new file mode 100644 index 0000000..3fa8f23 --- /dev/null +++ b/docs/css/base.css @@ -0,0 +1,1002 @@ + +:root { + /* Typography */ + --font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + /* Colors */ + --primary-color: hsl(96, 57%, 60%); + --primary-color-darken: hsl(96, 57%, 40%); + --primary-color-darker: hsl(96, 57%, 20%); + --primary-color-lighten: hsl(96, 57%, 80%); + --primary-color-lighter: hsl(96, 57%, 97%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: #4b3b40; + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: #f7faf5; + --code-border-color: #d6e7cb; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darken); + --link-hover-color-primary: var(--primary-color-darker); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; + margin-top: 0; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; +} + +.phpdocumentor h1:hover .headerlink, +.phpdocumentor h2:hover .headerlink, +.phpdocumentor h3:hover .headerlink, +.phpdocumentor h4:hover .headerlink, +.phpdocumentor h5:hover .headerlink, +.phpdocumentor h6:hover .headerlink +{ + opacity: 1; +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-lg); + position: relative; + width: 100%; +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle inside; +} + +ol.phpdocumentor-list { + list-style: decimal inside; +} + +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: 0; + margin-bottom: var(--spacing-md); +} + +dl { + margin-bottom: var(--spacing-md); +} + +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: var(--spacing-xs) 0 var(--spacing-xs) calc(var(--spacing-xs) * 2); +} + +li.phpdocumentor-list { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; + font-size: var(--text-sm); +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 30.6666666667%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + list-style: none; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + font-size: 85%; + padding: .5rem; + margin: 2rem 0; + display: flex; + flex-direction: row; +} + +.phpdocumentor-admonition--success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + font-size: 2rem; + margin: .75rem 0.75rem 1.25rem 0.5rem; + color: var(--primary-color); +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-content { + position: relative; +} + +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} diff --git a/docs/css/normalize.css b/docs/css/normalize.css new file mode 100644 index 0000000..46f646a --- /dev/null +++ b/docs/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/css/template.css b/docs/css/template.css new file mode 100644 index 0000000..fb905f3 --- /dev/null +++ b/docs/css/template.css @@ -0,0 +1,169 @@ +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} + +.phpdocumentor-element:not(:last-child) { + border-bottom: 1px solid var(--primary-color-lighten); + padding-bottom: var(--spacing-lg); +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} +.phpdocumentor-signature { + display: inline-block; + font-size: var(--text-sm); + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + padding-top: var(--spacing-xs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + position: absolute; + top: 0; + right: 0; + font-size: var(--text-sm); + color: gray; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/docs/files/class-config.html b/docs/files/class-config.html new file mode 100644 index 0000000..27fa852 --- /dev/null +++ b/docs/files/class-config.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                +

                                Documentation

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

                                config.php

                                + + + +

                                + Interfaces, Classes and Traits + +

                                + +
                                + +
                                MCI_Footnotes_Config
                                +
                                Contains all Plugin Constants. Contains no Method or Property.
                                + +
                                + + + + + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + diff --git a/docs/files/class-convert.html b/docs/files/class-convert.html new file mode 100644 index 0000000..332a478 --- /dev/null +++ b/docs/files/class-convert.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

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

                                  convert.php

                                  + + + +

                                  + Interfaces, Classes and Traits + +

                                  + +
                                  + +
                                  MCI_Footnotes_Convert
                                  +
                                  Converts data types and Footnotes specific values.
                                  + +
                                  + + + + + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + diff --git a/docs/files/class-dashboard-init.html b/docs/files/class-dashboard-init.html new file mode 100644 index 0000000..b64a13d --- /dev/null +++ b/docs/files/class-dashboard-init.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

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

                                    init.php

                                    + + + +

                                    + Interfaces, Classes and Traits + +

                                    + +
                                    + +
                                    MCI_Footnotes_Layout_Init
                                    +
                                    Handles the Settings interface of the Plugin.
                                    + +
                                    + + + + + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + diff --git a/docs/files/class-dashboard-layout.html b/docs/files/class-dashboard-layout.html new file mode 100644 index 0000000..18778f8 --- /dev/null +++ b/docs/files/class-dashboard-layout.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

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

                                      layout.php

                                      + + + +

                                      + Interfaces, Classes and Traits + +

                                      + +
                                      + +
                                      MCI_Footnotes_LayoutEngine
                                      +
                                      Layout Engine for the administration dashboard.
                                      + +
                                      + + + + + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + diff --git a/docs/files/class-dashboard-subpage-diagnostics.html b/docs/files/class-dashboard-subpage-diagnostics.html new file mode 100644 index 0000000..e6ed92b --- /dev/null +++ b/docs/files/class-dashboard-subpage-diagnostics.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

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

                                        subpage-diagnostics.php

                                        + + + +

                                        + Interfaces, Classes and Traits + +

                                        + +
                                        + +
                                        MCI_Footnotes_Layout_Diagnostics
                                        +
                                        Displays Diagnostics of the web server, PHP and WordPress.
                                        + +
                                        + + + + + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + diff --git a/docs/files/class-dashboard-subpage-main.html b/docs/files/class-dashboard-subpage-main.html new file mode 100644 index 0000000..62a90fc --- /dev/null +++ b/docs/files/class-dashboard-subpage-main.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

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

                                          subpage-main.php

                                          + + + +

                                          + Interfaces, Classes and Traits + +

                                          + +
                                          + +
                                          MCI_Footnotes_Layout_Settings
                                          +
                                          Displays and handles all Settings of the Plugin.
                                          + +
                                          + + + + + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + diff --git a/docs/files/class-hooks.html b/docs/files/class-hooks.html new file mode 100644 index 0000000..b57ef84 --- /dev/null +++ b/docs/files/class-hooks.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

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

                                            hooks.php

                                            + + + +

                                            + Interfaces, Classes and Traits + +

                                            + +
                                            + +
                                            MCI_Footnotes_Hooks
                                            +
                                            Registers all WordPress Hooks and executes them on demand.
                                            + +
                                            + + + + + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + diff --git a/docs/files/class-init.html b/docs/files/class-init.html new file mode 100644 index 0000000..27020fe --- /dev/null +++ b/docs/files/class-init.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

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

                                              init.php

                                              + + + +

                                              + Interfaces, Classes and Traits + +

                                              + +
                                              + +
                                              MCI_Footnotes
                                              +
                                              Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                              + +
                                              + + + + + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + diff --git a/docs/files/class-language.html b/docs/files/class-language.html new file mode 100644 index 0000000..db941a6 --- /dev/null +++ b/docs/files/class-language.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

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

                                                language.php

                                                + + + +

                                                + Interfaces, Classes and Traits + +

                                                + +
                                                + +
                                                MCI_Footnotes_Language
                                                +
                                                Loads text domain of current or default language for localization.
                                                + +
                                                + + + + + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + diff --git a/docs/files/class-settings.html b/docs/files/class-settings.html new file mode 100644 index 0000000..910ad5e --- /dev/null +++ b/docs/files/class-settings.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

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

                                                  settings.php

                                                  + + + +

                                                  + Interfaces, Classes and Traits + +

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

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + diff --git a/docs/files/class-task.html b/docs/files/class-task.html new file mode 100644 index 0000000..d4b6618 --- /dev/null +++ b/docs/files/class-task.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

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

                                                    task.php

                                                    + + + +

                                                    + Interfaces, Classes and Traits + +

                                                    + +
                                                    + +
                                                    MCI_Footnotes_Task
                                                    +
                                                    Searches and replaces the footnotes.
                                                    + +
                                                    + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + diff --git a/docs/files/class-template.html b/docs/files/class-template.html new file mode 100644 index 0000000..09b8714 --- /dev/null +++ b/docs/files/class-template.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

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

                                                      template.php

                                                      + + + +

                                                      + Interfaces, Classes and Traits + +

                                                      + +
                                                      + +
                                                      MCI_Footnotes_Template
                                                      +
                                                      Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                      + +
                                                      + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + diff --git a/docs/files/class-widgets-base.html b/docs/files/class-widgets-base.html new file mode 100644 index 0000000..edfbc18 --- /dev/null +++ b/docs/files/class-widgets-base.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

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

                                                        base.php

                                                        + + + +

                                                        + Interfaces, Classes and Traits + +

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

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + diff --git a/docs/files/class-widgets-reference-container.html b/docs/files/class-widgets-reference-container.html new file mode 100644 index 0000000..9553b8a --- /dev/null +++ b/docs/files/class-widgets-reference-container.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

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

                                                          reference-container.php

                                                          + + + +

                                                          + Interfaces, Classes and Traits + +

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

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + diff --git a/docs/files/class-wysiwyg.html b/docs/files/class-wysiwyg.html new file mode 100644 index 0000000..59d1315 --- /dev/null +++ b/docs/files/class-wysiwyg.html @@ -0,0 +1,121 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

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

                                                            wysiwyg.php

                                                            + + + +

                                                            + Interfaces, Classes and Traits + +

                                                            + +
                                                            + +
                                                            MCI_Footnotes_WYSIWYG
                                                            +
                                                            + +
                                                            + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + diff --git a/docs/files/footnotes.html b/docs/files/footnotes.html new file mode 100644 index 0000000..132a72c --- /dev/null +++ b/docs/files/footnotes.html @@ -0,0 +1,110 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

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

                                                              footnotes.php

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

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + diff --git a/docs/files/includes.html b/docs/files/includes.html new file mode 100644 index 0000000..de8700d --- /dev/null +++ b/docs/files/includes.html @@ -0,0 +1,190 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

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

                                                                includes.php

                                                                + + + + + +

                                                                + Table of Contents + +

                                                                + +
                                                                +
                                                                + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                +
                                                                Requires (require_once) all *.php files inside a specific Directory.
                                                                + +
                                                                + + + + +
                                                                +

                                                                + Functions + +

                                                                +
                                                                +

                                                                + MCI_Footnotes_requirePhpFiles() + +

                                                                + + +

                                                                Requires (require_once) all *.php files inside a specific Directory.

                                                                + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                + +
                                                                Parameters
                                                                +
                                                                +
                                                                + $p_str_Directory + : string +
                                                                +
                                                                +

                                                                Absolute Directory path to lookup for *.php files

                                                                +
                                                                + +
                                                                +
                                                                + + +
                                                                + Tags + +
                                                                +
                                                                +
                                                                + author +
                                                                +
                                                                + +

                                                                Stefan Herndler

                                                                +
                                                                + +
                                                                +
                                                                + since +
                                                                +
                                                                + 1.5.0 + +
                                                                + +
                                                                +
                                                                + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html new file mode 100644 index 0000000..f77584f --- /dev/null +++ b/docs/graphs/classes.html @@ -0,0 +1,97 @@ + + + + + Documentation + + + + + + + + +
                                                                  +

                                                                  Documentation

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

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..003b277 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,223 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                    +

                                                                    Documentation

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

                                                                    Documentation

                                                                    + + + + +

                                                                    + Interfaces, Classes and Traits + +

                                                                    + +
                                                                    + +
                                                                    MCI_Footnotes_Config
                                                                    +
                                                                    Contains all Plugin Constants. Contains no Method or Property.
                                                                    +
                                                                    MCI_Footnotes_Convert
                                                                    +
                                                                    Converts data types and Footnotes specific values.
                                                                    +
                                                                    MCI_Footnotes_Layout_Init
                                                                    +
                                                                    Handles the Settings interface of the Plugin.
                                                                    +
                                                                    MCI_Footnotes_LayoutEngine
                                                                    +
                                                                    Layout Engine for the administration dashboard.
                                                                    +
                                                                    MCI_Footnotes_Layout_Diagnostics
                                                                    +
                                                                    Displays Diagnostics of the web server, PHP and WordPress.
                                                                    +
                                                                    MCI_Footnotes_Layout_Settings
                                                                    +
                                                                    Displays and handles all Settings of the Plugin.
                                                                    +
                                                                    MCI_Footnotes_Hooks
                                                                    +
                                                                    Registers all WordPress Hooks and executes them on demand.
                                                                    +
                                                                    MCI_Footnotes
                                                                    +
                                                                    Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                    +
                                                                    MCI_Footnotes_Language
                                                                    +
                                                                    Loads text domain of current or default language for localization.
                                                                    +
                                                                    MCI_Footnotes_Settings
                                                                    +
                                                                    Loads the settings values, sets to default values if undefined.
                                                                    +
                                                                    MCI_Footnotes_Task
                                                                    +
                                                                    Searches and replaces the footnotes.
                                                                    +
                                                                    MCI_Footnotes_Template
                                                                    +
                                                                    Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                    +
                                                                    MCI_Footnotes_WidgetBase
                                                                    +
                                                                    Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                    +
                                                                    MCI_Footnotes_Widget_ReferenceContainer
                                                                    +
                                                                    Registers a Widget to put the Reference Container to the widget area.
                                                                    +
                                                                    MCI_Footnotes_WYSIWYG
                                                                    +
                                                                    + +
                                                                    + + +

                                                                    + Table of Contents + +

                                                                    + +
                                                                    +
                                                                    + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                    +
                                                                    Requires (require_once) all *.php files inside a specific Directory.
                                                                    + +
                                                                    + + + +
                                                                    +

                                                                    + Functions + +

                                                                    +
                                                                    +

                                                                    + MCI_Footnotes_requirePhpFiles() + +

                                                                    + + +

                                                                    Requires (require_once) all *.php files inside a specific Directory.

                                                                    + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                    + +
                                                                    Parameters
                                                                    +
                                                                    +
                                                                    + $p_str_Directory + : string +
                                                                    +
                                                                    +

                                                                    Absolute Directory path to lookup for *.php files

                                                                    +
                                                                    + +
                                                                    +
                                                                    + + +
                                                                    + Tags + +
                                                                    +
                                                                    +
                                                                    + author +
                                                                    +
                                                                    + +

                                                                    Stefan Herndler

                                                                    +
                                                                    + +
                                                                    +
                                                                    + since +
                                                                    +
                                                                    + 1.5.0 + +
                                                                    + +
                                                                    +
                                                                    + + +
                                                                    +
                                                                    + +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html new file mode 100644 index 0000000..7ac73fe --- /dev/null +++ b/docs/indices/files.html @@ -0,0 +1,142 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                      +

                                                                      Documentation

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

                                                                      Files

                                                                      +

                                                                      B

                                                                      + +

                                                                      C

                                                                      + +

                                                                      F

                                                                      + +

                                                                      H

                                                                      + +

                                                                      I

                                                                      + +

                                                                      L

                                                                      + +

                                                                      R

                                                                      + +

                                                                      S

                                                                      + +

                                                                      T

                                                                      + +

                                                                      W

                                                                      + +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + diff --git a/docs/js/search.js b/docs/js/search.js new file mode 100644 index 0000000..a7e3595 --- /dev/null +++ b/docs/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                                        ' + result.name + "

                                                                        \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                                        ' + result.summary + '
                                                                        '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js new file mode 100644 index 0000000..ca8f2cc --- /dev/null +++ b/docs/js/searchIndex.js @@ -0,0 +1,1419 @@ +Search.appendIndex( + [ + { + "fqsen": "\\MCI_Footnotes_Config", + "name": "MCI_Footnotes_Config", + "summary": "Contains\u0020all\u0020Plugin\u0020Constants.\u0020Contains\u0020no\u0020Method\u0020or\u0020Property.", + "url": "classes/MCI-Footnotes-Config.html" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_NAME", + "name": "C_STR_PLUGIN_NAME", + "summary": "Internal\u0020Plugin\u0020name.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_PUBLIC_NAME", + "name": "C_STR_PLUGIN_PUBLIC_NAME", + "summary": "Public\u0020Plugin\u0020name.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_PLUGIN_HEADING_NAME", + "name": "C_STR_PLUGIN_HEADING_NAME", + "summary": "Public\u0020Plugin\u0020name\u0020for\u0020dashboard\u0020heading", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL", + "name": "C_STR_LOVE_SYMBOL", + "summary": "Html\u0020tag\u0020for\u0020the\u0020LOVE\u0020symbol.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL_HEADING", + "name": "C_STR_LOVE_SYMBOL_HEADING", + "summary": "HTML\u0020code\u0020for\u0020the\u0020\u0027love\u0027\u0020symbol\u0020used\u0020in\u0020dashboard\u0020heading", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" + }, { + "fqsen": "\\MCI_Footnotes_Config\u003A\u003AC_STR_NO_LOVE_SLUG", + "name": "C_STR_NO_LOVE_SLUG", + "summary": "Short\u0020code\u0020to\u0020DON\u0027T\u0020display\u0020the\u0020\u0027LOVE\u0020ME\u0027\u0020slug\u0020on\u0020certain\u0020pages.", + "url": "classes/MCI-Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Convert", + "name": "MCI_Footnotes_Convert", + "summary": "Converts\u0020data\u0020types\u0020and\u0020Footnotes\u0020specific\u0020values.", + "url": "classes/MCI-Footnotes-Convert.html" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AIndex\u0028\u0029", + "name": "Index", + "summary": "Converts\u0020a\u0020integer\u0020into\u0020the\u0020user\u002Ddefined\u0020counter\u0020style\u0020for\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Convert.html#method_Index" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoLatin\u0028\u0029", + "name": "toLatin", + "summary": "Converts\u0020an\u0020integer\u0020into\u0020latin\u0020ascii\u0020characters,\u0020either\u0020lower\u0020or\u0020upper\u002Dcase.", + "url": "classes/MCI-Footnotes-Convert.html#method_toLatin" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoArabicLeading\u0028\u0029", + "name": "toArabicLeading", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020leading\u002D0\u0020integer.", + "url": "classes/MCI-Footnotes-Convert.html#method_toArabicLeading" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoRomanic\u0028\u0029", + "name": "toRomanic", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020romanic\u0020letter.", + "url": "classes/MCI-Footnotes-Convert.html#method_toRomanic" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AtoBool\u0028\u0029", + "name": "toBool", + "summary": "Converts\u0020a\u0020string\u0020depending\u0020on\u0020its\u0020value\u0020to\u0020a\u0020boolean.", + "url": "classes/MCI-Footnotes-Convert.html#method_toBool" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003AgetArrow\u0028\u0029", + "name": "getArrow", + "summary": "Get\u0020a\u0020html\u0020Array\u0020short\u0020code\u0020depending\u0020on\u0020Arrow\u002DArray\u0020key\u0020index.", + "url": "classes/MCI-Footnotes-Convert.html#method_getArrow" + }, { + "fqsen": "\\MCI_Footnotes_Convert\u003A\u003Adebug\u0028\u0029", + "name": "debug", + "summary": "Displays\u0020a\u0020Variable.", + "url": "classes/MCI-Footnotes-Convert.html#method_debug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init", + "name": "MCI_Footnotes_Layout_Init", + "summary": "Handles\u0020the\u0020Settings\u0020interface\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AinitializeSettings\u0028\u0029", + "name": "initializeSettings", + "summary": "Initializes\u0020all\u0020sub\u0020pages\u0020and\u0020registers\u0020the\u0020settings.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterMainMenu\u0028\u0029", + "name": "registerMainMenu", + "summary": "Registers\u0020the\u0020new\u0020main\u0020menu\u0020for\u0020the\u0020WordPress\u0020dashboard.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AregisterSubPages\u0028\u0029", + "name": "registerSubPages", + "summary": "Registers\u0020all\u0020SubPages\u0020for\u0020this\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AdisplayOtherPlugins\u0028\u0029", + "name": "displayOtherPlugins", + "summary": "Displays\u0020other\u0020Plugins\u0020from\u0020the\u0020developers.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AgetPluginMetaInformation\u0028\u0029", + "name": "getPluginMetaInformation", + "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_SLUG", + "name": "C_STR_MAIN_MENU_SLUG", + "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", + "url": "classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_TITLE", + "name": "C_STR_MAIN_MENU_TITLE", + "summary": "Plugin\u0020main\u0020menu\u0020name.", + "url": "classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Init\u003A\u003A\u0024a_arr_SubPageClasses", + "name": "a_arr_SubPageClasses", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine", + "name": "MCI_Footnotes_LayoutEngine", + "summary": "Layout\u0020Engine\u0020for\u0020the\u0020administration\u0020dashboard.", + "url": "classes/MCI-Footnotes-LayoutEngine.html" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSection\u0028\u0029", + "name": "addSection", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020sub\u0020page\u0020section.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSection" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddMetaBox\u0028\u0029", + "name": "addMetaBox", + "summary": "Returns\u0020an\u0020array\u0020describing\u0020a\u0020meta\u0020box.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addMetaBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSubPage\u0028\u0029", + "name": "registerSubPage", + "summary": "Registers\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSubPage" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterSections\u0028\u0029", + "name": "registerSections", + "summary": "Registers\u0020all\u0020sections\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerSections" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AregisterMetaBoxes\u0028\u0029", + "name": "registerMetaBoxes", + "summary": "Registers\u0020all\u0020Meta\u0020boxes\u0020for\u0020a\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_registerMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AappendScripts\u0028\u0029", + "name": "appendScripts", + "summary": "Append\u0020javascript\u0020and\u0020css\u0020files\u0020for\u0020specific\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_appendScripts" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AdisplayContent\u0028\u0029", + "name": "displayContent", + "summary": "Displays\u0020the\u0020content\u0020of\u0020specific\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_displayContent" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AsaveSettings\u0028\u0029", + "name": "saveSettings", + "summary": "Save\u0020all\u0020Plugin\u0020settings.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_saveSettings" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ADescription\u0028\u0029", + "name": "Description", + "summary": "Output\u0020the\u0020Description\u0020of\u0020a\u0020section.\u0020May\u0020be\u0020overwritten\u0020in\u0020any\u0020section.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_Description" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003ALoadSetting\u0028\u0029", + "name": "LoadSetting", + "summary": "Loads\u0020specific\u0020setting\u0020and\u0020returns\u0020an\u0020array\u0020with\u0020the\u0020keys\u0020\u005Bid,\u0020name,\u0020value\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_LoadSetting" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNewline\u0028\u0029", + "name": "addNewline", + "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020start\u0020a\u0020new\u0020line.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNewline" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLineSpace\u0028\u0029", + "name": "addLineSpace", + "summary": "Returns\u0020a\u0020line\u0020break\u0020to\u0020have\u0020a\u0020space\u0020between\u0020two\u0020lines.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLineSpace" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddText\u0028\u0029", + "name": "addText", + "summary": "Returns\u0020a\u0020simple\u0020text\u0020inside\u0020html\u0020\u003Cspan\u003E\u0020text.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addText" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddLabel\u0028\u0029", + "name": "addLabel", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\/select\u0020label.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addLabel" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextBox\u0028\u0029", + "name": "addTextBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddCheckbox\u0028\u0029", + "name": "addCheckbox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020checkbox\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addCheckbox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddSelectBox\u0028\u0029", + "name": "addSelectBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020select\u0020box.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addSelectBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddTextArea\u0028\u0029", + "name": "addTextArea", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020a\u0020text\u0020area.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addTextArea" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddColorSelection\u0028\u0029", + "name": "addColorSelection", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020text\u005D\u0020with\u0020color\u0020selection\u0020class.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addColorSelection" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003AaddNumBox\u0028\u0029", + "name": "addNumBox", + "summary": "Returns\u0020the\u0020html\u0020tag\u0020for\u0020an\u0020input\u0020\u005Btype\u0020\u003D\u0020num\u005D.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#method_addNumBox" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_str_SubPageHook", + "name": "a_str_SubPageHook", + "summary": "Stores\u0020the\u0020Hook\u0020connection\u0020string\u0020for\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_str_SubPageHook" + }, { + "fqsen": "\\MCI_Footnotes_LayoutEngine\u003A\u003A\u0024a_arr_Sections", + "name": "a_arr_Sections", + "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-LayoutEngine.html#property_a_arr_Sections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics", + "name": "MCI_Footnotes_Layout_Diagnostics", + "summary": "Displays\u0020Diagnostics\u0020of\u0020the\u0020web\u0020server,\u0020PHP\u0020and\u0020WordPress.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Diagnostics\u003A\u003ADiagnostics\u0028\u0029", + "name": "Diagnostics", + "summary": "Displays\u0020a\u0020diagnostics\u0020about\u0020the\u0020web\u0020server,\u0020php\u0020and\u0020WordPress.", + "url": "classes/MCI-Footnotes-Layout-Diagnostics.html#method_Diagnostics" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings", + "name": "MCI_Footnotes_Layout_Settings", + "summary": "Displays\u0020and\u0020handles\u0020all\u0020Settings\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Settings.html" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetPriority\u0028\u0029", + "name": "getPriority", + "summary": "Returns\u0020a\u0020Priority\u0020index.\u0020Lower\u0020numbers\u0020have\u0020a\u0020higher\u0020Priority.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getPriority" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageSlug\u0028\u0029", + "name": "getSubPageSlug", + "summary": "Returns\u0020the\u0020unique\u0020slug\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageSlug" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSubPageTitle\u0028\u0029", + "name": "getSubPageTitle", + "summary": "Returns\u0020the\u0020title\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSubPageTitle" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetSections\u0028\u0029", + "name": "getSections", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020sections\u0020for\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getSections" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AgetMetaBoxes\u0028\u0029", + "name": "getMetaBoxes", + "summary": "Returns\u0020an\u0020array\u0020of\u0020all\u0020registered\u0020meta\u0020boxes\u0020for\u0020each\u0020section\u0020of\u0020the\u0020sub\u0020page.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_getMetaBoxes" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AReferenceContainer\u0028\u0029", + "name": "ReferenceContainer", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_ReferenceContainer" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AStartEnd\u0028\u0029", + "name": "StartEnd", + "summary": "Displays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020start\u0020and\u0020end\u0020tag\u0020short\u0020codes\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020footnotes\u0020numbering\nDisplays\u0020all\u0020options\u0020for\u0020the\u0020scrolling\u0020behavior", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_StartEnd" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ANumbering\u0028\u0029", + "name": "Numbering", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Numbering" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AScrolling\u0028\u0029", + "name": "Scrolling", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Scrolling" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALove\u0028\u0029", + "name": "Love", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020\u0027I\u0020love\u0020Footnotes\u0027.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Love" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AExcerpts\u0028\u0029", + "name": "Excerpts", + "summary": "Displays\u0020the\u0020excerpt\u0020setting", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Excerpts" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ASuperscript\u0028\u0029", + "name": "Superscript", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnote\u0020referrers", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Superscript" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBox\u0028\u0029", + "name": "MouseOverBox", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020footnotes\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBox" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxPosition\u0028\u0029", + "name": "MouseOverBoxPosition", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxPosition" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxDimensions\u0028\u0029", + "name": "MouseOverBoxDimensions", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxDimensions" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTiming\u0028\u0029", + "name": "MouseOverBoxTiming", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTiming" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxTruncation\u0028\u0029", + "name": "MouseOverBoxTruncation", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxTruncation" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxText\u0028\u0029", + "name": "MouseOverBoxText", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxText" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AMouseOverBoxAppearance\u0028\u0029", + "name": "MouseOverBoxAppearance", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_MouseOverBoxAppearance" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHyperlinkArrow\u0028\u0029", + "name": "HyperlinkArrow", + "summary": "Displays\u0020all\u0020settings\u0020for\u0020the\u0020prepended\u0020symbol", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_HyperlinkArrow" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSS\u0028\u0029", + "name": "CustomCSS", + "summary": "Displays\u0020the\u0020custom\u0020css\u0020box.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSS" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSMigration\u0028\u0029", + "name": "CustomCSSMigration", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSMigration" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ACustomCSSNew\u0028\u0029", + "name": "CustomCSSNew", + "summary": "", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_CustomCSSNew" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ALookupHooks\u0028\u0029", + "name": "LookupHooks", + "summary": "Displays\u0020available\u0020Hooks\u0020to\u0020look\u0020for\u0020Footnote\u0020short\u0020codes.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_LookupHooks" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003AHelp\u0028\u0029", + "name": "Help", + "summary": "Displays\u0020a\u0020short\u0020introduction\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Help" + }, { + "fqsen": "\\MCI_Footnotes_Layout_Settings\u003A\u003ADonate\u0028\u0029", + "name": "Donate", + "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", + "url": "classes/MCI-Footnotes-Layout-Settings.html#method_Donate" + }, { + "fqsen": "\\MCI_Footnotes_Hooks", + "name": "MCI_Footnotes_Hooks", + "summary": "Registers\u0020all\u0020WordPress\u0020Hooks\u0020and\u0020executes\u0020them\u0020on\u0020demand.", + "url": "classes/MCI-Footnotes-Hooks.html" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Registers\u0020all\u0020WordPress\u0020hooks.", + "url": "classes/MCI-Footnotes-Hooks.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AactivatePlugin\u0028\u0029", + "name": "activatePlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020activated.", + "url": "classes/MCI-Footnotes-Hooks.html#method_activatePlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AdeactivatePlugin\u0028\u0029", + "name": "deactivatePlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020deactivated.", + "url": "classes/MCI-Footnotes-Hooks.html#method_deactivatePlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003AuninstallPlugin\u0028\u0029", + "name": "uninstallPlugin", + "summary": "Executed\u0020when\u0020the\u0020Plugin\u0020gets\u0020uninstalled.", + "url": "classes/MCI-Footnotes-Hooks.html#method_uninstallPlugin" + }, { + "fqsen": "\\MCI_Footnotes_Hooks\u003A\u003APluginLinks\u0028\u0029", + "name": "PluginLinks", + "summary": "Add\u0020Links\u0020to\u0020the\u0020Plugin\u0020in\u0020the\u0020\u0022installed\u0020Plugins\u0022\u0020page.", + "url": "classes/MCI-Footnotes-Hooks.html#method_PluginLinks" + }, { + "fqsen": "\\MCI_Footnotes", + "name": "MCI_Footnotes", + "summary": "Entry\u0020point\u0020of\u0020the\u0020Plugin.\u0020Loads\u0020the\u0020Dashboard\u0020and\u0020executes\u0020the\u0020Task.", + "url": "classes/MCI-Footnotes.html" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003Arun\u0028\u0029", + "name": "run", + "summary": "Executes\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes.html#method_run" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeWidgets\u0028\u0029", + "name": "initializeWidgets", + "summary": "Initializes\u0020all\u0020Widgets\u0020of\u0020the\u0020Plugin.", + "url": "classes/MCI-Footnotes.html#method_initializeWidgets" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeDashboard\u0028\u0029", + "name": "initializeDashboard", + "summary": "Initializes\u0020the\u0020Dashboard\u0020of\u0020the\u0020Plugin\u0020and\u0020loads\u0020them.", + "url": "classes/MCI-Footnotes.html#method_initializeDashboard" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AinitializeTask\u0028\u0029", + "name": "initializeTask", + "summary": "Initializes\u0020the\u0020Plugin\u0020Task\u0020and\u0020registers\u0020the\u0020Task\u0020hooks.", + "url": "classes/MCI-Footnotes.html#method_initializeTask" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003AregisterPublic\u0028\u0029", + "name": "registerPublic", + "summary": "Registers\u0020and\u0020enqueues\u0020scripts\u0020and\u0020stylesheets\u0020to\u0020the\u0020public\u0020pages.", + "url": "classes/MCI-Footnotes.html#method_registerPublic" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_obj_Task", + "name": "a_obj_Task", + "summary": "Reference\u0020to\u0020the\u0020Plugin\u0020Task\u0020object.", + "url": "classes/MCI-Footnotes.html#property_a_obj_Task" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_TooltipsEnabled", + "name": "a_bool_TooltipsEnabled", + "summary": "Template\u0020process\u0020and\u0020script\u0020\/\u0020stylesheet\u0020load\u0020optimization.", + "url": "classes/MCI-Footnotes.html#property_a_bool_TooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", + "name": "a_bool_AlternativeTooltipsEnabled", + "summary": "", + "url": "classes/MCI-Footnotes.html#property_a_bool_AlternativeTooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Language", + "name": "MCI_Footnotes_Language", + "summary": "Loads\u0020text\u0020domain\u0020of\u0020current\u0020or\u0020default\u0020language\u0020for\u0020localization.", + "url": "classes/MCI-Footnotes-Language.html" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Register\u0020WordPress\u0020Hook.", + "url": "classes/MCI-Footnotes-Language.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003AloadTextDomain\u0028\u0029", + "name": "loadTextDomain", + "summary": "Loads\u0020the\u0020text\u0020domain\u0020for\u0020current\u0020WordPress\u0020language\u0020if\u0020exists.", + "url": "classes/MCI-Footnotes-Language.html#method_loadTextDomain" + }, { + "fqsen": "\\MCI_Footnotes_Language\u003A\u003Aload\u0028\u0029", + "name": "load", + "summary": "Loads\u0020a\u0020specific\u0020text\u0020domain.", + "url": "classes/MCI-Footnotes-Language.html#method_load" + }, { + "fqsen": "\\MCI_Footnotes_Settings", + "name": "MCI_Footnotes_Settings", + "summary": "Loads\u0020the\u0020settings\u0020values,\u0020sets\u0020to\u0020default\u0020values\u0020if\u0020undefined.", + "url": "classes/MCI-Footnotes-Settings.html" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Loads\u0020all\u0020Settings\u0020from\u0020each\u0020WordPress\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Ainstance\u0028\u0029", + "name": "instance", + "summary": "Returns\u0020a\u0020singleton\u0020of\u0020this\u0020class.", + "url": "classes/MCI-Footnotes-Settings.html#method_instance" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetContainer\u0028\u0029", + "name": "getContainer", + "summary": "Returns\u0020the\u0020name\u0020of\u0020a\u0020specified\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_getContainer" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AgetDefaults\u0028\u0029", + "name": "getDefaults", + "summary": "Returns\u0020the\u0020default\u0020values\u0020of\u0020a\u0020specific\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_getDefaults" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AloadAll\u0028\u0029", + "name": "loadAll", + "summary": "Loads\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method_loadAll" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ALoad\u0028\u0029", + "name": "Load", + "summary": "Loads\u0020all\u0020Settings\u0020from\u0020specified\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_Load" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AsaveOptions\u0028\u0029", + "name": "saveOptions", + "summary": "Updates\u0020a\u0020whole\u0020Settings\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#method_saveOptions" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Returns\u0020the\u0020value\u0020of\u0020specified\u0020Settings\u0020name.", + "url": "classes/MCI-Footnotes-Settings.html#method_get" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AClearAll\u0028\u0029", + "name": "ClearAll", + "summary": "Deletes\u0020each\u0020Settings\u0020Container\u0020and\u0020loads\u0020the\u0020default\u0020values\u0020for\u0020each\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#method_ClearAll" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003ARegisterSettings\u0028\u0029", + "name": "RegisterSettings", + "summary": "Register\u0020all\u0020Settings\u0020Container\u0020for\u0020the\u0020Plugin\u0020Settings\u0020Page\u0020in\u0020the\u0020Dashboard.", + "url": "classes/MCI-Footnotes-Settings.html#method_RegisterSettings" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_NAME", + "name": "C_STR_REFERENCE_CONTAINER_NAME", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_NAME" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_COLLAPSE", + "name": "C_BOOL_REFERENCE_CONTAINER_COLLAPSE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020collapse\u0020the\u0020reference\u0020container\u0020by\u0020default.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_COLLAPSE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION", + "name": "C_STR_REFERENCE_CONTAINER_POSITION", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020position\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_COMBINE_IDENTICAL_FOOTNOTES", + "name": "C_BOOL_COMBINE_IDENTICAL_FOOTNOTES", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020combining\u0020identical\u0020footnotes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_COMBINE_IDENTICAL_FOOTNOTES" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START", + "name": "C_STR_FOOTNOTES_SHORT_CODE_START", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020start.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END", + "name": "C_STR_FOOTNOTES_SHORT_CODE_END", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020short\u0020code\u0020of\u0020the\u0020footnote\u2019s\u0020end.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", + "name": "C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020start.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_START_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", + "name": "C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020short\u0020code\u0020of\u0020the\u0020footnotes\u0020end.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_SHORT_CODE_END_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_COUNTER_STYLE", + "name": "C_STR_FOOTNOTES_COUNTER_STYLE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020counter\u0020style\u0020of\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_COUNTER_STYLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_LOVE", + "name": "C_STR_FOOTNOTES_LOVE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020\u0027I\u0020love\u0020footnotes\u0027\u0020text.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_LOVE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_IN_EXCERPT", + "name": "C_BOOL_FOOTNOTES_IN_EXCERPT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020look\u0020for\u0020footnotes\u0020in\u0020post\u0020excerpts.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_IN_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_EXPERT_MODE", + "name": "C_BOOL_FOOTNOTES_EXPERT_MODE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Expert\u0020mode.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_EXPERT_MODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_BEFORE", + "name": "C_STR_FOOTNOTES_STYLING_BEFORE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020before\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_BEFORE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_STYLING_AFTER", + "name": "C_STR_FOOTNOTES_STYLING_AFTER", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020string\u0020after\u0020the\u0020footnote\u0020referrer.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_STYLING_AFTER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020mouse\u002Dover\u0020box.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020alternative\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_ALTERNATIVE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "name": "C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020tooltip\u0020truncation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020length\u0020of\u0020the\u0020enabled\u0020excerpt.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_EXCERPT_LENGTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020position.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028x\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_X" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020offset\u0020\u0028y\u0029.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_OFFSET_Y" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020background\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BACKGROUND" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_BORDER_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020border\u0020radius.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_BORDER_RADIUS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "name": "C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020max.\u0020width.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_MOUSE_OVER_BOX_MAX_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "name": "C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020mouse\u002Dover\u0020box\u0020to\u0020define\u0020the\u0020box\u002Dshadow\u0020color.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_MOUSE_OVER_BOX_SHADOW_COLOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW", + "name": "C_STR_HYPERLINK_ARROW", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020backlink\u0020symbol\u0020selection.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HYPERLINK_ARROW_USER_DEFINED", + "name": "C_STR_HYPERLINK_ARROW_USER_DEFINED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020user\u002Ddefined\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HYPERLINK_ARROW_USER_DEFINED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS", + "name": "C_STR_CUSTOM_CSS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_CUSTOM_CSS_NEW", + "name": "C_STR_CUSTOM_CSS_NEW", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020Custom\u0020CSS\u0020migrated\u0020to\u0020a\u0020dedicated\u0020tab.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_CUSTOM_CSS_NEW" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_CUSTOM_CSS_LEGACY_ENABLE", + "name": "C_BOOL_CUSTOM_CSS_LEGACY_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020display\u0020of\u0020legacy\u0020Custom\u0020CSS\u0020metaboxes.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_CUSTOM_CSS_LEGACY_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_TITLE", + "name": "C_BOOL_EXPERT_LOOKUP_THE_TITLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_CONTENT", + "name": "C_BOOL_EXPERT_LOOKUP_THE_CONTENT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_content\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_CONTENT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_THE_EXCERPT", + "name": "C_BOOL_EXPERT_LOOKUP_THE_EXCERPT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027the_excerpt\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_THE_EXCERPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", + "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_title\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TITLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", + "name": "C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020\u0027widget_text\u0027\u0020hook.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_EXPERT_LOOKUP_WIDGET_TEXT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_READON_LABEL", + "name": "C_STR_FOOTNOTES_TOOLTIP_READON_LABEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020label\u0020of\u0020the\u0020Read\u002Don\u0020button\u0020in\u0020truncated\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_READON_LABEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "name": "C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020the\u0020referrer\u0020element.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_REFERRER_SUPERSCRIPT_TAGS" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020display\u0020of\u0020a\u0020backlink\u0020symbol.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020not\u0020display\u0020the\u0020reference\u0020container\u0020on\u0020the\u0020homepage.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_START_PAGE_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020enable\u0020the\u0020legacy\u0020layout\u0020of\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_3COLUMN_LAYOUT_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "name": "C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH", + "summary": "Settings\u0020Container\u0020Key\u0020to\u0020get\u0020the\u0020backlink\u0020symbol\u0020switch\u0020side.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_BACKLINK_SYMBOL_SWITCH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027the_content\u0027\u0020hook\u0020priority\u0020level.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_CONTENT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020\u0027\u0027\u0020hook\u0020priority\u0020level", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_TITLE_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TITLE_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_WIDGET_TEXT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", + "name": "C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_EXPERT_LOOKUP_THE_EXCERPT_PRIORITY_LEVEL" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_LINK_ELEMENT_ENABLED", + "name": "C_BOOL_LINK_ELEMENT_ENABLED", + "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020the\u0020link\u0020element\u0020option\nSettings\u0020Container\u0020Keys\u0020for\u0020backlink\u0020typography\u0020and\u0020layout\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020font\u0020size\nSettings\u0020Container\u0020Keys\u0020for\u0020page\u0020layout\u0020support\nSettings\u0020Container\u0020Keys\u0020for\u0020scroll\u0020offset\u0020and\u0020duration\nSettings\u0020Container\u0020Keys\u0020for\u0020tooltip\u0020display\u0020durations", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_LINK_ELEMENT_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_SEPARATOR_ENABLED", + "name": "C_BOOL_BACKLINKS_SEPARATOR_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_SEPARATOR_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_OPTION", + "name": "C_STR_BACKLINKS_SEPARATOR_OPTION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_OPTION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_SEPARATOR_CUSTOM", + "name": "C_STR_BACKLINKS_SEPARATOR_CUSTOM", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_SEPARATOR_CUSTOM" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_TERMINATOR_ENABLED", + "name": "C_BOOL_BACKLINKS_TERMINATOR_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_TERMINATOR_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_OPTION", + "name": "C_STR_BACKLINKS_TERMINATOR_OPTION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_OPTION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_TERMINATOR_CUSTOM", + "name": "C_STR_BACKLINKS_TERMINATOR_CUSTOM", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_TERMINATOR_CUSTOM" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", + "name": "C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_WIDTH_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", + "name": "C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_WIDTH_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_WIDTH_UNIT", + "name": "C_STR_BACKLINKS_COLUMN_WIDTH_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_WIDTH_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "name": "C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_COLUMN_MAX_WIDTH_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", + "name": "C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_BACKLINKS_COLUMN_MAX_WIDTH_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", + "name": "C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_BACKLINKS_COLUMN_MAX_WIDTH_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", + "name": "C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_BACKLINKS_LINE_BREAKS_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "name": "C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_MOUSE_OVER_BOX_FONT_SIZE_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", + "name": "C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_FLO_MOUSE_OVER_BOX_FONT_SIZE_SCALAR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", + "name": "C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_MOUSE_OVER_BOX_FONT_SIZE_UNIT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", + "name": "C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_PAGE_LAYOUT_SUPPORT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_OFFSET", + "name": "C_INT_FOOTNOTES_SCROLL_OFFSET", + "summary": "Scroll\u0020offset\u0020and\u0020duration", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_OFFSET" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_SCROLL_DURATION", + "name": "C_INT_FOOTNOTES_SCROLL_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_SCROLL_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", + "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", + "name": "C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_IN_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", + "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DELAY" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", + "name": "C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_MOUSE_OVER_BOX_FADE_OUT_DURATION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_URL_WRAP_ENABLED", + "name": "C_BOOL_FOOTNOTE_URL_WRAP_ENABLED", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020URL\u0020wrap\u0020option", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_URL_WRAP_ENABLED" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", + "name": "C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020reference\u0020container\u0020position\u0020shortcode", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_POSITION_SHORTCODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", + "name": "C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION", + "summary": "Settings\u0020Container\u0020Keys\u0020for\u0020alternative\u0020tooltip\u0020position\nSettings\u0020Container\u0020Keys\u0020for\u0020reference\u0020container\u0020label\u0020element,\u0020thanks\u0020to\u0020\u0040markhillyer", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_POSITION" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_X" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_OFFSET_Y" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", + "name": "C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_FOOTNOTES_ALTERNATIVE_MOUSE_OVER_BOX_WIDTH" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", + "name": "C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERENCE_CONTAINER_LABEL_ELEMENT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "name": "C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_LABEL_BOTTOM_BORDER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "name": "C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE", + "summary": "Settings\u0020Container\u0020Key\u0020for\u0020table\u0020cell\u0020borders,\u0020thanks\u0020to\u0020\u0040noobishh", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_REFERENCE_CONTAINER_ROW_BORDERS_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_TOP_MARGIN", + "name": "C_INT_REFERENCE_CONTAINER_TOP_MARGIN", + "summary": "Settings\u0020container\u0020keys\u0020for\u0020reference\u0020container\u0020top\u0020and\u0020bottom\u0020margins\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020enabling\nSettings\u0020container\u0020keys\u0020for\u0020hard\u0020link\u0020anchors\u0020in\u0020referrers\u0020and\u0020footnotes", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_TOP_MARGIN" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", + "name": "C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_INT_REFERENCE_CONTAINER_BOTTOM_MARGIN" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", + "name": "C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_HARD_LINKS_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_REFERRER_FRAGMENT_ID_SLUG", + "name": "C_STR_REFERRER_FRAGMENT_ID_SLUG", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_REFERRER_FRAGMENT_ID_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_FRAGMENT_ID_SLUG", + "name": "C_STR_FOOTNOTE_FRAGMENT_ID_SLUG", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_FRAGMENT_ID_SLUG" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_HARD_LINK_IDS_SEPARATOR", + "name": "C_STR_HARD_LINK_IDS_SEPARATOR", + "summary": "", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_HARD_LINK_IDS_SEPARATOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "name": "C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020for\u0020shortcode\u0020syntax\u0020validation.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTE_SHORTCODE_SYNTAX_VALIDATION_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "name": "C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020backlink\u0020tooltips.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_BACKLINK_TOOLTIP_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", + "name": "C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020backlink\u0020tooltip.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_BACKLINK_TOOLTIP_TEXT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER", + "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020tooltip\u0020excerpt\u0020delimiter.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_DELIMITER" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "name": "C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020mirroring\u0020the\u0020tooltip\u0020excerpt\u0020in\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_BOOL_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_ENABLE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", + "name": "C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR", + "summary": "Settings\u0020container\u0020key\u0020to\u0020configure\u0020the\u0020tooltip\u0020excerpt\u0020separator\u0020in\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_TOOLTIP_EXCERPT_MIRROR_SEPARATOR" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT", + "name": "C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT", + "summary": "Settings\u0020container\u0020key\u0020to\u0020enable\u0020superscript\u0020style\u0020normalization.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTE_REFERRERS_NORMAL_SUPERSCRIPT" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003AC_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE", + "name": "C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE", + "summary": "Settings\u0020container\u0020key\u0020to\u0020select\u0020the\u0020script\u0020mode\u0020for\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Settings.html#constant_C_STR_FOOTNOTES_REFERENCE_CONTAINER_SCRIPT_MODE" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_obj_Instance", + "name": "a_obj_Instance", + "summary": "Stores\u0020a\u0020singleton\u0020reference\u0020of\u0020this\u0020class.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_obj_Instance" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Container", + "name": "a_arr_Container", + "summary": "Contains\u0020all\u0020Settings\u0020Container\u0020names.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Container" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Default", + "name": "a_arr_Default", + "summary": "Contains\u0020all\u0020Default\u0020Settings\u0020for\u0020each\u0020Settings\u0020Container.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Default" + }, { + "fqsen": "\\MCI_Footnotes_Settings\u003A\u003A\u0024a_arr_Settings", + "name": "a_arr_Settings", + "summary": "Contains\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container\u0020as\u0020soon\u0020as\u0020this\u0020class\u0020is\u0020initialized.", + "url": "classes/MCI-Footnotes-Settings.html#property_a_arr_Settings" + }, { + "fqsen": "\\MCI_Footnotes_Task", + "name": "MCI_Footnotes_Task", + "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes.", + "url": "classes/MCI-Footnotes-Task.html" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "Register\u0020WordPress\u0020Hooks\u0020to\u0020replace\u0020Footnotes\u0020in\u0020the\u0020content\u0020of\u0020a\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_head\u0028\u0029", + "name": "wp_head", + "summary": "Outputs\u0020the\u0020custom\u0020css\u0020to\u0020the\u0020header\u0020of\u0020the\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#method_wp_head" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awp_footer\u0028\u0029", + "name": "wp_footer", + "summary": "Displays\u0020the\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020slug\u0020if\u0020enabled.", + "url": "classes/MCI-Footnotes-Task.html#method_wp_footer" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_title\u0028\u0029", + "name": "the_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020post\/page\u0020title.", + "url": "classes/MCI-Footnotes-Task.html#method_the_title" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_content\u0028\u0029", + "name": "the_content", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020page\/post.", + "url": "classes/MCI-Footnotes-Task.html#method_the_content" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_excerpt\u0028\u0029", + "name": "the_excerpt", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020excerpt\u0020of\u0020the\u0020current\u0020page\/post.", + "url": "classes/MCI-Footnotes-Task.html#method_the_excerpt" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_title\u0028\u0029", + "name": "widget_title", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020widget\u0020title.", + "url": "classes/MCI-Footnotes-Task.html#method_widget_title" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Awidget_text\u0028\u0029", + "name": "widget_text", + "summary": "Replaces\u0020footnotes\u0020in\u0020the\u0020content\u0020of\u0020the\u0020current\u0020widget.", + "url": "classes/MCI-Footnotes-Task.html#method_widget_text" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Athe_post\u0028\u0029", + "name": "the_post", + "summary": "Replaces\u0020footnotes\u0020in\u0020each\u0020Content\u0020var\u0020of\u0020the\u0020current\u0020Post\u0020object.", + "url": "classes/MCI-Footnotes-Task.html#method_the_post" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AreplacePostObject\u0028\u0029", + "name": "replacePostObject", + "summary": "Replace\u0020all\u0020Footnotes\u0020in\u0020a\u0020WP_Post\u0020object.", + "url": "classes/MCI-Footnotes-Task.html#method_replacePostObject" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Aexec\u0028\u0029", + "name": "exec", + "summary": "Replaces\u0020all\u0020footnotes\u0020that\u0020occur\u0020in\u0020the\u0020given\u0020content.", + "url": "classes/MCI-Footnotes-Task.html#method_exec" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003Asearch\u0028\u0029", + "name": "search", + "summary": "Replaces\u0020all\u0020footnotes\u0020in\u0020the\u0020given\u0020content\u0020and\u0020appends\u0020them\u0020to\u0020the\u0020static\u0020property.", + "url": "classes/MCI-Footnotes-Task.html#method_search" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003AReferenceContainer\u0028\u0029", + "name": "ReferenceContainer", + "summary": "Generates\u0020the\u0020reference\u0020container.", + "url": "classes/MCI-Footnotes-Task.html#method_ReferenceContainer" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_arr_Footnotes", + "name": "a_arr_Footnotes", + "summary": "Contains\u0020all\u0020footnotes\u0020found\u0020on\u0020current\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#property_a_arr_Footnotes" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AllowLoveMe", + "name": "a_bool_AllowLoveMe", + "summary": "Flag\u0020if\u0020the\u0020display\u0020of\u0020\u0027LOVE\u0020FOOTNOTES\u0027\u0020is\u0020allowed\u0020on\u0020the\u0020current\u0020public\u0020page.", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AllowLoveMe" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_Prefix", + "name": "a_str_Prefix", + "summary": "Prefix\u0020for\u0020the\u0020Footnote\u0020html\u0020element\u0020ID.", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_Prefix" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_PostId", + "name": "a_int_PostId", + "summary": "Infinite\u0020scroll\u0020\/\u0020autoload\u0020or\u0020archive\u0020view", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_PostId" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ReferenceContainerId", + "name": "a_int_ReferenceContainerId", + "summary": "Multiple\u0020reference\u0020containers\u0020in\u0020content\u0020and\u0020widgets", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_ReferenceContainerId" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_TooltipsEnabled", + "name": "a_bool_TooltipsEnabled", + "summary": "Template\u0020process\u0020optimization", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_TooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_AlternativeTooltipsEnabled", + "name": "a_bool_AlternativeTooltipsEnabled", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_AlternativeTooltipsEnabled" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_HardLinksEnable", + "name": "a_bool_HardLinksEnable", + "summary": "Hard\u0020links\u0020for\u0020AMP\u0020compatibility", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_HardLinksEnable" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_ReferrerLinkSlug", + "name": "a_str_ReferrerLinkSlug", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_ReferrerLinkSlug" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_FootnoteLinkSlug", + "name": "a_str_FootnoteLinkSlug", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_FootnoteLinkSlug" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkIdsSeparator", + "name": "a_str_LinkIdsSeparator", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkIdsSeparator" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_PostContainerIdCompound", + "name": "a_str_PostContainerIdCompound", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_PostContainerIdCompound" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_ScrollOffset", + "name": "a_int_ScrollOffset", + "summary": "Scroll\u0020offset", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_ScrollOffset" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkSpan", + "name": "a_str_LinkSpan", + "summary": "Optional\u0020link\u0020element\u0020for\u0020footnote\u0020referrers\u0020and\u0020backlinks", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkSpan" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkOpenTag", + "name": "a_str_LinkOpenTag", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkOpenTag" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_LinkCloseTag", + "name": "a_str_LinkCloseTag", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_LinkCloseTag" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_MirrorTooltipText", + "name": "a_bool_MirrorTooltipText", + "summary": "Dedicated\u0020tooltip\u0020text", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_MirrorTooltipText" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_str_TooltipShortcode", + "name": "a_str_TooltipShortcode", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_str_TooltipShortcode" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_int_TooltipShortcodeLength", + "name": "a_int_TooltipShortcodeLength", + "summary": "", + "url": "classes/MCI-Footnotes-Task.html#property_a_int_TooltipShortcodeLength" + }, { + "fqsen": "\\MCI_Footnotes_Task\u003A\u003A\u0024a_bool_SyntaxErrorFlag", + "name": "a_bool_SyntaxErrorFlag", + "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation", + "url": "classes/MCI-Footnotes-Task.html#property_a_bool_SyntaxErrorFlag" + }, { + "fqsen": "\\MCI_Footnotes_Template", + "name": "MCI_Footnotes_Template", + "summary": "Handles\u0020each\u0020Template\u0020file\u0020for\u0020the\u0020Plugin\u0020Frontend\u0020\u0028e.g.\u0020Settings\u0020Dashboard,\u0020Public\u0020pages,\u0020...\u0029.", + "url": "classes/MCI-Footnotes-Template.html" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Reads\u0020and\u0020loads\u0020the\u0020template\u0020file\u0020without\u0020replace\u0020any\u0020placeholder.", + "url": "classes/MCI-Footnotes-Template.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Areplace\u0028\u0029", + "name": "replace", + "summary": "Replace\u0020all\u0020placeholders\u0020specified\u0020in\u0020array.", + "url": "classes/MCI-Footnotes-Template.html#method_replace" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Areload\u0028\u0029", + "name": "reload", + "summary": "Reloads\u0020the\u0020original\u0020content\u0020of\u0020the\u0020template\u0020file.", + "url": "classes/MCI-Footnotes-Template.html#method_reload" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AgetContent\u0028\u0029", + "name": "getContent", + "summary": "Returns\u0020the\u0020content\u0020of\u0020the\u0020template\u0020file\u0020with\u0020replaced\u0020placeholders.", + "url": "classes/MCI-Footnotes-Template.html#method_getContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aprocess_template\u0028\u0029", + "name": "process_template", + "summary": "Process\u0020template\u0020file", + "url": "classes/MCI-Footnotes-Template.html#method_process_template" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003Aget_template\u0028\u0029", + "name": "get_template", + "summary": "Get\u0020the\u0020template", + "url": "classes/MCI-Footnotes-Template.html#method_get_template" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AC_STR_DASHBOARD", + "name": "C_STR_DASHBOARD", + "summary": "Directory\u0020name\u0020for\u0020dashboard\u0020templates.", + "url": "classes/MCI-Footnotes-Template.html#constant_C_STR_DASHBOARD" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003AC_STR_PUBLIC", + "name": "C_STR_PUBLIC", + "summary": "Directory\u0020name\u0020for\u0020public\u0020templates.", + "url": "classes/MCI-Footnotes-Template.html#constant_C_STR_PUBLIC" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_OriginalContent", + "name": "a_str_OriginalContent", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize.", + "url": "classes/MCI-Footnotes-Template.html#property_a_str_OriginalContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024a_str_ReplacedContent", + "name": "a_str_ReplacedContent", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize\u0020with\u0020replaced\u0020place\u0020holders.", + "url": "classes/MCI-Footnotes-Template.html#property_a_str_ReplacedContent" + }, { + "fqsen": "\\MCI_Footnotes_Template\u003A\u003A\u0024plugin_directory", + "name": "plugin_directory", + "summary": "Plugin\u0020Directory", + "url": "classes/MCI-Footnotes-Template.html#property_plugin_directory" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase", + "name": "MCI_Footnotes_WidgetBase", + "summary": "Base\u0020Class\u0020for\u0020all\u0020Plugin\u0020Widgets.\u0020Registers\u0020each\u0020Widget\u0020to\u0020WordPress.", + "url": "classes/MCI-Footnotes-WidgetBase.html" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetID\u0028\u0029", + "name": "getID", + "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getID" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020child\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getName" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetDescription\u0028\u0029", + "name": "getDescription", + "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getDescription" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003AgetWidgetWidth\u0028\u0029", + "name": "getWidgetWidth", + "summary": "Returns\u0020the\u0020width\u0020of\u0020the\u0020Widget.\u0020Default\u0020width\u0020is\u0020250\u0020pixel.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method_getWidgetWidth" + }, { + "fqsen": "\\MCI_Footnotes_WidgetBase\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Registers\u0020the\u0020child\u0020Widget\u0020to\u0020WordPress.", + "url": "classes/MCI-Footnotes-WidgetBase.html#method___construct" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer", + "name": "MCI_Footnotes_Widget_ReferenceContainer", + "summary": "Registers\u0020a\u0020Widget\u0020to\u0020put\u0020the\u0020Reference\u0020Container\u0020to\u0020the\u0020widget\u0020area.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetID\u0028\u0029", + "name": "getID", + "summary": "Returns\u0020an\u0020unique\u0020ID\u0020as\u0020string\u0020used\u0020for\u0020the\u0020Widget\u0020Base\u0020ID.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getID" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetName\u0028\u0029", + "name": "getName", + "summary": "Returns\u0020the\u0020Public\u0020name\u0020of\u0020the\u0020Widget\u0020to\u0020be\u0020displayed\u0020in\u0020the\u0020Configuration\u0020page.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getName" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003AgetDescription\u0028\u0029", + "name": "getDescription", + "summary": "Returns\u0020the\u0020Description\u0020of\u0020the\u0020child\u0020widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_getDescription" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Aform\u0028\u0029", + "name": "form", + "summary": "Outputs\u0020the\u0020Settings\u0020of\u0020the\u0020Widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_form" + }, { + "fqsen": "\\MCI_Footnotes_Widget_ReferenceContainer\u003A\u003Awidget\u0028\u0029", + "name": "widget", + "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", + "url": "classes/MCI-Footnotes-Widget-ReferenceContainer.html#method_widget" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG", + "name": "MCI_Footnotes_WYSIWYG", + "summary": "", + "url": "classes/MCI-Footnotes-WYSIWYG.html" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AregisterHooks\u0028\u0029", + "name": "registerHooks", + "summary": "", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_registerHooks" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewVisualEditorButton\u0028\u0029", + "name": "newVisualEditorButton", + "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newVisualEditorButton" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AnewPlainTextEditorButton\u0028\u0029", + "name": "newPlainTextEditorButton", + "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_newPlainTextEditorButton" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AincludeScripts\u0028\u0029", + "name": "includeScripts", + "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_includeScripts" + }, { + "fqsen": "\\MCI_Footnotes_WYSIWYG\u003A\u003AajaxCallback\u0028\u0029", + "name": "ajaxCallback", + "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", + "url": "classes/MCI-Footnotes-WYSIWYG.html#method_ajaxCallback" + }, { + "fqsen": "\\MCI_Footnotes_requirePhpFiles\u0028\u0029", + "name": "MCI_Footnotes_requirePhpFiles", + "summary": "Requires\u0020\u0028require_once\u0029\u0020all\u0020\u002A.php\u0020files\u0020inside\u0020a\u0020specific\u0020Directory.", + "url": "namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + } ] +); diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 0000000..c9f9b75 --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,227 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                        +

                                                                        Documentation

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

                                                                        API Documentation

                                                                        + + + +

                                                                        + Interfaces, Classes and Traits + +

                                                                        + +
                                                                        + +
                                                                        MCI_Footnotes_Config
                                                                        +
                                                                        Contains all Plugin Constants. Contains no Method or Property.
                                                                        +
                                                                        MCI_Footnotes_Convert
                                                                        +
                                                                        Converts data types and Footnotes specific values.
                                                                        +
                                                                        MCI_Footnotes_Layout_Init
                                                                        +
                                                                        Handles the Settings interface of the Plugin.
                                                                        +
                                                                        MCI_Footnotes_LayoutEngine
                                                                        +
                                                                        Layout Engine for the administration dashboard.
                                                                        +
                                                                        MCI_Footnotes_Layout_Diagnostics
                                                                        +
                                                                        Displays Diagnostics of the web server, PHP and WordPress.
                                                                        +
                                                                        MCI_Footnotes_Layout_Settings
                                                                        +
                                                                        Displays and handles all Settings of the Plugin.
                                                                        +
                                                                        MCI_Footnotes_Hooks
                                                                        +
                                                                        Registers all WordPress Hooks and executes them on demand.
                                                                        +
                                                                        MCI_Footnotes
                                                                        +
                                                                        Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                        +
                                                                        MCI_Footnotes_Language
                                                                        +
                                                                        Loads text domain of current or default language for localization.
                                                                        +
                                                                        MCI_Footnotes_Settings
                                                                        +
                                                                        Loads the settings values, sets to default values if undefined.
                                                                        +
                                                                        MCI_Footnotes_Task
                                                                        +
                                                                        Searches and replaces the footnotes.
                                                                        +
                                                                        MCI_Footnotes_Template
                                                                        +
                                                                        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                        +
                                                                        MCI_Footnotes_WidgetBase
                                                                        +
                                                                        Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                        +
                                                                        MCI_Footnotes_Widget_ReferenceContainer
                                                                        +
                                                                        Registers a Widget to put the Reference Container to the widget area.
                                                                        +
                                                                        MCI_Footnotes_WYSIWYG
                                                                        +
                                                                        + +
                                                                        + + +

                                                                        + Table of Contents + +

                                                                        + +
                                                                        +
                                                                        + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                        +
                                                                        Requires (require_once) all *.php files inside a specific Directory.
                                                                        + +
                                                                        + + + +
                                                                        +

                                                                        + Functions + +

                                                                        +
                                                                        +

                                                                        + MCI_Footnotes_requirePhpFiles() + +

                                                                        + + +

                                                                        Requires (require_once) all *.php files inside a specific Directory.

                                                                        + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                        + +
                                                                        Parameters
                                                                        +
                                                                        +
                                                                        + $p_str_Directory + : string +
                                                                        +
                                                                        +

                                                                        Absolute Directory path to lookup for *.php files

                                                                        +
                                                                        + +
                                                                        +
                                                                        + + +
                                                                        + Tags + +
                                                                        +
                                                                        +
                                                                        + author +
                                                                        +
                                                                        + +

                                                                        Stefan Herndler

                                                                        +
                                                                        + +
                                                                        +
                                                                        + since +
                                                                        +
                                                                        + 1.5.0 + +
                                                                        + +
                                                                        +
                                                                        + + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + diff --git a/docs/packages/Default.html b/docs/packages/Default.html new file mode 100644 index 0000000..d4680ea --- /dev/null +++ b/docs/packages/Default.html @@ -0,0 +1,227 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                          +

                                                                          Documentation

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

                                                                          Default

                                                                          + + + +

                                                                          + Interfaces, Classes and Traits + +

                                                                          + +
                                                                          + +
                                                                          MCI_Footnotes_Config
                                                                          +
                                                                          Contains all Plugin Constants. Contains no Method or Property.
                                                                          +
                                                                          MCI_Footnotes_Convert
                                                                          +
                                                                          Converts data types and Footnotes specific values.
                                                                          +
                                                                          MCI_Footnotes_Layout_Init
                                                                          +
                                                                          Handles the Settings interface of the Plugin.
                                                                          +
                                                                          MCI_Footnotes_LayoutEngine
                                                                          +
                                                                          Layout Engine for the administration dashboard.
                                                                          +
                                                                          MCI_Footnotes_Layout_Diagnostics
                                                                          +
                                                                          Displays Diagnostics of the web server, PHP and WordPress.
                                                                          +
                                                                          MCI_Footnotes_Layout_Settings
                                                                          +
                                                                          Displays and handles all Settings of the Plugin.
                                                                          +
                                                                          MCI_Footnotes_Hooks
                                                                          +
                                                                          Registers all WordPress Hooks and executes them on demand.
                                                                          +
                                                                          MCI_Footnotes
                                                                          +
                                                                          Entry point of the Plugin. Loads the Dashboard and executes the Task.
                                                                          +
                                                                          MCI_Footnotes_Language
                                                                          +
                                                                          Loads text domain of current or default language for localization.
                                                                          +
                                                                          MCI_Footnotes_Settings
                                                                          +
                                                                          Loads the settings values, sets to default values if undefined.
                                                                          +
                                                                          MCI_Footnotes_Task
                                                                          +
                                                                          Searches and replaces the footnotes.
                                                                          +
                                                                          MCI_Footnotes_Template
                                                                          +
                                                                          Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                          +
                                                                          MCI_Footnotes_WidgetBase
                                                                          +
                                                                          Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                          +
                                                                          MCI_Footnotes_Widget_ReferenceContainer
                                                                          +
                                                                          Registers a Widget to put the Reference Container to the widget area.
                                                                          +
                                                                          MCI_Footnotes_WYSIWYG
                                                                          +
                                                                          + +
                                                                          + + +

                                                                          + Table of Contents + +

                                                                          + +
                                                                          +
                                                                          + MCI_Footnotes_requirePhpFiles() + +  : mixed +
                                                                          +
                                                                          Requires (require_once) all *.php files inside a specific Directory.
                                                                          + +
                                                                          + + + +
                                                                          +

                                                                          + Functions + +

                                                                          +
                                                                          +

                                                                          + MCI_Footnotes_requirePhpFiles() + +

                                                                          + + +

                                                                          Requires (require_once) all *.php files inside a specific Directory.

                                                                          + + + + MCI_Footnotes_requirePhpFiles(string $p_str_Directory) : mixed + +
                                                                          + +
                                                                          Parameters
                                                                          +
                                                                          +
                                                                          + $p_str_Directory + : string +
                                                                          +
                                                                          +

                                                                          Absolute Directory path to lookup for *.php files

                                                                          +
                                                                          + +
                                                                          +
                                                                          + + +
                                                                          + Tags + +
                                                                          +
                                                                          +
                                                                          + author +
                                                                          +
                                                                          + +

                                                                          Stefan Herndler

                                                                          +
                                                                          + +
                                                                          +
                                                                          + since +
                                                                          +
                                                                          + 1.5.0 + +
                                                                          + +
                                                                          +
                                                                          + + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + diff --git a/docs/packages/default.html b/docs/packages/default.html new file mode 100644 index 0000000..3d3e60c --- /dev/null +++ b/docs/packages/default.html @@ -0,0 +1,116 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                            +

                                                                            Documentation

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

                                                                            API Documentation

                                                                            + +

                                                                            + Packages + +

                                                                            + +
                                                                            +
                                                                            Default
                                                                            +
                                                                            + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html new file mode 100644 index 0000000..31e5420 --- /dev/null +++ b/docs/reports/deprecated.html @@ -0,0 +1,106 @@ + + + + + Documentation » Deprecated elements + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              Documentation

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

                                                                              Deprecated

                                                                              + + +
                                                                              + No deprecated elements have been found in this project. +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + diff --git a/docs/reports/errors.html b/docs/reports/errors.html new file mode 100644 index 0000000..340516e --- /dev/null +++ b/docs/reports/errors.html @@ -0,0 +1,174 @@ + + + + + Documentation » Compilation errors + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                Documentation

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

                                                                                Errors

                                                                                + +

                                                                                Table of Contents

                                                                                + + + + + + + + + + + + + +
                                                                                class/dashboard/subpage-main.php1
                                                                                class/language.php1
                                                                                class/settings.php1
                                                                                + + + +

                                                                                subpage-main.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "see" with body "@see templates/dashboard/customize-css.html + 2020-12-09T1113+0100" has error "\templates/dashboard/customize-css.html" is not a valid Fqsen.
                                                                                + +

                                                                                language.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "see" with body "@see wp-includes/l10n.php:857" has error "\wp-includes/l10n.php:857" is not a valid Fqsen.
                                                                                + +

                                                                                settings.php

                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeLineDescription
                                                                                ERROR0Tag "since" with body "@since ditched trimming whitespace from text box content in response to user request." has error
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + diff --git a/docs/reports/markers.html b/docs/reports/markers.html new file mode 100644 index 0000000..67e0a4e --- /dev/null +++ b/docs/reports/markers.html @@ -0,0 +1,128 @@ + + + + + Documentation » Markers + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  Documentation

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

                                                                                  Markers

                                                                                  + +

                                                                                  Table of Contents

                                                                                  + + + + + +
                                                                                  class/settings.php1
                                                                                  + + +

                                                                                  settings.php

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

                                                                                  Search results

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