Ce glossaire est une petite librairie interactive à intégrer sur votre site, qui va immédiatement identifier les sigles connus dans votre site et leur associer une définition. Par exemple :
Exemple : le siège de la DINUM est situé dans le 7e arrondissement de Paris, ainsi que la CADA. Mais ce n'est pas le cas du MESRI.
La donnée est issue du travail mené par Colin Maudry sur Dicosigles.
Vous pouvez retrouver le jeu de donnée complet sur data.gouv.fr
Au chargement de la page, la librairie Glossaire est chargée et
elle parcourt le document à la recherche de sigles. L'algorithme ne
regarde que le contenu des balises html <p>,
<li> et <tr>.
Lors de son parcours de la page, l'algorithme exclut spécifiquement les
liens <a> pour ne pas polluer la page.
Vous pouvez tester le prototype en ajoutant cette ligne dans le <head> de votre page web :
Vous pouvez paramétrer la librairie en ajoutant la ligne suivante dans le <body> de votre page web :
data-exclude-sigles : exclure un ou plusieurs sigles non pertinents (par exemple : Allocation de Parent Isolé (API) n'est pas pertinent sur api.gouv.fr.
data-parse-classes : forcer l'execution du script sur une ou plusieurs classe de votre document (utile pour faire passer le script sur d'autres éléments que <p>, <li> et <tr>).
⚠️ Danger Zone ☢️
N'activez cette dernière feature que si vous êtes certain de bien en
comprendre les implications.
data-dynamic-repaint : forcer l'execution du script à chaque modification de la page. Indispensable pour les Single Page applications (React, Angular et Vue). Vide par défault, c'est a dire que de base le script ne s'execute qu'une seule fois après le rendu de la page.
Dur à dire. L'ensemble de la lib pèse tout de même 100ko car elle inclut l'ensemble des sigles du dataset dicosigles (1mo de données sous format CSV !).
Aujourd'hui il y a deux goulots d'étranglement :
Toutes les idées d'améliorations sont les bienvenues ! 👇
Vous pouvez accèder au code source sur Github.