SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

286 Plugins, 197 contribs sur SPIP-Zone, 319 visiteurs en ce moment

Accueil > Vie de SPIP et autour de SPIP > Charte et vie SPIP-Contrib > Écrire la documentation d’un plugin SPIP

Écrire la documentation d’un plugin SPIP

25 février 2014 – par touti – commentaire

5 votes

Cet article explique en 4 étapes comment créer les liens de la documentation d’un plugin sur Contrib. Il s’adresse aussi aux administrateurs et administratrices de SPIP-contrib qui auraient des trous de mémoire ;)

Prérequis : vous disposez d’un plugin non documenté

Si vous souhaitez réaliser un plugin, ce n’est pas la bonne page ! Pour réaliser un plugin pour SPIP2 allez plutôt ici http://www.spip.net/fr_article3448.html et pour SPIP3, suivez l’excellent tutorial de marcimat http://marcimat.magraine.net/Chats-...

Voyez aussi ce guide de rédaction, qui présente l’esprit éditorial dans lequel les articles doivent être rédigés en général sur spip Contrib.

1. Rédigez l’article de documentation

Si vous n’êtes pas encore auteur·e, inscrivez-vous puis allez dans l’espace de rédaction de SPIP-Contrib http://contrib.spip.net/ecrire pour y rédiger votre article. Pensez à ajouter un logo, des mots-clefs, puis demandez la publication.

On peut proposer une structure-type à cet article, une trame générale, dont le respect facilitera l’utilisation ultérieure de ces articles comme documentation :

Un chapo décrit l’objet du plugin, en terme de fonctionnalités ou services rendus à l’utilisateur.

Les sections les plus fréquentes listées ci-dessous donnent un ordre de lecture et de compréhension logique :
-  installation : et dépendances, pré-requis
-  configuration (si elle existe) - spécifier s’il existe un bouton dédié..où ?
-  utilisations : explications avec captures d’ecran ou exemples de codes / boucles et développements explicatifs (si besoin, découper en plusieurs sections..)
-  fonctionnement : d’autres informations optionnelles, par exemple les indications de développement, bugs &toDo, modifications de la BdD à l’installation, le cas de la desinstallation purgeant ou non la BdD....
-  références et liens site-exemple, sources de bibliothèques, autres guides,
lien vers la page (de Carnet ?) doc developpeur et discussions d’extensions, trac..

Pensez à faciliter le travail des administrateur de Contrib : rajouter les mots-clés à utiliser pour :

  • le flux des plugins ; la/les versions de SPIP
  • le type de contribution = plugins[112] ou documentation code[222] ..merci.

Les réactions sous votre article lorsque vous l’aurez proposé à la publication ne devraient pas tarder (vous recevrez les notifications par mail) sinon après quelques jours, n’hésitez pas à relancer gentiment.

Un administrateur du site vous créera une rubrique pour y accueillir votre article et vous en deviendrez administrateur restreint pour gérer les versions suivantes et les ajouts d’articles. Il serait d’ailleurs de bonne pratique que vous intégriez ultérieurement vos nouveautés, ou les remarques et précisions apportées au fil de messages du forum, au sein de l’article principal..

2. Déclarez l’url de documentation dans votre plugin

Cette URL [1] sera affichée sur la page des plugins du site qui l’utilisera
et sera également référencée automatiquement dans le site http://plugins.spip.net/ si vous disposez d’un zip.
-  Vous êtes en SPIP2, dans plugin.xml utilisez la balise lien

<lien>http://www.spip-contrib.net/url_documentation</lien>


-  Vous êtes en SPIP3, dans paquet.xml et/ou si vous avez un plugin.xml référez-vous à l’écriture pour SPIP2

En tant qu’auteur de cet article, vous serez joignable par les réactions des utilisateurs publiées sur votre forum d’article.

Pour rédiger proprement votre paquet.xml voir http://plugins.spip.net/redaction-d... ou pour vérifier la validité de votre paquet.xml http://plugins.spip.net/validation/

Les attributs « documentation », « demonstration », « developpement » sont les URL respectives de la documentation officielle du plugin, d’un site de démonstration et du lieu de développement du plugin

On mettra dans la balise <paquet>au minimum l’attribut documentation avec l’URL générée par contrib, ou seulement le numéro d’article (par exemple : http://contrib.spip.net/Depublie est équivalent à http://www.spip-contrib.net/4484) :

<paquet
   documentation="http://contrib.spip.net/4484"
>

Voir l’exemple du plugin Dépublie
http://zone.spip.org/trac/spip-zone...

3. Fabriquez et ajoutez le Zip

voir http://plugins.spip.net/distribuer-une-contribution.html

-  Vous avez commité votre plugin sur la Zone SPIP http://zone.spip.org/trac/spip-zone/. Pour fabriquer automatiquement un fichier facilement installable grâce au format compressé .zip vous devez déclarer votre plugin dans archivelist.txt
svn://zone.spip.org/spip-zone/archivelist.txt
-  Ou bien vous avez développé votre plugin SPIP de votre côté, que vous avez déjà zippé et vous souhaitez le partager sur [SPIP-Contrib]

Ajoutez le Zip en tant que document distant
Lorsque le zip est généré depuis archivelist.txt (donc la Zone SPIP) vous le retrouvez dans la page des plugins générés automatiquement http://files.spip.org/spip-zone/, copiez son URL.

Dans l’article, ajoutez le document distant en collant son URL.

4. Ajoutez le flux RSS des modifications SVN

Réservé aux administrateurs à partir du moment où la rubrique existe. Il est conseillé d’effectuer cet ajout après publication de l’article.

Sur la page track de votre plugin, par exemple http://zone.spip.org/trac/spip-zone/browser/_plugins_/agenda/trunk cliquez à droite sur Revision Log puis sur le flux RSS qui se trouve en bas de la page http://zone.spip.org/trac/spip-zone....
Créez un nouveau site dans la rubrique de votre article et copiez l’URL dans le flux de syndication.

Petits plus

Ajoutez le logo à la rubrique, ainsi tous les articles enfants en hériteront.

Notes

[1Normalement celle de l’article de documentation que vous venez de rédiger, sous la forme http://contrib.spip.net/{n°_id_article}..

Dernière modification de cette page le 21 septembre 2015

Retour en haut de la page

Vos commentaires

  • Le 12 novembre 2014 à 12:56, par YannX En réponse à : Écrire la documentation d’un plugin SPIP

    A l’usage, d’autres préconisations :
    -  si l’explication du Fonctionnement interne n’est pas écrite, il peut néanmoins s’avérer utile de signaler explicitement le préfixe du plugin dans le paragraphe « Installation » ; éventuellement les tables et/ou champs optionnels dans la base...
    -  et prévoir un mot-clé précisant la compatibilité SQL étendue/préfixes des primitives utilisées..
    (ou avertissant dans le cas contraire !! )

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Bazar

    8 octobre 2015 – 21 commentaires

    Un squelette pour étaler son bazar sur l’accueil. Bazar est un squelette HTML5/CSS3 issu du squelette neo-dist (http://zone.spip.org/trac/spip-zone/browser/_core_/plugins/neo-dist) : c’est un choix fait au départ, qui à l’avantage d’intégrer (...)

  • LinkCheck : vérificateur de liens

    13 février 2015 – 70 commentaires

    Ce plugin permet de chercher et tester l’ensemble des liens présents dans les objets. Vous pourrez donc en quelques clics connaître les liens brisés ou défectueux qui se sont immiscés dans le contenu de votre site SPIP. La vérification s’effectue en (...)

  • Dublin Core

    21 septembre 2010 – 28 commentaires

    Un petit squelette pour l’insertion de méta-données Dublin Core dans la partie head des articles. Le Dublin Core « Le Dublin Core est un schéma de métadonnées générique qui permet de décrire des ressources numériques ou physiques et d’établir des (...)

  • Le plugin ZotSpip

    28 mai 2012 – 136 commentaires

    Synchronise Spip avec une bibliothèque (personnelle ou partagée) de références bibliographiques Zotero. Utilisez Zotero pour gérer / importer / rédiger vos références bibliographiques, puis incorporez vos références bibliographiques dans votre Spip avec (...)

  • Newsletters

    16 janvier 2013 – 410 commentaires

    Ce plugin permet de composer des Info-lettres. Par info-lettre, on désigne ici le contenu éditorial qui va être composé et envoyé par courriel à une liste d’inscrits. Le plugin permet de composer une info-lettre à partir d’un modèle pré-composé, (...)