Jump to content

E-Journal Format

From wiki.rayhan.com

This is an as-yet-untitled format definition for an enotebook format.

Some tenets:

1. Should be "unpackable" and editable using regular, available tools in their category. For example:

  • Zip/Unzip
  • Tar/Untar
    • Maybe less preferred, if not supported by Windows or macOS (latest).

2. The root directory has a .enotebook file:

  • JSON format

{
  "meta": {
    "version": "0.1,
  },
  "width": 1404
}

Note: The width is arbitrary, but should be supported by all "page part" formats when used on the latest macOS, Windows, and Ubuntu Linux LTS. 1404px was chosen because both Remarkable2 and Mobiscribe Wave have that width, so it's a sane default (for now).

"Page part" formats

1. Acceptable "page part" formats:

  • PNG
  • BMP

Being considered: - UTF-8 plaintext

2. The contents should be browsable and editable by a person using regular, available tools in their category.

  • Directory structure: ./my-journal/page {all-uppercase alpha string, sorts to the correct order to reconstruct the page}.png

3. It should be a reasonable task to build a tool that checks that all page-parts to make sure they are the correct width, as defined in the