modul.ordner.docunator_class_html.php

AUTOR: Andreas Theusner, © 2009 - ansatheus@gmx.net - http://www.ansatheus.de
PROGRAMM: AT Contenator
DATEI: modul.ordner.docunator_class_html.php
ZWECK: - HTML-Klasse für die Erzeugung der Dokumentation
EINBINDUNG: require_once("modul.ordner.docunator_class_html.php");
  $html = new html; - neue Instanz
WICHTIG: durch obige Einbindung erfolgt die Initialisierung der Klasse, die wichtig ist, denn
  der direkte Aufruf der Funktionen klappt nicht immer
FUNKTIONSAUFRUF: alle beschriebenen Aufrufarten gelten für alle Funktionen, außer dem Konstruktor
  $ergebnis = $html->function(Parameter) - Instanz
  $ergebnis = html::function(Parameter) - direkt
  $ergebnis = $this->function(Parameter) - in der Klasse
LIZENZ: GNU General Public License
  Dieses Programm ist freie Software. Sie können es unter den
  Bedingungen der GNU General Public License, wie von der Free
  Software Foundation veröffentlicht, weitergeben und/oder
  modifizieren, entweder gemäß Version 2 der Lizenz
  Die Veröffentlichung dieses Programms erfolgt in der Hoffnung,
  daß es Ihnen von Nutzen sein wird, aber OHNE IRGENDEINE GARANTIE,
  sogar ohne die implizite Garantie der MARKTREIFE oder der
  VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Details finden Sie
  in der GNU General Public License.
 
  Sie sollten eine Kopie der GNU General Public License zusammen
  mit diesem Programm erhalten haben. Falls nicht, schreiben Sie
  an die Free Software Foundation,
  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

NAME: function html()
ZWECK: Konstruktor der Klasse
AUTOR: Andreas Theusner , 18.05.2009
AUFRUF:
PARAMETER:
  FUNKTIONALITÄT:
STATUS:
BEMERKUNG:

NAME: function header($title="Docunator",$rueckgabe = False)
ZWECK: generiert den Kopf eines HTML-Dokumentes
AUFRUF: siehe Dateikopf
PARAMETER:
  $title = Titel der Website
  $rueckgabe = True/False -> wenn True, werden die Daten zurückgegeben, ansonsten geschrieben
BEMERKUNG: - heredoc-Syntax muß an erster Zeile anfangen und enden, deshalb diese Struktur
  - hinter dem schließenden heredoc-Tag darf hinter dem Semikolon keine Leerzeichen
  mehr sein, sonst funktioniert das Ganze nicht

NAME: function footer(,$rueckgabe = False)
ZWECK: generiert den Fuß eines HTML-Dokumentes
AUFRUF: siehe Dateikopf
PARAMETER: $rueckgabe = True/False -> wenn True, werden die Daten zurückgegeben, ansonsten geschrieben
BEMERKUNG: - heredoc-Syntax muß an erster Zeile anfangen und enden, deshalb diese Struktur
  - hinter dem schließenden heredoc-Tag darf hinter dem Semikolon keine Leerzeichen
  mehr sein, sonst funktioniert das Ganze nicht

NAME: function frameset($dateilinks, $dateirechts, $title="Docunator",$rueckgabe = False)
ZWECK: Frameset generieren
AUTOR: Andreas Theusner , 22.05.2009
AUFRUF: siehe Dateikopf
PARAMETER:
  $dateilinks = linker Rahmen - in der Regel das Menü
  $dateirechts = rechter Rahmen - in der Regel der Inhalt
  $title = Titel der Dokumentation
  $rueckgabe = True/False -> wenn True, werden die Daten zurückgegeben, ansonsten geschrieben
  FUNKTIONALITÄT:
STATUS:
BEMERKUNG:

NAME: function form_quelle_ziel()
ZWECK: Form für Auswahl von Quelle der Dateien und Ziel für die Ausgabe der Dokumentation
AUTOR: Andreas Theusner , 18.05.2009
AUFRUF: siehe Dateikopf
PARAMETER:
  FUNKTIONALITÄT:
STATUS:
BEMERKUNG:

- Generiert mit dem Docunator am 2009-06-25 -