SPIP-Contrib

SPIP-Contrib

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

290 Plugins, 198 contribs sur SPIP-Zone, 62 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

  • Convertir un site SPIP 3 en utf-8 avec le plugin Grenier

    8 janvier 2014 – 23 commentaires

    SPIP 3 fonctionne nativement avec l’encodage universel unicode utf-8. Sur certains sites (par exemple sur une mise à jour), on peut avoir un site qui est resté en iso-latin ce qui n’est pas conseillé (source de bugs, d’incompatibilité, ...) . (...)

  • ScolaSPIP 4

    19 janvier 2016 – 360 commentaires

    ScolaSPIP est plugin-squelette responsive personnalisable pour sites Web d’établissements scolaires basé sur SPIPr Présentation de ScolaSPIP Ce plugin pour SPIP 3 est développé par la Dane de l’académie de Versailles pour les webmestres de cette (...)

  • SPIP 3.2, Agenda et FullCalendar

    6 juin – 10 commentaires

    Nous avions publié un article sur la manière d’utiliser FullCalendar avec SPIP 3.0 afin d’afficher des évènements sous forme d’Agenda. La version de FullCalendar a changé avec SPIP 3.2. Le présent article est donc un tutoriel adapté à SPIP 3.2. Pour (...)

  • Mailsubscribers

    16 janvier 2013 – 408 commentaires

    Ce plugin permet de gérer les inscriptions (ou abonnements) à la diffusion de contenu par email. Mailsubscribers permet de gérer les inscriptions par Opt-in simple ou double et la désinscription par URL. Ce plugin gère également plusieurs listes de (...)

  • Nouvelle version - Modération de modifications

    29 janvier 2012 – 49 commentaires

    Suite à une migration depuis SPIP-Agora, j’ai développé ce plugin permettant de reprendre la fonctionnalité « Nouvelle version » inexistente sur SPIP2 ni sur SPIP3 Ce plugin permet d’étendre le work-flow de -rédaction-publication d’un article au cas d’un (...)