Flux de syndication

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 :

{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.

Type de flux

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 :

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 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

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

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 Syntaxe des filtres ainsi que les paramètres langlist (liste de langue) et corpuslist (liste de corpus).

Exemple

serveurscrutari/syndication.txt · Dernière modification: 2016/11/24 12:19 par vincent
CC Attribution-Noncommercial-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0