Werkzeugdokumentationsstruktur
In der Abbildung unten wird das Desktop-Hilfesystem mit dem erweiterten Inhaltsverzeichnis für das Toolset "Nachbarschaftsanalyse (Proximity)" in der Toolbox Analysis dargestellt. In der Abbildung wird die von allen Toolboxes gemeinsam verwendete Inhaltsverzeichnisstruktur gezeigt.
- Jede Toolbox weist ein Übersichtsthema auf, in dem der Zweck der Toolbox beschrieben wird. In der Übersicht ist auch eine Tabelle mit allen Toolsets in der Toolbox mit Links zu den einzelnen Toolset-Übersichtsthemen enthalten. Außerdem gibt es einen Abschnitt mit Links zu verwandten Themen, die Sie möglicherweise interessieren könnten.
- Jede Toolbox umfasst ein Lizenzierungsthema mit Lizenzinformationen zu den einzelnen Werkzeugen in der Toolbox.
- Jedes Toolset enthält auch eine Übersichtsseite, die ähnlich wie die Toolboxübersichtsseite strukturiert ist. Auf der Toolsetübersichtsseite wird das Organisationsprinzip des Toolsets zusammengefasst.
- Im Anschluss an die Toolsetübersicht folgen die einzelnen Werkzeugreferenzseiten für die Werkzeuge im Toolset. Weitere Informationen zur Werkzeugreferenzseite finden Sie unten.
- Möglicherweise gibt es auch ein Toolset-Konzepthandbuch. Die Themen in den Konzepthandbüchern enthalten ausführliche Informationen zu den Werkzeugen im Toolset.
Dokumentation und Lizenzierung
- Die installierte Desktop-Dokumentation enthält unabhängig von den Lizenzen Themen für alle Werkzeuge. Beispielsweise ist die Toolbox "Network Analyst" immer installiert, obwohl dafür eine Lizenz für die ArcGIS Network Analyst extension-Erweiterung erforderlich ist. Ein anderes Beispiel ist das Werkzeug Verschneiden (Identity), das sich in der Toolbox "Analysis" befindet. Dafür ist eine ArcGIS Desktop Advanced-Lizenz erforderlich. Die Dokumentation ist jedoch auch dann installiert, wenn Sie über eine ArcGIS Desktop Basic-Lizenz verfügen.
- Die Lizenzierungsinformationen für die Werkzeuge befinden sich unten auf der Referenzseite des entsprechenden Werkzeugs. Darüber hinaus enthält jede Toolbox ein Lizenzierungsthema, in dem die Lizenzanforderungen für die einzelnen Werkzeuge aufgeführt sind.
- Die Werkzeugdokumentation für separate Produkte ist nicht installiert. So wird beispielsweise die Dokumentation zur Coverage-Toolbox erst installiert, wenn Sie ArcInfo Workstation installieren.
Werkzeugreferenzseite
Alle Werkzeugreferenzseiten verwenden dasselbe Layout, das unten beschrieben wird.
| Abschnitt | Inhalt |
|---|---|
Zusammenfassung | Eine kurze Zusammenfassung zur Funktionsweise des Werkzeugs. Diese Zusammenfassung enthält möglicherweise einen Link zu einem anderen Thema mit einer detaillierten Beschreibung zur Funktionsweise des Werkzeugs. |
Abbildung | Optionale Abbildung zur Erläuterung der Funktionsweise des Werkzeugs. |
Verwendung | Hinweise und Erklärungen zur Verwendung des Werkzeugs. Wenn sich die Hinweise auf einen bestimmten Parameter beziehen, wird die Parameterbeschriftung (die im Werkzeugdialogfeld angezeigt wird) verwendet und nicht der Parametername (der in der Syntax angezeigt wird). Die Übereinstimmung der Parameterbeschriftung mit dem Namen ist normalerweise offensichtlich; in einigen Fällen wird jedoch der Parametername notiert, um Verwechslungen zu vermeiden. |
Syntax | Die genaue Syntax zum Ausführen des Werkzeugs in einem Skript. Im Anschluss daran wird eine Tabelle angegeben, in der alle Parameter mit ihren Namen, Erklärungen und Datentypen (Wert) aufgeführt sind. Eine ausführliche Beschreibung finden Sie unter Werkzeugsyntax. |
Codebeispiel | Enthält ein oder mehr Python-Codebeispiele, in denen das Werkzeug verwendet wird. |
Umgebungen | Dies ist eine Liste der Umgebungseinstellungen, die für das Werkzeug berücksichtigt werden. Jede Umgebung ist mit der Umgebungseinstellungs-Referenzseite verknüpft. Wenn die Umgebung für das Werkzeug eine besondere Bedeutung hat, werden möglicherweise weitere Informationen zur Umgebung angeführt. |
Verwandte Themen | Eine Liste verwandter Themen, in der immer die Toolset-Übersichtsseite eingeschlossen ist. |
|
Lizenzinformationen |
Lizenzen, die für die Verwendung des Werkzeugs erforderlich sind. |