docs: update documentation
This commit is contained in:
parent
ebcba982e6
commit
5afd55dba6
56 changed files with 5566 additions and 5217 deletions
|
|
@ -59,6 +59,14 @@
|
|||
</ul>
|
||||
</section>
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
||||
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
|
||||
<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>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
||||
|
|
@ -84,6 +92,12 @@
|
|||
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>
|
||||
|
|
@ -91,7 +105,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">46</span>
|
||||
<span class="phpdocumentor-element-found-in__line">48</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Class defining plugin constants.</p>
|
||||
|
|
@ -156,35 +170,35 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL">C_STR_LOVE_SYMBOL</a>
|
||||
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL">LOVE_SYMBOL</a>
|
||||
<span>
|
||||
= '<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>' </span>
|
||||
</dt>
|
||||
<dd>HTML element for the ‘love’ symbol.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING">C_STR_LOVE_SYMBOL_HEADING</a>
|
||||
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL_HEADING">LOVE_SYMBOL_HEADING</a>
|
||||
<span>
|
||||
= '<span class="footnotes_heart_heading">&hearts;</span>' </span>
|
||||
</dt>
|
||||
<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-includes-Config.html#constant_C_STR_NO_LOVE_SLUG">C_STR_NO_LOVE_SLUG</a>
|
||||
<a href="classes/footnotes-includes-Config.html#constant_NO_LOVE_SLUG">NO_LOVE_SLUG</a>
|
||||
<span>
|
||||
= '[[no footnotes: love]]' </span>
|
||||
</dt>
|
||||
<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-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME">C_STR_PLUGIN_HEADING_NAME</a>
|
||||
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_HEADING_NAME">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 use as a dashboard heading.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
||||
<a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a>
|
||||
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_PUBLIC_NAME">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>
|
||||
|
|
@ -201,15 +215,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
<a href="classes/footnotes-includes-Config.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
<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-includes-Config.html#constant_C_STR_LOVE_SYMBOL" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="constant_LOVE_SYMBOL">
|
||||
LOVE_SYMBOL
|
||||
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">84</span>
|
||||
<span class="phpdocumentor-element-found-in__line">86</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol.</p>
|
||||
|
|
@ -217,7 +231,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
<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>
|
||||
<span class="phpdocumentor-signature__name">LOVE_SYMBOL</span>
|
||||
= <span class="phpdocumentor-signature__default-value">'<span style="color:#ff6d3b; font-weight:bold;">&hearts;</span>'</span>
|
||||
</code>
|
||||
|
||||
|
|
@ -260,15 +274,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
|
||||
</article>
|
||||
<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-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="constant_LOVE_SYMBOL_HEADING">
|
||||
LOVE_SYMBOL_HEADING
|
||||
<a href="classes/footnotes-includes-Config.html#constant_LOVE_SYMBOL_HEADING" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">95</span>
|
||||
<span class="phpdocumentor-element-found-in__line">97</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">HTML element for the ‘love’ symbol used in dashboard heading</p>
|
||||
|
|
@ -276,7 +290,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
<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>
|
||||
<span class="phpdocumentor-signature__name">LOVE_SYMBOL_HEADING</span>
|
||||
= <span class="phpdocumentor-signature__default-value">'<span class="footnotes_heart_heading">&hearts;</span>'</span>
|
||||
</code>
|
||||
|
||||
|
|
@ -319,15 +333,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
|
||||
</article>
|
||||
<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-includes-Config.html#constant_C_STR_NO_LOVE_SLUG" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="constant_NO_LOVE_SLUG">
|
||||
NO_LOVE_SLUG
|
||||
<a href="classes/footnotes-includes-Config.html#constant_NO_LOVE_SLUG" 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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">106</span>
|
||||
<span class="phpdocumentor-element-found-in__line">108</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Shortcode to NOT display the ‘LOVE ME’ slug on certain pages.</p>
|
||||
|
|
@ -335,7 +349,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
<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>
|
||||
<span class="phpdocumentor-signature__name">NO_LOVE_SLUG</span>
|
||||
= <span class="phpdocumentor-signature__default-value">'[[no footnotes: love]]'</span>
|
||||
</code>
|
||||
|
||||
|
|
@ -378,15 +392,15 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
|
||||
</article>
|
||||
<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-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="constant_PLUGIN_HEADING_NAME">
|
||||
PLUGIN_HEADING_NAME
|
||||
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_HEADING_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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">73</span>
|
||||
<span class="phpdocumentor-element-found-in__line">75</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Public plugin name for use as a dashboard heading.</p>
|
||||
|
|
@ -394,7 +408,7 @@ Moved under <code class="prettyprint">footnotes\includes</code> namespace.</p>
|
|||
<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>
|
||||
<span class="phpdocumentor-signature__name">PLUGIN_HEADING_NAME</span>
|
||||
= <span class="phpdocumentor-signature__default-value">'<span class="footnotes_logo_heading footnotes_logo_part1_heading">foot</span><span class="footnotes_logo_heading footnotes_logo_part2_heading">notes</span>'</span>
|
||||
</code>
|
||||
|
||||
|
|
@ -442,15 +456,15 @@ that isn't translated, and dropping the logo in another, translatable heading.</
|
|||
|
||||
</article>
|
||||
<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-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="constant_PLUGIN_PUBLIC_NAME">
|
||||
PLUGIN_PUBLIC_NAME
|
||||
<a href="classes/footnotes-includes-Config.html#constant_PLUGIN_PUBLIC_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/includes/class-config.php"><a href="files/src-includes-class-config.html"><abbr title="src/includes/class-config.php">class-config.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
<span class="phpdocumentor-element-found-in__line">58</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Public plugin name.</p>
|
||||
|
|
@ -458,7 +472,7 @@ that isn't translated, and dropping the logo in another, translatable heading.</
|
|||
<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>
|
||||
<span class="phpdocumentor-signature__name">PLUGIN_PUBLIC_NAME</span>
|
||||
= <span class="phpdocumentor-signature__default-value">'<span class="footnotes_logo footnotes_logo_part1">foot</span><span class="footnotes_logo footnotes_logo_part2">notes</span>'</span>
|
||||
</code>
|
||||
|
||||
|
|
|
|||
Reference in a new issue