SPIP-Contrib

SPIP-Contrib

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

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

Accueil > Squelettes > Outils pour squelettes > Organisation des dossiers à la racine d’un projet SPIP

Organisation des dossiers à la racine d’un projet SPIP

21 janvier 2014 – par Cyril Marion, RastaPopoulos

11 votes

La méthode proposée ici est d’organiser les dossiers sur le serveur d’une manière rigoureuse et reproductible (industrielle ?) permettant d’optimiser le développement, la mise en production et la maintenance d’un site SPIP.

La structure de fichiers recommandée proposée est la suivante :

racine du site
    _ plugins
        _ nom_du_projet
            _ fonctions (ou « core »)
            _ squelettes
            _ theme

Chaque dossier correspond à un plugin, distinct des autres, mais faisant partie d’un même projet.

  • Le dossier fonctions ou core contient les modifications fonctionnelles propre au site (en effet, les modifications plus génériques doivent au maximum être envoyées dans les plugins de SPIP-Zone, ou dans des sous-plugins quand on ne veut pas gêner). Cela peut concerner par exemple l’ajout de champs supplémentaires sur des tables existantes, pour les besoin de ce site là. Ce dossier n’est pas obligatoirement présent si l’on n’a pas de modifications non-génériques.
  • Le dossier squelettes contient le HTML du site, le plus sémantique possible évidemment. :)
  • Le dossier theme contient les styles graphiques qui mettent en forme le HTML fourni par les squelettes.

Ce découpage est directement inspiré de la méthodologie Z, et même si on peut ranger son projet de la sorte sans utiliser Z, cette organisation est parfaitement adaptée à un site dont le squelette serait basé sur Z-core.

Dépendances

Les dépendances des trois plugins s’organisent comme suit :

  • fonctions : le plugin fonctionnel est optionnel et indépendant. Il peut avoir d’autres dépendances fonctionnelles, mais n’a pas de dépendance avec les autres plugins du projet. En revanche s’il est présent le site ne peut pas fonctionner sans lui.
  • squelettes : les squelettes nécessite les fonctions si ce plugin est présent. En effet, lorsque c’est le cas, les squelettes vont utiliser des balises ou des objets ajoutés spécifiquement pour ce site, il y a donc dépendance.
  • theme : le thème nécessite les squelettes car le graphisme du site s’applique souvent à une structure HTML et/ou des classes CSS bien particulières à ce site, et qui sont justement définies dans les squelettes.

On a donc : fonctions nécessité par squelettes nécessité par theme.

Nommage / préfixage

Le préfixe des plugins doit être singulier, de manière à limiter les équivoques et faciliter l’activation ou la désactivation par le gestionnaire de plugins.
Ainsi, le nom du dossier « squelettes/ » sera le même que celui d’un autre projet, mais son préfixe devra être différent.

Tout comme il est conseillé sur SPIP-Zone, et même si ce n’est pas du tout obligatoire, il est préférable pour limiter les confusions de nommer le nom du dossier du projet de la même manière que le préfixe de base.

Ainsi, si le projet s’appelle par exemple « Mon super projet », alors le dossier du projet ET le préfixe de base pourrait être « msp » ou « monsuperprojet ».

Ensuite le plugin fonctions (ou core) pourrait avoir comme préfixe : msp_core,
le plugin squelettes pourrait avoir comme prefixe : msp_skel
et le plugin thème pourrait être préfixé : msp_theme.

Ce qui donnerait la structure finale suivante :

racine du site
    _ plugins
        _ msp
            _ core (préfixe : msp_core)
            _ squelettes (préfixe : msp_skel)
            _ theme (préfixe : msp_theme)

Cas d’un site complexe avec une évolution des squelettes dans le temps

Toujours dans l’analogie avec SPIP-Zone, il est conseillé de versionner le projet plugin par plugin.

En effet, au cours du temps, il se peut parfaitement que le site ne change pas du tout fonctionnellement (les champs utilisés restent les mêmes), mais que le contenu que l’on veut présenter (les squelettes) ou la manière de l’afficher (le thème) demande des évolutions. Ou inversement !

Il n’y a donc pas de liaison obligatoire entre les changements. Voilà pourquoi si l’on fait une version différente du squelette, ou si l’on change complètement le thème graphique, on versionnera à l’intérieur de ces dossiers.

Proposition de structure :

racine du site
    _ plugins
        _ msp
            _ core
            |   _ v1
            |   _ v2
            _ squelettes
            |   _ v1
            |   _ v2
            _ theme
                _ v1
                _ v2

Avantages / inconvénients

AvantagesInconvénients
rangement plus lisible, un module fait une chose et le fait bien
facilité de suivi des versions
facilité de déploiement dev->prod
maintenabilité à long terme

Dernière modification de cette page le 17 février 2014

Retour en haut de la page

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

  • Facteur

    21 janvier 2010 – 383 commentaires

    Un plugin pour regrouper toutes les fonctions avancées autour de l’envoi de courriels. Introduction SPIP propose une fonction générique envoyer_mail() pour envoyer un courriel. Elle est assez simple d’utilisation mais peut paraître limitée (...)

  • Albums 3

    8 août 2014 – 224 commentaires

    Le plugin « Albums » évolue dans une version 3 pour SPIP 3. Avant d’effectuer une mise à jour depuis la version 1 ou 2, consultez les notes sur la rétro-compatibilité. Les modèles, notamment, on reçut quelques changements pour la bonne cause. En (...)

  • ciag : plugin « Groupes d’auteurs »

    30 novembre 2011 – 22 commentaires

    Ce plugin facilite l’affectation des auteurs aux rubriques, via des groupes d’auteurs. Il offre également des vues globales des affectations de rubriques aux auteurs. Les objectifs de ce plugin Le premier objectif est de faciliter (...)

  • Tickets, suivi de bugs

    28 novembre 2008 – 45 commentaires

    Tickets est un outil de suivi de bugs directement intégré à l’espace privé de SPIP. Il est conçu pour faciliter la phase de développement du site (notamment les squelettes du site public). Tickets est un système simple de suivi de bugs directement (...)

  • Titre de logo v2

    23 mai 2014 – 17 commentaires

    La version 2 du plugin Titre de logo reprend les mêmes fonctions que la v1 mais étend le titre et le descriptif aux logos de tout objet éditorial de SPIP. Vous pouvez toujours vous référer à l’article de la version 1 pour retrouver les fonctions (...)