Créer des squelettes avec Zcore

Ou comment bien démarrer avec Zcore.
Avec SPIP 3.0 est venu le plugin Zcore développé par un collectif de spipeurs. De plus en plus d’utilisateurs adoptent la mécanique de « Z » pour leurs squelettes. Ce premier article est écrit pour expliquer la Différence entre Zcore et Zpip v1.x.
Le présent article vous expliquera où vous rappellera comment mettre en place cette architecture sur un site pour éviter de s’arracher les cheveux.
Voir aussi le Plugin « Initialiser Zcore » et Organisation des scripts avec Zcore.

Préambule

En aucun cas, Zcore ne nécessite l’utilisation d’un framework CSS déterminé. Vous pouvez utiliser les feuilles de styles que vous voulez.

De plus, avant de commencer tout projet, il est nécessaire de se poser et de réfléchir à la structure que l’on désire avoir sur son site. Par exemple, l’architecture des répertoires adoptée par SPIPr-Dist est propre à ce plugin. Elle peut vous convenir comme elle peut aussi ne pas convenir à votre projet.

Première étape

Il vous faut installer le plugin Zcore dans votre répertoire « plugins » qui doit se trouver à la racine de votre site. Pour plus d’informations sur les procédures d’installation de plugins, vous pouvez vous référer à l’article dédié.

Depuis l’espace privé de SPIP, vous activerez le plugin Zcore depuis la page de gestion des plugins.

Ajouter une ligne dans mes_options.php

Zcore a besoin de savoir quels sont les dossiers ou plus exactement les « blocs » qui entrent dans son architecture « Z ». Entre autres choses, cela permet d’avoir un fichier par défaut (cf. dist.html) lorsque vous n’avez pas créé de squelettes HTML pour la page consultée. Il faut ajouter la ligne suivante dans votre fichier mes_options.php :

$GLOBALS['z_blocs'] = array('content', 'head', 'head_js', 'header', 'footer');

Avec ces valeurs, Zcore s’attend à avoir les répertoires suivants dans votre dossier squelettes/ :

  • content : qui contiendra le contenu central de votre page. C’est le nom conventionnel et historique pour Zcore. Il est obligatoire ;
  • head ;
  • head_js ;
  • header ;
  • footer.

Pour plus d’explications, vous pouvez vous référer à l’article sur le framework Z sur le site dédié à SPIPr.

Les squelettes

Les étapes précédentes réalisées, votre site sous « Z » ne sera pas encore opérationnel. Car SPIP par l’intermédiaire de Zcore s’attend à trouver dans le répertoire content/ un squelette pour chaque objet éditorial désiré.
Ainsi, vous pourrez avoir dans content/article.html les boucles adéquates pour afficher le contenu voulu sur la page article. Il sera de même pour chaque objet que vous désirez afficher dans l’espace publique.
SPIP-Zcore passera toutes variables nécessaires pour que content/article.html puisse fonctionner au mieux.

Si vous avez des besoins d’informations particulières, vous pouvez créer à la racine de votre répertoire squelettes un fichier correspondant à vos besoins.
A minima, pour un fichier squelettes/article.html, vous devez y mettre ceci :

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

Encore une fois, ce fichier est nécessaire que si vous désirez ajouter des variables d’environnement particulières à squelettes/content/article.html

Les squelettes pour les pages

Pour tous vos objets éditoriaux issus de la base de données (donc correspondant à une table), il vous faut créer un fichier html correspondant à la racine du répertoire squelettes/content/.

Pour toutes les autres pages de l’espace public qui ne font pas références à un objet, il en va de même. Il faut créer un fichier html dans le répertoire squelettes/content/. Ces pages sont appelées par ?page=sommaire, ou encore ?page=login etc.

Le point fort de Zcore est qu’il n’est pas nécessaire de mettre le préfixe page- dans le nom du fichier html, ni de mettre un fichier sommaire.html à la racine de squelettes/. (C’est l’une des différences avec le plugin Zpip, son prédécesseur.)

Le fichier par défaut

Comme il a été dit plus haut, Zcore va chercher le fichier correspondant à la page consultée dans chaque répertoire faisant partie de son architecture. Si vous n’avez pas créé ce fichier html, Zcore va prendre le fichier dist.html. Ce dernier est très utile pour ne pas avoir à répéter du code commun à toutes les pages.

Toutefois, il existe une exception : le répertoire content/. C’est le seul répertoire qui doit absolument contenir un fichier correspondant à la page consultée.

2 fichiers importants

Le plugin Zcore fournit 2 fichiers qui déterminent la mise en page :

  • structure.html ;
  • body.html.

Le fichier structure.html est appelé par les différents squelettes d’objets éditoriaux que vous avez créé dans les étapes précédentes. Il contient le code à mettre entre les balises html <head>…</head> et l’appel du fichier body.html. Vous pouvez vous référer à celui de Zcore : https://git.spip.net/spip-contrib-e...
Le fichier body.html contiendra tout ce que vous désirez mettre entre les <body>…</body>. N’oubliez pas de mettre ces dernières balises dans votre fichier body.html si vous utilisez le fichier structure.html de Zcore.

Compléments

Pour un démarrage facile
Sans aller jusqu’à utiliser SPIPr, voir le Plugin « Initialiser Zcore » du même auteur, ainsi que Organisation des scripts avec Zcore et sur le Carnet zcore-pratique.

Pour aller plus loin
Dans ce présent article, vous avez pu voir l’utilisation de 5 blocs : content, head, head_js, header, footer. Si vous désirez ajouter d’autres blocs dans votre mise en page et ainsi bénéficier des fichiers par défaut, il vous suffit de rajouter le nom de ce nouveau bloc (ex : aside) dans votre fichier mes_options.php :

$GLOBALS['z_blocs'] = array('content', 'head', 'head_js', 'header', 'footer', 'aside');

Balises et outils fournies par ZCore

Zcore fournit 2 nouvelles balises
-  la balise #SI_PAGE : elle reçoit un nom de page comme argument, et renvoie vrai si cet argument est la page courante.
Exemple d’usage :

[  (#SI_PAGE{sommaire}|oui) <INCLURE{fond=alaune}>]

-  la balise #CSS

-  Il est d’utiliser un squelette body différent pour chaque page : body-article.html, body-rubrique.html etc. C’est bien utile lorsqu’on sort des template standards.

-  La variable globale PHP z_blocs_404 définit la condition pour qu’une page d’erreur 404 soit générée. Par défaut il suffit que le bloc principal (le 1er dans la liste des blocs) soit vide. Il est cependant possible de modifier ce comportement, par exemple en disant qu’il faut que à la fois le bloc ’content’ ET le bloc ’aside’ soient vides :

$GLOBALS['z_blocs_404'] = array('content', 'aside');

Avec cette indication, la page 404 ne sera appelée que si content/xxx et aside/xxx sont vides tous les deux... Pour éviter un bouclage infini, il faut que ces 2 blocs ne soient pas vides dans la page 404 elle-même.

En savoir plus

Conclusion

En suivant ces quelques étapes, il est très facile de démarrer un projet sous l’architecture de Zcore. Cette mécanique de structure de fichiers est très pratique pour mettre en place un site internet. Vous ne pourrez plus vous en passer !

Discussion

3 discussions

  • 5

    Bonjour Teddy,

    En faisant une recherche sur le net je suis donc tombé sur cet article, bravo pour cette démarche, ça va faire gagner du temps a certains et clarifier l’utilisation de Zcore (alléger les forums ^^).

    Cela dit ce que je cherchais n’est pas mentionné dans l’article, et je me demande si ce ne serait pas bien d’ajouter les #BALISES et autres fonctions bien utiles qu’embarque Zcore comme :

    • la balise #SI_PAGE
    • la balise #CSS
    • la possibilitté d’utiliser un squelette body différent pour chaques pages body-article.html, body-rubrique.html (bien utile quand on sort des template standards à la layout gala)
    • la $GLOBALS['z_blocs_404'] = array('content','aside'); peut aussi être utile

    Sinon je suis étonné aussi que personne n’ai proposé de découper la dist en zcore comme base de démarrage, pouvant utiliser les thèmes de la dist.

    Bonne journée
    Arnaud B. (Mist. GraphX)

    • Bonjour Mist. GraphX,

      BALISE

      Il faudrait je pense faire une documentation dédiée à ces balises pour pouvoir avoir des exemples précis et ainsi mieux aider les utilisateurs sur ces particularités.
      De même pour $GLOBALS['z_blocs_404']

      body-xxx.html

      Pour body-article.html, en effet, il faudrait l’ajouter dans l’article. Je vais voir ce que je peux faire à ce sujet.

      La dist en zcore

      Il y a eu des propositions pour le faire mais je ne crois pas que cela a été réalisé ou du moins déposé sur la zone. Si le coeur t’en dit, tu es le bienvenu sur cette contribution.

      Teddy

    • oui, la surcharge de body-page ça dépanne bien ;-)

      Il y a eu des propositions pour le faire mais je ne crois pas que cela a été réalisé ou du moins déposé sur la zone. Si le coeur t’en dit, tu es le bienvenu sur cette contribution.

      le plus dur va être de trouver le nom/prefix alors , qu’il n’y ai pas d’ambiguité avec zdist, zspip, ...

      Bonne journée et merci

    • ben.... dist_Z ?

    • Syd Dolby

      J’ai créé un squelette pour Zcore à partir du squelette dist, en reprenant quelques éléments sur SPIPr-Dist. Je l’utilise comme base de démarrage pour créer mes propres squelettes.
      Par contre, je n’ai jamais testé les forums ou les brêves…, toutes les fonctionnalités que je n’utilise pas.
      Je ne sais pas trop comment déposer le squelette sur la zone, je peux le mettre sur GIT si ça intéresse quelqu’un…

    • Il n’y avait à ma connaissance pas de doc pour ces éléments, alors je les ai ajouté en complément à la fin de l’article. Il reste toutefois la fonction de #CSS à documenter. Savez vous à quoi ça sert et comment ça s’utilise ?

    Répondre à ce message

  • 8

    Bonjour,

    J’ai un problème étrange :

    Sur mon hébergement je suis obligé d’avoir le squelette principal de chaque objet.
    ex pour rubrique.html :

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

    Si ce squelette n’existe pas j’ai droit à une belle 404...

    En local çela fonctionne très bien sans les squelettes « objets » à la racine, ces squelettes ne semblent pas obligatoires...

    Je précise que je créé un squelette sous forme de plugin et que je n’ai qu’une dépendance a z-core.

    Si vous avez une explication je suis preneur :)

    Merci !

    • Je tiens a préciser qu’il y a un squelette générique dans zcore -> page.html qui dispense de créer les squelettes objets à la racine.

      Cordialement

    • Bonjour,

      Il faut avoir dans content/ le squelette de l’objet demandé. J’ai ouïe dire (suite à la création du Plugin « Initialiser Zcore ») qu’il n’est pas nécessaire d’avoir rubrique.html au même niveau que structure.html ou body.html

    • Oui, oui ! J’ai bien les squelettes qui vont bien dans content/

      Par contre les squelettes du genre :

      <BOUCLE_principale_ecureuil (ECUREUILS) {id_ecureuil}>
              <INCLURE{fond=structure, env, id_secteur=#ID_SECTEUR, type-page=ecureuil, composition=#COMPOSITION} ></INCLURE>
      </BOUCLE_principale_ecureuil>

      Ne sont pas nécessaires et ce pour n’importe quel objet spip :D.

      Pour moi ça marche très bien sur plein d’hébergements mais j’en juste 1 qui coince... (Je pense que c’est un soucis de mutualisaton )

      Essaye sans ces squelettes ça marche trés bien et ça allège l’arborescence.

    • Teddy, je confirme qu’il n’est pas nécessaire d’avoir tous les squelettes d’objet à la racine, c’est page.html de zcore qui route tout seul selon le type. Il faudrait mettre la doc à jour sur ce passage.

    • Hello,

      Merci nicod_ pour ta confirmation.
      De ce fait, j’ai mis à jour la documentation selon cette remarque. Un grand pan de l’article a donc été modifié.

       :-)

    • Salut,
      Est-ce que, quand on utilise le plugin compostions avec z-core, il faut quant même les squelettes d’objet à la racine ?
      Chez moi les compositions sont ignorés quand je n’y ai pas ces squelettes...
      ++
      j

    • Hello, j’ai remarqué la même chose pour les compositions : il faut les squelettes d’objets à la racine.

    • Bonjour,

      Il me semble qu’il est nécessaire d’avoir les fichiers des objets à la racine pour pouvoir passer la variable « composition » au reste du squelette.
      En tout cas, depuis que j’utilise Zcore, j’ai toujours eu besoin de le faire.

      Amicalement,

    Répondre à ce message

  • 5

    je me lance !

    c’est le grand saut , cela fait un moment que je tourne autour de cette histoire sans vraiment savoir par quelle bout prendre la chose. Vu de loin comme ça ... ce concept « z » fait saliver ... mais quand on s’approche un peu plus .... l’utilisateur « classique » de spip que je suis est tout simplement déboussolé.

    Pas simple de changer ses vieilles habitudes, alors , par ou commencer ?

    Je viens de m’installer un site de « découverte zcore », tout beau tout neuf .. tout vide .

    j’ai mis en place les deux plugins « zcore »
    Initialiser Zcore et Z-core 2.4.5
    j’ai installé mon dossier squelettes avec l’organisation recommandée :
    content ;
    head ;
    head_js ;
    header ;
    footer.

    (cf copies ecran)

    et maintenant ?

    quand je consulte un article bidon que je viens de créer , que se passe t’il ?
    comment la page est elle fabriquée ?
    j’avoue etre un peu perdu.
    J’aimerai bien par exemple partir sur une architeture « boostrap », comment est ce que je dois « construire » mes squelettes aujourd’hui, pour bénéficier de cette logique « z » qui me semble performante et bénéficier de l’architecture « bootstrap » que je trouve fabuleuse.

    Y a t-il un « tutorial » « zcore pour le nigauds » par exemple, pour me permettre de plonger dedans ?

    merci de vos conseils

    jacques

    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