Zettelmarkup: Inline-Zettel Block

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

An inline-zettel block allows to specify some content with another syntax without creating a new zettel. This is useful, for example, if you want to embed some Markdown content, because you are too lazy to translate Markdown into Zettelmarkup. Another example is to specify HTML code to use it for some kind of web front-end framework.

As all other line-range blocks, an inline-zettel block begins with at least three identical characters, starting at the first position of a line. For inline-zettel blocks, the at-sign character (@, U+0040) is used.

You can add some attributes on the beginning line of a verbatim block, following the initiating characters. The inline-zettel block uses the attribute key syntax to specify the syntax of the inline-zettel. Alternatively, you can use the generic attribute to specify the syntax value. If no value is provided, text is assumed.

Any other character in this first 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 at-sign characters given at the beginning line. This allows to enter some at-sign characters in the text that should not be interpreted at this level.

Some examples:

A link to [this](00001007031200) zettel.

will be rendered as:

A link to this zettel.

If you have set insecure-html to the value zettelmarkup, the following markup is not ignored:

<h1>H1 Heading</h1>
Alea iacta est

will render a section heading of level 1, which is not allowed within Zettelmarkup:

H1 Heading

Alea iacta est

Please note: some HTML code will not be fully rendered because of possible security implications. This include HTML lines that contain a <script> tag or an <iframe> tag.

Of course, you do not need to switch the syntax and you are allowed to nest inline-zettel blocks:

1st level inline
2nd level inline

Transclusion of zettel to enable authentication:

will result in the following HTML output:

1st level inline

2nd level inline

Transclusion of zettel to enable authentication:

To enable authentication, you must create a zettel that stores authentication data for the owner. Then you must reference this zettel within the startup configuration under the key owner. Once the startup configuration contains a valid zettel identifier under that key, authentication is enabled.

Please note that you must also set key secret of the startup configuration to some random string data (minimum length is 16 bytes) to secure the data exchanged with a client system.