Le Squelette Zpip

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.

Footnotes

[1Le 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

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

updated on 2 October 2019

Discussion

168 discussions

  • Ne faut il pas renommer cet article “Le plugin Zpip” ?

    Reply to this message

  • 2

    dans contenu/page.html

    il y a

    #INCLURE{fond=extra/page-#GET{composition},env}

    or normalement, si j’ai bien compris, l’extra s’appel directement dans le layout non ?

    Reply to this message

  • Je commence un peu à faire migrer collection vers ce modèle.

    Je but sur un point : ton modèle propose un menu de navigation différent selon le type de page.

    Or ce n’est pas le cas de mon squelette. Que faire. Pour le moment, j’ai mis dans navigation/article.html

    <INCLURE{fond=navigation/navigation.html>

    Y a-t-il une convention de nommage ?

    Reply to this message

  • 1

    la syntaxe suivante avec env au lieu de ,env semble fonctionner pour moi.

    ça

    <INCLURE{fond=contenu/#ENV{type} }{env}>

    au lieu de ça

    <INCLURE{fond=contenu/#ENV{type},env }>
    • Je viens de rajouter une condition pour forcer la mise à jour en 2.0.10 (qui est un upgrade mineur pouvant être réalisé les yeux fermés), pour utiliser Zpip.

    Reply to this message

  • 1

    Bonjour,
    je teste le plugin et j’obtiens une erreur quand j’essaye de voir un article

    1 Aucun squelette ’contenu/.html’ n’est disponible...
    2 Erreur de compilation
    3 Aucun squelette ’navigation/.html’ n’est disponible...
    4 Erreur de compilation
    5 Aucun squelette ’extra/.html’ n’est disponible...

    cala ne vient il pas des inclures? je ne connais pas la syntaxe avec “,env” ?
    une idée ?

    Reply to this message

  • 1

    Oui, je n’avais pas compris que c’était un plugin ! Merci de l’info
    Donc maintenant ça va aller.

    Mais avant de pouvoir le regarder, Zpip permet-il de faire une colonne à droite - ou une colonne à gauche pour la navigation ? Je cherche un squelette avec colonne à gauche.

    Merci

    • Zpip permet de faire tout ce qu’on veut, mais à condition qu’un thème existe ou que tu le fabriques toi même. Attends un peu qu’il y ait des thèmes de publiés peut-être ?

    Reply to this message

  • 1

    Bonjour

    J’ai téléchargé Zpip, et je l’ai décompressé
    et j’ai envoyé tous les fichiers dans www

    et j’obtiens, par deux fois, le message suivant :
    Vous n’avez pas le droit d’accéder au répertoire demandé. Soit il n’y a pas de document index soit le répertoire est protégé.

    Ai-je fait quelque chose qu’il ne fallait pas ?

    Merci de votre réponse

    Reply to this message

  • 3

    Y a-t-il un site de démo? Où voir ce squelette qui paraît bien prometteur?

    • Le thème squelette en lui même n’est pas une révolution, tu peut jeter un oeil sur zesty pour avoir une idée du thème du squelette.

      C’est plus une aide au développement rapide de squelette.

      Merci aux devs pour la suite de zesty (je fais mes squelettes de plus en plus souvent sur une base zesty maintenant ;))

      Bon, on y va pour proposer des thèmes !!

      Une remarque: ne serait il pas intéressant de proposer des barre-nav spécifique, par défaut elle est vide, il y a la barre-nav-secteur en plus. On peut envisager une barre-nav Acceuil/Archives/Suivre/Contact(AUTEUR(1)). etc ...

      Sans avoir à passer par menus-navigation ?

    • http://zpip.spip.org/ est le site de démo, mais qui va prendre tout son sens dans les jours qui viennent.

    • Merci de ton lien pour zesty. Comme tu peux le lire sur le blog, zesty est une première application du concept qui date d’il y a un an. Un galop d’essai en quelque sorte.

    Reply to this message

Comment on this article

Who are you?
  • [Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom