Skip to content

SERVICE VISU PAGINATION

tledoux edited this page Nov 17, 2016 · 10 revisions

Service de pagination

Contexte

J'ai un document numérique et je souhaite récupérer les informations nécessaires pour le parcourir

Ce service renvoie la pagination d'un document.

Un seul paramètre est obligatoire, il s’agit de l’ark de l’identifiant numérique du document.

Le service retourne donc :

  • 400, s’il manque le paramètre ark
  • 404, si la notice n’est pas trouvée (document non indexé).
  • le flux XML contenant la structure de la pagination du document, accompagnée de certains paramètres récupérés de l’index.

Exemple

http://gallica.bnf.fr/services/Pagination?ark=bpt6k5738219s

<?xml version="1.0" encoding="UTF-8"?>
<livre>
  <structure>
    <firstDisplayedPage>12</firstDisplayedPage>
    <hasToc>true</hasToc>
    <TocLocation>328</TocLocation>
    <hasContent>true</hasContent>
    <idUPN>NUMM-5738219</idUPN>
  </structure>
  <pages>
    <page>
      <numero>NP</numero>
      <ordre>1</ordre>
      <pagination_type>N</pagination_type>
    </page>
    <page>
      <numero>NP</numero>
      <ordre>2</ordre>
      <pagination_type>N</pagination_type>
    </page>
    …
  • Si le qualifier f n'est pas spécifié dans l'url, l'information de firstDisplayedPage sera utilisé pour afficher l'image correspondante au chargement du visualiseur. Si la valeur est < 1, on affiche la première page du document.

  • hasToc : true ou false, si le document contient une table des matières (et donc affichage du module de TDM ou pas). Il permet également de pouvoir faire appel au service restituant la table des matières si la valeur est à true.

  • hasContent : true ou false, si le document contient du texte indexé. Préférer la balise <mode_indexation> d'OAIRecord.

  • idUPN : cote du document numérique.

Chaque information de page est contenue dans une balise page, elles mêmes contenues dans une balise pages.

  • numero : chaîne à afficher dans le module de pagination.

  • ordre : numéro d'ordre séquentiel de l'image correspondante. Il s'agit de la valeur à rajouter dans le qualifier f lorsqu’on souhaite afficher la page correspondante (cf service d'affichage des images).

  • pagination_type : type de pagination logique (N comme non paginé, ou A comme Arabe par exemple).

Note : dans le cas des documents contenant des légendes (cartes, lot d'images ou manuscrits), une balise supplémentaire est rajoutée pour chaque balise page.

<page>
  <numero>1</numero>
  <ordre>1</ordre>
  <pagination_type>A</pagination_type>
  <legend>Le Louvre. N ° Atget : 5169. 1905-1906. Photographie positive sur papier aristotype d'après négatif sur   verre au gélatinobromure ; 21,6 x 17 cm (épr.). [Cote : BNF - Est. Eo 109b bte 1 ; n ° micr. T039204] \ Opaline 047313
  </legend>
</page>
  • legend : légende associée à la page

Difficulté

Parsing classique d'un flux xml, pas de difficulté.

Clone this wiki locally