Le Squelette Zpip

Publié le : 11 novembre 2009 – Dernière modification le 21 décembre 2021 – par Cerdic, Matthieu Marcillaud – 364 commentaires

Español, français
1
2
3
4
5
140 votes

Ce squelette n’est plus maintenu, il est remplacé par SPIPr-dist

Zpip [1] est un modèle de squelette réutilisable, modulaire et disposant d’une galerie de thèmes. [2] Ce modèle de squelette rend l’installation d’un site avec son thème plus facile, et la personnalisation plus efficace.

Zpip-dist est la version de base de ce modèle de squelette, que vous pouvez utiliser telle quelle ou personnaliser et enrichir selon vos besoins.

Installer Zpip

Zpip se charge et s’installe comme un plugin. Pour installer Zpip et jouer avec sans plus attendre, il suffit de suivre le guide d’installation pas à pas.

Une fois installé, vous pourrez vous faire plaisir en téléchargeant des thèmes déjà existants, et revenir lire la suite de cet article au moment de mettre un peu les mains dedans pour le personnaliser !

Le projet Zpip

Plus qu’un squelette, Zpip est un exemple d’un système de squelette qui met en application les idées exposées dans Modèle de squelette réutilisable. Il propose une organisation des squelettes visant à le rendre :

  • habillable par des thèmes indépendants du squelette
  • maintenable dans le temps, par une duplication minimale du code
  • rapidement déployable, au prix d’un petit apprentissage initial sur son organisation

Zpip s’adresse aussi bien aux débutants qui veulent profiter d’une galerie de thèmes prêts à l’emploi, qu’aux webmestres avancés pour qui il propose un fonctionnement et des mécanismes productifs.

Toute l’organisation et le fonctionnement de Zpip peuvent être réutilisés pour construire de nouveaux squelettes qui bénéficieront des mêmes avantages.

Organisation des fichiers

Zpip redéfinit tous les squelettes par défaut de la dist de SPIP, à la racine de son dossier : 404.html, article.html, auteur.html, backend.html, breve.html, forum.html, login.html, mot.html, page.html, plan.html, recherche.html, rubrique.html, site.html, sommaire.html, et spip_pass.html.

À l’exception du flux RSS (backend.html), tous ces squelettes sont réécrits de façon minimale pour inclure structure.html qui produira toutes les pages. Vous pouvez donc oublier tous ces squelettes issus de la dist : vous n’aurez plus besoin de les manipuler, sauf cas exceptionnel.

Nous voici donc avec deux squelettes supplémentaires à la racine : structure.html et body.html.
Le premier, structure.html, pose la structure minimale de la page HTML, inclut les squelettes chargés de produire le head, puis le body.html qui définit le layout unique et sur lequel nous revenons ci-dessous plus en détail.

Zpip contient de plus six sous dossiers.
Deux sont génériques :

  • img/ qui contient toutes les images de décoration
  • inclure/ qui contient les squelettes communs et partagés entre les différentes pages du site.

Les quatre autres dossiers déclinent des morceaux de la page html en fonction de la page du site sur laquelle on se trouve :

  • head/ qui contient les squelettes de la section <head> personnalisée pour chaque page, lorsque c’est nécessaire, qui s’ajoute à un <head> commun situé dans inclure/
  • contenu/ dans lesquels seront mis tous les squelettes produisant le contenu principal de chaque page
  • extra/ dans lesquels seront mis tous les squelettes produisant les informations extra contextuelles pour chaque page
  • navigation/ dans lesquels seront mis tous les squelettes produisant les informations de navigation propres à chaque page

Layout Unique

Zpip est donc organisé autour d’un layout unique décrit par body.html qui intègre 6 entités logiques de contenu et les structure à sa guise dans le HTML.

Les 6 entités sont nommées selon la convention ci-dessous, eu égard à leur contenu informationnel et sans préjuger de la dénomination et de la structure englobante définie par le thème :

  • entête fournit la présentation de la page et d’identité du site
  • barre-nav constitue la navigation principale du site ; peut être vide
  • contenu contient l’information principale de la page, déclinée par type de page
  • navigation fournit des éléments de navigation secondaire, déclinés par type de page
  • extra fournit des éléments d’information connexes contextuels, déclinés par type de page
  • pied fournit des éléments de repérages et de rappels secondaires

Le layout par défaut de Zpip est simple :

<div id="page">
	<div id="entete">
		<INCLURE{fond=inclure/entete,env}>
	</div>
	<div id="nav">
		<INCLURE{fond=inclure/barre-nav,env}>
	</div>
	
	<div id="conteneur">	
		<div id="contenu">
			<INCLURE{fond=contenu/#ENV{type},env}>
		</div>

		<div id="navigation">
			<INCLURE{fond=navigation/#ENV{type},env}>
			<INCLURE{fond=extra/#ENV{type},env}>
		</div>
	</div>

	<div id="pied">
		<INCLURE{fond=inclure/pied,env}>
	</div>
</div>

Nous voyons que ce layout ne gère qu’une unique colonne #navigation, laquelle intègre le contenu des blocs de navigation et extra.

Pages automatiques

Zpip intègre un mécanisme de génération automatique des pages complètes à partir d’un seul squelette de contenu.

Par exemple, il suffit d’écrire un squelette minimal contenu/page-inscription.html contenant seulement :

#FORMULAIRE_INSCRIPTION

pour que la page complète spip.php?page=inscription soit disponible.

Pour réaliser cela Zpip utilise les éléments communs inclure/entete.html, inclure/barre-nav.html et inclure/pied.html. Pour les éléments de navigation et d’extra, Zpip utilise par défaut les squelettes navigation/dist.html et extra/dist.html si aucun squelette navigation/page-inscription.html ou extra/page-inscription.html n’est défini.

Ce mécanisme de pages automatiques permet d’ajouter, aussi rapidement que facilement, des pages spécifiques, en cohérence immédiate avec le reste du site. De même, il permet à des plugins de fournir des pages dédiées, utilisables sur tous les sites quelle qu’en soit leur structure, laquelle sera automatiquement fournie par Zpip.

Par exemple, un plugin de newsletter peut facilement fournir un squelette contenu/page-abonnement.html (permettant à l’abonné de gérer son abonnement), qui pourra être utilisé tel quel par tous les sites reposant sur Zpip.

Zpip permet de gérer votre navigation principale directement dans l’espace privé à l’aide du plugin Menus. Il suffit de créer un menu avec l’identifiant barrenav pour qu’il soit automatiquement inséré à la place de la navigation principale, sans modifications de fichiers.

Compositions

Zpip est naturellement conçu pour fonctionner avec le plugin Compositions qui permet d’utiliser plusieurs types de composition par objet, et de décliner les cœurs de page en fonction des besoins.

Thèmes

Grâce à sa structure, Zpip est utilisable directement avec une galerie de thèmes interchangeables.

Pour faciliter l’écriture de nouveaux thèmes pour Zpip, un certain nombre de conventions ont été documentées qui permettent de définir un socle commun.

Les thèmes qui respectent ces conventions pourront être utilisés indifféremment avec Zpip ou tout autre squelette reposant sur la même structure et les mêmes conventions.

Notes

[1] Le nom de ce squelette ne doit rien à l’infâme Zorglub, mais plutôt à une comédie musicale futuriste imaginant le futur de SPIP en 2050

[2] Concrètement, Zpip est issu d’une fusion des projets Zesty et SPIP-Zen.

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

168 discussions

  • mj

    Bonjour
    merci pour cet excellent outil généraliste, qui permet de faire de façon pratique des squelettes évolutifs !

    En essayant de fabriquer une page contenu/page-agenda , je tombe sur un souci que je n’arrive pas à contourner : les deux plugins (zpip et agenda) utilisent la variable « type » mais dans deux sens très différents.

    Lequel modifier pour éviter la collision ?

    Dans mon cas, le « type » passé à zpip est « mois » et il arrive bien sur à la valeur « page » dans contenu/page-agenda
    ....

    que faire ?

    merci
    MJ

    Répondre à ce message

  • alain cousin

    je crois qu’il faut pas d’espace avant la class articles
    code zspip 1.4
    .liste .articles .item .introduction
    .liste.articles .item .introduction

    cordialement alain

    Répondre à ce message

  • Bruno Poterie

    bonjour,
    voulant sur mon Zpip afficher un nuage de tags, j’ai ajouté le plugin nuage, activé, et copié le fichier navigation/page.html dans squelettes/, en ajoutant simplement

    [<h2 class="h2" id="nuagenav_heading"><:nuagenav:nuage_de_tags:></h2>
(#MODELE{nuage})]

    à la fin. Ca marche sans souci.

    Puis j’ai essayé de faire pareil, mais sans toucher au fichier directement, en créant un plugin minimaliste qui effectuerai la modification au vol via les pipelines. Le plus adapté me semble être recuperer_fond, il suffit de rajouter le code en fin de texte et voilà. Mais j’ai beau suivre la doc, rien ne se passe, le source n’est pas modifié. J’ai oublié quelque chose, mais quoi ?

    <?php
/* la fonction indiquée par le plugin.xml */
function nuagenav_recuperer_fond($flux) {
  if ($flux['args']['fond'] == 'include/navigation') {
    $flux['data']['texte'] = $flux['data']['texte'] + ' [<h2 class="h2" id="nuagenav_heading"><:nuagenav:nuage_de_tags:></h2> (#MODELE{nuage})]';
  }
  return $flux;
}
?>

    Merci de m’indiquer si vous voyez le pb !

    Répondre à ce message

  • Furby

    Bonjour,

    Je suis un peu perdu pour prendre la décision d’utiliser ou non Zpip et compositions. Je voudrais être sûr que cela peut m’aider.

    J’ai actuellement un site qui ressemble à l’image ci-dessous en SPIP 1.9, il est composé en 4 parties verticales. La partie 2 est du Flash animé qui permet de changer de page. La partie centrale contient les contenu éditorial.

    Du coup j’ai un sommaire, article, breves personnalisé et même créé d’autres fichiers breves pour faire des recherches.

    Je profite du passage en 2.0 qui me permet d’utiliser Clevermail pour reconstruire ce design et les mécanismes de navigation.

    Est-ce que Zpip peut m’aider et sait inclure des images, du flash ?

    Merci de vos retours !

    Répondre à ce message

  • RP

    J’ai mis le code pour google analytic dans layout.html et après quelques heures cela est effectif.

    Répondre à ce message

  • zel

    Bonjour,

    j’avais l’habitude (avec SPIP 1.9.2 + alternatives) de classer l’ordre des articles ou des rubriques en les numérotant (10. rubrique10 ; 12. rubrique12 ...). Cela ne semble pas marcher avec Zpip (theme Less is More). Y-a-t-il quelque chose que j’ai manqué ? Ou sinon que faut-il modifier dans le squelette ?

    Merci d’avance

    Répondre à ce message

  • Shnoulle

    Quelques idée de possible contribution à zpip

    Sur un zquelette en cour de construction, j’ai permis la modification du menu de navigation dans l’interface privée de cette facon :

    <BOUCLE_menunavigation(MENUS?){identifiant=navigation}>
<div class="menu rubriques">
[<h2>(#TITRE)</h2>]
[(#INCLURE{fond=inclure/menu, env, identifiant=navigation})]
</div>
</BOUCLE_menunavigation>
<INCLURE{fond=inclure/rubriques}{id_rubrique}>
<//B_menunavigation>

    Est ce que cela serait intéressant de l’implémenter dans zpip ?

    Merci .

    PS : a RP : le mieux serait dans inclure/pied.html je pense (en tous cas c’est là que je met le code de piwik)

    Répondre à ce message

  • 1

    Bonjour,
    J’utilise depuis quelques jours votre plugins avec en plus le plugin SpipImmo. Il semblerait qu’il y ait un problème de compatibilité avec le formulaire de recherche.

    En effet, tout fonctionne bien, mais lorsqu’on lance une recherche avec le formulaire de spipimmo, il n’y a jamais rien de renvoyé. Si je mets la même boucle dans le dossier “squelettes”, j’ai bien les résultats.

    Une idée ?

    Cordialement !

    • Shnoulle

      La recherche de Spipimmo doit sans doute être adapté à spipimmo.

      Il faudrait regarder le squelette recherche.html et intégrer la partie contenu dans
      squelette/contenu/recherche.html

      Intéressant (et surprenant) que Spipimmo soit compatible zpip.

    Répondre à ce message

  • Ben

    Fichier de langue pour l’hindi, code langue (hi)

    // C
    ’conception_graphique_par’ => ’अभिकल्पन (C)’,
    ’commentaire’ => ’टिप्पणी’,
    ’commentaires’ => ’टिप्पणियाँ’,

    // D

    // I

    // L
    ’lire_la_suite’ => ’और पढ़ें’,
    ’lire_la_suite_de’ => ’ इसके बारे में और पढ़ें ’,

    // M

    // P
    ’personaliser_nav’ => ’इस मेनू को अपने हिस्सब से ढाल लें’,

    // R

    // S
    ’sous_licence’ => ’लाइसेन्स के तहत’,

    Au passage, vous remarquerez un problème pour « lire la suite de » où le « de » est avant « lire la suite » en hindi.

    Peut être serait il intéressant de séparer dans le code « lire la suite » et « lire la suite de », pour pas que « de » s’ajoute après « lire la suite ».

    Les intéressés me comprendront ;)

    Répondre à ce message

  • RP

    Bonjour

    à quel endroit dois-je placer le code fournit par google analytic ?
    Merci
    RP

    Répondre à ce message

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

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