Un glossaire interne

Ceci est une ARCHIVE, peut-être périmée. Vérifiez bien les compatibilités !

Fonctionnalité désormais intégrée au Couteau Suisse : disponible pour tout SPIP !
Votre site utilise un vocabulaire technique spécialisé, vous avez une tendance maladive à jargonner sans vous en rendre compte, voici une solution pour que votre prose reste néanmoins accessible au commun des mortels.

Quelques mots d’introduction

Ce glossaire présente les caractéristiques suivantes :

-  Il est interne. Ce glossaire ne fait pas appel à des ressources extérieures. Il exploite un glossaire interne au site (que nous allons créer en utilisant des brèves dans une rubrique dédiée). Il est donc typiquement dédié à des sites très spécialisés, dont le centre d’intérêt fait appel à un vocabulaire très spécifique. Par exemple, si vous créez un site parlant d’architecture antique, vous pourrez définir les mots métope, triglyphe ou architrave si vous craignez que vos visiteurs ignorent ce dont il s’agit.

-  Il est automatique. Contrairement au raccourci typographique existant actuellement dans SPIP qui renvoie vers Wikipedia (dont on apprécie ou non la qualité des articles ; perso : bof), qui demande une intervention humaine chaque fois qu’on veut créer un lien, le principe du présent script est d’automatiser le référencement. Concrètement, il prendra la forme d’un filtre (à ajouter dans mes_fonctions.php3) à appliquer sur chaque partie de texte où l’on souhaite voir se créer des liens vers le glossaire. Le filtre va parser le texte, y reconnaître les occurences des mots qu’il « connaît ».

Créer les données

Le contenu en lui-même du glossaire sera « physiquement » situé dans une rubrique, que nous appellerons, fort originallement, glossaire. Chaque entrée de notre petit dictionnaire prendra la forme d’une brève, le titre étant le mot lui-même (seul : sans article, pluriel particulier ou autres informations) ; le texte de la brève étant la définition du mot.

Le filtre

Et voici le code de la fonction

<?php

/*
 *   +----------------------------------+
 *    Nom du Filtre : Glossaire interne                                               
 *   +----------------------------------+
 *    Date : jeudi 11 septembre 2003
 *    Auteur :  François Schreuer <francois (sur) schreuer (point) org>
 *   +-------------------------------------+
 *    Fonctions de ce filtre :
 *    Gestion des liens vers un glossaire interne à un site
 *   +-------------------------------------+ 
 *  
 * Pour toute suggestion, remarque, proposition d'ajout
 * reportez-vous au forum de l'article :
 * http://www.spip-contrib.net/article241.html
*/

# Remplace seulement la première occurence. Mêmes arguments que str_replace
# Cette fonction est inspirée d'une fonction trouvée à l'adresse http://www.phpapps.org/index.php?action=sources&go=voir_source&id=174 (qui toutefois contenait un bug lorsque la chaîne recherchée ne se trouvait pas dans le texte
function first_replace($c,$r,$t)
{
	if(strstr($t,$c))
	{
		$d = str_replace(strstr($t,$c),"",$t);
		$f = strstr($t,$c);
		$f = substr($f,strlen($c));
		return $d . $r . $f;
	}
	else
		return $t;
}

# Crée des liens vers le glossaire
function lier_au_glossaire($texte)
{
	# Config
	# L'identifiant (id_rubrique) de la rubrique glossaire
	$id_rubrique = 2;
	# Limiter l'effet du filtre à la première occurence
	$eviter_doublons = 1; // 0 : afficher toutes les occurences

	# On checke si l'entrée est déjà présente dans la table
	# Mettre l'identifiant de la rubrique contenant le glos
	$r = spip_query("SELECT id_breve,titre FROM spip_breves WHERE statut='publie' AND id_rubrique='$id_rubrique'");

	while($o = spip_fetch_array($r))
	{
		if($eviter_doublons == 1)
		{
			$texte = first_replace("$o[titre]","<a href=\"breve.php3?id_breve=".$o[id_breve]."\" class=\"glossaire\">$o[titre]</a>",$texte);
		}
		else
		{
			$texte = str_replace("$o[titre]","<a href=\"breve.php3?id_breve=".$o[id_breve]."\" class=\"glossaire\">$o[titre]</a>",$texte);
		}
	}
	return $texte;
}

?>

N’oubliez pas de configurer le script :

-  en choisissant de remplacer toutes les occurences du mot (en attribuant la valeur 0 à la variable $eviter_doublons) ou uniquement la première (valeur 1). La fonction first_replace, donnée ici, est nécessaire si vous ne souhaitez afficher que la première occurence. Notez que ce option évitant les doublons ne fonctionne qu’au sein d’un seul champ : si plusieurs champs sur une même page utilisent le filtre, il est possible qu’un même mot soit lié au glossaire plusieurs fois.

-  en précisant l’id_rubrique de la rubrique contenant le glossaire ;

-  en configurant correctement l’URL. Si vous utilisez les réécritures Apache (rewrite rules), remplacez l’expression breve.php3?id_breve=".$o[id_breve]." par breve".$o[id_breve].".html

-  en configurant le CSS (ici, j’ai nommé la classe définissant les liens .glossaire mais vous pouvez évidemment changer tout cela).

Appeler la fonction

La fonction s’appelle comme tout autre filtre de SPIP. Par exemple :

[(#TEXTE|lier_au_glossaire)]

Pour ceux qui veulent voir à quoi ça ressemble, un exemple présentant l’utilisation de quelques entrées du glossaire est visible sur http://tchouktchouk.eu.org/article128.html (il s’agit d’un site qui parle de trains).

Quelques mots encore

-  Ce filtre requiert pas mal de capacité de calcul de la part du serveur, il est donc fortement conseillé de procéder à quelques tests avant de l’utiliser sur votre site. Quoi qu’il en soit, l’utiliser avec parcimonie et/ou dans des squelettes dont la durée de conservation dans le cache est longue.

-  Pour que les pages ne deviennent pas illisibles sous la profusion de liens, il me semble préférable, dans la mise en page, d’opter pour un mode d’affichage discret : en ce qui me concerne, j’utilise des liens non soulignés de la même couleur que le texte. Ils ne deviennent visibles qu’au passage de la souris.

-  On utilise ici des brèves pour stocker les entrées du glossaire : on pourrait aussi réserver un groupe de mots-clés à cet usage. Ca ne change pas grand-chose. A vous de voir la manière dont vous préférer opérer.

Pour la suite

Pour ceux qui auraient envie de poursuivre le travail entamé ici, voici quelques idées :

-  Il faudrait réfléchir à la question des formes modifiées des mots du glossaire (conjugaisons d’un verbe, pluriel d’un nom), qui ne sont pas reconnues actuellement. Il en va de même pour les mots qui acceptent indifférement plusieurs orthographes et autres problèmes du même accabit (on ne parle même pas ici du multilinguisme).

-  Il serait intéressant d’écrire une option permettant l’affichage des définitions en javascript : au passage de la souris sur une occurence d’un mot connu, une petite boîte contenant la description du mot s’afficherait.

-  Enfin, il serait utile d’interfacer cette fonction avec inc-urls-dist.php3 pour faire en sorte que l’écriture des URL se fasse correctement (en mode « standard » ou en mode « html ») sans qu’une intervention soit nécessaire dans le code.

Voir l’intégration dans le Le Couteau Suisse : Un glossaire interne pour vos sites !

Discussion

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

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