sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-12-22 01:35:02 +00:00
Code Activity

Update apidoc comment about history

Browse source
This commit is contained in:
Starbeamrainbowlabs 2017-10-25 22:45:15 +01:00
parent edba3b9bf3
commit 7b778ee56f
57 changed files with 1533 additions and 989 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/ModuleApi/classes/PeppermintParsedown.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1060053167"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-384877966"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1060053167" class="accordion-body collapse in">
<div id="namespace-384877966" class="accordion-body collapse in">
<div class="accordion-inner">
@ -365,7 +365,7 @@ with a URL encoded version of the page name.</em></p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/classes/Slimdown.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-610538792"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-127662780"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-610538792" class="accordion-body collapse in">
<div id="namespace-127662780" class="accordion-body collapse in">
<div class="accordion-inner">
@ -414,7 +414,7 @@ Added image support</p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/classes/ids.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-459313590"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2024061740"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-459313590" class="accordion-body collapse in">
<div id="namespace-2024061740" class="accordion-body collapse in">
<div class="accordion-inner">
@ -525,7 +525,7 @@ index.</p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

16
docs/ModuleApi/classes/page_renderer.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-502208457"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-874059852"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-502208457" class="accordion-body collapse in">
<div id="namespace-874059852" class="accordion-body collapse in">
<div class="accordion-inner">
@ -406,7 +406,13 @@ other elements not suiltable for printing.</em></p>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">register_part_preprocessor(\function <span class="argument">$function</span>) </pre>
<p><em>Registers a function as a part post processor.</em></p>
<p>This function's use is more complicated to explain. Pepperminty Wiki
renders pages with a very simple templating system. For example, in the
template a page's content is denoted by <code>{content}</code>. A function
registered here will be passed all the components of a page <em>just</em>
before they are dropped into the template. Note that the function you
pass in here should take a <em>reference</em> to the components, as the return
value of the function passed is discarded.</p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
@ -937,7 +943,7 @@ navigation bar.</p></td>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/classes/search.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1961686267"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1930599762"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1961686267" class="accordion-body collapse in">
<div id="namespace-1930599762" class="accordion-body collapse in">
<div class="accordion-inner">
@ -891,7 +891,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/core.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-352924567"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1166434112"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-352924567" class="accordion-body collapse in">
<div id="namespace-1166434112" class="accordion-body collapse in">
<div class="accordion-inner">
@ -2438,7 +2438,7 @@ an edit is saved.</em></p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

9
docs/ModuleApi/files/core.php.txt
View file

@ -1092,7 +1092,7 @@ class page_renderer
<footer>
<p>{footer-message}</p>
<p>Powered by Pepperminty Wiki {version}, which was built by <a href='//starbeamrainbowlabs.com/'>Starbeamrainbowlabs</a>. Send bugs to 'bugs at starbeamrainbowlabs dot com' or <a href='//github.com/sbrl/Pepperminty-Wiki' title='Github Issue Tracker'>open an issue</a>.</p>
<p>Your local friendly administrators are {admins-name-list}.</p>
<p>Your local friendly moderators are {admins-name-list}.</p>
<p>This wiki is managed by <a href='mailto:{admin-details-email}'>{admin-details-name}</a>.</p>
</footer>
{navigation-bar-bottom}
@ -1123,6 +1123,13 @@ class page_renderer
/**
* Registers a function as a part post processor.
* This function's use is more complicated to explain. Pepperminty Wiki
* renders pages with a very simple templating system. For example, in the
* template a page's content is denoted by `{content}`. A function
* registered here will be passed all the components of a page _just_
* before they are dropped into the template. Note that the function you
* pass in here should take a *reference* to the components, as the return
* value of the function passed is discarded.
* @package core
* @param function $function The part preprocessor to register.
*/

8
docs/ModuleApi/files/download.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-4526055"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1570989444"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-4526055" class="accordion-body collapse in">
<div id="namespace-1570989444" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.action-hash.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1144825519"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1332662049"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1144825519" class="accordion-body collapse in">
<div id="namespace-1332662049" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.action-protect.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-554912040"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2122323479"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-554912040" class="accordion-body collapse in">
<div id="namespace-2122323479" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.action-random.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2129272247"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1010967540"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2129272247" class="accordion-body collapse in">
<div id="namespace-1010967540" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.action-raw.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1534354678"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1568650655"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1534354678" class="accordion-body collapse in">
<div id="namespace-1568650655" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.api-status.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-167505373"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-601692093"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-167505373" class="accordion-body collapse in">
<div id="namespace-601692093" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.extra-sidebar.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1555458712"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-371666784"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1555458712" class="accordion-body collapse in">
<div id="namespace-371666784" class="accordion-body collapse in">
<div class="accordion-inner">
@ -298,7 +298,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-comments.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-436434900"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-556407950"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-436434900" class="accordion-body collapse in">
<div id="namespace-556407950" class="accordion-body collapse in">
<div class="accordion-inner">
@ -493,7 +493,7 @@ at which the comments are being rendered.</p></td>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-guiconfig.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1562000323"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-516423332"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1562000323" class="accordion-body collapse in">
<div id="namespace-516423332" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-history.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-607647446"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-859896163"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-607647446" class="accordion-body collapse in">
<div id="namespace-859896163" class="accordion-body collapse in">
<div class="accordion-inner">
@ -304,7 +304,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-recent-changes.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-225033231"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1690154390"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-225033231" class="accordion-body collapse in">
<div id="namespace-1690154390" class="accordion-body collapse in">
<div class="accordion-inner">
@ -384,7 +384,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-redirect.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-540414205"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1653152018"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-540414205" class="accordion-body collapse in">
<div id="namespace-1653152018" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-search.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2060814121"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2093436203"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2060814121" class="accordion-body collapse in">
<div id="namespace-2093436203" class="accordion-body collapse in">
<div class="accordion-inner">
@ -246,7 +246,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

24
docs/ModuleApi/files/modules.feature-stats.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-965936185"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1853349231"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-965936185" class="accordion-body collapse in">
<div id="namespace-1853349231" class="accordion-body collapse in">
<div class="accordion-inner">
@ -202,16 +202,21 @@
<article class="method">
<h3 class=" ">update_statistics()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">update_statistics( <span class="argument">$update_all = false</span>) </pre>
<p><em></em></p>
<pre class="signature" style="margin-right: 54px;">update_statistics(boolean <span class="argument">$update_all = false</span>, boolean <span class="argument">$force = false</span>) </pre>
<p><em>Updates the wiki&#039;s statistics.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>boolean</td>
<td>$update_all </td>
<td></td>
<td><p>Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$force </td>
<td><p>Whether we should recalculate statistics that don't currently require recalculating anyway.</p></td>
</tr>
</table>
@ -232,7 +237,8 @@
package
</th>
<td>
<p>Default</p>
<p>feature-stats</p>
<p>feature-stats</p>
</td>
</tr>
</table>
@ -375,7 +381,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-upload.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1031859243"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1152885264"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1031859243" class="accordion-body collapse in">
<div id="namespace-1152885264" class="accordion-body collapse in">
<div class="accordion-inner">
@ -503,7 +503,7 @@ the image.</p></td>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.feature-user-preferences.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1521828075"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1019548437"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1521828075" class="accordion-body collapse in">
<div id="namespace-1019548437" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-credits.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1994169794"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-216523704"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1994169794" class="accordion-body collapse in">
<div id="namespace-216523704" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-debug-info.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2011624911"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1466271282"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2011624911" class="accordion-body collapse in">
<div id="namespace-1466271282" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-delete.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-750372778"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1144789841"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-750372778" class="accordion-body collapse in">
<div id="namespace-1144789841" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-edit.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1225440466"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-587228102"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1225440466" class="accordion-body collapse in">
<div id="namespace-587228102" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-export.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1884193751"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-111360011"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1884193751" class="accordion-body collapse in">
<div id="namespace-111360011" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-help.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-2017724023"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1657690123"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-2017724023" class="accordion-body collapse in">
<div id="namespace-1657690123" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

55
docs/ModuleApi/files/modules.page-list.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1695191265"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1277730599"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1695191265" class="accordion-body collapse in">
<div id="namespace-1277730599" class="accordion-body collapse in">
<div class="accordion-inner">
@ -198,6 +198,53 @@
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_all_tags" name="method_get_all_tags" class="anchor"></a>
<article class="method">
<h3 class=" ">get_all_tags()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_all_tags() : array&lt;mixed,string&gt;</pre>
<p><em>Gets a list of all the tags currently used across the wiki.</em></p>
<h4>Returns</h4>
array&lt;mixed,string&gt;
&mdash; <p>A list of all unique tags present on all pages across the wiki.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>File</dt>
<dd><a href=""><div class="path-wrapper">modules/page-list.php</div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>page-list</p>
<p>page-list</p>
</td>
</tr>
<tr>
<th>
since
</th>
<td>
<p>v0.15</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_generate_page_list" name="method_generate_page_list" class="anchor"></a>
<article class="method">
<h3 class=" ">generate_page_list()</h3>
@ -293,7 +340,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-login.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-892762046"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-177381216"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-892762046" class="accordion-body collapse in">
<div id="namespace-177381216" class="accordion-body collapse in">
<div class="accordion-inner">
@ -295,7 +295,7 @@ enabled, or sha256 otherwise.</p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-logout.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-462050031"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1184234307"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-462050031" class="accordion-body collapse in">
<div id="namespace-1184234307" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-move.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-162517086"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-892302219"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-162517086" class="accordion-body collapse in">
<div id="namespace-892302219" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-update.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-812824952"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-360734490"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-812824952" class="accordion-body collapse in">
<div id="namespace-360734490" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-user-list.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-641381619"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-842179177"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-641381619" class="accordion-body collapse in">
<div id="namespace-842179177" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.page-view.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-704290044"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1907202469"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-704290044" class="accordion-body collapse in">
<div id="namespace-1907202469" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.parser-default-old.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-670272597"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-960081674"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-670272597" class="accordion-body collapse in">
<div id="namespace-960081674" class="accordion-body collapse in">
<div class="accordion-inner">
@ -246,7 +246,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules.parser-parsedown.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1859215181"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1812577039"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1859215181" class="accordion-body collapse in">
<div id="namespace-1812577039" class="accordion-body collapse in">
<div class="accordion-inner">
@ -246,7 +246,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/modules/action-raw.php.txt
View file

@ -24,9 +24,15 @@ register_module([
* ██ ██ ██ ██ ███ ███
*/
add_action("raw", function() {
global $env;
global $pageindex, $env;
if(empty($pageindex->{$env->page})) {
http_response_code(404);
exit("Error: The page with the name $env->page could not be found.\n");
}
header("content-type: text/markdown");
header("content-length: " . filesize($env->page_filename));
exit(file_get_contents($env->page_filename));
});

74
docs/ModuleApi/files/modules/feature-history.php.txt
View file

@ -13,6 +13,7 @@ register_module([
* @apiPermission Anonymous
*
* @apiParam {string} page The page name to return a revision list for.
* @apiParam {string} format The format to return the list of pages in. available values: html, json, text. Default: html
*/
/*
@ -25,32 +26,61 @@ register_module([
add_action("history", function() {
global $settings, $env, $pageindex;
$supported_formats = [ "html", "json", "text" ];
$format = $_GET["format"] ?? "html";
$content = "<h1>History for $env->page</h1>\n";
if(!empty($pageindex->{$env->page}->history))
{
$content .= "\t\t<ul class='page-list'>\n";
foreach(array_reverse($pageindex->{$env->page}->history) as $revisionData)
{
// Only display edits for now
if($revisionData->type != "edit")
continue;
switch($format) {
case "html":
$content = "<h1>History for $env->page</h1>\n";
if(!empty($pageindex->{$env->page}->history))
{
$content .= "\t\t<ul class='page-list'>\n";
foreach(array_reverse($pageindex->{$env->page}->history) as $revisionData)
{
// Only display edits for now
if($revisionData->type != "edit")
continue;
// The number (and the sign) of the size difference to display
$size_display = ($revisionData->sizediff > 0 ? "+" : "") . $revisionData->sizediff;
$size_display_class = $revisionData->sizediff > 0 ? "larger" : ($revisionData->sizediff < 0 ? "smaller" : "nochange");
if($revisionData->sizediff > 500 or $revisionData->sizediff < -500)
$size_display_class .= " significant";
$size_title_display = human_filesize($revisionData->newsize - $revisionData->sizediff) . " -> " . human_filesize($revisionData->newsize);
$content .= "<li><a href='?page=" . rawurlencode($env->page) . "&revision=$revisionData->rid'>#$revisionData->rid</a> " . render_editor(page_renderer::render_username($revisionData->editor)) . " " . render_timestamp($revisionData->timestamp) . " <span class='cursor-query $size_display_class' title='$size_title_display'>($size_display)</span>";
}
}
else
{
$content .= "<p style='text-align: center;'><em>(None yet! Try editing this page and then coming back here.)</em></p>\n";
}
exit(page_renderer::render_main("$env->page - History - $settings->sitename", $content));
case "json":
$page_history = $pageindex->{$env->page}->history ?? [];
// The number (and the sign) of the size difference to display
$size_display = ($revisionData->sizediff > 0 ? "+" : "") . $revisionData->sizediff;
$size_display_class = $revisionData->sizediff > 0 ? "larger" : ($revisionData->sizediff < 0 ? "smaller" : "nochange");
if($revisionData->sizediff > 500 or $revisionData->sizediff < -500)
$size_display_class .= " significant";
$size_title_display = human_filesize($revisionData->newsize - $revisionData->sizediff) . " -> " . human_filesize($revisionData->newsize);
foreach($page_history as &$history_entry) {
unset($history_entry->filename);
}
header("content-type: application/json");
exit(json_encode($page_history, JSON_PRETTY_PRINT));
case "csv":
$page_history = $pageindex->{$env->page}->history ?? [];
$content .= "<li><a href='?page=" . rawurlencode($env->page) . "&revision=$revisionData->rid'>#$revisionData->rid</a> " . render_editor(page_renderer::render_username($revisionData->editor)) . " " . render_timestamp($revisionData->timestamp) . " <span class='cursor-query $size_display_class' title='$size_title_display'>($size_display)</span>";
}
header("content-type: text/csv");
echo("revision_id,timestamp,type,editor,newsize,sizediff\n");
foreach($page_history as $hentry) {
echo("$hentry->rid,$hentry->timestamp,$hentry->type,$hentry->editor,$hentry->newsize,$hentry->sizediff\n");
}
exit();
default:
http_response_code(400);
exit(page_renderer::render_main("Format Error - $env->page - History - $settings->sitename", "<p>The format <code>" . htmlentities($format) . "</code> isn't currently supported. Supported formats: html, json, csv"));
}
else
{
$content .= "<p style='text-align: center;'><em>(None yet! Try editing this page and then coming back here.)</em></p>\n";
}
exit(page_renderer::render_main("$env->page - History - $settings->sitename", $content));
});

36
docs/ModuleApi/files/modules/feature-search.php.txt
View file

@ -1,7 +1,7 @@
<?php
register_module([
"name" => "Search",
"version" => "0.5.1",
"version" => "0.6",
"author" => "Starbeamrainbowlabs",
"description" => "Adds proper search functionality to Pepperminty Wiki using an inverted index to provide a full text search engine. If pages don't show up, then you might have hit a stop word. If not, try requesting the `invindex-rebuild` action to rebuild the inverted index from scratch.",
"id" => "feature-search",
@ -165,6 +165,27 @@ register_module([
}
$content .= "</p>";
if(module_exists("page-list")) {
$nterms = search::tokenize($query);
$nterms_regex = implode("|", array_map(function($nterm) {
return preg_quote(strtolower(trim($nterm)));
}, $nterms));
$all_tags = get_all_tags();
$matching_tags = [];
foreach($all_tags as $tag) {
if(preg_match("/$nterms_regex/i", trim($tag)) > 0)
$matching_tags[] = $tag;
}
if(count($matching_tags) > 0) {
$content .= "<p>Matching tags: <span class='tags'>";
foreach($matching_tags as $tag) {
$content .= "\t<a href='?action=list-tags&tag=" . rawurlencode($tag) ."' class='mini-tag'>" . htmlentities($tag) . "</a> \n";
}
$content .= "</span></p>";
}
}
$i = 0; // todo use $_GET["offset"] and $_GET["result-count"] or something
foreach($results as $result)
{
@ -184,6 +205,10 @@ register_module([
$context .= "...";
}*/
$tag_list = "<span class='tags'>";
foreach($pageindex->{$result["pagename"]}->tags ?? [] as $tag) $tag_list .= "<a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a>";
$tag_list .= "</span>\n";
// Make redirect pages italics
if(!empty($pageindex->{$result["pagename"]}->redirect))
$result["pagename"] = "<em>{$result["pagename"]}</em>";
@ -191,7 +216,7 @@ register_module([
// We add 1 to $i here to convert it from an index to a result
// number as people expect it to start from 1
$content .= "<div class='search-result' data-result-number='" . ($i + 1) . "' data-rank='" . $result["rank"] . "'>\n";
$content .= " <h2><a href='$link'>" . $result["pagename"] . "</a></h2>\n";
$content .= " <h2><a href='$link'>" . $result["pagename"] . "</a> <span class='search-result-badges'>$tag_list</span></h2>\n";
$content .= " <p class='search-context'>$context</p>\n";
$content .= "</div>\n";
@ -702,7 +727,7 @@ class search
if(!isset($matching_pages[$pageid]["title-matches"]))
$matching_pages[$pageid]["title-matches"] = 0;
$matching_pages[$pageid]["title-matches"] += count(mb_stripos_all($pagename, $qterm));
$matching_pages[$pageid]["title-matches"] += count(mb_stripos_all($pagename, $qterm)) * strlen($qterm);
}
// Consider matches in the page's tags
@ -715,7 +740,7 @@ class search
// Set up a counter for tag match if there isn't one already
if(!isset($matching_pages[$pageid]["tag-matches"]))
$matching_pages[$pageid]["tag-matches"] = 0;
$matching_pages[$pageid]["tag-matches"] += count(mb_stripos_all(implode(" ", $pagedata->tags), $qterm));
$matching_pages[$pageid]["tag-matches"] += count(mb_stripos_all(implode(" ", $pagedata->tags), $qterm)) * strlen($qterm);
}
}
}
@ -732,7 +757,8 @@ class search
foreach($pagedata["nterms"] as $pterm => $entry)
{
// Add the number of occurrences of this search term to the ranking
$pagedata["rank"] += $entry["freq"];
// Multiply it by the length of the word
$pagedata["rank"] += $entry["freq"] * strlen($pterm);
// Add the offsets to a listof all offsets on this page
foreach($entry["offsets"] as $offset)

112
docs/ModuleApi/files/modules/feature-stats.php.txt
View file

@ -1,19 +1,21 @@
<?php
register_module([
"name" => "Statistics",
"version" => "0.1",
"version" => "0.2",
"author" => "Starbeamrainbowlabs",
"description" => "An extensible statistics calculation system. Comes with a range of built-in statistics, but can be extended by other modules too.",
"id" => "feature-stats",
"code" => function() {
global $settings;
global $settings, $env;
/**
* @api {get|post} ?action=stats-update Recalculate the wiki's statistics
* @apiName UpdateStats
* @api {get} ?action=stats Show wiki statistics
* @apiName Stats
* @apiGroup Utility
* @apiPermission Administrator
*
* @apiParam {string} secret POST only, optional. If you're not logged in, you can specify the wiki's sekret (find it in peppermint.json) using this parameter.
* @apiPermission Anonymous
* @since v0.15
* @apiParam {string} format Specify the format the data should be returned in. Supported formats: html (default), json.
* @apiParam {string} stat HTML format only. If specified the page for the stat with this id is sent instead of the list of scalar stats.
*/
/*
@ -26,32 +28,76 @@ register_module([
add_action("stats", function() {
global $settings, $statistic_calculators;
$allowed_formats = [ "html", "json" ];
$format = $_GET["format"] ?? "html";
if(!in_array($format, $allowed_formats)) {
http_response_code(400);
exit(page_renderer::render_main("Format error - $settings->sitename", "<p>Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $allowed_formats) . "."));
}
$stats = stats_load();
$content = "<h1>Statistics</h1>";
$content .= "<p>This page contains a selection of statistics about $settings->sitename's content. They are updated automatically about every " . trim(str_replace(["ago", "1 "], [""], human_time($settings->stats_update_interval))) . ", although $settings->sitename's local friendly moderators may update it earlier (you can see their names at the bottom of every page).</p>\n";
$stat_scalar_values = [];
$stat_contents = [];
if($format == "json") {
header("content-type: application/json");
exit(json_encode($stats, JSON_PRETTY_PRINT));
}
$stat_pages_list = "<a href='?action=stats'>Main</a> | ";
foreach($statistic_calculators as $stat_id => $stat_calculator) {
if(!empty($stat_calculator["render"]))
$stat_contents[$stat_calculator["name"]] = $stat_calculator["render"]($stats->$stat_id);
else
$stat_scalar_values[$stat_calculator["name"]] = $stats->$stat_id->value;
if($stat_calculator["type"] == "scalar")
continue;
$stat_pages_list .= "<a href='?action=stats&stat=" . rawurlencode($stat_id) . "'>{$stat_calculator["name"]}</a> | ";
}
$stat_pages_list = trim($stat_pages_list, " |");
$content .= "<table class='stats-table'>\n";
$content .= "\t<tr><th>Statistic</th><th>Value</th></tr>\n\n";
foreach($stat_scalar_values as $scalar_name => $scalar_value) {
$content .= "\t<tr><td>$scalar_name</td><td>$scalar_value</td></tr>\n";
if(!empty($_GET["stat"]) && !empty($statistic_calculators[$_GET["stat"]])) {
$stat_calculator = $statistic_calculators[$_GET["stat"]];
$content = "<h1>{$stat_calculator["name"]} - Statistics</h1>\n";
$content .= "<p>$stat_pages_list</p>\n";
switch($stat_calculator["type"]) {
case "page-list":
if(!module_exists("page-list")) {
$content .= "<p>$settings->sitename doesn't current have the page listing module installed, so HTML rendering of this statistic is currently unavailable. Try <a href='mailto:" . hide_email($settings->admindetails_email) . "'>contacting $settings->admindetails_name</a>, $settings->sitename's administrator and asking then to install the <code>page-list</code> module.</p>";
break;
}
$content .= generate_page_list($stats->{$_GET["stat"]}->value);
break;
case "page":
$content .= $stat_calculator["render"]($stats->{$_GET["stat"]});
break;
}
}
else
{
$content = "<h1>Statistics</h1>\n";
$content .= "<p>This page contains a selection of statistics about $settings->sitename's content. They are updated automatically about every " . trim(str_replace(["ago", "1 "], [""], human_time($settings->stats_update_interval))) . ", although $settings->sitename's local friendly moderators may update them earlier (you can see their names at the bottom of every page).</p>\n";
$content .= "<p>$stat_pages_list</p>\n";
$content .= "<table class='stats-table'>\n";
$content .= "\t<tr><th>Statistic</th><th>Value</th></tr>\n\n";
foreach($statistic_calculators as $stat_id => $stat_calculator) {
if($stat_calculator["type"] !== "scalar")
continue;
$content .= "\t<tr><td>{$stat_calculator["name"]}</td><td>{$stats->$stat_id->value}</td></tr>\n";
}
$content .= "</table>\n";
}
$content .= "</table>\n";
foreach($stat_contents as $stat_content_part)
$content .= "$stat_content_part\n";
exit(page_renderer::render_main("Statistics - $settings->sitename", $content));
});
/**
* @api {get|post} ?action=stats-update Recalculate the wiki's statistics
* @apiName UpdateStats
* @apiGroup Utility
* @apiPermission Administrator
* @since v0.15
* @apiParam {string} secret POST only, optional. If you're not logged in, you can specify the wiki's sekret instead (find it in peppermint.json) using this parameter.
* @apiParam {bool} force Whether the statistics should be recalculated anyway - even if they have already recently been recalculated. Default: no. Supported values: yes, no.
*/
/*
* ███████ ████████ █████ ████████ ███████
@ -81,7 +127,7 @@ register_module([
// Delete the old stats cache
unlink($paths->statsindex);
update_statistics(true);
update_statistics(true, ($_GET["force"] ?? "no") == "yes");
header("content-type: application/json");
echo(file_get_contents($paths->statsindex) . "\n");
});
@ -96,6 +142,7 @@ register_module([
statistic_add([
"id" => "longest-pages",
"name" => "Longest Pages",
"type" => "page",
"update" => function($old_stats) {
global $pageindex;
@ -126,6 +173,7 @@ register_module([
statistic_add([
"id" => "page_count",
"name" => "Page Count",
"type" => "scalar",
"update" => function($old_stats) {
global $pageindex;
@ -139,6 +187,7 @@ register_module([
statistic_add([
"id" => "file_count",
"name" => "File Count",
"type" => "scalar",
"update" => function($old_stats) {
global $pageindex;
@ -154,14 +203,25 @@ register_module([
]);
// Perform an automatic recalculation of the statistics if needed
update_statistics(false);
if($env->action !== "stats-update")
update_statistics(false);
}
]);
function update_statistics($update_all = false)
/**
* Updates the wiki's statistics.
* @package feature-stats
* @param boolean $update_all Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.
* @param boolean $force Whether we should recalculate statistics that don't currently require recalculating anyway.
*/
function update_statistics($update_all = false, $force = false)
{
global $settings, $statistic_calculators;
// Clear the existing statistics if we are asked to recalculate them all
if($force)
stats_save(new stdClass());
$stats = stats_load();
$start_time = microtime(true);

196
docs/ModuleApi/files/modules/page-list.php.txt
View file

@ -1,7 +1,7 @@
<?php
register_module([
"name" => "Page list",
"version" => "0.10.3",
"version" => "0.11",
"author" => "Starbeamrainbowlabs",
"description" => "Adds a page that lists all the pages in the index along with their metadata.",
"id" => "page-list",
@ -26,14 +26,34 @@ register_module([
add_action("list", function() {
global $pageindex, $settings;
$title = "All Pages";
$content = " <h1>$title on $settings->sitename</h1>";
$supported_formats = [ "html", "json", "text" ];
$format = $_GET["format"] ?? "html";
$sorted_pageindex = get_object_vars($pageindex);
ksort($sorted_pageindex, SORT_NATURAL);
$content .= generate_page_list(array_keys($sorted_pageindex));
exit(page_renderer::render_main("$title - $settings->sitename", $content));
switch($format) {
case "html":
$title = "All Pages";
$content = " <h1>$title on $settings->sitename</h1>";
$content .= generate_page_list(array_keys($sorted_pageindex));
exit(page_renderer::render_main("$title - $settings->sitename", $content));
break;
case "json":
header("content-type: application/json");
exit(json_encode(array_keys($sorted_pageindex), JSON_PRETTY_PRINT));
case "text":
header("content-type: text/plain");
exit(implode("\n", array_keys($sorted_pageindex)));
default:
http_response_code(400);
exit(page_renderer::render_main("Format error - $settings->sitename", "<p>Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $supported_formats) . "."));
}
});
/**
@ -44,6 +64,7 @@ register_module([
* @apiPermission Anonymous
*
* @apiParam {string} tag Optional. If provided a list of all the pages with that tag is returned instead.
* @apiParam {string} format Optional. If specified sets the format of the returned result. Supported values: html, json. Default: html
*/
/*
@ -56,30 +77,42 @@ register_module([
add_action("list-tags", function() {
global $pageindex, $settings;
$supported_formats = [ "html", "json", "text" ];
$format = $_GET["format"] ?? "html";
if(!in_array($format, $supported_formats)) {
http_response_code(400);
exit(page_renderer::render_main("Format error - $settings->sitename", "<p>Error: The format '$format' is not currently supported by this action on $settings->sitename. Supported formats: " . implode(", ", $supported_formats) . "."));
}
if(!isset($_GET["tag"]))
{
// Render a list of all tags
$all_tags = [];
foreach($pageindex as $entry)
{
if(!isset($entry->tags)) continue;
foreach($entry->tags as $tag)
{
if(!in_array($tag, $all_tags)) $all_tags[] = $tag;
}
}
$all_tags = get_all_tags();
sort($all_tags, SORT_NATURAL);
$content = "<h1>All tags</h1>
<ul class='tag-list'>\n";
foreach($all_tags as $tag)
{
$content .= " <li><a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a></li>\n";
switch($format) {
case "html":
$content = "<h1>All tags</h1>
<ul class='tag-list'>\n";
foreach($all_tags as $tag)
{
$content .= " <li><a href='?action=list-tags&tag=" . rawurlencode($tag) . "' class='mini-tag'>$tag</a></li>\n";
}
$content .= "</ul>\n";
exit(page_renderer::render("All tags - $settings->sitename", $content));
break;
case "json":
header("content-type: application/json");
exit(json_encode($all_tags, JSON_PRETTY_PRINT));
case "text":
header("content-type: text/plain");
exit(implode("\n", $all_tags));
}
$content .= "</ul>\n";
exit(page_renderer::render("All tags - $settings->sitename", $content));
}
$tag = $_GET["tag"];
@ -95,20 +128,129 @@ register_module([
$pagelist[] = $pagename;
}
$content = "<h1>Tag List: $tag</h1>\n";
$content .= generate_page_list($pagelist);
switch($format)
{
case "html":
$content = "<h1>Tag List: $tag</h1>\n";
$content .= generate_page_list($pagelist);
$content .= "<p>(<a href='?action=list-tags'>All tags</a>)</p>\n";
exit(page_renderer::render("$tag - Tag List - $settings->sitename", $content));
case "json":
header("content-type: application/json");
exit(json_encode($pagelist, JSON_PRETTY_PRINT));
case "text":
header("content-type: text/plain");
exit(implode("\n", $pagelist));
}
$content .= "<p>(<a href='?action=list-tags'>All tags</a>)</p>\n";
exit(page_renderer::render("$tag - Tag List - $settings->sitename", $content));
});
statistic_add([
"id" => "tag-count",
"name" => "Number of Tags",
"type" => "scalar",
"update" => function($old_data) {
global $pageindex;
$result = new stdClass(); // value, state, completed
$result->value = count(get_all_tags());
$result->completed = true;
return $result;
}
]);
statistic_add([
"id" => "tags-per-page",
"name" => "Average Number of Tags per Page",
"type" => "scalar",
"update" => function($old_data) {
global $pageindex;
$tag_counts = [];
foreach($pageindex as $page_entry)
$tag_counts[] = count($page_entry->tags ?? []);
$result = new stdClass(); // value, state, completed
$result->value = round(array_sum($tag_counts) / count($tag_counts), 3);
$result->completed = true;
return $result;
}
]);
statistic_add([
"id" => "most-tags",
"name" => "Most tags on a single page",
"type" => "scalar",
"update" => function($old_data) {
global $pageindex;
$highest_tag_count = 0;
$highest_tag_page = "";
foreach($pageindex as $pagename => $page_entry) {
if(count($page_entry->tags ?? []) > $highest_tag_count) {
$highest_tag_count = count($page_entry->tags ?? []);
$highest_tag_page = $pagename;
}
}
$result = new stdClass(); // value, state, completed
$result->value = "$highest_tag_count (<a href='?page=" . rawurlencode($highest_tag_page) . "'>" . htmlentities($highest_tag_page) . "</a>)";
$result->completed = true;
return $result;
}
]);
statistic_add([
"id" => "untagged-pages",
"name" => "Untagged Pages",
"type" => "page-list",
"update" => function($old_data) {
global $pageindex;
$untagged_pages = [];
foreach($pageindex as $pagename => $page_entry) {
if(empty($page_entry->tags) || count($page_entry->tags ?? []) == 0)
$untagged_pages[] = $pagename;
}
sort($untagged_pages, SORT_STRING | SORT_FLAG_CASE);
$result = new stdClass(); // value, state, completed
$result->value = $untagged_pages;
$result->completed = true;
return $result;
}
]);
add_help_section("30-all-pages-tags", "Listing pages and tags", "<p>All the pages and tags on $settings->sitename are listed on a pair of pages to aid navigation. The list of all pages on $settings->sitename can be found by clicking &quot;All Pages&quot; on the top bar. The list of all the tags currently in use can be found by clicking &quot;All Tags&quot; in the &quot;More...&quot; menu in the top right.</p>
<p>Each tag on either page can be clicked, and leads to a list of all pages that possess that particular tag.</p>
<p>Redirect pages are shown in italics. A page's last known editor is also shown next to each entry on a list of pages, along with the last known size (which should correct, unless it was changed outside of $settings->sitename) and the time since the last modification (hovering over this will show the exact time that the last modification was made in a tooltip).</p>");
}
]);
/**
* Gets a list of all the tags currently used across the wiki.
* @package page-list
* @since v0.15
* @return string[] A list of all unique tags present on all pages across the wiki.
*/
function get_all_tags()
{
global $pageindex;
$all_tags = [];
foreach($pageindex as $page_entry) {
if(empty($page_entry->tags))
continue;
foreach($page_entry->tags as $tag) {
if(!in_array($tag, $all_tags))
$all_tags[] = $tag;
}
}
return $all_tags;
}
/**
* Renders a list of pages as HTML.
* @package page-list

1
docs/ModuleApi/files/modules/parser-parsedown.php.txt
View file

@ -25,6 +25,7 @@ register_module([
statistic_add([
"id" => "wanted-pages",
"name" => "Wanted Pages",
"type" => "page",
"update" => function($old_stats) {
global $pageindex, $env;

8
docs/ModuleApi/files/pack.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-174794015"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1447696764"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-174794015" class="accordion-body collapse in">
<div id="namespace-1447696764" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

8
docs/ModuleApi/files/settings.fragment.html
View file

@ -106,7 +106,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -136,10 +136,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1399174884"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-826807675"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1399174884" class="accordion-body collapse in">
<div id="namespace-826807675" class="accordion-body collapse in">
<div class="accordion-inner">
@ -239,7 +239,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

4
docs/ModuleApi/graphs/class.html
View file

@ -83,7 +83,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -152,7 +152,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

71
docs/ModuleApi/index.html
View file

@ -58,7 +58,7 @@
<ul class="dropdown-menu">
<li>
<a href="reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -88,10 +88,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-733145152"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-229828996"></a>
<a href="namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-733145152" class="accordion-body collapse in">
<div id="namespace-229828996" class="accordion-body collapse in">
<div class="accordion-inner">
@ -974,6 +974,53 @@ false if it wasn't found.</p>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_all_tags" name="method_get_all_tags" class="anchor"></a>
<article class="method">
<h3 class=" ">get_all_tags()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_all_tags() : array&lt;mixed,string&gt;</pre>
<p><em>Gets a list of all the tags currently used across the wiki.</em></p>
<h4>Returns</h4>
array&lt;mixed,string&gt;
&mdash; <p>A list of all unique tags present on all pages across the wiki.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>File</dt>
<dd><a href=""><div class="path-wrapper"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>page-list</p>
<p>page-list</p>
</td>
</tr>
<tr>
<th>
since
</th>
<td>
<p>v0.15</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_comment_filename" name="method_get_comment_filename" class="anchor"></a>
<article class="method">
<h3 class=" ">get_comment_filename()</h3>
@ -3092,16 +3139,21 @@ listed to be cacnonical.</em></p>
<article class="method">
<h3 class=" ">update_statistics()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">update_statistics( <span class="argument">$update_all = false</span>) </pre>
<p><em></em></p>
<pre class="signature" style="margin-right: 54px;">update_statistics(boolean <span class="argument">$update_all = false</span>, boolean <span class="argument">$force = false</span>) </pre>
<p><em>Updates the wiki&#039;s statistics.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>boolean</td>
<td>$update_all </td>
<td></td>
<td><p>Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$force </td>
<td><p>Whether we should recalculate statistics that don't currently require recalculating anyway.</p></td>
</tr>
</table>
@ -3122,7 +3174,8 @@ listed to be cacnonical.</em></p>
package
</th>
<td>
<p>Default</p>
<p>feature-stats</p>
<p>feature-stats</p>
</td>
</tr>
</table>
@ -3362,7 +3415,7 @@ listed to be cacnonical.</em></p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

71
docs/ModuleApi/namespaces/default.html
View file

@ -58,7 +58,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -88,10 +88,10 @@
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1463210363"></a>
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1628268544"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1463210363" class="accordion-body collapse in">
<div id="namespace-1628268544" class="accordion-body collapse in">
<div class="accordion-inner">
@ -974,6 +974,53 @@ false if it wasn't found.</p>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_all_tags" name="method_get_all_tags" class="anchor"></a>
<article class="method">
<h3 class=" ">get_all_tags()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">get_all_tags() : array&lt;mixed,string&gt;</pre>
<p><em>Gets a list of all the tags currently used across the wiki.</em></p>
<h4>Returns</h4>
array&lt;mixed,string&gt;
&mdash; <p>A list of all unique tags present on all pages across the wiki.</p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
<dt>File</dt>
<dd><a href=""><div class="path-wrapper"></div></a></dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr>
<th>
package
</th>
<td>
<p>page-list</p>
<p>page-list</p>
</td>
</tr>
<tr>
<th>
since
</th>
<td>
<p>v0.15</p>
</td>
</tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_get_comment_filename" name="method_get_comment_filename" class="anchor"></a>
<article class="method">
<h3 class=" ">get_comment_filename()</h3>
@ -3092,16 +3139,21 @@ listed to be cacnonical.</em></p>
<article class="method">
<h3 class=" ">update_statistics()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">update_statistics( <span class="argument">$update_all = false</span>) </pre>
<p><em></em></p>
<pre class="signature" style="margin-right: 54px;">update_statistics(boolean <span class="argument">$update_all = false</span>, boolean <span class="argument">$force = false</span>) </pre>
<p><em>Updates the wiki&#039;s statistics.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>boolean</td>
<td>$update_all </td>
<td></td>
<td><p>Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.</p></td>
</tr>
<tr>
<td>boolean</td>
<td>$force </td>
<td><p>Whether we should recalculate statistics that don't currently require recalculating anyway.</p></td>
</tr>
</table>
@ -3122,7 +3174,8 @@ listed to be cacnonical.</em></p>
package
</th>
<td>
<p>Default</p>
<p>feature-stats</p>
<p>feature-stats</p>
</td>
</tr>
</table>
@ -3362,7 +3415,7 @@ listed to be cacnonical.</em></p>
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

4
docs/ModuleApi/reports/deprecated.html
View file

@ -59,7 +59,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -142,7 +142,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

106
docs/ModuleApi/reports/errors.html
View file

@ -59,7 +59,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -549,7 +549,7 @@
<h3>
<i class="icon-file"></i>
modules/feature-stats.php
<small style="float: right;padding-right: 10px;">3</small>
<small style="float: right;padding-right: 10px;">1</small>
</h3>
<div>
<table class="table markers table-bordered">
@ -565,16 +565,6 @@
<td>error</td>
<td>0</td>
<td>No summary was found for this file</td>
</tr>
<tr>
<td>error</td>
<td>161</td>
<td>Argument $update_all is missing from the Docblock of update_statistics</td>
</tr>
<tr>
<td>error</td>
<td>161</td>
<td>No summary for function \update_statistics()</td>
</tr>
</tbody>
</table>
@ -760,27 +750,27 @@
</tr>
<tr>
<td>error</td>
<td>61</td>
<td>91</td>
<td>Argument $pageinfo is missing from the Docblock of history_add_revision</td>
</tr>
<tr>
<td>error</td>
<td>61</td>
<td>91</td>
<td>Argument $newsource is missing from the Docblock of history_add_revision</td>
</tr>
<tr>
<td>error</td>
<td>61</td>
<td>91</td>
<td>Argument $oldsource is missing from the Docblock of history_add_revision</td>
</tr>
<tr>
<td>error</td>
<td>61</td>
<td>91</td>
<td>Argument $save_pageindex is missing from the Docblock of history_add_revision</td>
</tr>
<tr>
<td>error</td>
<td>61</td>
<td>91</td>
<td>No summary for function \history_add_revision()</td>
</tr>
</tbody>
@ -915,12 +905,12 @@
</tr>
<tr>
<td>error</td>
<td>147</td>
<td>148</td>
<td>No summary for class \PeppermintParsedown</td>
</tr>
<tr>
<td>error</td>
<td>154</td>
<td>155</td>
<td>No summary for method __construct()</td>
</tr>
</tbody>
@ -1029,192 +1019,192 @@
</tr>
<tr>
<td>error</td>
<td>409</td>
<td>434</td>
<td>No summary for class \search</td>
</tr>
<tr>
<td>error</td>
<td>457</td>
<td>482</td>
<td>Argument $source is missing from the Docblock of index</td>
</tr>
<tr>
<td>error</td>
<td>457</td>
<td>482</td>
<td>No summary for method index()</td>
</tr>
<tr>
<td>error</td>
<td>487</td>
<td>512</td>
<td>Argument $source is missing from the Docblock of tokenize</td>
</tr>
<tr>
<td>error</td>
<td>487</td>
<td>512</td>
<td>No summary for method tokenize()</td>
</tr>
<tr>
<td>error</td>
<td>494</td>
<td>519</td>
<td>Argument $source is missing from the Docblock of strip_markup</td>
</tr>
<tr>
<td>error</td>
<td>494</td>
<td>519</td>
<td>No summary for method strip_markup()</td>
</tr>
<tr>
<td>error</td>
<td>499</td>
<td>524</td>
<td>Argument $output is missing from the Docblock of rebuild_invindex</td>
</tr>
<tr>
<td>error</td>
<td>499</td>
<td>524</td>
<td>No summary for method rebuild_invindex()</td>
</tr>
<tr>
<td>error</td>
<td>552</td>
<td>577</td>
<td>Argument $index is missing from the Docblock of sort_index</td>
</tr>
<tr>
<td>error</td>
<td>552</td>
<td>577</td>
<td>No summary for method sort_index()</td>
</tr>
<tr>
<td>error</td>
<td>567</td>
<td>592</td>
<td>Argument $oldindex is missing from the Docblock of compare_indexes</td>
</tr>
<tr>
<td>error</td>
<td>567</td>
<td>592</td>
<td>Argument $newindex is missing from the Docblock of compare_indexes</td>
</tr>
<tr>
<td>error</td>
<td>567</td>
<td>592</td>
<td>Argument $changed is missing from the Docblock of compare_indexes</td>
</tr>
<tr>
<td>error</td>
<td>567</td>
<td>592</td>
<td>Argument $removed is missing from the Docblock of compare_indexes</td>
</tr>
<tr>
<td>error</td>
<td>567</td>
<td>592</td>
<td>No summary for method compare_indexes()</td>
</tr>
<tr>
<td>error</td>
<td>586</td>
<td>611</td>
<td>Argument $invindex_filename is missing from the Docblock of load_invindex</td>
</tr>
<tr>
<td>error</td>
<td>586</td>
<td>611</td>
<td>No summary for method load_invindex()</td>
</tr>
<tr>
<td>error</td>
<td>591</td>
<td>616</td>
<td>Argument $invindex_filename is missing from the Docblock of measure_invindex_load_time</td>
</tr>
<tr>
<td>error</td>
<td>591</td>
<td>616</td>
<td>No summary for method measure_invindex_load_time()</td>
</tr>
<tr>
<td>error</td>
<td>602</td>
<td>627</td>
<td>Argument $invindex is missing from the Docblock of merge_into_invindex</td>
</tr>
<tr>
<td>error</td>
<td>602</td>
<td>627</td>
<td>Argument $pageid is missing from the Docblock of merge_into_invindex</td>
</tr>
<tr>
<td>error</td>
<td>602</td>
<td>627</td>
<td>Argument $index is missing from the Docblock of merge_into_invindex</td>
</tr>
<tr>
<td>error</td>
<td>602</td>
<td>627</td>
<td>Argument $removals is missing from the Docblock of merge_into_invindex</td>
</tr>
<tr>
<td>error</td>
<td>602</td>
<td>627</td>
<td>No summary for method merge_into_invindex()</td>
</tr>
<tr>
<td>error</td>
<td>651</td>
<td>676</td>
<td>Argument $filename is missing from the Docblock of save_invindex</td>
</tr>
<tr>
<td>error</td>
<td>651</td>
<td>676</td>
<td>Argument $invindex is missing from the Docblock of save_invindex</td>
</tr>
<tr>
<td>error</td>
<td>651</td>
<td>676</td>
<td>No summary for method save_invindex()</td>
</tr>
<tr>
<td>error</td>
<td>656</td>
<td>681</td>
<td>Argument $query is missing from the Docblock of query_invindex</td>
</tr>
<tr>
<td>error</td>
<td>656</td>
<td>681</td>
<td>Argument $invindex is missing from the Docblock of query_invindex</td>
</tr>
<tr>
<td>error</td>
<td>656</td>
<td>681</td>
<td>No summary for method query_invindex()</td>
</tr>
<tr>
<td>error</td>
<td>783</td>
<td>809</td>
<td>Argument $query is missing from the Docblock of extract_context</td>
</tr>
<tr>
<td>error</td>
<td>783</td>
<td>809</td>
<td>Argument $source is missing from the Docblock of extract_context</td>
</tr>
<tr>
<td>error</td>
<td>783</td>
<td>809</td>
<td>No summary for method extract_context()</td>
</tr>
<tr>
<td>error</td>
<td>867</td>
<td>893</td>
<td>Argument $query is missing from the Docblock of highlight_context</td>
</tr>
<tr>
<td>error</td>
<td>867</td>
<td>893</td>
<td>Argument $context is missing from the Docblock of highlight_context</td>
</tr>
<tr>
<td>error</td>
<td>867</td>
<td>893</td>
<td>No summary for method highlight_context()</td>
</tr>
<tr>
<td>error</td>
<td>412</td>
<td>437</td>
<td>No summary for property $stop_words</td>
</tr>
</tbody>
@ -1286,7 +1276,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

6
docs/ModuleApi/reports/markers.html
View file

@ -59,7 +59,7 @@
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">82</span>
</a>
</li>
<li>
@ -196,7 +196,7 @@
</tr>
<tr>
<td>TODO</td>
<td>75</td>
<td>105</td>
<td>Store tag changes here </td>
</tr>
</table>
@ -242,7 +242,7 @@
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
on October 25th, 2017 at 21:45.
</section>
</section>
</section>

718
docs/RestApi/api_data.js
View file

@ -268,7 +268,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-comments.php.txt",
"filename": "./modules/feature-comments.php",
"groupTitle": "Comment"
},
{
@ -318,7 +318,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-comments.php",
"filename": "./docs/ModuleApi/files/modules/feature-comments.php.txt",
"groupTitle": "Comment"
},
{
@ -504,82 +504,6 @@ define({ "api": [
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "post",
"url": "?action=save&page={pageName}",
@ -651,6 +575,82 @@ define({ "api": [
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=history&page={pageName}",
@ -673,12 +673,19 @@ define({ "api": [
"optional": false,
"field": "page",
"description": "<p>The page name to return a revision list for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>The format to return the list of pages in. available values: html, json, text. Default: html</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-history.php.txt",
"filename": "./modules/feature-history.php",
"groupTitle": "Page"
},
{
@ -708,7 +715,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-history.php",
"filename": "./docs/ModuleApi/files/modules/feature-history.php.txt",
"groupTitle": "Page"
},
{
@ -810,7 +817,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-move.php.txt",
"filename": "./modules/page-move.php",
"groupTitle": "Page"
},
{
@ -876,7 +883,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/page-move.php",
"filename": "./docs/ModuleApi/files/modules/page-move.php.txt",
"groupTitle": "Page"
},
{
@ -939,6 +946,70 @@ define({ "api": [
"filename": "./modules/action-protect.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/action-random.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
"title": "Get the raw source code of a page",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to return the source of.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/api-status.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/action-random.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
@ -999,53 +1070,6 @@ define({ "api": [
"filename": "./modules/api-status.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
"title": "Get the raw source code of a page",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to return the source of.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/api-status.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/action-random.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
@ -1076,23 +1100,6 @@ define({ "api": [
"filename": "./docs/ModuleApi/files/modules/action-raw.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/action-random.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=view[&page={pageName}][&revision=rid][&printable=yes]",
@ -1217,6 +1224,23 @@ define({ "api": [
"filename": "./modules/page-view.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=suggest-pages[&type={type}]",
@ -1256,8 +1280,8 @@ define({ "api": [
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"url": "?action=suggest-pages[&type={type}]",
"title": "Get search suggestions for a query",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
@ -1267,31 +1291,34 @@ define({ "api": [
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>The search query string to get search suggestions for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>The type of result to return. Default value: json. Available values: json, opensearch</p>"
}
]
}
],
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=suggest-pages[&type={type}]",
"title": "Get search suggestions for a query",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
@ -1301,26 +1328,6 @@ define({ "api": [
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>The search query string to get search suggestions for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>The type of result to return. Default value: json. Available values: json, opensearch</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
@ -1387,8 +1394,8 @@ define({ "api": [
},
{
"type": "get",
"url": "?action=query-searchindex&query={text}",
"title": "Inspect the internals of the search results for a query",
"url": "?action=search&query={text}",
"title": "Search the wiki for a given query string",
"name": "Search",
"group": "Search",
"permission": [
@ -1417,8 +1424,8 @@ define({ "api": [
},
{
"type": "get",
"url": "?action=search&query={text}",
"title": "Search the wiki for a given query string",
"url": "?action=query-searchindex&query={text}",
"title": "Inspect the internals of the search results for a query",
"name": "Search",
"group": "Search",
"permission": [
@ -1531,7 +1538,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
@ -1560,7 +1567,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
},
{
@ -1652,7 +1659,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-user-preferences.php",
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"groupTitle": "Settings"
},
{
@ -1708,7 +1715,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"filename": "./modules/feature-user-preferences.php",
"groupTitle": "Settings"
},
{
@ -1779,23 +1786,6 @@ define({ "api": [
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"groupTitle": "Settings"
},
{
"type": "get",
"url": "?action=recentchanges",
"title": "Get a list of recent changes",
"name": "RecentChanges",
"group": "Stats",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/feature-recent-changes.php",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=recentchanges",
@ -1813,6 +1803,23 @@ define({ "api": [
"filename": "./docs/ModuleApi/files/modules/feature-recent-changes.php.txt",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=recentchanges",
"title": "Get a list of recent changes",
"name": "RecentChanges",
"group": "Stats",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/feature-recent-changes.php",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=avatar&user={username}[&size={size}]",
@ -1939,7 +1946,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
@ -1994,106 +2001,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
"type": "post",
"url": "?action=upload",
"title": "Upload a file",
"name": "UploadFile",
"group": "Upload",
"permission": [
{
"name": "User",
"title": "Only users loggged in may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>The name of the file to upload.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "description",
"description": "<p>A description of the file.</p>"
},
{
"group": "Parameter",
"type": "file",
"optional": false,
"field": "file",
"description": "<p>The file to upload.</p>"
},
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Whether this upload should be uploaded as the current user's avatar. If specified, any filenames provided will be ignored.</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "UploadsDisabledError",
"description": "<p>Uploads are currently disabled in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UnknownFileTypeError",
"description": "<p>The type of the file you uploaded is not currently allowed in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "ImageDimensionsFiledError",
"description": "<p>PeppermintyWiki couldn't obtain the dimensions of the image you uploaded.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DangerousFileError",
"description": "<p>The file uploaded appears to be dangerous.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DuplicateFileError",
"description": "<p>The filename specified is a duplicate of a file that already exists.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "FileTamperedError",
"description": "<p>Pepperminty Wiki couldn't verify that the file wasn't tampered with during theupload process.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UserNotLoggedInError",
"description": "<p>You didn't log in before sending this request.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"filename": "./modules/feature-upload.php",
"groupTitle": "Upload"
},
{
@ -2196,10 +2104,10 @@ define({ "api": [
"groupTitle": "Upload"
},
{
"type": "get",
"url": "?action=upload[&avatar=yes]",
"title": "Get a page to let you upload a file.",
"name": "UploadFilePage",
"type": "post",
"url": "?action=upload",
"title": "Upload a file",
"name": "UploadFile",
"group": "Upload",
"permission": [
{
@ -2211,18 +2119,87 @@ define({ "api": [
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>The name of the file to upload.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "description",
"description": "<p>A description of the file.</p>"
},
{
"group": "Parameter",
"type": "file",
"optional": false,
"field": "file",
"description": "<p>The file to upload.</p>"
},
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Optional. If true then a special page to upload your avatar is displayed instead.</p>"
"description": "<p>Whether this upload should be uploaded as the current user's avatar. If specified, any filenames provided will be ignored.</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "UploadsDisabledError",
"description": "<p>Uploads are currently disabled in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UnknownFileTypeError",
"description": "<p>The type of the file you uploaded is not currently allowed in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "ImageDimensionsFiledError",
"description": "<p>PeppermintyWiki couldn't obtain the dimensions of the image you uploaded.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DangerousFileError",
"description": "<p>The file uploaded appears to be dangerous.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DuplicateFileError",
"description": "<p>The filename specified is a duplicate of a file that already exists.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "FileTamperedError",
"description": "<p>Pepperminty Wiki couldn't verify that the file wasn't tampered with during theupload process.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UserNotLoggedInError",
"description": "<p>You didn't log in before sending this request.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
@ -2257,8 +2234,38 @@ define({ "api": [
},
{
"type": "get",
"url": "?action=configure",
"title": "Get a page to change the global wiki settings",
"url": "?action=upload[&avatar=yes]",
"title": "Get a page to let you upload a file.",
"name": "UploadFilePage",
"group": "Upload",
"permission": [
{
"name": "User",
"title": "Only users loggged in may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Optional. If true then a special page to upload your avatar is displayed instead.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"groupTitle": "Upload"
},
{
"type": "post",
"url": "?action=configure-save",
"title": "Save changes to the global wiki settings",
"name": "ConfigureSettings",
"group": "Utility",
"permission": [
@ -2269,13 +2276,13 @@ define({ "api": [
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-guiconfig.php.txt",
"filename": "./modules/feature-guiconfig.php",
"groupTitle": "Utility"
},
{
"type": "post",
"url": "?action=configure-save",
"title": "Save changes to the global wiki settings",
"type": "get",
"url": "?action=configure",
"title": "Get a page to change the global wiki settings",
"name": "ConfigureSettings",
"group": "Utility",
"permission": [
@ -2320,7 +2327,7 @@ define({ "api": [
}
],
"version": "0.0.0",
"filename": "./modules/feature-guiconfig.php",
"filename": "./docs/ModuleApi/files/modules/feature-guiconfig.php.txt",
"groupTitle": "Utility"
},
{
@ -2682,12 +2689,19 @@ define({ "api": [
"optional": false,
"field": "tag",
"description": "<p>Optional. If provided a list of all the pages with that tag is returned instead.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>Optional. If specified sets the format of the returned result. Supported values: html, json. Default: html</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-list.php.txt",
"filename": "./modules/page-list.php",
"groupTitle": "Utility"
},
{
@ -2718,7 +2732,44 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/page-list.php",
"filename": "./docs/ModuleApi/files/modules/page-list.php.txt",
"groupTitle": "Utility"
},
{
"type": "get",
"url": "?action=stats",
"title": "Show wiki statistics",
"name": "Stats",
"group": "Utility",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>Specify the format the data should be returned in. Supported formats: html (default), json.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "stat",
"description": "<p>HTML format only. If specified the page for the stat with this id is sent instead of the list of scalar stats.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-stats.php",
"groupTitle": "Utility"
},
{
@ -2858,7 +2909,7 @@ define({ "api": [
}
},
"version": "0.0.0",
"filename": "./modules/feature-stats.php",
"filename": "./docs/ModuleApi/files/modules/feature-stats.php.txt",
"groupTitle": "Utility"
},
{
@ -2880,13 +2931,20 @@ define({ "api": [
"type": "string",
"optional": false,
"field": "secret",
"description": "<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret (find it in peppermint.json) using this parameter.</p>"
"description": "<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret instead (find it in peppermint.json) using this parameter.</p>"
},
{
"group": "Parameter",
"type": "bool",
"optional": false,
"field": "force",
"description": "<p>Whether the statistics should be recalculated anyway - even if they have already recently been recalculated. Default: no. Supported values: yes, no.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-stats.php.txt",
"filename": "./modules/feature-stats.php",
"groupTitle": "Utility"
},
{

718
docs/RestApi/api_data.json
View file

@ -268,7 +268,7 @@
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-comments.php.txt",
"filename": "./modules/feature-comments.php",
"groupTitle": "Comment"
},
{
@ -318,7 +318,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-comments.php",
"filename": "./docs/ModuleApi/files/modules/feature-comments.php.txt",
"groupTitle": "Comment"
},
{
@ -504,82 +504,6 @@
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "post",
"url": "?action=save&page={pageName}",
@ -651,6 +575,82 @@
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-edit.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=edit&page={pageName}[&newpage=yes]",
"title": "Get an editing page",
"description": "<p>Gets an editing page for a given page. If you don't have permission to edit the page in question, a view source pagee is returned instead.</p>",
"name": "EditPage",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "newpage",
"description": "<p>Set to 'yes' if a new page is being created. Only affects a few bits of text here and there, and the HTTP response code recieved on success from the <code>save</code> action.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to operate on.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/page-edit.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=history&page={pageName}",
@ -673,12 +673,19 @@
"optional": false,
"field": "page",
"description": "<p>The page name to return a revision list for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>The format to return the list of pages in. available values: html, json, text. Default: html</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-history.php.txt",
"filename": "./modules/feature-history.php",
"groupTitle": "Page"
},
{
@ -708,7 +715,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-history.php",
"filename": "./docs/ModuleApi/files/modules/feature-history.php.txt",
"groupTitle": "Page"
},
{
@ -810,7 +817,7 @@
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-move.php.txt",
"filename": "./modules/page-move.php",
"groupTitle": "Page"
},
{
@ -876,7 +883,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/page-move.php",
"filename": "./docs/ModuleApi/files/modules/page-move.php.txt",
"groupTitle": "Page"
},
{
@ -939,6 +946,70 @@
"filename": "./modules/action-protect.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/action-random.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
"title": "Get the raw source code of a page",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to return the source of.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/api-status.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/action-random.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
@ -999,53 +1070,6 @@
"filename": "./modules/api-status.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
"title": "Get the raw source code of a page",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "page",
"description": "<p>The page to return the source of.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/api-status.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/action-random.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=raw&page={pageName}",
@ -1076,23 +1100,6 @@
"filename": "./docs/ModuleApi/files/modules/action-raw.php.txt",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=random",
"title": "Redirects to a random page.",
"name": "RawSource",
"group": "Page",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/action-random.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=view[&page={pageName}][&revision=rid][&printable=yes]",
@ -1217,6 +1224,23 @@
"filename": "./modules/page-view.php",
"groupTitle": "Page"
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=suggest-pages[&type={type}]",
@ -1256,8 +1280,8 @@
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"url": "?action=suggest-pages[&type={type}]",
"title": "Get search suggestions for a query",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
@ -1267,31 +1291,34 @@
"description": ""
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>The search query string to get search suggestions for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>The type of result to return. Default value: json. Available values: json, opensearch</p>"
}
]
}
],
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
},
{
"type": "get",
"url": "?action=suggest-pages[&type={type}]",
"title": "Get search suggestions for a query",
"url": "?action=opensearch-description",
"title": "Get the opensearch description file",
"name": "OpenSearchDescription",
"group": "Search",
"permission": [
@ -1301,26 +1328,6 @@
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>The search query string to get search suggestions for.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "type",
"description": "<p>The type of result to return. Default value: json. Available values: json, opensearch</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
@ -1387,8 +1394,8 @@
},
{
"type": "get",
"url": "?action=query-searchindex&query={text}",
"title": "Inspect the internals of the search results for a query",
"url": "?action=search&query={text}",
"title": "Search the wiki for a given query string",
"name": "Search",
"group": "Search",
"permission": [
@ -1417,8 +1424,8 @@
},
{
"type": "get",
"url": "?action=search&query={text}",
"title": "Search the wiki for a given query string",
"url": "?action=query-searchindex&query={text}",
"title": "Inspect the internals of the search results for a query",
"name": "Search",
"group": "Search",
"permission": [
@ -1531,7 +1538,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-search.php",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"groupTitle": "Search"
},
{
@ -1560,7 +1567,7 @@
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-search.php.txt",
"filename": "./modules/feature-search.php",
"groupTitle": "Search"
},
{
@ -1652,7 +1659,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-user-preferences.php",
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"groupTitle": "Settings"
},
{
@ -1708,7 +1715,7 @@
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"filename": "./modules/feature-user-preferences.php",
"groupTitle": "Settings"
},
{
@ -1779,23 +1786,6 @@
"filename": "./docs/ModuleApi/files/modules/feature-user-preferences.php.txt",
"groupTitle": "Settings"
},
{
"type": "get",
"url": "?action=recentchanges",
"title": "Get a list of recent changes",
"name": "RecentChanges",
"group": "Stats",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/feature-recent-changes.php",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=recentchanges",
@ -1813,6 +1803,23 @@
"filename": "./docs/ModuleApi/files/modules/feature-recent-changes.php.txt",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=recentchanges",
"title": "Get a list of recent changes",
"name": "RecentChanges",
"group": "Stats",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"version": "0.0.0",
"filename": "./modules/feature-recent-changes.php",
"groupTitle": "Stats"
},
{
"type": "get",
"url": "?action=avatar&user={username}[&size={size}]",
@ -1939,7 +1946,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
@ -1994,106 +2001,7 @@
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
"type": "post",
"url": "?action=upload",
"title": "Upload a file",
"name": "UploadFile",
"group": "Upload",
"permission": [
{
"name": "User",
"title": "Only users loggged in may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>The name of the file to upload.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "description",
"description": "<p>A description of the file.</p>"
},
{
"group": "Parameter",
"type": "file",
"optional": false,
"field": "file",
"description": "<p>The file to upload.</p>"
},
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Whether this upload should be uploaded as the current user's avatar. If specified, any filenames provided will be ignored.</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "UploadsDisabledError",
"description": "<p>Uploads are currently disabled in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UnknownFileTypeError",
"description": "<p>The type of the file you uploaded is not currently allowed in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "ImageDimensionsFiledError",
"description": "<p>PeppermintyWiki couldn't obtain the dimensions of the image you uploaded.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DangerousFileError",
"description": "<p>The file uploaded appears to be dangerous.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DuplicateFileError",
"description": "<p>The filename specified is a duplicate of a file that already exists.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "FileTamperedError",
"description": "<p>Pepperminty Wiki couldn't verify that the file wasn't tampered with during theupload process.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UserNotLoggedInError",
"description": "<p>You didn't log in before sending this request.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"filename": "./modules/feature-upload.php",
"groupTitle": "Upload"
},
{
@ -2196,10 +2104,10 @@
"groupTitle": "Upload"
},
{
"type": "get",
"url": "?action=upload[&avatar=yes]",
"title": "Get a page to let you upload a file.",
"name": "UploadFilePage",
"type": "post",
"url": "?action=upload",
"title": "Upload a file",
"name": "UploadFile",
"group": "Upload",
"permission": [
{
@ -2211,18 +2119,87 @@
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "name",
"description": "<p>The name of the file to upload.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "description",
"description": "<p>A description of the file.</p>"
},
{
"group": "Parameter",
"type": "file",
"optional": false,
"field": "file",
"description": "<p>The file to upload.</p>"
},
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Optional. If true then a special page to upload your avatar is displayed instead.</p>"
"description": "<p>Whether this upload should be uploaded as the current user's avatar. If specified, any filenames provided will be ignored.</p>"
}
]
}
},
"error": {
"fields": {
"Error 4xx": [
{
"group": "Error 4xx",
"optional": false,
"field": "UploadsDisabledError",
"description": "<p>Uploads are currently disabled in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UnknownFileTypeError",
"description": "<p>The type of the file you uploaded is not currently allowed in the wiki's settings.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "ImageDimensionsFiledError",
"description": "<p>PeppermintyWiki couldn't obtain the dimensions of the image you uploaded.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DangerousFileError",
"description": "<p>The file uploaded appears to be dangerous.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "DuplicateFileError",
"description": "<p>The filename specified is a duplicate of a file that already exists.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "FileTamperedError",
"description": "<p>Pepperminty Wiki couldn't verify that the file wasn't tampered with during theupload process.</p>"
},
{
"group": "Error 4xx",
"optional": false,
"field": "UserNotLoggedInError",
"description": "<p>You didn't log in before sending this request.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"filename": "./docs/ModuleApi/files/modules/feature-upload.php.txt",
"groupTitle": "Upload"
},
{
@ -2257,8 +2234,38 @@
},
{
"type": "get",
"url": "?action=configure",
"title": "Get a page to change the global wiki settings",
"url": "?action=upload[&avatar=yes]",
"title": "Get a page to let you upload a file.",
"name": "UploadFilePage",
"group": "Upload",
"permission": [
{
"name": "User",
"title": "Only users loggged in may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "boolean",
"optional": false,
"field": "avatar",
"description": "<p>Optional. If true then a special page to upload your avatar is displayed instead.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-upload.php",
"groupTitle": "Upload"
},
{
"type": "post",
"url": "?action=configure-save",
"title": "Save changes to the global wiki settings",
"name": "ConfigureSettings",
"group": "Utility",
"permission": [
@ -2269,13 +2276,13 @@
}
],
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-guiconfig.php.txt",
"filename": "./modules/feature-guiconfig.php",
"groupTitle": "Utility"
},
{
"type": "post",
"url": "?action=configure-save",
"title": "Save changes to the global wiki settings",
"type": "get",
"url": "?action=configure",
"title": "Get a page to change the global wiki settings",
"name": "ConfigureSettings",
"group": "Utility",
"permission": [
@ -2320,7 +2327,7 @@
}
],
"version": "0.0.0",
"filename": "./modules/feature-guiconfig.php",
"filename": "./docs/ModuleApi/files/modules/feature-guiconfig.php.txt",
"groupTitle": "Utility"
},
{
@ -2682,12 +2689,19 @@
"optional": false,
"field": "tag",
"description": "<p>Optional. If provided a list of all the pages with that tag is returned instead.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>Optional. If specified sets the format of the returned result. Supported values: html, json. Default: html</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/page-list.php.txt",
"filename": "./modules/page-list.php",
"groupTitle": "Utility"
},
{
@ -2718,7 +2732,44 @@
}
},
"version": "0.0.0",
"filename": "./modules/page-list.php",
"filename": "./docs/ModuleApi/files/modules/page-list.php.txt",
"groupTitle": "Utility"
},
{
"type": "get",
"url": "?action=stats",
"title": "Show wiki statistics",
"name": "Stats",
"group": "Utility",
"permission": [
{
"name": "Anonymous",
"title": "Anybody may use this call.",
"description": ""
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "format",
"description": "<p>Specify the format the data should be returned in. Supported formats: html (default), json.</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "stat",
"description": "<p>HTML format only. If specified the page for the stat with this id is sent instead of the list of scalar stats.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./modules/feature-stats.php",
"groupTitle": "Utility"
},
{
@ -2858,7 +2909,7 @@
}
},
"version": "0.0.0",
"filename": "./modules/feature-stats.php",
"filename": "./docs/ModuleApi/files/modules/feature-stats.php.txt",
"groupTitle": "Utility"
},
{
@ -2880,13 +2931,20 @@
"type": "string",
"optional": false,
"field": "secret",
"description": "<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret (find it in peppermint.json) using this parameter.</p>"
"description": "<p>POST only, optional. If you're not logged in, you can specify the wiki's sekret instead (find it in peppermint.json) using this parameter.</p>"
},
{
"group": "Parameter",
"type": "bool",
"optional": false,
"field": "force",
"description": "<p>Whether the statistics should be recalculated anyway - even if they have already recently been recalculated. Default: no. Supported values: yes, no.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "./docs/ModuleApi/files/modules/feature-stats.php.txt",
"filename": "./modules/feature-stats.php",
"groupTitle": "Utility"
},
{

2
docs/RestApi/api_project.js
View file

@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2017-09-16T10:22:32.357Z",
"time": "2017-10-25T21:45:06.506Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}

2
docs/RestApi/api_project.json
View file

@ -8,7 +8,7 @@
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2017-09-16T10:22:32.357Z",
"time": "2017-10-25T21:45:06.506Z",
"url": "http://apidocjs.com",
"version": "0.17.6"
}

1
modules/feature-history.php
View file

@ -13,6 +13,7 @@ register_module([
* @apiPermission Anonymous
*
* @apiParam {string} page The page name to return a revision list for.
* @apiParam {string} format The format to return the list of pages in. available values: html, json, text. Default: html
*/
/*