Zettelmarkup: Comment Blocks

00001007030900 · Info · (manual) · #manual #zettelmarkup #zettelstore

Comment blocks are quite similar to verbatim blocks: both are used to enter text that should not be interpreted. While the text entered inside a verbatim block will be processed somehow, text inside a comment block will be ignored1. Comment blocks are typically used to give some internal comments, e.g. the license of a text or some internal remarks.

Comment blocks begin with at least three percent sign characters (“%”, U+0025) at the first position of a line. You can add some attributes on the beginning line of a comment block, following the initiating characters. The comment block supports the default attribute: when given, the text will be rendered, e.g. as an HTML comment. When rendered to JSON, the comment block will not be ignored but it will output some JSON text. Same for other renderers.

Any other character in this line will be ignored

Text following the beginning line will not be interpreted, until a line begins with at least the same number of the same characters given at the beginning line. This allows to enter some percent sign characters in the text that should not be interpreted.

For example:

%%%
Comment
  Block
%%%

will be completely ignored, while

%%%{-}
Will be rendered
%%%

will be rendered as some kind of comment2.

  1. Well, not completely ignored: text is read, but it will typically not rendered visible. ↩︎
  2. This cannot be shown here, because a HTML comment will not be rendered visible; it will be in the HTML text. ↩︎