<obj-generatePreview>

Definition:

<!ELEMENT obj-generatePreview %cm.obj-generatePreview;>
<!ATTLIST obj-generatePreview
  editor CDATA #REQUIRED
  fsPrefix CDATA #REQUIRED
  masterTemplate CDATA #REQUIRED
  mode (0|1|2|3|4|5|6|7) #REQUIRED
  path CDATA #REQUIRED
  urlPrefix CDATA #REQUIRED
>

Aufgabe: Das Element holt eine Vorschauseite.

Spezielle Parameter dieses Funktionselements:

  • editor: Login des Benutzers, für den die Vorschau erstellt werden soll.
  • fsPrefix: das Zielverzeichnis für dynamisch inkludierte Dateien. Siehe den Systemkonfigurationswert dynamicPreviewDirectory in der Konfigurationsdatei guiConfig.xml.
  • masterTemplate: der Pfad des für den Export der Vorschauseite zu verwendenden Basislayouts.
  • mode: eine Bitmaske. Die folgenden Werte können nach Bedarf addiert werden, um die jeweils angegebenen Effekte zu erzielen:
    • 1: Arbeitsversionen bevorzugen (ansonsten 0, freigegebene Versionen verwenden)
    • 2: Arbeitsversionen von Layouts verwenden (ansonsten 0, freigegebene Versionen von Layouts verwenden).
    • 4: Reserviert.
  • path: der Pfad der betreffenden Datei, einschließlich Dateiendung, bei Ordnern einschließlich /index.html.
  • urlPrefix: Teil-URL, die der berechneten URL vorangestellt werden soll.

Rückgabewert bei Erfolg: der HTML-Text der Vorschauseite.

Erforderliche Rechte: Der authentifizierte Benutzer muss das Recht permissionRead für alle referenzierten Dateien haben.

Beispiel:

<obj-generatePreview
  editor="chiefeditor"
  fsPrefix="/"
  masterTemplate="mastertemplate"
  mode="0"
  path="/index.html"
  urlPrefix="/NPS/preview/mastertemplate/0"
/>