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.
- Cada caja de herramientas tiene un tema de información general que describe su propósito. Esta información general también tiene una tabla de todos los conjuntos de herramientas que están dentro de la caja de herramientas con vínculos a temas generales de cada conjunto de herramientas. Además, hay una sección que contiene vínculos a temas relacionados que pueden ser de su interés.
- Cada caja de herramientas tiene un tema sobre licencias que brinda información acerca de las licencias necesarias para cada herramienta de la caja de herramientas.
- Cada conjunto de herramientas tiene también una página de información general, estructurada de manera similar a la de la caja de herramientas. El principio de organización del conjunto de herramientas está resumido en la página de información general.
- Después de la información general del conjunto de herramientas se encuentran las páginas de referencia de las herramientas individuales del conjunto de herramientas. Consulte a continuación para obtener más información sobre la página de referencia de las herramientas.
- Finalmente, puede haber disponible un libro de conceptos de conjuntos de herramientas. Los temas de los libros de conceptos contienen información detallada sobre las herramientas del conjunto de herramientas.
Documentación y licencias
- La documentación de escritorio instalada contiene temas para todas las herramientas, independientemente de las licencias que tenga. Por ejemplo, la caja de herramientas de ArcGIS Network Analyst siempre se instala aunque requiera una licencia de extensión para ArcGIS Network Analyst. Otro ejemplo es la herramienta Identidad que se encuentra en la caja de herramientas Análisis: requiere una licencia de ArcGIS Desktop Advanced, pero la documentación se instala si tiene una licencia de ArcGIS Desktop Basic.
- Las licencias para las herramientas se pueden encontrar al final de la página de referencia de cada herramienta. Además, cada caja de herramientas contiene un tema que enumera los requisitos de licencia de cada herramienta.
- La documentación sobre herramientas no se instala para los productos individuales. Por ejemplo, la documentación de la caja de herramientas Cobertura no se instala a menos que instale ArcInfo Workstation.
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. Va seguida de una tabla en la que se muestra una lista de todos los parámetros con sus nombres, explicaciones y 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. |