カスタム ジオプロセシング ツールのドキュメント化

カスタム ジオプロセシング ツールをドキュメント化することで、他のユーザーがツールを理解して効果的に使えるようになります。 このドキュメントは、ツールのプロパティ ダイアログ ボックスや、ツールのメタデータを使用して、部分的に作成できます。

ツールのプロパティ

ツールをドキュメント化するには、プロパティ ダイアログ ボックスで、以下に示すプロパティを設定します。 [プロパティ] ダイアログ ボックスを開くには、[カタログ] ウィンドウでツールを右クリックします。

  • [一般] サイド タブで、ツールの説明、サマリー、図を入力します。
  • パラメーターのサイド タブで、ツール ダイアログ ボックスのパラメーター ラベルの横にある [情報] ボタン 情報 の上にポインターを置いたとき表示される、各パラメーターの説明を設定します。

メタデータ

ツールの完全なヘルプ ドキュメントを作成するには、ツールのメタデータ (アイテムの説明) を修正します。メタデータには、次のコンポーネントが含まれます:

  • [タイトル] - カスタム ツールの名前。
  • [サムネイル] - [カタログ] ウィンドウでツールの上にポインターを置いたとき表示されるサムネイル。
  • [タグ] - [カタログ] ウィンドウまたは [カタログ] ビューでツールを検索するため使用されるキーワード。
  • [サマリー (要約)] - ツールが実行するタスクの概要と、用途についての簡単な説明。 このサマリーは、[ジオプロセシング] ウィンドウで [ヘルプ] ボタン ヘルプ の上にポインターを置いたとき表示されます。
    注意:

    ツールのメタデータと [プロパティ] ダイアログ ボックスでサマリーが設定されているなら、ツールのプロパティのサマリーがツール ダイアログに表示されます。

  • [使用法] - ツールを正しく効果的に使用するための一般的なヒントまたは手順。
  • [構文] - 各パラメーターに固有のヘルプ (受け入れられるデータ タイプと値など)。

コード サンプル、クレジット、使用の制約、境界ボックスもメタデータにドキュメント化できます。

カスタム ジオプロセシング ツールとツールボックスをドキュメント化するには、ツールまたはツールボックスを右クリックし、[メタデータの編集] を選択します。 あるいは、ツールまたはツールボックスを右クリックして [メタデータの表示] を選択し、[カタログ] タブの [編集] ボタン 編集 をクリックします。 カスタム ツールをドキュメント化した後で、ツールを使用しているユーザーは、ArcGIS Pro に含まれるジオプロセシング ツールと同じ方法でヘルプを表示できるようになります。


このトピックの内容
  1. ツールのプロパティ
  2. メタデータ