aide

Le répertoire Aide permet d’afficher la documentation d’un plugin SPIP

Le plugin aide est fourni dans la distribution SPIP (plugins‑dist/aide/).

– Dans le fichier paquet de votre plugin, indiquez son utilisation  :

<!-- on utilise le plugin d'aide de SPIP -->
<utilise nom="aide" compatibilite="[2.0.2;[" />
<!-- Rendre l'aide active -->
<pipeline nom="aide_index" inclure="votre_plugin_pipelines.php" />

Cette déclaration permet à SPIP de savoir que votre plugin dépend du plugin aide et que vous allez enrichir son index d’aide

– Enrichir l’index d’aide avec le pipeline aide_index

Le pipeline aide_index permet d’ajouter des entrées d’aide spécifiques à votre plugin.
Dans le fichier votre_plugin_pipelines.php :

/**
 * Utiliser ce pipeline permet d'ajouter une aide au plugin,
 *
 * @pipeline aide_index
 * @param array $flux Données du pipeline
 * @return array Données du pipeline
 */
function votre_plugin_aide_index($index) {
    $index['votre_groupe'] = [
        'entrée1',
        'entrée2'
    ];
    return $index;
}

Les clés (groupe) et les valeurs (entrées) ne doivent pas contenir d’underscore pour garantir une bonne lisibilité des idiomes de langue
programmer.spip.net