卷軸檔案說明

卷軸檔案是一個 JSON 物件：包含卷軸的詳細資訊、帶有想法的章節，以及選用的翻譯。本頁說明匯入時讀取的每個物件和欄位。

下載

• 範例檔案：一個虛構的卷軸，用到所有常用欄位，並包含介面全部 15 種語言的完整版本。
• JSON Schema：用機器可讀的形式（JSON Schema 2020-12）寫成的同一套規則，供編輯器、腳本和 AI 代理使用。其中的限制與匯入時執行的程式碼來自同一處。

結構

Scroll
├── language, title, authors, description, tags,
│   sourceUrl, originalYear, originalPeriod
├── summaries: Chapter[]
│   └── ideas: Idea[]
│       └── examples: string[]
└── translations: { language: Translation }
    └── summaries: TranslatedChapter[]
        └── ideas: TranslatedIdea[]

卷軸（Scroll）

根物件。在 schema 中，其他物件稱為 Chapter（章節）、Idea（想法）、Translation（翻譯）、TranslatedChapter 和 TranslatedIdea。

章節（Chapter）

想法（Idea）

翻譯（Translation）

translations 中的每一項都是該語言的完整卷軸。章節、想法和範例必須與原始版本順序相同、數量相同。

TranslatedChapter 包含不為空的 title，以及與原章節想法數量相同的 ideas。TranslatedIdea 包含不為空的 text，以及與原想法數量相同、且沒有空白項目的 examples。翻譯後的想法不寫 tier：它取自原始版本，填寫不同的值會被拒絕。

匯入如何讀取值

• 文字會去掉頭尾空格，長度依你看到的字計算。
• 空白的選用欄位視為未填寫。
• 本頁未說明的欄位會被忽略。
• 讀者看到與自己語言相符的版本；沒有時看到原始版本。

範例

{
  "language": "en",
  "title": "Small steps",
  "authors": ["Ada Example"],
  "description": "How small, repeated actions shape what you notice and do.",
  "tags": ["habits", "attention"],
  "sourceUrl": "https://example.org/small-steps",
  "originalYear": 1841,
  "summaries": [
    {
      "title": "Starting small",
      "ideas": [
        {
          "text": "Make the first step so small that you can take it on a bad day.",
          "tier": "important",
          "examples": ["Read one page every evening."]
        },
        {
          "text": "You notice more of what you have decided to look for.",
          "tier": "common",
          "examples": []
        }
      ]
    }
  ],
  "translations": {
    "de": {
      "title": "Kleine Schritte",
      "authors": ["Ada Beispiel"],
      "description": "Wie kleine, wiederholte Handlungen prägen, was wir bemerken und tun.",
      "tags": ["gewohnheiten", "aufmerksamkeit"],
      "summaries": [
        {
          "title": "Klein anfangen",
          "ideas": [
            {
              "text": "Mach den ersten Schritt so klein, dass er dir auch an einem schlechten Tag gelingt.",
              "examples": ["Lies jeden Abend eine Seite."]
            },
            {
              "text": "Du bemerkst mehr von dem, wonach du zu suchen beschlossen hast.",
              "examples": []
            }
          ]
        }
      ]
    }
  }
}

限制

常見匯入錯誤

• 檔案不是有效的 JSON。 請助理「只回覆有效的 JSON」，或檢查是否少了逗號或引號。刪掉 JSON 物件前後的所有文字。
• 缺少語言。 用 zh-TW 這樣的代碼加入 "language"。
• 想法或範例太長。 訊息會指出語言、章節、想法和範例，把那段文字縮短。
• 翻譯對不上。 每個版本的章節、想法和範例數量與順序都必須相同。
• 想法太多或檔案太大。 把來源拆成兩個卷軸。
• 你擁有的卷軸已達上限。 替換一個不再需要的卷軸，請參閱編輯、替換與分享。