API של אוריון - פורמט מסמך טקסט

[אומתו ] Last updated by Joe Schaefer on יום ו׳, 12 יוני 2026 source

תבנית מסמך טקסט (`markdown`, `YAML`, `CSV`)

דף זה מתעד את שדות הכותרת וארטיפקטי הנתונים המתקבלים מיוצר על ידי בנה API בעת עיבוד קובצי טקסט כאלה (כמסמכים מצורפים לדף) באמצעותם single_narrative תצוגה.

תבנית מסמך טקסט (markdown, YAML, CSV)

`Markdown`

כותרות

`title`

כותרת מסמך חובה.

`status`

סטטוס חובה של מסמך טקסט חופשי.

Three such special status labels are explained below:

טיוטה

מצב ברירת מחדל.

אומתה

מציין שהתוכן אומת על-ידי המחבר. יבצע roll back למצב טיוטה אם המסמך ישתנה לאחר מכן ללא אימות מחדש.

הועבר לארכיב

מציין שהמסמך סופי ולא ניתן להתעלם ממנו לעבודה עתידית 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

Markdown @mermaidjs/דיאגרמות בתולת ים.

asy

גרפיקת וקטור אסימפטוטה iframe מעבד.

[`snippet`:…]

הורד והזרק קטעי קוד מ-git repos ציבורי כמו GitHub.

`YAML`

כותרות

`title`

ראה סעיף למטה למעלה.

`status`

ראה סעיף למטה למעלה.

`acl`

ראה סעיף למטה למעלה.

ארטיפקטים של נתונים

`content`

YAML::XS::Load מבנה נתונים מפורק

`CSV`

כותרות

`title`

ראה סעיף למטה למעלה.

`status`

ראה סעיף למטה למעלה.

`acl`

ראה סעיף למטה למעלה.

`headers`

אופציונלי; ערך true מציין שלמסמך זה יש CSV שורת כותרת בחלק העליון של התוכן שלה.

`column_ids`

רשימה אופציונלית מופרדת בפסיקים של מזהי עמודות ל- PDL

`datetime`

אופציונלי strptime(3) פורמט של PDL מעבד

`type`

מוצהרת אופציונלית PDL סוגי נתונים של עמודה

ארטיפקטים של נתונים

`content`

arrayref של אחד arrayrefs (לא) csv כותרות, או hashrefs (csv כותרות)

`csv`

Text::CSV אובייקט המשמש לייצור למעלה

`csv_headers`

arrayref של כותרות מקוריות (לא מאוישות)

`pdl`

מלא PDL אובייקט שנוצר על-ידי תצורת כותרת

נצפה לאחרונה

API של אוריון - פורמט מסמך טקסט

תבנית מסמך טקסט (markdown, YAML, CSV)

Markdown

כותרות

title

status

טיוטה

אומתה

הועבר לארכיב

acl

dependencies

keywords

categories

ארטיפקטים של נתונים

הרחבות GFM

[TOC]#sidebar

[^name] Footnotes

fenced block extensions

[snippet:…]

YAML

כותרות

title

status

acl

ארטיפקטים של נתונים

content

CSV

כותרות

title

status

acl

headers

column_ids

datetime

type

ארטיפקטים של נתונים

content

csv

csv_headers

pdl

תבנית מסמך טקסט (`markdown`, `YAML`, `CSV`)

`Markdown`

`title`

`status`

`acl`

`dependencies`

`keywords`

`categories`

`[TOC]#sidebar`

`[^name] Footnotes`

`fenced block extensions`

[`snippet`:…]

`YAML`

`title`

`status`

`acl`

`content`

`CSV`

`title`

`status`

`acl`

`headers`

`column_ids`

`datetime`

`type`

`content`

`csv`

`csv_headers`

`pdl`