Différences
Ci-dessous, les différences entre deux révisions de la page.
| Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente Prochaine révision Les deux révisions suivantes | ||
|
serveurscrutari:syndication [2012/09/04 22:59] vincent |
serveurscrutari:syndication [2014/10/01 17:05] vincent [Filtrer les fiches par l'identifiant d'une recherche] |
||
|---|---|---|---|
| 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 moteur. Ces trois flux sont au format Atom. Ils sont accessibles via une adresse décomposée comme suit : |
| - | Ce flux est accessible au format atom via ///feed/{nom du flux}.atom//. | + | //{adresse du moteur}/feed/{nom du flux}(-{options du flux})_{langue d'interface}.atom// |
| - | Le nom du flux peut commencer par //tree// (les nouveautés sont regroupées par base et corpus) ou par //classes// (les nouveautés sont regroupées par classes de corpus). Un tiret peut être placé après ce préfixe suivi de plusieurs caractères qui sont autant d'instructions supplémentaires. Les instructions supplémentaires possibles sont les suivantes : | + | 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. |
| - | * //f// : n'indiquer que les fiches dans les nouveautés (les nouveaux mots-clés sont ignorés). | + | ===== Type de flux ===== |
| - | * //s// : ajouter le sous-titre | + | |
| - | * //c// : ajouter les champs complémentaires | + | |
| - | * //m// : ajouter les mots-clés | + | |
| - | * //i// : ajouter l'icone de la fiche | + | |
| - | * //h// : le texte XML est indenté, utile à des fins de débogage | + | |
| - | * //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 | + | |
| - | Enfin, le nom doit terminer de façon obligatoire par un tiret bas suivi du code de la langue à utiliser. | + | Les trois flux diffèrent par le format et le nombre des entrées fournies par le flux. Ces flux sont les suivants : |
| - | Exemple : http://sct1.scrutari.net/sct/coredem/feed/classes-fiv_fr.atom est le nom du flux utilisé pour l'affichage des nouveautés sur le site de la Coredem. | + | * //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//, //classes//) | ||
| + | * //s// : ajouter le sous-titre (//tree//, //classes//) | ||
| + | * //c// : ajouter les champs complémentaires (//tree//, //classes//) | ||
| + | * //m// : ajouter les mots-clés (//tree//, //classes//) | ||
| + | * //i// : ajouter l'icone de la fiche (//tree//, //classes//) | ||
| + | * //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//, //classes//) | ||
| + | |||
| + | |||
| + | |||
| + | ==== Exemples ==== | ||
| + | |||
| + | Pour la Coredem : | ||
| + | |||
| + | * http://sct1.scrutari.net/sct/coredem/feed/classes-fiv_fr.atom : flux avec une entrée par mise à jour, les fiches sont regroupées par classe 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 ===== | ||
| + | |||
| + | Le filtre le plus intéressant est celui qui consiste à filtrer à partir de l'identifiant d'une recherche réalisée précédemment. Ce filtre a deux intérêts majeurs par rapport au filtre précédent : | ||
| + | |||
| + | * le résultat de la recherche est mis en cache, or les flux de syndication sont consultés très régulièrement, cela réduit donc le temps de traitement | ||
| + | * En rajoutant le paramètre //all//, il est possible de récupérer l'intégralité de la recherche (le flux de syndication aura deux fonctions retrouverDans les **deux jours** qui suivent la recherche, le flux renvoie **toutes** les fiches de la recherche ; cela permet de proposer à l'internaute qui vient d'effectuer une recherche un lien de syndication qui, d'une part, lui permettra de retrouver les fiches de sa recherche dans son agrégateur et qui, d'autre part, transmettra à chaque mise à jour les nouvelles fiches répondant au critère de recherche. Au delà des deux jours, il est possible de forcer le téléchargement de toutes les fiches (et pas seulement des nouveautés) en rajoutant le paramètre //all=1// à l'Url du flux. | ||
| + | |||
| + | |||
| + | |||
| + | ===== 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 | ||
