schemaxisPandoc operation reference
Generated from the current declarations. Do not edit this file by hand.
Types, limits and defaults below describe resolved values. Runtime expressions must produce these types. Unknown options are rejected; defaults apply only when omitted. Constructor options must be constant after document composition.
Index#
report#
Publish an ordered report with a visible title, sections, plain paragraphs, rectangular text tables and captured PNG figures as standalone HTML and editable Word DOCX. Use it for small measured-result reports. Trusted JSON AST, sandboxed writers, independent HTML/OOXML inspection and fresh DOCX native readback retain actual declared content. Default typography and pagination are not an exact layout or accessibility contract.
Common mistakes and assumptions:
- Replace each image placeholder with an absolute regular plain RGB/RGBA PNG path.
- Begin headings at level 1 and avoid increasing by more than 1.
- Every table row must have one text cell per column; numeric values must be written as strings.
- No authored markup, templates, filters, scripts, rich text or arbitrary input-document conversion.
Native binding: Pandoc JSON AST: Header / Para / Table / Image; html5 / docx writers; docx reader. Output kind: ["text","file"].
Inputs: none.
| Option | Meaning | Type / constraints | Default |
|---|---|---|---|
title |
Required report title, up to 160 plain-text characters. It appears before the first section in both outputs and labels the HTML browser tab; it is not a filename. | {"type":"string","minLength":1,"maxLength":160} |
required |
sections |
Ordered outline of 1–32 sections, each with a heading and content. Array order is publication order; no native sorting or implicit content is added. | {"type":"array","items":{"type":"object","properties":{"heading":{"type":"string","minLength":1,"maxLength":160,"required":true},"level":{"type":"integer","minimum":1,"maximum":3,"default":1},"content":{"type":"array","items":{"type":"union","options":[{"type":"object","properties":{"kind":{"type":"enum","values":["paragraph"],"required":true},"text":{"type":"string","minLength":1,"maxLength":2048,"required":true}}},{"type":"object","properties":{"kind":{"type":"enum","values":["table"],"required":true},"columns":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256,"required":true},"minItems":1,"maxItems":8,"required":true},"rows":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1,"maxLength":256,"required":true},"minItems":1,"maxItems":8},"minItems":1,"maxItems":64,"required":true}}},{"type":"object","properties":{"kind":{"type":"enum","values":["image"],"required":true},"source":{"type":"string","minLength":1,"maxLength":4096,"required":true},"alt":{"type":"string","minLength":1,"maxLength":256,"required":true},"widthMm":{"type":"number","minimum":10,"maximum":150,"default":80}}}]},"minItems":1,"maxItems":32,"required":true}}},"minItems":1,"maxItems":32} |
required |