Startseite / Vorlagenentwicklung / Vorlagensyntax / Anweisungen / $CMS_TRIM

$CMS_TRIM(...)$Verfügbar ab FirstSpirit-Version 2.3

Verwendung von $CMS_TRIM(...)$

Die Anweisung $CMS_TRIM(...)$ dient dazu, den generierten Quelltext einer Seite oder eines Absatzes zu formatieren.

Über die Anweisung können unnötige Leerzeilen und Whitespaces (carriage return, linefeed, tab und space) aus dem generierten Quelltext entfernt werden.

Durch Entfernen dieser unnötigen Zeichen werden die generierten Seiten kleiner. Es wird daher empfohlen, in allen Projekten die Anweisung $CMS_TRIM(...)$ zu verwenden.

Für den Parameter level sollte ein Wert größer oder gleich 2 gewählt werden.

Syntax von $CMS_TRIM(...)$

Die Syntax der $CMS_TRIM(...)$-Anweisung sieht wie folgt aus:

$CMS_TRIM(level:LEVEL, char:CHAR)$
INHALT
$CMS_END_TRIM$

Innerhalb einer $CMS_TRIM(...)$-Anweisung können mehrere Parameter kommasepariert übergeben werden.

Für LEVEL und CHAR können zwar Ausdrücke angegeben werden, jedoch wird zur besseren Lesbarkeit die Verwendung von Konstanten empfohlen.

Beispiel mit Angabe von Konstanten:

$CMS_TRIM(level:3, char:"\r\n")$
...
$CMS_END_TRIM$

Parameter von $CMS_TRIM(...)$

$CMS_TRIM(...)$ verfügt nur über folgende Parameter:

  • level
  • char

Wichtig Bei dem Parameter level handelt es sich um einen Pflichtparameter.

Einstellung zum Entfernen von Whitespaces (level)

Über den Parameter level wird festgelegt, welche Whitespaces mit Hilfe von $CMS_TRIM(...)$ entfernt werden sollen.

Der Parameter erwartet als Wert eine Ganzzahl.

level

Bedeutung

0

Keine Änderung der Whitespaces.

1

Alle aufeinander folgenden Zeilen des Quelltexts, die nur Whitespaces enthalten, werden zu einer einzigen Zeile zusammengefasst.

2

Alle Zeilen des Quelltexts, die nur Whitespaces enthalten, werden entfernt.

3

Analog zu 2 werden alle Zeilen des Quelltexts, die nur Whitespaces enthalten, entfernt.

Zusätzlich werden bei dieser Einstellung noch führende und folgende Whitespaces in jeder Zeile entfernt.

4

Alle aufeinander folgenden Whitespaces werden zu einem Leerzeichen zusammengefasst.

Führende und folgende Leerzeichen werden zusätzlich entfernt.

  
Wichtig Bei der Angabe der level-Stufe 4 funktionieren keine Java-Skripte, da die benötigten Zeilenumbrüche entfernt werden!

Definition einer Zeichenfolge zum Beenden der bearbeiteten Zeilen (char)

Über den Parameter char wird definiert, mit welcher Zeichenfolge eine "getrimmte" Zeile des generierten Quelltexts beendet werden soll.

An das Ende aller Zeilen, die über die Anweisung $CMS_TRIM(...)$ bearbeitet wurden, wird also die hier angegebene Zeichenfolge gesetzt.

Standardmäßig werden Zeilen bei der Verwendung von $CMS_TRIM(...)$ mit der Zeichenfolge "\n" (Zeilenumbruch) beendet.

Bei Verwendung von $CMS_TRIM(...)$ muss folgende Syntax eingehalten werden:

$CMS_TRIM(level:GANZZAHL,char:"ZEICHEN")$
...
$CMS_END_TRIM$

bzw.

$CMS_TRIM(level:LEVEL,char:CHAR)$
...
$CMS_END_TRIM$

Eine Verknüpfung von char und level kann folgendermaßen angegeben werden:

$CMS_TRIM(level:3,char:"\n")$
...
$CMS_END_TRIM$

Im Codebeispiel wird der Parameter level in der Stufe 3 angewendet, also alle Zeilen des Quelltexts, die nur Whitespaces enthalten, und zusätzlich noch führende und folgende Whitespaces in jeder Zeile werden entfernt.

Alle Zeilen, die nicht vollständig, sondern in denen lediglich Whitespaces entfernt wurden, werden nun durch die Zeichenfolge "\n" beendet.

Beispiele zu $CMS_TRIM(...)$

Nachfolgend werden einige Beispiele zur Verwendung der Anweisung innerhalb von Vorlagen gezeigt. Die Beispiele sollen die konkrete Auswirkung der Anweisung verdeutlichen und eine Hilfe für den Vorlagenentwickler bei der Erstellung eigener Vorlagen sein.

Wichtig Für die Verwendung innerhalb eines Projekts, müssen die hier gezeigten Beispiele angepasst werden! Beispielsweise müssen Variablennamen auf die spezifischen Variablennamen des Projekts geändert werden, in dem die Anweisung verwendet werden soll.

1. Beispiel: level-Stufe 0

Codebeispiel:

$CMS_TRIM(level:0)$·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·$CMS_END_TRIM$

Beschreibung:

Auf den Inhalt zwischen $CMS_TRIM(...)$ und $CMS_END_TRIM$ werden die Ersetzungen der level-Stufe 0 angewendet.

Ausgabe:

·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·

(Darstellung: Leerzeichen = · und Zeilenumbruch = )

2. Beispiel: level-Stufe 1

Codebeispiel:

$CMS_TRIM(level:1)$·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·$CMS_END_TRIM$

Beschreibung:

Auf den Inhalt zwischen $CMS_TRIM(...)$ und $CMS_END_TRIM$ werden die Ersetzungen der level-Stufe 1 angewendet.

Ausgabe:


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄

(Darstellung: Leerzeichen = · und Zeilenumbruch = )

3. Beispiel: level-Stufe 2

Codebeispiel:

$CMS_TRIM(level:2)$·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·$CMS_END_TRIM$

Beschreibung:

Auf den Inhalt zwischen $CMS_TRIM(...)$ und $CMS_END_TRIM$ werden die Ersetzungen der level-Stufe 2 angewendet.

Ausgabe:

<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄

(Darstellung: Leerzeichen = · und Zeilenumbruch = )

4. Beispiel: level-Stufe 3

Codebeispiel:

$CMS_TRIM(level:3)$·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·$CMS_END_TRIM$

Beschreibung:

Auf den Inhalt zwischen $CMS_TRIM(...)$ und $CMS_END_TRIM$ werden die Ersetzungen der level-Stufe 3 angewendet.

Ausgabe:

<!--Hier·steht·ein·Kommentar-->
Hier·steht·ein·Text

(Darstellung: Leerzeichen = · und Zeilenumbruch = )

5. Beispiel: level-Stufe 4

Codebeispiel:

$CMS_TRIM(level:4)$·◄


<!--Hier·steht·ein·Kommentar-->
···Hier·steht·ein·Text·◄
·$CMS_END_TRIM$

Beschreibung:

Auf den Inhalt zwischen $CMS_TRIM(...)$ und $CMS_END_TRIM$ werden die Ersetzungen der level-Stufe 4 angewendet.

Ausgabe:

<!--Hier·steht·ein·Kommentar--> Hier·steht·ein·Text

(Darstellung: Leerzeichen = · und Zeilenumbruch = )

© 2005 - 2024 Crownpeak Technology GmbH | Alle Rechte vorbehalten. | FirstSpirit 2024.6 | Datenschutz