Vai al contenuto
nectar Documentazione

Documentazione / Riferimento del file della pergamena

Riferimento del file della pergamena

Un file di pergamena è un oggetto JSON: i dettagli della pergamena, i suoi capitoli di idee e traduzioni facoltative. Questa pagina descrive ogni oggetto e ogni campo che l’importazione legge.

Download

  • File di esempio: una pergamena inventata che usa tutti i campi comuni, con versioni complete in tutte le 15 lingue dell’interfaccia.
  • Schema JSON: le stesse regole in forma leggibile dalle macchine (JSON Schema 2020-12), per editor, script e agenti IA. I limiti vengono dallo stesso codice che esegue l’importazione.

Struttura

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

Pergamena (Scroll)

L’oggetto radice. Nello schema gli altri oggetti si chiamano Chapter (capitolo), Idea (idea), Translation (traduzione), TranslatedChapter e TranslatedIdea.

CampoTipoObbligatorioRegoleDescrizione
languagestringsìUn codice lingua come it o pt-BRLa lingua della versione originale. Va bene qualsiasi lingua. Non cambia quando la pergamena viene sostituita.
titlestringnoFino a 255 caratteriIl titolo della pergamena. Senza, si chiama "Untitled".
authorsstring[]noTutti i nomi insieme fino a 255 caratteriI creatori della fonte, in ordine: autori, conduttori o relatori. È accettata anche una singola stringa. Senza nomi compare "Unknown".
descriptionstringnoFino a 600 caratteriDue o tre frasi su ciò che si impara.
tagsstring[]noFino a 5, ciascuno da 1 a 30 caratteri, senza # né virgoleTemi brevi in questa lingua. I tag che differiscono solo per maiuscole, accenti o larghezza contano come uno. Se il campo manca, i tag salvati restano; una lista vuota li cancella.
sourceUrlstringnoUn URL http o https, fino a 2000 caratteriUn link all’originale.
originalYearintegernoDa -3000 all’anno corrente, non 0L’anno di uscita dell’originale. Gli anni negativi sono a.C.
originalPeriodstringnoFino a 80 caratteriQuando è uscito l’originale, per le opere senza un anno preciso, come "V secolo a.C.".
summariesChapter[]sìAlmeno un’idea; fino a 500 idee in tuttoI capitoli, in ordine di lettura.
translationsobjectnoLe chiavi sono codici lingua diversi da languageVersioni complete in altre lingue. Ogni valore è una Translation.

Capitolo (Chapter)

CampoTipoObbligatorioRegoleDescrizione
titlestringnoFino a 200 byteIl titolo del capitolo. Senza, diventa "Chapter N". Il limite conta i byte, quindi negli alfabeti non latini entrano meno caratteri.
ideasIdea[]noLe idee del capitolo, in ordine di lettura.

Idea (Idea)

CampoTipoObbligatorioRegoleDescrizione
textstringsìFino a 400 caratteriL’idea: un pensiero completo, comprensibile sulla propria scheda. Un’idea con testo vuoto viene saltata.
tierstringnoimportant, good o commonQuanto è centrale l’idea. Le idee importanti hanno un aspetto proprio sulla scheda. Se manca o ha un altro valore, vale common.
examplesstring[]noFino a 20, ciascuno fino a 400 caratteriCompaiono scorrendo di lato. Le voci vuote o che non sono testo vengono scartate.

Traduzione (Translation)

Ogni voce di translations è una versione completa della pergamena in quella lingua. Deve avere gli stessi capitoli, idee ed esempi dell’originale, nello stesso ordine e numero.

CampoTipoObbligatorioRegoleDescrizione
titlestringsìNon vuoto, fino a 255 caratteriIl titolo in questa lingua.
authorsstring[]sìNon vuotoI nomi dei creatori come si scrivono in questa lingua.
descriptionstringnoCome nell’originaleLa descrizione in questa lingua.
tagsstring[]noCome nell’originaleTag per chi legge in questa lingua. Non devono ricalcare quelli dell’originale.
originalPeriodstringnoCome nell’originaleIl periodo in questa lingua; senza, si mostra quello dell’originale.
summariesTranslatedChapter[]sìLo stesso numero dell’originaleI capitoli in questa lingua.

Un TranslatedChapter ha un title non vuoto e ideas con tante idee quante il capitolo originale. Una TranslatedIdea ha un text non vuoto ed examples con tante voci quante l’idea originale, nessuna vuota. Le idee tradotte omettono tier: viene dall’originale, e un valore diverso viene rifiutato.

Come l’importazione legge i valori

  • Il testo viene ripulito dagli spazi alle due estremità, e le lunghezze contano i caratteri così come li vedi.
  • Un campo facoltativo vuoto è trattato come assente.
  • I campi non descritti qui vengono ignorati.
  • Chi legge vede la versione nella propria lingua e, se manca, l’originale.

Esempio

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

Limiti

CosaLimite
Idea o esempio400 caratteri
Idee per pergamena500
Esempi per idea20
Titolo, autori255 caratteri
Titolo del capitolo200 byte
Descrizione600 caratteri
Tag5 per lingua, 30 caratteri ciascuno
Contenuto di una lingua1 MB
File caricato8 MB
Pergamene possedute200

Errori di importazione frequenti

  • Il file non è JSON valido. Chiedi all’assistente "solo JSON valido", oppure cerca una virgola o delle virgolette mancanti. Togli qualsiasi testo prima o dopo l’oggetto JSON.
  • Manca la lingua. Aggiungi "language" con un codice come it.
  • Un’idea o un esempio è troppo lungo. Il messaggio indica lingua, capitolo, idea ed esempio; accorcia quel testo.
  • Una traduzione non corrisponde. Ogni versione deve avere lo stesso numero di capitoli, idee ed esempi, nello stesso ordine.
  • Troppe idee o file troppo grande. Dividi la fonte in due pergamene.
  • Possiedi già il numero massimo di pergamene. Sostituiscine una che non ti serve più; vedi Modificare, sostituire e condividere.