3. Word als Autorenfrontend.
In unserer Projektgruppe SoDoM (Softwaredokumentation mit Mustern) haben wir uns für ein Autorenfrontend auf der Basis von Microsoft Word
ä entschieden. Dieses Textverarbeitungsprogramm erfüllte die von uns gestellten Forderungen
am ehesten.
Dieses von uns geplante Autorenfrontend erfüllt nicht alle der in den oberen Kapiteln genannten Forderungen, welches aber damit zusammenhängt daß die Dokumentenverwaltung über eine Datenbank und ein eigenes Frontend läuft.
Als Vorgehensmodell verwenden wir das V-Modell , VM-Basis , der Telekom, mit der wir in diesem Projekt zusammenarbeiten.
Es ist geplant ein Frontend zu erstellen, welches es ermöglicht
Da man für Word ,Visual Basic zur Programmierung verwenden kann, ist eine Erweiterung sehr einfach zu gestalten. Die Zugriffe auf die Objekte von Word unterstützen dies weiter. Es könnten sogar von außen Programme in Word eingebunden werden die bestimmte Aufgaben übernehmen oder, bei guter Kompatibilität, auch ihr Frontend (z.B. Viso
ä ).
Im weiteren möchte ich näher auf das geplant Autorenfrontend engehen.
3.1 Neu Erstellung Dokumenten.
Der Autor wählt aus der Liste von Dokumentvorlagen (DOT) das entsprechende Dokument (Arbeitspapier) aus und erzeugt es (Datei|Neu). Er findet im Dokument schon die durch die Definition im Vorgehensmodell geforderte lokale Gliederung des Arbeitspapiers vor und kann zur passenden Beschreibung in der Dokumentation des VM-Basis verzweigen (Darstellung in einem Browserfenster).
Über zusätzliche von uns in Word bereitgestellte Funktionen checkt der Autor ein Dokument aus, bearbeitet es in MS Word und checkt es schließlich wieder ein. Alle Versionen eines Dokuments lassen sich auschecken.
Um bestehende Dokumente zu vergleichen, werden wir die Überarbeiten-Funktion von Word einsetzen mit evtl. temporär nötiger Konvertierung der Dateien in das DOC-Format.
3.3 Markierung von Bekannten Begriffen
Beim Einladen eines Dokumentes in Word, wird es automatisch nach bekannten Begriffen durchsucht und diese werden dann Gelb hinterlegt.
Dieses Durchsuchen kann auch von dem Autoren selbst oder veranlaßt werden in dem er den entsprechenden Button in der Symbolleiste auswählt.
Das Durchsuchen wird bewerkstelligt in dem ein Auftrag, über ODBC, an die Datenbank übergeben wird, welche dann alle bekannten Begriffe alphabetisch sortiert zurückgibt. Nun werden diese Begriffe mit den Wörtern im Dokument verglichen und bei Übereinstimmung wird das Wort im Dokument mit einem gelben Formathintergrund belegt.
Abb. 20: Markierte Begriffe unter Word
3.4 Tooltip Anzeige der Definition für bekannte Begriffe
Wenn der Benutzer mit dem Mauszeiger über einem als bekannt markierten Begriff stehen läßt wird ihm ein Tooltip mit der aktuellen Version der Definition angezeigt.
Dieses wird über das Tooltip Objekt in Word realisiert, welches dann als Quellenangabe für seinen Text einen Auftrag an die angebundene ODBC-Datenbank hat.
3.5 Unbekannte Begriffe in die Datenbank einfügen
Zur erstmaligen Definition und anschließenden Einordnung eines Begriffs in eine Kategorie, wird ein Dialog in Word bereitgestellt der die nötigen Tätigkeiten ermöglicht. Ein Begriff kann auf diese Weise auch redefiniert werden und umgekehrt können auch weitere Begriffsvarianten als Alias-Bezeichner eingetragen werden. Begriffe sind unabhängig von ihrer Einordnung in unterschiedliche Kategorien im Glossar eindeutig definiert.
Die Funktionalität zur Pflege des Glossars wird mit einem Frontend umgesetzt, das auf der Explorer-Philosophie basiert: links eine Baumdarstellung der Anwendungen, Kategorien und Begriffe, rechts der Inhalt der Kategorien.
Diese Dialoge sind Unterteilt in
Der Benutzer kann über das Kontextmenü die Option Begriff definieren, für unbekannte Begriffe, bzw. die Option Begriff neu Definieren/Aliasname
,für bekannte Begriffe auswählen und gelangt in die entsprechende Dialogführung.
3.5.2 Auswahl der Kategorie oder neue Kategorie anlegen
Zuerst sollte der Autor die Kategorie festlegen zu der ein Begriff gehören soll, dies ist eine zwingende Angabe, dazu kann der Autor aus einer Liste von schon vorhandenen Kategorien auswählen und bestätigen.
Ist die vom Autoren gewünschte Kategorie nicht vorhanden muß er über den Menüpunkt Neu Kategorie anlegen diese definieren.
Abb. 21: Kategorieauswahl für einen Begriff.
Dieser Dialog verfügt über folgende Datenfelder:
Name: Ein Textfeld welches , ohne Vorgabe, Editierbar ist und angegeben werden muß.
Anwendung: Ein Pulldown-Menü in dem man die Anwendung auswählen kann, mit der Vorgabe der Anwendung zu der die Dokumentation gehört.
Oberkategorie: Ein Treecontrol in dem man die Kategorie auswählen kann.
Anmerkung: Ein Textfeld welches Editierbar ist und ohne Vorgabe eine Anmerkung angegeben werden kann.
Zeitstempel: Ein uneditierbares Feld welches das Datum und die Uhrzeit der Erstellung festhält.
Autor: Ein uneditierbares Feld welches den Loginnamen festhält.
Es Kann nicht gleichzeitig eine Anwendung und eine Oberkategorie ausgewählt werden, eins davon muß allerdings ausgewählt sein. Der Zeitstempel und der Autor werden automatisch eingetragen.
Es kann mit OK bestätigt werden oder über Abbruch der Dialog , ohne Speicherung der Daten, verlassen werden.
Abb. 22: Kategoriedefinition
Dieser Dialog wir nach der Kategorieauswahl gestartet und enthält folgende Datenfelder:
Bei der Anzeige einer Definition zu einem Begriff wird initial die als Hauptdefinition ausgezeichnete Definition angezeigt. Des weiteren sind noch folgende Buttons realisiert:
Für die Definition von Beziehungen zwischen Begriffen wird ein Treecontrol verwendet aus der man durch Auswahl oder sogar Drag&Drop die zu dem Begriff in Beziehung stehenden Begriffe in entsprechende Listen einfügt.
Abb. 23: Begriffsdefinition.
Ô in Word
Ein wichtiges Werkzeug, für die Verwaltung der Dokumente, in unserem Projekt ist Coninuus
Ô . Daher soll es dem Autoren, aus Word heraus, möglich sein eine gewisse ConinuusÔ - Funktionalität benutzen zu können. Diese Funktionalität beschränkt sich aber auf zwei Tasks an ConinuusÔ , dem Ein- und Auschecken. Diese Beiden Tasks sollen direkt in Word unter der Lade bzw. Speicheroption und in der Menüleiste auswählbar sein.