Nyligen besökta
Nyligen besökta
Home  Orion  Api  

Orion API - textdokumentformat

[VERIFIERAD] Last updated by Joe Schaefer on Fri, 12 Jun 2026    source

 

Textdokumentformat (markdown, YAML, CSV)

Den här sidan dokumenterar huvudfälten och resulterande dataartefakter producerad av Bygg API vid bearbetning av sådana textfiler (som sidbilagor) via dess single_narrative vy.

Markdown

Huvuden

title

Obligatorisk dokumenttitel.

status

Obligatorisk dokumentstatus i fritext.

Three such special status labels are explained below:

skiss

Standardtillstånd.

verifierad

Anger att innehållet har validerats av författaren. Återgår till utkastläge om dokumentet senare ändras utan omvalidering.

arkiverad

Anger att dokumentet är slutfört och okunnigt för framtida arbete i Orion CMS. Visas inte i framtida kataloglistor utanför dess arkiverade plats. Arkiverad plats spårar framtida ändringar av innehåll.

acl

Valfritt SVN säkerhetsbehörighetskontroller i det här dokumentet. Med autokomplettera stöd och gruppvalidering i Orion CMS redaktör.

dependencies

Valfri kommaavgränsad lista över file globs att dokumentets skapade utdata är beroende av.

keywords

Valfritt SEO-vänlig kommaavgränsad lista över sökbara taggar.

categories

Valfri kommaavgränsad lista över klassificeringskategorier som ska referera till detta permalänkade dokument.

Additiv till sin natur (om du tar bort kategorier tas inte dessa tidigare kategorier bort från listan).

Dataartefakter

Saknas

GFM-tillägg

[TOC]#sidebar

Automatisk kontexttabell med valfritt alternativ id=sidebar i omslutningen <div>.

#sidebar möjliggör dynamiskt beteende i det vänstra sidofältet för skärmar som har mer än 1900px bredd.

[^name] Footnotes

Automatiska fotnoter

Dubbelriktade länkar mellan refererade fotnoter och deras beskrivningar.

fenced block extensions

mermaid

Nedsättning @mermaidjs/mermaid diagram.

asy

Asymptote vektorgrafik iframe renderare.

[snippet:…]

Ladda ner och injicera kodfragment från offentliga git-datalager som GitHub.

YAML

Huvuden

title

Se avsnittet Markdown ovan.

status

Se avsnittet Markdown ovan.

acl

Se avsnittet Markdown ovan.

Dataartefakter

content

YAML::XS::Load tolkad datastruktur

CSV

Huvuden

title

Se avsnittet Markdown ovan.

status

Se avsnittet Markdown ovan.

acl

Se avsnittet Markdown ovan.

headers

Valfritt; sant värde anger att dokumentet har en CSV rubrikrad överst i innehållet.

column_ids

Valfri kommaavgränsad lista över kolumn-id:n för PDL

datetime

Valfritt strptime(3) format för PDL bearbetning

type

Valfritt deklarerat PDL kolumndatatyper

Dataartefakter

content

arrayref av endera arrayrefs (nej csv rubriker), eller hashrefs (csv rubriker)

csv

Text::CSV objekt som används för att producera ovan

csv_headers

arrayref av ursprungliga (oblandade) rubriker

pdl

Fullständig PDL objekt genererat av huvudkonfiguration