Orion API - Text Document Format
Joe SchaeferText Document Format (markdown, YAML, CSV)
This page documents the Header fields and resulting Data Artifacts produced by the Build API when processing such text files (as page attachments) via its single_narrative view.
Markdown
Headers
Mandatory free-text document status.
Three such special status labels are explained below:
draft
Default state.
verified
Indicates that content has been validated by the author. Will roll back to draft state if document is subsequently altered without revalidation.
archived
Indicates document is finalized and ignorable for future work in the Orion CMS. Will not appear in future directory listings outside of its archived location. Archived location will track future content modifications.
Optional SVN security authorization controls on this document. With autocomplete support and group validation in the Orion CMS editor.
Optional comma-separated list of file globs that this document’s built output relies upon.
Optional comma-separated list of classification categories that should reference this permalinked document.
Additive in nature (removing categories will not cause those ex-categories to delist this document).
Data Artifacts
n/a
GFM Extensions
Automatic Table of Contexts with optional id=sidebar on the enclosing <div>.
#sidebar enables dynamic behavior in the left sidebar for screens possessing more than 1900px width.
Automatic Footnotes.
Bidirectional links between referenced footnotes and their descriptions.
mermaid
Markdown @mermaidjs/mermaid diagrams.
asy
Asymptote Vector Graphics iframe renderer.
dot
d3-graphviz dot renderer.
YAML
Headers
Data Artifacts
CSV
Headers
Optional; true value indicates that this document has a CSV header line at the top of its content.
Optional strptime(3) format for PDL processing
Data Artifacts
Text::CSV object used to produce above
Full PDL object generated by header configuration