En vue d'une discussion sur la doc de spip.net, il serait d'établir certaines petites règles. Et par la suite, trouver une solution pour pouvoir les consulter à tout moment sur spip.net sans que cela soit consultable en public (juste la partie privée, donc).
(discussion initiale avec denisb, cam.lafit, merce et moi-même)
On commence les règles :
- Les balise, filtre , ... doivent encadrer par <code>
Exception des cas où on lie à un article de documentation dans ce cas c’est [->artXX]
- mettre les mot-clés pertinents à l'article : le nom des filtres, balises, constantes mais aussi le nom de la boucle à laquelle s'applique l'article ;
- version de spip où est apparue la "fonction" ou sa compatibilité minimale
- version de spip où la fonction à cesser d'exister (exemple : |reduire_image obsolète à partir de SPIP 2.1)
- quand on met des guillemets, on met le texte en italique (désolé, déformation professionnelle dans la presse papier), exemple : référence à un nom d'un bloc de la partie privée ;
Voyez vous d'autres choses ? Mais déjà, est-ce que ce que j'ai mis vous convient ?
L'utilisation du chapeau et du texte est importante. Il est utile pour
afficher un résumé lors des chargements via les modèles (exemple
d'utilisation avec l'article : boucle ARTICLES)
Oui c'est encore sous exploité mais cela devrait venir
Comme vous le constatez nous sommes encore loin de l'exhaustivité,
d'où cet appel à votre bon cœur pour nous aider.
Le principe est simple : Trouvez une balise/critère/filtre non
documenté et proposez une première description.
Le formatage des articles est simple :
Le titre : #BALISE |filtre{arg1, ..., argX} ou { critere }
Le texte : Description complète ou à défaut brève description
Le chapo : si texte complet fournir une brève description
Les mots clefs à communiquer (si connus) sont :
Critères/balises/filtre : le nom de l'élément documenté, à créer si
manquant (ou le demander)
Version SPIP (depuis) : depuis quelle version l'élément décrit fonctionne
Une fois rédigé mettez le, en "proposition à la publication", ainsi
nous pourrons tous relire et proposer les compléments d'informations
qui seraient en notre possession.
