WikiUpload
Inhaltsverzeichnis |
Beschreibung
WikiUpload ist ein Plugin für die NetBeans Entwicklungsumgebung, welches automatisch Beschreibungen von JAMS Komponenten erzeugt und diese als Artikel in einem MediaWiki ablegt. Die hierfür erforderlichen Informationen werden aus den Annotations der Komponenten ausgelesen.
Installation
Um das WikiUpload Plugin zu installieren, müssen zunächst die Installationsdateien heruntergeladen werden. Diese befinden sich hier beziehungsweise im lokalen Repository an der gleichen Stelle. Anschließend NetBeans öffnen. Im Menü auf Extras->Updatezentrum klicken. Installation manuell geladener Module (.nbm Dateien) auswählen. Weiter klicken. Per Hinzufügen die beiden nbm Dateien auswählen und Fertig klicken.
Bedienung
Wurde das WikiUpload Plugin erfolgreich installiert, ist nun im Kontextmenü eines NetBeans Projektes der Eintrag "WikiUpload" zu sehen. Ein Klick auf diesen öffnet folgendes Dialogfenster:
Zunächst muss angegeben werden in welches MediaWiki die Beschreibung abgelegt werden soll. Die Adresse des JAMS - Wikis lautet: http://jams.uni-jena.de/jamswiki/. In das Feld "Login" und Password wird der Benutzername mit zugehörigen Passwort angeben. Ein anonymes Hochladen ist in den meisten System nicht möglich. Das Passwort wird verschlüsselt auf der Festplatte gespeichert.
Es stehen nun folgende Aktionen zur Verfügung:
- Upload zipped package: Lädt eine Zip - Datei hoch, welche die erzeugte Jar - Datei des Projektes enthält und alle zur Ausführung benötigten Bibliothekten. Voraussetzung für diese Aktion ist es, dass das Jar bereits existiert, das heißt der Build Befehl bereits ausgeführt wurde.
- Remove zipped package: Entfernt die hochgeladene Zip - Datei aus dem Wiki.
- Upload package documentation: Erzeugt zunächst eine Dokumentation des Packages und lädt diese anschließend hoch. ACHTUNG: Änderungen die online durchgeführt wurden, werden hierdurch überschrieben.
- Remove package documentation: Entfernt alle zu dem Projekt gehörtenden Artikel. ACHTUNG: Entfernt auch online geänderte Artikel!
- Upload component documentation: Da der Uploadvorgang einer kompletten Packagedokumentation lange dauern kann, ist es außerdem möglich die Beschreibung einzelner Komponenten zu aktualisieren. Dazu wählt man in der Liste im rechten Teil des Dialogfeldes die gewünschte(n) Komponente(n) aus und klickt anschließend auf upload component documentation.
- OK schließt den Dialog und speichert die eingegebenen Daten in der Projektdatei.
Struktur
Die Struktur der erzeugten Dokumentation gliedert sich wie folgt:
Für jedes Projekt wird eine Übersichtsseite angelegt (Beispiel), die eine Übersicht aller Komponenten des Projektes enthält und zusätzlich einen Link zu dem Projekt - Jar bereitsstellt (sofern dieses vorhanden ist).
Auf der nächsten Ebene wird für jedes Package des Projektes eine Übersichtsseite mit allen enthaltenen Komponenten angelegt (Beispiel)und letztendlich erhält jede Komponente einen eigenen Artikel in dem die Komponente sowie ihre Attribute beschrieben werden. (Beispiel)
