Documenter - Online-Dokumentation


2 Formate

Dem Wunsch folgend möglichst viele Zieleformate zu unterstützen werden verschiedene Werkzeuge von Drittanbietern genutzt. Die Einschränkungen eines solchen Werkzeuges lassen sich naturgemäß mit Documenter nicht umgehen. Zudem bietet nicht jedes Format alle Möglichkeiten eines anderen Formats.

Daneben gibt es auch Beschränkungen (und Fehler) innerhalb von Documenter, die sich jedoch meißt recht einfach umgehen lassen (Workaround) .

2.1 CHM - Windows Hilfe

CHM basiert auf einem Mix von HTML und CSS, also den grundlegenden Elementen einer WebSeite. Eine CHM Datei ist damit eine Sammlung von Texten, Formatierungen und Bildern in einer Datei, die mit einer zusätzlichen Menüstruktur versehen und von einem MS-eigenen Programm, dem frei erhältlichen HTML Help Workshop, erzeugt wird. Für die Darstellung wird auf Teile des Internet Explorers zurückgegriffen.

Für eine einfache Installation unter Windows finden Sie im Programm unter Menü→Optionen→Allgemein→Pfade einen direkten Link zum Herunterladen.

2.2 Dynamisches HTML

Damit sind in HTML und CSS definierte (statische) Dateien gemeint, die allerdings keine Header usw. enthalten. Sie werden zum Beispiel durch ein Server-seitiges PHP-Skript dynamisch in eine Web-Seite eingebunden. Als Ergänzung wird eine Datei generiert, die die Menüstruktur abbildet.

2.3 OpenDocumentText

OpenDocumentText ist ein offenes XML/ZIP-Format, das ursprünglich mir OpenOffice eingeführt wurde. Es wird mittlerweile praktisch von allen etablierten Textverarbeitungsprogrammen gelesen und geschrieben.

2.4 ePub

Electronic Publishing ist ein neueres Format. Wirkliche revolutionäre Neuerungen enthält es meiner Meinung nach aber nicht. Eine ePub Datei ist nämlich nichts anderes, als eine ZIP-komprimierte Datei, die wiederum HTML- und CSS-Dateien enthält, sowie zusätzliche Dateien für die Menüstruktur. Vom Ansatz also einer CHM-Datei sehr ähnlich, allerdings nicht nur auf Windows-Systemen nutzbar und ein offenes Format.

Leider gibt es eine Unzahl an Variationen, welche Inhalte denn ein Reader unterstützt oder auch nicht oder wie diese interpretiert werden!

Hilfe zur Auswahl finden Sie unter Praeambel.

2.5 PDF - Portabe Document Format

Das Layout-treue Format von Adobe kann Documenter nicht direkt erzeugen. Mit einem installierten LibreOffice 7 kann aus der ODT-Datei aber automatisch eine PDF-Datei erzeugt werden.

Tragen Sie unter Optionen→Allgemein→Programmpfade→ODT den Pfad zum Programm "swriter.exe" ein. (Meist unter "C:\Program Files\LibreOffice x.y\program" zu finden.)