Annotationen & Apparate

Shortcut zum Einfügen der Annotation. Beispiele:

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

Die Möglichkeiten sind durch den CKEditor vorgegeben.

Ein Objekt mit der Konfiguration des Toolbuttons. Beispiel für Verweis auf Literatur:

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

Die Konfiguration kann in einfachen Fällen abgekürzt werden: 

1. Boolean-Wert (false|true): Standardmäßig erhält jede Annotation einen eigenen Button in der Toolbar (true). Um keinen Button zu erzeugen, wird der Schlüssel auf false gesetzt. Das ist beispielsweise der Fall bei Sonderzeichen, die keinen eigenen Button bekommen, sondern im Sonderzeichen-Dropdown landen sollen (siehe unten). Entspricht dem Schlüssel enable in der Vollkonfiguration.

2. String: Beschriftung des Toolbuttons, zum Beispiel [abc] oder ein Unicode-Symbol. Entspricht dem Schlüssel symbol in der Vollkonfiguration.

Wie wird das Tag bei der Ausgabe dargestellt? Soll ausschließlich ein Dropdown-Toolbutton erzeugt werden, wird der Schlüssel weggelassen.

• text: Ein alleinstehendes Tag. Die Werte der Schlüssel html_prefix, html_content und html_postfix werden zusammengefügt und ausgegeben, zum Beispiel ein festgelegtes Symbol für Worttrenner. Alternativ kann der Wert eines Attributs ausgelesen werden, zum Beispiel um URLs auszugeben, siehe unten die attributes-Konfiguration.
• format: Der Text wird formatiert, zum Beispiel kursiviert.
• bracket: Der Text wird geklammert. Vor dem Text wird dazu Der in html_prefix angegebene Wert ausgegeben, nach dem Text der Wert aus html_postfix.
• break: Es handelt sich um einen Zeilenumbruch, der in ein br-Tag umgewandelt werden soll. 
• character: Es handelt sich nicht um ein Tag, sondern um ein Sonderzeichen (siehe unten zur Konfiguration von Sonderzeichen).

Optional ein Objekt mit der Konfiguration von Attributen. Jeder Schlüssel ist ein Attributname, der Wert enthält wiederum die folgenden Schlüssel:

• caption: Eine Beschriftung des Attributs in Eingabefeldern, mit denen das Attribut bearbeitet wird.
• default (optional): In Eingabefeldern der Standardwert.
• render (optional): Attributwerte können als Klammern und alleinstehende Elemente ausgegeben werden. 
  • Mit der Angabe text wird für alleinstehende Elemente (tag_type text) der Attributwert statt html_content ausgegeben. 
  • Für Klammern kann der Attributwert über die Angabe prefix bzw. postfix in die öffnende bzw. schließende Klammer übertragen werden. 
  • Mit der Angabe attribute wird das Attribut als Attribut ausgegeben. 
  • Ohne Angabe wird das Attribut nicht gerendert.
• default (optional): Standardwert, wenn Attribute in Klammern und Elementen ausgegeben werden und das Attribut leer ist.
• repeat (optional): der Wert wird so oft ausgegeben, wie im Attribut angegeben. Das Attribut muss dazu eine Zahl enthalten. Ist das Attribut leer oder enthält die Zahl 0, dann wird der Wert in default ausgegeben.
• values (optional): Entweder ein regulärer Ausdruck oder eine Liste oder ein Objekt, abhängig von der Einstellung im input-Schlüssel.
  • Mit einem regulären Ausdruck werden die erlaubten Werte in Textfeldern eingeschränkt. Beispielsweise wird mit [0-9]+ auf Zahlen eingeschränkt. 
  • Eine Liste enthält Werte, die zur Auswahl bereitgestellt werden, zum Beispiel ["lost", "omitted", "ellipsis"]. Sollen in der Auswahlliste andere Beschriftungen verwendet werden, kann ein Objekt angegeben werden, wobei die im Element gespeicherten Werte in den Schlüsseln und die Beschriftungen als Werte angegeben werden, zum Beispiel: {"lost": "Verloren","ellipsis": "Auslassung"}. 
  • Soll eine Checkbox ausgegeben werden, müssen im Objekt die Werte für eine aktivierte und deaktivierte Checkbox angegeben werden. Der erste Schlüssel des Objekts wird verwendet, wenn die Checkbox nicht aktiviert ist, der zweite Schlüssel wenn sie aktiviert ist. Die Beschriftung wird aus dem ersten Wert des Objekts entnommen.
• input (optional): 
  • In der Standardeinstellung text wird eine Texteingabefeld ausgegeben. 
  • Mit der Angabe select wird eine Auswahlliste mit allen Werten aus values erzeugt. 
  • Mit checkbox wird eine Checkbox erzeugt. In values sollte dazu ein Objekt angegeben werden. 
• title (optional): Ein kurzer Hilfetext.

Die Attribute id, value, class und Attribute mit einem data-Präfix sind reserviert und dürfen nicht verwendet werden.
 

Konfiguration der Felder einer Annotation bzw. Fußnote mit den entsprechenden Einstellungen für das Rendering. Die Feldnamen werden als Schlüssel und die Einstellungen als Objekt angegeben.

Mögliche Felder in Fußnoten:

• name: Konfiguration der Nummerierung. Der Unterschlüssel format muss auf "counter" gesetzt werden. Die Ausgabe der Nummer wird im Schlüssel render mit den Werten "prefix", "text" oder "postfix" angegeben. 
  Die Art der Nummerierung wird im Unterschlüssel counter mit folgenden möglichen Werten angegeben: 
  
  • numeric: Es wird eine Zahl ausgegeben.
  • alphabetic: Es wird ein lateinischer Buchstabe ausgegeben (Varianten: alphabetic-lower, alphabetic-upper)
  • roman: Es wird eine römische Zahl ausgegeben (Varianten: roman-lower, roman-upper)
  • greek: Es wird eine griechische Zahl ausgegeben (Varianten: greek-lower, greek-upper)
• segment und content: Konfiguration für den Anmerkungstext und einen Referenztext.
  Der Unterschlüssel format muss auf "xml" gesetzt werden. 
  Im Unterschlüssel types wird wie bei Feldkonfigurationen für Items angegeben, welche Annotationen darin wiederum erlaubt sind. 
  Mit dem Unterschlüssel caption kann eine Überschrift gesetzt werden. 
  Wird der Unterschlüssel autofill auf true gesetzt, dann wird der markierte Text beim Einfügen einer Fußnote in dieses Feld übernommen. Alternativ kann autofill auf ein Objekt mit den Schlüsseln prefix (der Wert wird vorangestellt), postfix (der Wert wird nachgestellt) und wrap (ein link type, der zum Erzeugen eines umschließenden Tags genutzt wird, bspw. quot) gesetzt werden.
   

Mögliche Felder in links-Annotationen:

• to: Konfiguration von Verweisen. Der Unterschlüssel format muss für externe Verweise auf "record"  und für internet auf "relation" gesetzt werden. Soll eine Ausgabe in alleinstehenden Tags oder in Klammern erfolgen, wird dies im Schlüssel render mit den Werten "prefix", "text" oder "postfix" angegeben. Im targets-Schlüssel wird angegeben, worauf verwiesen werden kann: 
  
  • articles: Erlaubte Werte sind "intern" für interne Verweise und "extern" für Verweise auf andere Artikel.
  • sections: Die erlaubten Abschnittstypen werden in einer Liste angegeben.
  • items: Die erlaubten Inhaltstypen werden in einer Liste angegeben.
  • properties: Die erlaubten Kategorientypen werden in einer Liste angegeben.
  • footnotes: Die erlaubten Apparattypen werden in einer Liste angegeben.

Bei Bracket-Tags der für die öffnende Klammer verwendete Wert.

Bei Text-Tags wird dieser Wert dem in html_content festgelegten Wert vorangestellt.

Bei Format-Tags wird dieser Wert als Text zu Beginn des markierten Bereichs eingefügt.

Bei Bracket-Tags der für die schließende Klammer verwendete Wert.

Bei Text-Tags wird dieser Wert an den in html_content festgelegten Wert angehängt.

Bei Format-Tags wird dieser Wert als Text an das Ende des markierten Bereichs eingefügt.

Je nach Ausgabeformat werden die Tags anders gerendert: HTML benötigt Tags, Markdown und die Volltextsuche sollen dagegen keine Tags enthalten.

In den Schlüseln html, md und txt können Objekte mit den Schlüsseln tag_type, tag, prefix, content und postfix angegeben werden. Diese überschreiben dann die Standardeinstellung für die jeweiligen Formate. Auf diese Weise lässt sich beispielsweise das Rendering eines Absatzes vom tag_type "bracket" auf "format" umstellen, um das Markup auszublenden.

Es empfiehlt sich allerdings, die Standardeinstellung auf ein Textformat auszurichten und im html-Schlüssel explizit zu überschreiben (statt erst das HTML-Rendering festzulegen und es dann für alle möglichen Ausgabeformate wieder rückgängig zu machen). So können beispielsweise normalerweise Klammern weggelassen und nur in der HTML-Ausgabe ausgegeben werden. 

Die XML-Tags werden für die Anzeige auf der Webseite in HTML-konforme Tags konvertiert. Standardmäßig werden alle XML-Tags in span-Tags konvertiert. Der Schlüssel gibt an, welches HTML-Tag verwendet werden soll, wenn davon abgewichen werden soll.

Jedes konvertierte Tag erhält die Klasse xml_tag. Zusätzlich wird jedes Tag mit einer Klasse nach dem Schema "xml_tag_<name>" versehen. Wenn das XML-Tag zum Beispiel "wtr" heißt, wird nach der Transformation die Klasse "xml_tag_wtr" vergeben. 

Format-Tags erhalten zusätzlich die Klasse xml_format.

Bracket-Tags werden in drei Tags konvertiert. Die öffnende Klammer erhält die Klasse xml_bracket_open, die schließende Klammer die Klasse xml_bracket_close und der enthaltende Text die Klasse xml_bracket_content.

CSS-Angaben, die in die Webseite eingebettet werden, um das Tag zu gestalten. Die CSS-Angaben können sich auf die Klassen der konvertierten Tags beziehen (siehe die Konfiguration von html_tag).

Beispiel, um einen Umbruch nach einem Tag zu erzeugen:

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

Es können Unicode-Symbole von Font Awesome verwenden, werden. 

Dazu sucht man auf der Font-Awesome-Seite aus den Free Icons (wichtig!) ein Symbol heraus, z. B. das Font Awesome-eigene Buch-Symbol. Von der Seite entweder die Glyphe oder das Unicode-Kürzel kopieren und in den symbol-Schlüssel einfügen (wenn der Codepoint kopiert wird, dann bitte ein \u davorsetzen). 

Zusätzlich muss der font-Schlüssel auf "awesome" gesetzt werden. 

Um mehrere Toolbuttons zu einem Dropdown zu kombinieren, kann hier eine Kategorie angegeben werden. Alle Toolbuttons innerhalb einer Kategorie werden zu einem Dropdown kombiniert. Beispiel: Wird für Verweise-Annotationen (beispielsweise Verweis auf Hausmarke, Verweis auf Literatur) immer der Wert reference angegeben, entsteht ein Dropdown mit den entsprechenden Toolbuttons. 

Der Wert default sorgt dagegen dafür, dass der Toolbutton einzeln bleibt und nicht einer Gruppe zugeordnet wird.

Um Dropdown-Buttons gestalten zu können, wird für den Button eine eigene Annotation angelegt. Der group-Schlüssel wird auf die Gruppe der unterzuordnenden Buttons und der dropdown-Schlüssel wird auf true gesetzt. Mit weiteren Schlüsseln wie icon, symbol oder style kann der Button gestaltet werden. Beispiel: 
 

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