GLOSSAIRE - Mode d'emploi

Bienvenue sur ce mode d'emploi du plugin Glossaire_XH pour CMSimple_XH.

Plugin GLOSSAIRE

I - Description

GLOSSAIRE permet d'afficher une définition au survol de certains mots dans vos articles. Cette définition peut être titrée et illustrée.

Après avoir validé une première fois la configuration pour le template utilisé, il suffit de se rendre dans l'admin et d'enregistrer un premier mot ainsi que sa définition.

Lors de la lecture d'un de vos articles, si ce mot est présent dans le texte, il permettra d'afficher la définition au survol du pointeur de la souris, comme le ferait une info-bulle.

II - Langues

Le plugin peut fonctionner dans toutes les langues supportées par CMSimple_XH,

son détecteur de pluriels (permets aux mots créés d'être reconnus lorsqu'ils sont au pluriel dans l'article) supporte actuellement les langues suivantes : Da, De, Fr, It, Ru.

Danois : Créer le mot dans sa forme indéfinie. Dès lors, le détecteur de pluriel trouvera la version définie ainsi que les pluriels associés. Exemple pour une voiture = bil, les mots bilen, biler, bilerne seront également détectés.

Slovaque et Tchèque : Créer le mot dans sa forme nominative (basique). Le détecteur essaiera de trouver les autres formes (génitive, dative, accusative, vocative, locative, instrumentale) et leurs pluriels.
Seuls les noms sont concernés et tous les cas ne sont pas prévus.

L'administration est disponible dans les langues suivantes (par défaut en anglais) :

Pour que le glossaire puisse fonctionner dans une langue, il faut deux conditions :

Si vous souhaitez utiliser ce plugin dans une autre langue que celles déjà proposées, contactez-moi. N'hésitez pas à me proposer une traduction.

2.1 - Utilisation sur un site multilingue

Le plugin Glossaire respecte la philosophie de CMSimple_XH. L'interface du plugin s'affiche dans la langue en cours d'utilisation (selon les langues supportées par le plugin, sinon en anglais) et les mots et définitions créés sont placés dans un dossier spécifique du dossier data du plugin. Si votre site comporte par exemple deux langues, anglais et allemand, les mots créés en anglais ainsi que leurs définitions se trouvent donc placés dans data/en/ du plugin. Pour l'allemand, ce sera data/de/.

III - Installation

Uploadez le contenu du zip à la racine de votre site (même niveau que le dossier plugins/).

Faites attention aux limitations de votre hébergeur. chez OVH, par exemple,  les dossiers doivent avoir un chmod = 705 et les fichiers, 604 (le plus permissif pour les fichiers et les scripts étant 755). 

Vérifiez cela à l'aide de votre logiciel FTP (Filezilla par exemple) avec lequel vous pouvez ajuster les chmod.

Exemple OVH avec Filezilla
Parcourez le site distant, dossier plugins/ et faites un clic droit sur le dossier glossaire.
Cliquez sur "Droits d'accès au fichier" en bas du menu contextuel.
Entrez pour valeur numérique : 705
Cochez "Récursion dans les sous-dossiers"
Cochez "Appliquer uniquement aux dossiers".
Validez.

Pour utiliser le plugin, il suffit de valider une première fois la configuration (page Configuration) pour le template utilisé. Le fichier template.htm de votre template sera modifié en y ajoutant init_Glossaire(). Une copie du fichier original est également réalisée (template.htm.bak).

Selon les limitations de votre hébergeur, l'opération peut ne pas être possible; Dans ce cas un message vous invitera à réaliser l'ajout manuellement en éditant le fichier template.htm de votre template. Il suffit d'ajouter le code suivant en amont de l'echo de content() :

<?php init_Glossaire(); ?>

Pour des raisons de commodité d'automatisation du processus, le plugin place ce code juste après la balise de fin </head>.

Il est possible de désactiver le plugin pour le template choisi sur la page Configuration. Lorsqu'il est actif, une case à cocher est proposée pour la désactivation.

3.1 - Mises à jour

GLOSSAIRE est compatible avec le plugin updatecheck (de Holger Irmler) qui permet d'indiquer au webmaster si des mises à jour sont disponibles pour les plugins installés sur son site ou pour le CMS lui-même.

IV - Configuration

Cette page vous permet pour chaque template de :

Vous remarquerez la possibilité de choisir un template autre que celui par défaut. Dans ce cas, la page est rechargée avec le template sélectionné, vous permettant ainsi de comparer plus facilement avec l'aperçu de la définition situé à droite du formulaire (cet aperçu reprend directement les réglages effectués dans la partie ASPECT de la configuration). Une fois le formulaire validé, le template reste sélectionné et affiché à moins d'en choisir un autre ou de changer de page.

Important : Tant que la configuration pour un template n'a pas été validée, le Glossaire ne fonctionne pas pour vos visiteurs.

Conseil : Faites plutôt des définitions courtes, quelque soit le domaine concerné.

V - Mots et Définitions

Cette page vous permet de gérer la liste des mots et les définitions qui s'y rapportent.

5.1 - La liste des mots

Elle affiche les mots existants, permet d'accéder à leur édition ou à la création d'un mot et sa définition, elle permet aussi de supprimer simplement un mot et sa définition.

5.1.1 - Le filtre

Se présente sous la forme d'une liste alphabétique.
Si vous cliquez sur une lettre du filtre, le tableau sera filtré selon cette lettre et classé dans l'ordre alphabétique selon la colonne Mots.

5.1.2 - Le tri

Chaque titre de colonne du tableau (Id, Mots) comporte un lien de tri. Vous pouvez ainsi trier le tableau selon la colonne de votre choix, son titre sera alors souligné. (tri ordre alphabétique mais les abréviations seront placées en premier). Les dimensions du tableau sont fixes. Lorsque le nombre de mots sera suffisant au point de dépasser la hauteur du tableau, vous pourrez parcourir les lignes de la liste avec la molette de votre souris ou en utilisant le petit ascenseur placé à droite. L'utilisation du filtre permettra alors de réduire le nombre de lignes affichées.

5.1.3 - La liste

La liste comporte une colonne d'id, et une affichant les mots. Il suffit de cliquer sur un mot de la ligne pour accéder à la page d'édition  (même formulaire que pour la création). Une case à cocher située en bout de chaque ligne permet de sélectionner un ou plusieurs mots pendant qu'un bouton "Supprimer" apparaît en bas du tableau, accompagné d'une indication du nombre de sélections effectuées. La suppression d'un mot entraîne la suppression de sa définition et est définitive.

5.2 - Création

En bas de la liste, cliquez sur "Créer un mot".

Vous voici sur la page "MOT et DÉFINITION" où vous allez renseigner le mot, le titre de la définition et la définition elle-même.

Concernant le titre, cela correspond à la zone titre de la définition affichée. Pour ne pas avoir de zone titre, il suffit de laisser le champ vide.

L'Id affiché en haut est là pour indication. C'est le numéro identifiant le mot et sa définition, il n'est pas modifiable. 

Dans les champs MOT et TITRE, ne mettez pas de code HTML ou autre. Renseignez ces champs directement avec votre clavier sans passer par un copier/coller par exemple. Ceci a son importance notamment pour les accents. 

Note : La recherche qui sera effectuée dans l'article n'est pas "case sensitive". Néanmoins, pour les abréviations (exemple A.B.C.D. ou ABCD) et uniquement dans ce cas, la recherche ne se fera QUE sur les majuscules (a.b.c.d. ne sera pas trouvé ni abcd)

DÉFINITION : L'éditeur (selon le choix effectué dans l'admin de CMSimple_XH) vous permet de créer la définition. Vous pouvez placer une image (attention, la définition qui sera affichée n'est pas très large, il faut donc utiliser une image de petite taille sinon celle-ci sera tronquée).

Les couleurs (titres et textes et leurs arrière-plans), la fonte, les couleurs des bordures, sont configurables dans "Configuration". 

En bas, juste avant le bouton de validation, une case à cocher permet d'élargir l'affichage de la définition. Une autre option permet de figer la définition dès son survol. Cela peut être utile si son texte comporte plusieurs liens, par exemple. Un bouton de fermeture est alors ajouté dans son angle supérieur droit (Elle se fermera également si un autre mot défini est survolé). Sans cocher cette option, la définition se ferme dès que le curseur n'est plus au-dessus.

Une fois le formulaire renseigné, cliquez sur "Enregistrer", tout en bas.

Vous voici revenu à la liste des mots où figure à présent celui que vous venez de créer.

5.3 - Son et vidéo

Tout d'abord, il faut avoir à l'esprit que si un mot défini se trouve dans l'article affiché, sa définition se trouve forcément dans le flux de la page (en fin d'article). Elle n'est bien sûr visible que si le mot en question est survolé mais elle est bien présente. Dans le cas où vous souhaitez insérer un lecteur audio ou vidéo, les problèmes suivants se poseront :

Le script du glossaire peut commander un lecteur à condition que ce dernier soit contrôlable en javascript. Il appelle automatiquement deux fonctions, une de passage en lecture lorsque la définition s'affiche, une autre de stop lorsque la définition est fermée. Il vous faudra créer un fichier javascript que vous nommerez fonct_util.js et que vous placerez dans le dossier js du plugin (plugins/glossaire/js/). Il devra contenir les fonctions suivantes qui devront être adaptées au lecteur utilisé :

Pour la lecture : demLect(id)
Pour stopper : stopLect(id)

id représente l'id de la balise object du lecteur. Il faudra ajouter un id à la balise object de votre lecteur sous la forme suivante : vidgpop + le numéro d'id du mot auquel se rapporte la définition (l'id se trouve en haut du formulaire de création/édition du mot concerné)

Par exemple, pour la définition du mot id n°35, on aura <object id="vidgpop35"...

5.3.1 - Exemple concret

VI - A l'impression

Lors de l'impression d'un article, chaque mot défini demeure souligné et muni d'un lien vers sa définition placée en fin d'article (le soulignement n'apparaîtra pas forcément lors de la prévisualisation, dépendant du css de votre site). Les définitions ainsi cumulées sont précédées d'un titre "Glossaire". Si l'impression s'effectue vers un format pdf,  les liens demeurent actifs et pointent vers chaque définition concernée (ancre).

Note : Un article inclut aussi le glossaire de ses mots définis, lors de son impression. Le nombre de feuilles imprimées dépendra donc de la longueur de l'article mais aussi de celle de ses définitions. L'intérêt de faire des définitions courtes prend ici tout son sens.

Les définitions sont néanmoins affichées sur deux colonnes et dans une taille de caractère réduite.

VII - Désinstallation

Dans l'administration du plugin, page Configuration, désactivez le plugin pour chaque template de la liste.
Cela revient à supprimer init_Glossaire() dans le fichier template.htm de chaque template.

Puis supprimez tous les fichiers du plugin, cela revient à supprimer le dossier "glossaire":   plugins/glossaire/

VIII - Téléchargement

Vous pouvez télécharger Glossaire_XH pour CMSimple_XH ici.

IX - Licence

Glossaire_XH est sous licence GPLv3.

© 2016 Ludovic AMATHIEU

TOP