Referencia del archivo de pergamino

Un archivo de pergamino es un objeto JSON: los detalles del pergamino, sus capítulos con ideas y traducciones opcionales. Esta página describe cada objeto y cada campo que lee el importador.

Descargas

• Archivo de ejemplo: un pergamino inventado que usa todos los campos habituales, con versiones completas en los 15 idiomas de la interfaz.
• Esquema JSON: las mismas reglas en formato legible por máquinas (JSON Schema 2020-12), para editores, scripts y agentes de IA. Sus límites salen del mismo código que ejecuta el importador.

Estructura

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

Pergamino (Scroll)

El objeto raíz. En el esquema, los demás objetos se llaman Chapter (capítulo), Idea (idea), Translation (traducción), TranslatedChapter y TranslatedIdea.

Capítulo (Chapter)

Idea (Idea)

Traducción (Translation)

Cada entrada de translations es una versión completa del pergamino en ese idioma. Debe tener los mismos capítulos, ideas y ejemplos que el original, en el mismo orden y número.

Un TranslatedChapter tiene un title no vacío e ideas con tantas ideas como el capítulo original. Una TranslatedIdea tiene un text no vacío y examples con tantas entradas como la idea original, ninguna vacía. Las ideas traducidas omiten tier: viene del original, y un valor distinto se rechaza.

Cómo lee los valores el importador

• El texto se recorta por ambos extremos, y las longitudes cuentan los caracteres tal como se ven.
• Un campo opcional vacío se trata como si no estuviera.
• Los campos que no se describen aquí se ignoran.
• Cada lector ve la versión de su idioma y, si no existe, el original.

Ejemplo

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

Límites

Errores de importación frecuentes

• El archivo no es JSON válido. Pide al asistente "solo JSON válido" o busca una coma o unas comillas que falten. Quita cualquier texto antes o después del objeto JSON.
• Falta el idioma. Añade "language" con un código como es.
• Una idea o un ejemplo es demasiado largo. El mensaje indica el idioma, el capítulo, la idea y el ejemplo; acorta ese texto.
• Una traducción no coincide. Cada versión necesita el mismo número de capítulos, ideas y ejemplos, en el mismo orden.
• Demasiadas ideas o un archivo demasiado grande. Divide la fuente en dos pergaminos.
• Ya tienes el máximo de pergaminos. Sustituye uno que ya no necesites; consulta Editar, sustituir y compartir.