Supported Metadata Keys

00001006020000 · Info · (manual) · #manual #meta #reference #zettel #zettelstore

Although you are free to define your own metadata, by using any key (according to the syntax), some keys have a special meaning that is enforced by Zettelstore. See the computed list of supported metadata keys for details.

Most keys conform to a type.

all-tags
A property (a computed values that is not stored) that contains both the value of tags together with all tags that are specified within the content.
back
Is a property that contains the identifier of all zettel that reference the zettel of this metadata, that are not referenced by this zettel. Basically, it is the value of backward, but without any zettel identifier that is contained in forward.
backward
Is a property that contains the identifier of all zettel that reference the zettel of this metadata. References within invertible values are not included here, e.g. precursor.
box-number
Is a computed value and contains the number of the box where the zettel was found. For all but the predefined zettel, this number is equal to the number X specified in startup configuration key box-uri-X.
copyright
Defines a copyright string that will be encoded. If not given, the value default-copyright from the configuration zettel will be used.
credential

Contains the hashed password, as it was emitted by zettelstore password. It is internally created by hashing the password, the zettel identifier, and the value of the ident key.

It is only used for zettel with a role value of “user”.

dead
Property that contains all references that does not identify a zettel.
duplicates
Is set to the value “true” if there is more than one file that could contain the content of a zettel. Is used for directory boxes and file boxes.
folge
Is a property that contains identifier of all zettel that reference this zettel through the precursor value.
forward
Property that contains all references that identify another zettel within the content of the zettel.
id
Contains the zettel identifier, as given by the Zettelstore. It cannot be set manually, because it is a computed value.
lang
Language for the zettel. Mostly used for HTML rendering of the zettel. If not given, the value default-lang from the configuration zettel will be used. Use values according to the language definition of RFC-5646➚.
license
Defines a license string that will be rendered. If not given, the value default-license from the configuration zettel will be used.
modified

Date and time when a zettel was modified through Zettelstore. If you edit a zettel with an editor software outside Zettelstore, you should set it manually to an appropriate value.

This is a computed value. There is no need to set it via Zettelstore.

no-index
If set to a “true” value, the zettel will not be indexed and therefore not be found in full-text searches.
precursor
References zettel for which this zettel is a “Folgezettel” / follow-up zettel. Basically the inverse of key folge.
published

This property contains the timestamp of the mast modification / creation of the zettel. If modified is set, it contains the same value. Otherwise, if the zettel identifier contains a valid timestamp, the identifier is used. In all other cases, this property is not set.

It can be used for sorting zettel based on their publication date.

It is a computed value. There is no need to set it via Zettelstore.

read-only
Marks a zettel as read-only. The interpretation of supported values for this key depends, whether authentication is enabled or not.
role
Defines the role of the zettel. Can be used for selecting zettel. See supported zettel roles. If not given, the value default-role from the configuration zettel will be used.
syntax
Specifies the syntax that should be used for interpreting the zettel. The zettel about other markup languages defines supported values. If not given, the value default-syntax from the configuration zettel will be used.
tags
Contains a space separated list of tags to describe the zettel further. Each Tag must begin with the number sign character (“#”, U+0023).
title

Specifies the title of the zettel. If not given, the value default-title from the configuration zettel will be used.

You can use all inline-structured elements of Zettelmarkup.

url
Defines an URL / URI for this zettel that possibly references external material. One use case is to specify the document that the current zettel comments on. The URL will be rendered special on the web user interface if you use the default template.
user-id

Provides some unique user identification for a user zettel. It is used as a user name for authentication.

It is only used for zettel with a role value of “user”.

user-role

Defines the basic privileges of an authenticated user, e.g. reading / changing zettel. Is only valid in a user zettel.

See User roles for more details.

visibility

When you work with authentication, you can give every zettel a value to decide, who can see the zettel. Its default value can be set with default-visibility of the configuration zettel.

See visibility rules for zettel for more details.