Guide pour l`installation du glossaire sur un site SPIP 2.x

Installation du glossaire Eaufrance
sur un site SPIP (version 2.x)
Guide d’installation
Nicolas Dhuygelaere (OIEau)
01/01/2012
Version 1.0
Document élaboré en application du
schéma national des données sur l’eau
•
CONTEXTE
Ce document est élaboré dans le cadre de la convention Onema/OIEau 2011. Il vient en appui aux
utilisateurs des outils communs du SIE mis en place sur les sites en application du schéma web de
diffusion des données (SWDD) sur l’eau. C’est un document technique à destination des
administrateurs de sites web.
•
DOCUMENTS DE REFERENCE
Schéma web de diffusion des données sur l’eau
Anne Lançon (ONEMA)
Un glossaire sur l’eau et les milieux aquatiques
Janik Michon (ONEMA)
Création d’un flux de syndication de concepts du glossaire
Eaufrance pour intégration à un site web
Installation du glossaire Eaufrance sur un site DRUPAL
(version 6.x)
Nicolas Dhuygelaere (OIEau)
•
Nicolas Dhuygelaere (OIEau)
AUTEURS ET CONTRIBUTEURS
Nicolas Dhuygelaere, ingénieur études données (OIEau)
Avec la contribution de
Anne Lançon, chef de projet « diffusion des données » (ONEMA)
Janik Michon, chef de projet « valorisation des données » (ONEMA)
Sous la coordination de
Janik Michon, chef de projet « valorisation des données » (ONEMA)
Droits d’usage : http://creativecommons.org/licenses/by-nc-sa/2.0/fr
Mots-clés : Glossaire, eaufrance, eau, thésaurus, guide
Couverture géographique : France (dont DOM)
Niveau géographique : Niveau de lecture : Professionnel
Langue : Français
Diffuseur : Office national de l’eau et des milieux aquatiques (Onema)
•
OBJET ET DOMAINE D’APPLICATION
Ce document vient en appui aux utilisateurs des outils communs du SIE mis en place en application
du schéma web de diffusion des données (SWDD) sur l’eau. C’est un document technique à
destination des administrateurs de sites web, en particulier ceux de la toile eaufrance.fr, qui souhaitent
intégrer le glossaire Eaufrance sur leur site web développé en SPIP.
Les préconisations techniques qui suivent sont valables pour les sites développés en SPIP, version
égale ou supérieure à 2.0.6.
•
SOMMAIRE
1. Introduction ......................................................................................................... 5
2. Présentation du package SPIP 2.x..................................................................... 6
3. Installation du package SPIP 2.x ....................................................................... 6
3.1
3.2
Pré-requis ..............................................................................................................7
Téléchargement et installation du package .......................................................7
3.2.1
3.2.2
3.3
Téléchargement .................................................................................................. 7
Installation des plugins ........................................................................................ 8
Configuration du module .....................................................................................9
3.3.1 Configuration de la syndication au glossaire eaufrance ...................................... 9
3.3.1.1 Créer une liste de concepts sur le glossaire Eaufrance pour mon site................. 9
3.3.1.2 Configurer la syndication à une liste de concepts .............................................. 10
3.3.2 Configuration du « Glossaire auto » .................................................................. 11
3.3.2.1 Principe de fonctionnement................................................................................ 11
3.3.2.2 Options de configurations................................................................................... 13
4. Présentation du type de contenu Concept SKOS .......................................... 14
4.1. Qu’est-ce qu’un « Concept SKOS » ?...............................................................14
4.2. Pourquoi un nouveau type de contenu? ..........................................................14
4.3. Description des champs ....................................................................................14
5. Intégration du glossaire selon la charte Eaufrance ....................................... 15
5.1. Modification du bandeau haut...........................................................................15
5.2. Style général de la page abécédaire .................................................................15
5.3. Style général de la page d’un concept .............................................................17
6. Informations supplémentaires pour les développeurs .................................. 18
•
GUIDE
1. Introduction
De nombreux acteurs produisent et diffusent des informations relatives à l'eau et aux milieux
aquatiques, utilisant des termes plus ou moins techniques. Pour faciliter un langage commun, et dans
un souci de cohérence, les partenaires du système d'information sur l'eau (SIE) ont décidé de mettre
à disposition le glossaire qu'ils ont établi ensemble.
Ce glossaire est accessible à l'adresse suivante : http://www.glossaire.eaufrance.fr .
Figure 1 : Page d’accueil du site www.glossaire.eaufrance.fr
Le contenu actuel de ce glossaire repose sur l'analyse d'une cinquantaine de glossaires existants
(documents, sites web, ...), et comprend environ 1000 termes, dont la consultation est libre d'accès.
Le glossaire est évolutif : tout utilisateur peut proposer de modifier ou supprimer certains termes. Les
propositions sont évaluées par un groupe d'utilisateurs, partenaires du SIE. Ce site permet par ailleurs
à d'autres sites web d'alimenter dynamiquement leurs contenus, en s’abonnant au glossaire, et d'être
mis à jour en temps réel. Si un utilisateur gère lui-même un glossaire et qu’il souhaite bénéficier du
contenu de celui-ci, il lui suffit de s’abonner par flux RSS / RDF.
Par ailleurs, pour favoriser l'utilisation du glossaire par d'autres sites partenaires, des outils ont été
développés afin d'importer, de présenter et d'exploiter sur leur propre site les concepts définis dans le
glossaire Eaufrance. Il s'agit notamment de packages contenant les modules/plugin nécessaires à
l'intégration du glossaire sur des sites réalisés sous DRUPAL 6.x et SPIP 2.x. Ces outils sont
disponibles à l'adresse : http://www.glossaire.eaufrance.fr/noeud/comment-réutiliser-le-glossaire.
Le présent document détail les modalités d’utilisation de l’outil destiné aux sites fonctionnant
sous SPIP 2.x.
2. Présentation du package SPIP 2.x
Le package « glossaire Eaufrance pour SPIP 2.x », offre les fonctionnalités suivantes :
•
la création d'une page « glossaire » sur votre site
Figure 2 : Capture d'écran de la page "glossaire"
•
la syndication à une liste de concept du glossaire Eaufrance
Figure 3 : Capture d'écran de la page de configuration des flux de syndication
•
la recherche des mots du glossaire dans les pages de votre site afin de créer des
liens/infobulles présentant les concepts du glossaire (la création de ces éléments interactifs
ne modifie en rien le contenu de votre site)
Figure 4 : Exemple de fonctionnement du glossaire automatique
Le package offre également de nombreuses options de configuration.
3. Installation du package SPIP 2.x
Avertissement :
Même si le package a fait l'objet de nombreux tests, avant toute opération, effectuez une
sauvegarde complète de votre site (code+base de données) pour plus de précautions.
3.1 Pré-requis
Le package a été développé et testé pour une installation SPIP 2.0.61, sous PHP 5 fonctionnant avec
une base Mysql. Une installation sous PHP 4 est fortement déconseillée en raison de la dépendance
des fonctions de syndication à la librairie php simpleXML.
Vous devez bénéficier des droits d'écriture sur votre serveur web afin de déposer les fichiers des
différents modules nécessaires, et des droits administrateur sur votre site SPIP pour activer les
modules.
Par ailleurs, pour installer le plugin « glossaire », vous devez installer au préalable, et dans l'ordre
suivant, les modules présentés ci-après, préférentiellement dans leur dernière version stable pour
SPIP 2.x :
•
CFG - moteur de configuration : ce plugin permet de gérer très simplement des interfaces
de configuration pour différents modules. Il est disponible à l’adresse suivante :
http://plugins.spip.net/cfg.html ;
•
Saisies pour formulaires : ce plugin permet de faciliter l’écriture de champs de formulaires
en proposant une balise « #SAISIE ». Le HTML généré est compatible avec la nomenclature
des formulaires proposé par SPIP 2.0 et avec le plugin de configuration CFG. Il est disponible
à l’adresse suivante : http://plugins.spip.net/saisies.html ;
•
SPIP Bonux : ce plugin apporte de nombreuses fonctionnalités supplémentaires à SPIP :
(boucles POUR et CONDITION, tableaux, compteur, etc.). Il est disponible à l’adresse
suivante : http://plugins.spip.net/spip_bonux.html
Pour installer, un plugin sous SPIP 2.x, référez-vous à la documentation officielle en ligne :
http://www.spip.net/fr_article3396.html. Si votre installation dispose déjà de l'un de ces plugins, il n'est
à priori pas nécessaire de le réinstaller.
Pour un fonctionnement optimal du package, il est également recommandé de :
•
disposer de la librairie curl, accessible à l’adresse : http://fr.php.net/manual/fr/book.curl.php
avec php. Cette librairie est notamment utile pour les fonctions de syndication, afin de charger
le flux en provenance du glossaire eaufrance. Si cette librairie n'est pas disponible, le plugin
« glossaire » utilisera la fonction php « file_get_contents() » avec le risque d'atteindre un
timeout si le glossaire met trop de temps à répondre ;
•
d'installer le plugin « simple HTML DOM parser », fourni avec l’archive d’installation du
plugin « glossaire ». Ce module permet d'améliorer les fonctions de recherche automatique
des mots du glossaire dans les textes du site.
3.2 Téléchargement et installation du package
3.2.1 Téléchargement
Le package « glossaire Eaufrance » pour SPIP 2.x est disponible à l'adresse suivante :
http://www.glossaire.eaufrance.fr/noeud/comment-réutiliser-le-glossaire.
Dans la section « Comment utiliser un flux de syndication sur un site web ? » de la page concernée,
cliquez sur le lien de téléchargement du « plugin d’installation du glossaire sur un site SPIP 2.x » : le
fichier en téléchargement est une archive zip.
1
Le plugin glossaire a été testé avec succès sur les versions de SPIP allant de 2.0.6 à 2.1.12. Un fonctionnement sous SPIP
2.0.0 à 2.0.5 est possible sous condition de modifier le core de SPIP. Cette opération est totalement déconseillé est un passage
aux versions 2.0.6 à 2.0.9 est dans ce cas la meilleure alternative.
Figure 5 : Page de téléchargement du package glossaire
3.2.2 Installation des plugins
Une fois le package téléchargé, décompressez l'archive zip et placez les fichiers sur votre serveur
web, au niveau de la racine du site SPIP.
Lorsque les fichiers sont en place, avec votre navigateur web, rendez vous dans l'interface
d'administration
de
votre
site
SPIP
à
la
page
de
gestion
des
modules :
http://www.monsite.fr/ecrire/?exec=admin_plugin (nécessite les droits d'administrateur).
Puis cochez les plugins suivants (voir image ci-dessous) :
•
•
•
•
•
CFG ;
Glossaire ;
Saisies pour formulaires ;
Simple HTML DOM parser ;
SPIP Bonux.
Figure 6 : Page d'activation des plugins SPIP
Enfin, cliquez sur le bouton « Valider» situé sous le bloc « plugins » pour activer les plugins
sélectionnés.
Les plugins « glossaire » et « simple HTML DOM parser » utilisent des librairies externes : « jquerytooltip » (pour les infobulles) et « simplehtmldom » (pour l’analyse du code HTML). Celles-ci sont
normalement installées dans le répertoire « lib » à la racine de votre site lors de l’activation des
plugins. Si l’installation automatique de ces librairies ne s’effectue pas correctement, vous devez
répéter l’opération manuellement, et placer le répertoire « lib » contenu dans l’archive à la racine de
votre site.
Après l'activation des modules, il est conseillé de vider le cache de SPIP en lançant la page suivante :
http://www.monsite.fr/ecrire/?exec=admin_vider.
Afin de vérifier que installation est correctement réalisée, vous pouvez :
•
•
ouvrir la page http://www.monsite.fr/spip.php?page=glossaire&lettre=A ,
tester l’existence de deux nouveaux items la section « Edition » du menu d’administration du
site.
Figure 7 : Liens d'administration créer par le plugin glossaire
Note sur les fichiers de langues et la traduction du site :
Afin de prendre en compte le multilinguisme de SPIP, les interfaces du « package glossaire » ont été
développées en utilisant la méthode des codes traductions. Pour l’instant, seuls les fichiers
traductions pour la langue française sont disponibles.
3.3 Configuration du module
3.3.1 Configuration de la syndication au glossaire eaufrance
3.3.1.1 Créer une liste de concepts sur le glossaire Eaufrance pour mon site
Une guide spécifique décrit le processus. Il est également accessible à l’adresse :
http://www.glossaire.eaufrance.fr/noeud/comment-réutiliser-le-glossaire.
3.3.1.2 Configurer la syndication à une liste de concepts
Une fois que vous avez établi votre liste de concepts et configuré son export en flux en RSS ou RDF
sur le site http://www.glossaire.eaufrance.fr, vous pouvez réutiliser l'url de votre flux pour importer les
concepts sur votre site grâce au plugin « glossaire ».
L'accès à l'interface de configuration se trouve dans la partie « Flux de concepts » de la section
« Edition » du menu d'administration de votre site. L'URL pour y accéder est de la forme suivante :
http://www.monsite.fr/ecrire/?exec=liste_flux .
Sur cette page, vous trouverez la liste des flux déjà configurés avec les informations les concernant
(cf image ci-dessous).
Figure 8 : Interface de configuration des flux de syndication
A la fin, de chaque ligne descriptive, vous trouverez des liens vous permettant de forcer la
synchronisation du flux avec le glossaire, de le modifier et de le supprimer. Sur cette page vous
trouverez également un lien pour créer un nouveau flux.
Lors de la modification ou de la création des flux vous disposez des options de configuration
suivantes :
•
le nom du flux ;
•
l'adresse du flux (celle que vous avez créée sur le site http://www.glossaire.eaufrance.fr ) ;
•
le format du flux : RSS, RDF-SKOS + mode de détermination automatique ;
•
la définition de la valeur par défaut du champ « source » ;
•
la fréquence de synchronisation de votre flux (utiliser la fonction cron de SPIP).
Figure 9 : Formulaire de configuration d'un flux de syndication
3.3.2 Configuration du « Glossaire auto »
3.3.2.1 Principe de fonctionnement
Le module « glossaire auto » permet de rechercher dans un texte une liste de termes prédéfinie. Nous
utilisons ici le mot « terme » et non pas « concept » car la liste des mots à rechercher est en fait
constituée des libellés, des libellés alternatifs et des sigles de chaque concept du glossaire importés
dans votre site.
Lors du processus de recherche des termes du glossaire dans un texte, l’algorithme recherche dans
le texte des séquences de mots correspondant aux termes du glossaire en utilisant une méthode
simplifiée de lemmatisation (cf : http://fr.wikipedia.org/wiki/Lemmatisation) associée à des expressions
régulières (cf : http://fr.wikipedia.org/wiki/Expressions_régulières). La lemmatisation est dite simplifiée
car elle ne gère que les caractères accentués, les formes plurales et féminines simples, c'est à dire
des mots finissant par : s, x et e.
Par exemple le système trouvera :
•
« eaux douces » pour « eau douce » ;
•
« rejeté », « rejets », « rejetées » pour « rejet ».
Mais le système ne trouvera pas :
•
« arrêtés préfectoraux » pour « arrêté préfectoral » car la forme plurale est plus complexe ;
•
« normalisation » pour « norme » mots ayant le même lemme (même racine).
Dans cette première version, le glossaire automatique n'est pas capable de considérer le sens du
terme (en fonction d'une thématique) par rapport au sens du texte en se basant sur un champ
sémantique ou sur une liste fermée de thématiques. Des contresens sont donc possibles sur des
termes ayant des homonymes ou des sigles significatifs (exemple : MISE). Dans la version suivante,
un correctif sera apporté.
Le tableau ci-dessous présente quelques exemples de résultats de recherche en fonction du mode de
recherche sur un texte de référence (les mots en italique indiquent quels sont les mots trouvés par le
glossaire auto).
Texte de référence :
Agence de l'eau
Établissement public de l'État à caractère administratif placé sous la tutelle du ministre chargé
de l'environnement. Dans le bassin ou groupement de bassins, l'agence de l'eau met en
œuvre le schéma directeur d'aménagement et de gestion des eaux (SDAGE) et les schémas
d'aménagement et de gestion des eaux (SAGE), en favorisant une gestion équilibrée et
économe de la ressource en eau et des milieux aquatiques, l'alimentation en eau potable, la
régulation des crues et le développement durable des activités économiques. Elle mène, de
plus, une politique foncière de sauvegarde des zones humides approuvée par le comité de
bassin. Ses ressources proviennent essentiellement de la perception de redevances sur les
prélèvements et la pollution des eaux...
Tableau 1 : Exemples de résultat en fonction du mode de recherche sur un texte de référence
Termes du glossaire
Recherche
simple (mot à
mot)
Recherche
insensible à
la casse
Recherche
insensible à la
casse avec prise
en compte de la
ponctuation
Recherche avec
lemmatisation
Bassin
non
oui
oui
oui
non
oui
oui
Groupement de bassins non
Schéma directeur
non
oui
oui
oui
SDAGE
non
non
oui
oui
non
Schéma
d'aménagement et de
gestion des eaux
non
non
oui
SAGE
non
non
oui
oui
Eau potable
non
non
oui
oui
Crue
non
non
non
oui
oui
oui
oui
Développement durable non
Zone humide
non
non
non
oui
Comité de bassin
non
non
oui
oui
Prélèvement
non
non
oui
oui
Pollution
non
oui
oui
oui
3.3.2.2 Options de configurations
Le module propose différentes options de configuration dans la section « configuration / CGF /
glossaire » à l’adresse suivante : http://www.monsite.fr/ecrire/?exec=cfg&cfg=glossaire.
•
la sélection du masque de remplacement : lorsqu'un terme est repéré, vous pouvez choisir
quel masque de remplacement appliquer : faire un lien, une info-bulle ou les deux à la fois ;
•
ne rechercher que la première occurrence du mot : cela permet de réduire le temps
d'exécution du script et d'alléger la charge visuelle de vos pages ;
•
faire la recherche uniquement sur le texte (nécessite simplehtmldom) : cette option est
celle qui aura le plus d'impact sur le temps d'exécution ou sur l'intégrité de votre code HTML.
Appliquer, la recherche sur tout le code HTML permet de réduire significativement le temps
d'exécution du script, surtout si les pages sont longues et riches en balises HTML (c'est
souvent le cas lorsque l'on utilise un éditeur wysiwyg http://fr.wikipedia.org/wiki/Wysiwyg)) et
que le glossaire contient beaucoup de termes. En revanche, effectuer une recherche sur tout
le code HTML peut conduire à la création d'erreurs dans le code HTML (cf exemple 1). C’est
notamment le cas, si certains attributs des balises HTML correspondent à des termes du
glossaire. De plus certains termes composés de plusieurs mots peuvent ne pas être détectés
(cf exemple 2). Le mode de recherche sur le texte évite les problèmes évoqués
précédemment, mais est très consommateur en ressources machines et plus long à exécuter.
En effet, au préalable, le système doit éliminer tout le code HTML et conserver les différents
fragments de texte dans un tableau. Donc, au lieu de réaliser tous ces traitements en une
seule passe, le système est obligé de répéter la séquence de recherche pour chaque
fragment du tableau. Si vous souhaitez utiliser le mode de recherche uniquement sur le texte,
il est vivement conseillé d'activer le cache afin d'éviter de refaire le traitement à chaque fois
qu'un utilisateur souhaite consulter une page déjà calculée.
Exemple 1 : génération d'erreur html (cas de la recherche sur le code HTML complet)
Texte HTML original :
« ...le site du <a href="http://www.glossaire.eaufrance.fr">glossaire</a> propose des définitions... »
Le système peut entrainer l'erreur suivante si « glossaire » est un des termes à rechercher :
Texte HTML générer par le glossaire auto :
« ...le site du <a href="http://www.<em>glossaire</em>.eaufrance.fr"><em>glossaire</em></a>
propose des définitions... »
Dans ce cas, le système a ajouté des balises <em> (emphase) à l'intérieur de l'attribut « href » du lien.
Cela casse au minimum le lien vers la page concernée, et, en fonction du navigateur, cela peut
également entrainer des erreurs d'affichage.
Exemple 2 : des termes du glossaire ne sont pas trouvés (cas de la recherche sur le code HTML
complet)
Texte HTML original :
« <p>Ceci est un <b>paragraphe</b> contenant des balises de <u>mise</u> en forme</p> »
Dans ce cas si le glossaire auto recherche les termes « paragraphe » et « mise en forme », il trouvera
« paragraphe » mais pas « mise en forme » à cause des balises <u>.
•
rendre la recherche insensible à la casse : l’option est conseillée même si le temps
d’exécution s'en trouve légèrement augmenté, mais vos chances de retrouver les termes du
glossaire s'en trouveront fortement augmenté ;
•
l’établissement d'une liste noire de concepts du glossaire à ne pas rechercher : il peut
s’avérer utile, dans certains cas, de retirer certains mots de la recherche du glossaire
automatique tout en souhaitant conserver le concept dans son glossaire. C'est notamment le
cas de certains mots pouvant avoir plusieurs sens (homonymie) ou de sigles pouvant se
trouver couramment dans la langue française. Par exemple :
- système d'information (SI) : il peut être intéressant de mettre « SI » dans la liste
noire pour éviter de marquer tous les « si » se trouvant dans le texte tout en
conservant « système d'information » dans son glossaire.
- valeur : ce concept possède une définition propre dans le glossaire eaufrance, se
rapportant au sens économique du terme, mais le mot « valeur » peut aussi être
utilisé dans certaines expressions telles que « la mise en valeur d'un milieu ». Dans
ce cas, il est nécessaire de supprimer « valeur » de la base de recherche du glossaire
automatique pour éviter un contre sens
4. Présentation du type de contenu Concept SKOS
Le fonctionnement du package repose sur l’utilisation d’un nouveau type de contenu ajouté à SPIP
par le plugin glossaire, définissant les différentes propriétés des concepts du glossaire Eaufrance
selon le standard SKOS.
4.1.
Qu’est-ce qu’un « Concept SKOS » ?
SKOS, ou Simple Knowledge Organisation System (Système simple d'organisation des
connaissances) est une famille de langages formels permettant une représentation standard des
thésaurus, classifications ou de tout autre type de vocabulaire contrôlé et structuré. SKOS est
construit sur la base du langage RDF, et son principal objectif est de permettre la publication facile de
vocabulaires structurés pour leur utilisation dans le cadre du Web sémantique. SKOS est une
recommandation du W3C depuis le 18/08/2009.
Pour aller plus loin sur le SKOS : http://www.w3.org/2004/02/skos/
Un concept est une représentation générale et abstraite d'un objet. Dans SKOS, un concept permet
de designer un mot ou un groupe de mots et son/leur sens (un mot ne permet pas de définir à lui seul
un concept à cause du risque d'homonymie). À chaque concept peuvent être attachés comme
propriétés RDF :
•
•
•
•
au maximum un terme préférentiel par langue ;
des synonymes, avec spécification possible de la langue ;
des définitions et notes, avec spécification possible de la langue ;
des concepts par des relations « générique-spécifique », ou par des relations associatives,
comme pour les termes d'un thésaurus.
4.2.
Pourquoi un nouveau type de contenu?
Depuis la version 2, SPIP permet de créer de nouveaux types de contenu. Cette possibilité permet de
définir des champs et des fonctionnalités propres au nouveau type de contenu, sans avoir besoin de
détourner un type de contenu existant et surtout sans risquer de perturber le fonctionnement d’un site
pré-existant.
La création d’un nouveau type de contenu autorise également la gestion des droits d’accès et simplifie
énormément la création des squelettes.
4.3.
Description des champs
Le glossaire eaufrance est conçu pour gérer les différentes propriétés des concepts et leurs relations
avec les autres concepts selon le standard SKOS. Le but du package n'est pas de recréer toute cette
structuration, mais de fournir aux sites tiers une vue simplifiée des concepts afin de créer leur propre
glossaire. Dans cette première version, le glossaire Eaufrance ne gère pas le multilinguisme.
Chaque entrée du glossaire présente les champs suivants :
•
•
•
•
•
•
•
•
Libellé : libellé préférentiel du concept (obligatoire) ;
Libellé alternatif : synonyme du concept (facultatif) ;
Sigle : sigle du concept - exemple : DCE, Sandre, ONEMA (facultatif) ;
Définition : définition du concept (obligatoire) ;
Illustration : URL des images illustrant le concept (facultatif) ;
Source : source de la définition du concept (facultatif) ;
Lien : libellé + adresse des concepts associés au concept courant (facultatif) ;
Identifiant : adresse de la page ou est décrit le concept sur
http://www.glossaire.eaufrance.fr (obligatoire).
le
site
5. Intégration du glossaire selon la charte Eaufrance
5.1.
Modification du bandeau haut
Pour toutes les pages du site, le lien « glossaire » doit apparaître dans le bandeau haut, dans le coin
supérieur droit (à la droite du lien « contact »). Le libellé est en blanc gras (de même style de police
. Le lien pointe vers la page de l’abécédaire,
que le lien « contact ») et est précédé du pictogramme
présentant par défaut la première lettre du glossaire affichant au moins une définition (le plus souvent
la lettre A).
Figure 10 : Exemple du bandeau charté pour le site www.sandre.eaufrance.fr
Pour un site SPIP, l’adresse URL de cette page est : spip.php?page=glossaire&lettre=A, si au moins
une définition existe pour la lettre A
Pour les sites utilisant des URL normalisées, il est recommandé d’utiliser le format d’URL suivant
:http://www.monsite.eaufrance.fr/glossaire/lettre-du-glossaire. Par exemple, pour la lettre A, l’adresse
URL serait : http://www.monsite.eaufrance.fr/glossaire/A. L’ajout de ce type de lien s’effectue au
niveau de la section « REGLAGES PERSONNALISES » du fichier « .htaccess »2 situé à la racine du
site. Pour rendre ce type d’URL opérationnel sur votre site, sous la ligne : « # Inscrivez ci-dessous vos
reglages supplementaires » du fichier .htaccess, insérez la ligne :
« RewriteRule ^glossaire/([A-Z]{1})$ spip.php?page=glossaire&lettre=$1 [QSA,L] »
5.2.
Style général de la page abécédaire
Le plugin crée une page générique communément appelée « abécédaire ». Cette page présente la
liste des concepts par ordre alphabétique pour la lettre sélectionnée lors du paramétrage. Cette page
est
accessible
en
utilisant
une
adresse
URL
du
type :
http://www.monsite.eaufrance.fr/spip.php?page=glossaire&lettre=A ou, si vous avez configuré
les URL normalisées : http://www.monsite.eaufrance.fr/glossaire/A
Ci-après, sont décrits les points qui doivent être respectés :
2
Par défaut, ce fichier est nommé htaccess.txt, dans le cas vous devez le renommer en .htaccess
Figure 11 : Exemple de page abécédaire charté pour le site www.sandre.eaufrance.fr
•
Le lien « Glossaire » est présent dans le bandeau haut de toutes les pages du site ;
•
Le fil d’Ariane est composé de 3 items : le lien vers l’accueil, puis le lien vers la page glossaire
abécédaire et la lettre consultée par l’utilisateur ;
•
Dans le menu de gauche, la rubrique de niveau 1 « Glossaire » apparaît sur fond bleu en
première position pour toutes les pages de l’abécédaire. Cette rubrique peut éventuellement
apparaître en deuxième position si la rubrique de niveau 1 « Espace perso » est également
activée ;
•
Le titre de niveau 1 de la page est « Glossaire ». Il apparait en police bleu foncé (#3D6098)
gras, et est suivi de l’alphabet en majuscule. Pour ce qui concerne l’alphabet :
•
•
•
•
•
la lettre de la page active est affichée en gras, de couleur blanche et sur fond bleu
foncé ;
les lettres pour lesquelles il existe des concepts sont affichées en gras, de couleur
bleu foncé sur fond blanc ;
les lettres pour lesquelles il n’existe pas de concept sont affichées en bleu foncé, sur
fond blanc, en gras ;
chaque lettre correspond à un lien (vers la page de la lettre concernée) qui n’est pas
souligné par défaut ; le soulignement apparaît au survol.
Les concepts sont affichés sous forme d’une liste. Pour chaque item :
•
•
•
•
le libellé est un lien renvoyant vers la page descriptive du concept. Il est affiché en
bleu foncé gras et n’est pas souligné (le soulignement n’apparaît qu’au survol avec la
souris). Il est suivi du sigle entre parenthèses quand il en existe un ;
10 px plus bas, est affichée la définition du concept ; le texte est justifié ;
10 px plus bas, est affichée la source éventuelle de la définition. Celle-ci est écrite en
caractères plus petits que la définition (font-size : 0.9em) ;
sur la ligne suivante, alignés à droite, sont affichés un pictogramme si la définition
possède une illustration, et un lien « En savoir plus » renvoyant vers la page
descriptive du concept ;
Figure 12 : Cas d'une définition possédant des illustrations
•
Les sigles seuls s’affichent de la même manière que les libellés des concepts, dans la liste. Ils
sont par contre suivis directement d’un lien faisant un renvoi vers la page descriptive du
concept. Ce lien de renvoi est en gris (#aaaaaa), gras, italique et n’est pas souligné ;
•
Dans la colonne de droite, est affiché un bloc présentant le glossaire eaufrance et son mode
de fonctionnement. Le texte de ce bloc est le suivant :
A propos du Glossaire Eaufrance
Techniciens, ingénieurs, scientifiques, services de l'état, élus, ... de nombreux acteurs
produisent et diffusent des informations relatives à l'eau et aux milieux aquatiques, utilisant
des termes spécifiques. Pour faciliter l'échange, améliorer la compréhension des termes et
créer un langage commun pédagogique, un glossaire a été établi par les partenaires du
système d'information sur l'eau (SIE). Son contenu complet est accessible sur le site
Glossaire, mais vous trouverez ici une extraction, correspondant aux termes utilisés dans le
site Gest'eau.
Le glossaire est collaboratif : vous pouvez proposer de modifier ou supprimer certains termes,
d'en ajouter d'autres. Les propositions seront évaluées par un groupe d'utilisateurs,
partenaires du SIE. N'hésitez pas à devenir contributeur, faites vivre le glossaire.
•
En cas d’utilisation du mode de recherche automatique des concepts du glossaire (module
« glossaire_auto »), les mots détectés doivent apparaître en gras, souligné par des pointillés
(utiliser la propriété CSS, border-bottom : 1px dashed #AAAAAA).
5.3.
Style général de la page d’un concept
La page descriptive d’un concept est accessible en utilisant une adresse URL du type :
http://www.monsite.eaufrance.fr/spip.php?page=concept&id_concept=2 ou, si vous avez
configuré les URL normalisées : http://www.monsite.eaufrance.fr/concept/23
Ci-après, sont décrits les points qui doivent être respectés :
3
Ce type d’adressage nécessite l’ajout de la ligne : « RewriteRule ^concept/([0-9]+)$ spip.php?page=concept&id_concept=$1
[QSA,L] » dans le fichier .htaccess, au niveau de la section « REGLAGES PERSONNALISES »
Figure 13 : Exemple d'une page de concept charté pour le site Sandre
•
Le lien « Glossaire » est présent dans le bandeau haut de toutes les pages du site ;
•
Le fil d’Ariane est composé de 4 items : le lien vers l’accueil, puis le lien vers la page glossaire
abécédaire, le lien vers la lettre concernée et le libellé du concept ;
•
Dans la rubrique de gauche, la rubrique de niveau 1 « Glossaire » apparaît sur fond bleu en
première position pour toutes les pages descriptives de concept. Cette rubrique peut
éventuellement apparaître en deuxième position si la rubrique de niveau 1 « espace perso »
est également activée ;
•
Le titre de niveau 1 de la page est le libellé du concept, suivi du sigle entre parenthèses
quand il en existe un. Il apparait en police bleu foncé (#3D6098), gras. La partie centrale de la
page permet d’afficher les champs du concept : l’ordre et l’affichage de ces champs sont ceux
définis par le squelette par défaut ;
•
Dans la colonne de droite, est affiché un bloc présentant le glossaire eaufrance et son mode
de fonctionnement. Le texte de ce bloc est le suivant :
A propos du Glossaire Eaufrance
Techniciens, ingénieurs, scientifiques, services de l'état, élus, ... de nombreux acteurs
produisent et diffusent des informations relatives à l'eau et aux milieux aquatiques, utilisant
des termes spécifiques. Pour faciliter l'échange, améliorer la compréhension des termes et
créer un langage commun pédagogique, un glossaire a été établi par les partenaires du
système d'information sur l'eau (SIE). Son contenu complet est accessible sur le site
Glossaire, mais vous trouverez ici une extraction, correspondant aux termes utilisés dans le
site Gest'eau.
Le glossaire est collaboratif : vous pouvez proposer de modifier ou supprimer certains termes,
d'en ajouter d'autres. Les propositions seront évaluées par un groupe d'utilisateurs,
partenaires du SIE. N'hésitez pas à devenir contributeur, faites vivre le glossaire.
6. Informations supplémentaires pour les développeurs
Le plugin ne nécessite normalement aucune modification des squelettes préexistants pour la fonction
de recherche automatique des concepts du glossaire. La seule condition est la présence, dans les
squelettes du site, la balise « #INSERT_HEAD » : cette balise sert à ajouter toutes les fonctions
JavaScript et CSS de SPIP.
Pour des cas particuliers, le plugin propose deux filtres supplémentaires utilisables sur les textes de
SPIP :
•
|glossaire : pour appliquer le filtre « glossaire automatique » sur un texte selon la
configuration définie dans le site ;
•
|glossaire_light : pour appliquer le filtre « glossaire automatique » sur un texte selon la
configuration définie dans le site mais sans utiliser la librairie simplehtmldom (utile pour les
boucles listant beaucoup de contenus – par exemple, une liste d’articles).
Le filtre s’utilise avec cette expression : [(#BALISE|glossaire)]. Ce filtre peut également utiliser en
paramètre un identifiant de concept qui exclura par exemple celui de la recherche, avec cette
expression : [(#DEFINITION|glossaire{#ID_CONCEPT})]
Ces filtres sont incompatibles avec les filtres |textebrut ; en effet, toutes les balises HTML ajoutées
par le glossaire automatique seront supprimées par ce filtre. Mais :
•
si l’objectif est de récupérer seulement le texte brut (sans bénéficier de l’opération de
recherche automatique des concepts du glossaire), l’écriture est la suivante
:#BALISE*|textebrut au lieu de #BALISE|textebrut . En effet, sous SPIP, l’usage du
caractère « * » permet de désactiver les traitements typographiques qui seraient réalisés
automatiquement ;
•
si l’objectif est d’utiliser le filtre |textebrut puis d‘appliquer le filtre |glossaire, l’écriture est la
suivante : #BALISE|textebrut|glossaire
Le plugin crée également deux nouveaux types de contenu (objets éditoriaux) :
•
CONCEPTS : décrivant les concepts du glossaire ;
•
FLUX : décrit les flux de syndication pour l’import des concepts.
Comme tout objet éditorial, ces deux nouveaux objets sont utilisables dans les boucles et leurs
champs peuvent être utilisés comme filtres ou sous forme de balises.
Exemple :
<BOUCLE_glossaire(CONCEPTS){par preflabel}>
<dl>
<dt><a
href="#URL_SITE_SPIP/spip.php?page=concept&id_concept=#ID_CONCEPT">[(#PREFLABEL|gloss
aire)][ ((#SIGLE))]</a></dt>
<dd>
[<div class="definition">(#DEFINITION*|glossaire_light)</div>]
[<div class="source"><em class="sourceLabel">Source :</em><span
class="source">(#SOURCE)</span></div>]
</dd>
</dl>
</BOUCLE_glossaire>
Enfin, le plugin propose quelques balises supplémentaires :
•
#MINI_GLOSSAIRE : cette balise insert la description des concepts utilisables pour
l’affichage des infobulles ;
•
#GLOSSAIRE_LETTRES : cette balise insert un alphabet avec les liens vers le glossaire.
•
GLOSSAIRE
Terme : Mot, groupe de mots, expression.
Concept : Représentation générale et potentiellement abstraite d'un objet. Par exemple, dans SKOS
un concept permet de designer à la fois un terme et son sens (le libellé ne permet pas de définir à lui
seul un concept à cause du risque d'homonymie).
Mot : Son, groupe de sons ou de lettres formant une unité de sens.
Objet éditorial : Un objet éditorial correspond à un des types de contenu gérés par SPIP. Chacun
d’entre eux possède des attributs, des méthodes, des droits et des relations inter-objets qui leurs sont
propres. De base SPIP propose les objets suivants : articles, rubriques, brèves, mots, documents,
sites, auteurs, syndic_article, forums. Depuis la version 2, il est possible de créer de nouveaux objets
éditoriaux par l’ajout de plugin.
Syndication de contenu web : Forme de syndication dans laquelle une partie d'un site est
accessible depuis d'autres sites. Cela est possible en y ajoutant une licence accordée à ses
utilisateurs. Bien souvent, la syndication consiste à mettre à disposition un flux RSS avec l’en-tête du
contenu récemment ajouté au site web (par exemple, la dernière news ou le dernier post du forum).
Source : http://fr.wikipedia.org/wiki/Syndication_de_contenu
•
SIGLES & ABREVIATIONS
API : Application Programming Interface
HTML : Hypertext Markup Language
RDF : Resource Description Framework
RSS : Really Simple Syndication
SIE : Système d’Information sur l’Eau
SKOS : Simple Knowledge Organisation System
W3C : World Wide Web Consortium
•
TABLE DES ILLUSTRATIONS
Figure 1 : Page d’accueil du site www.glossaire.eaufrance.fr................................................................. 5
Figure 2 : Capture d'écran de la page "glossaire"................................................................................... 6
Figure 3 : Capture d'écran de la page de configuration des flux de syndication .................................... 6
Figure 4 : Exemple de fonctionnement du glossaire automatique .......................................................... 6
Figure 5 : Page de téléchargement du package glossaire...................................................................... 8
Figure 6 : Page d'activation des plugins SPIP ........................................................................................ 9
Figure 7 : Liens d'administration créer par le plugin glossaire ................................................................ 9
Figure 8 : Interface de configuration des flux de syndication ................................................................ 10
Figure 9 : Formulaire de configuration d'un flux de syndication............................................................ 11
Figure 10 : Exemple du bandeau charté pour le site www.sandre.eaufrance.fr ................................... 15
Figure 11 : Exemple de page abécédaire charté pour le site www.sandre.eaufrance.fr ...................... 16
Figure 12 : Cas d'une définition possédant des illustrations ................................................................. 17
Figure 13 : Exemple d'une page de concept charté pour le site Sandre .............................................. 18
•
LISTE DES TABLEAUX
Tableau 1 : Exemples de résultat en fonction du mode de recherche sur un texte de référence........ 12