Zum Inhalt springen
nectar Dokumentation

Dokumentation / Referenz der Scroll-Datei

Referenz der Scroll-Datei

Eine Scroll-Datei ist ein JSON-Objekt: die Angaben zum Scroll, seine Kapitel mit Ideen und optionale Übersetzungen. Diese Seite beschreibt jedes Objekt und jedes Feld, das der Import liest.

Downloads

  • Beispieldatei: ein erfundener Scroll, der alle gängigen Felder nutzt, mit vollständigen Fassungen in allen 15 Sprachen der Oberfläche.
  • JSON-Schema: dieselben Regeln maschinenlesbar (JSON Schema 2020-12), für Editoren, Skripte und KI-Agenten. Die Grenzen stammen aus demselben Code, den der Import ausführt.

Aufbau

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

Scroll

Das Wurzelobjekt. Die anderen Objekte heißen im Schema Chapter (Kapitel), Idea (Idee), Translation (Übersetzung), TranslatedChapter und TranslatedIdea.

FeldTypPflichtRegelnBeschreibung
languagestringjaEin Sprachcode wie de oder pt-BRDie Sprache der Originalfassung. Jede Sprache ist möglich. Sie ändert sich nicht, wenn der Scroll ersetzt wird.
titlestringneinBis zu 255 ZeichenDer Titel des Scrolls. Ohne ihn heißt er "Untitled".
authorsstring[]neinAlle Namen zusammen bis zu 255 ZeichenDie Urheber der Quelle in Reihenfolge: Autoren, Moderatoren oder Sprecher. Ein einzelner String geht auch. Ohne Namen steht dort "Unknown".
descriptionstringneinBis zu 600 ZeichenZwei oder drei Sätze darüber, was man lernt.
tagsstring[]neinBis zu 5, je 1 bis 30 Zeichen, ohne # und KommasKurze Themen in dieser Sprache. Tags, die sich nur in Groß- und Kleinschreibung, Akzenten oder Breite unterscheiden, zählen als einer. Fehlt das Feld, bleiben die gespeicherten Tags erhalten; eine leere Liste löscht sie.
sourceUrlstringneinEine http- oder https-URL, bis zu 2000 ZeichenEin Link zum Original.
originalYearintegerneinVon -3000 bis zum laufenden Jahr, nicht 0Das Erscheinungsjahr des Originals. Negative Jahre sind v. Chr.
originalPeriodstringneinBis zu 80 ZeichenWann das Original erschien, für Werke ohne genaues Jahr, etwa "5. Jahrhundert v. Chr.".
summariesChapter[]jaMindestens eine Idee, insgesamt bis zu 500 IdeenDie Kapitel in Lesereihenfolge.
translationsobjectneinSchlüssel sind Sprachcodes außer languageVollständige Fassungen in anderen Sprachen. Jeder Wert ist eine Translation.

Kapitel (Chapter)

FeldTypPflichtRegelnBeschreibung
titlestringneinBis zu 200 BytesDer Titel des Kapitels. Ohne ihn wird daraus "Chapter N". Die Grenze zählt Bytes, in nichtlateinischen Schriften passen also weniger Zeichen hinein.
ideasIdea[]neinDie Ideen des Kapitels in Lesereihenfolge.

Idee (Idea)

FeldTypPflichtRegelnBeschreibung
textstringjaBis zu 400 ZeichenDie Idee: ein vollständiger Gedanke, der auf seiner eigenen Karte verständlich ist. Eine Idee mit leerem Text wird übersprungen.
tierstringneinimportant, good oder commonWie zentral die Idee ist. Wichtige Ideen haben auf der Karte ein eigenes Aussehen. Fehlt der Wert oder ist er ein anderer, gilt common.
examplesstring[]neinBis zu 20, je bis zu 400 ZeichenErscheinen beim seitlichen Wischen. Leere Einträge und Einträge, die kein Text sind, werden verworfen.

Übersetzung (Translation)

Jeder Eintrag in translations ist eine vollständige Fassung des Scrolls in dieser Sprache. Er muss dieselben Kapitel, Ideen und Beispiele wie das Original haben, in derselben Reihenfolge und Anzahl.

FeldTypPflichtRegelnBeschreibung
titlestringjaNicht leer, bis zu 255 ZeichenDer Titel in dieser Sprache.
authorsstring[]jaNicht leerDie Namen der Urheber, wie sie in dieser Sprache geschrieben werden.
descriptionstringneinWie im OriginalDie Beschreibung in dieser Sprache.
tagsstring[]neinWie im OriginalTags für Leser dieser Sprache. Sie müssen die des Originals nicht spiegeln.
originalPeriodstringneinWie im OriginalDer Zeitraum in dieser Sprache; ohne ihn wird der des Originals gezeigt.
summariesTranslatedChapter[]jaDieselbe Anzahl wie im OriginalDie Kapitel in dieser Sprache.

Ein TranslatedChapter hat einen nicht leeren title und ideas mit so vielen Ideen wie das Kapitel im Original. Eine TranslatedIdea hat einen nicht leeren text und examples mit so vielen Einträgen wie die Idee im Original, keiner davon leer. Übersetzte Ideen lassen tier weg: Er kommt aus dem Original, und ein abweichender Wert wird abgelehnt.

Wie der Import Werte liest

  • Text wird an beiden Enden getrimmt, und Längen zählen Zeichen so, wie man sie sieht.
  • Ein leeres optionales Feld gilt als nicht vorhanden.
  • Felder, die hier nicht beschrieben sind, werden ignoriert.
  • Leser sehen die Fassung in ihrer Sprache und, wenn es keine gibt, das Original.

Beispiel

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

Grenzen

WasGrenze
Idee oder Beispiel400 Zeichen
Ideen pro Scroll500
Beispiele pro Idee20
Titel, Autoren255 Zeichen
Kapiteltitel200 Bytes
Beschreibung600 Zeichen
Tags5 pro Sprache, je 30 Zeichen
Inhalt einer Sprache1 MB
Hochgeladene Datei8 MB
Eigene Scrolls200

Häufige Importfehler

  • Die Datei ist kein gültiges JSON. Bitte den Assistenten um "nur gültiges JSON" oder such nach einem fehlenden Komma oder Anführungszeichen. Entferne jeden Text vor oder nach dem JSON-Objekt.
  • Die Sprache fehlt. Ergänze "language" mit einem Code wie de.
  • Eine Idee oder ein Beispiel ist zu lang. Die Meldung nennt Sprache, Kapitel, Idee und Beispiel; kürze diesen Text.
  • Eine Übersetzung passt nicht. Jede Fassung braucht dieselbe Zahl an Kapiteln, Ideen und Beispielen in derselben Reihenfolge.
  • Zu viele Ideen oder eine zu große Datei. Teile die Quelle auf zwei Scrolls auf.
  • Du besitzt schon die Höchstzahl an Scrolls. Ersetze einen, den du nicht mehr brauchst; siehe Bearbeiten, ersetzen und teilen.