Comment le document s'ouvre et s'imprime

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.

Un document peut arriver déjà réglé. Il s'ouvre avec son sommaire déplié sur le côté, à la bonne page, à la bonne taille. Un livre s'affiche par deux pages côte à côte, comme un vrai livre ouvert. Et au moment d'imprimer, la fenêtre propose déjà le recto-verso, deux exemplaires, et les pages qui comptent. Ce sont des souhaits : le logiciel de lecture les suit s'il sait le faire, et rien ne casse s'il fait autrement.

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.

reading porte dix-sept réglages, tous facultatifs, qui décrivent ce que la requête demande au lecteur : le panneau latéral, la disposition des pages, la page d'ouverture et son cadrage, l'habillage de la fenêtre, l'ordre de lecture, et les souhaits qu'une boîte de dialogue d'impression lit. Chaque champ reste absent du document tant que la requête ne l'écrit pas : une requête qui demande une chose demande cette chose-là et laisse le reste du lecteur tranquille.

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.

• reading — objet, facultatif, absent par défaut. Dix-sept clés, toutes facultatives.
• open_mode — chaîne. Ce que le lecteur affiche à côté de la page à l'ouverture. Six valeurs : page_only, bookmarks, thumbnails, full_screen, layers, attachments.
• page_layout — chaîne. Six valeurs : single_page, one_column, two_columns_odd_left, two_columns_odd_right, two_pages_odd_left, two_pages_odd_right.
• open_on — objet. page entier ≥ 1 obligatoire, fit facultatif, whole_page par défaut, les huit formes de cadrage étant celles de destinations.
• hide_toolbar, hide_menu_bar, hide_window_controls, fit_window, center_window, show_title — booléens.
• after_full_screen — chaîne. Ce qui est affiché à côté de la page une fois le plein écran quitté. Quatre valeurs : page_only, bookmarks, thumbnails, layers.
• reading_order — chaîne. Deux valeurs : left_to_right, right_to_left.
• print_scaling — chaîne. Deux valeurs : viewer, actual_size.
• lock_actual_size — booléen, false par défaut. Dit au lecteur qu'il peut n'offrir que la taille demandée.
• duplex — chaîne. Trois valeurs : one_sided, short_edge, long_edge.
• tray_by_page_size — booléen.
• copies — entier ≥ 1.
• print_runs — tableau, vide par défaut. Chaque entrée porte first_page et last_page, entiers ≥ 1, tous deux obligatoires.

Les souhaits d'impression demandent au moins PDF 1.7 ; lock_actual_size demande PDF 2.0. Un document qui déclare une version au-dessous de ce qu'il porte est refusé à l'écriture, et la réponse nomme la partie qui demandait davantage.

Une requête entière qui le dessine

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

{
  "reading": {
    "open_mode": "bookmarks",
    "page_layout": "two_pages_odd_right",
    "open_on": { "page": 1, "fit": "whole_page" }
  },
  "bookmarks": [{ "title": "The cover", "page": 1 }],
  "standard_fonts": [{ "name": "sans", "face": "helvetica" }],
  "items": [
    {
      "type": "text",
      "rect": { "llx": 60, "lly": 700, "urx": 535, "ury": 740 },
      "content": ["The handbook"],
      "font": "sans",
      "font_size": 28
    }
  ]
}

La ligne qui l'envoie, en trois langages

Glossaire

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