Liste des identifiants de menu de SPIP

Lorsqu’on développe un plugin pour SPIP, on ajoute quasi systématiquement une entrée dans le menu du back office de SPIP pour pouvoir accéder à nos pages. Mais voilà, on ne connait pas par coeur le nom de chaque menu et sous menu. Alors voici une liste de tous les menus connus.

Préambule

Qui dit menu, dit insertion du bon code dans plugin.xml ou paquet.xml. Voici le code préconisé :
Pour paquet.xml (SPIP 2.x et SPIP 3.x) :

<bouton id="identifiant" parent="nom de l'identifiant parent">
    <icone>chemin de l'icone</icone>
    <titre>chaine de langue du titre</titre>	
    <url>nom de l'exec</url>	
    <args>arguments transmis</args>	
</bouton>

Pour paquet.xml (SPIP 3.x) :

<menu nom="identifiant" titre="chaine de langue du titre" parent="nom de l'identifiant parent" icone="chemin de l'icone" action="nom de l'exec" parametres="arguments transmis" />

Comme vous pouvez le voir, le code change un peu mes les attributs restent les même. Il faut juste ne pas oublier que c’est "menu" dans paquet.xml et "bouton" dans plugin.xml.

Les identifiants de menu

Voici la liste selon le contexte de version :

SPIP 2.x
cf. http://core.spip.org/projects/spip/repository/entry/branches/spip-2.0/ecrire/inc/bandeau.php#L30
cf. http://core.spip.org/projects/spip/repository/entry/branches/spip-2.1/ecrire/inc/bandeau.php#L30

Identifiant du parent Titre Commentaires
accueil Accueil On ne l’utilise quasiment jamais
naviguer Édition Contient généralement les liens vers les objets enregistrés en BDD
forum Forum Tout ce qui est interactivité avec l’internaute mais aussi entre auteurs
auteurs Auteurs
statistiques_visites Statistiques Ne s’affiche que si vous avez activé les visites sur votre site
configuration Configuration Toutes les pages de configuration du site, plugins compris

SPIP 2.x avec le plugin Bandeau
cf. http://zone.spip.org/trac/spip-zone/browser/_plugins_/bandeau/inc/bandeau.php#L45

Identifiant du parent Titre
bando_accueil Accueil
bando_edition Édition
bando_publication Publication
bando_reactions Activités
bando_squelette Squelettes
bando_administration Maintenance
bando_configuration Configuration
outils_collaboratifs Sans titre
outils_rapides Sans titre

SPIP 3.0
cf. http://core.spip.org/projects/spip/repository/entry/branches/spip-3.0/ecrire/inc/bandeau.php#L52

Nom du parent Titre
menu_accueil Accueil
menu_edition Édition
menu_publication Publication
menu_activite Activités
menu_squelette Squelettes
menu_administration Maintenance
menu_configuration Configuration
outils_collaboratifs Sans titre
outils_rapides Sans titre

Remarques

Comme vous pouvez le voir, en SPIP 2.x, avec le plugin "Bandeau", on a eu les prémisses du menu en SPIP 3.0. Tout comme l’appel dans paquet.xml, on a changé "bando" pour "menu". Ce qui est plus logique en soit.
Il y a aussi l’apparition de outils_collaboratifs et outils_rapides. Le premier contient tout ce qui est accès à la messagerie, au calendrier et au forum interne. Le second contiendra tous les boutons de création d’un objet éditorial (cf. ajout d’un élément dans une des tables de SPIP).
Ces 2 menus sont disponibles mais cela ne veut pas dire que c’est obligatoire lorsque votre plugin crée de nouveaux objets éditoriaux. Avoir un menu long comme le bras ne vous plaira pas très certainement ! ;-)

Quoiqu’il advienne, vous pouvez mettre pour un plugin compatible SPIP 2.x, l’insertion de vos boutons pour SPIP sans le plugin "Bandeau" et avec "Bandeau". Voici un exemple : http://zone.spip.org/trac/spip-zone/browser/_plugins_/projets_sites/client/trunk/plugin.xml#L28

Et voilà, vous avez tous les identifiants sous la main maintenant ! Vous ne pourrez plus vous tromper !

 
par Teddy Payet
3
Langage et développement
XML
Frameworks
SPIP
Catégorie
Notes de développement