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

Talend Cloud API Services Platform Studio ユーザーガイド

Version
Cloud
Language
日本語 (日本)
EnrichDitaval
API Services Platform
Product
Talend Cloud
Module
Talend Studio
Content
ジョブデザインと開発

Talend Studioでは、 Integration パースペクティブでStudioの[Repository] (リポジトリー)ツリービューで選択したジョブまたはルートの詳細なドキュメンテーションをHTML形式で生成できます。この自動ドキュメンテーションでは、以下のものが提供されます。

  • 選択したジョブまたはルートが作成されたプロジェクトのプロパティ、

  • 選択したジョブまたはルートのプロパティと設定、そして各ジョブまたはルートのプレビューピクチャ、

  • 選択した各ジョブまたはルートおよびコンポーネントパラメーターで使用されているすべてのコンポーネントのリスト。

  • Talendが提供する8.0 R2022-06以降のStudio月次アップデートをインストールし、ジョブまたはルートにジョブレット、ルートレット、子ジョブがある場合は、そのジョブまたはルートのドキュメンテーションの生成時に、そのジョブレット、ルートレット、子ジョブのドキュメンテーションも生成されます。ジョブレット、ルートレット、子ジョブのドキュメンテーションには、ジョブやルートのドキュメンテーションにある対応リンクから移動できます。

ジョブまたはルートに関するHTMLドキュメントを生成するには、次の手順に従います。

手順

  1. [Repository] (リポジトリー)ツリービューで[Job] (ジョブ) または[Route] (ルート) エントリーを右クリックするか、またはいくつかの項目を選択して、複数のドキュメンテーションを生成します。
  2. [Generate Doc As HTML] (ドキュメントをHTMLで生成)をコンテキストメニューで選択します。
  3. 生成されたドキュメンテーションの圧縮ファイルを保存する場所を参照します。
  4. 同じフィールドに、すべての生成ドキュメンテーションをまとめて圧縮するファイルの名前を入力します。
  5. CSSファイルを使用する必要がある場合は、[Use CSS file as a template to export] (エクスポート用のテンプレートとしてCSSファイルを使用)チェックボックスをオンにし、[CSS File] (CSSファイル)フィールドを有効にします。
  6. [CSS File] (CSS ファイル)フィールドで、使用するCSSファイルを参照するか、CSSファイルのパスを入力します。
  7. [Finish] (終了)をクリックして生成を確定します。

タスクの結果

圧縮ファイルは定義されたパスに生成されます。このファイルにはHTML出力ファイルに加えてすべての必要なファイルが含まれます。HTMLファイルは任意のブラウザーで開くことができます。