Encoding of Sz Inline Elements

00001012931600 · Info · (manual) · #api #manual #reference #zettelstore (all)

TEXT

Text = (TEXT String ).

Specifies the string as some text content, typically a word.

SPACE

Space = (SPACE [ String ] ).

Specifies some space, typically white space. If the string is not given it is assumed to be " " (one space character). Otherwise it contains the space characters.

SOFT

Soft = (SOFT).

Denotes a soft line break. It is typically translated into a space character, but signals the point in the textual content, where a line break occurred.

HARD

Hard = (HARD).

Specifies a hard line break, i.e. the user wants to have a line break here.

The following lists specify various links, based on the full reference. They all have the same structure, with a trailing sequence of InlineElements that contain the linked text.

InvalidLink = (LINK-INVALID Attributes String InlineElement … ).

The string contains the invalid link specification.

ZettelLink = (LINK-ZETTEL Attributes String InlineElement … ).

The string contains the zettel identifier, a zettel reference.

SelfLink = (LINK-SELF Attributes String InlineElement … ).

The string contains the number sign character and the name of a zettel mark. It reference the same zettel where it occurs.

FoundLink = (LINK-FOUND Attributes String InlineElement … ).

The string contains a zettel identifier, a zettel reference, of a zettel known to be included in the Zettelstore.

BrokenLink = (LINK-BROKEN Attributes String InlineElement … ).

The string contains a zettel identifier, a zettel reference, of a zettel known to be not included in the Zettelstore.

HostedLink = (LINK-HOSTED Attributes String InlineElement … ).

The string contains a link starting with one slash character, denoting an absolute local reference.

BasedLink = (LINK-BASED Attributes String InlineElement … ).

The string contains a link starting with two slash characters, denoting a local reference interpreted relative to the Zettelstore base URL.

QueryLink = (LINK-BASED Attributes String InlineElement … ).

The string contains a query expression.

ExternalLink = (LINK-EXTERNAL Attributes String InlineElement … ).

The string contains a full URL, referencing a resource outside of the Zettelstore server.

EMBED

Embed = (EMBED Attributes Reference String InlineElement … ).

Specifies an embedded element, in most cases some image content or an inline transclusion. A transclusion will only be used, if the zettel content was not evaluated.

Reference denoted the referenced zettel.

If the string value is empty, it is an inline transclusion. Otherwise it contains the syntax of an image.

The InlineElement at the end of the list is interpreted as describing text.

EMBED-BLOB

EmbedBLOB = (EMBED-BLOB Attributes String1 String2 ).

If used if some processed image has to be embedded inside some inline material. The first string specifies the syntax of the image content. The second string contains the image content. If the syntax is “SVG”, the image content is not further encoded. Otherwise a base64 encoding is used.

CITE

CiteBLOB = (CITE Attributes String InlineElement … ).

The string contains the citation key.

MARK

Mark = (MARK String1 String2 String3 InlineElement … ).

The first string is the mark string used in the content. The second string is the mark string transformed to a slug, i.e. transformed to lower case, remove non-ASCII characters. The third string is the slug string, but made unique for the whole zettel. Then follows the marked text as a sequence of InlineElements.

ENDNOTE

Endnote = (ENDNOTE Attributes InlineElement … ).

Specifies endnote / footnote text.

FORMAT-*

The following lists specifies some inline text formatting. The structure is always the same, the initial symbol denotes the actual formatting.

DeleteFormat = (FORMAT-DELETE Attributes InlineElement … ).

The inline text should be treated as deleted.

EmphasizeFormat = (FORMAT-EMPH Attributes InlineElement … ).

The inline text should be treated as emphasized.

InsertFormat = (FORMAT-INSERT Attributes InlineElement … ).

The inline text should be treated as inserted.

MarkFormat = (FORMAT-MARK Attributes InlineElement … ).

The inline text should be treated as highlighted for the reader (but was not important fto the original author).

QuoteFormat = (FORMAT-QUOTE Attributes InlineElement … ).

The inline text should be treated as quoted text.

SpanFormat = (FORMAT-SPAN Attributes InlineElement … ).

The inline text should be treated as belonging together in a certain, yet unspecified way.

SubScriptFormat = (FORMAT-SUB Attributes InlineElement … ).

The inline text should be treated as sub-scripted text.

SuperScriptFormat = (FORMAT-SUPER Attributes InlineElement … ).

The inline text should be treated as super-scripted text.

StrongFormat = (FORMAT-STRONG Attributes InlineElement … ).

The inline text should be treated as strongly emphasized.

LITERAL-*

The following lists specifies some literal text. The structure is always the same, the initial symbol denotes the actual usage.

CodeLiteral = (LITERAL-CODE Attributes String ).

The string contains text that should be treated as executable code.

CommentLiteral = (LITERAL-COMMENT Attributes String ).

The string contains text that should be treated as an internal comment not to be interpreted further.

HTMLLiteral = (LITERAL-HTML Attributes String ).

The string contains text that should be treated as HTML code.

InputLiteral = (LITERAL-INPUT Attributes String ).

The string contains text that should be treated as input entered by an user.

MathLiteral = (LITERAL-MATH Attributes String ).

The string contains text that should be treated as special code to be interpreted as mathematical formulas.

OutputLiteral = (LITERAL-OUTPUT Attributes String ).

The string contains text that should be treated as computer output to be read by an user.

ZettelLiteral = (LITERAL-ZETTEL Attributes String ).

The string contains text that should be treated as (nested) zettel content.