Fonctionnement par défaut du noiZetier

Le noiZetier est prévu pour fonctionner nativement avec les squelettes Zpip compatibles. Cette page décrit son fonctionnement avec ces derniers.

Le fonctionnement de l’interface du noiZetier repose sur plusieurs étapes principales :

  • Déterminer les pages et les blocs pouvant recevoir des noisettes.
  • Lister les noisettes disponibles.
  • Insérer les noisettes à la fin de chaque bloc.

Lister les pages et les blocs pouvant recevoir des noisettes

La première étape consiste à déterminer les pages pouvant recevoir une noisette. Par défaut, le noiZetier considère qu’à tout fichier HTML présent dans le sous-répertoire contenu correspond une page pouvant recevoir des noisettes [1]. Les compositions classiques situées dans ce répertoire sont de fait automatiquement détectées par le noiZetier.

Ce répertoire par défaut peut être modifié en ajoutant une constante à un fichier d’options de la manière suivante :

define('_NOIZETIER_REPERTOIRE_PAGES','mon_repertoire/');

Pour améliorer la présentation des pages dans l’interface, les différentes pages peuvent être décrites sous la forme d’un fichier XML de même nom, présent dans le même sous-répertoire et reprenant une structure analogue à celle de la description des compositions (les paramètres en moins [2]). Exemple de description de la page article dans le plugin Aveline :

<page>
	<nom><:aveline:nom_page_article:></nom>
	<description><:aveline:description_page_article:></description>
	<icon>img/ic_article.png</icon>
</page>

Concernant les compositions, le noiZetier reprend le nom, la description et l’icône définies directement dans leur XML de configuration.

Enfin, le noiZetier considère que chaque page contient trois blocs : contenu, navigation et extra. Ces blocs par défaut ajoutés à chaque page peuvent être modifiés à l’aide d’un pipeline nommé noizetier_blocs_defaut.

Il est également possible de spécifier, pour une page précise, les blocs de cette page en ajoutant dans le XML de cette page l’élément suivant pour chaque bloc de la page [3] :

<bloc id="sousrepertoire" nom="plugin:chainelange"  description="plugin:chainelange"  icon="img/fichier.png" />

Le tableau décrivant l’ensemble des pages et des blocs passe au travers d’un pipeline noizetier_lister_pages permettant ainsi à un plugin de modifier ce tableau.

Lister les noisettes disponibles

La liste des noisettes est déterminée à partir du contenu des sous-répertoires noisettes. Le nom des noisettes permet de déterminer sur quelles pages chaque noisette peut être proposée.

Voir Déclarer des noisettes au noiZetier pour plus de détails.

Insérer les noisettes à la fin de chaque bloc

Le noiZetier utilise le pipeline recuperer_fond pour intercepter les appels à un squelette bloc/page.html. Le cas échéant, le noiZetier ajoute à la fin du squelette une inclusion du squelette noizetier-generer-bloc.html qui se charge d’inclure les noisettes proprement dites.

Notes

[1Si Zpip est actif, le squelette contenu/page.html est retiré de la liste des pages, ce fichier n’étant présent que pour assurer une compatibilité pour SPIP 2.0.

[2Voir Compositions 1.

[3Les blocs par défaut ne seront alors pas pris en compte.

Discussion

Aucune discussion

Ajouter un commentaire

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

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

Dernière modification de cette page le 21 juin 2010