docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
|
|
@ -51,18 +51,12 @@
|
|||
|
||||
<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>
|
||||
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</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">
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
||||
|
|
@ -79,7 +73,6 @@
|
|||
|
||||
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
||||
<ul class="phpdocumentor-breadcrumbs">
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
|
||||
</ul>
|
||||
|
||||
<article class="phpdocumentor-element -class">
|
||||
|
|
@ -87,12 +80,6 @@
|
|||
Footnotes_Config
|
||||
|
||||
|
||||
<div class="phpdocumentor-element__package">
|
||||
in package
|
||||
<ul class="phpdocumentor-breadcrumbs">
|
||||
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</h2>
|
||||
|
|
@ -100,12 +87,13 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">17</span>
|
||||
<span class="phpdocumentor-element-found-in__line">27</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Contains all Plugin Constants. Contains no Method or Property.</p>
|
||||
<p class="phpdocumentor-summary">Class defining plugin constants.</p>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
<section class="phpdocumentor-description"><p>This class contains no methods of properties.</p>
|
||||
</section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
|
|
@ -114,6 +102,15 @@
|
|||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">subpackage</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>includes</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
|
@ -121,6 +118,23 @@
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -140,35 +154,35 @@
|
|||
<span>
|
||||
= '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' </span>
|
||||
</dt>
|
||||
<dd>Html tag for the LOVE symbol.</dd>
|
||||
<dd>HTML element for the ‘love’ symbol.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING">C_STR_LOVE_SYMBOL_HEADING</a>
|
||||
<span>
|
||||
= '<span class="footnotes_heart_heading">&hearts;</span>' </span>
|
||||
</dt>
|
||||
<dd>HTML code for the 'love' symbol used in dashboard heading</dd>
|
||||
<dd>HTML element for the ‘love’ symbol used in dashboard heading</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG">C_STR_NO_LOVE_SLUG</a>
|
||||
<span>
|
||||
= '[[no footnotes: love]]' </span>
|
||||
</dt>
|
||||
<dd>Short code to DON'T display the 'LOVE ME' slug on certain pages.</dd>
|
||||
<dd>Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME">C_STR_PLUGIN_HEADING_NAME</a>
|
||||
<span>
|
||||
= '<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>' </span>
|
||||
</dt>
|
||||
<dd>Public Plugin name for dashboard heading</dd>
|
||||
<dd>Public plugin name for use as a dashboard heading.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a>
|
||||
<span>
|
||||
= '<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>' </span>
|
||||
</dt>
|
||||
<dd>Public Plugin name.</dd>
|
||||
<dd>Public plugin name.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
|
@ -180,7 +194,7 @@
|
|||
Constants
|
||||
<a href="classes/Footnotes-Config.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
<article class="phpdocumentor-element -constant -public ">
|
||||
<article class="phpdocumentor-element -constant -public -deprecated">
|
||||
<h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL">
|
||||
C_STR_LOVE_SYMBOL
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
|
@ -189,12 +203,12 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">48</span>
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Html tag for the LOVE symbol.</p>
|
||||
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol.</p>
|
||||
|
||||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||||
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL</span>
|
||||
|
|
@ -218,11 +232,28 @@
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -constant -public ">
|
||||
<article class="phpdocumentor-element -constant -public -deprecated">
|
||||
<h4 class="phpdocumentor-element__name" id="constant_C_STR_LOVE_SYMBOL_HEADING">
|
||||
C_STR_LOVE_SYMBOL_HEADING
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
|
@ -231,12 +262,12 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
<span class="phpdocumentor-element-found-in__line">76</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">HTML code for the 'love' symbol used in dashboard heading</p>
|
||||
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol used in dashboard heading</p>
|
||||
|
||||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||||
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">C_STR_LOVE_SYMBOL_HEADING</span>
|
||||
|
|
@ -260,11 +291,28 @@
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -constant -public ">
|
||||
<article class="phpdocumentor-element -constant -public -deprecated">
|
||||
<h4 class="phpdocumentor-element__name" id="constant_C_STR_NO_LOVE_SLUG">
|
||||
C_STR_NO_LOVE_SLUG
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
|
@ -273,12 +321,12 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">64</span>
|
||||
<span class="phpdocumentor-element-found-in__line">87</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Short code to DON'T display the 'LOVE ME' slug on certain pages.</p>
|
||||
<p class="phpdocumentor-summary">Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</p>
|
||||
|
||||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||||
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">C_STR_NO_LOVE_SLUG</span>
|
||||
|
|
@ -302,11 +350,28 @@
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -constant -public ">
|
||||
<article class="phpdocumentor-element -constant -public -deprecated">
|
||||
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_HEADING_NAME">
|
||||
C_STR_PLUGIN_HEADING_NAME
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
|
@ -315,12 +380,12 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">40</span>
|
||||
<span class="phpdocumentor-element-found-in__line">54</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Public Plugin name for dashboard heading</p>
|
||||
<p class="phpdocumentor-summary">Public plugin name for use as a dashboard heading.</p>
|
||||
|
||||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||||
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_HEADING_NAME</span>
|
||||
|
|
@ -329,10 +394,10 @@
|
|||
|
||||
|
||||
<section class="phpdocumentor-description"><p>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.</p>
|
||||
in WP 5.5 being torn apart as if the headline was <code class="prettyprint">text-align:justify</code> and not
|
||||
the last line. That ugly display bug badly affected the plugin's communication.
|
||||
The only working solution found so far is using <code class="prettyprint">position:fixed</code> in one heading
|
||||
that isn't translated, and dropping the logo in another, translatable heading.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -349,11 +414,28 @@ that isn’t translated, and dropping the logo in another, translatable heading.
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -constant -public ">
|
||||
<article class="phpdocumentor-element -constant -public -deprecated">
|
||||
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_PUBLIC_NAME">
|
||||
C_STR_PLUGIN_PUBLIC_NAME
|
||||
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
|
|
@ -362,12 +444,12 @@ that isn’t translated, and dropping the logo in another, translatable heading.
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">26</span>
|
||||
<span class="phpdocumentor-element-found-in__line">37</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Public Plugin name.</p>
|
||||
<p class="phpdocumentor-summary">Public plugin name.</p>
|
||||
|
||||
<code class="phpdocumentor-signature phpdocumentor-code ">
|
||||
<code class="phpdocumentor-signature phpdocumentor-code -deprecated">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_PUBLIC_NAME</span>
|
||||
|
|
@ -391,6 +473,23 @@ that isn’t translated, and dropping the logo in another, translatable heading.
|
|||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">todo</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Remove.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">deprecated</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
|
|||
Reference in a new issue