An dieser Stelle entsteht die öffentliche Dokumentation für Epigraf 5. Diese Seite ist noch in Bearbeitung.
Für alle Typen - Artikel, Abschnitte, Inhalte, Kategorien, Fußnoten - wird über den fields
-Schlüssel festgelegt, welche Felder verwendet werden sollen und wie sie beschriftet werden. Die Feldkonfiguration umfasst im einfachsten Fall eine Liste mit Feldnamen als Schlüssel und Beschriftungen als Werten. Sollen weitere Eigenschaften konfiguriert werden, kann als Wert ein Objekt mit folgenden Schlüsseln angegeben werden:
Schlüssel | Beschreibung |
---|---|
caption | Beschriftung des Feldes. |
showcaption | Soll die Beschriftung angezeigt werden (true | false)? |
display | Steuert die Darstellung des Feldes:
|
format | Wenn der Inhalt eines Feldes etwas anderes als eine Zeichenkette umfasst, wird das Format angegeben:
|
targets | Bei Feldern mit den Formaten record oder relation wird angegeben, worauf verwiesen werden kann:
|
required | Bei Feldern mit den Formaten record oder relation muss standardmäßig ein Wert ausgewählt werden. Um auch leere Werte zuzulassen (es wird dann im Dropdown-Selektor eine Auswahlmöglichkeit dafür erzeugt), kann required auf false gesetzt werden. |
append | In der Standardeinstellung können bei Felder mit den Format record nur existierende Kategorien ausgewählt werden. Um ad hoc neue Kategorien erzeugen zu können, wird append auf true gesetzt. |
baseurl | Bei Feldern vom Typ imageurl wird der Dateiname des Bildes aus den Feldern file_path und file_name gebildet und an die baseurl angehängt. Beispiel: für eine baseurl: https://www.inschriften.net/fileadmin/ . |
template | Bei JSON-Feldern wird standardmäßig eine Tabelle ausgegeben. Eine kompakte Liste wird mit dem Template "list" erzeugt. |
types | In XML-Feldern: Welche Annotationen sind erlaubt? Es wird eine Liste der Link-Namen (name-Feld der Annotation) oder der Link-Gruppen (config.group-Feld der Annotation) angegeben. In Property-Feldern: Welche Art von Eigenschaften wird verlinkt? Der Name des Propertytyps wird als Zeichenkette angegeben. |
options | Für Auswahlfelder ein Objekt mit Schlüsseln und Beschriftungen. Beispiel:
|
edit | Ist das Feld bearbeitbar oder nicht (true|false)? |
fulltext | Die Bezeichnung eines Index, dem der Text hinzugefügt werden soll, z.B. "Transkription". oder "Notizen". Für die Volltextindizierung muss zusätzlich muss der fulltext-Schlüssel im Item gesetzt werden. |
autofill | Feldinhalte können automatisch bei der Eingabe aus anderen Feldern erzeugt werden. Dazu wird die Datenquelle als Extraktionsschlüssel im source-Schlüssel angegeben. Der Extraktionsschlüssel enthält den Tabellennamen, in eckigen Klammern den Zeilentyp und schließlich mit Punkt getrennt den Feldnamen. Es werden normalerweise nur Inhalte überschrieben, wenn das Feld leer ist und nicht manuell bearbeitet wurde. Der optionale force-Schlüssel sorgt dafür, dass das Feld für die manuelle Eingabe gesperrt und in jedem Fall überschrieben wird. Beispiel:
Die Werte können bei der Übertragung transformiert werden, etwa um sie zu bereinigen. Dafür wird im process-Schlüssel eine Liste von Transformationsfunktionen angegeben. Beispiel:
Folgende Transformationen sind implementiert:
|
keys | Für JSON-Felder können Unterfelder definiert werden. Jedes Unterfeld wird wie ein normales Feld konfiguriert. Beispiel:
|
published | Statuswert, z.B. für Geokoordinaten |
widgets.map | Soll eine Kartenansicht gezeigt werden (true | false)? Beispiel:
|
services | Service configurations used to update the field, e.g. a reconciliation service configuration. An object with an arbitrary key for each service and its configuration object as the value. The configuration object contains the following keys:
Make sure to configure the namespaces to link the results in views. Example:
|