La documentation d’un outil de géotraitement personnalisé permet aux utilisateurs de comprendre et d'utiliser efficacement votre outil. Elle peut être créée en partie à l’aide de la boîte de dialogue de propriétés de l’outil, mais aussi avec les métadonnées de l’outil.
Propriétés de l’outil
Définissez les propriétés répertoriées ci-dessous pour documenter l’outil dans la boîte de dialogue Properties (Propriétés). Pour ouvrir la boîte de dialogue Properties (Propriétés), cliquez avec le bouton droit sur l’outil dans la fenêtre Catalog (Catalogue).
- Sous l’onglet latéral General (Généralités), fournissez une description, un résumé et une illustration de l’outil.
- Sous l’onglet latéral Parameters (Paramètres), définissez une description pour chaque paramètre qui s’affiche dans la boîte de dialogue de l’outil lorsque vous positionnez le pointeur sur le bouton Information (Informations)
situé à proximité de l’étiquette du paramètre.
Métadonnées
Pour créer une documentation d’aide complète pour un outil, modifiez ses métadonnées, c’est-à-dire la description de l’élément, qui sont constituées des composantes suivantes :
- Title (Titre) : nom de l’outil personnalisé.
- Thumbnail (Miniature) : miniature qui s’affiche lorsque vous positionnez le curseur sur l’outil dans la fenêtre Catalog (Catalogue).
- Tags (Balises) : mots-clés utilisés pour rechercher les outils dans la fenêtre Catalog (Catalogue) ou la vue Catalog (Catalogue).
- Summary (Abstract) (Résumé) : résumé de la tâche que l’outil exécute et brefs exemples de cas d'utilisation. Le résumé s’affiche lorsque vous positionnez le curseur sur le bouton Help (Aide)
dans la fenêtre Geoprocessing (Géotraitement).Remarque :
Si le résumé est défini dans les métadonnées de l’outil et dans la boîte de dialogue Properties (Propriétés), le résumé des propriétés de l’outil s’affichent dans la boîte de dialogue de l’outil.
- Usage (Utilisation) : conseils généraux ou instructions pour utiliser l’outil de manière correcte et efficace.
- Syntax (Syntaxe) : aide spécifique sur chaque paramètre, notamment les valeurs et les types de données acceptables.
Des exemples de code, des crédits, des contraintes d’utilisation et une emprise peuvent également être documentés dans les métadonnées.
Pour documenter l’outil de géotraitement personnalisé et la boîte à outils, cliquez avec le bouton droit sur l’outil ou la boîte à outils, puis sélectionnez Edit Metadata (Modifier les métadonnées). Vous pouvez également cliquer avec le bouton droit sur l’outil ou la boîte à outils, sélectionner View Metadata (Afficher les métadonnées), puis cliquer sur le bouton Edit (Mettre à jour) 
sous l’onglet Catalog (Catalogue). Après avoir documenté l’outil personnalisé, quiconque l’utilisant peut obtenir de l’aide sur cet outil comme pour n'importe quel outil de géotraitement fourni avec ArcGIS Pro.
Vous avez un commentaire à formuler concernant cette rubrique ?