Kurzer Überblick über das Dokumentieren von Werkzeugen und Toolboxes
Um ein Werkzeug oder eine Toolbox zu dokumentieren, bearbeiten Sie die Seite Beschreibung wie unten beschrieben.
Hinweis:Toolsets weisen keine Elementbeschreibung auf, und Sie können keine Dokumentation für Toolsets eingeben.
Bearbeiten der Seite "Beschreibung"
Es gibt verschiedene Möglichkeiten, auf die Seite Beschreibung eines Werkzeugs oder einer Toolbox zuzugreifen.
Führen Sie im Fenster Katalog oder in ArcCatalog die folgenden Schritte aus:
- Klicken Sie mit der rechten Maustaste auf ein selbst erstelltes Werkzeug oder eine Toolbox, und wählen Sie Elementbeschreibung. Das Fenster Elementbeschreibung mit der Seite Beschreibung wird geöffnet.
- Klicken Sie auf die Schaltfläche Bearbeiten
.
Führen Sie im Fenster Suchen die folgenden Schritte aus:
Wenn bei einer Suche im Fenster Suchen ein Werkzeug oder eine Toolbox gefunden wird, wie unter Kurzer Überblick über das Suchen von Werkzeugen beschrieben, haben Sie folgende Möglichkeiten, um auf die Seite Beschreibung zuzugreifen:
- Bewegen Sie den Mauszeiger auf den Namen des Werkzeugs oder der Toolbox. Es wird ein Popup-Fenster angezeigt, das unten einen Link zu Elementbeschreibung enthält. Klicken Sie auf diesen Link, um das Fenster Elementbeschreibung zu öffnen, und klicken Sie dann auf die Schaltfläche Bearbeiten .
- Klicken Sie unterhalb des Namens auf die Zusammenfassungszeile des Werkzeugs bzw. der Toolbox, um das Fenster Elementbeschreibung zu öffnen, und klicken Sie dann auf die Schaltfläche Bearbeiten .
Eingeben einer Beschreibung für eine Toolbox
Für die Beschreibungsseite einer Toolbox wird eine von ArcGIS bereitgestellte Standardvorlage verwendet. Anfänglich ist diese Seite leer und zeigt nur den Standardinhalt an, z. B. den Namen der Toolbox und die darin enthaltenen Toolsets. Sie müssen in die entsprechenden Bereiche die relevanten Informationen eingeben, indem Sie die Tipps unten im Editor befolgen:
- Titel: Sie können einen anderen und ggf. aussagekräftigeren Titel für die Toolbox eingeben. Dieser alternative Titel wird auf der Seite Beschreibung angezeigt.
- Miniaturansicht: Sie können auf eine Bilddatei (z. B. im Format .jpg oder .png) zugreifen, die veranschaulicht, was die Toolbox enthält.
- Tags: Sie können Wörter eingeben, die zum Angeben des Themas oder Inhalts der Toolbox im System verwendet werden.
- Zusammenfassung: Sie können eine kurze Zusammenfassung zum Inhalt der Toolbox schreiben.
- Beschreibung: Hier können Sie eine ausführlichere Erklärung zur Toolbox eingeben.
- Beteiligte: Hier können Sie Personen oder Organisationen würdigen, die zu den Ressourcen beigetragen haben.
Eingeben einer Beschreibung für ein Werkzeug
Die Seite Beschreibung eines Werkzeugs verwendet auch eine von ArcGIS bereitgestellte Standardvorlage, die wie die Referenzseite eines Systemwerkzeugs aufgebaut ist. Anfänglich ist diese Seite leer und zeigt nur den Standardinhalt an, z. B. den Namen des Werkzeugs, Parameternamen und die Parameterdatentypen. Sie müssen in die entsprechenden Bereiche die relevanten Informationen eingeben, indem Sie die Tipps unten im Editor befolgen:
- Titel: Sie können einen anderen und ggf. aussagekräftigeren Titel für das Werkzeug eingeben. Dieser alternative Titel wird auf der Seite Elementbeschreibung angezeigt.
- Miniaturansicht: Sie können auf eine Bilddatei (z. B. im Format .jpg oder .png) zugreifen, die veranschaulicht, was mit dem Werkzeug durchgeführt werden kann.Hinweis:
Das Bild wird nur in der Elementbeschreibung angezeigt, nicht in der Hilfe im Seitenbereich des Werkzeugs.
- Tags: Sie können Wörter eingeben, die das Thema des Werkzeugs im System angeben.
- Zusammenfassung: Sie können eine kurze Zusammenfassung zum Inhalt des Werkzeugs schreiben.
- Verwendung: Sie können einen oder mehrere Tipps eingeben, die für Benutzer wichtig sind.
- Syntax: Die Werkzeugsyntax definiert die Werkzeugparameter und ihre Auswirkung auf die Ergebnisse des Werkzeugs. Obwohl die Namen und Typen der Parameter automatisch in die Tabelle eingefügt werden, müssen Sie die folgenden Parametererklärungen eingeben:
- Die Dialogerklärung ist die Referenz für einen Parameter im Werkzeugdialogfeld. Dieser Referenztext wird im Seitenbereich eines Werkzeugdialogfeldes angezeigt, wenn Sie auf Hilfe anzeigen >> klicken.
- Die Skripterstellungserklärung ist die Referenz für den gleichen Parameter in Bezug auf die Skripterstellung. Diese Referenz wird auf der Seite "Elementbeschreibung" und im Abschnitt "Hilfe" des Python-Fensters angezeigt.
- Codebeispiele: Sie können Beispiele für Python-Code angeben, die veranschaulichen, wie das Werkzeug im Python-Fenster und in einem eigenständigen Skript verwendet wird. Für jedes Beispiel können Sie einen Titel, eine Beschreibung des Beispiels und den Python-Code angeben.
- Beteiligte: Hier können Sie Personen oder Organisationen würdigen, die zum Design und zur Implementierung des Werkzeugs beigetragen haben.
Verwendung der Elementbeschreibung beim Suchen
Die Dokumentation, die Sie in der Elementbeschreibung angeben, wird im Fenster Suchen zum Suchen nach dem Werkzeug verwendet. Wenn die Suche den nächsten Indizierungslauf für die Werkzeuge durchführt, werden die Zusammenfassung und die Schlüsselwörter analysiert und dem Suchindex hinzugefügt.