<!-- on utilise le plugin d'aide de SPIP -->
<utilise nom="aide" compatibilite="[2.0.2;]" />
<!-- Rendre l'aide active -->
<pipeline nom="aide_index" inclure="#ENV{plugin}_pipelines.php" />
[(#BOITE_FERMER)]
[(#REM) ]
#SET{_groupes,#ARRAY}
<:aide_dev:info_aucun_objet:>
[(#BOITE_FERMER)] /B_les_objets_du_plugin> [(#REM) ] #SET{espaces, } #SET{groupes,#ARRAY} #SET{prefixe,#VAL{_}|str_replace{'',#ENV{plugin}}}/**
* Utiliser ce pipeline permet d'ajouter une aide au plugin #ENV{plugin}
*
* @pipeline aide_index
* @link https://contrib.spip.net/Creer-une-aide-en-ligne-pour-un-plugin
*
* @param array $flux Données du pipeline
* @return array Données du pipeline
*/
function #ENV{plugin}_aide_index($index) {
#GET{espaces}// L'index d'aide pour le plugin #ENV{plugin}.
#GET{espaces}// -- Le groupe est débute par le prefixe du plugin auquel les
#GET{espaces}//#GET{espaces}éventuels underscores ont été retirés
#GET{espaces}//#GET{espaces}suivie des trois premières et dernières lettres
#GET{espaces}//#GET{espaces}de l'objet pour lequel l'aide est proposée.
#GET{espaces}// -- les entrées sont :
#GET{espaces}//#GET{espaces}le contenu de l'objet (quelles données il encapsule)
#GET{espaces}//#GET{espaces}le statut qu'on peut lui donner (le cas échéant)
#GET{espaces}//#GET{espaces}le texte qu'on peut écrire (le cas échéant)
#GET{espaces}// -- l'introduction (_intro.spip) n'a pas d'entrée.
#GET{espaces}//#GET{espaces}Elle peut permettre d'indiquer brièvement
#GET{espaces}//#GET{espaces}la finalité de l'objet (à quoi il sert).
'}>
#SET{entrees,#LISTE{contenu}}
[(#SET{groupe,#GET{prefixe}|concat{#VALEUR{_groupe}}})]
#GET{espaces}$index['#GET{groupe}'] = [ // #VALEUR{objet}
#GET{espaces}#GET{espaces}'contenu',
#SET{statut,#VALEUR{objet}|objet_info{'statut'}}
[(#GET{statut/0/champ}|oui)
#SET{entrees,#GET{entrees}|push{statut}}
#GET{espaces}#GET{espaces}'statut',
]
#SET{field,#VALEUR{objet}|objet_info{'field'}}
#SET{titre,#GET{field/titre}}
[(#GET{titre}|oui)
#SET{entrees,#GET{entrees}|push{titre}}
#GET{espaces}#GET{espaces}'titre',
]
#SET{texte,#GET{field/texte}}
[(#GET{texte}|oui)
#SET{entrees,#GET{entrees}|push{texte}}
#GET{espaces}#GET{espaces}'texte',
]
#GET{espaces}]
#SET{groupes,#GET{groupes}|push{#ARRAY{groupe,#GET{groupe},objet,#VALEUR{objet},entrees,#GET{entrees}}}}
#GET{espaces}return $index;
}
<?php
/**
* Définit les variables de langue pour l'aide du plugin #ENV{plugin}
*
* @package SPIP#VAL{'\'}[(#ENV{plugin}|ucfirst)]\Lang
*/
if (!defined('_ECRIRE_INC_VERSION')) return;
$GLOBALS[$GLOBALS['idx_lang']] = [
// #VALEUR{objet}
#SET{nom_objet,#VALEUR{objet}|objet_info{texte_objet}|_T{'',#ARRAY{'force',''}}}
#SET{nom_objet,#GET{nom_objet}|sinon{#VALEUR{objet}}}
#GET{espaces}'#VALEUR{groupe}' => '[(#VAL{aide_dev}|concat{:,info_aide_objet}|_T{#ARRAY{objet,#GET{nom_objet}}})]',
#GET{espaces}'#_fichiers_aides:VALEUR{groupe}_#VALEUR' => '[(#VAL{aide_dev}|concat{:,info_aide_,#VALEUR}|_T)]',
];
[(#BOITE_FERMER)]
<:aide_dev:info_rep:> | <:aide_dev:info_fichier:> | <:aide_dev:info_action:> |
---|---|---|
/aide/#ENV{lang}/#VALEUR{groupe}/ |
||
#GET{espaces}#VALEUR.spip |