Visitados recentemente
Visitados recentemente
Home  Orion  Api  

Orion API - Formato de Documento de Texto

[VERIFICADO] Last updated by Joe Schaefer on sex, 12 jun 2026    source

 

Formato do documento de texto (markdown, YAML, CSV)

Esta página documenta os campos de Cabeçalho e os Artefatos de Dados resultantes produzido pela API de Criação ao processar esses arquivos de texto (como anexos de página) por meio do single_narrative vista.

Markdown

Cabeçalhos

title

Título do documento obrigatório.

status

Status do documento de texto livre obrigatório.

Three such special status labels are explained below:

rascunho

Estado padrão.

verificado

Indica que o conteúdo foi validado pelo autor. Será revertido para o estado preliminar se o documento for subsequentemente alterado sem revalidação.

arquivado

Indica que o documento foi finalizado e ignorado para trabalho futuro no Orion CMS. Não aparecerá em futuras listagens de diretórios fora de seu local arquivado. O local arquivado rastreará futuras modificações de conteúdo.

acl

Opcional SVN controles de autorização de segurança neste documento. Com suporte ao preenchimento automático e validação de grupo no Orion CMS editor.

dependencies

Lista opcional separada por vírgulas de file globs que a saída construída deste documento depende.

keywords

Opcional SEO-friendly lista separada por vírgulas de tags pesquisáveis.

categories

Lista opcional separada por vírgulas de categorias de classificação que devem fazer referência a este documento permalinked.

Aditivo por natureza (a remoção de categorias não fará com que essas ex-categorias retirem este documento da lista).

Artefatos de Dados

n/d

Extensões GFM

[TOC]#sidebar

Tabela automática de contextos com opcional id=sidebar no fechamento <div>.

#sidebar permite o comportamento dinâmico na barra lateral esquerda para telas com mais de 1900px de largura.

[^name] Footnotes

Notas de rodapé automáticas.

Links bidirecionais entre notas de rodapé referenciadas e suas descrições.

fenced block extensions

mermaid

Diagramas de Markdown @mermaidjs/mermaid.

asy

Gráficos vetoriais assintóticos iframe renderizador.

[snippet:…]

Faça download e injete trechos de código de repositórios git públicos como GitHub.

YAML

Cabeçalhos

title

Consulte a seção de markdown acima.

status

Consulte a seção de markdown acima.

acl

Consulte a seção de markdown acima.

Artefatos de Dados

content

YAML::XS::Load estrutura de dados analisados

CSV

Cabeçalhos

title

Consulte a seção de markdown acima.

status

Consulte a seção de markdown acima.

acl

Consulte a seção de markdown acima.

headers

Opcional; o valor verdadeiro indica que este documento tem um CSV linha de cabeçalho na parte superior de seu conteúdo.

column_ids

Lista opcional separada por vírgulas de IDs de coluna para PDL

datetime

Opcional strptime(3) formato para PDL processando

type

Opcional declarado PDL tipos de dados de coluna

Artefatos de Dados

content

arrayref de qualquer um dos arrayrefs não csv cabeçalhos), ou hashrefs (csv cabeçalhos)

csv

Text::CSV objeto usado para produzir acima

csv_headers

arrayref de cabeçalhos originais (desmungados)

pdl

Completo PDL objeto gerado pela configuração do cabeçalho