Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
clients:scrutarijs [2017/07/01 01:44]
vincent [Les fichiers de gabarit HTML]
clients:scrutarijs [2017/07/11 15:11]
vincent
Ligne 1: Ligne 1:
 ====== ScrutariJs ====== ====== ScrutariJs ======
  
-===== Les fichiers ​de localisation (l10n) =====+ScrutariJs est un client ​de Scrutari écrit en Javascript. Il est déposé sur Framagit : https://​framagit.org/​Scrutari/​scrutarijs. Le wiki du dépôt indique notamment [[https://​framagit.org/​Scrutari/​scrutarijs/​wikis/​installation|la procédure d'​installation]] et comment [[https://​framagit.org/​Scrutari/​scrutarijs/​wikis/​adaptation|l'​adapter]].
  
-L'insertion ​d'un fichier ​de localisation est indispensable ​pour que l'interface soit lisibleUn 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.+Il est possible de le voir en action à l'adresse [[http://​client.scrutari.net/​|client.scrutari.net]] (avec une recherche sur la Coredem). client.scrutari.net est constitué ​d'une série ​de scripts PHP qui organise l'​appel du client ScrutariJs avec notamment une variante ​pour grand écran qui divise la fenêtre en deux cadres : un pour la recherche proprement dite et l'autre pour la consultation : [[http://​client.scrutari.net/?​page=frame|client.scrutari.net/?​page=frame]]Le code de ce mini site est aussi hébergé sur Framagit : [[https://​framagit.org/​Scrutari/​scrutarijs-standalone|Scrutari/​scrutarijs-standalone]].
  
-Extrait du fichier ​pour le français : +ScrutariJs est conçu ​pour s'intégrer ​dans des sites existantscomme le montre ​les exemples suivants ​:
- +
-<code javascript>​ +
-var SCRUTARI_L10N = { +
-  lang:'​fr',​ +
-  '_ and':'​ET',​ +
-  '_ button_check_all':'​Tout cocher',​ +
-  '_ button_close':'​Fermer'​ +
-}; +
-</​code>​ +
- +
-Les fichiers de localisation sont définis à part dans le répertoire !!l10n/!!. Ils doivent être insérés spécifiquement. +
- +
-Exemple : +
- +
-<code javascript>​ +
-<script src="​scrutarijs/​l10n/​fr.js"></​script>​ +
-</​code>​ +
- +
-===== Les fichiers de gabarit HTML ===== +
- +
-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 : +
-<code javascript>​ +
-<script src="​scrutarijs/​html/​bootstrap3.js"></​script>​ +
-</​code>​ +
- +
-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/ +
- +
- +
-===== Options de Scrutari.Client.init ===== +
- +
-  * //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+
  
 +  * [[http://​www.films-luttes-mouvements.net/​scrutarijs|Films en Luttes et en Mouvement]]
 +  * [[http://​www.socioeco.org/​scrutarijs_fr.html|Socioeco.org]]
 +  * [[http://​www.autourdu1ermai.fr/​scrutarijs|Autour du 1er mai]]
 +  * [[http://​www.citego.org/​scrutarijs_fr.html|Citego]]
  
 +Une extension pour Spip est également développée pour faciliter son intégration dans un site Spip, comme le montre le [[http://​www.coredem.info/​spip.php?​page=recherche_scrutari&​moteur=coredem|site de la Coredem]]. Le code de cette extension est également déposé sur Framagit : [[https://​framagit.org/​Scrutari/​scrutari_client|Scrutari/​scrutari_client]].
clients/scrutarijs.txt · Dernière modification: 2017/07/11 15:11 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0