İçeriğe geç
nectar Belgeler

Belgeler / Parşömen dosyası başvurusu

Parşömen dosyası başvurusu

Bir parşömen dosyası tek bir JSON nesnesidir: parşömenin ayrıntıları, fikirleriyle bölümleri ve isteğe bağlı çeviriler. Bu sayfa, içe aktarmanın okuduğu her nesneyi ve alanı açıklar.

İndirmeler

  • Örnek dosya: yaygın alanların tümünü kullanan, arayüzün 15 dilinin hepsinde tam sürümleri olan uydurma bir parşömen.
  • JSON şeması: aynı kurallar makinenin okuyabileceği biçimde (JSON Schema 2020-12); editörler, betikler ve yapay zekâ ajanları için. Sınırları, içe aktarmanın çalıştırdığı kodun kendisinden gelir.

Yapı

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

Parşömen (Scroll)

Kök nesne. Şemada diğer nesnelerin adı Chapter (bölüm), Idea (fikir), Translation (çeviri), TranslatedChapter ve TranslatedIdea'dır.

AlanTürZorunluKurallarAçıklama
languagestringevettr veya pt-BR gibi bir dil koduÖzgün sürümün dili. Her dil olur. Parşömen değiştirildiğinde değişmez.
titlestringhayırEn fazla 255 karakterParşömenin başlığı. Yoksa "Untitled" olur.
authorsstring[]hayırTüm adlar birlikte en fazla 255 karakterKaynağı yapanlar, sırayla: yazarlar, sunucular veya konuşmacılar. Tek bir metin de kabul edilir. Ad yoksa "Unknown" gösterilir.
descriptionstringhayırEn fazla 600 karakterOkuyucunun ne öğreneceğini anlatan iki üç cümle.
tagsstring[]hayırEn fazla 5, her biri 1 ile 30 karakter arası, # ve virgül olmadanBu dilde kısa konular. Yalnızca büyük-küçük harf, aksan veya genişlikle ayrılan etiketler tek sayılır. Alan yoksa kayıtlı etiketler korunur; boş liste onları siler.
sourceUrlstringhayırhttp veya https adresi, en fazla 2000 karakterÖzgün esere bağlantı.
originalYearintegerhayır-3000 ile bu yıl arası, 0 değilÖzgün eserin çıktığı yıl. Negatif yıllar MÖ'dür.
originalPeriodstringhayırEn fazla 80 karakterKesin yılı olmayan eserler için ne zaman çıktığı, örneğin "MÖ 5. yüzyıl".
summariesChapter[]evetEn az bir fikir; toplam en fazla 500 fikirOkuma sırasına göre bölümler.
translationsobjecthayırAnahtarlar language dışındaki dil kodlarıdırBaşka dillerdeki tam sürümler. Her değer bir Translation'dır.

Bölüm (Chapter)

AlanTürZorunluKurallarAçıklama
titlestringhayırEn fazla 200 baytBölümün başlığı. Yoksa "Chapter N" olur. Sınır baytları sayar; bu yüzden Latin olmayan alfabelerde daha az karakter sığar.
ideasIdea[]hayırBölümün fikirleri, okuma sırasıyla.

Fikir (Idea)

AlanTürZorunluKurallarAçıklama
textstringevetEn fazla 400 karakterFikrin kendisi: kendi kartında anlaşılan tam bir düşünce. Metni boş fikir atlanır.
tierstringhayırimportant, good veya commonFikrin ne kadar merkezi olduğu. Önemli fikirlerin kartta kendine özgü bir görünümü vardır. Değer yoksa veya başka bir değerse common sayılır.
examplesstring[]hayırEn fazla 20, her biri en fazla 400 karakterYana kaydırınca görünür. Boş ve metin olmayan girdiler atılır.

Çeviri (Translation)

translations içindeki her girdi, parşömenin o dildeki tam sürümüdür. Özgün sürümle aynı bölümleri, fikirleri ve örnekleri aynı sırada ve sayıda içermelidir.

AlanTürZorunluKurallarAçıklama
titlestringevetBoş değil, en fazla 255 karakterBu dildeki başlık.
authorsstring[]evetBoş değilYapanların adları, bu dilde yazıldığı biçimiyle.
descriptionstringhayırÖzgündeki gibiBu dildeki açıklama.
tagsstring[]hayırÖzgündeki gibiBu dilin okuyucuları için etiketler. Özgündekileri tekrarlamaları gerekmez.
originalPeriodstringhayırÖzgündeki gibiBu dildeki dönem; yoksa özgündeki gösterilir.
summariesTranslatedChapter[]evetÖzgündekiyle aynı sayıdaBu dildeki bölümler.

Bir TranslatedChapter, boş olmayan bir title ve özgün bölümdeki kadar fikir içeren ideas taşır. Bir TranslatedIdea, boş olmayan bir text ve özgün fikirdeki kadar girdisi olan, hiçbiri boş olmayan examples taşır. Çevrilmiş fikirlerde tier yazılmaz: özgünden gelir ve farklı bir değer reddedilir.

İçe aktarma değerleri nasıl okur

  • Metnin iki ucundaki boşluklar kırpılır ve uzunluklar karakterleri göründükleri gibi sayar.
  • Boş bir isteğe bağlı alan yokmuş gibi sayılır.
  • Burada açıklanmayan alanlar yok sayılır.
  • Okuyucular kendi dillerindeki sürümü, o yoksa özgün sürümü görür.

Örnek

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

Sınırlar

NeSınır
Fikir veya örnek400 karakter
Parşömen başına fikir500
Fikir başına örnek20
Başlık, yazarlar255 karakter
Bölüm başlığı200 bayt
Açıklama600 karakter
EtiketlerDil başına 5, her biri 30 karakter
Bir dilin içeriği1 MB
Yüklenen dosya8 MB
Sahip olunan parşömen200

Sık görülen içe aktarma hataları

  • Dosya geçerli JSON değil. Asistandan "yalnızca geçerli JSON" isteyin ya da eksik bir virgül veya tırnak arayın. JSON nesnesinden önceki veya sonraki her metni silin.
  • Dil eksik. tr gibi bir kodla "language" ekleyin.
  • Bir fikir veya örnek çok uzun. Mesaj dili, bölümü, fikri ve örneği belirtir; o metni kısaltın.
  • Bir çeviri uyuşmuyor. Her sürümde aynı sayıda bölüm, fikir ve örnek aynı sırada olmalıdır.
  • Çok fazla fikir ya da çok büyük dosya. Kaynağı iki parşömene bölün.
  • Zaten en fazla parşömene sahipsiniz. Artık gerekmeyen birini değiştirin; bkz. Düzenle, değiştir ve paylaş.