ScrutariJs

L'insertion d'un fichier de localisation est indispensable pour que l'interface soit lisible. Un fichier de localisation est un fichier Javascript où est défini un objet javascript appelé SCRUTARI_L10N dont les noms de propriétés correspondent aux clés de localisation.

Extrait du fichier pour le français :

var SCRUTARI_L10N = {
  lang:'fr',
  '_ and':'ET',
  '_ button_check_all':'Tout cocher',
  '_ button_close':'Fermer'
};

Les fichiers de localisation sont définis à part dans le répertoire l10n/. Ils doivent être insérés spécifiquement.

Exemple :

<script src="scrutarijs/l10n/fr.js"></script>

Les fichiers de gabarit HTML sont situés dans le répertoire html/, ils doivent être insérés en plus de scrutarijs.js car ils s'appuient sur des bibliothèques tierces. Il faut donc n'insérer que le fichier correspondant à la bibliothèque utilisée. Pour l'heure, la seule bibliothèque entièrement géré est Bootstrap version 3. La gestion de Bootstrap 2 est prévue.

L'intégration de Bootstrap3 se fait ainsi :

<script src="scrutarijs/html/bootstrap3.js"></script>

Un fichier de gabarit HTML définit un objet Javascript : SCRUTARI_HTML, celui doit posséder une propriété structure qui est un objet comprenant les chaines HTML utilisées pour constituer la structure du client ainsi qu'une propriété templates qui est un objet dont les propriétés définissent des gabarits Html/

• locMap : objet Javascript dont les noms de propriétés correspondent aux clés de localisation. Cette option n'a pas besoin d'être définie si un fichier de localisation a été inséré préalablement.
• htmlObject : objet Javascript indiquant les gabarits HTML à utiliser. Cette option n'a pas besoin d'être définie si un fichier de gabarit a été inséré préalablement.
• withCorpus : false ou true, indique si les options de filtre proposent un filtre par corpus, défaut : false
• baseSort : ordre de classement des bases dans les options de filtres ; peut prendre les valeurs suivantes :
  • “fiche-count” : par le nombre de fiches (défaut)
  • “none” : ordre « naturel » (ordre de déclaration des bases dans le serveur)
• corpusSort : ordre de classement des corpus (si withCorpus est égal à true) ; peut prendre les valeurs suivantes :
  • “fiche-count” : par le nombre de fiches (défaut)
  • “none” : ordre « naturel » (ordre de déclaration des corpus dans les fichiers ScrutariData)
• target : cible des liens vers les fiches (par défaut, “_target”)
• initialQuery : séquence de recherche initiale (par défaut, “”), permet de remplir le client avec le contenu d'une nouvelle recherche
• initialQId : identifiant d'un recherche existante (par défaut, “”), permet de remplir le client avec le contenu d'une recherche existante
• permalinkPattern : patron de construction de l'URL du permalien vers la recherche (défaut null), doit être une chaine contenant “$QID” (sera remplacé par l'indentifiant de la recherche) et éventuellement $LANG
• paginationChangeCallback : Fonction de rappel optionnelle appelée lorsque l'utilisateur change la pagination
• hiddenList : liste d'élements HTML à cacher, ces éléments doivent être définis dans les gabarits HTML, cette option permet de cacher simplement des éléments (par exemple, le titre) sans avoir à modifier le gabarit HTML lui-même
• templateFactory : fonctions ou tableau de fonctions qui fournissent des gabarits alternatifs à ceux par défaut