(zettel (meta (back "00001012931400") (backward "00001012931000 00001012931400 00001012931600 00001012931900") (box-number "1") (created "20230403161845") (forward "00001007700000 00001012931000 00001012931600 00001012931900") (modified "20240620170546") (published "20240620170546") (role "manual") (syntax "zmk") (tags "#api #manual #reference #zettelstore") (title "Encoding of Sz Inline Elements")) (rights 4) (encoding "") (content "=== ''TEXT''\n:::syntax\n__Text__ **=** ''(TEXT'' String '')''.\n:::\nSpecifies the string as some text content, including white space characters.\n\n=== ''SOFT''\n:::syntax\n__Soft__ **=** ''(SOFT)''.\n:::\nDenotes a soft line break.\nIt will be often encoded as a space character, but signals the point in the textual content, where a line break occurred.\n\n=== ''HARD''\n:::syntax\n__Hard__ **=** ''(HARD)''.\n:::\nSpecifies a hard line break, i.e. the user wants to have a line break here.\n\n=== ''LINK-*''\nThe following lists specify various links, based on the full reference.\nThey all have the same structure, with a trailing sequence of __InlineElements__ that contain the linked text.\n\n:::syntax\n__InvalidLink__ **=** ''(LINK-INVALID'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains the invalid link specification.\n\n:::syntax\n__ZettelLink__ **=** ''(LINK-ZETTEL'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains the zettel identifier, a zettel reference.\n\n:::syntax\n__SelfLink__ **=** ''(LINK-SELF'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains the number sign character and the name of a zettel mark.\nIt reference the same zettel where it occurs.\n\n:::syntax\n__FoundLink__ **=** ''(LINK-FOUND'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a zettel identifier, a zettel reference, of a zettel known to be included in the Zettelstore.\n\n:::syntax\n__BrokenLink__ **=** ''(LINK-BROKEN'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a zettel identifier, a zettel reference, of a zettel known to be __not__ included in the Zettelstore.\n\n:::syntax\n__HostedLink__ **=** ''(LINK-HOSTED'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a link starting with one slash character, denoting an absolute local reference.\n\n:::syntax\n__BasedLink__ **=** ''(LINK-BASED'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a link starting with two slash characters, denoting a local reference interpreted relative to the Zettelstore base URL.\n\n:::syntax\n__QueryLink__ **=** ''(LINK-BASED'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a [[query expression|00001007700000]].\n\n:::syntax\n__ExternalLink__ **=** ''(LINK-EXTERNAL'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains a full URL, referencing a resource outside of the Zettelstore server.\n\n=== ''EMBED''\n:::syntax\n__Embed__ **=** ''(EMBED'' [[__Attributes__|00001012931000#attribute]] [[__Reference__|00001012931900]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nSpecifies an embedded element, in most cases some image content or an inline transclusion.\nA transclusion will only be used, if the zettel content was not evaluated.\n\n__Reference__ denoted the referenced zettel.\n\nIf the string value is empty, it is an inline transclusion.\nOtherwise it contains the syntax of an image.\n\nThe __InlineElement__ at the end of the list is interpreted as describing text.\n\n=== ''EMBED-BLOB''\n:::syntax\n__EmbedBLOB__ **=** ''(EMBED-BLOB'' [[__Attributes__|00001012931000#attribute]] String,,1,, String,,2,, '')''.\n:::\nIf used if some processed image has to be embedded inside some inline material.\nThe first string specifies the syntax of the image content.\nThe second string contains the image content.\nIf the syntax is \"\"SVG\"\", the image content is not further encoded.\nOtherwise a base64 encoding is used.\n\n=== ''CITE''\n:::syntax\n__CiteBLOB__ **=** ''(CITE'' [[__Attributes__|00001012931000#attribute]] String [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe string contains the citation key.\n\n=== ''MARK''\n:::syntax\n__Mark__ **=** ''(MARK'' String,,1,, String,,2,, String,,3,, [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe first string is the mark string used in the content.\nThe second string is the mark string transformed to a slug, i.e. transformed to lower case, remove non-ASCII characters.\nThe third string is the slug string, but made unique for the whole zettel.\nThen follows the marked text as a sequence of __InlineElement__s.\n\n=== ''ENDNOTE''\n:::syntax\n__Endnote__ **=** ''(ENDNOTE'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nSpecifies endnote / footnote text.\n\n=== ''FORMAT-*''\nThe following lists specifies some inline text formatting.\nThe structure is always the same, the initial symbol denotes the actual formatting.\n\n:::syntax\n__DeleteFormat__ **=** ''(FORMAT-DELETE'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as deleted.\n\n:::syntax\n__EmphasizeFormat__ **=** ''(FORMAT-EMPH'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as emphasized.\n\n:::syntax\n__InsertFormat__ **=** ''(FORMAT-INSERT'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as inserted.\n\n:::syntax\n__MarkFormat__ **=** ''(FORMAT-MARK'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as highlighted for the reader (but was not important fto the original author).\n\n:::syntax\n__QuoteFormat__ **=** ''(FORMAT-QUOTE'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as quoted text.\n\n:::syntax\n__SpanFormat__ **=** ''(FORMAT-SPAN'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as belonging together in a certain, yet unspecified way.\n\n:::syntax\n__SubScriptFormat__ **=** ''(FORMAT-SUB'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as sub-scripted text.\n\n:::syntax\n__SuperScriptFormat__ **=** ''(FORMAT-SUPER'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as super-scripted text.\n\n:::syntax\n__StrongFormat__ **=** ''(FORMAT-STRONG'' [[__Attributes__|00001012931000#attribute]] [[__InlineElement__|00001012931600]] … '')''.\n:::\nThe inline text should be treated as strongly emphasized.\n\n=== ''LITERAL-*''\nThe following lists specifies some literal text.\nThe structure is always the same, the initial symbol denotes the actual usage.\n\n:::syntax\n__CodeLiteral__ **=** ''(LITERAL-CODE'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as executable code.\n\n:::syntax\n__CommentLiteral__ **=** ''(LITERAL-COMMENT'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as an internal comment not to be interpreted further.\n\n:::syntax\n__HTMLLiteral__ **=** ''(LITERAL-HTML'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as HTML code.\n\n:::syntax\n__InputLiteral__ **=** ''(LITERAL-INPUT'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as input entered by an user.\n\n:::syntax\n__MathLiteral__ **=** ''(LITERAL-MATH'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as special code to be interpreted as mathematical formulas.\n\n:::syntax\n__OutputLiteral__ **=** ''(LITERAL-OUTPUT'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as computer output to be read by an user.\n\n:::syntax\n__ZettelLiteral__ **=** ''(LITERAL-ZETTEL'' [[__Attributes__|00001012931000#attribute]] String '')''.\n:::\nThe string contains text that should be treated as (nested) zettel content."))