Le fichier jslib.conf

Toute bibliothèque Javascript située dans /resources/jslibs/ est censé posséder un fichier jslib.conf qui précise la configuration. Ce fichier de configuration est découpé en section indiqué par un nom entre crochets. Les sections attendues sont : [use], [javascript], [css] et [params].

Section [use]

Cette section est la plus importante : elle indique les pages Html de l’interface standard dans lesquelles cette bibliothèque doit être rajoutée. Une page est identifié par son domaine et son nom local, séparé par un :, comme le nom d’un attribut. On retrouve le domaine et le nom local en regardant l’URL de la page en question. Le domaine est la dernière partie du chemin (par exemple, /corpus, /edition). Le nom local est la valeur du paramètre page=.

L’exemple suivant présente le cas le plus courant, celui d’une bibliothèque qui permet d’enrichir le formulaire de création ou de modification d’une fiche :

[use]
edition:fiche-creation
edition:fiche-change

Section [javascript]

Tous les fichiers contenus dans le répertoire js/ d’une bibliothèque (ainsi que ses sous-répertoires) sont inclus automatiquement. Cette section permet d’indiquer d’autres chemins de fichiers Javascript. Tous les chemins de cette section sont insérés avant l’insertion automatique de js/. Il est ainsi possible d’indiquer des fichiers dans js/ pour être sûr de l’ordre d’insertion des fichiers.

Un fichier peut-être indiqué par un chemin relatif (qui sera résolu par rapport au répertoire de la bibliothèque Javascript) ou par un chemin absolu (qui sera résolu par rapport à la racine des ressources de la fichothèque).

Dans l’exemple suivant, la bibliothèque comprend du code Javascript utilitaire provenant d’une source extérieure qu’on ne veut pas mélanger avec le code Javascript propre à la bibliothèque :

[javascript]
share/Utils.js

Section [css]

Cette section fonctionne exactement de la même façon que la section précédente mais pour les fichiers CSS à la seule différence près c’est que ce sont tous les fichiers contenus dans le répertoire css/ d’une bibliothèque (ainsi que ses sous-répertoires) sont inclus automatiquement comme feuille de style CSS.

Section [params]

Cette section n’est pour le moment pas utilisée, elle permet d’indiquer des paramètres sous la forme key=value.