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 !
Discussions par date d’activité
Une discussion
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 :
#SI_PAGE
#CSS
$GLOBALS['z_blocs_404'] = array('content','aside');
peut aussi être utileSinon 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 ;-)
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 ?
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
Ajouter un commentaire
Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :
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.
Suivre les commentaires : |