2018.06 2019.06

Über diese Dokumentation

Ein komplexes Framework wie MyCoRe benötigt entsprechend Dokumentation, um sowohl Einstieg in die Nutzung des Frameworks, Entwicklung eigener Anwendungen als auch Mit-Entwicklung am MyCoRe-Framework zu ermöglichen. Vollständig wird eine solche Dokumentation nie sein, daher freuen sich die Entwickler immer über Rückmeldungen. Die vorliegende Dokumentation beinhaltet die LTS 2018.06 und 2019.06.

Zu Beginn

Für den Einstieg in MyCoRe empfielt sich die MIR-Anwendung. Diese vereint alle klassischen Repository-Funktionen und bildet diese ab. Die Metadaten werden im MODS-Standardformat erfasst und abgelegt.

Möchte man eine eigene MyCoRe-Anwendung entwickeln, welche mit eigenem Datenmodell und angepassten Funktionen auszustatten ist, kann der "Maven Archetype als Einstieg genutzt werden.

Eine Übersicht bestehender Applikationen der MyCore-Anwender steht unter Standorte und Projekte.

Generierte Projektdokumentation (Maven)

  • Maven Site
  • Aktuelle API Dokumentation (Javadocs).
    Diese Seite umfasst sämtliche Klassen des aktuellen MyCoRe-Codes des Master-Branches.
  • Die Javadocs der einzelnen MyCoRe-Komponenten erreichen sie über die MyCoRe-Maven-Hauptseite (jeweils Eintrag unter "Modules" -> "Project Reports" -> "JavaDocs").
  • Javadocs für älteren Versionen sind über die Maven Site erreichbar ("Project Reports" -> "JavaDocs").

HowTo's

HowTo's (Wiki) beschreiben in knappen Anleitungen, wie etwas gemacht wird und wie häufige MyCoRe-Probleme gelöst werden können. Diese Anleitungen sind nicht Bestandteil der hier verfügbaren Dokumentation!

Archiv

Alte Dokumentation sind jetzt in den jeweiligen Branches des Dokumentationsprojektes unter https://github.com/MyCoRe-Org/mycore-website zu finden. Dokumentationen zu Release 2017.06 und älter sind ggf. unter dem GIT-Repository https://github.com/MyCoRe-Org/documentation zu finden. Zur Darstellung wird eine forrest-Installation benötigt. Wir empfehlen jedoch ein baldmögliches Update auf das aktuelle Release.

Es wird versucht in der aktuellen Dokumentation deutlich zu machen, was neue Funktionen sind und mit welcher Version diese zur Verfügung stehen. Dokumentation veralteter Komponenten sind nur noch in den entsprechenden Doku-Branches verfügbar.