[Release] ETMuS - Simple template system

+----------+
| English |
+----------+
Hi all,

I am proud to release my third work now: ETMuS - Extendable Template Markup Script. I will also publish some plugins for this release soon. Those will include a plugin for MySQL and MSSQL database connections. I started this project quite a while ago and was always extending it and adding some features.

I hope that this script helps someone out there to create complex sites with a low cost of time building up the base for it. It was developed to have very simple template script which keeps the HTML (Design) parts away from the PHP (Coding) ones.

Requirements:

bcompiler
PHP >= 5.3

You can find the files and some examples at my filespace here: [Only registered and activated users can see links. Click Here To Register...]
The documentation can be found here: [Only registered and activated users can see links. Click Here To Register...]

How to use?
First you have to get the singleton instance of the ETMuS class by using:

PHP Code:


			
$instance = +OutstandDesig+ETMuS+ETMuS::getSingleton();

Note: + should be a backslash (\) but unfortunatly it is cut off here :(

Now you can use the following options:

User defined variables
by writing

PHP Code:

$instance->UserDefined = "42";

you can use
HTML Code:
```
<<UserDefined>>
```
in your design files as variable and it will be parsed to 42
Predefined variables
by writing

PHP Code:

$instance->Pagetitle = "1337";

you can use the predefined
HTML Code:
```
<<PAGETITLE>>
```
to set the page title. A full list with all predefined variables can be found in the documentation.
Navigation
You can add a new Navigationpoint by using

PHP Code:

$instance->NavigationAddLink($menuname, array("name" => linkname, "url" => linkurl[, "active" => false])[, $parentmenuname]);

In your designfiles you can use the navigation by writing
HTML Code:
```
<<NAV:MENUNAME>>
```
This will include the following files from your designfolder in the following order:
navigation_start_MENUNAME.html
navigation_substart_MENUNAME.html
navigation_1_MENUNAME_off.html/on.html for each navigationlink
navigation_2_MENUNAME_off.html/on.html for each sublink
navigation_subend_MENUNAME.html
navigation_end_MENUNAME.html
If one or more files are not available they will be skipped and a notice will be thrown.
Tables
You can use tables if you have content that returns a few times for example a <table> with 5 rows and 2 columns, you can write a foreach or equal which contains the following line:

PHP Code:

$instance->TableData_TestTable = array("key1" => "value1", "key2" => "value2");

This line will add a row to the TestTable. Each row will be the content of the TestTable.html (in the design folder). The vars will be replaced by the value of the specified key (key1, key2). These keys need to be written as
HTML Code:
```
[<KEY1>] or [<KEY2>]
```
within the table template to avoid conflicts with same-named "global" variables.
A table is marked by using
HTML Code:
```
<<INCLUDE:TESTTABLE:TABLE>>
```
in your design file
Includes
Files from your Designfolder can be included by using
HTML Code:
```
<<INCLUDE:INCFILE>>
```
in your design files. This tag will include the incfile.html file. The content will be parsed for further tags.
Privileges
If

PHP Code:

$instance->User != NULL

, the content between
HTML Code:
```
<<PRIVILEGE:LOGGEDIN>> and <</PRIVILEGE:LOGGEDIN>>
```
will be displayed.
You can negate this expression by using
HTML Code:
```
<<!PRIVILEGE:LOGGEDIN>> and <</PRIVILEGE:LOGGEDIN>>
```
A more complex Privileges plugin is already in development.

A full list of the currently supported features can be found in the download files. The folder structure needs to be used as is. Each example is a single page with an identifiying name.

You can ask me here or in skype if you have any questions. I can help you also in building up a new webpage if you have any problems.

+-----------+
| Deutsch |
+-----------+
Hallo zusammen,

ich freue mich euch heute hier meine dritte Ver�ffentlichung zu pr�sentieren: ETMuS - Extendable Template Markup Script. Ich werde in naher Zukunft weitere Erweiterungen f�r das Skript zur Verf�gung stellen, darunter auch eine Erweiterung f�r MySQL und MSSQL Verbindungen. Ich habe mit diesem Projekt schon einer halben Ewigkeit angefangen und seit dem kontinuierlich ausgebaut und verbessert.

Ich hoffe, dass dieses Skript einigen dabei hilft mit einfachen Mitteln gr��ere Projekte in sehr kurzer Zeit zu verwirklichen. Desweiteren ist das Skript speziell darauf ausgelegt, das Design vom PHP-Quelltext zu trennen um neue Designs blitzschnell anzupassen und einzupflegen genauso wie neue Features.

Vorraussetzungen:

bcompiler
PHP >= 5.3

Die ben�tigten Dateien und Ordner sowie einige Beispiele finden sich auf hier: [Only registered and activated users can see links. Click Here To Register...]
Die Dokumentation findet sich in Englisch hier: [Only registered and activated users can see links. Click Here To Register...]

Wie funktionierts?
Zu aller erst sollte man sicherstellen, dass man eine Instanz erh�lt. Dazu folgende Funktion abrufen:

PHP Code:


			
$instance = +OutstandDesig+ETMuS+ETMuS::getSingleton();

Beachtet: Das + sollte eig. ein \ darstellen. Leider werden die im PHP-Code-Tag entfernt :(.

Nachdem die Instanz abgerufen wurden, kann man nun folgendes damit machen:

Benutzerdefinierte Variablen
durch

PHP Code:

$instance->UserDefined = "42";

kann man in den Designdateien folgende Konstrukt verwenden:
HTML Code:
```
<<UserDefined>>
```
Dies wird nach dem Parsen zu 42.
Vordefinierte Variablen
Vordefinierte Variablen m�ssen nicht explizit gesetzt werden, da sie bereits einen Wert besitzen.

PHP Code:

$instance->Pagetitle = "1337";

Setzt den Seitentitel auf 1337, wenn man folgendes Tag in den Designdateien unterbringt:
HTML Code:
```
<<PAGETITLE>>
```
Eine ausf�hrliche Dokumentation aller Vordefinierten Variablen findet sich in der Doku (siehe oben)
Navigation
Ein Navigationspunkt f�r ein Men� kann durch folgende Funktion hinzugef�gt werden:

PHP Code:

$instance->NavigationAddLink($menuname, array("name" => linkname, "url" => linkurl[, "active" => false])[, $parentmenuname]);

Nun kann ein oder mehrere zusammengeh�rige Links durch das folgende Tag plaziert werden:
HTML Code:
```
<<NAV:MENUNAME>>
```
Dadurch werden nun folgende Dateien eingebunden:
navigation_start_MENUNAME.html
navigation_substart_MENUNAME.html
navigation_1_MENUNAME_off.html/on.html f�r jeden Navigationslink innerhalb eines Blocks
navigation_2_MENUNAME_off.html/on.html f�r jeden Sub-Navigationslink innerhalb eines Blocks
navigation_subend_MENUNAME.html
navigation_end_MENUNAME.html
Falls eine oder mehrere Dateien nicht vorhanden sind (oder nicht ben�tigt werden), so werden diese �bersprungen und eine Notice wird ausgegeben.
Tabellen
Tabellen kommen dann zum Einsatz, wenn man einen gewissen Inhalt mehrfach wiederholen muss und sich nur einzelne Positionen �ndern z.b. eine Tabelle oder auch Warenliste mit 10 Gegenst�nden (mit individueller Beschreibung, Preis etc.). In solchen F�llen werden die Daten i.d.R. per PHP aus einer DB/Datei/Array geladen. Durch eine Foreach/While/For wird dann der folgende Befehl f�r jede Zeile abgesetzt:

PHP Code:

$instance->TableData_TestTable = array("key1" => "value1", "key2" => "value2");

Jede Zuweisung zu TableData_TestTable erzeugt eine neue Zeile, wobei als Template die Datei TestTable.html (aus dem Designordner) genommen wird.
Um keine Verwechslung mit "globalen" Variablen zu bekommen, greift man auf Table Variablen mit
HTML Code:
```
[<KEY1>] or [<KEY2>]
```
zu, wobei als Variablenname der Schl�ssel des Array genommen wird.
Eine Tablle wird in der Designdatei gekennzeichnet durch
HTML Code:
```
<<INCLUDE:TESTTABLE:TABLE>>
```
Includes
Um weitere Dateien (z.b. Seiten�bergreifender Inhalt) einzubinden wird folgendes Tag genutzt:
HTML Code:
```
<<INCLUDE:INCFILE>>
```
Dieses Beispiel bindet die incfile.html Datei ein. Der Inhalt wird wiederrum erneut geparst auf weitere Tags.
Zugriffsrechte
Wenn

PHP Code:

$instance->User != NULL

, so wird der Inhalt zwischen
HTML Code:
```
<<PRIVILEGE:LOGGEDIN>> und <</PRIVILEGE:LOGGEDIN>>
```
angezeigt.
Durch die Negierung mittels
HTML Code:
```
<<!PRIVILEGE:LOGGEDIN>> und <</PRIVILEGE:LOGGEDIN>>
```
kann Inhalt vor eingeloggten Benutzern verborgen werden.
Ein Plugin f�r speziellen Nutzergruppen Zugriff ist zur Zeit in der Endphase der Entwicklung und wird sicherlich auch bald ver�ffentlicht.

Eine komplette liste aller aktuellen Features k�nnen in den Herunterladbaren Dateien gefunden werden. Die Ordnerstruktur muss genauso �bernommen werden. Die Beispiele sind jeweils auf verschiedene Seiten aufgeteilt und eindeutig benannt.

Falls ihr Fragen habt, bin ich nat�rlich per Skype oder hier direkt verf�gbar. Ich kann euch nat�rlich bei Problemen mit der Erstellung eurer eigenen Webseite helfen.

M2Commander