Startseite / Vorlagenentwicklung / WebEdit / WebEdit-Formatvorlagen

Die WebEdit-Formatvorlagen

Die WebEdit-Standardformatvorlagen sind im Lieferumfang von FirstSpirit enthalten und können vom Projektadministrator über die FirstSpirit Server- und Projektkonfiguration installiert und aktualisiert werden. Anschließend können diese Formatvorlagen innerhalb der Projektvorlagen referenziert und verwendet werden. Die WebEdit-Formatvorlagen befinden sich in der Vorlagen-Verwaltung im Knoten „WebClient Formatvorlagen“:

Die WebEdit-Formatvorlagen werden ab FirstSpirit-Version 5.0 nicht mehr unterstützt.

Verwendung von WebEdit-Formatvorlagen

Die Anweisung $CMS_RENDER(...)$ dient dazu, innerhalb einer Vorlage den Inhalt einer Formatvorlage einzubinden. Die WebEdit-Formatvorlagen müssen daher über $CMS_RENDER(...)$ innerhalb der gewünschten Seiten- und Absatzvorlagen eingebunden werden:

$CMS_RENDER(template:"VORLAGE", OPTIONEN)$

Weiterführende Informationen siehe Kapitel zur Anweisung $CMS_RENDER(...)$ und Kapitel Formatvorlagen.

Bei der Verwendung der Vorlagen ist darauf zu achten, dass in jeder Seitenvorlage des Projektes WEBeditIncludeJS im <HEAD>-Bereich verwendet werden muss!

WEBeditBarIncludeJS

Mit WEBeditBarIncludeJS wird einer Seite die WebEdit-Funktion „Quick-Edit“ zur Verfügung gestellt. Die Vorlage WEBeditBarIncludeJS muss in jeder Seitenvorlage des Projektes verwendet werden, in der „Quick-Edit“ genutzt werden soll. Zusätzlich muss jede Seitenvorlage WEBeditIncludeJS enthalten.

$CMS_RENDER(template:"WEBeditIncludeJS")$
$CMS_RENDER(template:"WEBeditBarIncludeJS")$

Weitere Informationen zu WEBeditBarIncludeJS siehe Kapitel Quick-Edit.

WEBeditEditAttribute

WEBeditEditAttribute stellt die Funktion zur Bearbeitung einer Eingabekomponente zur Verfügung und benötigt den Pflichtparameter name für die Angabe der Eingabekomponente (z.B. „st_text“). Zusätzlich kann mit dem Parameter tooltip ein alternativer Tooltip vergeben werden.

$CMS_RENDER(template:"WEBeditEditAttribute",name:"st_subheadline")$

Sonderfall CMS_INPUT_CONTENTAREALIST und FS_LIST

Bei der Verwendung der Eingabekomponente CMS_INPUT_CONTENTAREALIST sowie FS_LIST muss darauf geachtet werden, dass die WebEdit-Icons nicht für die Absätze, die in der Eingabekomponente gepflegt wurden, ausgegeben werden, d.h. die WebEdit-Icons der in die Contentarealist bzw. FS_LIST eingefügten Absätze dürfen nicht angezeigt werden. Dies gilt für alle Render-Formatvorlagen, die eine Bearbeitung auf Attribut-Ebene zulassen:

Fall A: Ausgabe von Inhalten über $CMS_VALUE(...)$
Bei der Ausgabe des Inhalts der Eingabekomponenten CMS_INPUT_CONTENTAREALIST und FS_LIST über eine $CMS_VALUE(...)$-Anweisung werden die entsprechenden Steuerelemente (z.B. die Quick-Edit-Leiste auf Absatzebene) automatisch unterdrückt. Zum Beispiel:

$CMS_VALUE(BEZEICHNER_EINGABEKOMPONENTE)$

Fall B: Ausgabe von Inhalten über $CMS_FOR(...)$ / $CMS_VALUE(...)$:
Bei einer manuellen Ausgabe der Inhalte über eine $CMS_FOR(...)$- / $CMS_VALUE(...)$-Anweisung muss die Unterdrückung der Steuerelemente manuell in der Vorlage vorgenommen werden.

Dazu sollte im HTML-Kanal vor der Ausgabe der einzelnen Absätze der Eingabekomponente durch die $CMS_FOR(...)$-Anweisung folgende $CMS_SET(...)$-Anweisung eingefügt werden:

$CMS_SET(gv_void, #global.context.setVariableValue("#sectionList", BEZEICHNER_EINGABEKOMPONENTE))$

Über diesen Aufruf wird die fehlende Variable "#sectionList" definiert und mit den kontextbezogenen Daten der Eingabekomponente befüllt, so dass die Auswertungen der WebEdit-Formatvorlagen auch in diesem Spezialfall korrekt funktionieren.

Die Variable muss nach der Ausgabe wieder entfernt werden, damit die Steuerelemente für nachfolgende Absätze wieder ausgegeben werden:

$CMS_SET(gv_void, #global.context.removeVariable("#sectionList"))$

Beispiel HTML-Kanal:

$CMS_RENDER(template:"VORLAGE")$
   $CMS_SET(gv_void, #global.context.setVariableValue("#sectionList", BEZEICHNER_EINGABEKOMPONENTE))$
          $CMS_FOR(section, BEZEICHNER_EINGABEKOMPONENTE)$
                     $CMS_VALUE(section)$    
          $CMS_END_FOR$
   $CMS_SET(gv_void, #global.context.removeVariable("#sectionList"))$

Pflichtparameter

Parameter	Erläuterung / Beispiel
name	Bezeichnung der GUI-Komponente („name“ Attribut der <CMS_INPUT_...>-Komponente), z.B. name:"st_text" oder name:"st_headline"

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip: “Überschrift bearbeiten“

WEBeditEditContent

WEBeditEditContent ermöglicht die Bearbeitung eines Datensatzes und benötigt keinen Pflichtparameter. Mit dem optionalen Parameter tooltip kann ein alternativer Tooltip vergeben werden.

Regulär werden die UID der Tabellenvorlage und die ID des aktuell gerenderten Datensatzes verwendet. Über den optionalen Parameter content können die standardmäßig verwendeten UIDs der Tabellenvorlage ($CMS_VALUE(ContentName)$) geändert werden. Über den optionalen Parameter index kann die standardmäßig verwendete Datensatz-ID ($CMS_VALUE(#row.getId())$) geändert werden.

$CMS_RENDER(template:"WEBeditEditContent")$

Hinweise zur Verwendung der Eingabekomponenten CMS_INPUT_CONTENTAREALIST und FS_LIST siehe oben.

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip: "Überschrift bearbeiten"
content	Angabe der UID der Tabellenvorlage, z.B.: content:"glossar.glossary"
index	Angabe der ID des Datensatzes im Schema, z.B. index: "128" oder index:#row.getId()

WEBeditEditSectionAttributes

WEBeditEditSectionAttributes stellt die Funktion zur Bearbeitung aller Eingabekomponenten eines Absatzes zur Verfügung und benötigt keinen Pflichtparameter. Mit dem optionalen Parameter tooltip kann ein alternativer Tooltip vergeben werden.

$CMS_RENDER(template:"WEBeditEditSectionAttributes")$

Hinweise zur Verwendung der Eingabekomponenten CMS_INPUT_CONTENTAREALIST und FS_LIST siehe oben.

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip: "Überschrift bearbeiten"

WEBeditScripts

WEBeditScripts ermöglicht die Einblendung von bis zu drei Skript-Buttons in der WebEdit Symbolleiste.

Mit den optionalen Parametern script1 bis script3 wird eine Zeichenkette von Parametern übergeben, die festlegt, welche Parameter für das Skript zu berücksichtigen sind. Innerhalb dieser Zeichenkette erfolgt die Trennung von Schlüssel und Wert durch das Gleichheitszeichen („=“) und die Trennung eines Schlüssel/Wert-Paares durch das Zeichen „&“. Vor dem ersten Schlüssel/Wert-Paar steht KEIN „&“-Zeichen. Mit scriptTooltip1 bis scriptTooltip3 werden die Tooltips für die Buttons in der WebEdit-Symbolleiste angegeben, beispielsweise „Skript ausführen“:

$CMS_RENDER(template:"WEBeditScripts"
[,script1:"PARAMETER",scriptTooltip1:"TOOLTIP"]
[,script2:"PARAMETER",scriptTooltip2:"TOOLTIP"]
[,script3:"PARAMETER",scriptTooltip3:"TOOLTIP"])$

In WebEdit werden die Schlüssel script, id, store und templateset in einer Parameter-Zeichenkette ausgewertet, wobei script ein Pflichtschlüssel ist und den eindeutigen Bezeichner des auszuführenden Skripts enthalten muss. Weitere Schlüssel werden dem Skriptkontext zur Verfügung gestellt.

Bei templateset ist entweder der Name oder die Nummer des Präsentationskanals des Skriptes anzugeben. Die Schlüssel id und store geben an, in welcher Verwaltung (z.B. store=mediastore) und auf welchem Knoten (z.B. id=12345) das Skript ausgeführt werden soll. Diese beiden Schlüssel müssen immer gemeinsam angegeben werden.

Beispiel:

$CMS_RENDER(template:"WEBeditScripts",script1:"script=meinTestSkript&templateset=html&store=mediastore&id=23456&parameter1=wert1"

Im Beispiel wird der Inhalt des “html”-Kanals des Skriptes mit dem eindeutigen Bezeichner “meinTestSkript” auf dem Knoten mit der ID „23456“, in der Medien-Verwaltung ausgeführt. Im Skriptkontext ist der Parameter parameter1 mit dem Wert wert1 verfügbar.

Optionale Parameter

Parameter	Erläuterung / Beispiel
script1	Angabe der Parameter-URL für den ersten Skript-Button, z.B. script1:“script=meinSkript“
scriptTooltip1	Tooltip für den ersten Skript-Button in der WebEdit-Symbolleiste, z.B. scriptTooltip1:“Mein 1. Skript“
script2	Angabe der Parameter-URL für den zweiten Skript-Button, z.B. script2:“script=meinSkript“
scriptTooltip2	Tooltip für den zweiten Skript-Button in der WebEdit-Symbolleiste, z.B. scriptTooltip2:“Mein 2. Skript“
script3	Angabe der Parameter-URL für den dritten Skript-Button, z.B. script3:“script=meinSkript“
scriptTooltip3	Tooltip für den dritten Skript-Button in der WebEdit-Symbolleiste, z.B. scriptTooltip3:“Mein 3. Skript“

Parameter URL

Parameter	Erläuterung / Beispiel
script=WERT	Angabe des eindeutigen Bezeichners des auszuführenden Skriptes, z.B. script=meinSkript
templateset=WERT	Angabe des Präsentationskanals des auszuführenden Skripts, entweder über die Kanalnummer oder den Kanalnamen, z.B. templateset=0 oder templateset=html
store=WERT&id=WERT	ID und Verwaltung des Knotens, auf dem das Skript ausgeführt werden soll, z.B. store=mediastore&id=23884
NAME=WERT	Weitere Variablen, die im Skriptkontext verfügbar gemacht werden sollen, z.B. date=03.04.2005&editor=Franz

WEBeditSelectPicture

WEBeditSelectPicture stellt die Funktion zur Bearbeitung eines Bildes zur Verfügung und verfügt über dieselben Pflicht- und optionalen Parameter wie WEBeditEditAttribute: name für den Bezeichner der Eingabekomponente und tooltip als optionalen Parameter.

$CMS_RENDER(template:"WEBeditSelectPicture",name:"st_picture")$

Hinweise zur Verwendung der Eingabekomponenten CMS_INPUT_CONTENTAREALIST und FS_LIST siehe oben.

Pflichtparameter

Parameter	Erläuterung / Beispiel
name	Bezeichnung der GUI-Komponente („name“ Attribut der <CMS_INPUT_...>-Komponente), z.B. name:"st_picture"

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip: "Bild bearbeiten“

WEBeditIncludeJS

Mit WEBeditIncludeJS stellt man in einer Seite die WebEdit-Standardfunktionen zur Verfügung, daher muss der Parameter in jeder Seitenvorlage eines Projektes verwendet werden.

$CMS_RENDER(template:"WEBeditIncludeJS")$

WEBeditQuickBar

Mit WEBeditQuickBar wird die Quick-Edit-Leiste auf Seiten-/Absatzebene eingefügt. WEBeditQuickBar hat keine Pflichtparameter. Folgende optionale Parameter können angegeben werden: barOrientation, highlightContainer, highlightClass, extended, wfNew, wfChanged, wfDelete und wfForce. Mit barOrientation legt man die Ausklapprichtung der Quick-Edit-Leiste fest. hightlightContainer und highlightClass legen einen hervorzuhebenden Bereich fest und weisen ihm eine CSS-Klasse zu. Mit extended kann das initiale Ausklappverhalten der Quick-Edit-Leiste beeinflusst werden. Die Parameter wfNew, wfChanged und wfDelete dienen zur Festlegung der empfohlenen Arbeitsabläufe für die Objektstatus. Mit wfForce kann die Ausführung eines empfohlenen Arbeitsablaufes erzwungen werden.

$CMS_RENDER(template:"WEBeditQuickBar",barOrientation:"left",highlightContainer:"hc" + #global.page.id)$

Weitere Informationen zu WEBeditQuickBar siehe Kapitel Quick-Edit.

Hinweise zur Verwendung der Eingabekomponenten CMS_INPUT_CONTENTAREALIST und FS_LIST siehe oben.

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip:"Bearbeiten"
barOrientation	Angabe der Ausklapp-Richtung der Quick-Edit-Leiste. Wird der Wert „left“ angegeben, wird die Quick-Edit-Leiste nach links ausgeklappt, bei „right“ nach rechts, z.B. barOrientation:"left" Ist kein Parameter angegeben, klappt die Quick-Edit-Leiste nach rechts aus.
extended	Angabe des initialen Ausklappverhaltens EINER Quick-Edit-Leiste auf einer Vorschau-Seite, z.B. extended:“true“. „true“ bedeutet ausgeklappt und „false“ eingeklappt. Wenn der Parameter nicht angegeben wird, ist die Quick-Edit-Leiste eingeklappt. Der Parameter kann nur einmal pro Seite verwendet werden.
highlightContainer	ID des Elements, dessen Inhalt besonders hervorgehoben werden soll, z.B. highlightContainer:“absatz1“ Beispiele: highlightContainer: "hc" + #global.id highlightContainer: "hc" + #global.page.id highlightContainer: "hc" + #global.section.id
highlightClass	Angabe einer CSS-Klasse, die für das Element verwendet werden soll, das mit highlightContainer angegeben wurde. Wird keine CSS-Klasse angegeben, so wird die Standard-CSS-Klasse „weHighlight” verwendet. Beispiele: highlightClass: "weContainer" highlightClass: "layout"
wfNew	Name des empfohlenen Arbeitsablaufes für den Status „neu“, z.B. wfNew:"Freigabe Anfordern"
wfChanged	Name des empfohlenen Arbeitsablaufes für den Status „geändert“, z.B. wfChanged:"Freigabe Anfordern"
wfDelete	Name des empfohlenen Arbeitsablaufes für den Status „löschen“, z.B. wfDelete:"Delete"
wfForce	Ausführung des empfohlenen Arbeitsablaufes für einen Status erzwingen. „true“ bedeutet Ausführung erzwingen, „false“ Ausführung wird nicht erzwungen. Ist der Parameter nicht angegeben, so wird die Ausführung nicht erzwungen, z.B. wfForce:"true" oder wfForce:"false"
disableButtons	Angabe von Buttons der Quick-Edit-Leiste (auf Seitenebene), die aus der Leiste ausgeblendet werden sollen. Momentan ist das Ausblenden der Buttons über das Attribut disableButtons nur für die Buttons „Seite anlegen“ (disableButtons:"newpage") und „Extras“ (disableButtons:"extras") möglich. Die beiden Parameter können auch kombiniert angegeben werden, z.B. disableButtons:"newpage,extras" Diese Buttons werden beim Aufruf der Quick-Edit-Leiste nicht mehr angezeigt.

WEBeditSwitch

Über die Formatvorlage WEBeditSwitch ist es möglich, aus einer Seite, die keine Vorschauseite ist, einen Sprung in eine WebEdit-Vorschauseite („DeepLink“) zu realisieren.

$CMS_RENDER(template:"WEBeditSwitch",guiLanguage:"DE",login:"User_A",password:"PW_A")$

Die Formatvorlage WEBeditSwitch2 stellt zusätzliche Authentifizierungsverfahren zur Verfügung und sollte bevorzugt verwendet werden.

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip:"Seite anzeigen"
guiLanguage	Angabe einer gültigen Oberflächensprache, die für WebEdit genutzt werden soll, z.B.guiLanguage:"DE"
login	Angabe eines gültigen Benutzernamens für die Authentifizierung am WebClient, z.B. login:"User_A"
password	Angabe eines gültigen Passworts für die Authentifizierung am WebClient, z.B. password:“PW_A“

WEBeditSwitch2

Über die Formatvorlage WEBeditSwitch2 ist es möglich, aus einer Seite, die keine Vorschauseite ist, einen Sprung in eine WebEdit-Vorschauseite („DeepLink“) zu realisieren. Im Unterschied zu WEBeditSwitch können neben der herkömmlichen Authentifizierung („plain“) auch weitere Authentifizierungsverfahren genutzt werden (z.B. Authentifizierung per SAP-Ticket).

$CMS_RENDER(template:"WEBeditSwitch2",guiLanguage:"DE",login:"plain",user:"User_A",password:"PW_A")$

Optionale Parameter

Parameter	Erläuterung / Beispiel
tooltip	Angabe eines abweichenden Tooltips für die Anzeige, wenn mit dem Cursor über den Link gefahren wird, z.B. tooltip:"Gehe zu"
guiLanguage	Angabe einer gültigen Oberflächensprache, die für WebEdit genutzt werden soll, z.B. guiLanguage:"DE"
user	Angabe eines gültigen Benutzernamens für die Authentifizierung am WebClient, z.B. user:"User_A"
login	Angabe eines gültigen Authentifizierungsverfahrens für die Authentifizierung am WebClient, z.B. login:"ticket" Weitere Login-Möglichkeiten: plain: Klartext-Authentifizierung hash: Base64-Authentifizierung ticket: Authentifizierung per SAP-Ticket
ticket	Angabe eines Tickets für die SAP-Authentifizierung. Der Parameter ticket wird nur dann benötigt, wenn für den Parameter login das Authentifizierungsverfahren „ticket“ definiert wurde.
password	Angabe eines gültigen Passworts für die Authentifizierung am WebClient, z.B. password:“PW_A“

Druckversion | Seitenanfang