docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
200
docs/index.html
200
docs/index.html
|
|
@ -51,18 +51,14 @@
|
|||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
||||
</section>
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
|
||||
<ul class="phpdocumentor-list">
|
||||
<li><a href="packages/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
||||
<li><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
|
||||
<li><a href="packages/footnotes-public.html"><abbr title="\footnotes\public">public</abbr></a></li>
|
||||
</ul>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
|
||||
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
|
||||
<ul class="phpdocumentor-list">
|
||||
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
|
||||
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
|
||||
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
||||
|
|
@ -81,194 +77,22 @@
|
|||
<h2>Documentation</h2>
|
||||
|
||||
|
||||
<h3 id="packages">
|
||||
Packages
|
||||
<a href="#packages" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
||||
<h3 id="namespaces">
|
||||
Namespaces
|
||||
<a href="#namespaces" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></dt>
|
||||
</dl>
|
||||
|
||||
|
||||
<h3 id="interfaces_class_traits">
|
||||
Interfaces, Classes and Traits
|
||||
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Activator.html"><abbr title="\Footnotes_Activator">Footnotes_Activator</abbr></a></dt>
|
||||
<dd>Fired during plugin activation.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Deactivator.html"><abbr title="\Footnotes_Deactivator">Footnotes_Deactivator</abbr></a></dt>
|
||||
<dd>Fired during plugin deactivation.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes.html"><abbr title="\Footnotes">Footnotes</abbr></a></dt>
|
||||
<dd>The core plugin class.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Admin.html"><abbr title="\Footnotes_Admin">Footnotes_Admin</abbr></a></dt>
|
||||
<dd>The admin-specific functionality of the plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-WYSIWYG.html"><abbr title="\Footnotes_WYSIWYG">Footnotes_WYSIWYG</abbr></a></dt>
|
||||
<dd>Handles the WSYIWYG-Buttons.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Engine.html"><abbr title="\Footnotes_Layout_Engine">Footnotes_Layout_Engine</abbr></a></dt>
|
||||
<dd>Layout Engine for the administration dashboard.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Init.html"><abbr title="\Footnotes_Layout_Init">Footnotes_Layout_Init</abbr></a></dt>
|
||||
<dd>Handles the Settings interface of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Settings.html"><abbr title="\Footnotes_Layout_Settings">Footnotes_Layout_Settings</abbr></a></dt>
|
||||
<dd>Displays and handles all Settings of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Config.html"><abbr title="\Footnotes_Config">Footnotes_Config</abbr></a></dt>
|
||||
<dd>Contains all Plugin Constants. Contains no Method or Property.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Convert.html"><abbr title="\Footnotes_Convert">Footnotes_Convert</abbr></a></dt>
|
||||
<dd>Converts data types and Footnotes specific values.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-i18n.html"><abbr title="\Footnotes_i18n">Footnotes_i18n</abbr></a></dt>
|
||||
<dd>Define the internationalization functionality.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Loader.html"><abbr title="\Footnotes_Loader">Footnotes_Loader</abbr></a></dt>
|
||||
<dd>Register all actions and filters for the plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Settings.html"><abbr title="\Footnotes_Settings">Footnotes_Settings</abbr></a></dt>
|
||||
<dd>Loads the settings values, sets to default values if undefined.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Template.html"><abbr title="\Footnotes_Template">Footnotes_Template</abbr></a></dt>
|
||||
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Public.html"><abbr title="\Footnotes_Public">Footnotes_Public</abbr></a></dt>
|
||||
<dd>The public-facing functionality of the plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Base.html"><abbr title="\Footnotes_Widget_Base">Footnotes_Widget_Base</abbr></a></dt>
|
||||
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Reference-Container.html"><abbr title="\Footnotes_Widget_Reference_Container">Footnotes_Widget_Reference_Container</abbr></a></dt>
|
||||
<dd>Registers a Widget to put the Reference Container to the widget area.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Parser.html"><abbr title="\Footnotes_Parser">Footnotes_Parser</abbr></a></dt>
|
||||
<dd>Searches and replaces the footnotes and generates the reference container.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
<h3 id="toc">
|
||||
Table of Contents
|
||||
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_activate_footnotes">activate_footnotes()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>The code that runs during plugin activation.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_deactivate_plugin_name">deactivate_plugin_name()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>The code that runs during plugin deactivation.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_run_footnotes">run_footnotes()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>Begins execution of the plugin.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<section class="phpdocumentor-functions">
|
||||
<h3 class="phpdocumentor-elements__header" id="functions">
|
||||
Functions
|
||||
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
|
||||
activate_footnotes()
|
||||
<a href="namespaces/default.html#function_activate_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The code that runs during plugin activation.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-activator.php</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_deactivate_plugin_name">
|
||||
deactivate_plugin_name()
|
||||
<a href="namespaces/default.html#function_deactivate_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The code that runs during plugin deactivation.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">deactivate_plugin_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-deactivator.php</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
|
||||
run_footnotes()
|
||||
<a href="namespaces/default.html#function_run_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">88</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks,
|
||||
then kicking off the plugin from this point in the file does
|
||||
not affect the page life cycle.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
Tags
|
||||
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
</section>
|
||||
|
||||
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
||||
<section class="phpdocumentor-search-results__dialog">
|
||||
<header class="phpdocumentor-search-results__header">
|
||||
|
|
|
|||
Reference in a new issue