diub - Dipl.-Ing. Uwe Barth
 


Documenter


1 Einleitung

Documenter

Documenter soll die Erstellung von Dokumenten erleichtern, die in mehreren Formaten vorliegen sollen oder müssen. Dazu gehören

  • Statische HTML-Seiten
  • dynamisch eingebundene HTML-Seiten (PHP, include)
  • CHM Dateien (Windows 7 Hilfe)
  • ePub
  • TeX, XeTeX-Dateien für die Druckvorbereitung
  • PDF-Dateien via XeTeX (Portable Document Format) für Acrobat(R) Reader(R) kompatible Programme

Weiter geplant sind

  • RTF-Dokumente (RichText), die sich mit gängigen Textverarbeitungen nutzen lassen
  • PDF via RTF

Documenter bietet dabei einfache Elemente und deren grundlegende Formatierung:    

  • Texte mit unterschiedlichen Zeichensätzen, zum BEISPIELl
  • Bilder im Text
  • Figuren in Form von Bildern mit Bildunterschrift (als eigeständige Konten)
  • Tabellen mit Tabellenunterschrift (als eigenständige Knoten)

Ideen

Wie jedes andere Programm auch, spiegeln sich in Documenter einige grundlegende Ideen (Konzepte) wieder.

  • Die Struktur hat die Funktion eines Outliners: Kapitel, Artikel (Textabschnitte), Tabellen usw. lassen sich bequem verschieben und neu anordnen.
  • Dazu ist Documenter primär auf die Bedienung mit der Tastatur ausgelegt.
  • Das Programm ist bewusst einfach gehalten; viele Optionen anderer Programme werden selten bis nie genutzt.
  • Kein WYSIWYG. Um zu sehen, wie es im jeweiligen Format aussieht, muss dieses erzeugt werden.

Design

Das letztliche Erscheinungsbild wird dabei durch das jeweilige 'Backend' bestimmt. Für HTML und CHM lassen sich mittels Anpassung der Sequenzen sehr viele Möglichkeiten von HTML und CSS Formatierungen nutzen.

Auch die Ausgabe via XeTeX lässt sich durch Anpassung der Sequenzen oder der verwendeten Makro-Datei beeinflussen. An dieser Stelle sei jedoch Zurückhaltung empfohlen.

In der Zukunft sollen sich die Gestaltungselemente (Formatierungen usw.)

  • direkt im Programm einstellen lassen
  • als Vorlagen speichern und wieder verwenden lassen