Die vorliegende Seite behandelt die Komponenten des MyCoRe-Kerns sowie weitere im Zusammenhang mit MyCoRe nutzbare Bibliotheken.
MyCoRe ist kein monolithisches System. Vielmehr besteht der Kern aus Modulen, welche einzeln inklusive ihrer Abhängigkeiten genutzt werden können. Die nachfolgende alphabetische Auflistung gibt eine Übersicht über die verfügbaren Teile. Je nach Erfordernissen und Entwicklungen kann es vorkommen, dass einzelne Komponenten im Laufe der MyCoRe-Entwicklung bei neuen LTS-Releases neu hinzukommen oder entfallen. Diese Dokumentation spiegelt den oben genannten Release-Stand wieder. Neben dieser Dokumentation sind die einzelnen Komponenten auch kurz auf den entsprechenden Git-Hub in ihren Kernpunkten beschrieben (z. B. https://github.com/MyCoRe-Org/mycore/tree/master/mycore-sass ).
Name | Prio. | Beschreibung | abhängig von | |
---|---|---|---|---|
acl | * | Access Control List System | optional |
base
ifs restapi user2 |
acl-editor2 | 70 | 2. Version des Editors für die benutzten Access Control List | optional | base |
base | * | Basis für alle anderen Komponenten | required | |
bom | * | General Maven version definitions | required | |
classbrowser | 25 | Anzeigekomponente für Klassifikationen | optional | base |
classeditor | 75 | Online-Editor für Klassifikationen | required |
base
solr |
coma | * | Prototypische Entwicklung eines Content-Manager zu entwickeln, mit dem man einen Überblick über den gesamten Bestand an Daten (evtl. auch Metadaten) hat. | optional | |
cronjob | * | optional | base | |
csl | * | Citation Style Language - mit mycore-csl kann man Objekte in verschiedene Citations transformieren. | optional | base |
fo | 31 | Integration von XSL:FO Formatter; FOP is supported by default | optional | base |
ifs | * | Komponente des MyCoRe-Internal-File-Systems, organisiert das Speichern der Daten | required | base |
iiif | * | eine Komponente zur Einbindung von IIIF in MyCoRe | optional | base restapi |
impex | 95 | generiert Import- und Export-Pakete auf Grundlage einer SOLR-Query | optional | base packer solr |
indexing | 30 | Erstellung von Google-Sitemaps für angegebene Datenmodelltypen | optional | base solr |
iview2 | 40 | Komponente zum Erstellen von Kacheln der Bilder | optional | base iiif jobqueue media |
jobqueue | * | Komponente zur Verwaltung von asynchronen Aufgaben | optional | base cronjob restapi |
lod | * | Komponente für Linked Open Data | optional | base restapi |
media | * | Werkzeuge zum Ermitteln von Medieninformationen für einzustellendes Material | optional |
base
ifs |
meta | * | Komponente, welche die Verweise auf alle Komponenten enthält | base | |
mets | 45 | Komponente zur Bereitstellung von METS-Daten für die gespeicherten Derivate | optional | base solr |
migration | 35 | Komponente mit Werkzeugen zur Migration auf das aktuelle MyCoRe-Release | optional | base iview2 |
mods | 50 | Werkzeuge zum Verarbeiten von MODS-Daten | optional | base cronjob csl jobqueue pi solr |
neo4j | 57 | Bibliothek zur Arbeit mit NEO4J | optional | base |
oai | 60 | Implementierung eines OAI-Data-Providers für die MyCoRe-Webanwendung | optional | base solr |
ocfl | * | Implementierung einer OCFL-Versionierung | optional | base user2 |
orcid | 55 | ORCID Unterstützung | optional | base mods user2 |
orcid2 | 54 | ORCID Unterstützung | optional | base mods restapi user2 |
packer | * | MyCoRe packer API | optional | base jobqueue |
pandoc | * | Pandoc | optional | base |
pi | * | Codesammlung zur Arbeit mit persitenten Identifiern (DOI, URN, PURL) | optional | base jobqueue |
restapi | 65 | Implementierung einer REST-API | optional | base solr |
sass | * | Unterstützung des Compile-Vorganges von sass-Files zu css-Files | optional | base |
solr | 10 | Klassen zur Indizierung und Suche mit Apache SOLR | required | base |
sword | * | Implementierung einer Sword-Schnittstelle, Version 2 | optional | base solr |
tei | * | Unterstützung für den Umgang mit TEI | optional | base |
user2 | 15 | Implementierung des Nutzer-Systems, Version 2 | required | base |
validation | * | Validation | optional | base |
viewer | * | Enthält den MyCoRe-Viewer für Bilder und PDFs. Das Modul kann sowohl standalone wie auch in einer MyCoRe-Anwendung integriert genutzt werden. | optional | base |
wcms2 | 90 | Implementierung eines Autorensystems für die Webanwendung, Version 2 | optional | base |
webcli | 80 | Implementierung der Möglichkeit, Kommandos der CLI über die Webanwendung auszuführen | optional | base |
webtools | 85 | Enthält Web-Tools wie Session Listing oder die Prozessliste | optional | base |
wfc | * | Eine Workflow-Implementierung | optional | base |
xeditor | 20 | Ein Gestaltungsystem für die Erstellung von Editorformularen, Version 2 | optional | base |
Die nun aufgelisteten zusätzlichen Maven-Module sind in GitHub-MyCoRe zu finden.
Komponente | Beschreibung | Version |
---|---|---|
mycore-parent | Parent pom für MyCoRe-Maven-Modulen | 57-SNAPSHOT |
datamodel-plugin | Eine Erweiterung zur Erstellung eigener Datenmodelldefinitionen in eigenen Maven-Modulen | 0.9-SNAPSHOT |
mir-mets-printer | Basis-Projekt mit dem man die PDF-Funktion des MyCoRe-Viewers benutzen kann | 2023.06-SNAPSHOT |
MyCoRe-Komponenten können einzeln je nach Bedarf in die eigene Anwendung integriert werden. Dazu sind lediglich die entsprechenden Angaben in der pom.xml -Datei zu machen. Wichtig ist dabei, auf Abhängigkeiten zu achten (siehe oben). Alle Komponenten sollten auch denselben Versionsstand haben, um Kompatibilitätsprobleme zu vermeiden. Die Integration der in den Komponenten enthaltenen Teile erfolgt entsprechend den Servlet-3.1-Regeln.
Folgende Versionsnummern können genutzt werden:
|
|