Compositions 2 et 3

Ce plugin vous permet de définir plusieurs variantes de squelettes (nommées compositions) pour un même type d’objet SPIP. Dans l’espace privé, il est alors possible de choisir, dans un menu déroulant, la composition qu’on veut attribuer à chaque article (ou rubrique, auteur, etc.).

Note de version

Cette nouvelle itération du plugin Compositions apporte la possibilité de définir des héritages par branche. Elle existe en deux versions : Compositions 2 pour la branche SPIP 2.x, et Compositions 3 pour SPIP 3.x.

La fonctionnalité Article d’accueil a été extraite dans un plugin dédié.

Compositions nécessite le plugin Bonux.

Objectif

Ce plugin a pour but de fournir un mécanisme et une interface pour faire varier le type de composition de chaque objet en fonction des besoins.

Par exemple, vous pouvez avoir besoin de composer certains articles sous une forme d’article de journal, et certains autres comme des albums photos.

Ou vous pouvez vouloir composer certaines rubriques comme des blogs, et d’autres de façon plus classique...

Configuration

Le plugin ne nécessite pas CFG, mais si celui-ci est installé vous pourrez modifier certaines options de fonctionnement. Dans le cas contraire, les réglages par défaut seront appliqués.

Sous SPIP 3, le formulaire de configuration est directement accessible, sans CFG, via le menu Configuration > Compositions.

Utiliser les compositions sur les objets

Sous SPIP 3 uniquement, vous pouvez définir les objets pouvant recevoir des compositions.

Dossier des compositions

Ce réglage vous permet de choisir le sous-dossier qui contiendra les différentes compositions. Par défaut le nom de dossier compositions/ est utilisé, contenu/ si vous utilisez Zpip. C’est-à-dire que les compositions seront recherchées dans squelettes/compositions/, puis dans les sous dossiers compositions/ des plugins, etc.

Sélection des squelettes

Par défaut, le squelette de la composition est sélectionné automatiquement par SPIP. Mais ce mécanisme est désactivable pour des besoins précis.

Masquer le formulaire

Vous pouvez masquer le formulaire de Compositions aux utilisateurs n’ayant pas les droits de modifier la composition d’un objet donné afin d’alléger l’interface.

Tout verrouiller

Compositions possède un mécanisme permettant à unE webmaster de verrouiller une composition et/ou les compositions d’une branche. En activant cette option, toutes les compositions seront verrouillées et seul unE webmaster pourra les modifier.

Définir des compositions

Une composition est constituée par une paire de fichiers : un squelette et un fichier XML qui l’accompagne et porte le même nom. Leur nom est composé du type de l’objet (article, rubrique ou autre) suivi du nom de la composition séparée par un tiret. Par exemple : article-edito.html et article-edito.xml ou encore rubrique-chronologique.html et rubrique-chronologique.xml.

Les compositions doivent être rangées dans un sous-répertoire de votre dossier squelettes, appelé compositions/ (le nom de ce sous-répertoire est configurable).

Il est possible de définir une composition par défaut pour chaque type d’objet, en la nommant simplement article, rubrique, etc. sans la suffixer.

Pour définir une composition de type portfolio d’un article on va par exemple :

  • créer un squelette compositions/article-portfolio.html,
  • créer à côté un fichier compositions/article-portfolio.xml.

Le squelette sera constitué classiquement de boucles et balises pour réaliser l’affichage de l’article selon le mode de composition qui vous convient. Le fichier XML pourra contenir la description de cette composition :

<composition>
	<nom>Article Portfolio</nom>
	<description>Composition adaptée aux galeries d'images</description>
	<icon>images/article-portfolio.png</icon>
</composition>

Lorsqu’aucune composition n’est définie pour un type d’objet donné, aucune interface n’apparait dans l’espace privé.

Mais lorsque vous avez défini au moins une composition, une interface apparaît et permet aux administrateurs de choisir sur chaque objet la composition qui lui convient parmi celles qui sont définies.

Définir des compositions héritées

Dans le fichier XML d’une composition de rubrique, vous pouvez définir une composition qui s’appliquera par défaut aux objets de la branche (articles, sous-rubriques, brèves...). Il vous suffit d’ajouter dans le XML de la composition une tag de la forme <branche type="objet" composition="nom_composition" />. Par exemple, vous pouvez faire une composition rubrique-agenda avec le XML suivant :

<composition>
	<nom>Rubrique Agenda</nom>
	<description>Composition pour les rubriques gérant un agenda</description>
	<icon>images/objet-liste-contenus-dates.png</icon>
	<branche type="article" composition="agenda" />
	<branche type="rubrique" composition="agenda" />
</composition>

Les articles de cette rubrique et de ses sous-rubriques hériteront alors de la composition article-agenda.html. Attention : il doit s’agir d’une composition valable et doit donc disposer d’une description dans un fichier article-agenda.xml.

La composition héritée par un objet n’est pas forcément homonyme de la composition de la rubrique. Vous pouvez donc avoir une composition rubrique-machin avec <branche type="article" composition="truc" />. Dans le cas présent, truc fait référence au suffixe de article-truc.html. Le tag <nom></nom> de article-truc.xml reste libre de recevoir le texte de votre choix.

Par ailleurs, il vous est toujours possible de modifier au cas par cas la composition d’un objet donné. Si l’objet hérite d’une composition, l’interface vous proposera donc de lui appliquer la composition héritée ou bien de lui appliquer une autre composition de votre choix.

La composition par défaut d’un objet n’ayant pas de nom (puisqu’il s’agit du squelette correspondant au nom de l’objet sans suffixe), on pourra l’indiquer dans le tag <branche /> à l’aide d’un tiret (composition="-").

Si les rubriques parentes d’un objet définissent plusieurs compositions héritées, c’est la composition définit par la rubrique la plus proche qui s’appliquera.

Prenons un exemple concret. Supposons un secteur A ayant trois sous-rubriques A1, A2 et A3. La composition appliquée au secteur A attribue aux articles de ce secteur la composition truc (<branche type="article" composition="truc" />). Par ailleurs, on a appliqué à la sous-rubrique A3 une composition attribuant aux articles de sa branche la composition par défaut (<branche type="article" composition="-" />). Les articles des rubriques A, A1 et A2 seront alors affichés avec le squelette article-truc.html alors que ce sera article.html qui sera utilisé pour les articles de la rubrique A3 [1].

Verrouiller les compositions

Par défaut, les individus ayant le droit de modifier le contenu d’un objet ont le droit de modifier sa composition. Cependant, si vous êtes webmaster, vous pouvez verrouiller une composition. Cette dernière ne sera alors plus modifiable que par un webmaster.

Si vous êtes dans une rubrique, vous pouvez verrouiller la composition de tous les objets de cette branche (sous-rubriques, articles, brèves, sites, etc.).

Enfin, dans la configuration de Compositions, vous pouvez également verrouiller toutes les compositions.

Interface

Lorsque des compositions ont été mises en place par le webmestre, un formulaire de sélection apparait automatiquement dans l’espace privé sur chaque objet de ce type.

L’interface peut différer selon vos réglages afin de n’afficher que les options s’appliquant à votre situation.

Utilisation avec les squelettes de type Z comme Zpip

Utilisé avec un squelette Z comme le squelette Zpip (version 1.7.10 minimum), le fonctionnement par défaut des compositions s’applique au cœur de page (le contenu). Le dossier par défaut pour mettre les compositions est alors contenu/.

Une composition contenu/article-portfolio.html sera alors utilisée à la place de contenu/article.html, le reste de la page étant alors inchangé. Pour plus d’information sur la construction des pages dans le squelette Zpip, voir sa documentation.

ll n’y a donc aucun réglage à faire pour utiliser le plugin Compositions avec Zpip : il suffit de déclarer des compositions dans un dossier contenu/ (dans le dossier squelettes/ par exemple) pour pouvoir les utiliser pour faire varier la présentation du contenu des objets de SPIP.

Utilisation avec le noiZetier

Si vous utilisez Compositions avec le plugin noiZetier, vous pouvez créer des compositions directement dans l’interface de SPIP. Une fois créées, il vous reste seulement à modifier les noisettes de votre composition pour disposer d’un affichage alternatif pour vos objets.

Pour plus d’informations, voir Les compositions du noiZetier.

Utilisation personnalisée dans les squelettes

En dehors des squelettes Z, le fonctionnement du plugin par défaut est de sélectionner automatiquement un squelette, dans son intégralité. Ce mode de fonctionnement oblige donc à définir le squelette en entier pour chaque composition.

Pour une utilisation différente du plugin dans le cadre d’un squelette personnel, et pour utiliser les compositions pour faire varier une partie de la page uniquement, le mécanisme automatique peut être désactivé.

Dans ce cas, la balise #COMPOSITION peut être utilisée dans les squelettes pour inclure la bonne variante de composition dans la partie de la page que le webmestre souhaite faire varier.

La balise #COMPOSITION tient compte des héritages éventuels s’appliquant à un objet. Il est donc impératif de s’appuyer sur cette dernière et non sur la valeur du champ composition des tables SQL pour connaître la composition s’appliquant à un objet. Elle doit être appelée au sein d’une boucle.

Le plugin laisse donc la liberté au webmestre d’utiliser le mécanisme de compositions en fonction de son besoin propre.

Si par exemple, vous souhaitez que le cœur des pages articles change en fonction de la composition choisie (mais les colonnes latérales, l’en-tête et le pied de page seront inchangés), vous remplacerez la partie concernée de article.html par

<INCLURE{fond=#COMPOSITION|compositions_selectionner{article}}{env}>

.

Cette inclusion doit se trouver dans une boucle article dans ce cas.

Des icones pour vos compositions

Le plugin intègre dans le sous dossier images/ plusieurs icones simples que vous pouvez utiliser et décliner pour identifier vos compositions. N’hésitez pas à proposer vos variantes pour enrichir le plugin !

ImageCode à utiliser
<icon>images/objet-simple.png</icon>
<icon>images/objet-liste-contenus.png</icon>
<icon>images/objet-liste-contenus-dates.png</icon>
<icon>images/composition-cours.png</icon>
<icon>images/composition-tableau.png</icon>
<icon>images/composition-test.png</icon>

Notes

[1Sauf bien sûr si une composition a été attribuée spécifiquement et au cas par cas pour certains de ces articles.

Discussion

58 discussions

  • 2

    Bonjour

    je dois être complètement débile, pourtant pas débutante en spip, mais même après avoir lu à peu près tous les commentaires, je n’arrive même pas à démarrer !
    Je suis sous spip 3.2.1 avec zpip
    J’ai modifié un squelette d’article et l’ai renommé en « article-recap.html », et créé un fichier article-recap.xml avec ce code :

    <?xml version = "1.0" encoding="UTF-8" ?>
    <composition>
            <nom>recap</nom>
            <description>voir le titre</description>
            <icon></icon>
            <branche type="article" composition="recap" /> //c'est pareil avec ou sans, ça marche pas
    </composition>

    et j’ai placé le tout dans plugins/z/v1.7.31/contenu (puisque c’est là que sont mes squelettes zpip)

    Et aucune composition ne s’affiche dans l’espace privé.

    Qu’est-ce que j’ai loupé ? Il faut un appel à la composition dans article-recap.html ?

    merci de votre aide

    (tout ça c’est pour pouvoir assigner une variable dynamique à un champ de formulaire formidable...)

    • As-tu activé la composition sur les articles dans la configuration du plugin ?
      La balise <branche.../> dans le XML n’est en effet pas utile du tout et plutôt contre productive ici.

      Par ailleurs c’est pas génial du tout de mettre tes squelettes personnalisés dans le dossier du plugin plugins/z/v1.7.31/ car si tu fais une mise à jour du plugin tu vas tout perdre.

      Je te conseille plutôt de mettre dans le dossier squelettes/ à la racine de SPIP, qui est fait pour ça, et ça te permet de bien différencier ce qui est fourni par défaut dans les plugins et ce qui est propre à ton site.

    • Ouah ! Quelle réactivité !

      Oui, les cases articles et rubriques sont activés. A noter que quand je manipule les rubriques, le champ composition apparaît, mais pas pour les articles.

      Effectivement je me doute que branche ne sert à rien mais ce n’était pas mieux sans.

      En ce qui concerne l’emplacement du plugin, ça s’est fait tout seul quand je l’ai installé, je n’ai pas osé le bouger... J’ai mis à jour spip récemment et quand j’ai réinstallé zpip, il s’est remis là.

      zpip fonctionnera si je mets mes squelettes perso ailleurs ?

    Répondre à ce message

  • Bonjour,

    J’utilise SPIP 3.2.1 et j’utilise les formulaires CVT de la partie privée dans l’espace public comme #FORMULAIRE_EDITER_ARTICLE etc.
    Dans une boucle « article » j’ai placé : #FORMULAIRE_EDITER_COMPOSITION_OBJET{id_article,#ID_ARTICLE}.
    J’obtiens bien le formulaire mais après validation, j’ai une page blanche et ma modification n’est pas prise en compte.

    Si vous aviez quelques lumières ?
    Merci.

    Répondre à ce message

  • Salut,
    Impossible de changer le « dossier des compositions » en grisé dans le formulaire de config, figé sur le dossier « content/ » !
    est-ce normal ? ou le modifier si possible ?

    merci

    Répondre à ce message

  • 1

    Bonjour, mon site comporte des secteurs personnalisés et header personnalisés. Comment faire pour avoir un body différent pour appeler un header différent en fonction de la rubrique choisie ?

    • Ok, j’ai finalement trouvé... Il suffit de copier le fichier structure.html dans le dossier squelette et de modifier la ligne suivante :
      <INCLURE{fond=body#ENV{composition},env}>

      Et ensuite créer un fichier bodytruc.html dans le squelette.

       :-D

    Répondre à ce message

  • Bonjour,

    Mon environnement : SPIP 3.2.0, SarkaSpip 4.5.10, Z-core 2.6.6 et Compositions 3.7.1

    Je teste pour la première fois les compositions.
    J’ai créé une composition article-test.html (squelettes/content et squelettes/aside) qui s’applique correctement sur un article sélectionné.

    Par contre, je souhaite aussi modifier la structure globale de la page. J’ai donc créé un body-article-test.html à la racine de mon squelette, mais il n’est pas pris en compte, c’est celui de SarkaSpip qui est pris en compte (plugins/auto/sarkaspipr/v4.5.10/body.html)

    Toutefois, si j’applique la méthode « le code magique » décrite dans cet article, pas de soucis, mon body modifié est bien pris en compte. Le structure.html que j’utilise pour ce dernier test est une copie de celui de zcore, Sarkaspip n’en proposant pas.

    Une idée de ce qui peut bloquer ?

    Répondre à ce message

  • 3

    Bonjour,

    Est-il possible d’utiliser Compositions sur un objet mot-clef ? J’ai essayé avec la syntaxe suivante, mot-XX.xml et mot-XX.html mais le menu de choix n’apparait pas sur la page des mot-clefs.

    • Bonjour,
      Dans la configuration du plugin, on peut choisir le type d’objet avec lequel on veut l’utiliser...
      CDLT

    • Bonjour,

      C’est ce que j’ai fait dans la configuration du plugin.
      Le sous-menu « Composition » n’apparait pas dans la page mot-clef. Autrement dit pour les articles, j’ai bien le sous-menu mais pas pour les mots-clefs.

    • Bonjour,
      Effectivement, je viens de m’en rendre compte.
      Je suis un gros consommateur de compositions et je n’en avais, jusqu’à ce jour, jamais eu besoin avec les mots-clés.

      Avez-vous depuis tout ce temps résolu la question ?
      Merci.

    Répondre à ce message

  • Bonjour, et merci pour ce joli plug-in.
    D’abord voici la configuration dans laquelle je travaille : spipr + menus + compositions (récemment).

    J’ai une question concernant les fonctionnalités et l’histoire de ce module :
    Il est indiqué que « compositions 1 » contenait la fonctionnalité « d’article d’acceuil ». Cette fonctionnalité a-t-elle disparue de « compositions 2 et 3 » ? Cela signifie-t-il que si la fonctionnalité d’article d’acceuil doit être utilisée aussi, il faut aussi installer de plug-in ? (par exemple, compositions 2 ou 3 peut-il être paramétré pour remplir les fonctions de l’article d’acceuil aussi ?).

    En vous remerciant,
    Mike

    Répondre à ce message

  • 3

    Bonjour,
    Merci pour ce plugin.

    Mais est-il possible de modifier la composition des previews d’articles et non pas l’article en lui même ? (Vous savez sans l’accueil il y a la liste des articles cliquables et c’est ça que j’aimerai changer).
    Je travaille avec le plugin Moulinette et j’aurais besoin de modifier la composition de ces preview pour afficher des images qui prennent la moitié de l’écran par exemple.

    Merci bien :)

    • J’ai trouvé.
      Dans mon cas il fallait créer un fichier dans squelettes/inclure/ du nom de « article-moulinette.html » et modifier son code à sa guise :)
      En revanche je n’ai pas réussis à le faire grâce au plugin compositions..

    • Une composition est une caractéristique de l’article lui-même, indépendamment de son statut (publié ou en cours de rédaction).

    • Par preview d’article j’entendais des bouts d’articles avec un bouton « lire la suite » si l’article est trop gros.

    Répondre à ce message

  • Pascal Engelmajer

    Bonjour,
    je pense avoir suivi le mode d’emploi, maisl’interface du plugin composition n’apparaît pas...
    Avez-vous une idée pour me dépanner...
    Cordialement

    Répondre à ce message

  • Attention, quand on utilise z-core, le dossier par défaut est « content »

    Répondre à ce message

Ajouter un commentaire

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

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom

Dernière modification de cette page le 24 octobre 2017