Anmerkungen und Hinweise

Ergänzung der DocPortal-Beispieldaten

Mit Version 1.1 wurden die Beispieldaten für das DocPortal aus der Distribution des selbigen herausgelöst und in eine separaten CVS-Baum untergebracht. Dies hat den Vorteil, dass

  • die Installation des DocPortals nicht mehr von Beispieldaten abhängig ist,
  • man nach der Installation ein leeres, betriebsbereites System hat,
  • die Distribution des Samples schlanker und der Download damit schneller ist,
  • mehr Beispiele in einer extra-CVS-Distribution angeboten werden können und
  • die Beispiele gezielt geladen und auch wieder entfernt werden können.

Die Beispieldaten stehen auf dem CVS-Server in Essen (server.mycore.de) in einem extra CVS-Baum mit dem Namen content bereit. Dieser Enthält eine Sammlung einzelner Beispieldatengruppen. Nach dem checkout können die Gruppen je nach Wunsch einzeln installiert werden (siehe UserGuide). Dabei spielt das jeweils mitgelieferte build.xml-Skript eine wichtige Rolle, hier sind alle Funktionen zur Arbeit mit dem Beispiel definiert.

Um neue Beispieldaten bereitzustellen gibt es zwei Wege: es wird eine Beispielgruppe mit Daten ergänzt oder es wird einen neue Beispielgruppe aufgebaut.

Ergänzungen in einer Beispielgruppe

Folgende Arbeiten sind erforderlich:

  • Erzeugen der Metadaten für das Dokument (ggf. mit Daten für den Autor und/oder die Institution).
  • Erzeugen des/der Derivate.
  • Integration des Ladens und Entfernens im build.xml-Skript in den target-Abschnitten load und remove.

Hinzufügen einer neuen Beispielgruppe

content

Abbildung 4.1: Mindeststruktur einer Beispielgruppe

Hier sind mehr Schritte erforderlich. Dabei ist immer darauf zu achten, dass die Beispielgruppe in sich vollständig ist, d. h. alle Autoren- und Institutionsdaten mitgeliefert werden. Da zum Laden der Daten das Update-Kommando verwendet wird, ist sichergestellt, dass es keine Doppelung im System gibt. Verwenden Sie möglichst die schon vorhandenen Autoren und Institutionen erneut.

  • Checken Sie die content-Distribution aus.
  • Erzeugen Sie ein neues Verzeichnis unter content, welches die Wurzel für Ihre Beispielgruppe sein soll.
  • Übernehmen Sie die Verzeichnisstruktur von einem bestehenden Beispiel und füllen Sie diese mit Ihren Daten.
  • Kopieren Sie das build.xml-Skript von einem bestehenden Beispiel und adaptieren Sie es. Es muss mindestens die targets info, load und remove beinhalten. Ggf. sind noch weitere targets zum Kopieren von Stylesheets usw. nötig, hier müssen Sie das build.xml-File ergänzen.
  • Schreiben Sie ein kurzes ReadMe-File im ASCII-Format mit Installationshinweisen.
  • Testen Sie das fertige Beispiel.
  • Commiten Sie alles in den CVS-Server.