SqLinguae est un visualiseur de dictionnaires en ligne.
SqLinguae n'intégre par lui-même aucun dictionnaire, ceux-ci doivent lui être secondairement adjoints. SqLinguae présente la particularité d'utiliser des dictionnaires au format Sqlite qui sont construits par le logiciel libre Linguae (logiciel hors-ligne) à partir de dictionnaires-sources en de multiples formats. Ceci facilite beaucoup la réalisation et la mise en ligne de dictonnaires pour le Web.
SqLinguae est un script PHP, mais est utilisable sans aucune connaissance du langage PHP.
SqLinguae est librement utilisable et téléchargeable sur le site http://linguae.stalikez.info
SOMMAIRE :
Prérequis pour utiliser ce script
Contraintes
Installation et lancement du script
Options et Paramétrages
Adaptation au serveur
Parcours ou Recherche dans les dictionnaires
Utiliser plusieurs dictionnaires
Confidentialité des fichiers-dictionnaires
Statistiques de consultation des dictionnaires
Sécurité du script
Compatibilité XHTML
Personnaliser le script
Ajout de greffons
Licence du script
Contact
Ce script peut être utilisé sur un site Web de deux façons :
Ces deux modes ne sont en rien exclusifs l'un de l'autre sur un même site. D'ailleurs, si vous installez le script en mode inclus, il restera toujours utilisable en mode autonome sans que vous ayez quoi que ce soit à faire de plus pour cela (il suffit de taper l'url du script dans le navigateur).
Tous les paramètres du script sont placés dans le fichier de configuration "config.php" :
.../sqlinguae/lib/stat/config.phLangue par défaut de l'interface
Liste des langues d'interface
Nombre de caractères maximum admis dans le champ de recherche
Nombre maximum de résultats de recherche à retourner
Enregistrement des statistiques de consultation des dictionnaires
Mot de passe d'accès aux statistiques
Extension des fichiers PHP5
Option de surlignage du mot recherché
Option d'affichage du choix du domaine de recherche
Option d'affichage du sélecteur de jeu de caractères spéciaux
Liste des jeux de caractères spéciaux à présenter au visiteur
Paramètre : 'def_lang' Valeurs : fr, en, ou autres valeurs en fonction des fichiers de langue disponibles
Langue utilisée par défautpour l'interface du script et les messages retournés par celui-ci. Ce paramètre n'a rien à voir avec la langue des dicos !
Seul le français et l'anglais sont actuellement fournis avec le script. Pour ajouter d'autres langues d'interface, traduisez l'un des fichiers présents dans le dossier .../sqlinguae/lib/lang
La valeur du paramètre doit correspondre au radical du fichier de langue à utiliser.
Toutes les nouvelles traductions sont les bienvenues !
Paramètre : 'ic_lang' Valeurs : fr, en, ou autres valeurs en fonction des fichiers de langue disponibles
Liste des langues d'interface (et non des dicos !) que vous désirez présenter au visiteur par une petite icône (petit drapeau). Une icône s'affichera pour chaque langue en bas du visualiseur.
Pour masquer un langage au visiteur, ajoutez "//" devant son nom ou supprimez-le de la liste.
Nb : si cette liste ne contient qu'un seul élément actif, l'îcone restante sera masquée et la langue par défaut sera appliquée, quelque soit l'élément restant.
Paramètre : 'char_max' Valeurs : nombre quelconque supérieur à zéro
Limite le nombre de caractères des cases "Rechercher" et "Aller à".
Adaptez ce nombre aux caractéristiques des dictionnaires utilisés mais ne choisissez pas une valeur trop élevée, afin de diminuer l'encombrement de la base des statistiques avec du texte issu de robots spammeurs.
Paramètre : 'res_max' Valeurs : toute valeur numérique entière supérieure à 0
Un nombre modéré soulage le travail du serveur et évite des pages interminables à charger.
Un nombre modéré ou bas peut aussi constituer une protection contre le pillage des données des dictionnaires par copier-coller, dans le cas où vous désireriez l'éviter.
Quand le nombre de résultats trouvés excède le nombre de résultats retournés, le nombre total est affiché en sus du nombre retourné ce qui incite l'utilisateur à affiner sa recherche pour restreindre le nombre de résultats.
Paramètre : 'record_stat' Valeurs : 0 : ne pas enregistrer
2 : enregistrer uniquement les "Rechercher"
4 : enregister uniquement les "Allez à"
6 : enregistrer les "Rechercher" ET les "Allez à"
Si cette option est validée, des données anonymes sont enregistrées dans le fichier de statistiques du dictionnaire concerné.
(voir aussi : Statistiques de consultation des dictionnaires)
Paramètre : 'stat_psw' Valeurs : chaîne alphanumérique quelconque
(voir aussi : Statistiques de consultation des dictionnaires)
Paramètre : 'ext' Valeurs : dépendante de la configuration du serveur
Tous les fichiers du script qui nécessitent PHP5+ possèdent par défaut l'extension ".php5", les autres fichiers php ont l'extension ".php".
Si le paramétrage de votre serveur nécessite de modifier cette extension, il ne suffit pas de modifier l'extension des fichiers, il faut aussi modifier ce paramètre afin de ne pas briser les références à ces fichiers dans le code du script.
Paramètre : 'expl_nbl' Valeurs : toute valeur numérique entière supérieure à 0
Ce paramètre détermine le nombre de ligne et donc la heuteur de l'explorateur de dictionnaire (accessible par l'icône "Parcourir le dictionnaire") mais aussi celle de la zone d'affichage des données du mot sélectionné, cette dernière s'adaptant automatiquement à la première.
Paramètre : 'expl_width' Valeurs : (en pixels) toute valeur numérique entière supérieure à 0
Si la longueur d'une entrée est supérieure à la longueur définie ici, la partie excédentaire de cette entrée sera masquée. En conséquence, choisissez une longueur qui soit un compromis entre la longueur moyenne des entrées de vos dictionnaires et la place disponible dans la page.
Paramètre : 'start_dic' Valeurs : [+]nom_de_fichier
Si ce champ mentionne un nom de fichier-dictionnaire valide, ce dictionnaire sera présélectionné dans la liste déroulante des dicos au lancement du script.
Ce dictionnaire peut aussi être automatiquement ouvert en mode "explorateur de dictionnaire". Pour cela, ajouter "+" (le signe "plus") devant le nom du fichier, sinon le script se lancera en mode "recherche seule". Si Javascript est désactivé sur le navigateur du visiteur, ce symbole sera sans effet et le dictionnaire sera seulement présélectionné.
Paramètre : 'hilight' Valeurs : 0 ou 1 (1 pour surligner, 0 pour ne pas surligner)
Si cette option est validée, le motif recherché est surligné ou colorisé dans les résultats affichés (entrées et notices).
Paramètre : 'lst_dom' Valeurs : 0 ou 1 (1 pour afficher, 0 pour masquer)
Si cette option est validée, une liste déroulante de choix du domaine du domaine de recherche (recherche dans les entrées ou recherche dans les notices) est affichée.
L'affichage de cette liste est superflu dans le cas de l'utilisation de ce script pour des dicos aux notices courtes, des glossaires etc. Si cette liste est masquée, la recherche est effectuée dans les seules entrées.
Paramètre : 'lst_char' Valeurs : 0 ou 1 (1 pour afficher, 0 pour masquer)
Si cette option est validée, une liste déroulante de choix d'un jeu de caractères spéciaux est affichée. Le jeu de carctères sélectionné est affiché sous forme d'un ensemble de touches à cliquer, le clic copie le caractère choisi dans la case de saisie du texte.
L'utilité d'afficher cet accessoire dépend du type des dico consultables et du type de clavier utiisé par vos visiteurs.
Cette liste de jeux constitue le contenu de la liste déroulante dont l'affichage est contrôlé par l'option "lst_char"
Pour masquer un jeu de carctères, ajoutez "//" devant son nom.
PHP5 ou supérieur doit être disponible sur votre serveur, ou celui de votre hébergeur, ainsi que son extension sqlite et PDO (Php Database Object). Dans le cas contraire, le script affichera un message d'avertissement et stoppera.
Parmi les fichiers de ce script, tous ceux qui nécessitent PHP5+ portent l'extension *.php5, ils devront peut-être être modifiés en *.php, suivant la configuration de votre serveur. (voir : Paramétrages)
Elle s'effectue en sélectionnant un dictionnaire dans la liste déroulante, en tapant le motif recherché (le mot ou le début du mot) dans la case de saisie puis en cliquant sur le bouton "Rechercher" (flèche).
Pour afficher l'Explorateur de dictionnaire, sélectionnez un dictionnaire dans la liste déroulante et cliquez sur l'icône "Parcourir le dictionnaire" à droite de cette liste.
L'explorateur permet de naviguer dans la liste des entrées classées par ordre alphabétique et d'afficher les notices correspondantes. L'explorateur est doté d'une barre de navigation qui permet de se déplacer dans le dictionnaire et d'une case "Aller à" dans laquelle il suffit de taper un début de mot et de cliquer sur la flèche pour se déplacer au premier mot correspondant (s'il existe...).
Il est possible de faire s'afficher automatiquement cet explorateur en choisissant un "dictionnaire initial" (voir : paramétrages).
Attention, la navigation dans cet explorateur utilise Ajax et nécessite donc que Javascript soit activé sur le navigateur du visiteur, dans le cas contraire il reste invisible, ainsi que son icône d'appel.
Si plusieurs dictionnaires sont présents dans le dossier "dic", le simple affichage du nom du dico unique est automatiquement remplacé par une liste déroulante de choix du dictionnaire.
Le visualiseur peut contenir un nombre illimité de dictionnaires mais la recherche n'a lieu que dans le seul dictionnaire sélectionné dans la liste déroulante.
C'est le comportement par défaut.
Le script scanne automatiquement le contenu du dossier "dic" et remplit la liste déroulante des dicos disponibles avec tous les dicos qu'il trouve et dans l'ordre où il les trouve.
Les noms conviviaux des dicos sont automatiquement extraits des fichiers-dicos et affichés dans la liste déroulante. Quand un dico ne contient aucun nom convivial (celui-ci est stocké dans le champ 'dicName' de la table 'Properties'), son nom de fichier est utilisé en supprimant son extension.
Pour modifier ce comportement d'affichage et personnaliser le texte affiché dans la liste des dictionnaires, ou regrouper des dictionnaires par thème, il faut rédiger un index des dicos (voir plus bas).
Il est possible d'utiliser un fichier d'indexation des dicos. Ce fichier est facultatif.
Ce fichier d'indexation s'appelle obligatoirement "dic_idx.php" et il doit être placé dans le dossier "dic".
Pour désactiver ce fichier, ajoutez un "." initial à son nom (.dic_idx.php) ou supprimez-le. Le comportement par défaut (liste automatique) est alors rétabli.
Si ce fichier est présent et actif, son contenu sera utilisé, quel que soit le contenu réel du dossier "dic", c'est-à-dire que des dicos présents dans le dossier "dic" mais absents de l'index seront ignorés.
Ce fichier permet de personnaliser le texte affiché dans la liste déroulante et de regrouper les dicos par groupes thématiques (à conseiller si la liste en est longue !). A noter qu'un même dictionnaire peut être indexé plusieurs fois dans des groupes différents.
Utilisez le fichier "dic_idx.php" fourni comme modèle et modifiez-le en utilisant la syntaxe suivante :
Elle dépend de ce que vous désirez :
C'est la configuration par défaut.
Pour empêcher que le visiteur puisse télécharger les fichiers-dictionnaires en utilisant leur url (http://xxxxx.xxx/sqlinguae/dic/monDico.sqlite), un fichier '.htaccess' de verrouillage est placé par défaut dans le dossier des dicos (cette protection totale ne fonctionne que sur les serveurs de type Apache, qui sont de loin les plus fréquents sur le Web).
Si, par contre, vous désirez que les fichiers des dictionnaires soient librement téléchargeables par vos visiteurs, supprimez ce fichier '.htaccess' du dossier 'sqlinguae/dic/', après vous être assuré que la licence des dictionnaires autorise leur libre téléchargement.
Le nom du fichier-dictionnaire avec un lien de téléchargement direct de celui-ci apparaîtra alors dans les propriétés de chaque dictionnaire.
Si vous désirez que certains dictionnaires soient téléchargeables et d'autres non, par exemple pour des raisons de licence, renseignez les champs 'protec1' et 'protec2' de la table "Properties" du fichier du dictionnaire (pour cela utilisez Linguae ou un éditeur de base sqlite). Ecrivez-y n'importe quoi car il suffit que l'un de ces champs soit non vide pour que le nom du fichier et son lien de téléchargement n'apparaissent plus dans l'affichage des propriétés du dictionnaire.
Un fichier ainsi masqué restera néanmoins téléchargeable par son url directe (mais encore faut-il connaître celle-ci ! ).
Pour une protection plus robuste et plus personnalisée en cas de panachage de fichiers téléchargeables et de fichiers non téléchargeables, il vous faudra éditer un fichier '.htacces' personnalisé et adapté au contenu de votre dossier "dic".
Pour visualiser les statistiques de consultation des dictionnaires, ouvrez l'url suivante dans votre navigateur :
http://{...url de votre site...}/sqlinguae/lib/viewstat.php5
Le mot de passe par défaut est "sqlinguae". Il est modifiable dans le fichier de configuration. Une fois le mot de passe entré, les statistiques s'affichent en sélectionnant dans une liste déroulante le dictionnaire concerné.
Les mots recherchés par vos visiteurs sont affichés avec le nombre de fois où ils ont été recherchés ainsi que la date de leur dernière recherche. Les mots qui n'ont pas été trouvés dans le dictionnaire concerné sont surlignés en rouge.
En utilisant les cases à cocher et le bouton "Rafraîchir", l'ordre d'affichage des statistiques peut être modifié :
Le tri s'effectue à deux niveaux (niveau principal et niveau secondaire) paramétrables indépendamment. Ceci permet de panacher les modes de tri entre eux.
Si vous désirez que ces statistiques restent confidentielles, remplacez le mot de passe par défaut par un mot de passe personnel.
Pour cela, ouvrez le fichier de configuration : .../sqlinguae/lib/config.php et modifiez-y le paramètre 'stat_psw'.
Pour réinitialiser les statistiques d'un dictionnaire, supprimez (ou archivez) le fichier de statistiques correspondant dans le dossier /stat/.
A chaque fichier dictionnaire dans le dossier "dic" correspond un fichier de statistique de même nom mais préfixé par "stat_". Ce fichier est créé automatiquement par le script lors de la première recherche effectuée par un visiteur dans le dictionnaire concerné.
Ouvrez et modifiez le fichier de configuration : .../sqlinguae/lib/config.php, et modifier la valeur de 'record_stat'
Mettez la valeur 0 à ce paramètre si vous désirez une désactivation totale, la valeur 2 pour ne surveiller que la case "Rechercher" ou 4 pour ne surveiller que la case "Aller à".
Attention, cette désactivation/activation concerne tous les dicos.
Si les statistiques ne vous sont d'aucune utilité, n'hésitez pas à les désactiver totalement ou partiellement, cela diminuera légèrement la charge du serveur et accélèrera légèrement le script.
Les statistiques ne doivent pas être un moyen de pistage de l'utilisateur ! De ce fait, seules sont conservées des données neutres et anonymes qui peuvent être utiles pour améliorer l'adaptation du contenu d'un dictionnaire à la demande de ses utilisateurs : mot recherché, date et succès ou non de la recherche.
Si vous désirez récupérer et conserver des données du genre adresse IP, "referrer" ou autres données de traçage des utilisateurs des dictionnaires, débrouillez-vous tout seul car ce n'est pas dans l'esprit de ce script !
La page de statistique affiche également (en bas de page) un lien permettant de vérifier si une nouvelle version du script SqLinguae est disponible en téléchargement. En activant ce lien, les numéros respectifs des versions sont affichés avec un lien vers le site de téléchargement.
Problèmes potentiels :
Tout script de ce type (le problème n'est pas propre à SqLinguae), c'est-à-dire traitant des données externes, représente donc une porte d'entrée potentielle aux attaques de type XSS et autres.
SqLinguae prend en compte ce risque mais il n'a pas la prétention d'être totalement sécurisé de ce point de vue. Il présente un niveau de sécurité suffisant pour une utilisation sur un site personnel ou assimilable, mais il serait par contre imprudent de l'utiliser tel quel sur un site contenant des données sensibles sans tests préalables réalisés par une personne compétente et des modifications de son code si besoin.
Le risque d'injection SQL est, pour ce script, assez secondaire. Le risque de corruption d'une base-dico est faible et, si cela survenait néanmoins, ce serait sans grande importance puisqu'il ne s'agit que d'une exportation d'un dico-maître géré par un programme en local donc inaccessible via le Web. Reconstituer une base-dico corrompue ne prend que quelques secondes à l'aide de Linguae. De plus, chaque dico constitue une base de données indépendante.
Ce script est compatible XHTML 1.0-strict.
... toutefois, il n'est pas certain que l'affichage des données issues des dictionnaires le soit toujours !
En effet, l'affichage correct de nombreux dictionnaires nécessite que le formatage html souvent contenu dans les notices des mots puisse être interprété par le navigateur. Seul le contenu potentiellement à risque (tel que les balises <script>, etc.) est automatiquement éliminé par SqLinguae avant l'envoi de la page au navigateur, le balisage de mise en forme est conservé.
Or les notices de certains dictionnaires contiennent soit des balises conformes avec HTML mais non avec XHTML, les mises en couleur par la balise <font> par exemple, soit des balises sans aucune signification pour HTML/XHTML comme de nombreuses balises xdxf (un format xml utilisé dans de nombreux dictionnaires).
A noter que les balises xdxf de couleur de police <c c="#xxxx">...</c> sont automatiquement converties par le script en syntaxe XHTML-strict, ce qui n'est pas le cas des couleurs appliquées à l'aide de <font>.
Donc, si le code généré par le script lui-même est effectivement conforme à XHTML-strict, la conformité à XHTML de l'affichage du dico dans le visualiseur reste dépendante du contenu du dictionnaire.
Dans l'hypothèse où le risque de non-conformité XHTML poserait problème, il est possible d'utiliser l'option radicale "nettoyer les balises" lors de l'exportation du dictionnaire-source à partir de Linguae.
Tout d'abord, les options et paramétrages permettent une certaine personnalisation de l'aspect et du comportement du script en fonction du contexte et des types de dictionnaire.
Vous pouvez aussi modifier la feuille de style CSS du script : ".../sqlinguae/lib/sqlinguae.css"
Vous pouvez réaliser des greffons ou ajouter des greffons existants.
Autres possibilités de personnalisation :
Un greffon ("plugin" en franglais) est une extension logicielle apportant des fonctionnalités supplémentaires à un programme-hôte en s'interfaçant avec ce dernier.
Les dictionnaires sont multiples et variés quant à leur langue et leur contenu. Il est inconcevable de prendre en charges les particularités et contraintes propres à chaque langue dans le gestionnaire d'affichage lui-même, ce serait beaucoup trop lourd ! Il en va ainsi des déclinaisons, conjugaisons et autres particularités grammaticales qu'il est impensable de traiter par un autre moyen que des greffons spécifiques à chaque langue ou à chaque groupe de langue.
Un greffon est constitué par un dossier portant son nom. L'installation consiste à copier ce dossier dans le dossier sqlinguae/plugin/.
En mode explorateur de dictionnaire, les icônes de tous les greffons compatibles avec le dictionnaire utilisé s'affichent en haut de la notice, dans la barre du mot à la suite de celui-ci. En cliquant sur une icône, le mot affiché est transmis au greffon. Le traitement appliqué à ce mot dépend du greffon.
(sautez cette section si vous ne désirez pas programmer un nouveau greffon)
Les greffons de SqLinguae s'éxécutent côté serveur et doivent être écrits en PHP ou être appelés par du code PHP.
Pour s'interfacer avec SqLinguae, les fichiers constituant le greffon doivent être placés dans un dossier qui lui est propre et qui porte son nom. Ce dossier doit être placé dans le dossier sqlinguae/plugin/.
Pour s'interfacer automatiquement avec SqLinguae, le contenu du dossier du greffon doit contenir au minimum :
Tout le reste du contenu du dossier du greffon est libre et est du domaine de la programmation du greffon lui-même.
L'appel d'un greffon par Sqlinguae consiste à appeler par un lien (l'icône du greffon) le fichier index.php du greffon et à lui transmettre le libellé du mot sélectionné par le paramètre "wd".
Pour qu'un greffon soit accessible via un dictionnaire :
Pour permettre l'utilisation d'un greffon avec un dictionnaire donné, il faut compléter les champs 'compatPlugins' et 'usePlugins' de la table "Properties" du fichier sqlite du dictionnaire (pour cela utilisez Linguae ou un éditeur de base sqlite) en y inscrivant le nom du greffon (= le nom de son dossier) de la manière suivante :
"sqlinguae:nom_du_greffon_1","sqlinguae:nom_du_greffon_2","sqlinguae:nom_du_greffon_3"
Un dictionnaire peut accepter un nombre indifférent de greffons.
Le terme "script SqLinguae", utilisé ci-dessous, désigne l'ensemble constitué par tous les fichiers inclus dans l'archive zip originale "sqlinguae.zip".
Le script Sqlinguae est sous Licence CeCILL (licence libre compatible GNU-GPL) :
http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt
http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
Auteur : Billig, 2011
Cette licence libre ne concerne que le script SqLinguae lui-même (c'est-à-dire un moteur d'affichage de dictionnaires) et non les dictionnaires qu'il affiche, qui restent régis par leurs propres contrats de licence.
Tous vos...
... sont à adresser à :
linguae [ partie à supprimer et à remplacer par l'arobase] stalikez.info
_____________________________________________________