Page ThesisWikiDocReportRobert

Reportseite

Woche 9

• Erdachtes
• Erarbeitetes
  • setzen von MixedContent Funktioniert
  • es können auch Methodenbeschreibungen über das Wiki editiert werden.
• Gelesenes
• Erkanntes
• Probleme
  • Zeichenkodierung von umlauten → Problem lag in falscher Encoding angabe in JSP
• Ziele
  • Sperren des Wiki's soll nicht mehr über die gesamte Datei erfolgen, sondern nur der entsprechende Bereich soll gesperrt werden
  • Der eingebene Text muss geprüft werden, ob er HTML-Code enthält der beim späteren Parsen der HTML-Datei durch das Stylesheet probleme verursachen könnte. Außerdem muss geprüft werden ob der eingegebende HTML-Code gültiges XHTML darstellt.
  • editieren von Konstruktoren und Feldern ermöglichen
  • Sicherheit: durch URL übergebende Dateisystempfade überprüfen!
• Zeitaufwand

Woche 9	30h
Gesamt	170h

Woche 8

Wegen des Unfalls in diese Woche auch nur minimale Arbeiten an dem Projekt.

• Erdachtes
• Erarbeitetes
• Gelesenes
• Erkanntes
• Probleme
  • setzen einer MixedContent Node in einen DOM-Baum
• Ziele
• Zeitaufwand

Woche 8	5h
Gesamt	140h

Woche 7

Aufgrund eines Unfalls konnte ich in dieser Woche nicht an dem Projekt arbeiten. Trotzdem wurde am Anfang der Woche Meilenstein 1 erreicht. Methodenbeschreibungen können über das Wiki editiert und ältere Versionen wieder hergestellt werden. Damit wurden zumindest für Methoden grundlegende wikifunktionalitäten realisiert.

• Erdachtes
• Erarbeitetes
  • Methoden können über das Wiki editiert und wiederhergestellt werden.
• Gelesenes
• Erkanntes
• Probleme
• Ziele
• Zeitaufwand

Woche 7	0h
Gesamt	135h

Woche 6

• Erdachtes
• Erarbeitetes
  • XSL-Schema für das Wiki → XMLBeans erzeugt daraus Javaklassen mit denen auf die XML-Struktur zugegriffen werden kann
  • Umbau der Gesamten Klassen, Refactoring,
• Gelesenes
  • XMLBeans Dokumentation
• Erkanntes
  • eventueller Umstieg von org.w3c.Document nach jDom nötig
• Probleme
  • ein Haufen → hauptsächlich Programmierfehler meinerseits
• Ziele
  • Erreichten Ziele zu festigen, Quellcode säubern, einheitliche Fehlerbehandlung(errorFile oder Benutzer anzeigen)
  • Erweitern der Wiki-Funktion auf anderen Teile (Konstruktoren, Felder etc.)
• Zeitaufwand

Woche 6	25h
Gesamt	135h

Woche 5

• Erdachtes
  • verwenden von XMLBeans um einfach auf die XML-Einträge des Wikis zuzugreifen
• Erarbeitetes
  • Anlegen von Projekten, Browsen om Wiki und Anzeigen der Editierseite für Methoden funktioniert
  • Wiki-Seiten werden zum Bearbeiten gesperrt (Lock-File-System)
• Gelesenes
• Erkanntes
  • sinnvolles abspeichern der Wikieinträge → XMLDatei
• Probleme
• Ziele
  • Innerhalb der nächsten zwei Wochen grundlegende Wikifunktionen zu realisieren
• Zeitaufwand

Woche 5	25h
Gesamt	110h

Woche 4

• Erdachtes
• Erarbeitetes
  • Umstellung auf nekoHTML und Saxon in einem komplett eigenen ANT-Task
• Gelesenes
  • Ant-Manual/API, XSLT-Hilfe
• Erkanntes
  • jTidy parst JavaDoc-HTML Seiten teilweise unterschiedlich, deswegen Umstieg auf nekoHTML
  • dadurch nur noch einen Ant-Task ist der Prozess jetzt sehr viel schneller
  • nekoHTML parst die HTML-Seite zwar als Document-Object ein, die Ausgabe ist jedoch wieder das nicht XML-Konforme HTML→ damit weniger probleme mit nichtkonformen HTML wie bei jTidy
• Probleme
  • neuentwurf des Stylesheets notwendig, da nekoHTML die Webseiten anders parst als jTidy
• Ziele
• Zeitaufwand

Woche 4	5h
Gesamt	85h

Woche 3

1. Meilenstein Anlegen, Löschen und aufrufen der fertigen WIKI-Seiten(JavaDoc-HTML mit Edit-Knopf und markierungen) ist im Prinzip fertig.

• Erdachtes
  • Authentifizierung über Servlet-Filters
• Erarbeitetes
  • Anlegen und Löschen eines Projektes
• Gelesenes
  • Informationen über Pushlets (HTML-Seiten die vom Server aktualiesiert werden), Ant-Manual/API
• Erkanntes
• Probleme
  • fortwärende Ausgabe des Ant-Scriptes klappt nur wenn vorher der Content-Type der Ausgabe richtig auf Text/Html gesetzt wurde → das wusste ich bis zu diesen Zeitpunkt nicht
• Ziele
• Zeitaufwand

Woche 3	30h
Gesamt	80h

Woche 2

• Erdachtes
  • Steuerung der Initialisierungsroutine(Quellen holen, JavaDoc erstellen, HTMLtoXMl, Stylesheet anwenden, DOM-Baum erstellen) durch ein Ant-File. Dadurch bleibt der Vorgang sehr flexibel (es stehen alle Möglichkeiten von Ant offen) außerdem muss dieser Vorgang nicht Programmiert werden. Ant kann aber trotzdem aus dem Programm gestartet werden.
• Erarbeitetes
  • Ant-Script
  • überarbeitetes Stylesheet
  • jTidy Ant-Task aus der unstabilen Version kopiert und an die ältere stabile Version (welche ich verwende) angepasst
  • eigenen Ant-Task um einen DOM-Baum aus den Dokument zu erstellen
• Gelesenes
  • Ant-Dokumentation, Saxon-Dokumentation, Foren etc.
• Erkanntes
  • Es existiert keine einfache Möglichkeit aus Java heraus auf CVS/Subversion-Server zuzugreifen → Ant
• Probleme
  • XSL-Stylesheet funktioniert mit dem ALTOVA-XSL-Prozessor, aber blöderweise! nicht mit anderen, scheinbar interpretiert jeder Prozessor den Standard etwas anders und der Altova-Prozessor ist etwas fehlertoleranter.
  • da im XSL-Stylesheet XPath 2.0 Elemente benutzt wurden, bleibt als Parser nur Saxon übrig → Standardparser von Java funktionert nicht
  • die JavaDoc-HTML-Seiten unterscheiden sich teilweise deutlich vom Aufbau untereinander → erschwert sehr die Stylesheet Entwicklung.
  • jTidy parst Interfaces und Klassen vollkomment unterschiedlich → erschwert sehr die Stylesheet Entwicklung.
  • JavaDoc-Kommentare können nicht valider HTML-Code sein z.B. <,> oder nicht erlaubte UNICODE-Zeichen
  • Probleme mit Saxon (nichtreproduzierbare Abstürze beim verarbeiten der Java 5.0 Api)
• Ziele
  • noch keines
• Bemerkungen
  • Ich hatte diese Woche nicht allzuviel Zeit
  • ziemlich gravierende Probleme mit dem Stylesheet → Weg falsch ?
• Zeitaufwand

Woche 2	10h
Gesamt	50h

Woche 1

Arbeit an demXSL-Stylesheet...

• Erdachtes
  • Parsen des Dokumentes durch ein XSL-Stylesheet. Wobei das Stylesheet die zu verarbeitenden Informationen durch entsprechende Tags bzw. Attribute im HTML-Dokument "markiert". Durch diese Vorgehensweise, ist es einfach möglich den Parsingprozess an andere JavaDoc-Versionen anzupassen bzw. Fehler zu beheben.
• Erarbeitetes
  • XSL-Stylesheet
• Gelesenes
  • XPath und XSL Referenzen, Hilfen, Foren, Mailinglisten etc.
• Erkanntes
  • nichts besonderes
• Probleme
  • Zugriff auf die entsprechenden Teile des Dokumentes mit XPath, wobei das Problem darin bestand das die Informationen im HTML-Dokument nicht hierarchisch geordnet sind
  • Entwerfen eines Stylesheets welches allgemeingültig für alle Klassen(Exceptions, Interfaces, etc) ist
• Ziele
  • noch keines
• Zeitaufwand

Woche 1	25h
Gesamt	40h

Woche 0

Allgemeine Überlegungen zum Thema und erstellen erster Strukturentwürfe...

• Erdachtes
  • erste Gedanken zum Aufbau bzw. grundlegende Struktur des Programmes
• Erarbeitetes
  • erste Prototypen z.B. Servlet-Proxy, HTML-to-DOM Parser
• Gelesenes
  • HTML-to-DOM Parser nekoHTML und jTidy
• Erkanntes
  • nichts besonderes
• Probleme
  • JavaDoc-HTML ist kein XML und kann somit nicht einfach als DOM-Baum eingelesen werden
• Ziele
  • noch keines
• Zeitaufwand

Woche 0	15h
Gesamt	15h