Referência do arquivo de pergaminho

Um arquivo de pergaminho é um objeto JSON: os detalhes do pergaminho, seus capítulos de ideias e traduções opcionais. Esta página descreve cada objeto e cada campo que a importação lê.

Downloads

• Arquivo de exemplo: um pergaminho inventado que usa todos os campos comuns, com versões completas nos 15 idiomas da interface.
• Esquema JSON: as mesmas regras em formato legível por máquina (JSON Schema 2020-12), para editores, scripts e agentes de IA. Os limites vêm do mesmo código que a importação executa.

Estrutura

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

Pergaminho (Scroll)

O objeto raiz. No esquema, os outros objetos se chamam Chapter (capítulo), Idea (ideia), Translation (tradução), TranslatedChapter e TranslatedIdea.

Capítulo (Chapter)

Ideia (Idea)

Tradução (Translation)

Cada entrada de translations é uma versão completa do pergaminho naquele idioma. Ela precisa ter os mesmos capítulos, ideias e exemplos do original, na mesma ordem e quantidade.

Um TranslatedChapter tem um title não vazio e ideas com tantas ideias quanto o capítulo original. Uma TranslatedIdea tem um text não vazio e examples com tantas entradas quanto a ideia original, nenhuma vazia. Ideias traduzidas omitem tier: ele vem do original, e um valor diferente é recusado.

Como a importação lê os valores

• O texto é aparado nas duas pontas, e os tamanhos contam os caracteres como você os vê.
• Um campo opcional vazio é tratado como ausente.
• Campos não descritos aqui são ignorados.
• Cada leitor vê a versão do seu idioma e, se não houver, o original.

Exemplo

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

Limites

Erros de importação comuns

• O arquivo não é JSON válido. Peça ao assistente "somente JSON válido" ou procure uma vírgula ou aspas faltando. Remova qualquer texto antes ou depois do objeto JSON.
• Falta o idioma. Acrescente "language" com um código como pt-BR.
• Uma ideia ou exemplo está longo demais. A mensagem indica idioma, capítulo, ideia e exemplo; encurte esse texto.
• Uma tradução não corresponde. Toda versão precisa ter o mesmo número de capítulos, ideias e exemplos, na mesma ordem.
• Ideias demais ou arquivo grande demais. Divida a fonte em dois pergaminhos.
• Você já tem o máximo de pergaminhos. Substitua um de que não precisa mais; veja Editar, substituir e compartilhar.