Layout of a Zettel

00001006000000 · Info · (manual) · #design #manual #zettelstore

A zettel consists of two parts: the metadata and the zettel content. Metadata gives some information mostly about the zettel content, how it should be interpreted, how it is sorted within Zettelstore. The zettel content is, well, the actual content. In many cases, the content is in plain text form. Plain text is long-lasting. However, content in binary format is also possible.

Metadata has to conform to a special syntax. It is effectively a collection of key/value pairs. Some keys have a special meaning and most of the predefined keys need values of a specific type.

Each zettel is given a unique identifier. To some degree, the zettel identifier is part of the metadata..

The zettel content is your valuable content. Zettelstore contains some predefined parsers that interpret the zettel content to the syntax of the zettel. This includes markup languages, like Zettelmarkup and CommonMark➚. Other text formats are also supported, like CSS and HTML templates. Plain text content is always Unicode, encoded as UTF-8. Other character encodings are not supported and will never be1. There is support for a graphical format with a text represenation: SVG. And there is support for some binary image formats, like GIF, PNG, and JPEG.

  1. This is not a real problem, since every modern software should support UTF-8 as an encoding. ↩︎