ドキュメンテーションの生成

ご使用のモジュールおよびライブラリーにリソースのドキュメンテーションを生成できます。

ドキュメンテーションを生成するには、以下の手順に従います。

  1. 「ビジネス・インテグレーション」ビューからリソースを選択します。
  2. ツールバーの「ドキュメンテーションの生成」ツールバーの「ドキュメンテーションの生成」ボタン をクリックするか、 または右クリックして「ドキュメンテーションの生成...」を選択します。 「ドキュメンテーションの生成」ウィザードが開きます。
    注: このウィザードのすべてのフィールドでは、F1 でヘルプ情報を表示できるため、指定を行うのに役立ちます。 Tab キーを使用してフォーカスをフィールドまたはボタンに移動し、 次に F1 キー (Linux® の場合は Ctrl+F1 キー) を押して追加のヘルプを表示します。
  3. 「ドキュメンテーションの生成」ウィザードで「作成者名 (Author name)」「ドキュメンテーション・タイトル (Documentation title)」、 および生成される PDF ファイルのロケーションを指定します。デフォルトのファイル名は reportFile.pdf で、 デフォルトのロケーションはご使用のワークスペース内です。 説明やレポート名の変更方法については、F1 ヘルプを参照してください。
  4. デフォルト設定を受け入れ、「終了」をクリックしてドキュメンテーションを生成できます。ただし、出力に含める追加のリソースを選択する場合、 またはドキュメンテーションのレイアウトを変更する場合は、「次へ」をクリックします。
    注: 「終了」ボタンが使用可能でない場合は、 ドキュメンテーション生成プログラムによってサポートされていないリソースを選択したということです。 この場合、「次へ」をクリックして、新しいマスター・ファイルを作成する必要があります。 その後で、ドキュメンテーション生成プログラムによってサポートされていないリソースを選択できるようになります。 リソースの文書化に関する追加情報については、 関連概念の『ドキュメンテーションまたはリソース』を参照してください。
    1. 生成された出力の内容をさらにカスタマイズしたい場合は、「内容の選択」ページで指定を行います。
      • 文書生成のリソースを追加または除去しない場合は、 「選択したリソースからドキュメンテーションを生成します」を選択します。
      • 前に保存したリソース・プロファイルを再実行するには、「既存のマスター・ファイルからドキュメンテーションを生成します」とマスター・ファイルを選択します。
      • このドキュメンテーション生成のリソースを追加または除去するには、 「新しいマスター・ファイルを作成します (Create a new master file)」を選択します。
      マスター・ファイルに関する追加情報については、関連概念の『ドキュメンテーションまたはリソース』を参照してください。 「次へ」をクリックします。
    2. 「値の編集 (Edit content)」ページで、 ドキュメンテーションのリソースを追加または除去できます。リソースを選択し、> をクリックして「文書入力リソース (Document input resources)」テーブルにそのリソースを追加します。テーブルで項目を選択して < をクリックすれば、 生成されるドキュメンテーションから内容を除去することもできます。 「参照ファイルの組み込み」チェック・ボックスを選択すると、 選択したリソースによって参照される成果物の情報も生成されます。 参照されるファイルに関する追加情報については、関連概念の『ドキュメンテーションまたはリソース』を参照してください。

      「別名保存」ボタンによって新しいマスター・ファイルが保管されるため、 そのマスター・ファイルを使用して同じレポートを再生成できます。 「次へ」をクリックします。

    3. 「レイアウト設定」ページで、必要なドキュメンテーション・レイアウトを選択し、「終了」をクリックしてドキュメンテーションを生成します。
      注: レイアウトとスタイルの設定を変更した場合、その変更は保管され、再度変更されるまで、 それ以降のすべてのドキュメンテーション生成で使用されます。
      ドキュメンテーションで使用するために新しいフォントを追加するには、 次の『フォントの追加』を参照してください。
  5. 指定したロケーションで PDF ファイルを見つけ、Acrobat Reader で開きます。

フォントの追加

生成されるドキュメンテーションで使用できるように新しいフォントを追加する場合、 「ドキュメンテーションの生成」ウィザードを起動し、「レイアウト設定」ページが表示されるまで「次へ」をクリックします。

「ドキュメンテーションの生成」ウィザードの「レイアウト設定」ページ

次に、以下のステップに従います。

  1. 「デフォルト・フォントの上書き」チェック・ボックスを選択します。 「フォント...」ボタンが使用可能になります。
  2. 「フォント...」をクリックして、 「ドキュメンテーション・スタイルの設定」ページを開きます。

    「ドキュメンテーション・スタイルの設定」ページ

  3. 「フォントの管理 ...」をクリックして、 「ドキュメンテーションに使用するフォントの管理」ウィンドウを開きます。

    「ドキュメンテーションに使用するフォントの管理」ウィンドウ

  4. 「追加...」ボタンをクリックします。 「ドキュメンテーションに使用するフォントの追加」ウィンドウが開きます。

    「ドキュメンテーションに使用するフォントの追加」ウィンドウ

  5. 「参照」をクリックして「開く」ウィンドウを表示し、 TTF または TTC ファイルを探して選択します。
    注: (Windows® のみ) Windows ディレクトリー (例えば WINNT または WINDOWS) からフォントを選択する場合、次に示す「開く」ウィンドウで TTF または TTC ファイルの名前を再入力する必要があります:
    WINNT ディレクトリーの「開く」ウィンドウ
    。Windows において、 デフォルトでは、WINNT ディレクトリーで TTF または TTC ファイルをダブルクリックすると、 選択する代わりにこれらのファイルが開きます。マウスを使用して選択を行うには、TTF または TTC ファイルを別のディレクトリーにコピーします。 次に、マウスをでフォント・ファイルをクリックして、選択します。

    TTC ファイルが選択されている場合は、有効なフォント名を入力する必要があります。

  6. 「ドキュメンテーション・フォント (Documentation Font)」ウィンドウで「OK」をクリックして選択を完了します。 「ドキュメンテーションに使用するフォントの管理」ウィンドウに新しいフォントが表示されます。
    注: 「ドキュメンテーション生成」ウィザードでは、 2 バイト文字セットのフォント名を含む登録済みフォント名がローマ字のみで表示されます。
  7. 「OK」をクリックして「ドキュメンテーション・スタイルの設定」ページに戻ります。このページで、リストされたテキストのタイプに新しいフォントを選択できます。

これで、新しいフォントが登録され、これ以降のすべてのドキュメンテーションの生成で使用できます。 デフォルト・フォントは除去できません。

関連資料
リソースのドキュメンテーション

Feedback
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
(C) Copyright IBM Japan 2006