| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| serveurscrutari:syndication [2013/12/12 16:16] – vincent | serveurscrutari:syndication [2022/07/01 17:12] (Version actuelle) – vincent |
|---|
| ====== Flux de syndication ====== | ====== Flux de syndication ====== |
| |
| Le serveur Scrutari propose trois types de flux de syndication différents pour être tenu informé des nouvelles entrées dans le serveur. Ces trois flux sont au format Atom. Ils sont accessibles via une adresse décomposée comme suit : | Un moteur Scrutari propose trois types de flux de syndication différents pour être tenu informé des nouvelles entrées dans le moteur plus un flux pour les erreurs. Ces quatre flux sont au format Atom. Ils sont accessibles via une adresse décomposée comme suit : |
| |
| ///feed/{nom du flux}(-{options du flux})_{langue d'interface}.atom// | //{adresse du moteur}/feed/{nom du flux}(-{options du flux})_{langue d'interface}.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. | 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. |
| | |
| | L'interface d'administration propose à l'onglet « syndication » un outil pour construire l'URL du flux en fonction des options. |
| |
| ===== Type de flux ===== | ===== Type de flux ===== |
| |
| * //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 | * //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 |
| * //classes// : équivalent au flux //tree// (une seule entrée par mise à jour) mais les fiches sont regroupées par classe de corpus ; ce flux n'a évidemment d'intérêt que si des classes de corpus sont définies dans le moteur Scrutari | * //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 | * //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 |
| | * //errors// : flux des erreurs rencontrées au moment de la mise à jour du moteur |
| |
| ===== Les options ===== | ===== 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 : | 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//) | * //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//, //classes//) | * //s// : ajouter le sous-titre (//tree//, //categories//) |
| * //c// : ajouter les champs complémentaires (//tree//, //classes//) | * //i// : ajouter l'icone de la fiche (//tree//, //categories//) |
| * //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) | * //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//) | * //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//) |
| |
| |
| Pour la Coredem : | 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/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 | * 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 l'identifiant d'une recherche ===== | ===== 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 : | 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 |
| * 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 | * 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. |
| * Dans 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. | |
| |
| | ==== 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 ===== | ===== Filtrer les fiches par les filtres ===== |
