ツール ドキュメントの構造
次の図は、[コンテンツ] ウィンドウで [解析] ツールボックスの [近接] ツールセットを展開し、デスクトップのヘルプ システムを示したものです。この図は、すべてのツールボックスによって共有される [コンテンツ] ウィンドウの構造を示しています。
- 各ツールボックスには、ツールボックスの目的を説明する概要トピックがあります。概要には、各ツールセットの概要トピックへのリンクとともに、ツールボックスのすべてのツールセットが含まれたテーブルがあります。さらに、ユーザーが関心を持つ可能性のある関連トピックへのリンクを記載したセクションがあります。
- すべてのツールボックスには、ツールボックスの各ツールについてのライセンス情報を含む、ライセンス トピックが含まれています。
- 各ツールセットにも概要ページがあり、ツールボックスの概要ページと同様の構造になっています。ツールセットの構造原理は、ツールセットの概要ページにまとめられています。
- ツールセットの概要に続き、ツールセットのツールごとにツール参照ページがあります。ツール参照ページの詳細については、この後の説明をご参照ください。
- 最後に、ツールセットのコンセプト ブックがある場合があります。概念ブックのトピックには、ツールセットのツールに関する詳細情報が含まれています。
ドキュメントとライセンス
- インストールされたデスクトップ ドキュメントには、ユーザーのライセンスの種類にかかわらず、すべてのツールのトピックが含まれています。たとえば、[Network Analyst] ツールボックスを使用するには ArcGIS Network Analyst エクステンション エクステンション ライセンスが必要ですが、必ずインストールされます。また、[解析] ツールボックスの [アイデンティティ (Identity)] ツールには ArcGIS for Desktop Advanced ライセンスが必要ですが、ArcGIS for Desktop Basic ライセンスでもドキュメントがインストールされます。
- ツールのライセンスは、各ツールの参照ページの下部に表示されます。さらに、各ツールボックスには、各ツールのライセンス要件を一覧表示する、ライセンス トピックが含まれています。
- ツールのドキュメントは、独立した製品としてインストールされるわけではありません。たとえば、[カバレッジ] ツールボックスのドキュメントは、ArcInfo Workstation をインストールしない限り、インストールされません。
ツール リファレンス ページ
すべてのツール リファレンス ページは、次に説明する同じレイアウトを使用しています。
| セクション | コンテンツ |
|---|---|
サマリー | ツールの目的の簡単な説明。このサマリーには、ツールの機能に関する詳しい説明を含む、別のトピックへのリンクが含まれている場合があります。 |
図 | ツールの目的の説明に役立つ図 (オプション)。 |
使用法 | ツールの使用についての注意事項と説明。特定のパラメーターについての注意事項が記載される場合には、パラメーター名 (構文で示されるもの) ではなく、パラメーター ラベル (ツールのダイアログ ボックスに表示されるもの) が使用されます。パラメーターのラベルと名前は、通常は明確に対応していますが、混乱を避けるために、パラメーター名が記載されることもあります。 |
構文 | スクリプトでツールを実行するための、正確な構文。構文の後には、名前、説明、およびデータ (値) タイプを含むすべてのパラメーターを一覧表示するテーブルが示されます。詳細については、「ツールの構文の概要」をご参照ください。 |
コードのサンプル | ツールを使用した 1 つ以上の Python コードのサンプルが含まれます。 |
環境 | ツール使用時の環境設定のリストです。各環境は、環境設定のリファレンス ページにリンクされています。ツールにとって環境が特に重要である場合は、環境に関するさらに詳しい情報が掲載されている場合があります。 |
関連項目 | 関連項目のリストで、必ずツールセットの概要のページが含まれています。 |
ライセンス情報 | このツールを使用するために必要なライセンス。 |