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
serveurscrutari:syndication [2012/08/01 10:51]
vincent
serveurscrutari:syndication [2016/11/24 12:19] (Version actuelle)
vincent
Ligne 1: Ligne 1:
 ====== Flux de syndication ====== ====== Flux de syndication ======
  
-À chaque mise à jour des fichiers ScrutariData auxquels il est abonné, le moteur Scrutari ​garde la trace des nouvelles entrées. ​La liste de ces nouvelles entrées peut être obtenues automatiquement via un flux de syndication ​au format Atom.+Un moteur Scrutari ​propose trois types de flux de syndication différents pour être tenu informé ​des nouvelles entrées ​dans le moteurCes trois flux sont au format Atom. Ils sont accessibles via une adresse décomposée comme suit :
  
-Ce flux est accessible via ///feed/data_{code de la langue}.atom//. Par exemple, l'​adresse ​du flux de la Coredem en français est : http://​sct1.scrutari.net/​sct/​coredem/​feed/​data_fr.atom. Le code de la langue est utilisée pour la langue d'affichage des intitulés des bases, des corpus et des thésaurus.+//{adresse du moteur}/feed/{nom du flux}(-{options ​du flux})_{langue d'interface}.atom//
  
-Outre la langue, il est possible de transmettre des paramètres au flux en les insérant après ​''​data''​ et avant l'​indication ​de la langue. Par exemple''​-f''​ indique ​que seules ​les nouvelles fiches sont prises en compte et les nouveaux mots-clés sont ignorésAinsi, ​l'adresse du flux de la Coredem avec le filtre sur les fiches est : http://​sct1.scrutari.net/​sct/​coredem/​feed/​data-f_fr.atom.+Les options sont exprimées sous la forme d'une série ​de lettres accoléesà chaque lettre correspond une option (sur le même principe ​que les arguments d'une ligne de commande)La langue de l'interface est le code ISO classique ​de la langue qui doit être utilisé de préférence pour les intitulés.
  
-Paramètres :+===== Type de flux =====
  
--v : demande que le titre de chaque entrée soit sous la forme d'une série de variables, à utiliser si le titre fait l'​objet d'un post-traitement+Les trois flux diffèrent par le format et le nombre des entrées fournies par le flux. Ces flux sont les suivants :
  
 +  * //tree// : le flux comprend une entrée unique par mise à jour avec comme contenu les fiches et les mots-clés organisés suivant les bases, corpus et thésaurus d'​origine ; ce flux est adapté pour un suivi interne de l'​évolution du contenu d'un moteur Scrutari ; le flux contient l'​entrée de la dernière mise à jour ainsi que les entrées de la dizaine de mises à jour précédentes
 +  * //​categories//​ : équivalent au flux //tree// (une seule entrée par mise à jour) mais les fiches sont regroupées par catégorie ; ce flux n'a évidemment d'​intérêt que si des catégories de corpus sont définies dans le moteur Scrutari
 +  * //fiches// : le flux propose une entrée par fiche ajoutée dans le moteur ; seules les nouvelles fiches de la dernière mise à jour sont indiquées ; le contenu d'une entrée reprend les données d'une fiche (titre, sous-titre, champs complémentaires,​ attributs, mot-clé) et le lien de l'​entrée pointe sur l'​adresse de la fiche ; ce flux est le plus « lisible », c'est probablement celui qu'il faut privilégier à destination du public
  
 +===== Les options =====
 +
 +Les options sont indiquées à l'aide d'une série de lettre à la suite du type de flux. Les options ne s'​appliquent pas forcément à tous les types. Les options sont les suivantes :
 +
 +  * //f// : n'​indiquer que les fiches dans les nouveautés (les nouveaux mots-clés sont ignorés) (//tree//, //​categories//​)
 +  * //s// : ajouter le sous-titre (//tree//, //​categories//​)
 +  * //c// : ajouter les champs complémentaires (//tree//, //​categories//​)
 +  * //m// : ajouter les mots-clés (//tree//, //​categories//​)
 +  * //i// : ajouter l'​icone de la fiche (//tree//, //​categories//​)
 +  * //h// : le texte XML est indenté, utile à des fins de débogage (tous les flux)
 +  * //v// : demande que le titre de chaque entrée soit sous la forme d'une série de variables, à utiliser s'il fait l'​objet d'un post-traitement (//tree//, //​categories//​)
 +
 +
 +
 +==== Exemples ====
 +
 +Pour la Coredem :
 +
 +  * http://​sct1.scrutari.net/​sct/​coredem/​feed/​categories-fiv_fr.atom : flux avec une entrée par mise à jour, les fiches sont regroupées par catégories de corpus, les mots-clés ne sont pas ajoutés (option //f//), les icones des fiches sont indiquées (option //i//), le titre de l'​entrée indique le nombre de fiches de l'​entrée (option //v//), les intitulés sont en français
 +  * http://​sct1.scrutari.net/​sct/​coredem/​feed/​fiches_en.atom : flux des nouveautés avec une fiche par entrée, intitulés en anglais ​
 +
 +===== Filtrer les fiches par une recherche =====
 +
 +Le flux //fiches// a ceci de particulier qu'il accepte les mêmes paramètres de recherche que la requête JSON [[serveurscrutari:​json:​type_qfiche|q-fiche]]. Lorsqu'​une recherche est ainsi définie, un filtre est appliqué aux entrées du flux de syndication : seules les fiches répondant au critère de recherche sont insérées dans le flux (ce qui peut conduire à un flux vide).
 +
 +==== Exemple ====
 +
 +  * http://​sct1.scrutari.net/​sct/​coredem/​feed/​fiches_fr.atom?​q=economie : flux des nouveautés qui traite de l'​économie
 +
 +
 +===== Filtrer les fiches par l'​identifiant d'une recherche ​ =====
 +
 +Un flux peut également être filtré en se basant sur les paramètres d'une recherche existante (paramètre //qid//). Cela permet d'​éviter une URL complexe si les critères de recherche sont multiples. En outre, le flux admet le paramètre //all// qui indique que **toutes** les fiches de la recherche doivent être incluses dans le flux. Cela permet à un internaute de retrouver l'​intégralité de sa recherche dans son agrégateur tout en bénéficiant par la suite des nouveautés. Le paramètre //all// peut avoir les valeurs suivantes :
 +  * //always// : toutes les fiches sont toujours rajoutée
 +  * une date au format ISO (Année-Mois-Jour) : toutes les fiches sont incluses lors de l'​appel à cette date et au jour suivant, ensuite, seules les nouveautés sont incluses.
 +
 +==== Exemple ====
 +
 +  * Voir l'URL du lien « flux de syndication ATOM » après voir effectué une recherche sur http://​scrutarijs.coredem.info/​coredem
 +
 +===== Filtrer les fiches par les filtres ​ =====
 +
 +Qu'il soit ou non filtré préalablement par une recherche, le flux //fiches// peut être filtré par les filtres définis dans [[serveurscrutari:​json:​filtersyntax|Syntaxe des filtres]] ainsi que les paramètres //​langlist//​ (liste de langue) et //​corpuslist//​ (liste de corpus).
 +
 +==== Exemple ====
 +
 +  * http://​sct1.scrutari.net/​sct/​coredem/​feed/​fiches_fr.atom?​langlist=fr : flux des nouveautés en français uniquement
serveurscrutari/syndication.1343811072.txt.gz · Dernière modification: 2012/08/01 10:51 par vincent
CC Attribution-Share Alike 4.0 International
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0