An dieser Stelle entsteht die öffentliche Dokumentation für Epigraf 5. Diese Seite ist noch in Bearbeitung.
Epigraf lässt sich für vielfältige Anwendungsfälle anpassen. Vorgegeben ist durch das Datenmodell die Struktur aus Projekten, Artikeln, Abschnitten, Inhalten, Annotationen inklusive Fußnoten und Kategorien. Wie diese Struktur inhaltlich gefüllt wird, ist dagegen frei konfigurierbar. Es lassen sich zum Beispiel ganz verschiedene Arten von Abschnitten (z.B. Textabschnitte, Standortlisten, Inschriftenbearbeitungen...) festlegen und auch, welche Felder angezeigt werden, wie sie beschriftet sind und welche Datenformate sie enthalten. Die Konfiguration erfolgt im Menüpunkt Typen
.
Geltungsbereich eines Konfigurationeintrags
- scope: Legt fest, ob ein Artikel, ein Abschnitt, ein Inhalt usw. konfiguriert wird, zum Beispiel "sections".
- name: Ein Name für den konfigurierten Typ, zum Beispiel "locations".
- mode: Es muss immer eine Standardkonfiguration (default) angelegt werden. Diese kann für den Bearbeitunsmodus (edit) und den Anzeigemodus (view) mit weiteren Konfigurationen überschrieben werden.
- preset: Die Standardkonfiguration kann auch für spezifische Anwendungsfälle überschrieben werden, zum Beispiel um eine Kurzfassung eines Artikels anzuzeigen. Wenn beim Aufruf einer Seite in der URL der preset-Parameter gesetzt wird, überschreiben die entsprechend benannten Konfigurationseinstellungen die Standardkonfiguration
- iri: Ein global eindeutiger Bezeichner, insbesondere um Konfigurationen zwischen verschiedenen Datenbanken austauschen zu können.
- published: Für die öffentliche Ansicht freigegebenen Konfigurationen. Nur veröffentlichte Konfigurationen gelten auch für Nutzende, die nicht in Epigraf angemeldet sind.
- number: Steuert die Reihenfolge in der Konfiguration. Wenn mehrere Einstellungen zum gleichen mode vorhanden sind, werden sie jeweils in der vorgegebenen Reihenfolge überschrieben.
Inhalt eines Konfigurationseintrags
- caption: Eine Beschriftung des Eintrags. Diese Beschriftung dient vorrangig der Übersichtlichkeit. Sie wird zum Beispiel als Überschrift von Abschnitten und bei Annotationen für die Beschriftung von Toolbuttons verwendet.
- description: Dient ausschließlich der übersichtlicheren Organisation und enthält eine Beschreibung, welchen Zweck der Konfigurationseintrag erfüllt.
- category: Dient ausschließlich der übersichtlicheren Organisation, um mehrere Einträge schneller finden zu können.
- config: Enthält die Konfiguration, zum Beispiele welche Felder in einem Datensatz verwendet werden sollen.