SixCMS Befehlsreferenz

Transkript

1 SixCMS Befehlsreferenz Handbuch Stand 19. August 2011

2 Inhaltsverzeichnis 1.Allgemeines zu Platzhaltern Konventionen und der SixCMS-Platzhalter Aufbau HTML Hochkommata Hochkommata als Wert Defaultparameter - Kurzschreibweise Eckige Klammern "[]" Trenner und Lesbarkeit Allgemeine Platzhalter-Optionen Allgemeines Ausgabe auszuwertende Bedingung (condition Ausgabe bei nicht leerem Inhalt (if Ausgabe bei leerem Inhalt (else Ausgabe bei leerem Feld (ifempty Ausgabe anstelle des Inhalts (instead Ausgabe vor bzw. nach dem Inhalt (prefix, suffix Ausgabe dynamischer Inhalte (engine Setzen einer PHP-Variable (varset Verschachteln von %CMS-Platzhaltern Parameter pro Platzhalter %CMS_ACTION( %CMS_AGENT_DATA( %CMS_AGENT_FORM( %CMS_AGENT_MAIL( %CMS_AGENT_PROFILE( %CMS_AREA( %CMS_ASSOC( %CMS_AUTH( %CMS_CALLBACK( %CMS_DEBUG::Backtrace( %CMS_DEBUG::JSDebug( %CMS_DEBUG::Log( %CMS_EMBED( %CMS_ERROR( %CMS_EXIT( %CMS_FIELD( %CMS_HEADER(

3 Inhaltsverzeichnis %CMS_JUMPLIST( %CMS_LINK::Content( %CMS_LINK::Template( %CMS_LINK::Container( %CMS_LISTVAL( %CMS_MAIL( %CMS_NEXT( %CMS_PHP( %CMS_PREV( %CMS_REQUIRE( %CMS_START::Box( %CMS_START::Welcome( %CMS_START::RecordList( %CMS_START::Messages( %CMS_START::Tip( %CMS_START::RSS( %CMS_SYSTEM( %CMS_VALUE::dct( %CMS_VALUE::GSID( %CMS_VALUE::ID( %CMS_VALUE::LSID( %CMS_VARPRINT( %CMS_VARSET( %CMS_WYSIWYG( HTTP-Header Setzen eines HTTP-Headers Angabe des Dokument-Typs (mimetype Laden einer Datei (download Setzen beliebiger Header (raw Ausgabe von Content Allgemein Grundoptionen für alle Feldtypen Feldwerte und Subfields Sich wiederholender Inhalt (ifnotchanged Link auf Detailansicht (link Unterdrückung von Frontend-Editing (editlink Unterdrückung von WYSIWYG (wysiwyg Ausgabe für templatebasierte Eingabemasken (display 75 4

4 Inhaltsverzeichnis Automatische Übernahme der Feldoptionen bei display="input"(input_options unterdrücken Ausgabe von sprachverwandten Artikeln Ausgabe eines Feldes über die Artikel-ID (id Ausgabe eines Feldes über die GSID (gsid Ausgabe eines Feldes über die LSID (lsid Attachment-Felder Liste der angehängten Attachments (field Feldausgabe im Attachment-Container (subfield Steuerung der Ausgabe des Dokument-Typs (mimetype 80 Steuerung der Ausgabe der Dateigröße (filesize Angabe des HTML-Ziels (target Trennzeichen zwischen Attachments (separator Ausgabe des Dateinamens (filename Template-Ausgabe der Attachments (template CSS-Angabe (class Ausgabe beliebiger HTML-Attribute (linkattr Datums-Felder Formatierte Datumsausgabe (format Ausgabe für templatebasierte Eingabemasken (display. 87 File-Felder Linkausgabe auf Datei (field Feldausgabe im Medien-Container (subfield Steuerung der Ausgabe des Dokument-Typs (mimetype 89 Steuerung der Ausgabe der Dateigröße (filesize Angabe des HTML-Ziels (target Ausgabe des Dateinamens (filename Ausgabe des Dateipfads (urlonly CSS-Angabe (class Ausgabe beliebiger HTML-Attribute (linkattr Flag-Felder Ausgabe eines Flag-Feldes (field Suche in Flag-Feldern (sv Fulltext-Felder Ausgabe eines Fulltext-Feldes (field Image-Felder Ausgabe eines Bildes (field Angabe des Bildnamens (name Definieren der Rahmenlinie (border

5 Inhaltsverzeichnis Ausrichtung des Bildes (align Größenangabe des Bildes (width, height Abstand des Bildes zum Text (vspace, hspace Ausgabe des Dateipfads (urlonly Ausgabe des Thumbnails (autothumb Öffnen des Bildes in neuem Fenster (zoompic Alternativtext eines Bildes (altlabel Feldausgabe im Medien-Container (subfield Ausgabe einer Imagemap (usemap Angabe zusätzlicher Bild-Attribute (imgattr Ausgabe beliebiger HTML-Attribute (linkattr Integer-Felder Feldwert (field Formatierung des Trennzeichens (thousands_sep Ausgabe für templatebasierte Eingabemasken (display105 Link-Felder Ausgabe des Datums (datetime Ausgabe eines Textes als Link (sublink Ausgabe einer Link-Liste (field Template-Ausgabe der Links (template Ausgabe der Links entsprechend dem Status (sv[status] Feldausgabe im Link-Container (subfield Definition des Trennzeichens (separator Ausgabe für templatebasierte Eingabemasken (display110 Price-Felder Feldwert (field Formatierung des Dezimal-Trennzeichens (dec_point 112 Formatierung des Tausender-Trennzeichens (thousands_sep Ersetzung von Null-Werten (zero_replace Ausgabe für templatebasierte Eingabemasken (display113 Relation-Felder Ausgabe eines Textes als Link (sublink Ausgabe einer Relation-Liste (field Feldausgabe im Relation-Container (subfield Feldausgabe als Punktschreibweise (field.subfield Anzahl der verknüpften Einträge (count Template-Ausgabe der Relationen (template Ausgabe sortierter Relationen (sixcms_internal

6 Inhaltsverzeichnis Ausgabe der Relationen entsprechend dem Status (sv[status] Trennzeichen zwischen Relationen (separator Übergabe von Suchkriterien (sv Ausgabe für templatebasierte Eingabemasken (display120 Text-Felder (text-plain oder text-html Feldwert (field Text-Editor (input_type Text kürzen (limit Umsetzung von Links (link_convert Angabe des HTML-Ziels (autolink_target Umsetzung von Zeilenumbrüchen (lbr_convert Umsetzung von -Adressen (mailto_convert Entfernung von HTML-Tags (striptags Ausgabe der Textlänge von Textfelder Ausgabe für templatebasierte Eingabemasken (display126 Thumbnail-Felder Ausgabe eines Thumbnails (field Angabe des Bildnamens (name Definieren der Rahmenlinie (border Ausrichtung des Bildes (align Größenangabe des Bildes (width, height Abstand des Thumbnails zum Text (vspace, hspace Ausgabe des Dateipfads (urlonly Bild in einem neuen Fenster öffnen (zoompic Alternativtext eines Thumbnails (altlabel Feldausgabe des Thumbnails (subfield Ausgabe einer Imagemap (usemap Ausgabe des Dateityps (mimetype Ausgabe der Dateigröße (filesize Angabe des HTML-Ziels (target Ausgabe des Dateinamens (filename Steuerung der Ausgabe (output Ausgabe beliebiger HTML-Attribute (linkattr Uploads Ausgabe eines Uploads (field Angabe des Bildnamens (name Definieren der Rahmenlinie (border Ausrichtung des Bildes (align Größenangabe des Bildes (width, height

7 Inhaltsverzeichnis Abstand des Uploads zum Text (vspace, hspace Ausgabe des Dateipfads (urlonly Bild in einem neuen Fenster öffnen (zoompic Ausgabe des Thumbnails (autothumb Alternativtext eines Bildes (altlabel Ausgabe von Eigenschaften des Mediums (subfield Ausgabe einer Imagemap (usemap Ausgabe des Dateityps (mimetype Ausgabe der Dateigröße (filesize Angabe des HTML-Ziels (target Ausgabe des Dateinamens (filename Steuerung der Ausgabe (output Ausgabe beliebiger HTML-Attribute (linkattr Ausgabe von Baumstrukturen Übergeordneter Eintrag (sixcms_parent Untergeordnete Einträge (sixcms_kids Anzahl der untergeordneten Einträge (count Metainformationen Ausgabe des Online-Datums (online_date Ausgabe des Offline-Datums (offline_date Ausgabe des Datums der Eintragserstellung (creation_date Ausgabe des Datums der letzten Änderung (change_date Name des Eigentümers (user Name des Benutzers der letzten Änderung (change_user Container-Name (area Container-ID (area_id Ordner-Name (folder ID der zugehörigen Gruppe (group_id ID des zugehörigen Templates (template_id Mehrsprachigkeit Ausgabe der Sprache Sprache des angezeigten Artikels als Backend-Sprache verfügbar Sprache des angezeigten Artikels als Container-Sprache verfügbar Ausgabe des Originalnamens der Sprache

8 Inhaltsverzeichnis Ausgabe des Namens der Sprache in der Backend-Sprache Daten eines Containers Datenfeld eines Containers (field Ausgabe eines Containers über die ID (id Ausgabe des Ordnerpfads (resolve_folder Ausgabe in original Form (resolve_values Ausgabe Feldinformationen von Strukturfeldern (resolve_structure Ausgabe in php-form (return Daten eines Feldes abfragen Direkter Zugriff auf Feldwerte Ausgabe Spracheintrag eines Labels Ausgabe Felddaten mittels GSID Ausgabe Felddaten mittels ID Ausgabe Felddaten mittels LSID Verschachteln von Templates Allgemein Template-Aufrufe Aufruf eines Detail-Templates (template Aufruf eines Listen-Templates mit Abfrage (template, query Aufruf einer Seite (page Einschränkung durch Suchkriterien (sv Ausgabe personalisierter Inhalte (useprofile Zufällige Artikel ausgeben (rand Weitere Artikel in der Vorschau ausgeben (preview Platzhalter verschachteln Artikel in der Vorschau aufrufen Allgemeines Weitere Artikel in der Vorschau ausgeben (preview Verwandte Einträge Allgemein Ausgabe und Suchmöglichkeiten Ausgabe verwandter Einträge (usefields Berücksichtigung aller Verknüpfungen (relation_all Einschränkung nach Status (sv[published] Einschränkung durch Suchkriterien (sv

9 Inhaltsverzeichnis 6.Systemfunktionen Allgemein Systemzeit Formatierte Systemzeit (field="time" Listenfunktionen Allgemein Nummerierung von Listen Anzahl der Einträge (hits Erster Eintrag (first Letzter Eintrag (last Nummerierung einzelner Einträge (counter Seitenübergreifende Nummerierung (counter_all Seitenübergreifende interne Nummerierung (recno Next- / Prev Weiter-Blättern (%CMS_NEXT Zurück-Blättern (%CMS_PREV Seiten anspringen (%CMS_GOTO Jumplist- (Jumplist Allgemeines Jumplist erzeugen (%CMS_JUMPLIST Begrenzung der Seiten (maxjumps Trennzeichen zwischen Seiten (separator Platzierung der aktuellen Seite (deviation Spezielle Platzhalter des SixCMS-Backends Links innerhalb des Backends Allgemein Backend-Link auf einen Artikel (content Backend-Link auf ein Template (template Backend-Link auf einen Container (container Anpassen der Startseite Allgemein Startseiten-Box mit frei wählbarem Inhalt (box Startseiten-Box mit Willkommens-Text (welcome Startseiten-Box mit Aufzählung/Liste (recordlist Startseiten-Box mit Messages des Benutzers (messages Startseiten-Box mit zufälligem Inhalt (tip Startseiten-Box mit Newsfeed (rss

10 Inhaltsverzeichnis 9.Authentifizierungsfunktionen Allgemein Authentifizierung Fixe Authentifizierung (sixcms_simple Authentifizierung über Gruppenzugehörigkeit (sixcms_group Authentifizierung über Workspace (sixcms_workspace 219 Authentifizierung über Profilmanager (sixcms_profile. 220 Authentifizierung über Custom- (sixcms_custom Authentifizierung für mehrere gleichzeitige Logins (slot Zusatzmodul: Profil-en Allgemein zur Bearbeitung von Formulardaten Übergabe der Daten (input, mode Definition von Formularen HTML-Formularkopf (header Absende-Button (submit Reset-Button (reset Schliessen des Formulars (footer Benutzerdaten Allgemeines Eingabe und Ausgabe Konfiguration eines Eintrags in Profil-Containern Allgemein Ja/Nein-Profile (Flag-Felder Ja/Nein-Profile (Relations-Felder Eingabe von Profil-Daten Eingabe von Profil-Daten (Relations-Felder versenden Einstellungen auslesen Allgemeines Einstellungen Newsletter-Versand Parameter eines Newsletter-Agenten Fehlermeldungen und Debugging Allgemein

11 Inhaltsverzeichnis Ausgabe von Fehlermeldungen Allgemeine Fehlermeldungen Individuelle Fehlermeldungen Template-Backtrace mit %CMS_DEBUG Log-Ausgaben mit %CMS_DEBUG JavaScript-Debugger mit %CMS_DEBUG PHP-Schnittstelle Allgemein Setzen von Variablen PHP-Variable setzen Variablen ausgeben der Ausgabe von $cmsvar der Ausgabe einer eigenen PHP-Variable der Ausgabe von $cmsparam PHP-Code Platzieren von Codeteilen WYSIWYG und Frontend-Editing WYSIWYG-Bearbeitung WYSIWYG von eingebetteten Relationen Frontend-Editing Custom-en Custom-en aktivieren Aktivieren von en Verwendung von Klassen-Methoden Verwendung von statischen Member-Variablen und -Konstanten Einbinden von Templates Callback-en Allgemein Callback- definieren Benennung Parameter Ablageort Callback- verwenden Aufruf einer Callback- für ein Feld Aufruf einer Callback- für eine PHP-Variable

12 Inhaltsverzeichnis Setzen einer Default-Call- für ein Template Verwenden der Call-en als direkter CMS-Platzhalter Im Lieferumfang enthaltene en cmsfunc_call_highlight( cmsfunc_call_urlencode ( cmsfunc_fieldverify_ ( e Parser-Engines Allgemein Parser installieren Parser verwenden Eigene Custom-Engines Index

13 1. Allgemeines zu Platzhaltern Kapitel 1 Allgemeines zu Platzhaltern In diesem Kapitel erfahren Sie Konventionen und der SixCMS-Platzhalter (siehe 1.1 Konventionen und der SixCMS-Platzhalter, Seite 14 welche Parameter in nahezu allen Platzhaltern angewendet werden können (siehe 1.2 Allgemeine Platzhalter-Optionen, Seite 20 wie Sie mit dem Parameter varset eine einfache PHP- Schnittstelle realisieren können (siehe Setzen einer PHP- Variable (varset, Seite 29 wie Sie Platzhalter verschachteln können (siehe 1.3 Verschachteln von %CMS-Platzhaltern, Seite 30 welche Platzhalter es gibt und welche Parameter ein Platzhalter verwenden kann (siehe 1.4 Parameter pro Platzhalter, Seite Konventionen und der SixCMS-Platzhalter SixCMS-Platzhalter sind Variablen, die in der Regel Werte von Feldern ausgeben. Sie werden ausschließlich in Templates verwendet Aufbau Hinweis Alle SixCMS-Platzhalter werden grundsätzlich in Großbuchstaben geschrieben. 14

14 1.1 Konventionen und der SixCMS-Platzhalter Der Platzhalter setzt sich aus folgenden Komponenten zusammen: Prozentzeichen (% spezifische SixCMS Kennung (CMS Unterstrich (_ Befehl des Platzhalters z. B. DATA, AUTH, EMBED etc. in Klammern, die Parameter z. B. (field="title" suffix=" " Neben Platzhaltern gibt es auch noch Platzhalter-Methoden. Bei Platzhaltermethoden wird zwischen Befehl des Platzhalters und den in Klammer stehenden Parameter die Methode eingefügt: %CMS_XYZ::Methode( Platzhalter: field="title" prefix="es folgt der Titel:" Platzhalter-Methode: %CMS_DEBUG::log (timestamp="exact" HTML Templates werden in der Auszeichnungssprache abgefasst, die das jeweilige Ausgabemedium darstellen kann. Für die Ausgabe der Inhalte via Webbrowser ist dies HTML, für mobile Endgeräte kommt z. B. WML in Betracht. Alle e in diesem Handbuch sowie im Handbuch für Template-Designer sind in HTML abgefasst, da dies der häufigste Anwendungsfall ist. Als Voraussetzung werden Grundkenntnisse in der HTML-Programmierung empfohlen. Andere Auszeichnungssprachen können analog verwendet werden. Die folgenden e zeigen, wie SixCMS-Platzhalter und HTML- Code in Templates kombiniert und verwendet werden können. Platzhalter können direkt innerhalb von HTML-Code verwendet werden. Umgekehrt kann HTML-Code in Platzhaltern durch spezielle Parameter eingebettet werden. Die Ausgabe ist in beiden en identisch. HTML-Code direkt im Platzhalter ("prefix" und "suffix" : field="name" prefix="<table><tr><td colspan=2>" suffix="</td></tr></table>" 15

15 1. Allgemeines zu Platzhaltern Der Platzhalter gibt jeweils den Wert des Feldes "name" aus. Zugleich wird über die Parameter "prefix" und "suffix" eine HTML-Tabelle aufgebaut. Alle Angaben des Parameters "prefix" werden vor der Ausgabe des Feldes angegeben. Das "suffix" verhält sich genau wie das "prefix", nur wird es nach dem Wert ausgegeben (siehe Ausgabe vor bzw. nach dem Inhalt (prefix, suffix, Seite

16 1.1 Konventionen und der SixCMS-Platzhalter HTML-Code vor und nach einem Platzhalter. : <table> <tr> <td colspan="2"> field="text" </td> </tr> </table> Hier ist der SixCMS-Platzhalter von HTML-Code umrahmt. Der Wert wird in diesem ebenfalls innerhalb einer Tabellenzelle ausgegeben. Die einzelnen HTML-Befehle sind aber nicht in den SixCMS-Platzhalter integriert Hochkommata In einem %CMS-Platzhalter können Sie die Werte der Parameter wahlweise in Hochkommata setzen. Werte, die Leerzeichen enthalten, müssen in Hochkommata gesetzt werden, damit SixCMS erkennen kann, wo dieser Wert beginnt und wo er endet. Hinweis Wir empfehlen Ihnen grundsätzlich den Einsatz von Hochkommata. Hochkommata schützen vor unerwarteten Fehlern und machen Platzhalter generell übersichtlicher. Zulässige Schreibweisen: field=title field="title" field=title prefix="es folgt der Titel: " 17

17 1. Allgemeines zu Platzhaltern Hochkommata als Wert Wenn Sie innerhalb eines Wertes die doppelten Anführungen (" verwenden möchten, müssen Sie diese maskieren, und damit anzeigen, dass sie Teil des Wertes sind. Dies tun Sie mit einem führenden Backslash (\ vor dem Hochkomma: field="title" prefix="<a href=\"list.php?page= glossar&sv[title]="suffix="&sv[special]=on\" target=\"new\">" Ergibt die Ausgabe <a href="list.php?page=glossar&sv[title]= physik&sv[special]=on" target="new"> Defaultparameter - Kurzschreibweise Für einige Platzhalter wurde ein sogenannter Default-Parameter festgelegt. Er erlaubt eine verkürzte Schreibweise für den Fall, dass nur ein Parameter an den Platzhalter übergeben werden soll. Bei %CMS_DATA ist dies der Parameter "field". Folgende Platzhalter sind also gleichbedeutend: title field="title" Wenn mehr als ein Parameter übergeben werden soll, muss der Parametername angegeben werden: Falsch: title prefix="titel: " Richtig: field="title" prefix="titel: " Eckige Klammern "[]" Innerhalb der eckigen Klammern "[]" und zwischen zwei Paaren von eckigen Klammern, z. B. "sv[online_date][]" darf kein Leerzeichen stehen. 18

18 1.1 Konventionen und der SixCMS-Platzhalter Trenner und Lesbarkeit Die einzelnen Parameter/Wert-Paare innerhalb eines %CMS-Platzhalters können mit beliebig vielen sog. Whitespaces (Leerzeichen und/oder Zeilenumbrüchen getrennt werden. Tipp Achten Sie darauf, dass Ihre Templates für andere möglichst lesbar sind. Die Lesbarkeit eines Platzhalters mit vielen Parametern kann wesentlich erhöht werden, indem Sie hinter jedem Parameter/Wert- Paar einen Zeilenumbruch einfügen. Schreiben Sie anstelle: %CMS_EMBED(template="news_list" query="news" sv[special]="on" sort="online_date" order="desc" besser: %CMS_EMBED( template="news_list" query="news" sv[special]="on" sort="online_date" order="desc" Lassen Sie für längere %CMS-Platzhalter noch ein wenig Platz in Ihrem Quellcode. Benutzen Sie HTML-Kommentare, um zu beschreiben, was der Platzhalter ausgibt, falls dies nicht selbsterklärend ist. 19

19 1. Allgemeines zu Platzhaltern 1.2 Allgemeine Platzhalter-Optionen Allgemeines In SixCMS gibt es bestimmte Parameter, die in nahezu allen Platzhaltern angewendet werden können. Ausnahme ist z. B. der Platzhalter %CMS_PHP. Im Einzelnen handelt es sich hierbei um folgende Parameter, die in der angegebenen Reihenfolge abgearbeitet werden. condition else if ifempty instead prefix suffix engine varset Ausgabe auszuwertende Bedingung (condition Ausgabe einer auszuwertenden Bedingung. Mit dem Parameter "condition" kann ergänzend zu "if" und "else" eine eigene Bedingung hinzugefügt werden. Die Bedingung (condition ist als gültiger PHP-Ausdruck anzugeben. Wird die Bedingung erfüllt, wird der Ausdruck im "if"-parameter ausgeführt, ansonsten der im "else"- Parameter. Der Platzhalter "#this#" stellt dabei den Rohwert des %CMS-Platzhalters selbst zur Verfügung. field="<feldname>" if="<if-text>" else="<else-text>" condition="<php-ausdruck>" 20

20 1.2 Allgemeine Platzhalter-Optionen 1 Gibt aus, ob als Farbe Rot ausgewählt wurde. field="farbe" if="als Farbe ist Rot gewählt." else="es wurde eine andere Farbe als Rot gewählt." condition="'rot' == #this#" 2 Ein Vergleich ohne Verwendung von #this#. Gibt aus welches der beiden Datums-Felder älter ist. Das title- Feld wird nicht weiter benötigt und dient nur als Initialwert für den Platzhalter. field="title" if="das erste Datum ist jünger als das zweite Datum" else="das erste Datum ist älter als oder genauso alt wie das zweite Datum" conition="datum_eins > datum_zwei" Ausgabe bei nicht leerem Inhalt (if Die Parameter "if" und "else" erlauben bei allen %CMS- Platzhaltern ein echtes PHP-if-Statement zu erzeugen. Dabei wird das Ergebnis des Platzhalters als Bedingung und die Parameter "if" und "else" als Statement im entsprechenden Block eingesetzt. Die Parameter können einzeln oder auch gemeinsam angegeben werden. Gibt der Platzhalter einen Wert zurück der nicht leer ist, wird der im if-parameter angegebene Ausdruck ausgewertet und anstelle des originalen Platzhalters zurückgegeben. 1 field="<feldname>" if="<if-text>" else="<else-text>" Einfache Anzeige, ob das Titel-Feld Text enthält oder nicht. field="title" if="titel ist nicht leer" else="titel ist leer" 21

21 1. Allgemeines zu Platzhaltern Ausgabe bei leerem Inhalt (else Die Parameter "if" und "else" erlauben bei allen %CMS- Platzhaltern ein echtes PHP-if-Statement zu erzeugen. Dabei wird das Ergebnis des Platzhalters als Bedingung und die Parameter "if" und "else" als Statement im entsprechenden Block eingesetzt. Die Parameter können einzeln oder auch gemeinsam angegeben werden. Gibt der Platzhalter einen leeren Wert zurück, wird der im else-parameter angegebene Ausdruck ausgewertet und anstelle des originalen Platzhalters zurückgegeben. Hinweis 1 field="<feldname>" if="<if-text>" else="<else-text>" Im Gegensatz zu den bestehenden Platzhaltern 'ifempty' und 'instead' werden die übergebenen Werte (inkl. darin verschachtelter Platzhalter bei 'if' und 'else' nicht bereits bei Aufruf des Platzhalters ausgeführt, sondern erst bei tatsächlichem Bedarf. Insbesondere die Verwendung bei komplizierteren Ausdrücken kann somit positiven Einfluss auf die Performance haben. Einfache Anzeige, ob das Titel-Feld Text enthält oder nicht. field="title" if="titel ist nicht leer" else="titel ist leer" 2 Bei 'if' und 'else' werden die übergebenen Werte (inkl. darin verschachtelter Platzhalter nicht bereits bei Aufruf des Platzhalters ausgeführt, sondern erst bei tatsächlichem Bedarf. In folgendem wird das innere %CMS_EMBED nur ausgeführt, wenn das äußere kein Ergebnis geliefert hatte; die unnötige Ausführung des inneren Embed wird, anders als beim ifempty-parameter, vermieden: %CMS_EMBED( template="liste" query="abfrage_eins" else="%cms_embed template="liste" query="abfrage_zwei" " 22

22 1.2 Allgemeine Platzhalter-Optionen Ausgabe bei leerem Feld (ifempty Bedingung 1 Ausgabe des "ifempty-text" bei leerem Feld. field="<feldname>" ifempty="<ifempty-text>" Die Ausgabe erfolgt nur, wenn das Feld leer bzw. bei Zahlen oder Preisfeldern gleich null ist. Bei Feldern des Typs "flag" erfolgt die Ausgabe nur, wenn das "flag"-feld nicht gesetzt, also "off" ist. Wenn der Preis gleich null ist, wird der Text "Können Sie kostenlos bestellen" ausgegeben. field="preis" ifempty="können Sie kostenlos bestellen" oder %CMS_EMBED( template="preis" ifempty="können Sie kostenlos bestellen" 2 Kombination der Ifempty- und Instead-Klausel field="preis" ifempty="können Sie kostenlos bestellen" instead="dieses Produkt kostet etwas" oder %CMS_EMBED( template="preis" ifempty="können Sie kostenlos bestellen" instead="dieses Produkt kostet etwas" 3 Text, der ausgegeben wird, wenn für eine Jumplist zu wenig Einträge gefunden werden. %CMS_JUMPLIST( [ifempty="<text>"] 23

23 1. Allgemeines zu Platzhaltern Ausgabe anstelle des Inhalts (instead Bedingung 1 Ausgabe des Inhalts der Instead-Klausel anstelle (engl. "instead" des eigentlichen Inhalts. field="<feldname>" instead="<instead-text>" Die Ausgabe erfolgt nur, wenn das Feld gefüllt bzw. bei Zahlen oder Preisfeldern ein Wert ungleich "0" eingegeben wurde. Bei Feldern des Typs "flag" erfolgt die Ausgabe nur, wenn das "flag"-feld gesetzt, also "on" ist. Wenn das Feld "special" gesetzt ist, wird der nachfolgende Text rot dargestellt. field="special" instead="<font color=red>" 2 Wenn das Feld "special" gesetzt ist, wird der nachfolgende Text rot dargestellt. %CMS_EMBED( template="special" instead="<font color=red>" 3 Abonnent persönlich ansprechen: %CMS_AGENT_DATA( field="surname" display="output" instead="hallo" %CMS_AGENT_DATA (field="firstname" display="output" %CMS_AGENT_DATA( field="surname" display="output" suffix="!" erzeugt die Ausgabe: Hallo Martin Mustermann! 24

24 1.2 Allgemeine Platzhalter-Optionen Ausgabe vor bzw. nach dem Inhalt (prefix, suffix Ausgabe des "prefix-text" vor bzw. des "suffix-text" nach dem eigentlichen Inhalt bzw. eingebettetem Template. field="<feldname>" prefix="<prefix-text oder HTML-Tags>" suffix="<suffix-text oder HTML-Tags>" oder %CMS_EMBED( page="<seiten-label>" prefix="<prefix-text oder HTML-Tags>" suffix="<suffix-text oder HTML-Tags>" Bedingung Hinweis 1 Ist das Feld leer bzw. "0" bei Zahlen und Preis-Feldern sowie "off" bei Flag-Feldern, wird der Suffix-Parameter ignoriert. Folgende Platzhalter sind intern ebenfalls Spezialfälle von %CMS_EMBED(: field="relation" template="list" field="links" template="list" field="attachments" template="list" %CMS_ASSOC(usefields="firma" template="list" Es wird nur dann ein Euro-Zeichen ausgegeben, wenn auch ein Preis angegeben wurde. field="preis" suffix=" " 2 Es wird nur dann eine neue Tabellenzeile erzeugt und auch wieder geschlossen, wenn das Feld "text" gefüllt ist. field="text" prefix="<tr><td>" suffix="</td></tr>" 3 Aufruf einer Page mit vorangestelltem Text. %CMS_EMBED( page="seite" prefix="news: " 25

25 1. Allgemeines zu Platzhaltern 4 Ausgabe von Kollegen mit vorangestelltem Text: %CMS_ASSOC( usefields="firma" template="mitarbeiter_list" prefix="kollegen: " 5 Ausgabe von text vor der Systemzeit: %CMS_SYSTEM( field="time" prefix="datum" erzeugt die Ausgabe Datum: Abonnent persönlich ansprechen: %CMS_AGENT_DATA( field="surname" display="output" instead="hallo" %CMS_AGENT_DATA (field="firstname" display="output" %CMS_AGENT_DATA( field="surname" display="output" suffix="!" erzeugt die Ausgabe: Hallo Martin Mustermann! 26

26 1.2 Allgemeine Platzhalter-Optionen 7 Überschreibt den Betreff der mit dynamischen Inhalten: %CMS_AGENT_MAIL( field="subject" value="%cms_agent_data( field="anrede" suffix=" " %CMS_AGENT_DATA( field="vorname" suffix=" " %CMS_AGENT_DATA( field="nachname" suffix=" - " Ihr %CMS_AGENT_MAIL( field="job_data.title" " Schreibt in den Betreff: Herr Max Mustermann - Ihr SixCMS Monats-Newsletter 8 Verwendung der Eingabemaske einer Community- Anwendung als Fehlertemplate: template=community_in... <form method="post" action="insert.php"> <input type="hidden" name="input[area_id]" value="123"> <input type="hidden" name="template[success] value="alles_klar"> <input type="hidden" name="template[error]" value="community_in"> %CMS_ERROR( prefix="<font color=red>fehler bei der Eingabe:" suffix="</font>" <P> Titel: <input type="text" size="40" name="input[title]" value="%cms_varprint( value="$input[title]"">... Auf diese Weise erhält Ihr Benutzer bei einem Eingabefehler sofort wieder das vorausgefüllte Formular. Die Fehlermeldungen stehen gesammelt über den Eingabefeldern. 27

27 1. Allgemeines zu Platzhaltern 9 Suche nach "title=zahn*": %CMS_VARPRINT( variable="sv[title]" prefix="sie haben gesucht nach title: " ergibt die Ausgabe: Sie haben gesucht nach title: zahn* Ausgabe dynamischer Inhalte (engine (siehe Kapitel 17 Parser-Engines, Seite

28 1.2 Allgemeine Platzhalter-Optionen Setzen einer PHP-Variable (varset Anstelle den Wert auszugeben, wird er in die PHP-Variable $cmsvar[variablenname] geschrieben. Dies ermöglicht sie an anderer Stelle wiederzuverwenden. Durch dieses Verfahren ist eine Schachtelung von %CMS- Platzhaltern möglich (siehe 1.3 Verschachteln von %CMS- Platzhaltern, Seite 30. field="<feldname>" varset="<variablenname>" oder %CMS_EMBED( template="<template>" varset="<variablenname>" Hinweis Sie können auf diese Variable innerhalb von %CMS- Platzhaltern über %CMS_VARPRINT (siehe a. oder innerhalb eigener PHP-Scripts (siehe b. zugreifen (siehe c.. Siehe Handbuch für Template-Designer, 11.2 Parameter varset, Seite Der Titel des Eintrages wird in die Variable $cmsvar[title] geschrieben. field="title" varset="title" ==> $cmsvar[ title ] = "Titel des Eintrags"; 2 Zugriff auf Variable über %CMS_VARPRINT: %CMS_VARPRINT(variable="mytitle" prefix="titel: " 3 Zugriff auf Variable innerhalb eigener PHP-Skripts: field="longtitle" ifempty="$cmsvar[mytitle]" oder <?php echo $cmsvar[mytitle];?> 29

29 1. Allgemeines zu Platzhaltern 4 Der Titel des Eintrages wird in die Variable $cmsvar[title] geschrieben. %CMS_EMBED( template="title" varset="title" ==> $cmsvar[ title ] = "Titel des Eintrags"; 5 Ausgabe der Systemzeit: %CMS_SYSTEM( field="time" varset="zeit" ==> $cmsvar[ zeit ] = " "; 6 Ausgabe einer Variable: field="title" varset="mytitle" %CMS_VARPRINT( variable="mytitle" 1.3 Verschachteln von %CMS- Platzhaltern %CMS-Platzhalter in Templates dürfen verschachtelt werden. Auf diese Weise lassen sich Abhängigkeiten sehr einfach abbilden. : field=bild1 ifempty=field=bild" Alternativ können Sie mit dem Parameter "varset" und einer Hilfsvariable operieren: field="title" varset="mytitle" field=" " ifempty="$cmsvar[mytitle]" 30

30 1.4 Parameter pro Platzhalter 1.4 Parameter pro Platzhalter %CMS_ACTION( Parameter Werte Beschreibung area_id ID des Stammdaten- Containers. ID des Stammdaten- Containers. condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt if Text Ausgabe anstelle des Inhalts iffalse Fehlerfall Rückgabe im Fehlerfall iftrue Erfolgsfall Rückgabe im Erfolgsfall input Array Eingabe-Array mode login logout insert update save delete relogin get Bearbeitungstyp slot Text Ermöglicht mehrere Logins zur gleichen Zeit varset Variablenname Rückgabewert als Variable Siehe 10.2 zur Bearbeitung von Formulardaten, Seite

31 1. Allgemeines zu Platzhaltern %CMS_AGENT_DATA( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" display input output. Anzeigeart des Inhalts else Text Ausgabe bei leerem Inhalt field feldname relationfeldname.feldname Siehe 10.4 Benutzerdaten, Seite 233. Datenfeld des Abonnenten if Text Ausgabe anstelle des Inhalts ifempty Text Text bei leerem Inhalt instead Text Text anstelle des Inhalts prefix Text Text vor dem Inhalt slot Text Ermöglicht mehrere Logins zur gleichen Zeit suffix Text Text nach dem Inhalt type text select radio hidden Typ des Formularfeldes value Wert des Feldes Auswahl-Optionen bei type="select" und "radio" varset Variablenname Rückgabewert als Variable 32

32 1.4 Parameter pro Platzhalter %CMS_AGENT_FORM( Parameter Werte Beschreibung area_id ID des Stammdaten-Container ID des Stammdaten- Container condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" do login profile logout Formular-Typ password remove element header submit reset footer Formular-Element else Text Ausgabe bei leerem Inhalt error Template-Label Fehler-Template expires Tage Verfallszeit des Cookies bei do="profile" und "login" if Text Ausgabe anstelle des Inhalts image URL zum Bild Bild für Buttons mail Template-Label -Template bei do="password" mail_from -Adresse Absender der bei do="password" mail_subject Text Betreff der bei do="password" success Template-Label Erfolgs-Template text Text Text für Buttons Siehe 10.3 Definition von Formularen, Seite

33 1. Allgemeines zu Platzhaltern %CMS_AGENT_MAIL( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt field feldname Datenfeld der relationfeldname.feldname if Text Ausgabe anstelle des Inhalts ifempty Text Text bei leerem Inhalt instead Text Text anstelle des Inhalts prefix Text Text vor dem Inhalt suffix Text Text nach dem Inhalt varset Variablenname Rückgabewert als Variable value Wert Wert wird in das unter field angegebene Feld geschrieben Siehe Einstellungen auslesen, Seite %CMS_AGENT_PROFILE( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt field Feldname.Feldname Name des Feldes Feldname.page if Text Ausgabe anstelle des Inhalts size Zahl Zeichen/Zeilen des Text/Select-Felds type checkbox hidden select radio text Ausgabeart Siehe 10.5 Konfiguration eines Eintrags in Profil-Containern, Seite

34 1.4 Parameter pro Platzhalter %CMS_AREA( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt field datafield structure.feldname meta data all Siehe 3.19 Daten eines Containers, Seite 158. Datenfeld des Containers id id lsid gsid ID des Containers if Text Ausgabe anstelle des Inhalts ifempty Text Ausgabe bei leerem Inhalt instead Text Ausgabe anstelle des Inhalts prefix Text Text vor dem Inhalt resolve_folder no yes Bei Yes Ausgabe zusätzlicher Informationen zum Ordner-Pfad resolve_structure no yes kindof Ausgabe von Strukturfeldern und/oder zugehörige Feldinformationen resolve_values true false Bei true Ausgabe dynamischer Inhalte in original Form return php Ausgabe in PHP-Form suffix Text Text nach dem Inhalt varset Variablenname Inhalt in Variable schreiben 35

35 1. Allgemeines zu Platzhaltern %CMS_ASSOC( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt if Text Ausgabe anstelle des Inhalts order asc desc Sortierreihenfolge prefix Text Text vor dem Inhalt sm[<feldname>] relation_all Suchmodus zu angegebenem Feld sort Feldname Sortierfeld suffix Text Text nach dem Inhalt sv[<feldname>] Suchwert Suchwert über das angegebene Feld sv[status] online archive online_archive on off auszuwählender Status template Template-Label Listen-Template zur Ausgabe usefields Feldnamen Felder, die zur Ermittlung der verwandten Einträge herangezogen werden. Siehe 5.2 Ausgabe und Suchmöglichkeiten, Seite

36 1.4 Parameter pro Platzhalter %CMS_AUTH( Parameter Werte Beschreibung area_id ID des Stammdaten- Containers ID des Stammdaten- Containers condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" container Container-Name Name des Stammdaten- Containers else Text Ausgabe bei leerem Inhalt error Template-Label Fehler-Template group SixCMS-Gruppenname SixCMS-Gruppenname if Text Ausgabe anstelle des Inhalts password Passwort Passwort, das geprüft wird profile Feldname Relationsfeldname des Profils realm Zone Zone, in der das Passwort gültig ist slot Text Ermöglicht mehrere Logins zur gleichen Zeit type sixcms_simple sixcms_group sixcms_workspace sixcms_profile Siehe 9.2 Authentifizierung, Seite 217. Authentifizierungsquelle username Username Username, der geprüft wird workspace SixCMS-Workspacename SixCMS- Workspacename 37

37 1. Allgemeines zu Platzhaltern %CMS_CALLBACK( Parameter Werte Beschreibung action set clear Aktivieren und Deaktivieren der call sname sname ohne "cmsfunc_call" condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt if Text Ausgabe anstelle des Inhalts Siehe Setzen einer Default-Call- für ein Template, Seite

38 1.4 Parameter pro Platzhalter Parameter Werte Beschreibung Feldtyp align left right top middle bottom altlabel Text Alternativtext eines Bildes Bild-Ausrichtung Image Thumbnail Upload autolink_target true false Angabe des HTML- Ziels autothumb true false Ausgabe des Thumbnails Image Thumbnail Upload Text Image Upload border Zahl Bild-Rahmenlinie Image Thumbnail Upload calendar true false Kalender-Tool bei display= input datetime class Style-Angabe Verwendung eines Stylesheet condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" Attachment File condition datetime true false Ausgabe des Datums Text dec_point Zeichen Dezimal- Price Trennzeichen default_value Wert Standard-Wert für display=input vorgeben display input Ausgabe eines Eingabefelds für templatebasierte Eingabemasken. - alle - attachments datetime file flag image integer links password price relation text upload editlink true false Frontend-Editing - alle - else Text Ausgabe bei leerem - alle - Inhalt 39

39 1. Allgemeines zu Platzhaltern Parameter Werte Beschreibung Feldtyp field Feldname sixcms_parent sixcms_kids sixcms_kids.coun t Feldname.Feldna me Feldname.count filename true false Ausgabe des Dateinamens filesize true false Ausgabe der Dateigröße format MySQL-Format Angaben Feldangabe - alle - Formatierte Ausgabe Attachment File Thumbnail Upload Attachment File Thumbnail Upload Datum height Wert auto Bildhöhe Image Thumbnail Upload height Wert Höhe des Eingabefelds bei display= input links relation text hspace Wert Bildabstand zum Text Image Thumbnail Upload if Text Ausgabe anstelle des Inhalts - alle - ifempty Text Ausgabe bei leerem Inhalt ifnotchanged Text Ausgabe bei gleichem Inhalt imgattr[<width height...>] input_options none Ausschalten der automatischen Übernahme der Feldoptionen bei display="input" input_type checkbox integer lookup price radio select - alle - - alle - Image-Angabe Bild-Attribute Image Art der Darstellung bei display= input instead Text Ausgabe anstelle des Inhalts - alle - außer links relation integer links price relation text - alle - 40

40 1.4 Parameter pro Platzhalter Parameter Werte Beschreibung Feldtyp language_iso Sprachkürzel Auswahl der Sprache -allelbr_convert nach ISO true false Zeilenumbrüche Text limit Zahl[w] Textkürzung Text limit_snippet Zeichen Zeichen nach gekürztem Text Text link detail Link auf - alle - Detailansicht link_convert true false Umsetzung von Links Text linkattr HTML-Attribute Ausgabe von HTML- Attributen mailto_convert true false Umsetzung von E- Mail-Adressen mimetype true false Ausgabe des Dateityps multiple true false Mehrfachauswahl bei display= input Attachement File Image Thumbnail Upload Text Attachment File Thumbnail Upload links relation name Bildname Name eines Bildes Image Thumbnail Upload now_link true false Button für Aktuelles Datum (display= input datetime options Optionen Optionen bei display= input und input_type= select integer price order desc asc Sortierreihenfolge Relation output auto file image filename data meta media Steuerung der Ausgabe Thumbnail Upload prefix Text Text vor Inhalt - alle - preview on all online archive onlinearchive published unpublished Anzeige von zusätzlichen Artikeln in der Vorschau Relation Link separator Wert Trennzeichen Attachment Link Relation 41

41 1. Allgemeines zu Platzhaltern Parameter Werte Beschreibung Feldtyp size Wert Breite des Eingabefelds (display= input sort Feldname Sortierfeld Feldname.sixcms _internal sortable true false Sortierfunktion bei display= input split_fields true false Datum mit mehreren Eingabefeldern (display= input striptags true false Entfernung von HTML-Tags subfield Feldname Feldausgabe in Punktschreibweise password text Relation relation datetime Text Attachment File Image Link Relation Thumbnail Upload sublink true false Ausgabe eines Textes Text als Link suffix Text Text nach Inhalt - alle - sv[<feldname>] Suchwert Sucheinschränkung Flag Relation sv[status] online archive online_archive Sucheinschränkung nach Status Link Relation target Ziel HTML-Ziel Attachment File Thumbnail Upload template Template-Label Ausgabe über Template thousands_sep Zeichen Tausender- Trennzeichen time_field true false Mit Uhrzeit bei display= input urlonly true false Ausgabe des Dateipfads usemap Imagemap Verwendung einer Imagemap value Wert Wert eines Feldes für die Ausgabe mit display=input überschreiben Attachment Link Relation Integer Price datetime File Image Thumbnail Uplaod Image Thumbnail Upload -alle- 42

42 1.4 Parameter pro Platzhalter Parameter Werte Beschreibung Feldtyp varset Variablenname Inhalt in Variable schreiben Siehe Ausgabe von Content, Seite %CMS_DEBUG::Backtrace( Siehe Template-Backtrace mit %CMS_DEBUG, Seite %CMS_DEBUG::JSDebug( Siehe JavaScript-Debugger mit %CMS_DEBUG, Seite %CMS_DEBUG::Log( Siehe Log-Ausgaben mit %CMS_DEBUG, Seite alle - vspace Wert Bildabstand zum Text Image Thumbnail Upload width Wert auto Bildbreite Image Thumbnail Upload wysiwyg true false Verwendung von WYSIWYG zero_replace Zeichen Kommastellen ersetzen zoompic true false Öffnen eines Bildes in neuem Fenster - alle - Price Image Thumbnail Upload Parameter Werte Beschreibung output echo string var Erstellen eines Backtrace der Template-Ausgabe Parameter Werte Beschreibung Aktiviert den JavaScript-Debugger Parameter Werte Beschreibung text variable timestamp file Ausgabe von beliebigen Texten und Variablen in einer Log-Datei 43

43 1. Allgemeines zu Platzhaltern %CMS_EMBED( Parameter Werte Beschreibung condition PHP-Ausdruck Auszuwertende Bedingung siehe "if" und "else" else Text Ausgabe bei leerem Inhalt if Text Ausgabe anstelle des Inhalts ifempty Text Ausgabe bei leerem Inhalt instead Text Ausgabe anstelle des Inhalts order asc desc ascexact descexact Sortierreihenfolge page Seiten-Label Seite zur Ausgabe prefix Text Text vor dem Inhalt query Abfrage-Label Abfrage zur Ausgabe preview on all online archive onlinearchive published unpublished Siehe 4.2 Template-Aufrufe, Seite 177. Anzeige von zusätzlichen Artikeln in der Vorschau rand true false Zufällige Artikel sort Feldname Sortierfeld suffix Text Text nach dem Inhalt sv[<feldname>] Suchwert Suchwert über das angegebene Feld template Template-Label Template zur Ausgabe useprofile true Profilfeldname Seiten- anzuwendendes Profil Label varset Variablenname Inhalt in Variable schreiben 44