Créer des modèles générant des notes de bas de page

Rappel sur ce qu’est un modèle SPIP

Un modèle est un petit squelette SPIP qui décrit un fragment de HTML facile à insérer dans un autre squelette ou — et c’est là le principale intérêt — dans le texte d’un article.

Le problème

Pour une structure associative, nous avions besoin d’un modèle capable de :

• récuperer des informations sur des activités (objet à part, spécifique à notre association) ;
• présenter ces activités, en mettant, pour certaines informations, un renvoi en note de bas de page.

Nous avions commencé par créer un modèle qui générait quelque chose comme :

Mon texte[[Une note de bas de page.]]

Le problème était que les modèles étant interprétés après les raccourcis typographiques de SPIP, nous n’avions pas de note de bas de page.

Nous pouvions éventuellement appliquer le filtre |propre au sein du modèle, afin d’interpréter les raccourcis SPIP. Cependant cela ne marchait pas correctement pour deux raisons :

1. L’appel de note était bien inséré, mais pas la note au sein de #NOTES ;
2. la numérotation de l’appel de note était incorrect, car ne tenait pas compte des notes présentes avant le modèle ; de même les notes suivant le modèle étaient mal numérotées.

La solution

Nous avons écrit ce plugin permettant à certains modèles, définis au cas par cas, d’être interprétés avant la transformation des raccourcis typographiques SPIP. Cependant, le besoin étant essentiellement pour les notes de bas de page [1], nous l’avons appelé « modèles avec notes ».

Les personnes souhaitant créer de tels modèles doivent :

1. Installer le plugin.
2. Créer leur modèle dans modeles. Ce modèle peut renvoyer un texte formaté selon les raccourcis typographiques de SPIP, et notamment avec des notes de bas de page ([[Texte de ma note]]).
3. Déclarer le pipeline modeles_avec_notes soit dans un fichier mes_options.php, soit dans le fichier paquet.xml de plugin (notamment si l’on distribue les squelettes sous forme de plugin). Voir le site « Programmer avec SPIP » sur la manière de déclarer un pipeline
4. Ajouter leur(s) modèle(s) au tableau du flux de ce pipeline.

Exemple

Le plugin fournit lui même un exemple.

<BOUCLE_articles(ARTICLES) {par titre}>
-* #TITRE[[#LESAUTEURS]]
</BOUCLE_articles>

<pipeline nom="modeles_avec_notes" inclure="modeles_avec_notes_pipelines.php" />

/**
 * Retourne la liste des modèles à traiter de manière anticipée
 * Pour y gérer les notes
 * @param array $flux liste de modeles
 * @return $array $flux
 **/
function modeles_avec_notes_modeles_avec_notes($flux = array()) {
	$flux[] = 'liste_articles_auteurs';
	return $flux;
}

Limites

Pour ce type de modèle, on prêtera attention aux limites suivantes :

• tout ce qui est susceptible d’être compris comme des raccourcis typographiques SPIP sera interprété en tant que tel ;
• contrairement aux modèles classiques (depuis la version 3.0 de SPIP), les paramètres d’environnement ne sont pas automatiquement passés [2]. Par conséquent, il faut passer explicitement chaque paramètre lors de l’appel au modèle [3].
• De même, pour les sites multibases, le paramètre $connect n’est pas passé à l’appel du modèle.