Недавно посещённые
Недавно посещённые

Orion API – формат текстового документа

[ПРОВЕРЕНО] Last updated by Joe Schaefer on пт, 12 июн. 2026    source
 

Формат текстового документа (markdown, YAML, CSV)

На этой странице содержатся документы полей заголовка и результирующих артефактов данных произведенный Создание API при обработке таких текстовых файлов (как вложений страницы) через single_narrative просмотр.


Markdown

Заголовки

title

Обязательное название документа.

status

Обязательный статус документа произвольного текста.

Three such special status labels are explained below:

черновик

Состояние по умолчанию.


подтверждено

Указывает, что контент проверен автором. Будет выполнен откат до состояния «Черновик», если документ впоследствии будет изменен без повторной проверки.


архивированный

Указывает, что документ завершен и игнорируется для будущей работы в Orion CMS. Не будет отображаться в списках будущих каталогов за пределами его архивного местоположения. Местоположение архива будет отслеживать будущие изменения контента.

acl

Дополнительной SVN средства контроля прав доступа к этому документу. С поддержкой автозавершения и проверкой группы в Orion CMS редактор.

dependencies

Необязательный список разделенных запятыми file globs на что опирается созданный документ.

keywords

Дополнительной SEO-дружественный список тегов с возможностью поиска через запятую.

categories

Необязательный список категорий классификации, разделенных запятыми, которые должны ссылаться на этот документ с постоянной связью.

Добавка по своей природе (удаление категорий не приведет к исключению из списка этих бывших категорий).

Артефакты данных

н/д

Расширения GFM

[TOC]#sidebar

Автоматическая таблица контекстов (необязательно) id=sidebar на корпусе <div>.

#sidebar обеспечивает динамическое поведение в левой боковой панели для экранов с шириной более 1900 пикселей.

[^name] Footnotes

Автоматические сноски.

Двунаправленные связи между ссылочными сносками и их описаниями.

fenced block extensions

mermaid

Схемы разметки @mermaidjs/русалки.

asy

Асимптотная векторная графика iframe рендерер.

[snippet:…]

Загружайте и внедряйте фрагменты кода из общедоступных репозиториев git, таких как GitHub.


YAML

Заголовки

title

См. раздел «Уценка» выше.

status

См. раздел «Уценка» выше.

acl

См. раздел «Уценка» выше.

Артефакты данных

content

YAML::XS::Load синтаксический анализ структуры данных


CSV

Заголовки

title

См. раздел «Уценка» выше.

status

См. раздел «Уценка» выше.

acl

См. раздел «Уценка» выше.

headers

Необязательно; истинное значение указывает, что этот документ имеет CSV строка заголовка в верхней части ее содержимого.

column_ids

Необязательный список идентификаторов столбцов, разделенных запятыми PDL

datetime

Дополнительной strptime(3) формат для PDL переработка

type

Необязательно объявлено PDL типы данных столбцов

Артефакты данных

content

arrayref любой из arrayrefs (нет) csv заголовков), или hashrefs (csv заголовки)

csv

Text::CSV объект, используемый для производства выше

csv_headers

arrayref оригинальных (без боеприпасов) заголовков

pdl

Полный PDL объект, созданный конфигурацией заголовка