Kirjarulli faili viide

Kirjarulli fail on üks JSON-objekt: kirjarulli üksikasjad, selle peatükid koos ideedega ja valikulised tõlked. See lehekülg kirjeldab iga objekti ja välja, mida import loeb.

Allalaadimised

• Näidisfail: väljamõeldud kirjarull, milles on kõik levinud väljad ja täielikud versioonid kõigis 15 liidese keeles.
• JSON-skeem: samad reeglid masinloetaval kujul (JSON Schema 2020-12) redaktoritele, skriptidele ja AI-agentidele. Selle piirangud tulevad samast koodist, mida import kasutab.

Ülesehitus

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

Kirjarull (Scroll)

Juurobjekt. Teised objektid on skeemis Chapter (peatükk), Idea (idee), Translation (tõlge), TranslatedChapter ja TranslatedIdea.

Peatükk (Chapter)

Idee (Idea)

Tõlge (Translation)

Iga kirje objektis translations on kirjarulli täielik versioon selles keeles. Sellel peavad olema samad peatükid, ideed ja näited mis originaalil, samas järjekorras ja arvus.

TranslatedChapter sisaldab mittetühja title ja ideas sama arvu ideedega nagu originaali peatükk. TranslatedIdea sisaldab mittetühja text ja examples sama arvu kirjetega nagu originaali idee, millest ükski pole tühi. Tõlgitud ideedes tier puudub: see tuleb originaalist ja erinev väärtus lükatakse tagasi.

Kuidas import väärtusi loeb

• Tekstil eemaldatakse tühikud mõlemast otsast ja pikkust loetakse märkides nii, nagu neid näed.
• Tühja valikulist välja käsitletakse puuduvana.
• Siin kirjeldamata väljad jäetakse tähelepanuta.
• Lugeja näeb oma keele versiooni ja kui seda pole, siis originaali.

Näide

{
  "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": []
            }
          ]
        }
      ]
    }
  }
}

Piirangud

Sagedased importimisvead

• Fail pole korrektne JSON. Palu assistendilt "ainult korrektset JSON-i" või otsi puuduvat koma või jutumärki. Eemalda kogu tekst enne ja pärast JSON-objekti.
• Keel puudub. Lisa "language" koodiga, näiteks et.
• Idee või näide on liiga pikk. Teade nimetab keele, peatüki, idee ja näite; lühenda seda teksti.
• Tõlge ei sobi. Igal versioonil peab olema sama arv peatükke, ideid ja näiteid samas järjekorras.
• Liiga palju ideid või liiga suur fail. Jaga allikas kaheks kirjarulliks.
• Sul on juba suurim lubatud arv kirjarulle. Asenda üks, mida enam ei vaja; vaata Muuda, asenda ja jaga.