Templates

Aus DynPG-Wiki
Wechseln zu: Navigation, Suche

Einführung

Mit DynPG ist es möglich die Art und Weise wie Artikel und Listenansichten ausgegeben werden, zu beeinflussen. Ein Weg ist CSS, ein anderer (wesentlich flexiblerer) geht über die eingebaute Templateengine. Ein Beispiel: Der Aufruf 

$DynPG->Write_Article();

bewirkt, dass die Detailansicht eines Artikels angezeigt wird. Dabei wird (wenn nichts anderes explizit angegeben wurde) implizit ein Standard-Template verwendet, das definiert wie diese Ansicht auszusehen hat. Im DynPG-Unterverzeichnis /tpl/MyCMS/default/ liegen die Templatedateien für die Standardansichten.

  • groups.tpl (Gruppenlistenansicht)
  • articles.tpl (Artikellistenansicht)
  • detail.tpl (Artikel-Detailansicht)
  • home.tpl (Home-Ansicht)
  • navigation.tpl (Blätterfunktion der Listen-Ansichten)
  • search-form.tpl (Formular für die Suche)

In diesen Dateien haben Sie die Möglichkeit, oben genannte Ansichten nach Ihren Wünschen anzupassen. Die Darstellung geschieht grundsätzlich mit HTML. Zusätzlich gibt es eine Templatesprache. Diese ist schlicht gehalten und beinhaltet einige wenige Elemente die nachfolgend näher betrachtet werden sollen. Statt die Standard-Templates zu manipulieren, können auch neue Templates erzeugt werden. Dazu muss im Unterverzeichnis /tpl/MyCMS/ einfach ein neuer Ordner mit dem gewünschten Templatenamen angelegt werden. Je nachdem welche Ansichten nun geändert werden sollen, fügt man Dateien mit denselben Namen wie in oben genannter Liste ein. Diese können dann nach den eigenen Wünschen bearbeitet werden. Mit den Zeilen 

$DynPG->setupTemplate("meinTemplate");
 
$DynPG->SetParam_A_Article(13);
 
$DynPG->Write_Article();

wird das Template "meinTemplate" gesetzt und damit der Artikel 13 ausgegeben.


Caution.png Achtung Das Setzen eines Templates muss vor der Ausgabe des Artikels erfolgen!

Caution.png Achtung Wenn das Template gesetzt wurde, dann wird es auch für alle nachfolgenden Ausgaben verwendet! Ist dies unerwünscht, muss man explizit wieder das Standard-Template("default") setzen!

Ein erstes kleines Beispiel

Da alle Theorie grau ist, hier ein kleines einführendes Beispiel:

Beispiel 2.1. Template-Minimalbeispiel (eigene Artikel-Detailansicht in /tpl/MyCMS/minimal/detail.tpl) 

<!-- Dies ist ein Kommentar (er wird nicht angezeigt) -->
{$CONTENT} <!--Den Inhalt des Artikels ausgeben--> 

Dies ist ein <b>selbstdefiniertes Template</b>  <!--beliebiger HTML-Code-->

<!--Alles was hier drinsteht, wird nach dem Aufruf von $DynPG->Write_Article(); eingefügt -->

Ich habe mir also mit dem Ordner /tpl/MyCMS/minimal ein eigenes Template angelegt. In diesen Ordner packe ich die Datei detail.tpl, die obigen Inhalt aufweist. Damit hab ich meine eigene Artikel-Detailansicht definiert, die ich jetzt jederzeit auf meiner Seite verwenden kann, indem ich z.B. 

$DynPG->setupTemplate("minimal");
 
$DynPG->SetParam_A_Article(13);
 
$DynPG->Write_Article();

aufrufe. {$CONTENT} ist ein Platzhalter für den Inhalt des anzuzeigenden Artikels. An dieser Stelle wird dann also der eigentliche Artikeltext eingefügt (das macht die Templateengine). Eine Liste der Templatevariablen (Platzhalter) finden Sie im nächsten Kapitel. In die Template-Datei kann zudem auch beliebiger HTML-Code eingefügt werden, wodurch den Gestaltungsphantasien fast keine Grenzen gesetzt sind!

Liste und Bedeutung der Template-Variablen

Dieses Template ist zuständig für die Darstellung von Ansichten der Gruppen-Listen.

Templatevariablen - groups.tpl
Platzhalter
Beschreibung
{$ROOT_NAVIGATION} Erstellt eine Übersichts-Navigation. Gruppe >> Untergruppe
{$PAGES_NAVIGATION} Erstellt eine Navigation zum Blättern bei mehreren Seiten. Also falls mehr Gruppen angezeigt werden sollten, als in der config.php unter config_AllGroups_Limit eingestellt sind.
{$LIST_REFER_TO} Enthält die URL-Adresse zur nächsttieferen Anzeige- Stufe (im falle groups.tpl den Link zur Artikelliste oder zur Untergruppe).
{$NAME} Gibt den Namen der Gruppe aus.
{$SHORTTEXT} Gibt den Kurztext der Gruppe aus.
{$CREATEDATE} Gibt das Erstelldatum der Gruppe aus.
{$LIST_SHOW_VISTS} Gibt die Anzahl Klicks auf den Link der entsprechenden Gruppe aus.
{$LIST_HAS_IMAGE} Gibt zurück, ob die Gruppe ein Leadbild hat. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus DynPG.
{$LIST_IMAGE_ALIGN} Gibt die gewünschte Position des Leadbildes zurück. TOP für oben, BOTTOM für unten, LEFT für links und RIGHT für rechts. Entnimmt den Wert aus DynPG.
{$IMAGE_URL} Gibt das Quellverzeichnis des Leadbildes aus.
{$IMAGE_NAME} Gibt den Namen des Leadbildes aus.
{$IMAGE_DESCR} Gibt die Beschreibung des Leadbildes aus.


Dieses Template ist zuständig für die Darstellung von Ansichten der Artikel-Listen.

Templatevariablen - articles.tpl
Platzhalter
Beschreibung
{$ROOT_NAVIGATION} Erstellt eine Übersichts-Navigation. Gruppe >> Artikel
{$PAGES_NAVIGATION} Erstellt eine Navigation zum Blättern bei mehreren Seiten. Also falls Sie mehr Gruppen angezeigt werden sollten, als in der config.php unter 'config_AllArticles_Limit' eingestellt sind.
{$LIST_USER_DEFINED_CSS} Gibt den Wert zurück, den Sie beim Implementieren unter SetParam_AA_SingleCss(...); angegeben wurde.
{$LIST_INDEX} Gibt die aktuelle Anzahl (den Index) der angezeigten Artikel zurück (also beim 3. Artikel den Wert 3, beim 6. Artikel den Wert 6).
{$LIST_REFER_TO} Enthält die URL-Adresse zur nächsttieferen Anzeige- Stufe (im falle articles.tpl den Link zur Detail-Ansicht).
{$CONTENT} Gibt die ID des zum Artikel gehörigen Textes aus.
{$TITLE} Gibt den Namen/Titel des Artikels aus.
{$LEAD} Gibt den Lead-Text des Artikels aus.
{$SHOWDATE} Gibt zurück, ob das Erstelldatum angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus DynPG.
{$CREATEDATE} Gibt das Erstelldatum des Artikels aus
{$LIST_SHOW_VISTS} Gibt die Anzahl Klicks auf den Link des entsprechenden Artikel aus.
{$LIST_HAS_IMAGE} Gibt zurück, ob der Artikel ein Leadbild hat. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus DynPG.
{$LIST_IMAGE_ALIGN} Gibt die gewünschte Position des Leadbildes zurück. TOP für oben, BOTTOM für unten, LEFT für links und RIGHT für rechts. Entnimmt den Wert aus DynPG.
{$IMAGE_URL} Gibt das Quellverzeichnis des Leadbildes aus.
{$IMAGE_NAME} Gibt den Namen des Leadbildes aus.
{$IMAGE_DESCR} Gibt die Beschreibung des Leadbildes aus.


Dieses Template ist zuständig für die Darstellung der Detailansicht eines Artikels.

Templatevariablen - detail.tpl
Platzhalter
Beschreibung
{$COND_SEGM_CATNAV} Gibt zurück, ob eine Übersichts-Navigation angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus der Implementation: SetParam_A_CategoryNavigation(TRUE/FALSE);
{$ROOT_NAVIGATION} Erstellt eine Übersichts-Navigation . Gruppe >> Artikel >> Titel
{$LIST_USER_DEFINED_CSS} Gibt den Wert zurück, den Sie beim Implementieren unter SetParam_A_ArticleCss(...); angegeben wurde.
{$COND_SEGM_HEAD} Gibt zurück, ob der Head-Bereich (im Normalfall Headtext und Beschreibung) angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus der Implementation: SetParam_A_ArticleHeader(TRUE/FALSE);
{$TITLE} Gibt den Namen/Titel des Artikels aus.
{$LEAD} Gibt den Lead-Text des Artikels aus.
{$SHOWDATE} Gibt zurück, ob das Erstelldatum angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus DynPG.
{$CREATEDATE} Gibt das Erstelldatum des Artikels aus
{$COND_SEGM_TEXT} Gibt zurück, ob der Artikelinhalt/-text angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus der Implementation: SetParam_A_ShowText(TRUE/FALSE);
{$CONTENT} Gibt den zugehörigen Text des Artikels aus
{$COND_SEGM_PRINTNAV} Gibt zurück, ob ein Link um den Artikel zu drucken angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus der Implementation: SetParam_A_PrintNavigation(TRUE/FALSE);
{$PRINT_HREF} Gibt den Link zur Druckansicht des Artikels aus.
{$COND_SEGM_SEPARATOR} Gibt zurück, ob der Seperator im Text ignoriert werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus der Implementation: SetParam_A_IgnoreSeperator(TRUE/FALSE);
{$MORE_HREF} Gibt die URL aus, die vom durch den Seperator getrennten Text zum gesamten Text führt.


Dieses Template ist zuständig für die Darstellung der Home-Ansicht.

Templatevariablen - home.tpl
Platzhalter
Beschreibung
{$LIST_INDEX} Gibt die aktuelle Anzahl (den Index) der angezeigten Artikel zurück (also beim 3. Artikel den Wert 3, beim 6. Artikel den Wert 6).
{$GRP_NAME} Gibt den Gruppennamen aus.
{$LIST_HEADER_EACH}  
{$TITLE} Gibt den Namen/Titel des Artikels aus.
{$LEAD} Gibt den Lead-Text des Artikels aus.
{$LIST_SHOWTEXT_EACH}  
{$CONTENT} Gibt den zugehörigen Text des Artikels aus.
{$SHOWDATE} Gibt zurück, ob das Erstelldatum angezeigt werden soll. Falls ja wird TRUE, bei nein FALSE zurückgegeben. Entnimmt den Wert aus DynPG.
{$CREATEDATE} Gibt das Erstelldatum des Artikels aus.
{$LIST_FWD_TEXT}  
{$LIST_REFER_TO} Enthält die URL-Adresse zur nächsttieferen Anzeige- Stufe (im falle home.tpl den Link zum gesamten Artikel).


Dieses Template ist zuständig für die Darstellung von Ansichten der Artikel-Listen.

Templatevariablen - navigation-page.tpl
Platzhalter
Beschreibung
{$PG_NAV_LASTPAGE} Gibt die Seitenzahl der Seite davor aus.
{$PG_NAV_NEXTPAGE} Gibt die Seitenzahl der nächsten Seite aus.
{$PG_NAV_RELPAGE} Gibt die URL der Seite aus.
{$PG_NAV_SEPARATION}  
{$PG_NAV_ISCURRENT}  


Dieses Template ist zuständig für die Darstellung von Ansichten der Artikel-Listen.

Templatevariablen - search-form.tpl
Platzhalter
Beschreibung
{$SEARCH_RESULTPAGE} Gibt die URL der Seite aus, auf der die Suchresultate erscheinen.

Die bedingte Anweisung

Folgendes Beispiel zeigt, wie man bedingte Anweisungen in seine Templates integrieren kann:

Beispiel 2.2. Template-Beispiel (Artikel-Detailansicht mit bedingter Anweisung) 

<!--Wenn Artikelname = "Kontakt" dann Inhalt + zusätzliche Infos ausgeben-->

{$# ('{$TITLE}'=='Kontakt') #}

{$CONTENT}

mein <b>Lieblingsartikel</b>!

{$# End #}

<!--andernfalls nur den Inhalt ausgeben-->

{$# ('{$TITLE}'!='Kontakt') #}

{$CONTENT}

{$# End #}

Hier wird der Text "mein Lieblingsartikel!" nur dann ausgegeben, wenn der Artikel den Namen "Kontakt" trägt. Die Syntax für bedingte Anweisungen lautet allgemein: 

{$#(Bedingung) #}

...

{$# End #}

Caution.png Achtung Bei Zeichenkettenvergleichen(wie in obigem Bsp.) muss darauf geachtet werden, dass auch die Templatevariablen von Anführungszeichen umgeben werden, sonst hagelt es Fehlerausschriften!

Tip.png Tipp Die Bedingung wird als PHP-Code ausgewertet, daher können prinzipiell alle Operatoren verwendet werden, solange der Ergebnisausdruck einen Wahrheitswert liefert.

PHP-Code

{$#PHP (PHP-CODE) #}

Mit dieser Syntax können Sie PHP-Code implementieren. Alles was in der Klammer steht, wird als PHP-Code interpretiert. Es kommt dem Tag 

<?php ... ?>

einer PHP-Seite gleich. Auch hier ein kleines Beispiel:

Beispiel 2.3. Template-Beispiel (Artikel-Detailansicht mit PHP-Code) 

<!--Zeichenlänge des Titels anzeigen-->

Die Länge des Titels beträgt {$#PHP (strlen("{$TITLE}")) #} Zeichen 

{$CONTENT} <!--Inhalt ausgeben-->

Caution.png Achtung Am Ende eines PHP-Statements darf kein Semikolon (";") stehen, wie sonst üblich!

Von „http://wiki-de.dynpg.org/wiki_de/index.php?title=Templates&oldid=1850“