Änderungen von Dokument Platzhalter

Von Version < 44.9 >

bearbeitet von awa
am 02.01.2020, 11:09

Auf Version < 53.3 >

bearbeitet von gru
am 30.04.2020, 05:59

< >

Änderungskommentar: Code Makros angepasst

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1
          +1,1 @@
--XWiki.awa
++XWiki.gru

Inhalt

@@ -18,7
          +18,7 @@
  === Verwendung in Templates ===
--{{figure image="3_de_PlatzhalterTemplates.png" width="300" group="platzhalter"}}
++{{figure image="3_de_PlatzhalterTemplates.png" group="platzhalter"}}
  Platzhalter können auch in Templates genutzt werden. Der Knopf //Platzhalter// öffnet das entsprechende Auswahlmenü.
  {{/figure}}
@@ -29,7
          +29,7 @@
  === Formularplatzhalter ===
  {{panel monospace="true" title="Syntax"}}
--[%{{italic}}&lt;NameDesFormularelements&gt;{{/italic}}%]
++[%&lt;NameDesFormularelements&gt;%]
  {{/panel}}
  Dieser Platzhalter wird ersetzt durch den Wert des Formularelements mit dem angegebenen Namen. Formularplatzhalter werden in Aktionen wie z.B. [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]], [[Text erzeugen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WriteTextFile]], [[Datenbank>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.SQLStatement]] sowie bei [[Templates>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ResponsePage]] verwendet.
@@ -40,13
          +40,15 @@
  Einige spezielle Formularplatzhalter existieren für alle Formulare:
--* [%xf-action%] Der Name der Schaltfläche, die zum Absenden verwendet wurde. Kann etwa genutzt werden, um über eine Bedingung bestimmte Aktionen nur auszuführen, wenn eine bestimmte Schaltfläche gedrückt wurde.
--* [%lang%] Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. //de//, //de-CH//, //en/ oder //fr-FR//.//
++; [%xf-action%]
++: Der Name der Schaltfläche, die zum Absenden verwendet wurde. Kann etwa genutzt werden, um über eine Bedingung bestimmte Aktionen nur auszuführen, wenn eine bestimmte Schaltfläche gedrückt wurde.
++; [%lang%]
++: Verweist auf die Sprache, die beim Ausfüllen des Formulars verwendet wurde, z.B. //de//, //de-CH//, //en// oder //fr-FR//.
  === Systemplatzhalter ===
  {{panel monospace="true" title="Syntax"}}
--[%${{italic}}&lt;Name&gt;{{/italic}}%]
++[%$&lt;Name&gt;%]
  {{/panel}}
  Dieser Platzhalter wird ersetzt durch den entsprechenden Systemwert. Aktuell stehen folgende Systemplatzhalter in Aktionen und Templates zur Verfügung.
@@ -83,42
          +83,106 @@
  ==== Parametrisierbare Systemplatzhalter ====
  {{panel monospace="true" title="Syntax"}}
--[%${{italic}}&lt;Name&gt;(&lt;Paramater&gt;...){{/italic}}%]
++[%$&lt;Name&gt;(&lt;Parameter&gt;...)%]
  {{/panel}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$DATE({{html~}~}&quot;{{/html~}~}<format>{{html~}~}&quot;{{/html~}~}, <lang>)%]"}}{{info}}Verfügbar ab FORMCYCLE Version 6.0.5{{/info}} Aktuelles Datum. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.
++; [%$DATE("<format>", <lang>)%]
++: {{version major="6" minor="0" patch="5"/}} Aktuelles Datum. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden. Siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$DATE("dd.MM.yyyy", de)%]{{/code}}.
++; [%$FORM_DATE_CREATED("<format>", <lang>)%]
++: {{version major="6" minor="0" patch="5"/}} Erstellungsdatum des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden. Siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$FORM_DATE_CREATED("dd.MM.yyyy", de)%]{{/code}}
++; [%$FORM_DATE_MODIFIED("<format>", <lang>)%]
++: {{version major="6" minor="0" patch="5"/}} Datum der letzten Änderung des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Parameter kann das Format und die Sprache bestimmt werden. Siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]) für mehr Informationen zum Datumsformat. Beispiel: {{code language="none"}}[%$FORM_DATE_MODIFIED("dd.MM.yyyy", de)%]{{/code}}
--Beispiel: {{code}}[%$DATE("dd.MM.yyyy", de)%]{{/code}}
++=== Benutzerplatzhalter {{version major="6" minor="4" patch="0"/}} ===
--(siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]){{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_DATE_CREATED({{html~}~}&quot;{{/html~}~}<format>{{html~}~}&quot;{{/html~}~}, <lang>)%]"}}{{info}}Verfügbar ab FORMCYCLE Version 6.0.5{{/info}} Erstellungsdatum des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.
++{{panel monospace="true" title="Syntax"}}
++[%$&lt;Benutzerobjekt&gt;.&lt;Attribut&gt;%]
++{{/panel}}
--Beispiel: {{code}}[%$FORM_DATE_CREATED("dd.MM.yyyy", de)%]{{/code}}
++Über verschiedene Benutzerobjekte kann auf die Informationen der angemeldeten Benutzer zugrgriffen werden. Wird der Platzhalter ohne Attribut angegeben (z.b. [%USER%]), so werden sämtliche Benutzerinformation im [[JSON>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]]-Format ausgegeben.
--(siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]){{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$FORM_DATE_MODIFIED({{html~}~}&quot;{{/html~}~}<format>{{html~}~}&quot;{{/html~}~}, <lang>)%]"}}{{info}}Verfügbar ab FORMCYCLE Version 6.0.5{{/info}} Datum der letzten Änderung des Vorgangs. Die Parameter sind optional. Ohne Parameter wird das Datum im Standardformat zurückgegeben. Durch die Paramater kann das Format und die Sprache bestimmt werden.
++Für die sinnvolle Verwendung von Benutzerplatzhaltern ist es nötig, dass eine [[Formularanmeldung>>doc:Formcycle.UserInterface.MyForms.Access.WebHome]] am Formular konfiguriert ist. Ist dies nicht der Fall, ist das Benutzerobjekt mit einem anonymen Nutzer vorbelegt.
--Beispiel: {{code}}[%$FORM_DATE_MODIFIED("dd.MM.yyyy", de)%]{{/code}}
++==== Benutzerobjekte ====
--(siehe [[SimpleDateFormat>>https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html]]){{/litem}}
++; [%$USER%]
++: Benutzerobjekt für den Zugriff auf den aktuellen Benutzer.
++; [%$LAST_USER%]
++: Benutzerobjekt für den Zugriff auf den letzten Benutzer.
++
++; [%$INITIAL_USER%]
++: Benutzerobjekt für den Zugriff auf den Benutzer, der den Vorgang angelegt hat.
++
++==== Attribute ====
++
++Mit den Attributen eines Benutzerobjektes können gezielt Informationen über den Benutzer ermittelt werden. Die folgenden Attribute stehen bei allen Benutzern zur Verfügung. Auch wenn diese Attribute immer zur Verfügung stehen, müssen sie nicht immer einen Wert haben. Ob das Attribut einen Wert besitzt, hängt davon ab mit welcher [[Authentifizierungsmethode>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]] sich der Benutzer angemeldet hat.
++
++Beispiel: Mit dem Platzhalter **[%$USER.mail%]** gelangt man an die E-Mailadresse des angemeldeten Benutzers.
++
++; authTypeId
++: ID des [[Authentifikators>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]], der vom Benutzer verwendet wurde, um sich anzumelden.
++; displayName
++: Anzeigename des angemeldeten Benutzers
++; familyName
++: Nachname des angemeldeten Benutzers
++; gender
++: Geschlecht des angemeldeten Benutzers
++; groups
++: Namen der Gruppen, denen der Benutzer angehört
++; id
++: ID des angemeldeten Benutzers. (System-ID bei FORMCYCLE-Benutzern)
++; linkedId
++:
++; locale
++: Sprache des angemeldeten Benutzers
++; location
++: Ort des angemeldeten Benutzers
++; mail
++: E-Mailadresse des angemeldeten Benutzers
++; phone
++: Telefonnummer des angemeldeten Benutzers
++; pictureUrl
++: URL zum Profilbild des angemeldeten Benutzers
++; profileUrl
++: URL zum Profil des angemeldeten Benutzers
++; rawData
++: Die gesamte Rohdaten des angemeldeten Benutzers im [[JSON>>https://de.wikipedia.org/wiki/JavaScript_Object_Notation]]-Format. Abhängig vom verwendeten Authentifikator können die Rohdaten weitere Benutzerinformationen enthalten, die nicht über die Attribute des Benutzerobjektes abgebildet werden.
++; role
++: Rolle des angemeldeten Benutzers
++; title
++: Titel des angemeldeten Benutzers
++; typedId
++: Typ des [[Authentifikators>>doc:Formcycle.UserInterface.UserSettings.ExternalUsers.WebHome]], der vom Benutzer verwendet wurde, um sich anzumelden.
++; userName
++: Benutzername des angemeldeten Benutzers
++
  === Systemplatzhalter für HTML-Templates ===
  {{panel monospace="true" title="Syntax"}}
--[%${{italic}}&lt;Name&gt;{{/italic}}({{italic}}&lt;Parameter1&gt;{{/italic}},{{italic}}&lt;Parameter2&gt;{{/italic}})%]
++[%$&lt;Name&gt;(&lt;Parameter1&gt;,&lt;Parameter2&gt;)%]
  {{/panel}}
  Zusätzlich zu den allgemeingültigen Systemplatzhaltern gibt es noch einige weitere Systemplatzhalter, welche nur innerhalb eines [[HTML-Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.HTML.WebHome]] verwendet werden können. Diese dienen zum Herunterladen von Anhängen und sind hierfür nur innerhalb der Browser-Session nach dem Absenden eines Formulars nutzbar.
--* {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_LIST%]"}}Stellt alle an einem Vorgang verfügbaren Anhänge (Attachments) in einer Liste zum Herunterladen bereits. Die erzeugte Liste wird als //ul//-HTML-Element in das Tempalte eingefügt.{{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP=Dateiname,Link-Text%]"}}Erzeugt einen Link zum Herunterladen aller Anhänge eines Vorgangs. Die Parameter //Dateiname// sowie //Link-Text// sind optional, sodass dieser Systemplatzhalter in folgenden Varianten genutzt werden kann.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP=Dateiname,Link-Text%]"}}Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP=Dateiname%]"}}Erzeugt einen Link mit dem Text //Dateiname// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT_ZIP%]"}}Erzeugt einen Link mit dem Text //attachment.zip// zum Herunterladen der Datei, die den Dateinamen //attachment.zip// erhält.{{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT=Anhang,Link-Text,Dateiname%]"}}Erzeugt einen Link zum Download eines einzelnen Anhangs eines Vorgangs mit dem Namen "Anhang". Dieser muss für eine korrekte Funktion den Namen einer erzeugten bzw. an den Vorgang angehangenen Datei entsprechen. Die Parameter "Link-Text" und "Dateiname" sind hierbei optional, sodass sich folgende Verwendungsmöglichkeiten ergeben.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT=Anhang,Link-Text,Downloadname%]"}}Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Dateiname// erhält.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT=Anhang,Link-Text%]"}}Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.{{/litem}}
--** {{litem styleTitle="letter-spacing:1px;" title="[%$ATTACHMENT=Anhang%]"}}Erzeugt einen Link mit dem Text //Anhang// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.{{/litem}}
++; [%$ATTACHMENT_LIST%]
++: Stellt alle an einem Vorgang verfügbaren Anhänge (Attachments) in einer Liste zum Herunterladen bereits. Die erzeugte Liste wird als //ul//-HTML-Element in das Tempalte eingefügt.
++; [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
++: Erzeugt einen Link zum Herunterladen aller Anhänge eines Vorgangs. Die Parameter //Dateiname// sowie //Link-Text// sind optional, sodass dieser Systemplatzhalter in folgenden Varianten genutzt werden kann.
++:; [%$ATTACHMENT_ZIP=Dateiname,Link-Text%]
++:: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.
++:; [%$ATTACHMENT_ZIP=Dateiname%]
++:: Erzeugt einen Link mit dem Text //Dateiname// zum Herunterladen der Datei, die den Dateinamen //Dateiname// erhält.
++:; [%$ATTACHMENT_ZIP%]
++:: Erzeugt einen Link mit dem Text //attachment.zip// zum Herunterladen der Datei, die den Dateinamen //attachment.zip// erhält.
++; [%$ATTACHMENT=Anhang,Link-Text,Dateiname%]
++: Erzeugt einen Link zum Download eines einzelnen Anhangs eines Vorgangs mit dem Namen "Anhang". Dieser muss für eine korrekte Funktion den Namen einer erzeugten bzw. an den Vorgang angehangenen Datei entsprechen. Die Parameter "Link-Text" und "Dateiname" sind hierbei optional, sodass sich folgende Verwendungsmöglichkeiten ergeben:
++:; [%$ATTACHMENT=Anhang,Link-Text,Downloadname%]
++:: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Dateiname// erhält.
++:; [%$ATTACHMENT=Anhang,Link-Text%]
++:: Erzeugt einen Link mit dem Text //Link-Text// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.
++:; [%$ATTACHMENT=Anhang%]
++:: Erzeugt einen Link mit dem Text //Anhang// zum Herunterladen des Anhangs mit dem Namen //Anhang//, der den Dateinamen //Anhang// erhält.
  Zusätzlich ist bei dieser Art von Platzhaltern zu beachten, dass sie automatisch aus dem Template entfernt werden, wenn keine entsprechende Datei gefunden wurde bzw. erzeugt werden konnte.
@@ -125,15
          +125,15 @@
  === Textbausteinplatzhalter ===
  {{panel monospace="true" title="Syntax"}}
--[%$${{italic}}&lt;Name&gt;{{/italic}}%]
++[%$$&lt;Name&gt;%]
  {{/panel}}
--Ein Textbausteinplatzhalter gibt den Inhalt eines [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] (zum Beispiel [[Text->>doc:Formcycle.UserInterface.FilesAndTemplates.Text]], [[Mail->>doc:Formcycle.UserInterface.FilesAndTemplates.Email]], [[Link-Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Link]]) zurück und wird z.B. in Aktionen vom Typ [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]] verwendet.
++Ein Textbausteinplatzhalter gibt den Inhalt eines [[Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] (zum Beispiel [[Text->>doc:Formcycle.UserInterface.FilesAndTemplates.Text]], [[Mail->>doc:Formcycle.UserInterface.FilesAndTemplates.Email]], [[Link-Templates>>doc:Formcycle.UserInterface.FilesAndTemplates.Link]]) zurück und wird beispieslweise in Aktionen vom Typ [[E-Mail>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.EMail]] verwendet.
  === Aktionsplatzhalter ===
  {{panel monospace="true" title="Syntax"}}
--[%${{italic}}&lt;Aktionsname&gt;{{/italic}}.{{italic}}&lt;RückgabeWert&gt;{{/italic}}%]
++[%$&lt;Aktionsname&gt;.&lt;RückgabeWert&gt;%]
  {{/panel}}
  Einige Aktionen haben Rückgabewerte, die über diesen Platzhalter ausgelesen werden können.
@@ -140,7
          +140,11 @@
  Sie sehen ähnlich wie Systemplatzhalter aus, haben aber im Unterschied zu diesen einen Punkt als Trennzeichen zwischen dem Namen der Aktion und dem Rückgabewert. Folgende Rückgabebezeichner sind vorhanden.
--* {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.SUCCESS%]"}}Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.{{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.COUNT%]"}}Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.{{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.RESULT%]"}}Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.{{/litem}}
--* {{litem styleTitle="letter-spacing:1px;" title="[%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]"}}Einige Aktionen liefern mehrere Ergebnisse zurück (//List<Map<String,String>>// in Java). Der Bezeichner ist dabei fest durch die Verarbeitung definiert. Wird häufig bei Plugins verwendet, falls mehrere Ergebnisse zurückgegeben werden.{{/litem}}
++; [%$<Aktionsname>.SUCCESS%]
++: Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück.
++; [%$<Aktionsname>.COUNT%]
++: Rückgabe der Anzahl von Ergebnissen. Liefert Integer-Wert zurück.
++; [%$<Aktionsname>.RESULT%]
++: Rückgabe eines einzelnen Ergebnis. Liefert String-Wert zurück.
++; [%$<Aktionsname>.RESULT[<Index>].<Bezeichner>%]
++: Einige Aktionen liefern mehrere Ergebnisse zurück (//List<Map<String,String>>// in Java). Der Bezeichner ist dabei fest durch die Verarbeitung definiert. Wird häufig bei Plugins verwendet, falls mehrere Ergebnisse zurückgegeben werden.

Änderungen von Dokument Platzhalter

Zusammenfassung

Details

Navigation