Structure de la documentation relative aux outils
L'illustration suivante représente le système d'aide accessible sur l'ordinateur de bureau avec la table des matières développée sur le jeu d'outils Proximité dans la boîte à outils Analyse. L'illustration montre la structure de la table des matières commune à toutes les boîtes à outils.
- Chaque boîte à outils est associée à une vue d'ensemble décrivant la finalité de la boîte à outils. Cette vue d'ensemble comprend également un tableau répertoriant en hyperlien tous les jeux d'outils contenus dans la boîte à outils pour accéder à leur présentation respective. Vous trouverez également une section avec des liens vers des thèmes connexes susceptibles de vous intéresser.
- Chaque boîte à outils est accompagnée d'une rubrique sur les licences qui reprend toutes les informations de licence sur chaque outil de la boîte à outils.
- Chaque jeu d'outils est également associé à une page de présentation générale, dont la structure s'apparente à celle de la page de présentation générale de la boîte à outils. Le principe d'organisation du jeu d'outils est résumé dans la page de présentation générale du jeu d'outils.
- Après la présentation générale du jeu d'outils, vous trouverez des pages de référence spécifiques de l'outil pour chaque outil du jeu d'outils. Pour plus d'informations sur ces pages de référence, reportez-vous aux sections abordées plus loin dans ce chapitre.
- Enfin, vous trouverez parfois un livre sur les concepts du jeu d'outils. Les rubriques de ce livre contiennent des informations détaillées sur les outils du jeu d'outils.
Documentation et licences
- La documentation accessible sur votre poste contient des rubriques pour tous les outils indépendamment de vos licences. Par exemple, la boîte à outils Network Analyst est toujours installée bien que nécessitant une licence d'extension ArcGIS Network Analyst. On peut également citer comme autre exemple celui de l'outil Identité qui se trouve dans la boîte à outils Analyse. Cet outil nécessite une licence ArcGIS Desktop Advanced mais, vous pouvez accéder à sa documentation si vous avez une licence ArcGIS Desktop Basic.
- Les informations de licence relatives aux outils se trouvent en bas de la page de référence de chaque outil. En outre, chaque boîte à outils contient une rubrique sur les informations de licence répertoriant tous les besoins en la matière pour chaque outil.
- La documentation relative aux outils n'est pas installée pour les produits distincts. Par exemple, la documentation de la boîte à outils Couverture n'est pas installée à moins que vous installiez ArcInfo Workstation.
Page de référence de l'outil
Toutes les pages de référence des outils utilisent la même mise en page, décrite ci-dessous.
| Section | Table des matières |
|---|---|
Résumé | Résumé succinct des fonctions de l'outil. Ce résumé peut contenir un lien vers un autre thème contenant une description plus approfondie du fonctionnement de l'outil. |
Illustration | Illustration facultative qui aide à comprendre les fonctions de l'outil. |
Utilisation | Remarques et éclaircissements à propos de l'utilisation de l'outil. Lorsque les remarques font référence à un paramètre particulier, l'étiquette du paramètre (ce qui apparaît sur la boîte de dialogue de l'outil) est utilisée plutôt que le nom du paramètre (ce qui apparaît dans la syntaxe). En général, la correspondance entre l'étiquette et le nom du paramètre est évidente, mais dans certains cas, le nom du paramètre est indiqué pour éviter toute confusion. |
Syntaxe | Syntaxe exacte pour exécuter l'outil dans un script. Vous trouverez à sa suite, un tableau répertoriant tous les paramètres avec leurs noms, des explications et les types de données (valeur). Pour des informations détaillées, reportez-vous au chapitre Présentation de la syntaxe de l'outil. |
Exemple de code | Contient un ou plusieurs exemples de code Python utilisant l'outil. |
Environnements | Voici une liste des paramètres d'environnement que l'outil respecte. Chaque environnement propose un lien vers la page de référence des paramètres d'environnement. Si l'environnement revêt une importance particulière pour l'outil, vous trouverez probablement des informations supplémentaires à propos de l'environnement. |
Rubriques connexes | Liste de thèmes connexes, qui comprend toujours la page de la présentation générale du jeu d'outils. |
|
Informations de licence |
Licences requises pour utiliser l'outil. |