108 lines
4.4 KiB
HTML
108 lines
4.4 KiB
HTML
|
{% extends "../base.html" %}
|
||
|
|
|
||
|
|
{% block head %}
|
||
|
|
<link rel="stylesheet" href="{{ static_url("documentation.css") }}" type="text/css">
|
||
|
|
{% end %}
|
||
|
|
|
||
|
|
{% block title %} {{ escape(handler.settings["website_title"]) }} - Help{% end %}
|
||
|
|
|
||
|
|
{% block body %}
|
||
|
|
<div class="documentation">
|
||
|
|
<div class="summary">
|
||
|
|
<h2>Summary</h2>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<a href="#module_modules">Module (<code>modules</code>)</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#">Liste des modules</a></li>
|
||
|
|
<li><a href="#">Charger un module</a></li>
|
||
|
|
<li><a href="#">Décharger un module</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="#module_help">Help (<code>help</code>)</a>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#">Aide générale</a></li>
|
||
|
|
<li><a href="#">Aide d'un module précit</a></li>
|
||
|
|
<li><a href="#">Aide d'une commande précise</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a href="">Cofiguration (<code>config</code>)</a></li>
|
||
|
|
<li><a href="">Deeptown (<code>deeptown</code>)</a></li>
|
||
|
|
<li><a href="">Survey (<code>survey</code>)</a></li>
|
||
|
|
<li><a href="">Pi (<code>pi</code>)</a></li>
|
||
|
|
<li><a href="">Github (<code>github</code>)</a></li>
|
||
|
|
<li><a href="">Direct access to database (<code>directAccessDB</code>)</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="content">
|
||
|
|
<h2 id="module_modules">Modules (<code>modules</code>)</h2>
|
||
|
|
<div>
|
||
|
|
<h3>Liste des modules (<code>list_modules</code>)</h3>
|
||
|
|
<div>
|
||
|
|
<p>Commande permettant de lister les modules disponibles. (réservé aux administrateurs)</p>
|
||
|
|
<div>
|
||
|
|
<h4>Exemples:</h4>
|
||
|
|
<ul>
|
||
|
|
<li><code>list_modules</code>: retourne la liste des modules disponibles</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h3>Charger un module (<code>load</code>)</h3>
|
||
|
|
<div>
|
||
|
|
<p>Commande permettant de charger des modules. (réservé aux administrateurs)</p>
|
||
|
|
<div>
|
||
|
|
<h4>Exemples:</h4>
|
||
|
|
<ul>
|
||
|
|
<li><code>load help</code>: charge le module <code>help</code></li>
|
||
|
|
<li><code>load help module1 module2 ...</code>: charger les modules <code>help</code>,
|
||
|
|
<code>module1</code>,
|
||
|
|
<code>module2</code>,
|
||
|
|
...
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h3>Décharger un module (<code>unload</code>)</h3>
|
||
|
|
<div>
|
||
|
|
<p>Commande permettant de décharger des modules. (réservé aux administrateurs)</p>
|
||
|
|
<div>
|
||
|
|
<h4>Exemples:</h4>
|
||
|
|
<ul>
|
||
|
|
<li><code>unload module</code>: décharge le module <code>module</code></li>
|
||
|
|
<li><code>unload module1 module2 module3 ...</code>: décharge les modules <code>module1</code>,
|
||
|
|
<code>module2</code>,
|
||
|
|
<code>module3</code>, ...
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 id="module_help">Help (<code>help</code>)</h2>
|
||
|
|
<div>
|
||
|
|
<h3>Aide générale</h3>
|
||
|
|
<div>
|
||
|
|
<p>Commande permettant de lister les différentes commandes actives sur le bot.</p>
|
||
|
|
<div>
|
||
|
|
<h4>Exemples:</h4>
|
||
|
|
<ul>
|
||
|
|
<li><code>help</code>: Afficher la liste des commandes</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h3>Aide d'un module précit</h3>
|
||
|
|
<div>
|
||
|
|
<p>Commande permmetant d'afficher la description de toutes les commandes d'un module.</p>
|
||
|
|
<div>
|
||
|
|
<h4>Exemples:</h4>
|
||
|
|
<ul>
|
||
|
|
<li><code>help modules</code>: Affiche la description de toutes les commandes du module
|
||
|
|
<code>modules</code>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
{% end %}
|