Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update documentation

Browse source
This commit is contained in:
Ben Goldsworthy 2021-04-27 10:06:06 +01:00
parent a10090ff24
commit a8e85d4edd
8 changed files with 200 additions and 117 deletions
Download patch file Download diff file Expand all files Collapse all files

71
docs/classes/Footnotes-Layout-Engine.html
View file

@ -80,6 +80,8 @@
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-admin.html">admin</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-admin-layout.html">layout</a></li>
</ul>
<article class="phpdocumentor-element -class">
@ -91,6 +93,8 @@
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-admin.html">admin</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-admin-layout.html">layout</a></li>
</ul>
</div>
@ -100,7 +104,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Layout Engine for the administration dashboard.</p>
@ -121,6 +125,15 @@
<section class="phpdocumentor-description"></section>
</dd>
<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>admin_layout</p>
</section>
</dd>
</dl>
@ -359,7 +372,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
<span class="phpdocumentor-element-found-in__line">51</span>
</aside>
<p class="phpdocumentor-summary">Stores all Sections for the child sub page.</p>
@ -406,7 +419,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">40</span>
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Stores the Hook connection string for the child sub page.</p>
@ -454,7 +467,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">32</span>
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
@ -514,7 +527,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">313</span>
<span class="phpdocumentor-element-found-in__line">316</span>
</aside>
<p class="phpdocumentor-summary">Output the Description of a section. May be overwritten in any section.</p>
@ -563,7 +576,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">213</span>
<span class="phpdocumentor-element-found-in__line">216</span>
</aside>
<p class="phpdocumentor-summary">Displays the content of specific sub page.</p>
@ -612,7 +625,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
<span class="phpdocumentor-element-found-in__line">59</span>
</aside>
<p class="phpdocumentor-summary">Returns a Priority index. Lower numbers have a higher Priority.</p>
@ -661,7 +674,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">159</span>
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">Registers all sections for a sub page.</p>
@ -710,7 +723,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">133</span>
<span class="phpdocumentor-element-found-in__line">136</span>
</aside>
<p class="phpdocumentor-summary">Registers a sub page.</p>
@ -759,7 +772,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">441</span>
<span class="phpdocumentor-element-found-in__line">444</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = checkbox].</p>
@ -820,7 +833,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">519</span>
<span class="phpdocumentor-element-found-in__line">522</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text] with color selection class.</p>
@ -881,7 +894,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">388</span>
<span class="phpdocumentor-element-found-in__line">391</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input/select label.</p>
@ -951,7 +964,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">365</span>
<span class="phpdocumentor-element-found-in__line">368</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to have a space between two lines.</p>
@ -1000,7 +1013,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a meta box.</p>
@ -1089,7 +1102,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">355</span>
<span class="phpdocumentor-element-found-in__line">358</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to start a new line.</p>
@ -1138,7 +1151,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">543</span>
<span class="phpdocumentor-element-found-in__line">546</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = num].</p>
@ -1237,7 +1250,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a sub page section.</p>
@ -1326,7 +1339,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">469</span>
<span class="phpdocumentor-element-found-in__line">472</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a select box.</p>
@ -1437,7 +1450,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">376</span>
<span class="phpdocumentor-element-found-in__line">379</span>
</aside>
<p class="phpdocumentor-summary">Returns a simple text inside html &lt;span&gt; text.</p>
@ -1498,7 +1511,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">416</span>
<span class="phpdocumentor-element-found-in__line">419</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text].</p>
@ -1586,7 +1599,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">501</span>
<span class="phpdocumentor-element-found-in__line">504</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a text area.</p>
@ -1647,7 +1660,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered meta boxes.</p>
@ -1696,7 +1709,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
<span class="phpdocumentor-element-found-in__line">83</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered sections for a sub page.</p>
@ -1745,7 +1758,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Returns the unique slug of the child sub page.</p>
@ -1794,7 +1807,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Returns the title of the child sub page.</p>
@ -1843,7 +1856,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">339</span>
<span class="phpdocumentor-element-found-in__line">342</span>
</aside>
<p class="phpdocumentor-summary">Loads specific setting and returns an array with the keys [id, name, value].</p>
@ -1971,7 +1984,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">200</span>
<span class="phpdocumentor-element-found-in__line">203</span>
</aside>
<p class="phpdocumentor-summary">Append javascript and css files for specific sub page.</p>
@ -2020,7 +2033,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">179</span>
<span class="phpdocumentor-element-found-in__line">182</span>
</aside>
<p class="phpdocumentor-summary">Registers all Meta boxes for a sub page.</p>
@ -2081,7 +2094,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">285</span>
<span class="phpdocumentor-element-found-in__line">288</span>
</aside>
<p class="phpdocumentor-summary">Save all Plugin settings.</p>