Insight Limmud

The .ibe sefer file

An .ibe file is one sefer in a single plain text file. Send it to another person, or write your own in any text editor, and import it into Insight Limmud with its chapters intact. It is UTF-8 JSON. Nothing is zipped.

The smallest working file

Copy this into a text editor, save it as my-shiurim.ibe, and import it.

{
  "format": "insight-limmud-sefer",
  "version": 1,
  "title": "My Shiurim",
  "sections": [
    { "paragraphs": ["First paragraph.", "Second paragraph."] }
  ]
}

What goes in it

Required

  • format: exactly insight-limmud-sefer.
  • version: currently 1.
  • title: the sefer’s name. It must be on one line and must not contain a colon, because a colon is how a chapter and a paragraph are told apart in a reference, as in My Sefer 3:2.
  • sections: the chapters, at least one.

Optional

  • hebrewTitle: the name in Hebrew.
  • direction: "rtl" or "ltr". Left out, the app works it out from the text.
  • categoryPath: a list such as ["Chasidut"]. Treated as a suggestion.
  • author, source, notes.

Each section

  • title (optional): what the chapter is called, for example פרק א׳. Left out, it is numbered “Section 1”, “Section 2” and so on.
  • Its text, as either paragraphs (a list of strings) or text (one string, split into paragraphs on blank lines; lines inside a paragraph are joined). If both are given, paragraphs is used.
  • part (optional): the part of the sefer this section belongs to, for example בראשית on each of the seven aliyos of parshas Bereishis. Give it on every section and the app shows the sefer two levels deep — the parts first, and the sections inside the one you open — which is how a chumash divided by parsha and then by aliyah should read rather than as one list of 378 rows. The sections of a part must be together and in order, and either every section names a part or none does; anything else is refused rather than shown wrong.
  • Blank paragraphs are dropped.

A fuller example

This one has a Hebrew title, a direction, a title on each chapter, and uses paragraphs for one chapter and text for the other.

{
  "format": "insight-limmud-sefer",
  "version": 1,
  "title": "Pirkei Chizuk",
  "hebrewTitle": "פרקי חיזוק",
  "direction": "rtl",
  "categoryPath": ["Chasidut"],
  "author": "A. Cohen",
  "source": "Typed from my own copy",
  "notes": "Chapters one and two only.",
  "sections": [
    {
      "title": "פרק א׳",
      "paragraphs": [
        "ראשית דבר, האדם נברא לעמל.",
        "ומכאן יוצא שכל יום הוא התחלה חדשה."
      ]
    },
    {
      "title": "פרק ב׳",
      "text": "פסקה ראשונה.\n\nפסקה שנייה, אחרי שורה ריקה."
    }
  ]
}

Importing and exporting

  • Import: in the app, use the + button at the top of any library list, then Import a Sefer File. The sefer goes into whichever category you are standing in.
  • Export: open a sefer’s More menu, choose Export…, then Sefer file.

When a file is refused

The app tells you what is wrong. A file is refused if it is not JSON; format is something else; version is higher than the app supports; a required field is missing; the title has a colon or more than one line; sections is empty; a section has no paragraphs; direction is neither rtl nor ltr; or the part fields do not line up — a part that comes back after another has started, or a section with no part among sections that have one.

What it does not carry

Meforshim, links, cycles, bookmarks and reading positions. The file holds the sefer’s own text and structure only.

Back to Insight Limmud