Platzhalterverzeichnis

- Platzhalterverzeichnis (CLXPlaceholderDoc)

Platzhalterverzeichnis (CLXPlaceholderDoc)

Anwendungsseiten

Standard (section=CLXPlaceholderDoc)

Listet die vorhandenen Anwendungen auf (siehe <!-- BEGIN/END clxplaceholderdoc_index -->). Pretty-URL wird verwendet um die Details zu einer Anwendung anzuzeigen (siehe <!-- BEGIN/END component -->).

Widgets
[[COMPONENT_NAME]]

Technischer, nicht übersetzter, Name der (aktuellen) Applikation.

<!-- BEGIN component -->

Dieser Block wird ausgegeben, wenn die Template-Integration einer Applikation angezeigt werden soll.

<!-- BEGIN component_title -->

Dieser Block wird für jede Sprache, in welche der Titel dieser Applikation übersetzt ist, ausgegeben.

[[COMPONENT_TITLE]]

Enthält den übersetzen Namen der Applikation.

[[LANGUAGE_CODE]]

Enthält den ISO-1 Sprachcode der aktuellen Sprache.

<!-- END component_title -->
<!-- BEGIN cmds -->

Dieser Block wird ausgegeben, sofern die Applikation mindestens ein CMD dokumentiert hat.

<!-- BEGIN cmd -->

Dieser Block wird für jedes CMD dieser Applikation ausgegeben.

<!-- BEGIN cmd_names -->

Dieser Block wird für den Namen, sowie alle Aliase des aktuellen CMD ausgegeben.

<!-- BEGIN cmd_name -->

Dieser Block wird für jedes CMD dieser Applikation ausgegeben, das nicht "Default" heisst. Dies kann z.B. verwendet werden um [[CMD_NAME]] nur für CMDs auszugeben, die nicht das Standard-CMD sind.

<!-- END cmd_name -->
<!-- BEGIN cmd_names_separator -->

Dieser Block wird ausgegeben, wenn das aktuelle CMD einen weiteren Namen/Alias enthält. Er ist dazu gedacht, Trennzeichen zwischen den Namen/Aliasen auszugeben.

<!-- END cmd_names_separator -->
<!-- END cmd_names -->
[[CMD_NAME]]

Der technische Name des CMD.

[[CMD_TITLE]]

Der formatierte Name des CMD.

[[CMD_DESCRIPTION]]

Die formatierte Beschreibung des CMD.

func_widgetLink(<widgetName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen Widget aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetParamLink(<paramName> : string [, <widgetName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des Widgets <widgetName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle Widget verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdLink(<cmdName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen CMD aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdParamLink(<paramName> : string [, <cmdName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des CMD <cmdName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle CMD verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetDescription(<widgetName> : string [, <fullText> : bool])

Gibt die formatierte Beschreibung (siehe [[DESCRIPTION]]) des als Parameter 1 angegebenen Widgets aus. So eingebundene Widgets werden nicht in den Widgets <!-- BEGIN/END widgets_<type> --> geparst.

Als zweiter Parameter kann false (ohne Anführungszeichen) mitgegeben werden um nur eine Kurzbeschreibung anzuzeigen (siehe <!-- BEGIN/END widget_short -->). Das Verhalten bleibt ansonsten dasselbe.

<!-- BEGIN widgets_<type> -->

Dieser Block wird ausgegeben, wenn der aktuelle Bereich <type> mindestens ein Widget enthält. <type> kann "cmd" (Widgets, die direkt in einem CMD verfügbar sind), "widget" (Widgets, die in einem anderen Widget verfügbar sind), "global" (global verfügbare Widgets) oder "orphaned" (Widgets, die nirgends verfügbar sind, für Debugging-Zwecke) sein.

<!-- BEGIN widget_<type> -->

Dieser Block wird für jedes Widget im aktuellen Bereich <type> ausgegeben (siehe <!-- BEGIN/END widgets_<type> -->).

[[WIDGET_<type>]]

Die formatierte Beschreibung eines Widgets (inkl. allfälliger Sub-Widgets). Siehe <!-- BEGIN/END widget -->.

<!-- END widget_<type> -->
<!-- BEGIN global_widget_description -->
Deprecated

Nur verfügbar innerhalb <!-- BEGIN/END widgets_global -->. Gibt eine allfällige übergeordnete Beschreibung aller globalen Widgets dieser Applikation aus.

Der entsprechende Key im Component.yml ist deprecated.

<!-- END global_widget_description -->
<!-- END widgets_<type> -->
<!-- END cmd -->
<!-- END cmds -->
<!-- BEGIN widgets_<type> -->

Dieser Block wird ausgegeben, wenn der aktuelle Bereich <type> mindestens ein Widget enthält. <type> kann "cmd" (Widgets, die direkt in einem CMD verfügbar sind), "widget" (Widgets, die in einem anderen Widget verfügbar sind), "global" (global verfügbare Widgets) oder "orphaned" (Widgets, die nirgends verfügbar sind, für Debugging-Zwecke) sein.

<!-- BEGIN widget_<type> -->

Dieser Block wird für jedes Widget im aktuellen Bereich <type> ausgegeben (siehe <!-- BEGIN/END widgets_<type> -->).

[[WIDGET_<type>]]

Die formatierte Beschreibung eines Widgets (inkl. allfälliger Sub-Widgets). Siehe <!-- BEGIN/END widget -->.

<!-- END widget_<type> -->
<!-- BEGIN global_widget_description -->
Deprecated

Nur verfügbar innerhalb <!-- BEGIN/END widgets_global -->. Gibt eine allfällige übergeordnete Beschreibung aller globalen Widgets dieser Applikation aus.

Der entsprechende Key im Component.yml ist deprecated.

<!-- END global_widget_description -->
<!-- END widgets_<type> -->
<!-- END component -->
<!-- BEGIN widget -->

Dieser Block bestimmt die Darstellung eines Widgets in [[WIDGET_<type>]].

[[WIDGET_NAME]]

Technischer Name des Widgets.

[[WIDGET_TYPE]]

Typ des Widgets ("placeholder", "block" oder "function").

[[WIDGET_NESTING_LEVEL]]

Aktuelle Verschachtelungstiefe.

[[WIDGET_TITLE]]

Übersetzter Name des Widgets.

[[WIDGET_NAME_FORMATTED]]

Formatierter Name des Widgets (also z.B. <!-- BEGIN xy --> für Widgets vom Typ "block"). Siehe auch <!-- BEGIN/END widget_end -->.

<!-- BEGIN widget_end -->

Dieser Block wird ausgegeben, sofern das Widget ein End-Tag hat (nur bei Widgets vom Typ "block" der Fall).

[[WIDGET_END]]

Das End-Tag des Widgets (z.B. <!-- END xy -->).

<!-- END widget_end -->
<!-- BEGIN description -->

Dieser Block wird ausgegeben, sofern das Widget ein Beschreibung hat.

[[DESCRIPTION]]

Formatierte Beschreibung des Widgets.

func_widgetLink(<widgetName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen Widget aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetParamLink(<paramName> : string [, <widgetName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des Widgets <widgetName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle Widget verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdLink(<cmdName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen CMD aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdParamLink(<paramName> : string [, <cmdName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des CMD <cmdName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle CMD verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetDescription(<widgetName> : string [, <fullText> : bool])

Gibt die formatierte Beschreibung (siehe [[DESCRIPTION]]) des als Parameter 1 angegebenen Widgets aus. So eingebundene Widgets werden nicht in den Widgets <!-- BEGIN/END widgets_<type> --> geparst.

Als zweiter Parameter kann false (ohne Anführungszeichen) mitgegeben werden um nur eine Kurzbeschreibung anzuzeigen (siehe <!-- BEGIN/END widget_short -->). Das Verhalten bleibt ansonsten dasselbe.

<!-- END description -->
<!-- BEGIN legacy -->

Dieser Block wird ausgegeben, sofern das Widget als "legacy" markiert ist. Dies ist bei globalen Widgets der Fall, die nicht über den Widget Component registriert sind.

<!-- END legacy -->
<!-- BEGIN deprecated -->

Dieser Block wird ausgegeben, sofern das Widget als "deprecated" markiert ist. Dies ist bei Widgets der Fall, die nur noch für die Rückwärtskompatibilität vorhanden sind und nicht mehr aktiv gewartet werden.

<!-- END deprecated -->
<!-- END widget -->
<!-- BEGIN widget_short -->

Dieser Block definiert die Darstellung der Kurzbeschreibung eines Widgets (siehe func_widgetDescription(<widgetName> : string [, <fullText> : bool])).

[[WIDGET_NAME]]

Technischer Name des Widgets.

[[WIDGET_NAME_FORMATTED]]

Formatierter Name des Widgets (also z.B. <!-- BEGIN xy --> für Widgets vom Typ "block"). Siehe auch <!-- BEGIN/END widget_end -->.

[[DESCRIPTION]]

Formatierte Beschreibung des Widgets.

func_widgetLink(<widgetName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen Widget aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetParamLink(<paramName> : string [, <widgetName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des Widgets <widgetName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle Widget verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdLink(<cmdName> : string [, <linkText> : string])

Gibt eine Verknüpfung zum als Parameter 1 angebenen CMD aus. Der optionale zweite Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_cmdParamLink(<paramName> : string [, <cmdName> : string [, <linkText> : string]])

Gibt eine Verknüpfung zum Parameter <paramName> des CMD <cmdName> aus. Wird der zweite Parameter nicht angegeben wird das aktuelle CMD verwendet (sofern verfügbar). Der optionale dritte Parameter kann verwendet werden, um den Linktext zu übersteuern.

func_widgetDescription(<widgetName> : string [, <fullText> : bool])

Gibt die formatierte Beschreibung (siehe [[DESCRIPTION]]) des als Parameter 1 angegebenen Widgets aus. So eingebundene Widgets werden nicht in den Widgets <!-- BEGIN/END widgets_<type> --> geparst.

Als zweiter Parameter kann false (ohne Anführungszeichen) mitgegeben werden um nur eine Kurzbeschreibung anzuzeigen (siehe <!-- BEGIN/END widget_short -->). Das Verhalten bleibt ansonsten dasselbe.

<!-- BEGIN legacy_short -->

Dasselbe wie <!-- BEGIN/END legacy --> für die Kurzdarstellung.

<!-- END legacy_short -->
<!-- BEGIN deprecated_short -->

Dasselbe wie <!-- BEGIN/END deprecated --> für die Kurzdarstellung.

<!-- END deprecated_short -->
<!-- END widget_short -->

Layout / Inhaltsseiten

<!-- BEGIN clxplaceholderdoc_index -->

Dieser Block wird geparst, wenn keine Applikation gewählt ist und deshalb eine Übersicht geparst wird.

<!-- BEGIN index_entry -->

Dieser Block wird für jede Applikation geparst, die ihre Template-Integration im Component.yml spezifiziert.

[[COMPONENT_NAME]]

Technischer, nicht übersetzter, Name der (aktuellen) Applikation.

[[COMPONENT_URL]]

Link-URL zur Detailansicht dieser Applikation.

<!-- END index_entry -->
<!-- END clxplaceholderdoc_index -->