Module dokumentieren und vergleichen

Mit dem Befehl „Dokumentation erzeugen“ (im Menü Datei und Menü Extras)¹⁾ kann ²⁾ eine Darstellung des Inhalts des aktuellen Objekts in Word-Format erstellt werden. Im ersten Schritt enthält diese Dokumentation nur die Implementierung von Schriftgut.

Für das Erstellen der Dokumentation muss über den Speichern-Dialog eine Datei ausgewählt werden. Falls dieser Pfad nicht schreibbar ist (z.B. weil dort bereits ein Dokument existiert, welches schreibgeschützt oder in einer Anwendung geöffnet ist), wird ein Fehlersymbol angezeigt. Über die Checkbox „Kompakt“ kann angegeben werden, dass die Dokumentation keine Kommentare usw. enthalten soll. Wenn die Checkbox „Erzeugtes Dokument anzeigen“ angekreuzt ist, wird das erzeugte Dokument in Word angezeigt. Außerdem kann das Format der erstellten Dokumentation über den Tab „Layout“ im angezeigten Dialog beeinflusst werden:

Das Design legt die Farben und sowie die Schriftarten für Überschriften und Text für das Dokument fest. Abweichende Schriftarten für Text und Überschrift können in den entsprechenden Comboboxen ausgewählt werden.

Für Tabellen kann zwischen drei Standard-Formaten gewählt werden. Die Farbe für die Tabellen kann aus den im Design angegebenen Akzentfarben ausgewählt werden. Außerdem kann angegeben werden, welche Schriftart für Tabellen genutzt werden soll, welche mit einem Fixed-Font dargestellt werden müssen (z.B. Entscheidungstabellen).

Mit dem Knopf „Als Standard festlegen“ werden die gewählten Einstellungen in die TAA-Registry geschrieben und für weitere Dokumentationserzeugungen verwendet.

Durch die Nutzung von Designs ist es leicht möglich, bei der Anzeige des Dokuments in Word die Darstellung durch Anpassung von Design, Schriftart- oder Farbschema, bzw. pro Tabelle durch Auswahl eines anderen Tabellenlayouts anzupassen.

Falls zusätzliche Designs (z.B. Alte-Leipziger Standard) oder Tabellenformate angeboten werden sollen, können wir diese in die Auswahl aufnehmen.

Es wäre leicht möglich, auch die Modulschnittstelle auf diesem Weg zu dokumentieren, sodass Dokumentation für alle Objekte vom Typ MODL erzeugt werden könnte.

Auch ein Batch-Aufruf für die Dokumentationsgenerierung wäre problemlos machbar.

Der Befehl „Dokumentation vergleichen“ vergleicht die Dokumentation zu zwei Versionen des aktuellen Objekts miteinander. Bei dem Vergleich wird immer das aktuell angezeigte und ggf. bearbeitete Dokument mit dem Dokument aus der im Dialog ausgewählten Quelle verglichen.

Das Vergleichsdokument kann aus einer Rochadestufe oder als Laufzeitdefinition ausgewählt werden. Im Falle von Laufzeitdefinitionen (Resource-Dll) wird überprüft, ob in dem angegebenen Provider eine Instanz des Objekts vorhanden ist; falls nein, wird ein Fehlersymbol angezeigt.

Die zum Vergleich erzeugten Dokumente enthalten kein Inhaltsverzeichnis und keine farbige Darstellung von Texten (z.B. Pseudocode), um keine unnötigen Differenzen zu erzeugen bzw. die Differenzen in Word besser erkennbar zu machen.

Wenn beide Dokumenente aus EDB-Rochade stammen, kann gewählt werden, ob Kommentare, Überschrift usw. berücksichtigt werden sollen (Checkbox „Kompakt“). Andernfalls werden die Dokumente immer im Kompakt-Modus erzeugt.

Wenn ein Dokument in Bearbeitung ist und noch nicht gespeichert wurde, können auch die Differenzen zwischem dem geänderten Stand und dem aktuellen Stand in Rochade so aufgezeigt werden.

Nach Erstellung der beiden Dokumentationen als temporäre Dateien wird Word im Vergleichsmodus mit diesen Dateien aufgerufen:

• Inhaltsverzeichnis ³⁾
• ggf. Kommentar zum Objekt ⁴⁾
• Entscheidungstabelle (Iteration, Bedingungen, Aktionen)
• Inhalt der Bedingungen und Aktionen, wobei Pseudocode in demselben Format (farbig) dargestellt wird ⁵⁾ wie in KnowlEdge/ReflEdge.
• Liste der verwendeten SGPV
• List der sonstigen Schriftgut-Angaben, z.B. Dateiname von statischem Dokument, OpenXml-basierend, …
• Textbausteine: Textkonserven
• Diagrammbausteine: Darstellung des Diagramms