Des points d'arrivée qui portent un nom

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.

Dire « voir page 12 » a un défaut : le jour où on ajoute une page au début, tout se décale et le renvoi est faux. On peut faire mieux : on colle une étiquette à l'endroit visé, on lui donne un nom, et les renvois pointent vers ce nom. Si le document bouge, l'étiquette bouge avec lui et les renvois restent justes. On décide aussi de ce qui remplit l'écran en arrivant : la page entière, sa largeur, ou un cadre précis.

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.

destinations enregistre des points d'arrivée sous un nom : chacun tient une page et la façon dont elle remplit la fenêtre. Une action qui mène à un nom n'énonce ni l'une ni l'autre, si bien que le point d'arrivée suit le document plutôt que le numéro de page qu'il occupait. Un élément link y mène par action, avec la forme {"destination": "the name"}.

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.

• destinations — tableau, facultatif, vide par défaut.
• destinations[].name — chaîne, obligatoire. Le nom sous lequel l'endroit est enregistré. Un nom enregistré deux fois est refusé.
• destinations[].page — entier ≥ 1, obligatoire. La page pour laquelle le nom tient. Une page que le document n'a pas est refusée.
• destinations[].fit — facultatif, whole_page par défaut. Huit formes : "whole_page" ; {"full_width": {"top": n}} ; {"full_height": {"left": n}} ; {"rectangle": {"x": n, "y": n, "width": n, "height": n}} ; "whole_drawing" ; {"drawing_width": {"top": n}} ; {"drawing_height": {"left": n}} ; {"fixed": {"left": n, "top": n, "zoom": n}} — les trois dernières clés étant chacune facultative.

Une requête entière qui le dessine

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

{
  "destinations": [{ "name": "annex", "page": 2 }],
  "standard_fonts": [{ "name": "sans", "face": "helvetica" }],
  "items": [
    {
      "type": "text",
      "pages": [1],
      "rect": { "llx": 60, "lly": 740, "urx": 535, "ury": 758 },
      "content": ["See the annex"],
      "font": "sans",
      "font_size": 12
    },
    {
      "type": "link",
      "pages": [1],
      "rect": { "llx": 60, "lly": 738, "urx": 160, "ury": 760 },
      "action": { "destination": "annex" }
    },
    {
      "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