SPIP-Contrib

SPIP-Contrib

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

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

Accueil > Squelettes > Outils pour squelettes > Compositions > Compositions 2 et 3

Compositions 2 et 3

25 mars 2011 – par Cerdic, Joseph – 174 commentaires

71 votes

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 :

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

Télécharger

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 :

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

Télécharger

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>

Voir en ligne : http://plugins.spip.net/compositions

Notes

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

Dernière modification de cette page le 7 avril 2015

Retour en haut de la page

Tout afficher

Vos commentaires

  • Le 15 septembre à 20:19, par Cécile En réponse à : Compositions 2 et 3

    Bonjour

    Dans : Utilisation personnalisée dans les squelettes
    « 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é. »

    Qu’est ce que le mécanisme automatique et comment le désactiver ?

    Merci

    Répondre à ce message

  • Le 28 juillet à 11:45, par Béat En réponse à : Compositions 2 et 3

    Bonjour,

    Sur un site en Z (ZpipR) je voudrais utiliser Compositions. Si j’ai bien compris, avec une configuration Z on ne peut opérer que sur un fichier, par exemple rubrique.html dans le dossier content.

    Or, pour le même effet, je voudrais modifier aussi le fichier rubrique.html situé dans le dossier aside. (Et peut-être aussi le fichier article.html dans le dossier content…)

    Cela est-il possible et comment ?

    Merci de vos lumières.

    Béat

    Répondre à ce message

  • Le 28 juillet à 14:23, par Béat En réponse à : Compositions 2 et 3

    Bonjour,

    J’ai placé un commentaire ici ce matin, je l’ai vu et il n’y est plus ! Je vais réessayer…

    Je voudrais utiliser Compositions avec un site sous Z (SpipR). Pour arriver mes fins, j’aurais besoin d’agir sur plusieurs fichiers : content/rubrique.html, aside/rubrique.html, content/article.html.

    Est-ce possible, et si oui, comment ?

    Merci d’avance pour vos lumières.

    Répondre à ce message

  • Le 30 avril à 21:54, par Mist. GraphX En réponse à : Compositions 2 et 3

    Bonjour,

    Y’aurais t’il possibilité d’avoir des compositions de sommaire ?? je n’arrive pas a le faire sans passer par le noizettier.
    Je ne pense pas que le plugin le fasse en l’état, qu’elle serait sinon la méthode la plus efficace d’ajouter cette fonctionnalité ?

    merci de vos idées.

    • Le 19 juillet à 16:03, par Mist. GraphX En réponse à : Compositions 2 et 3

      Je retombe sur mes questions, donc je me répond a moi mm ;-)

      Compositions gère tout a fait autre chose que les objet ayant un champ compositions dans leur table.

      On peut créer des compositions pour des pages n’ayant pas d’objet/table, composition sait déjà les lister, il suffit d’appeler la saisie ainsi :

      1. [(#SAISIE{composition, composition_sommaire,
      2. label='composition du Sommaire',
      3. type=sommaire})]

      Télécharger

      Listera toutes les compositions crées pour le sommaire.

      il suffit ensuite de stocker l’info en meta (par exemple), et pour afficher la bonne compositions, ajouter a l’appel de la page :

      , composition=#CONFIG{meta/ma_config}

      et voili,
      un exemple en plugin pour la page sommaire

    Répondre à ce message

  • Le 10 mars à 16:33, par Paulo En réponse à : Compositions 2 et 3

    Je crée un site avec z-core et compositions. Au départ, mes compositions ne donnaient rien sur mes pages. En lisant les commentaires, j’en ai déduis une solution qui fonctionne, créer à la racine de mon squelette des fichiers pour chaque objet concerné.

    Un fichier article.html à la racine du squelette avec :

    1. <BOUCLE_principale_article(ARTICLES){id_article}>
    2. <INCLURE{fond=structure,env,id_rubrique=#ENV{id_rubrique,#ID_RUBRIQUE},id_secteur=#ID_SECTEUR,type-page=article,composition=#COMPOSITION} />
    3. </BOUCLE_principale_article>

    Télécharger

    Un fichier rubrique.html à la racine du squelette avec :

    1. <BOUCLE_principale_rubrique(RUBRIQUES){id_rubrique}>
    2. <INCLURE{fond=structure,env,id_rubrique=#ENV{id_rubrique,#ID_RUBRIQUE},id_secteur=#ID_SECTEUR,type-page=rubrique,composition=#COMPOSITION} />
    3. </BOUCLE_principale_rubrique>

    Télécharger

    Ça marche mais ma question est simplement est-ce une méthode orthodoxe ? Est-ce normal d’avoir à faire cela dans ce contexte(z-core 2.5.0, compositions 3.5.3) ?

    Merci de toute précision.

    Répondre à ce message

  • Le 9 février à 15:22, par joz En réponse à : Compositions 2 et 3

    Bonjour,
    J’utilise compositions (avec z-core) sur un site qui fonctionne bien en local, mais pas en ligne sur un hébergement spip mutualisé. SPIP 3.0.21 SVN [22724] + Compositions 3.5.3

    Sur ecrire/ ?exec=configurer_compositions je vois bien la page de config, mais sur ecrire/ ?exec=compositions je lis malheureusement ’Aucune composition’.

    Sur une page rubrique je vois bien la boite de gestion des compositions, mais aucune composition au choix. Juste ’Composition : composition par défaut’.

    Les fichiers sont bien présents dans le bon dossier, avec leur partenaire xml. Comme ça fonctionne en local, tout va bien de ce coté là.

    Est-ce que quelqu’un aurait une idée par où chercher le problème ?
    D’avance merci
    joz

    Répondre à ce message

  • Le 1er février à 09:53, par peetdu En réponse à : Compositions 2 et 3

    Petite anomalie dans composition (v. 3.5.3 pour SPIP 3.0 et 3.1) :

    dans le fichier .xml si on utilise un nom long, genre

    1. <nom>Rubrique avec une disposition en deux grandes colonnes</nom>

    ce nom vient se télescoper avec le bouton [Changer], cela à cause de la class ’toggle_box_link’ qui fait bien le boulot dans Dater, Editer_lien, etc, mais pas dans composition. (voir copie écran)

    Proposition en deux temps :
    1- dans le fichier compositions/formulaires/editer_composition_objet.html, ligne #29, ajouter la classe (par exemple) box_bloc
    2- ajouter le style suivant

    1. <style>
    2. .box_bloc { position: static !important; display: block !important; text-align:right;}
    3. </style>

    Télécharger

    C’est pas super propre, mais ça fait le boulot.
    Qu’en pensez-vous ?
    Je commite en l’état où on trouve mieux ?

    Répondre à ce message

  • Le 20 avril 2013 à 10:40, par benolaos En réponse à : Compositions 2 et 3

    Bonjour,

    je tiens à signaler ce que je crois reconnaître comme un bug.
    En cherchant à afficher des vignettes plus grandes (des 64x64 au lieu de 24x24) dans l’espace privé, j’ai modifié le fichier

    inc-selecteur_composition.html

    Cherchant à le rapatrier dans mon dossier squelette (pour une possible mise à jour), je remarque qu’il n’est pas pris en compte. Serait-ce un bug ?

    (Entre parenthèse, ce serait peut-être bien d’ajouter une option de paramétrage des vignettes d’illustration comme c’est le cas pour d’autres plugins...)

    • Le 21 avril 2013 à 19:07, par Joseph En réponse à : Compositions 2 et 3

      Le fichier inc-selecteur_composition.html personnalisé est-il bien dans le répertoire squelettes/formulaires/ ? (il faut respecter le chemin relatif).

    • Le 30 janvier à 09:30, par benolaos En réponse à : Compositions 2 et 3

      Bonjour Joseph,
      Avec à peine 3 ans de retard, je confirme qu’en respectant le chemin relatif, ça marche.
      Merci.

      Par contre, pour aller un peu plus loin dans la personnalisation (sous SPIP 3.1 tout du moins, par exemple pour afficher des icônes 64x64), pour l’image affichée pour la composition par défaut :
      -  Originellement :

      1. (#ICON|sinon{#CHEMIN_IMAGE{composition-24.png}}|image_reduire{24,24}|inserer_attribut{class,logo})


      -  Changement (si on veut placer la nouvelle image par défaut dans le dossier compositions :

      1. (#ICON|sinon{#CHEMIN{squelettes/compositions/composition-defaut-64.png}}|image_reduire{64,64}|inserer_attribut{class,logo})

      On voit qu’il faut rajouter « squelettes » au #CHEMIN (ce qui n’est peut-être pas normal, mais cela fonctionne).

    Répondre à ce message

  • Le 30 janvier à 09:00, par beno En réponse à : Compositions 2 et 3

    Bonjour,
    Je voudrais juste faire remonter ce qui semble être un tout petit couac d’affichage sur la version portée pour SPIP 3.1 : lorsqu’on doit choisir la composition (de son article ou sa rubrique) apparaissent les balises <b> et </b> sur le titre des compositions. Pas problématique, juste pas très élégant ;-)

    Répondre à ce message

  • Le 23 novembre 2015 à 15:45, par margranger En réponse à : Compositions 2 et 3

    Bonjour,
    sur un spip 3.0.20 avec Compositions 3.5.0, le menu ne s’affiche pas dans les articles… J’ai bien créé la paire de fichiers xml-html dans le dossier squelettes/compositions et coché la case « articles » mais rien n’y fait… Une idée ?

    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

  • Import ICS 2 (agenda distant)

    2 août – 35 commentaires

    La version 2 du plugin « import ICS » en reprend la principale fonctionnalité, à savoir l’ajout automatique d’évènements distants dans la liste des évènements d’un site. À la différence de la première version, elle ne dépend pas du plugin « Séminaire » et est (...)

  • Newsletters

    16 janvier 2013 – 374 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é, (...)

  • CKeditor 3.0

    4 octobre 2009 – 1217 commentaires

    CKeditor est l’évolution de l’éditeur WYSIWYG : FCKeditor, avec ce plugin vous pourrez utiliser cet éditeur à la place de l’éditeur de spip tout en laissant le choix à vos auteurs de l’éditeur qu’ils préfèrent utiliser. Attention : cet éditeur WYSIWYG (...)

  • GIS 4

    11 août 2012 – 1284 commentaires

    Présentation et nouveautés La version 4 de GIS abandonne la libraire Mapstraction au profit de Leaflet. Cette librairie permet de s’affranchir des librairies propriétaires tout en gardant les mêmes fonctionnalités, elle propose même de nouvelles (...)

  • SPIPr

    23 mars 2015 – 75 commentaires

    SPIPr est à la fois une famille de squelettes et un framework pour le développement front avec SPIP. Prêt à l’emploi, thémable, responsive, et conçu dans une approche d’industrialisation et de développement rapide. Documentation source : (...)

Ça spipe par là