Konfigurationen

Im Quelltextverzeichnis data/ sind die Daten-Konfigurationen, die bestimmen, welche Daten in die Datenbank geladen werden und mit welchen Hashtags, Quellen und Typen sie verfügbar sind. Die Datenlisten sind in sources/ zu finden.

Format

Die einzelnen Dateien sind im JSON-Format, spezifisch so, dass die python3-json-Bibliothek sie parsen kann. (Im Zweifel die vorhandenen Dateien als Vorlage benutzen.)

Inhalt

In der obersten Ebene müssen folgende Schlüssel vorhanden sein:

Folgende Schlüssel werden zusätzlich erkannt:

access

Der Schlüssel access enthält eine Liste von Arten, wie auf diese Quelle zugegriffen werden kann, bestehend aus (alle Schlüssel müssen vorhanden sein):

Die explizite Quelle darf nur aus Großbuchstaben bestehen. Der Magic Hashtag sollte gleich der expliziten Quelle sein, aber mit einem Unterstrich davor, also z.B. '_FFM' zu 'FFM'.

data

Der Schlüssel data enthält eine Liste von Datenlisten, die dieser Quelle hinzugefügt werden sollen. Grundsätzlich sollten Sammlungen, die verschiedene Herkünfte haben, und daher unterschiedliche Ersteller*innen und/oder Lizenzen, in verschiedenen Datenlisten sein und können hier zusammengesetzt werden.

Folgende Schlüssel sind unbedingt erforderlich:

Folgende Schlüssel werden erkannt, wenn sie vorhanden sind:

source

Spezifiziert die Herkunft der Datenliste.

Benötigte Schlüssel:

Optionale Schlüssel:

license

Spezifiziert das Urheberrecht an dieser Datenliste. Wenn nicht vorhanden, bedeutet das, dass das Urheberrecht dieser Liste beim Autor des Bots liegt und die Liste unter Apache Lizenz 2.0 veröffentlicht ist.

Benötigt:

Optional: