render_publication

readSeit v1.0

Rendert eine ganze Publikation — jede Seite, in Lesereihenfolge, in einem Durchgang. Das ist dieselbe Zusammenstellung, die auch das PDF und der Markdown-Download verwenden; zurück kommt also das echte Ergebnis und keine Näherung.

Verwenden Sie es, um eine Publikation von vorn bis hinten durchzusehen: in welcher Reihenfolge die Seiten kommen und wie sie sich verschachteln, welche Elemente es hineingeschafft haben und welche Seiten leer geblieben sind. Jede Seite trägt ihre eigenen Diagnosen, und das Ergebnis zählt, wie viele Seiten überhaupt welche haben — so erkennen Sie Probleme, ohne alles zu lesen. Hat die Publikation eine Startseite, kommt sie zuerst.

Die Ergebnisse kommen seitenweise. Rufen Sie immer wieder mit dem next_offset des vorigen Ergebnisses auf, bis has_more false zurückgibt — richten Sie die Schleife nicht danach, wie viele Sie angefordert haben, denn ein Durchgang wird auch dann abgebrochen, wenn der Text lang wird. Für einen schnellen Blick auf die Struktur einer großen Publikation fordern Sie die Struktur ohne Inhalt an.

Parameter

Name	Typ	Pflichtfeld	Standard	Beschreibung
`format`	`String`	—	markdown	Format jeder zurückgegebenen Seite: „markdown” ist die lesbare, gut vergleichbare Fassung; „html” ist das, was der Viewer zeigt.
`locale`	`String`	—		Rendert die Publikation in dieser Sprache (zum Beispiel „de”).
`limit`	`Number`	—	20	Höchstzahl der Seiten in dieser Antwort. Maximal 100. Ein Durchgang kann trotzdem kürzer ausfallen, wenn der Text lang wird — entscheiden Sie also anhand von has_more, ob Sie weitermachen, nicht anhand dieser Zahl.
`include_content`	`Boolean`	—	true	Auf false setzen, um den gerenderten Text wegzulassen und nur Struktur und Diagnosen zu erhalten — der schnellste Weg, die Form einer großen Publikation zu prüfen.
`publication`	`String`	✓		Die zu rendernde Publikation, per ID, Slug oder Name.
`offset`	`Number`	—		Anzahl der zu überspringenden Seiten. Übergeben Sie das next_offset des vorigen Ergebnisses, um fortzufahren.

Beispielanfrage

{"publication": "service-handbook", "include_content": false, "limit": 50}

Beispielantwort

{"total_pages": 74, "returned": 50, "has_more": true, "next_offset": 50, "pages_with_diagnostics": 3, "pages": [{"id": "homepage", "kind": "homepage", "label": "Service Handbook", "depth": 0, "diagnostics": []}]}