Un paseo introductorio por las referencias de las herramientas de geoprocesamiento

Estructura de la documentación de herramientas

La siguiente ilustración muestra el sistema de ayuda de escritorio con la tabla de contenido expandida en el Conjunto de herramientas de proximidad en la Caja de herramientas de análisis. La ilustración muestra la estructura de la tabla de contenido compartida por todas las cajas de herramientas.

Caja de herramientas, conjunto de herramientas y documentación sobre herramientas en el sistema de ayuda

Ayuda instalada (en escritorio) y ayuda on-line (Web)

Cuando instala ArcGIS for Desktop, se instala toda la documentación en su equipo. Puede encontrar una copia de esta documentación en la web en http://webhelp.esri.com. La Ayuda de ArcGIS for Desktop instalada es en un principio una copia exacta del sistema de ayuda Web. Sin embargo, la ayuda Web se actualiza periódicamente y puede contener más información que la ayuda instalada de escritorio.

Documentación y licencias

Página de referencia de herramientas

Todas las páginas de referencia de herramientas tienen el mismo diseño que se describe a continuación.

Sección

Índice

Resumen

Breve resumen de la función de la herramienta. Este resumen puede tener un vínculo a otro tema que contenga una discusión detallada del funcionamiento de la herramienta.

Ilustración

Ilustración opcional que ayuda a explicar el funcionamiento de la herramienta.

Uso

Notas y aclaraciones sobre el uso de la herramienta. Cuando las notas se refieren a un parámetro en particular, se utiliza la etiqueta del parámetro (que aparece en el cuadro de diálogo de la herramienta) en lugar del nombre del parámetro (que aparece en la sintaxis). La correspondencia entre la etiqueta y el nombre del parámetro generalmente es obvia, pero en algunos casos, se aclarará el nombre del parámetro para evitar confusiones.

Sintaxis

Sintaxis exacta para ejecutar la herramienta en una secuencia de comandos. Está seguida de una tabla que enumera todos los parámetros con sus nombres, las explicaciones y los tipos de datos (valores). Para obtener más detalles, consulte Entender la sintaxis de la herramienta.

Muestra de código

Contiene una o más muestras de códigos de Python que utilizan esta herramienta.

Entornos

Esta es una lista de la configuración del entorno que distingue la herramienta. Cada entorno está vinculado a la página de referencia de configuración del entorno. Si el entorno es de especial importancia para la herramienta, puede haber más información sobre el mismo.

Temas relacionados

Lista de temas relacionados, que incluye siempre la página de información general del conjunto de herramientas.

Información sobre licencias

Licencias requeridas para la utilización de la herramienta.

Temas relacionados

9/11/2013