Zweck

Parameter dienen der Erfassung von Benutzereingaben während des interaktiven Erstellungsprozesses einer Dokumentvorlage.

Sie können innerhalb der XML-Dokumentvorlage sowohl zur Ausgabe von Werten als auch zur Steuerung der Dokumentlogik verwendet werden.

Der Komponentenbereich Parameter ermöglicht die Verwaltung aller der Dokumentvorlage zugeordneten Parameter.

Darstellung

Alle Parameter werden innerhalb des Komponentenbereichs in einer Baumstruktur dargestellt.

Für die Anzeige eines Parameters kann wahlweise der technische Parametername oder der Anzeigename verwendet werden.

Die Darstellung wird über Documents → Konfiguration → Developer mit der Einstellung Technischen Parameternamen anzeigen gesteuert.

Empfehlung

Aktivieren Sie die Einstellung Technischen Parameternamen anzeigen.

Der technische Parametername entspricht dem Namen innerhalb der XML-Dokumentvorlage und erleichtert das Auffinden eines Parameters während der Entwicklung erheblich.

Nicht einer Parameterseite oder Gruppe zugeordnete Parameter werden direkt unterhalb der Ebene Parameter dargestellt.

Arbeiten mit Parametern

Ein Parameter kann entweder über die linke Maustaste oder über das Kontextmenü bearbeitet werden.

Während der Linksklick unmittelbar den Bearbeitungsdialog öffnet, stellt das Kontextmenü zusätzliche Funktionen für die Verwaltung sowie die Verwendung des Parameters innerhalb der XML-Dokumentvorlage bereit.

Parameter bearbeiten

Ein Linksklick auf einen Parameter öffnet den Dialog Parameter bearbeiten.

Der Dialog entspricht dem Dialog Parameter hinzufügen und ermöglicht die Anpassung sämtlicher Parametereigenschaften.

Abhängig vom Parametertyp werden unterschiedliche Eingabemöglichkeiten angezeigt. So stehen beispielsweise für Dropdown-Parameter zusätzliche Funktionen zur Verwaltung der Auswahlwerte zur Verfügung.

Die vorgenommenen Änderungen werden nach Bestätigung des Dialogs unmittelbar für die Dokumentvorlage übernommen.

Kontextmenü

Über einen Rechtsklick auf einen Parameter öffnet sich das Kontextmenü.

Je nach Parametertyp stehen unterschiedliche Funktionen zur Verfügung.

Parameter bearbeiten

Öffnet den Dialog Parameter bearbeiten.

Die Funktion entspricht einem Linksklick auf den Parameter.

Bei Cursor einfügen

Mit dieser Funktion unterstützt der Developer den Redakteur beim Erzeugen des passenden XML-Codes für den ausgewählten Parameter.

Der generierte XML-Code wird an der aktuellen Cursorposition innerhalb der XML-Dokumentvorlage eingefügt.

Hierzu muss der Cursor zuvor an die gewünschte Position innerhalb des XML-Codes gesetzt werden.

Alternativ kann ein bestehender XML-Bereich markiert werden. In diesem Fall ersetzt der generierte XML-Code den markierten Bereich.

Hinweis

Die Funktion prüft weder die XML-Struktur noch die fachliche Position innerhalb der Dokumentvorlage.

Der XML-Code wird exakt an der aktuellen Cursorposition eingefügt.

Befindet sich der Cursor innerhalb eines XML-Tags oder wurde ungeeigneter XML-Code markiert, kann dadurch ungültiger XML-Code entstehen.

Erzeugter XML-Code

Abhängig vom Parametertyp erzeugt der Developer unterschiedliche XML-Strukturen.

Parametertyp	Erzeugter XML-Code
SingleText	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
MultiText	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
Numeric	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
Date	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
Address	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
Currency	Ein <Variable>-Element zur Ausgabe des Parameterwertes.
Bool	Eine leere <If>-Struktur zur Auswertung des Parameterwertes.
Dropdown	Auswahl zwischen einem <Variable>-Element zur Ausgabe des ausgewählten Wertes oder einer leeren <Case>-Struktur zur Auswertung der Auswahl.

Zu Parameter im Text springen

Sucht die erste Verwendung des ausgewählten Parameters innerhalb der XML-Dokumentvorlage.

Wird eine Verwendung gefunden, positioniert der Developer den Cursor automatisch an der entsprechenden Stelle und hebt den Parameter innerhalb des XML-Codes hervor.

Dadurch lassen sich Parameter auch in umfangreichen Dokumentvorlagen schnell auffinden.

Parameter löschen

Entfernt den Parameter aus der Dokumentvorlage.

Vor dem Löschen prüft der Developer, ob der Parameter innerhalb der XML-Dokumentvorlage noch verwendet wird.

Wird eine Verwendung gefunden, informiert ein Hinweisdialog über diesen Sachverhalt.

Nach Bestätigung des Dialogs wird die entsprechende Position innerhalb der XML-Dokumentvorlage automatisch markiert.

Dadurch kann der Redakteur die Verwendung des Parameters prüfen und bei Bedarf entfernen.

Parameter in Seite verschieben

Verschiebt den ausgewählten Parameter in eine vorhandene Parameterseite.

Sobald mindestens eine Parameterseite vorhanden ist, erweitert der Developer das Kontextmenü automatisch um ein entsprechendes Untermenü.

Nach dem Verschieben wird der Parameter innerhalb der Baumstruktur unter der gewählten Parameterseite dargestellt.

Nicht zugeordnete Parameter verbleiben direkt unterhalb der Ebene Parameter.

Parameter in Gruppe verschieben

Verschiebt den ausgewählten Parameter in eine vorhandene Gruppe.

Sobald mindestens eine Gruppe vorhanden ist, erweitert der Developer das Kontextmenü automatisch um ein entsprechendes Untermenü.

Nach dem Verschieben wird der Parameter innerhalb der gewählten Gruppe dargestellt.

Nicht zugeordnete Parameter verbleiben direkt unterhalb der Ebene Parameter.

Hinweis

Gruppen besitzen innerhalb der Baumstruktur dieselbe Darstellung wie normale Parameter und unterscheiden sich ausschließlich durch ihre Funktion.

Parameter sortieren

Über das Kontextmenü der Ebene Parameter kann die Funktion Parameter sortieren aufgerufen werden.

Es öffnet sich ein Dialog zur Anpassung der Reihenfolge aller nicht einer Parameterseite oder Gruppe zugeordneten Parameter.

Die Reihenfolge bestimmt unmittelbar die Darstellung der Parameter während des interaktiven Erstellungsprozesses.

Die Sortierung kann jederzeit angepasst werden und wirkt sich ausschließlich auf die Reihenfolge der Anzeige aus.