Beim Design einer Vorlage kann es notwendig sein, Werte zu berechnen
oder Datenattribute in Kontexten
verfügbar zu machen, in denen diese normalerweise nicht verfügbar sind.
Für diese Situationen können Sie Variablen definieren und ihnen Werte zuordnen.
Bei den Werten kann es sich um statische Daten handeln oder um Daten, die im aktuellen Kontext verfügbar sind.
Informationen zu diesem Vorgang
Variablen können als Platzhalter für die während der Ausführungszeit berechneten Daten (Variablenzuordnungen)
verwendet werden, oder sie können in der Dokumentspezifikation angegeben werden.
Im Gegensatz zu
Datenattributen können Sie Variablen auch in Stammseiten verwenden.
Es gibt zwei Arten von Variablen:
- Benutzerdefinierte Variablen: Benutzerdefinierte Variablen werden vom Entwickler der Vorlage definiert.
Eine benutzerdefinierte Variable kann intern oder extern sein.
- Interne benutzerdefinierte Variablen: Sie können eine Variable als interne Variable festlegen, um Berechnungen auszuführen oder
um Informationen temporär zu speichern. Dies kann z. B. eine Variable sein, mit der
Daten in die Stammseiten eingefügt werden.
Interne Variablen werden in der Dokumentspezifikation nicht angezeigt. Daher können Sie keine Werte dafür angeben.
- Externe benutzerdefinierte Variablen: Sie können eine Variable als externe Variable angeben, wenn Sie einen Wert dafür festlegen.
Externe Variablen werden in der Dokumentspezifikation angezeigt.
Weitere Informationen finden Sie unter Dokumentspezifikation erstellen.
- RPE-Variablen (Rational Publishing Engine): RPE-Variablen sind
interne Variablen, die zur Verwendung in der Dokumentvorlage verfügbar sind.
Tabelle 1. Interne VariablenVariable |
Beschreibung |
_element_id |
Ist intern in der Vorlage enthalten und wird für Debugging-Zwecke eingesetzt. |
_element_level |
Die rekursive Ebene eines Elements. |
_row_number |
Die Zeilennummer in einer aktuellen Tabelle.
Ist das Element keine Zeile, ist der Wert 0. |
_cell_number |
Die Zellennummer in einer aktuellen Zeile. Ist das Element keine Zelle, ist der Wert 0. |
Vorgehensweise
- Klicken Sie in der Sicht
Gliederung auf . Das Fenster
Neue Variable wird geöffnet.
- Geben Sie in den folgenden Feldern die Details zu den
Variablen ein:
- Name: Geben Sie den Namen der Variablen ein. Der Variablenname muss gültige
Java- oder JavaScript-IDs verwenden, weil sie in Scripts verwendet werden.
- Beschreibung: Geben Sie die Beschreibung für die Variable ein.
- Standardwert: Geben Sie den Wert für die Variable ein.
- Zugriff: Wählen Sie in der Liste aus, ob die Variable eine interne oder eine externe Variable ist.
- Interne Variablen werden in der Dokumentspezifikation nicht angezeigt, daher können dafür keine Werte festgelegt werden.
- Externe Variablen werden in der Dokumentspezifikation angezeigt, daher können Sie Werte dafür festlegen.
- Gehen Sie wie folgt vor, um einem Element eine Variable zuzuordnen:
Tipp: Ordnen Sie die Variablen möglichst den Containerelementen zu.
Die Variable wird auf die Elemente im Containerelement angewendet.
Beispielsweise könnten Sie eine Variable in einer Tabelle verwenden, damit für jede Variable eine neue Zeile erstellt wird.
Wenn Sie dem Tabellenelement
eine Variable zuordnen, wird eventuell für jede Variable eine Tabelle erstellt.
Manchmal werden diese aufeinanderfolgenden Tabellen zusammengefügt, aber manchmal werden sie auch als separate Tabellen angezeigt.
Wenn Sie in die Tabelle ein Containerelement aufnehmen und die Zeile in das Containerelement ziehen und wenn Sie
anschließend die Variable dem Containerelement zuordnen, wird eine einzelne Tabelle erstellt, die für jede Variable eine Zeile enthält.
- Klicken Sie mit der rechten Maustaste auf das Element,
und klicken Sie auf . Das Fenster
Zuordnungseditor wird geöffnet.
- Klicken Sie auf Hinzufügen. Das Fenster
Variable auswählen wird geöffnet.
- Geben Sie einen Namen für die Variable ein, und klicken Sie auf
OK.
- Klicken Sie im Fenster
Zuordnungseditor auf
OK.
Ergebnisse
Die ausgewählte Variable wird definiert und dem aktuellen Element zugeordnet.
Wenn Sie einem Element eine Variable zuordnen,
wird neben dem Element im Vorlageninhaltseditor
das folgende Symbol angezeigt:
Nächste Schritte
Tipp: Sie können nach einer Liste der in einem Element verwendeten
Variablenzuordnungen suchen, indem Sie das Element, dem die Variable zugeordnet ist,
mit der rechten Maus anklicken, und
auswählen.
Die Sicht "Suchen" wird geöffnet, und eine Liste mit Variablenzuordnungen wird angezeigt. Sie können doppelt auf eine Variablenzuordnung
in den Ergebnissen klicken, um
sie zu bearbeiten.Sie können nach einer Liste der in einem Element verwendeten
Variablenzuordnungen, Attribute und Abfragen suchen, indem Sie ein Element mit der rechten Maustaste anklicken, und
auswählen. Die Sicht "Suchen" wird geöffnet, und eine Liste wird angezeigt. Sie können doppelt auf einen
Eintrag in den Ergebnissen klicken, um
ihn zu bearbeiten.