<!-- NO_MARKDOWN_PARSING -->

<h1>App helpers</h1>

{% for category, helpers in data.helpers %}

<h3 style="text-transform: uppercase; font-weight: bold">{{ category }}</h3>

{% for h in helpers %}

<div class="helper-card">
  <div class="helper-card-body">
    <div data-toggle="collapse" href="#collapse-{{ h.name }}" style="cursor:pointer">
        <h5 class="helper-card-title"><tt>{{ h.name }}</tt></h5>
        <h6 class="helper-card-subtitle text-muted">{{ h.brief }}</h6>
    </div>
    <div id="collapse-{{ h.name }}" class="collapse" role="tabpanel">
    <hr style="margin-top:25px; margin-bottom:25px;">
    <p>
        {% if not '\n' in h.usage %}
        <strong>Usage</strong>: <code class="helper-code">{{ h.usage }}</code>
        {% else %}
        <strong>Usage</strong>: <code class="helper-code helper-usage">{{ h.usage }}</code>
        {% endif %}
    </p>
    {% if h.args %}
    <p>
        <strong>Arguments</strong>:
        <ul>
            {% for infos in h.args %}
            {% if infos|length == 2 %}
            <li><code>{{ infos[0] }}</code> : {{ infos[1] }}</li>
            {% else %}
            <li><code>{{ infos[0] }}</code>, <code>{{ infos[1] }}</code> : {{ infos[2] }}</li>
            {% endif %}
            {% endfor %}
        </ul>
    </p>
    {% endif %}
    {% if h.ret %}
    <p>
        <strong>Returns</strong>: {{ h.ret }}
    </p>
    {% endif %}
    {% if "example" in h.keys() %}
    <p>
        <strong>Example</strong>: <code class="helper-code">{{ h.example }}</code>
    </p>
    {% endif %}
    {% if "examples" in h.keys() %}
    <p>
    <strong>Examples</strong>:<ul>
        {% for example in h.examples %}
            {% if not example.strip().startswith("# ") %}
            <code class="helper-code">{{ example }}</code>
            {% else %}
            {{ example.strip("# ") }}
            {% endif %}
            <br>
        {% endfor %}
        </ul>
    </p>
    {% endif %}
    {% if h.details %}
    <p>
        <strong>Details</strong>:
        <p>
        {{ h.details.replace('\n', '</br>') }}
        </p>
    </p>
    {% endif %}
    <p>
        <a href="https://github.com/YunoHost/yunohost/blob/stretch-unstable/data/helpers.d/{{ category }}#L{{ h.line + 1 }}">Dude, show me the code !</a>
    </p>

  </div>
  </div>

</div>

{% endfor %}
{% endfor %}

<p>Generated by <a href="https://github.com/YunoHost/yunohost/blob/stretch-unstable/doc/generate_helper_doc.py">this script</a> on {{data.date}} (Yunohost version {{data.version}})</p>


<style>
/*=================================================
 Helper card
=================================================*/
.helper-card {
    width:100%;
    min-height: 1px;
    margin-right: 10px;
    margin-left: 10px;
    border: 1px solid rgba(0,0,0,.125);
    border-radius: 0.5rem;
    word-wrap: break-word;
    margin-top: 0.5rem;
    margin-bottom: 0.5rem;
}
.helper-card-body {
    padding: 1.25rem;
    padding-top: 0.8rem;
    padding-bottom: 0;
}
.helper-code {
    word-wrap: break-word;
    white-space: normal;
}
/*===============================================*/

</style>