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

Talend Studioでは、ジョブやルートが作成、保存、アップデートされるたびに自動ドキュメンテーションが生成されるように永続パラメーターを設定できます。ジョブ/ジョブレットまたはルートのドキュメンテーションの自動生成をセットアップするには、次の手順に従います。

1. [Window] (ウィンドウ) > [Preferences] (環境設定)>Talend> [Documentation] (ドキュメンテーション)とクリックします。

2. [Automatic update of corresponding documentation of Job/joblet] (ジョブ/ジョブレットに対応するドキュメンテーションの自動アップデート)のチェックボックスをオンにします。

3. 生成したドキュメンテーションにこれ以上カスタマイズが必要なければ、OKをクリックします。

   これでジョブまたはルートが作成、保存、またはアップデートされるたびに、関連するドキュメンテーションが生成されます。

   生成されたドキュメントは、[Repository] (リポジトリー)ツリービューの[Documentation] (ドキュメンテーション)フォルダーに表示されます。

   

自動生成されたジョブ/ジョブレットまたはルートのドキュメンテーションを開くには、次の手順に従います。

1. [Repository] (リポジトリー)ツリービューで[Documentation] (ドキュメンテーション)ノードをクリックします。

2. 次に、すべてのルート、ジョブ、ジョブレットの自動ドキュメンテーションが保存されているGeneratedフォルダー内を検索します。

3. 適切なルート、ジョブまたはジョブレットラベルをダブルクリックして、対応するHTMLファイルをデザインワークスペース内の新しいタブとして開きます。

このドキュメンテーションは、ルート、ジョブまたはジョブレットに関連するすべての情報を収集しています。次にこのドキュメンテーションをHTMLおよびPDFとして圧縮ファイルにエクスポートできます。

1. [Repository] (リポジトリー)ツリービューで、エクスポートする適切なドキュメンテーションを右クリックします。

2. [Export documentation] (ドキュメンテーションのエクスポート)を選択してエクスポートウィザードを開きます。

3. 圧縮ファイルを作成する場所を参照します。

4. [Finish] (終了)をクリックしてエクスポートします。

この圧縮ファイルには、HTMLを任意のWebブラウザーで表示するのに必要なすべてのファイルが含まれています。

さらに、独自のロゴや会社名を使う別のCSS (Cascading Style Sheets)スタイルで自動生成ドキュメンテーションをカスタマイズできます。HTML用の送信先フォルダーには、htmlファイル、cssファイル、xmlファイル、およびピクチャフォルダーが含まれています。この操作は次の手順で行います。

1. [Window] (ウィンドウ) > [Preferences] (環境設定) > [Talend] > [Documentation] (ドキュメンテーション)に移動します。

   

2. 会社のロゴをすべての自動生成ドキュメンテーションで使用する場合は、[User Doc Logo] (ユーザードキュメントロゴ)フィールドで、会社ロゴの画像ファイルを参照します。

3. [Company Name] (会社名)フィールドで、会社名を入力します。

4. CSSファイルを使用する必要がある場合は、[Use CSS file as a template when export to HTML] (HTMLへのエクスポート時にCSSファイルをテンプレートとして使用)チェックボックスをオンにし、[CSS File] (CSS ファイル)フィールドを有効にします。

5. [CSS File] (CSS ファイル)フィールドで、使用するCSSファイルを参照するか、CSSファイルのパスを入力します。

6. [Apply] (適用)をクリックしてからOKをクリックします。