Objectifs

Le plugin Boussole a comme buts :

• de constituer la liste "officielle" des sites SPIP en proposant une charte réutilisable,
• de proposer une liste de modèles prédéfinis pour insérer la boussole en fonction du besoin et de couvrir par là même l’ensemble des affichages utilisés dans la galaxie SPIP (voir l’article Charte de la boussole SPIP),
• d’être utilisé, a minima, dans tous les sites de la galaxie -et plus si affinité,
• et donc de constituer un repère commun pour tous les utilisateurs de SPIP.

En outre, il est possible de créer sa propre boussole personnalisée de la galaxie SPIP ou de tout autre univers.

Exemples d’utilisation

Aujourd’hui, il existe une site de la Galaxie dédiée uniquement à la boussole SPIP : http://boussole.spip.org/. On peut y accéder en interrogeant Edgard par la commande @boussole.

En outre, la plupart des sites de la galaxie SPIP ont été mis à jour avec la Boussole. Les noms, adresses, icônes et libellés de ces sites sont maintenant identiques et donc plus facilement repérables.

La planche ci-dessous illustre les différents affichages de la Boussole dans la galaxie.

Installation

Comme tout plugin, il suffit de suivre les procédures manuelles ou automatiques standard : veuillez vous reporter à cette documentation : SPIP-1-9-Les-Plugins.

Pré-requis

Boussole ne nécessite aucun autre plugin pour fonctionner.

Modèle de données

Le modèle de données de Boussole distingue trois notions principales :

• la Boussole, qui n’est autre qu’une liste de sites. Une boussole est identifiée par un alias unique qui prend la valeur « spip » pour la galaxie SPIP. Elle est décrite dans un fichier XML.
• le Groupe, qui est un sous-ensemble thèmatique des sites d’une boussole. Le groupe est identifié par un alias unique au sein d’une boussole.
• le Site, identifié par un alias unique au sein d’une boussole. Un site de boussole peut être mis en relation avec un site référencé de SPIP.

Le modèle de données est matérialisé par une unique table spip_boussoles. La table est mise à jour à partir de la lecture du fichier XML de la boussole. La DTD de ce fichier est matérialisée par le fichier boussole.dtd à la racine du plugin.

Initialisation du plugin

Etant donné que Boussole est principalement destiné à la galaxie SPIP, lors de son activation, la boussole SPIP est automatiquement chargée en base de données et donc disponible à l’utilisation. Le fichier XML de description de la boussole SPIP -boussole_spip.xml. est entreposé sur la Zone à la racine du répertoire _galaxie_/boussole.spip.org/.

L’interface privée

Elle propose - via le menu Squelettes ou Configuration suivant qu’on utilise le plugin Bandeau ou pas - une interface à onglets réservée aux admins et composée :

• d’une page principale autorisant l’ajout, la mise à jour ou la suppression d’une boussole
• une page d’édition d’une boussole donnée permettant d’en configurer l’affichage : visibilité et classement des groupes et des sites

En outre, une tache CRON tourne toutes les 24h pour mettre à jour automatiquement la boussole SPIP à partir du fichier boussole_spip.xml stocké sur la Zone.

Enfin, si un site référencé fait partie d’une boussole, sa page d’édition en fera mention et affichera un lien vers cette boussole.

L’interface publique

Des modèles

Elle est essentiellement constituée d’une liste de modèles prédéfinis consultables dans la page de démo demo/boussole.html :

• boussole_liste_simple.html - une liste ul/li avec le titre de la boussole en h2 optionnel
• boussole_liste_par_groupe.html - une liste ul/li par groupe avec titre du groupe en h3 et titre de la boussole en h2, optionnels
• boussole_liste_avec_logo.html - une liste ul/li avec le titre de la boussole en h2 optionnel. Chaque bloc de site affiche le logo, le nom et une explication, slogan ou descriptif
• boussole_panorama.html - une galerie d’icônes seuls avec le titre de la boussole en h2 optionnel
• boussole_panorama_sepia.html - idem que le modèle précédent avec des logos sépia qui s’éclairent au survol
• boussole_liste_actualite.html - une liste ul/li des articles syndiqués des sites référencés de la boussole.
• boussole_contenu_z.html - une page Z avec le titre de la boussole en h1 et les titres des groupes en h3. Chaque site est un paragraphe
• boussole_tableau.html - tableau complet de toutes les informations de la boussole. Ce modèle est utile essentiellement comme débusqueur

Les sites sont généralement présentés sous forme de lien avec le slogan en bulle d’info. Le fichier html de chaque modèle comporte en commentaire une description détaillée des paramètres du modèle.

Une page Z compatible avec le noiZetier

Boussole propose aussi une page Z, boussole.html, utilisable avec ou sans le NoiZetier. Si elle est utilisée avec le NoiZetier, il est nécessaire de configurer la noisette Boussole - Contenu principal et de l’insérer explicitement dans la page et d’y ajouter un fil d’ariane éventuellement avec la noisette Boussole - Fil d’ariane - voir ci-dessous.

L’appel de cette page se fait en passant le paramètre « boussole » désignant l’alias de la boussole à afficher - spip.php?page=boussole&boussole=spip.

Des noisettes compatibles avec le noiZetier

En outre, le plugin propose des noisettes compatibles avec le NoiZetier et qui permet d’introduire facilement dans les squelettes compatibles (Aveline, SPIPClear Z) les modèles précédemment décrits. Les noisettes disponibles sont :

• Boussole, permettant d’utiliser et de configurer les modèles standard, à savoir :
  • boussole_liste_simple.html
  • boussole_liste_par_groupe.html
  • boussole_liste_avec_logo.html
  • boussole_panorama.html
  • boussole_panorama_sepia.html
• Boussole - Actualités, permettant de configurer le modèle :
  • boussole_liste_actualite.html
• Boussole - Contenu principal, destinée principalement à la page Z boussole et permettant de configurer le modèle :
  • boussole_contenu_z.html
• Boussole - Fil d’ariane, destinée principalement à la page Z boussole

Traductions et icônes

L’intérêt de Boussole étant d’officialiser une charte des sites SPIP, le plugin intègre cette charte sous la forme :

• d’une liste d’icônes contenus dans le dossier themes/spip/images pour chaque site et boussole,
• d’une liste d’items de langue pour chaque nom, slogan et description des sites, groupes et boussoles, facilitant ainsi la traduction de la boussole SPIP via Salvatore.

Pour les icônes, le fichier est construit de la façon suivante :

• boussole-<alias de la boussole>.png, pour une boussole,
• site-<alias de la boussole>-<alias du site>.png, pour un site.

Un groupe ne possède pas d’icône spécifique.

Pour les items de langue, le nom est construit de la façon suivante :

• <nom|slogan|descriptif>_boussole_<alias de la boussole>, pour le nom, le slogan ou le descriptif d’une boussole,
• <nom|slogan|descriptif>_groupe_<alias de la boussole>_<alias du groupe>, pour le nom, le slogan ou le descriptif d’un groupe,
• <nom|slogan|descriptif>_site_<alias de la boussole>_<alias du site>, pour le nom, le slogan ou le descriptif d’un site.

Un filtre |boussole_traduire permet de traduire tous les champs concernés d’une boussole, d’un groupe ou d’un site.

Créer sa propre boussole

Il est tout à fait possible de définir sa propre boussole en créant un fichier XML boussole_<alias de la boussole>.xml à la racine du répertoire squelettes/, par exemple. Les modèles existants pourront être utilisés mais d’autres modèles peuvent aussi être développés pour répondre à des besoins spécifiques.

En utilisant les règles de nommage précédemment décrites, vous pourrez définir vos icônes et vos noms, slogans et descriptions multilangues.