#############################################################################################################
#  GRUNDKONFIGURATION DER content.txt  Ansatheus 2003-2006 - Steuerzeichen siehe Hilfe                     #
#<< 1  Die Anzahl der Zeichen in einer Reihe sollte 120 nicht berschreiten                           120 >>#
#############################################################################################################
#STATISTIK
~!AT Docunator
~AT Docunator
~Ansatheus  2003-2014
#~~Dateien und Verzeichnisse         | Steuerzeichen wird nur untersucht
~?letzte Bearbeitung der content.txt| Steuerzeichen wird nur untersucht
#############################################################################################################
#INHALT
<center>
%%AT Docunator
%Quellcode-Dokumentations-System</center>
=
%Einleitung
Ausgehend vom Umgang mit Dokumentationssystemen wie JavaDoc, PHPDoc, PHPDocumentor etc. war mir das alles
irgendwie zu zeitraubend, zu komplex. Sich mit den einzelnen Doctags im Quellcode herumzuschlagen find ich
nervig. Nun mag jeder anderer Meinung sein; fr mich sind diese ganzen mittlerweile doch recht komplexen
Dokumentationssysteme zu aufreibend. Auch haben mich immer die festgeschriebenen DocTags genervt. Und da
ich mich schon seit Jahren mit diversen Facetten des Themas Dokumentation beschftige, habe ich mir
kurzerhand einen eigenen Dokumentations-Generator fr Quelltexte gebaut - den AT Docunator.

%Architektur
AT Docunator basiert auf dem AT Contenator, einem PHP-Framework, und ist als Ordner-Plugin ausgefhrt.
Das heit, da der Docunator Ordner in jedes beliebige Contenator-System in den Root oder einem
Unterordner kopiert (installiert) werden kann und sofort zur Verfgung steht. Ebenso kann er auch
einfach wieder durch lschen des Ordner deinstalliert werden.

%Was er kann
Er generiert anhand von festgelegten Grabzeichen (von grabben, greifen), die einem Kommentar vorangestellt werden,
eine fertige HTML-Dokumentation des Quelltextes. Dabei bercksichtigt er selbstdefinierte DocTags und zeichnet sie
in fetter Schrift aus. Jeder dokumentierbare Bereich wird in einen eigenen Rahmen gesetzt. Alle dokumentierten
Dateien stellt er links in einem Men dar. Bilder und Grafiken werden in den Zielordner kopiert und
knnen ebenfalls aufgerufen/angezeigt werden. Dabei ist es unerheblich, in welchem Unterverzeichnis die
Dateien liegen. Zudem werden alle Dateien im Men aufsteigend sortiert. Welche Dateiarten als Dokumentation
generiert werden sollen, kann in der docunator.config.dat eingestellt werden. Der ebenfalls in dieser
Datei eingestellte Style wird in die Dokumentation kopiert und ihr zugeordnet.
Vorhandene Quellcode-Dateien, die mit den blichen DocTags fr PHPDoc daherkommen, knnen ebenso als
Dokumentation generiert werden. Dazu mssen diese Doctags in der docunator.doctag.dat eingetragen werden.


%Wie es funktioniert
- in der docunator.config.dat Quell- und Zielpfad einstellen - relative Pfadangaben -> Standardeinstellung vorhanden
- ebenso Grabzeichen, Titel, Deckblatt und die zu generierenden Dateiarten -> Standardeinstellung vorhanden
- in der docunator.doctag.dat die gewnschten DocTags eintragen -> Standardeinstellung vorhanden
- zu dokumentierenden Quellcode in den Quellordner kopieren (einfach z.B. ein PHP-Projekt samt Unterordner reinkopieren)
- im Men ^Docunator^ auf den Button ^Dokumentation generieren^ klicken -> die Dokumentation wird generiert
- abschlieend auf den Link ^Generierte Dokumentation anzeigen^ klicken -> Dokumentation wird angezeigt


%Haftungsausschlu
Der Einsatz von AT Docunator ist auf eigene Gefahr. In keinster Weise kann eine Haftung in irgendeiner Weise
durch die Benutzung des Docunators bei Ausfall oder anderweitigen Schden an Systemen oder Peripherie durch dessen
Einsatz hergeleitet werden. Alle erwhnten Markennamen/Markenzeichen gehren den jeweiligen Firmen/Personen.


%Abschlieende Bemerkungen
Die Generierung von Quellcode-Dokumentationen ist mit dem Docunator ganz einfach und vllig unkompliziert. Es wird
jede Art von Quellcode verschiedenster Programmiersysteme akzeptiert. Vorraussetzung ist natrlich, da sich dessen
Programmierer an festgelegte und einfache Regeln halten. Das sollte jedoch nicht schwer sein, da das Konzept von
AT Docunator auf Einfachheit ausgelegt ist.

In diesem Sinne wnsche ich viel Spa damit. Wenn Fragen sind und/oder Verbesserungs-/nderungswnsche bestehen,
kann man mich jederzeit kontakten.