— Lors de l’édition de l’arti­cle, reco­piez tel quel le contenu du fichier « plu­gin.xml » du plu­gin concerné dans le champ prévu à cet effet. Le sys­tème affi­chera ainsi auto­ma­ti­que­ment un cer­tain nom­bre d’infor­ma­tions.

— Si le des­crip­tif tiré de plu­gin.xml n’est pas adapté (notam­ment pré­sence d’éléments de docu­men­ta­tion tech­ni­que, liens inter­nes...), ren­sei­gner le « des­crip­tif » de l’arti­cle : ce des­crip­tif rem­pla­cera alors le des­crip­tif tiré de plu­gin.xml.

— Renseignez pré­ci­sé­ment les mots-clés « tech­ni­ques » :

• version(s) de SPIP avec laquelle (lesquelles) le plugin est compatible ;
• bases de données compatibles ; vous vous avez utilisé les fonctions génériques de SPIP, indiquez « Fonctions génériques » et ajoutez les systèmes de base de données pour lesquels le plugin a été réellement validé ; si le plugin n’effectue pas d’accès SQL, indiquez « Pas d’accès SQL » ;
• les langues dans lesquelles le plugin affiche une interface, ou dans certains cas celles pour lesquelles le plugin fonctionne ; si le plugin utilise l’outil Salvatore, indiquez « Salvatore » et complétez avec les langues déjà traduites ; si le plugin fonctionne sans afficher de texte, indiquez-le en choisissant « Pas de texte ».

— Référencez l’archive zip conte­nant le plu­gin en tant que docu­ment dis­tant. N’ins­tal­lez pas direc­te­ment ce fichier sur le site : ins­tal­lez-le ailleurs (notam­ment sur spip-zone) ; cela per­met­tra de gérer les évolutions du plu­gin sans devoir en modi­fier le réfé­ren­ce­ment sur plu­gins.spip.

— Installez éventuellement le logo du plu­gin en tant que logo de l’arti­cle.

— Vous avez la pos­si­bi­lité de vous conten­ter d’un texte court sur le pré­sent site, et de ren­voyer éventuellement vers un « site offi­ciel » plus com­plet.

— Vous pou­vez (c’est conseillé) uti­li­ser le texte de l’arti­cle pour docu­men­ter plus lar­ge­ment l’uti­li­sa­tion du plu­gin. La lon­gueur d’un tel texte n’est pas limi­tée, pen­sez éventuellement à bien le struc­tu­rer et à uti­li­ser des inter­ti­tres.

— N’hési­tez pas à insé­rer des ima­ges et, sur­tout, des copies d’écran. Pour cela vous pou­vez uti­li­ser les rac­cour­cis <img> et <doc> de SPIP. Le pré­sent site pro­pose un modèle sup­plé­men­taire très pra­ti­que pour pré­sen­ter de gran­des ima­ges : <deplier>, qui pré­sente une image en docu­ment joint avec un effet de plier-déplier ori­gi­nal ; il s’uti­lise par exem­ple ainsi :

— Si vous sou­hai­tez four­nir des extraits de code, uti­li­sez le rac­courci <cadre>, doté d’une « class » indi­quant le type de code. Par exem­ple :

est obtenu en codant ainsi :