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:04:30 +01:00
parent a72558098b
commit 431d75f62e
60 changed files with 1151 additions and 365 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -57,11 +57,9 @@
<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-footnotesincludes.html"><abbr title="\footnotes\footnotesincludes">footnotesincludes</abbr></a></li>
<li><a href="packages/footnotes-footnotesadmin.html"><abbr title="\footnotes\footnotesadmin">footnotesadmin</abbr></a></li>
<li><a href="packages/footnotes-footnotesadminlayout.html"><abbr title="\footnotes\footnotesadminlayout">footnotesadminlayout</abbr></a></li>
<li><a href="packages/footnotes-footnotespublic.html"><abbr title="\footnotes\footnotespublic">footnotespublic</abbr></a></li>
<li><a href="packages/footnotes-footnotespublicwidget.html"><abbr title="\footnotes\footnotespublicwidget">footnotespublicwidget</abbr></a></li>
<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>
</section>
@ -102,7 +100,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">24</span>
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Layout Engine for the administration dashboard.</p>
@ -361,7 +359,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">49</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Stores all Sections for the child sub page.</p>
@ -408,7 +406,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">41</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Stores the Hook connection string for the child sub page.</p>
@ -456,7 +454,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">33</span>
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
@ -516,7 +514,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">314</span>
<span class="phpdocumentor-element-found-in__line">313</span>
</aside>
<p class="phpdocumentor-summary">Output the Description of a section. May be overwritten in any section.</p>
@ -565,7 +563,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">214</span>
<span class="phpdocumentor-element-found-in__line">213</span>
</aside>
<p class="phpdocumentor-summary">Displays the content of specific sub page.</p>
@ -614,7 +612,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">57</span>
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Returns a Priority index. Lower numbers have a higher Priority.</p>
@ -663,7 +661,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">160</span>
<span class="phpdocumentor-element-found-in__line">159</span>
</aside>
<p class="phpdocumentor-summary">Registers all sections for a sub page.</p>
@ -712,7 +710,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">134</span>
<span class="phpdocumentor-element-found-in__line">133</span>
</aside>
<p class="phpdocumentor-summary">Registers a sub page.</p>
@ -761,7 +759,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">442</span>
<span class="phpdocumentor-element-found-in__line">441</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = checkbox].</p>
@ -822,7 +820,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">520</span>
<span class="phpdocumentor-element-found-in__line">519</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text] with color selection class.</p>
@ -883,7 +881,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">389</span>
<span class="phpdocumentor-element-found-in__line">388</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input/select label.</p>
@ -953,7 +951,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">366</span>
<span class="phpdocumentor-element-found-in__line">365</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to have a space between two lines.</p>
@ -1002,7 +1000,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">120</span>
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a meta box.</p>
@ -1091,7 +1089,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">356</span>
<span class="phpdocumentor-element-found-in__line">355</span>
</aside>
<p class="phpdocumentor-summary">Returns a line break to start a new line.</p>
@ -1140,7 +1138,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">544</span>
<span class="phpdocumentor-element-found-in__line">543</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = num].</p>
@ -1239,7 +1237,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">101</span>
<span class="phpdocumentor-element-found-in__line">100</span>
</aside>
<p class="phpdocumentor-summary">Returns an array describing a sub page section.</p>
@ -1328,7 +1326,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">470</span>
<span class="phpdocumentor-element-found-in__line">469</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a select box.</p>
@ -1439,7 +1437,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">377</span>
<span class="phpdocumentor-element-found-in__line">376</span>
</aside>
<p class="phpdocumentor-summary">Returns a simple text inside html &lt;span&gt; text.</p>
@ -1500,7 +1498,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">417</span>
<span class="phpdocumentor-element-found-in__line">416</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text].</p>
@ -1588,7 +1586,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">502</span>
<span class="phpdocumentor-element-found-in__line">501</span>
</aside>
<p class="phpdocumentor-summary">Returns the html tag for a text area.</p>
@ -1649,7 +1647,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">89</span>
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered meta boxes.</p>
@ -1698,7 +1696,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">81</span>
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Returns an array of all registered sections for a sub page.</p>
@ -1747,7 +1745,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">65</span>
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Returns the unique slug of the child sub page.</p>
@ -1796,7 +1794,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">73</span>
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Returns the title of the child sub page.</p>
@ -1845,7 +1843,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">340</span>
<span class="phpdocumentor-element-found-in__line">339</span>
</aside>
<p class="phpdocumentor-summary">Loads specific setting and returns an array with the keys [id, name, value].</p>
@ -1973,7 +1971,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">201</span>
<span class="phpdocumentor-element-found-in__line">200</span>
</aside>
<p class="phpdocumentor-summary">Append javascript and css files for specific sub page.</p>
@ -2022,7 +2020,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">180</span>
<span class="phpdocumentor-element-found-in__line">179</span>
</aside>
<p class="phpdocumentor-summary">Registers all Meta boxes for a sub page.</p>
@ -2083,7 +2081,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">286</span>
<span class="phpdocumentor-element-found-in__line">285</span>
</aside>
<p class="phpdocumentor-summary">Save all Plugin settings.</p>