Praktisches & Grundsätzliches zur Informatik

Projectweb Generator projweb.exe

Ein Project Web Generator

Wer meinen Artikel

Wie sollte man Software-Dokumentation gestalten?

gelesen hat, könnte den Wunsch haben, selbst ein sogenanntes Project Web zu generieren.

Das Werkzeug, das ich dazu benutze — docs2web.zip — ist Freeware. Zu seiner Installation muss man lediglich das ZIP File entpacken und den Pfad hin zum dann entstandenen Verzeichnis (docs2web) mit in die PATH Variable des eigenen Rechners schreiben.

Es handelt sich um ein Command Line Tool. Aufruf ohne Parameter zeigt eine Kurzanleitung. Vorher aber sollte man das

Handbuch zum Gebrauch des Generators

gelesen haben (4 Seiten).

Sample_ProjectWeb ist ein schon generiertes Sample Web. Wie dieses Beispiel zeigt, enthält die Ein­gangsseite jeden Projectwebs über Links

README   und   SeeTEMPLATES

erreichbare Dokumentation zum Web selbst. Sie kann (und sollte) projektspezifisch angepasst sein: Beide PDF Dateien findet man als per MS Office editierbare RTF Dateien im Verzeichnis docs2web/doc — zur Anpassung hat man sie lediglich zu editieren und dann die neben ihnen stehenden PDF Versionen neu zu generie­ren. Jene werden von hier automatisch in jedes Web mitgenommen.

Wer das nicht möchte (etwa dann, wenn er ständig Webs unterschiedlicher Art neu generiert), kann diese Daten im erzeugten Web selbst austauschen über das Batch File, aus dem heraus er es per projweb.exe generiert.

Natürlich kann dieser Generator auch dazu verwendet werden, ein oder mehrere Dateien nach HTML zu bringen nur in der Absicht, sie als Lexikon einsehbar zu machen (ihren Inhalt also gut indiziert zu haben). In den Index aufgenommen werden mindestens alle Substantive, die in einer Kapitelüberschrift enthalten sind.

Mein kleines Sample_Lexikon
Zu Agiler Methodik

etwa führt vier Dokumente zusammen über einen einzigen Index. Notwendig hierfür war nur das Erstellen dieser Konfigurationsdatei (die Zeile -o noCards bewirkt, dass statt eines Projektwebs ein Lexikon ent­steht). Nachdem jedes Kapitel, welches Unterkapitel hat, im Lexikon ein Inhalts­ver­zeichnis hat, kann man diesen Abschnitt dann referenzieren wie ein eigenes Dokument. Hier ein Beispiel:

The Capability Maturity Model (CMM).


Wissenswertes zu "Projectweb Generator projweb.exe" zusammengestellt durch Gebhard Greiter.
tags: Generator1gegreit Lexikon1gegreit Projectweb1gegreit