2016.06 2017.06

Übersicht

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.

Mit MyCoRe starten

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

Möchte man eine eigene MyCoRe-Anwendung entwickeln mit eigenem Datenmodell und angepassten Funktionen, kann das Skeleton-Modul 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 MyCoRe-Build-Prozesses, unter Umständen auch solche, die nicht in mycore-complete enthalten sind.
    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 wird hier aufbewahrt und steht somit Anwendern vergangener Release-Versionen auch weiterhin zur Verfügung. 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 wird nach wie vor im Archiv abgelegt.

 Kathleen Neumann, Jens Kupferschmidt - 2016-01-16