SPIP-Contrib

SPIP-Contrib

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

289 Plugins, 197 contribs sur SPIP-Zone, 93 visiteurs en ce moment

Accueil > Documentation > Tutoriaux pour le code de SPIP > Après SPIP 1.9 - doc.spip.org

Après SPIP 1.9 - doc.spip.org

4 mars 2006 – par Cerdic – commentaires

1 vote

Une présentation de Piif sur l’outil d’autodoc en cours de construction pour documenter le code.

L’idée est de construire un site spip de documentation à partir du code

  • un article par fonction du code
  • ajout de commentaires dans le code au dessus de chaque fonction qui renvoie automatiquement vers l’article de la doc

Chaque article peut ensuite être écrit pas des contributeurs/documenteurs (ie notamment les codeurs qui vont pas s’en tirer comme ça)

Objectif

-  pouvoir documenter le code sans comit
-  Avoir une doc de référence du code

Prochaines étapes

  • Définir la tête des url propre
  • Comment gérer les fonction déplacées dans le code, qui ont disparues du code, qui sont définies à plusieurs endroits
  • Tester que le code modifié par la moulinette de doc n’est pas impacté (commentaires placés aux mauvais endroit à cause d’une ’function’ dans une chaîne de texte par exemple)
  • Modifier TRAC pour transformer les commentaires du code avec l’url doc en lien cliquable

Dernière modification de cette page le 5 mars 2006

Retour en haut de la page

Vos commentaires

  • Le 20 mai 2006 à 10:27, par Loiseau2nuit En réponse à : Après SPIP 1.9 - doc.spip.org

    C’est une bonne idée. J’avais déjà plus u moins commencé à réfléchir à une version de spip un peu académique avec full commentaire de code, articles de méthode préenregistrés dans une ou deux rubriques exemple et des liens vers sites d’infos... pour d’une part visualiser le site plus rapidement après l’install sur serveur, et d’autre part, avoir sur place une série de conseils, et tips pour te lancer dans ta personnalisation de site.

    Par contre je maitrise assez peu tout ce qui est « Trac » « SVN » et autre outils de dev communautaire.

    Répondre à ce message

  • Le 18 mars 2006 à 19:45, par JavSP En réponse à : Après SPIP 1.9 - doc.spip.org

    Tres interesant.
    Je crois que il doit etre organisé par :
    -  version
    -  module
    -  fonction

    Si une fonction disparaitre, poser une entreé con une reference que cet fonction ja n’existe pas.

    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

  • Sauvegarder le répertoire IMG/ avec wget

    20 février 2007 – 10 commentaires

    Voici un système client serveur en deux lignes pour sauvegarder le répertoire des documents.

  • Rôles de documents

    21 février – commentaires

    Ce plugin permet d’attribuer un rôle aux documents liés aux contenus, et cerise sur le gâteau, rend possible la gestion des logos par le biais des documents-joints. Principe Les documents liés aux contenus n’ont pas forcément tous la même (...)

  • COLT : Extension de Firefox utile pour SPIP

    21 septembre 2008 – commentaires

    Une petite extension de Firefox qui permet de copier des liens sous format SPIP

  • Moulinette

    17 juillet 2015 – 46 commentaires

    Un squelette qui monte et qui descend ! Moulinette est un squelette basé sur le thème Grayscale (documentation) pour Bootstrap 3. Le type de site attendu est un site en une seule page : une rubrique avec quelques articles, des titres courts, des (...)

  • Plugin Duplicator

    3 janvier 2010 – 88 commentaires

    Duplication de rubrique et de ses contenus, et duplication d’articles pour SPIP Fonctionnement Ce plugin permet de dupliquer une rubrique et son contenu depuis l’espace privé en ajoutant un bouton dans la navigation de gauche dans l’espace privé (...)