(zettel (meta (back "00001012931400") (backward "00001012931400 00001012931600") (box-number "1") (created "20230405123046") (forward "00001012931600") (modified "20240122094720") (published "20240122094720") (role "manual") (syntax "zmk") (tags "#api #manual #reference #zettelstore") (title "Encoding of Sz Reference Values")) (rights 4) (encoding "") (content "A reference is encoded as the actual reference value, and a symbol describing the state of that actual reference value.\n\n:::syntax\n__Reference__ **=** ''('' __ReferenceState__ String '')''.\n:::\nThe string contains the actual reference value.\n\n:::syntax\n__ReferenceState__ **=** ''INVALID'' **|** ''ZETTEL'' **|** ''SELF'' **|** ''FOUND'' **|** ''BROKEN'' **|** ''HOSTED'' **|** ''BASED'' **|** ''QUERY'' **|** ''EXTERNAL''.\n:::\n\nThe meaning of the state symbols corresponds to that of the symbols used for the description of [[link references|00001012931600#link]].\n\n; ''INVALID''\n: The reference value is invalid.\n; ''ZETTEL''\n: The reference value is a reference to a zettel.\n  This value is only possible before evaluating the zettel.\n; ''SELF''\n: The reference value is a reference to the same zettel, to a specific mark.\n; ''FOUND''\n: The reference value is a valid reference to an existing zettel.\n  This value is only possible after evaluating the zettel.\n; ''BROKEN''\n: The reference value is a valid reference to an missing zettel.\n  This value is only possible after evaluating the zettel.\n; ''HOSTED''\n: The reference value starts with one slash character, denoting an absolute local reference.\n; ''BASED''\n: The reference value starts with two slash characters, denoting a local reference interpreted relative to the Zettelstore base URL.\n; ''QUERY''\n: The reference value contains a query expression.\n; ''EXTERNAL''\n: The reference value contains a full URL, referencing a resource outside of the Zettelstore server."))