{PROJECT} ../../template/doc.de.ini {MENU} 00.06.12 {TITEL} Alles über PAX {CONTENT}

- Wie funktioniert PAX? Warum PAX?
- Einbindung von PHP im Template
- Was sind PAX TAGS?

- PAXINC Einbindung von weiteren Templates oder anderen Dateien
- PAXHIGHLIGHT
  PHP-Syntaxhighlighting
- PAXMENU Zugriff auf Menüwerte
- PAXCOMBO
  Erstellung eines einfachen DropDown Menüs
- PAXCOMBOALL
  DropDown Menü aller vorhandener Menüs
- PAXLASTMOD
  stellt das letzte Aktualisierungsdatum der Seite dar

- Globale Werte
- Fehlerquellen

Wie funktioniert PAX? Warum PAX?

Ist PAX im GUI aktiviert, wird das Template vor der Übergabe an phpCMS an PAX übergeben um diverse Erweiterungen schon im Vorfeld auszufiltern. So kommt phpCMS nicht durcheinander und PAX kann auch weiterentwickelt werden, ohne weitere grössere Eingriffe im Parser von phpCMS vornehmen zu müssen.
Wie von phpCMS bekannt, werden Scripte, die über das Feld {SCRIPT} eingebunden sind, dynamisch zur Laufzeit in die Ausgabe eingebunden. Sollte Servercache aktiviert sein, wird die Seite jedoch auch im Cache abgelegt (obwohl dynamisch). Im Cache wird aber eben nur jener Teil abgelegt, welcher statisch ist, sich also zur Laufzeit nicht verändert.
Von dieser Funktionalität macht auch PAX gebrauch.

PAX benötigt man, wenn PHP in Templates eingebunden werden soll.
Weiters gibt es mit PAX verschiedene TAGS (PAXTAGS), welche bestimmte Eigenschaften haben.

Bisher war es in phpCMS nicht möglich PHP in Templates einzubinden. Es bestand nur die Möglichkeit, wie schon oben angeführt, über {SCRIPT} externe Scripte in einer Contentseite einzubinden. Da ich aber zum Zeitpunt der PAX-Idee Bedarf hatte, ein Umfragescript auf jeder Seite einzubinden, musste ich mir Gedanken machen wie das funktionieren könnte, ohne in jeder Contentdatei das Feld {SCRIPT} anführen zu müssen. Und so entstand eben PAX *g*

Einbindung von PHP im Template

Primär gilt es zu beachten, daß man mit PAX keine Debugging-Funktionalität für PHP hat!
Die Einbindung von PHP im Template geschieht auf sehr einfache Weise und auf eigene Gefahr:

Beispiel:
<!-- PAXPHP Blockbezeichnung
echo 'Hello World!';
PAXPHP Blockbezeichnung -->

- PHP muss immer in einen Block geschrieben werden. Diesen filtert PAX im Vorfeld aus und verbindet vor der Ausgabe den von phpCMS erzeugten Code mit dem von PAX
- Die "Blockbezeichnung" darf NICHT zweimal vorkommen, egal in welchem Template!
- In "Blockbezeichnung" dürfen Buchstaben in Gross/Kleinschreibung, Unterstriche und Zahlen verwendet werden. KEINE LEEREZEICHEN und KEINE SONDERZEICHEN ( A-Z , a-z , _ , 0-9 )
- Der Block besteht immer aus einem Beginntag und einem Endetag (<!-- PAXPHP Blockbezeichnung und PAXPHP Blockbezeichnung -->)
- Die Trennung mit Leerzeichen des PAXPHP-Tags und der Blockbezeichnung sind wichtig!
- Die üblichen Anfangstags ( <? , <?php ) und das Schlusstag ( ?> ) von PHP dürfen nicht vorkommen.

Wie man am Beispiel sieht, ist es sehr einfach PHP einzubinden.

Was sind PAX TAGS?

- PAXTAGS sind grundsätzlich in Templates oder/und Contentdateien verfügbar
- PAXTAGS sind immer statisch. Das heisst, beim Ändern einer Contentdatei wird auch das PAXTAG angepasst. Sollte ein PAXTAG in einem Template verändert werden, so ist der Cache zu löschen, falls aktiviert.

---------------

Mit PAXTAGS wird die Funktionalität von phpCMS um einige interessante Features erweitert.

PAXINC: Einbindung von weiteren Templates oder anderen Dateien

Mit PAXINC können weitere Templates oder Dateien an beliebiger Stelle im Template eingebunden werden.
Vorhandene Links werden NICHT überprüft!

TAG:
PAXINC
SYNTAX:
<!-- PAXINC /pfad/vom_docroot/zu/template/oder/datei.html -->
oder
<!-- PAXINC http://www.domain.net/daten.html -->

---------------

Beispiel:
<!-- PAXINC http://phpcms.de/phpcms/doku/paxtest_de.html -->
ergibt bei aktivierten PAXTAGS:

Es können natürlich in den extern einzubindenden Templates oder Dateien weitere PAXTAGS geschrieben werden.

PAXHIGHLIGHT: PHP Syntaxhervorhebung

PAXHIGHLIGHT bietet eine farbliche Syntaxhervorhebung für PHP Quellcode.
PAXHIGHLIGHT eignet sich in erster Linie für auf dem eigenen Server befindliche PHP-Dateien. Wird hingegen per HTTP auf Dateien zugegriffen, kann sich die Syntaxhervorhebung naturgemäss nur auf den vom Server zurück gegebenen Code beziehen - nicht auf den Quellcode der jeweiligen Datei.
Zur syntaktischen Hervorhebung werden die im eingebauten Syntax Highlighter Ihrer PHP-Installation definierten Farben verwendet.

TAG:
PAXHIGHLIGHT
SYNTAX:
<!-- PAXHIGHLIGHT /pfad/von_root/zu/template/oder/datei.php -->
oder
<!-- PAXHIGHLIGHT http://www.domain.net/data.php -->

Wenn die Variable $home definiert ist, kann diese ebenfalls verwendet werden.
---------------

Beispiel:
steht PAXTAGS im GUI auf "On", sehen Sie hier den syntaktisch hervorgehobenen Quellcode der Datei "/demo/user.php".

PAXMENU: Zugriff auf Menüwerte

Mit PAXMENU ist die Möglichkeit gegeben, auf jedes Menüfeld zugreifen zu können.

TAG:
PAXMENU
SYNTAX:
<!-- PAXMENU FIELDNAME,CLASS -->

---------------

einfaches Beispiel:
Nehmen wir an, ich möchte einen Link zu einem Menüeintrag auf einer Seite oder in einem Template haben, dann wird dies wie folgt erreicht:

<a href="<!-- PAXMENU LINK,00.08.06.12 -->"><!-- PAXMENU MNAME,00.08.06.12 --></a>
Dies würde einen Link auf einen Menüpunkt mit seinem Feldwert ergeben.
Ausgabe bei aktivierter PAXTAGS Unterstützung:

---------------

Beispiel mit Titel (für IE), Zielframe/fenster und Statustextanzeige beim Mouseover:

<A HREF="<!-- PAXMENU LINK,00.08.06.12 -->" TARGET="<!-- PAXMENU TARGET,00.08.06.12 -->" onMouseOver="window.status='<!-- PAXMENU TEXT,00.08.06.12 -->';return true;" title="<!-- PAXMENU TEXT,00.08.06.12 -->"><!-- PAXMENU MNAME,00.08.06.12 --></a>
Ausgabe bei aktivierter PAXTAGS Unterstützung:

Meine MenüFelder sehen wie folgt aus:
LINK und CLASS sind ja Pfilchtfelder von phpCMS, also gibt es hierbei auch keine Unterschiede in der Schreibweise!
TARGET: Zielfenster oder -frame für LINK
TEXT: Soll in der Statuszeile dargestellt weden.
MNAME: Feldname für Menübezeichnung

---------------

Zusammengefasst kann man auf jedes Menüfeld zugreifen, welches man in der .mnu-Datei auch definiert hat.

PAXCOMBO: Erstellung eines einfachen DropDown Menüs

PAXCOMBO kann verwendet werden, um ein Drop-Down Menü für ein einzelnes in der Menü-Datei definiertes Menü zu erzeugen.
PAXCOMBO funktioniert möglicherweise nur im non-Stealth-Mode einwandfrei!
Das angegebene Menü muss einen eindeutigen Namen tragen!
Wenn ein Menü doppelt vorkommt (zb. SUB1), kommt es zu Fehlern bei der Darstellung!
Die Links werden grundsätzlich ausgehend von $home gesetzt!

TAG:
PAXCOMBO
SYNTAX:
<!-- PAXCOMBO MENUNAME,FIELDNAME,VALUES,SELECTED,SIZE,MULTI,ONCHANGE,FIRSTENTRY -->

MENUNAME | MENU:MAIN > hier wäre MAIN richtig. Darf in der Menüdatei nur ein mal vorkommen!
FIELDNAME | Welcher Feldinhalt soll angezeigt werden? LINK, TEXT, NAME, usw...
VALUES | optional - welcher Feldinhalt soll als Wert eingefügt werden. Ganz brauchbar für zb. automischen Linklisten. Wenn nichts angegeben, wird der Wert von FIELDNAME eingetragen.
SELECTED | optional - welche Zeile des angezeigten Menüs soll den Focus erhalten
SIZE | optional - Wie gross soll die Liste sein (in Zeilen)
MULTI | (on/off) optional - Soll Multiselect erlaubt werden?
ONCHANGE | (on/off) optional - Soll ein automatischer onselect bei eintragsaktivierung eingetragen werden? Praktisch für Linklisten
FIRSTENTRY | optional - Text der als erster Eintrag angezeigt werden soll. zb: ~ select an entry ~

---------------

Beispiel:
<!-- PAXCOMBO SUB1, TEXT, LINK,, 1, off, on, ~ select your favorite ~ -->
ergibt bei aktivierten PAXTAGS:

PAXCOMBOALL: Erstellung eines DropDown Menüs aus allen definierten Menüs

PAXCOMBOALL kann verwendet werden, um ein automatisches Drop-Down Menü aller in der Menü-Datei definierten Menüs zu erzeugen.

TAG:
PAXCOMBOALL
SYNTAX:
<!-- PAXCOMBOALL FIELDNAME,SIZE,MULTI,ONCHANGE,FIRSTENTRY -->

FIELDNAME | Welcher Feldinhalt soll angezeigt werden? LINK, TEXT, NAME, usw...
SIZE | optional - Wie gross soll die Liste sein (in Zeilen)
MULTI | (on/off) optional - Soll Multiselect erlaubt werden?
ONCHANGE | (on/off) optional - Soll ein automatischer onselect bei eintragsaktivierung eingetragen werden? Praktisch für Linklisten
FIRSTENTRY | optional - Text der als erster Eintrag angezeigt werden soll. zb: ~ select an entry ~

---------------

Beispiel:
<!-- PAXCOMBOALL TEXT, 1, off, on, phpCMS Dokumentation -->
ergibt bei aktivierten PAXTAGS:

PAXLASTMOD: stellt das letzte Aktualisierungsdatum der Seite dar.

TAG:
PAXLASTMOD
SYNTAX:
<!-- PAXLASTMOD d.m.Y - H:m:s -->

---------------

Beispiel:
<!-- PAXLASTMOD d.m.Y - H:m:s -->
ergibt bei aktivierten PAXTAGS:
zur Formatierung der Ausgabe werden die Werte, die für den PHP Befehl date verwendet werden, herangezogen.

Globale Werte

Grundsätzlich stehen im PHP-Code alle globalen Werte zur Verfügung, die vor dem Einlesen der Seite in phpCMS vorhanden sind. Welche das sind, entnimmt man am besten der Dokumentation für phpCMS.
Nicht alle für Plug-ins beschriebenen Variablen stehen bereit. Hier heisst es experimentieren. Eine genaue Aufstellung werde ich laufend auf http://lemon.ac bekanntgeben.
Übergabe von Parametern ist natürlich ebenso möglich: http://domain.net/index.htm?&var=red
Auch $PHP_SELF steht in unveränderter Form bereit. So könnte man eine Ausführung oder Anzeige von bestimmten Teilen im Code von der dargestellten Seite abhängig machen.

Fehlerquellen

Derzeit sind keine bekannt. Wenn man sich an die Richtlinien von phpCMS, PAX und PHP hält, dürfte nichts schief gehen.

Tips&Tricks&FAQ zu PAX unter lemon.ac - BBS
Viel Spass ... Wernhard