"toolbutton": { "group": "links", "icon": "literature"}

• Alt+N
• Ctrl+Shift+A
• F9

• text: A standalone tag, for example, a dedicated symbol for word separators in transcriptions. In the output, the values of the keys html_prefix, html_content, and html_postfix are concatenated. Alternatively, the value of an attribute can be used, for example, to output URLs, see the attributes configuration below.
• format: The text is formatted, for example in italics or as bold text.
• bracket: The text is placed in brackets. The html_prefix value is used as opening bracket, the html_postfix value as closing bracket.
• attribute: A configuration used in the attributes key of molecular annotations, without a tag on its own.
• group: A configuration used exclusively for grouping (drop-down tool button, colours of annotation groups).
• break: A line break rendered as br tag.
• character: A special character added to the character toolbar (see below for special characters configuration).

• caption: A label for input fields in edit mode.
• default (optional): The default value in input fields and for rendering when the attribute is empty.
• render (optional): Attribute values can be rendered as brackets or standalone elements, based on the following values:
  • text: For standalone elements with the tag type `text`, the attribute value is used instead of html_content.
  • With the specification attribute, the attribute is output as an attribute.
  • prefix or postfix: For brackets, the attribute value is used as opening or closing bracket.
• repeat (optional): If the attribute contains a number, you can define a value in the repeat key. For rendering, the repeat value will be output the times given in the attribute. If the attribute is empty or contains the number 0, the value given in default is rendered one time.
• values (optional): Either a regular expression or a list or an object, depending on the input key setting.
  • A regular expression is used to restrict the permitted values in text fields. For example, [0-9]+ restricts the values to numbers.
  • For select inputs, a list of available values can be used, for example ["lost", "omitted", "ellipsis"].
  • For select inputs, an object with keys to be used as values in the XML attribute and values used as labels in the input, for example: {"lost": "Lost","ellipsis": "omission"}
  • For checkbox inputs, an object with two states. The first key is used when the checkbox is not activated, the second key when it is activated. The checkbox label is taken from the first value.
• input (optional):
  • text (default): A text input field.
  • select: A combobox input based on the values key.
  • checkbox: A checkbox input based on the values key.
  • link: For molecular annotations, a select input used to choose from property entities. Must be used in combination with the type key to determine the target property type.
• type (optional): Used in conjunction with link inputs to create molecular annotations. Provide the name of the links configuration that defines a target property type in its `to` field configuration.
• title (optional): A brief help text.

• name: The name field of a footnote entity contains the footnote number. To render the footnote number, provide an object with the following keys:
  • format must be set to the value `counter`.
  • render: Define one of `prefix`, `text` or `postfix` to push the number to the rendering of one of those components.
  • counter: The number type, one of the following values:
    • numeric: A usual number.
    • alphabetic: A latin letter (variants: alphabetic-lower, alphabetic-upper)
    • roman: A roman numeral (variants: roman-lower, roman-upper)
    • greek: A greek number (variants: greek-lower, greek-upper)
• segment and content: Field configuration objects for the fields holding footnote text and a reference text. The format subkey must be set to "xml". Configure the permitted annotations in the types subkey by providing a list containing annotation names and group names. The caption subkey can be used to set a heading. If the autofill subkey is set to true, the selected text is transferred to this field when a footnote is inserted. Alternatively, autofill can be set to an object with the keys `prefix` (the value is prefixed), `postfix` (the value is suffixed) and `wrap` (a link type name that is used to create an enclosing tag, e.g. `quot`).

• to: The target field configuration restricting what kind of links are allowed. Each link is part of a root entity and has a source. The source is either a tag in an XML field of the root entity (e.g. an article) or in one of its parts (e.g. an item in a section of an article). The target can be any other entity, in the database, the target reference is stored in a pair of `to_tab` and `to_id` columns. Thus, from the perspective of a root entity, there are external links (e.g. a link from article content to a property) and internal links (e.g. a link from one section to another section within the article). The format subkey must be set to "record" for external links and to "relation" for internal links. The required subkey can be set to "true" to force a selection in the editor. The manage subkey can be set to "true" to allow editors to quickly access and manage respective categories. The limit subkey can be set to either "article" opposed to the standard "project" to restrict the annotation selection to entities present in the current article (useful for working with categories such as person names). The targets subkey further specifies what can be referenced:
  • articles: Permitted values are "internal" for internal references and "external" for references to other articles.
  • sections: If the link target should be a section, provide a list of allowed section types.
  • items: If the link target should be an item, provide a list of allowed item types.
  • properties: If the link target should be a property, provide a list of allowed property types.
  • footnotes: If the link target should be a footnote, provide a list of allowed footnote types.

For bracket tags, the value used for the opening bracket.

For text tags, this value is prefixed to the value given in the `html_content` key.

For bracket tags, the value used for the closing bracket.

For text tags, the value is appended to the `html_content` value.

Depending on the output format, tags are rendered differently: HTML requires tags, whereas Markdown and full-text search should not contain tags.

In the html, md and txt keys, rendering objects with the keys `tag_type`, `tag`, `prefix`, `content` and `postfix` can be provided. These override the default settings for the respective formats. This way, for example, the rendering of a paragraph can be changed from tag_type "bracket" for the default HTML rendering to "format" for Markdown rendering in order to hide the markup.

Example to create a break after a tag:

.xml_tag_vz:after {content: "\\A" ; white-space: pre;}

Annotation groups can be hidden with the settings button next to input fields. This will not really hide the content of all tags in the group. Instead it adds a css class following the pattern `.xml_group_<groupname>_unadorned` to the container which allows you to provide simplified unobstrusive styling. For example, you can change the color from blue to the default black color. Provide default rendering in the `default` subkey and rendering for the unselected state in the `unadorned` subkey.

Example: Small caps configured in a links configuration named `k` that appear as normal text when the text group has been unselected.

{
  "default": ".xml_tag_k {
    color: #1ccaaa;
    font-size: 1em;
    font-variant: small-caps }",
  "unadorned": ".xml_group_text_unadorned .xml_tag_k {
    color: inherit;
    font-size: inherit;
    font-variant: inherit; }"
}

  "toolbutton": {
    "group": "links",
    "icon": "reference",
    "dropdown": true
  }