Ajouter des types d’entrées pour les menus

Afin d’être facilement extensibles, les types d’entrées sont tous définis dans des squelettes SPIP configurables. Nous allons voir comment les écrire.

Placer les fichiers

Un type d’entrée se définit grâce à un squelette SPIP associé à un fichier XML le décrivant. Les deux fichiers ayant le même nom.

Ces fichiers doivent être placé dans un dossier menus/

On aura donc par exemple :

menus/
	lien.html
	lien.xml

Le squelette

Il est composé de deux grandes parties :

  1. qu’affiche-t-on dans le formulaire de création des menus pour décrire l’entrée ?
  2. qu’affiche-t-on dans le menu lui-même ?

Pour les différencier, deux variables sont accessibles : #ENV{appel_formulaire} et #ENV{appel_menu}. Il suffit donc de les tester pour afficher les bonnes choses au bon endroit.

Pour le premier point, il s’agit juste d’une ligne qui va décrire le plus explicitement possible ce qu’aura configuré l’utilisateur. On affichera donc un titre, et des informations complémentaires. Deux classes CSS sont prévues pour cela : « titre », et « infos ».

Ce qui donne quelque chose du genre :

[(#ENV{appel_formulaire}|oui)
	<div class="titre">#ENV{titre}</div>
	<div class="infos">#ENV{url}</div>
]

Maintenant il faut écrire ce qui sera vraiment inséré dans le menu final. Un type d’entrée peut ajouter une ligne avec un lien dans le menu. Ou plusieurs lignes. Ou plusieurs lignes en cascade (des sous-menus). Tout est possible.

Un type simple comme les liens arbitraires donne donc :

[(#ENV{appel_menu}|oui)
	<li class="entree">
		<a href="#ENV{url}">#ENV{titre}</a>
]

Pourquoi la balise LI n’est pas fermée ? : Pour les types d’entrées qui accepte des sous-menus, il ne faut pas fermer la balise, car le plugin va insérer le sous-menu à l’intérieur du <li>. C’est donc le plugin qui s’occupera de fermer la balise.
En revanche, lorsque votre type refuse les sous-menus, alors vous pouvez écrire normalement et fermer les balises comme il faut (comme dans le cas suivant par exemple).

Si vous avez besoin d’écrire des boucles à l’intérieur des tests, il faut alors utiliser la boucle (CONDITION) fournie par Bonux. Par exemple :

<BOUCLE_test_menu(CONDITION){si #ENV{appel_menu}|oui}>
	<BOUCLE_rub(RUBRIQUES){id_parent=#ENV{id_rubrique}}>
		<li><a href="#URL_RUBRIQUE">#TITRE</a></li>
	</BOUCLE_rub>
</BOUCLE_test_menu>

Le fichier XML de configuration

Ce fichier va permettre de décrire le type d’entrée afin d’afficher les choix lorsqu’on est dans le formulaire de création des menus. Il va notamment définir les paramètres dont le squelette aura besoin.

Voici à quoi il peut ressembler :

<entree>
	<nom>Nom du type d'entrée</nom>
	<description>Une description détaillée expliquant à l'utilisateur ce que fera le squelette</description>
	<icone>images/une_icone.png</icone>
	<parametre nom="titre" label="Le titre du paramètre" obligatoire="oui" />
	<parametre nom="url" label="menus:ou_une_chaine_de_langue" obligatoire="oui" />
	<refuser_sous_menu />
</entree>

La plupart de ces éléments sont assez explicites. Remarquez que l’on retrouve bien les deux paramètres dont nous avions besoin précédemment dans le squelette : #ENV{titre} et #ENV{url}.

L’élément <refuser_sous_menu/> permet d’interdire la création d’un sous-menu en-dessous des entrées de ce type. En effet, il arrive que des types créent déjà plusieurs entrées voire des sous-menus, comme lorsque l’on affiche les rubriques sur plusieurs niveaux. Dans ce cas, cela n’a aucun sens de pouvoir créer un sous-menu de cette entrée.

Et voilà !

Normalement vous savez tout pour créer vous-mêmes vos entrées personnalisées si ce que fournit le plugin Menus ne vous suffit pas.

En revanche, si vous pensez que vos créations ont une utilisation générique et qu’elles peuvent servir à d’autres, alors n’hésitez pas à les ajouter directement dans le plugin pour les partager avec tout le monde !

Discussion

3 discussions

  • Bonjour,
    y a t-il possibilité de sélectionner une rubrique contenant des brèves ou des sites syndiqués ?
    y a t-il une méthode pour appeler une noisette ?
    cordialement

    Répondre à ce message

  • critère de tri ?

    # Critère de tri (numérique) [Facultatif]
    # Critère de tri (alphabétique) [Facultatif]

    Que remplir pour que s’affiche les articles dans le menu de manière antéchronologique ?
    J’aimerais avoir les derniers articles d’un mot clé par date inverse

    Répondre à ce message

  • 3

    En me basant sur le mécanisme décrit ici et sur l’un des modèles existant j’ai pu créer un type d’entrée listant tous les articles d’une rubrique.

    Pour le .html :

    [(#SET{id_rubrique, #ENV{id_rubrique}|intval})]
    [(#SET{tri_num, #ENV{tri_num}|ou{#ENV{tri_alpha}}|?{#ENV{tri_num},'titre'}})]
    [(#SET{tri_alpha, #ENV{tri_num}|ou{#ENV{tri_alpha}}|?{#ENV{tri_alpha},'titre'}})]
     
    [(#ENV{appel_formulaire}|oui)
    	[(#SET{titre, #GET{id_rubrique}|?{#INFO_TITRE{rubrique, #GET{id_rubrique}}, <:info_racine_site:>}})]
    	<div class="titre">#GET{titre}</div>
    	<div class="infos">
    		<br /><:menus:info_tri:> [(#GET{tri_num}) <:menus:info_tri_num:>][(#GET{tri_num}|et{GET{tri_alpha}}), ][(#GET{tri_alpha}) <:menus:info_tri_alpha:>]
    	</div>
    ]
     
    <BOUCLE_test_menu(CONDITION){si #ENV{appel_menu}|oui}>
    	<BOUCLE_rub(RUBRIQUES){id_rubrique=#ENV{id_rubrique}}>
    		<li class="menu-entree">#TITRE
    			<B_articles>
    			<ul class="menu-liste">
    				<BOUCLE_articles(ARTICLES){id_rubrique}>
    					<li class="menu-entree"><a href="#URL_ARTICLE">#TITRE</li></a>
    				</BOUCLE_articles>
    			</ul>
    			<B_articles>
    		</li>
    	</BOUCLE_rub>
    </BOUCLE_test_menu>

    et pour le .xml :

    <entree>
    	<nom>Liste d&rsquo;articles</nom>
    	<description>Affiche la liste des articles d&rsquo;une rubrique</description>
    	<icone>img/articles.png</icone>
    	<parametre nom="id_rubrique" label="menus:entree_id_rubrique" />
    	<parametre nom="tri_num" label="menus:entree_tri_num" />
    	<parametre nom="tri_alpha" label="menus:entree_tri_alpha" />
    	<refuser_sous_menu />
    </entree>

    ça fonctionne comme j’en avais besoin. On pourrait en théorie ajouter des types de tris supplémentaires.

    • Ben si tu penses que c’est générique, n’hésite pas à l’ajouter au plugin. :)

    • Bien ça ! J’avais voulu bidouiller un truc en ce sens mais j’avais du me planter quelque part et ca n’a jamais voulu marcher. Du coup j’étais partis sur autre chose.

      Pour les tris en revanche, j’avoue que je n’ai pas encore compris quoi mettre dans les champs ?

    • Alain BOURDEAU

      Bonjour,
      Après tatonnements, il suffit de mettre le nom du champ de la table concernée dans le type de trie.
      Par exemple si le menu est sur des mots clés :
      le trie numérique serait sur id_mot
      le trie alpha serait sur :titre

    Répondre à ce message

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 7 septembre 2009