変数の定義および割り当て

テンプレートを設計する際に、値を計算したり、データ属性が通常は使用不可のコンテキストでそれらを使用可能にしたりすることが必要な場合があります。このような場合、変数を定義して、それに値を割り当てることができます。値は静的データにすることも、現行コンテキストで使用可能なデータにすることもできます。

このタスクについて

変数は、実行時に計算されるデータのプレースホルダーとして使用することも (変数の割り当て)、文書仕様で指定することもできます。データ属性とは異なり、変数をマスター・ページで使用することもできます。
変数には、以下の 2 つのタイプがあります。
  • ユーザー定義の変数: ユーザー定義の変数は、テンプレート設計者によって定義されます。ユーザー定義の変数には、内部のものと、外部のものがあります。
    • 内部ユーザー定義変数: 計算を実行したり、情報を一時保管したりする場合は、変数を内部として指定します。例として、マスター・ページにデータを取り込むときに使用する変数があります。内部変数は文書仕様に表示されないため、それらの変数に値を指定することはできません。
    • 外部ユーザー定義変数: 値を指定して使用する場合は、変数を外部として指定します。外部変数は文書仕様に表示されます。『文書仕様の作成』を参照してください。
  • Rational® Publishing Engine 変数: Rational Publishing Engine 変数は、文書テンプレートで使用できる内部変数です。
    表 1. 内部変数
    変数 説明
    _element_id テンプレート内部に保持され、デバッグに使用されます。
    _element_level 要素の再帰レベル。
    _row_number 現行テーブルの行番号。要素が行でない場合、値は 0 です。
    _cell_number 現在行のセル番号。要素がセルでない場合、値は 0 です。

手順

  1. 「アウトライン」ビューで、「変数」 > 「挿入」 > 「新規変数」をクリックします。「新規変数」ウィンドウが開きます。
  2. 以下のフィールドに変数の詳細を入力します。
    1. 名前: 変数の名前を入力します。 変数名はスクリプト内で使用されるので、有効な Java™ または JavaScript ID を使用する必要があります。
    2. 説明: 変数の説明を入力します。
    3. デフォルト値: 変数の値を入力します。
    4. アクセス: リストから変数が内部と外部のいずれであるかを選択します。
      • 内部変数は文書仕様に表示されないため、それらの変数に値を指定することはできません。
      • 外部変数は文書仕様に表示されるため、それらの変数に値を指定することができます。
  3. 要素に変数を割り当てるには、以下のようにします。
    ヒント: 可能な場合は常に、コンテナー要素に変数を割り当ててください。変数はコンテナー要素内の要素に適用されます。例えば、変数ごとに新規行が作成されるように、テーブル内で変数を使用する場合があります。テーブル要素に変数を割り当てると、変数ごとにテーブルが作成される可能性があります。これらの連続したテーブルがマージされる場合もありますが、個別のテーブルとして表示される場合もあります。テーブル内にコンテナー要素を追加して、行をコンテナー要素にドラッグしてから、変数をコンテナー要素に割り当てると、変数ごとに行がある 1 つのテーブルが作成されます。
    コンテナー要素が含まれるテーブル要素。コンテナー要素内に 3 つのセル要素を持つ行要素があります。
    1. 要素を右クリックして、「データ」 > 「割り当ての編集 (Edit Assignments)」をクリックします。 「割り当てエディター (Assignment Editor)」ウィンドウが開きます。
    2. 「追加」をクリックします。 「変数の選択」ウィンドウが開きます。
    3. 変数の名前を入力して、「OK」をクリックします。
    4. 「割り当てエディター (Assignment Editor)」ウィンドウで、「OK」をクリックします。

タスクの結果

選択した変数が定義され、現行要素に割り当てられます。

変数を要素に割り当てると、テンプレート・コンテンツ・エディターでその要素に 「変数の割り当て」アイコン アイコンが表示されます。

照会が指定され、変数が割り当てられた段落要素

次のタスク

ヒント: 変数の割り当て先の要素を右クリックして、「検索」 > 「要素内の変数参照 (Variable references in element)」を選択することによって、要素で使用されている変数割り当てのリストを検索できます。「検索」ビューが開き、変数割り当てのリストが表示されます。結果内の変数割り当てをダブルクリックすると、その変数割り当てを編集できます。

要素を右クリックして、「検索」 > 「要素内のすべての参照 (All references in element)」を選択することによって、要素で使用されている変数割り当て、属性、および照会のリストを検索できます。「検索」ビューが開き、リストが表示されます。結果内の項目をダブルクリックすると、それを編集できます。


フィードバック