Présentation rapide de la documentation des outils et des boîtes à outils

Pour documenter un outil ou une boîte à outils, modifiez la page Description comme indiqué ci-dessous.

Remarque :

Comme les jeux d'outils ne possèdent pas de description d'élément, vous ne pouvez pas entrer de documentation pour les jeux d'outils.

Modification d'une page Description

Vous pouvez accéder à la page Description d'un outil ou d'une boîte à outils de différentes façons.

A partir de la fenêtre Catalogue ou d'ArcCatalog

• Cliquez avec le bouton droit sur un outil ou une boîte à outils que vous avez créé et cliquez sur Description d'élément. La fenêtre Description d'élément s'ouvre et affiche la page Description.
• Cliquez sur le bouton Editer. .

A partir de la fenêtre Rechercher

Lorsque vous recherchez un outil ou une boîte à outils et qu'il apparaît dans la fenêtre Rechercher (comme indiqué dans la rubrique Présentation rapide de la recherche d'outils), vous pouvez effectuer l'une des opérations suivantes pour accéder à sa page Description :

• Placez le curseur sur le nom de l'outil ou de la boîte à outils pour afficher une fenêtre contextuelle. Cliquez sur le lien Description d'élément qui figure en bas de cette fenêtre pour ouvrir la fenêtre Description d'élément, puis cliquez sur le bouton Editer .
• Cliquez sur la ligne de résumé de l'outil ou de la boîte à outils située sous son nom pour ouvrir la fenêtre Description d'élément, puis cliquez sur le bouton Editer .

Saisie de la description d'une boîte à outils

La page Description d'une boîte à outils utilise un modèle standard fourni par ArcGIS. Cette page est au départ vide et n'affiche que le contenu par défaut (nom de la boîte à outils et jeux d'outils qui y figurent, par exemple). Suivez les conseils indiqués dans la partie inférieure de l'éditeur pour remplir les informations pertinentes dans les zones ci-dessous :

• Titre : vous pouvez saisir un autre titre, plus descriptif par exemple, pour votre boîte à outils. Cet autre titre s'affiche dans la page Description.
• Miniature : vous pouvez rechercher un fichier image (.jpg ou .png, par exemple) qui illustre le contenu de la boîte à outils.
• Balises : vous pouvez saisir des mots qui permettent d'identifier le sujet ou le contenu de votre boîte à outils dans le système.
• Résumé : vous pouvez résumer le contenu de la boîte à outils.
• Description : vous pouvez écrire une explication plus détaillée sur votre boîte à outils.
• Crédits : vous pouvez citer les personnes ou les organisations qui ont apporté leur contribution aux ressources.

Saisie de la description d'un outil

La page Description d'un outil utilise également un modèle standard fourni par ArcGIS, dont la structure est similaire à celle de la page de référence d'un outil système. Cette page est au départ vide et n'affiche que le contenu par défaut (nom de l'outil, nom des paramètres et type de données des paramètres, par exemple). Suivez les conseils indiqués dans la partie inférieure de l'éditeur pour remplir les informations pertinentes dans les zones ci-dessous :

• Titre : vous pouvez saisir un autre titre, plus descriptif par exemple, pour votre outil. Cet autre titre s'affiche dans la page Description d'élément.
• Miniature : vous pouvez rechercher un fichier image (.jpg ou .png, par exemple) qui illustre la fonction de l'outil.
  Remarque :

  L'image ne s'affiche que dans la description de l'élément et non dans l'aide du panneau latéral de l'outil.

• Balises : vous pouvez saisir des mots qui permettent d'identifier le sujet de votre outil dans le système.
• Résumé : vous pouvez résumer la fonction de l'outil.
• Utilisation : vous pouvez saisir un ou plusieurs conseils importants à l'attention des utilisateurs.
• Syntaxe : la syntaxe de l'outil définit les paramètres de l'outil et leur incidence sur les résultats de l'outil. Même si le nom et le type des paramètres sont automatiquement remplis dans la table, vous devez saisir les explications suivantes sur les paramètres :
  • L'explication Boîte de dialogue fait référence à un paramètre sur la boîte de dialogue de l'outil. Cette référence s'affiche dans le panneau latéral de la boîte de dialogue d'un outil lorsque vous cliquez sur Afficher l'aide >>.
  • L'explication Scripts fait référence au même paramètre dans les scripts. Cette référence s'affiche dans la page Description d'élément et dans la section Aide de la fenêtre Python.
  Pour la plupart des paramètres, l'explication de la boîte de dialogue et l'explication des scripts sont les mêmes. Mais vous pouvez être amené à les expliquer différemment pour certains paramètres, comme une case à cocher dans une boîte de dialogue (un booléen avec des mots-clés dans des scripts) ou un champ à plusieurs entrées dans la boîte de dialogue (paramètre à valeurs multiples dans des scripts), en indiquant l'interaction de l'utilisateur avec les contrôles de la boîte de dialogue et en spécifiant des mots-clés ou des valeurs dans les scripts.
• Exemples de code : vous pouvez donner des exemples de code Python qui illustrent l'utilisation de votre outil dans la fenêtre Python et dans un script autonome. Pour chaque exemple, vous pouvez indiquer un titre, une description de l'exemple et le code Python.
• Crédits : vous pouvez citer les personnes ou les organisations qui ont apporté leur contribution à la conception et à l'implémentation de l'outil.

Utilisation de la description de l'élément dans une recherche

La documentation que vous indiquez dans Description d'élément est utilisée par la fenêtre Rechercher pour rechercher votre outil. Lors de la prochaine indexation de vos outils par la fenêtre Rechercher, leur résumé et leurs mots-clés seront analysés et ajoutés à l'index de recherche.

Pour en savoir plus sur la recherche et l'indexation dans ArcGIS