cocoda

Cocoda -Mapping -Werkzeug

Ein webbasiertes Tool zum Erstellen von Mappings zwischen Wissensorganisationssystemen.

Probieren Sie die neueste Versionsversion, die aktuelle Entwicklungsversion, aus und wenden Sie sich an die Nutzungsdokumentation!

Inhaltsverzeichnis

• Installieren
  • Versionen veröffentlicht
  • Entwicklungsversionen
  • Servieren der Dateien
  • Docker
• Verwendung
• Konfiguration
• Betreuer
• Beitragen
• Lizenz

Installieren

Versionen veröffentlicht

Veröffentlichungen können in Form statischer Dateien heruntergeladen werden. Extrahieren Sie in ein Webserver -Verzeichnis und passen Sie die Konfigurationsdatei cocoda.json an. Sie können den Download und die Extraktion der neuesten Version mit JQ wie folgt automatisieren:

 # You can also manually download the latest release here: https://github.com/gbv/cocoda/releases/latest
wget -N $( curl -s https://api.github.com/repos/gbv/cocoda/releases/latest | jq -r ' .assets[].browser_download_url ' )
unzip cocoda- * .zip
rm cocoda- * .zip

Das Verzeichnis cocoda ist dann bereit, mit jedem Webserver serviert zu werden.

Entwicklungsversionen

Alternativ ist es möglich, das Cocoda -Repository zu klonen:

git clone https://github.com/gbv/cocoda.git
cd cododa

Installieren Sie dann die erforderlichen Knotenmodule mit NPM und Ausführen von Build (erfordert Node.js v18 oder höher, V20 empfohlen):

npm ci
npm run build

Dateien werden im Verzeichnis dist erstellt, einschließlich der Konfigurationsdatei.

Servieren der Dateien

Jeder Webserver kann zum Servieren von Cocoda -Dateien verwendet werden. Es ist keine spezielle Konfiguration erforderlich. Zum Beispiel mit dem http-server -NPM-Paket zum Servieren von Cocoda unter http: // localhost: 8000:

 # serve the pre-built release
npx http-server -p 8000 cocoda/
# or serve the build version
npx http-server -p 8000 dist/

Docker

Cocoda ist auch über Docker erhältlich. Weitere Informationen und Anweisungen finden Sie in unserer Docker -Dokumentation.

Verwendung

Auf Deutsch und Englisch gibt es ein detailliertes Endbenutzerhandbuch. Die deutsche Version wird wahrscheinlich aktueller sein. Dokumentationsquellen befinden sich in docs .

Konfiguration

Für die vorgefertigte Version können Konfigurationsoptionen mit cocoda.json im Stammverzeichnis überschrieben werden. Die Standardoptionen finden Sie in der Dateikonfiguration config/cocoda.default.json (bitte untersuchen Sie diese Datei, um die Verwendung der Konfigurationsoptionen zu verwenden). Bei Verwendung eines manuellen Builds erstellen Sie die Dateikonfiguration config/cocoda.json und rebuild ( npm run build ) nach der dist/ (Sie können auch npm run build -- --config-only ausführen. Die folgenden Felder werden bisher erkannt:

• Titel : Der Haupttitel der Instanz als einfache Zeichenfolge

• Logos : Eine Liste von Logos, die zum Titel gelassen werden, jeweils mit Unterfeldern:

  • file : Bild -URL relativ zum static Verzeichnis
  • alt : Alternativer Text für das Bild, wenn das Bild nicht als einfache Zeichenfolge angezeigt werden kann
  • url : URL, um aus dem Logo zu verlinken

• Menü : Eine Liste der Links, die im Menü mit jeweils Unterfeldern angezeigt werden sollen:

  • url : Die Link -URL
  • prefLabel : Zuordnung von Sprachcodes zu Link -Titeln

• Suchlinks : Eine Liste von Suchlinks, um schnell mit externen Ressourcen aus Konzepten zu verlinken. Jeder Suchlink hat Unterfelder:

  • url Eine URL -Vorlage mit möglichen Parametern {prefLabel} und/oder {notation}
  • prefLabel : Zuordnung von Sprachcodes zu Link -Titeln

• Favoritenschemen : Liste der Vokabular -URIs, die standardmäßig favorisiert werden sollen.

• Sprachen : Array mit unterstützten Schnittstellensprachen

• Registrien : Listet Registries auf, woher Daten abgerufen werden sollen

• Oversideregistries : false (Standard) oder true Controls, ob in config/cocoda.default.json Register überschrieben werden soll

• AUTH : URL zu einer Anmelderver-Instanz, die zur Authentifizierung verwendet werden soll

• Conceptlists : Eine Liste von Konzeptlisten. Jede Liste kann entweder ein Objekt oder eine URL sein, die ein JSON -Objekt zurückgibt. Objekte sind im Grunde genommen JSKOS -Register mit den erforderlichen Eigenschaften prefLabel und concepts . Wenn concepts eine Zeichenfolge sind, wird sie als URL angesehen, die ein JSON -Array von Konzepten zurückgibt. Optionale Eigenschaften sind notation und scopeNote .

• AutoreFresh : Ein Objekt mit automatischen Aktualisierungswerten in Millisekunden. autoRefresh.mappings bestimmt, wie oft Zuordnungen in MappingBrowser neu geladen werden (Standardeinstellung: 10000 = alle 10 Sekunden), autoRefresh.update bestimmt, wie oft Cocoda nach einem Update sucht (Standard: 120000 = alle 2 Minuten).

Mit der vorgefertigten Version muss die Anwendung nach dem Bearbeiten der Konfigurationsdatei nur neu geladen werden.

Betreuer

• @stefandesu
• @nichtich

Beitragen

Ihre Beiträge zur Verbesserung von Cocoda sind sehr willkommen: Bitte eröffnen Sie ein GitHub -Problem für Feature -Vorschläge und Fehlerberichte! Weitere Informationen darüber finden Sie in der Datei zum Mitbetrieb der Datei.

In https://gbv.github.io/cocoda/ finden Sie die API -Dokumentation automatisch aus Knotenquellen.

Lizenz

MIT © 2019 Verbundzentrale des GBV (VZG)