Le sommaire cliquable sur le côté

En mots de tous les jours

Écrit pour tout le monde. Il dit ce que cela pose sur une feuille de papier, et ne vous demande rien de plus.

Dans un gros classeur, on met des intercalaires avec des onglets pour retrouver une partie sans feuilleter. C'est exactement ce qu'on fabrique ici : une liste qui s'affiche sur le côté du document, où chaque ligne porte un titre et mène directement à la bonne page. Les lignes peuvent en contenir d'autres, comme un sommaire de livre avec ses chapitres et ses sous-chapitres, et on décide lesquelles s'ouvrent d'elles-mêmes.

Pour un développeur

Écrit pour celui qui écrit le programme appelant : le modèle, les unités, et les réglages qui portent le poids.

bookmarks porte l'arbre des signets qu'un lecteur affiche dans son panneau latéral. Chaque signet a un titre, la page où il mène, et éventuellement des signets imbriqués sous lui. L'ordre du tableau est l'ordre d'affichage. Pour que le panneau s'ouvre tout seul à l'ouverture du document, on le demande par reading.open_mode. Un signet qui mène à une page que le document n'a pas est refusé.

Chaque clé, avec son défaut

La référence : quelles clés sont obligatoires, lesquelles sont facultatives, ce que vaut chacune par défaut et quelles combinaisons le serveur décline.

bookmarks — tableau, facultatif, vide par défaut.
bookmarks[].title — chaîne, obligatoire. Ce que le lecteur affiche.
bookmarks[].page — entier ≥ 1, obligatoire. La page où mène le signet. Une page que le document n'a pas est refusée, et la réponse la nomme dans la numérotation employée par la requête.
bookmarks[].open — booléen, facultatif, false par défaut. Affiche ce qui est imbriqué dessous sans qu'on le demande.
bookmarks[].children — tableau, facultatif, vide par défaut. Les signets imbriqués sous celui-ci, de même forme, sans limite de profondeur.

Un signet mène à une page par son numéro. Pour un point d'arrivée qui suive le document plutôt que le numéro, on passe par destinations et un élément link qui la nomme.

Une requête entière qui le dessine

Envoyez ceci tel quel et un PDF revient. Rien n'en a été retiré.

{
  "bookmarks": [
    {
      "title": "Contents",
      "page": 1,
      "open": true,
      "children": [{ "title": "The annex", "page": 2 }]
    }
  ],
  "standard_fonts": [{ "name": "sans", "face": "helvetica" }],
  "items": [
    {
      "type": "text",
      "pages": [1],
      "rect": { "llx": 60, "lly": 740, "urx": 535, "ury": 768 },
      "content": ["Contents"],
      "font": "sans",
      "font_size": 18
    },
    {
      "type": "text",
      "pages": [2],
      "rect": { "llx": 60, "lly": 740, "urx": 535, "ury": 768 },
      "content": ["The annex"],
      "font": "sans",
      "font_size": 18
    }
  ]
}

La ligne qui l'envoie, en trois langages

S'y retrouver

L'ordre du passage d'un champ au suivant Des points d'arrivée qui portent un nom Suivre un article de colonne en colonne Comment le document s'ouvre et s'imprime

Où aller ensuite

Chaque clé d'une requête, en une page Les trente-deux autres réglages d'une requête

Voir les prix Voir les exemples

Glossaire

signet: La liste des titres qu'un lecteur de PDF affiche sur le côté du document, chaque ligne menant droit à sa place dedans. C'est le sommaire que possède le logiciel, et non celui qui est imprimé sur une page : un long document qui n'en a pas est un document où personne ne retrouve son chemin.
requête: Un appel au service : vous envoyez ce que le document doit dire, et vous recevez le document. Votre facture compte ces appels, un par document. Le nombre de pages d'un document n'est jamais compté.

Tous les mots que le site explique