JavaScript コード・エレメントの追加

テンプレート内で使用しているコードの各ブロックに JavaScript コード・エレメントを使用します。
制約事項: 新規フィーチャー・アイコン JavaScript コード・エレメントは バージョン 2 テンプレートでのみ使用可能です。

このタスクについて

JavaScript は、単純な引数から複雑なスクリプトに至るまで、広範囲に利用できます。
  • 単純な引数の場合、スクリプトはテキスト・エレメントなどのエレメントのコンテンツに適用できます。 テキスト・エレメントをダブルクリックし、「スクリプト式」タブを選択し、スクリプトを入力します。
  • 複雑なスクリプトに関しては、このタスクを JavaScript コード・エレメントとともに使用すれば、スクリプトを適用できます。
エレメントの「スクリプト式」タブで JavaScript コード・エレメントを使用する利点として、以下のようなことがあります。
  • 他のユーザーが使用したスクリプトを再利用できます。
  • 実行順序を考慮する必要なく計算をグループ化できます。
  • 通常のデータ構造体と複合データ構造体 (コレクションなど) を作成し、それに継続的に追加することができます。
    ヒント: Rational® Publishing Engine V2.1 リリース以降では、スクリプト・コードに「ライブラリー・スクリプト」プロパティーを設定することで、ある JavaScript コード・エレメントで定義した関数を別の JavaScript コード/スクリプト式で呼び出すことができます。 「ライブラリー・スクリプト」プロパティーを設定するには、「JavaScript コード」エレメントの「プロパティー」ビューにアクセスして「特定」タブを選択し、「ライブラリー・スクリプト」チェック・ボックスを有効にします。 ライブラリー・スクリプト・プロパティーについて詳しくは、「JavaScript コード・エレメント・プロパティー」を参照してください。

JavaScript ファイル utils.js が、インストール・ファイルと、事前定義のDocument Builderコンポーネント・ファイルに自動的に組み込まれます。これはレポート出力に現在日付を組み込むなどの、単純な JavaScript に使用されます。

テンプレート内の既存の JavaScript コードのリストを表示するには、 「テンプレート」 > 「JavaScript のレビュー」をクリックします。 「検索」ビューが開き、JavaScript を使用するエレメントのリストが表示されます。 ネイティブ・フィルターは、このコンテキストでは JavaScript とはみなされません。 ネイティブ・フィルターは、 検索結果にはリストされません。

手順

  1. JavaScript の処理を開始する前に、テンプレートを保存します。
  2. 「パレット」ビューで、「JavaScript コード」アイコン 「JavaScript コード」エレメントを選択して、テンプレート・コンテンツ・エディターにドラッグします。
  3. JavaScript コード・エレメントをダブルクリックします。
  4. 「スクリプト式」タブで、JavaScript コードを適用するツリーから変数を選択します。
  5. 以下のいずれかのオプションを使用して、JavaScript コードを入力します。
    • このウィンドウでスクリプトを手動で記述する
    • 外部エディターからこのウィンドウにスクリプトをコピーして貼り付ける
    • 「スクリプトの組み込み」をクリックして、コンピューター、リモート・サーバー、またはDocument Builderコンポーネントからファイルを選択する
  6. オプション: スクリプトを XHTML からコピーした場合は、以下を行うことができます。
    • 「XHTML 入力」オプションを選択してスクリプトに含まれている XHTML タグを編集できるようにする。
    • 「XHTML 入力」オプションをクリアして、 スクリプトからすべての XHTML タグを削除する。
    条件内でリッチ・テキストをコピーしているか、またはリッチ・テキストを使用している場合は、「XHTML 入力」オプションを選択する必要があります。
    重要: 無効な XHTML により文書生成が失敗します。変更内容を保存する前に、ご使用の XHTML が有効であることを確認します。
  7. オプション: XHTML 出力内にテンプレートを生成する場合は、以下を行うことができます。
    • 「XHTML 出力」オプションを選択して、 スクリプトを解析してスクリプトをリッチ・テキストとしてレンダリングする。
    • 「XHTML 出力」オプションをクリアして、 スクリプトをプレーン・テキストとして処理する。
    この選択は、式内のデータ・ソース属性のすべてに 適用されます。スクリプト内でプレーン・テキストと XHTML を混在させることはできません。

    リッチ・テキストをコピーしているか、または必要に応じて随時にリッチ・テキストを作成している場合、 「XHTML 出力」オプションを選択する必要があります。

  8. スクリプトを入力した後、「スクリプトのテスト」をクリックし、コードを検証します。 JavaScript にエラーがある場合は、文書の生成が正常に完了しないことがあります。
  9. 「OK」をクリックして変更を保存します。 コードのブロックがエレメント内で省略されます。テンプレート・コンテンツ・エディター内で コードを表示するために展開できます。

JavaScript エディターでの作業

JavaScript エディターは、構文の色分けやコンテンツ・アシストによりスクリプトを操作する場合に使用します。

このタスクについて

構文の色分け では、JavaScript のソース・コードが独自の色とスタイルでどのように変換されるのかが指定されます。 デフォルトの構文色設定を変更するには、Document Studio で「ウィンドウ (Windows)」 > 「設定」 > 「JavaScript」 > 「エディター (Editor)」 > 「色分け (Syntax Coloring)」を選択します。

コンテンツ・アシスト では、現行コード行を完成させるための有効な選択肢がポップアップ・ウィンドウにリストで表示されます。 コンテンツ・アシストをアクティブ化するには、Ctrl + スペースを押します。

これは JavaScript エディターの画面キャプチャーです。

手順

  1. JavaScript コード・エレメントをダブルクリックします。 「JavaScript コード・エレメントのコードの入力」ウィンドウが開きます。
  2. オプション: 新規スクリプトを別のファイルから組み込む場合は、「スクリプトの組み込み」をクリックして、コンピューター、リモート・サーバー、またはDocument Builderコンポーネントからファイルを選択します。「OK」をクリックします。

    ご使用のコンピューターまたはリモート・サーバーから選択されたファイルに関しては、選択ファイルに含まれる JavaScript コードのコピーが JavaScript エディターで開かれます。

    Document Builder から選択されたファイルに関しては、「スクリプト参照の使用」ウィンドウが開きます。 テンプレート内の参照リンクとして JavaScript を組み込むかどうかを選択する必要があります。
    • 「はい」を選択した場合は、JavaScript (.js) ファイルへのリンクが <Script> タグ内に組み込まれます。 例えば、次の参照リンクは JavaScript エディター内に追加されます。 このリンクは変更してはなりません。
      <Script src= "library://api/scripts/51"></Script>
      要確認: テンプレートから文書を生成する場合に、そのテンプレートで JavaScript が参照リンクとして使用されているのであれば、Document Builder を起動して Document Studio に接続する必要があります。 詳しくは、Document Builder コンポーネントへの接続トピックを参照してください。
    • 「いいえ」を選択した場合は、選択ファイルに含まれる JavaScript コードのコピーが JavaScript エディターで開かれます。
  3. オプション: 「エディターで開く」をクリックし、スクリプトを Eclipse JavaScript エディターに入力します。 スクリプトが新規エディター・タブで一時 .js ファイルとして開かれ、その JavaScript を編集したり、「アウトライン」ビューでオプションを使用してスクリプトを管理したりできるようになります。 スクリプトを編集した後は、変更内容を保存し、一時 JavaScript エディター・タブを閉じて、「JavaScript コード・エレメントのコードの入力」ウィンドウに戻ります。
  4. 「スクリプトのテスト」をクリックし、コードを検証します。
  5. 「OK」をクリックし、変更内容を保存して ウィンドウを終了します。