ツールとツールボックスのドキュメント化の概要
ツールまたはツールボックスに関する説明を入力するには、ツールまたはツールボックスの [説明] ページを編集します。操作内容については、以下に説明します。
注意:ツールセットにはアイテムの説明がないので、ツールセットについての説明を入力することはできません。
説明ページの編集
ツールまたはツールボックスの [説明] ページの編集にアクセスするには、いくつかの方法があります。
カタログ ウィンドウでの操作
- 作成したツールまたはツールボックスを右クリックし、[アイテム説明] をクリックします。 [アイテム説明] ウィンドウが開き、[説明] ページが表示されます。
- [編集] ボタン
をクリックします。
ArcCatalog での操作
- カタログ ツリー ビューで、作成したツールまたはツールボックスを選択します。
- [コンテンツ] パネルで、[説明] タブをクリックします。
- [編集] ボタン をクリックします。
検索ウィンドウでの操作
[検索] ウィンドウで検索した結果、ツールまたはツールボックスが見つかった場合、ツールの検索の概要の説明にあるように、次の方法で [説明] ページにアクセスできます。
- ツールまたはツールボックス名の上にカーソルを合わせると、下部に [アイテムの説明] へのリンクが埋め込まれたポップアップ ウィンドウが表示されます。そのリンクをクリックして [アイテムの説明] ウィンドウを開き、[編集] ボタン をクリックします。
- その名前の下にあるツールまたはツールボックスのサマリ行をクリックして [アイテムの説明] ウィンドウを開き、[編集] ボタン をクリックします。
ツールの説明の入力
ArcGIS に付属している標準テンプレートは、システム ツールのリファレンス ページと同じ構造のもので、ツールの [説明] ページにも使用されています。このページは初期設定では空になっていて、デフォルトのコンテンツ（たとえば、ツール名、パラメータ名、パラメータのデータ タイプなど）しか表示されません。以下の領域では、エディタの下部に表示されたヒントに従って関連情報を入力する必要があります。
- タイトル: ツールについて他と異なる具体的内容を示すタイトルを入力することができます。この代替のタイトルは、[アイテムの説明] ページに表示されます。
- サムネイル: ツールに格納される内容を示す画像ファイル（たとえば、*.jpg や *.png）を閲覧することができます。グラフィックスの幅が 600 ピクセルを超えないようにすることをお勧めします。これを超えると、印刷時にカットされる可能性があります。注意:
画像は、[アイテム説明] にのみ表示されます。ツールのサイドパネル ヘルプには表示されません。
- タグ: システム内にあるツールの目的を特定する際に使用する単語を入力することができます。
- サマリ: ツールの機能についての短いサマリを記述することができます。
- 使用法: 知っておくと便利なヒントを 1 つまたは複数入力することができます。
- 構文: ツールの構文にはツールのパラメータを定義するほか、ツールのパラメータがツールの実行結果におよぼす影響を定義します。パラメータ名とタイプはテーブルに自動的に入力されるようになっていますが、これらのパラメータの説明は入力する必要があります。
- [ダイアログの説明] は、ツール ダイアログ ボックス上のパラメータに関するリファレンスです。このリファレンスは、[ヘルプの表示] をクリックしたときにツール ダイアログ ボックスのサイド パネルに表示されます。
- [スクリプトの説明] は、スクリプト内に使用されているものと同一のパラメータに関するリファレンスです。このリファレンスは、Python ウィンドウの [ヘルプ] セクションの [アイテムの説明] ページに表示されます。
- サンプル コード: Python コードの例を挙げて、Python でのツールの使用方法を説明できます。サンプルごとに、タイトル、サンプルの説明、および Python コードを入力することができます。
- ツール サイドバー ヘルプ イメージ: ツールのサイド パネル ヘルプに表示される画像です。グラフィックスの幅が 400 ピクセルを超えないようにすることをお勧めします。
- 著作権: ツールの設計/実装に貢献した方や組織の名称を入力することができます。
ツールボックスの説明の入力
ツールボックスの [説明] ページには、ArcGIS に付属している標準テンプレートが使用されます。このページは初期設定では空になっていて、デフォルトのコンテンツ（ツールボックス名とその内部のツールセットなど）しか表示されません。以下の領域では、エディタの下部に表示されたヒントに従って関連情報を入力する必要があります。
- タイトル: ツールボックスについて他と異なる具体的内容を示すタイトルを入力することができます。この代替としてのタイトルは、[説明] ページに表示されます。
- サムネイル: ツールボックスに格納される内容を示す画像ファイル（たとえば、*.jpg や *.png）を閲覧することができます。
- タグ: システム内にあるツールボックスの主題またはコンテンツの特定に使用するための単語を入力することができます。
- サマリ: ツールボックスの内容についての簡単なサマリを記述することができます。
- 説明: ツールボックスについての詳細な説明を記述することができます。
- 著作権: リソースに貢献した方や組織の名称を入力することができます。
検索でのアイテムの説明の使用
[アイテムの説明] に入力しておいた説明は、[検索] ウィンドウによるツール検索に使用されます。次回の検索でツールにインデックスが付けられると、サマリとキーワードが解析されて検索インデックスに追加されます。