Un recorrido rápido por la documentación de herramientas y cajas de herramientas

Para documentar una herramienta o caja de herramientas, edite la página Descripción como se describe a continuación.

Nota:

Los grupos de herramientas no tienen una descripción del elemento y no es posible incluir documentación en los mismos.

Editar una página Descripción

Hay diferentes formas de acceder a la página Descripción de una herramienta o caja de herramientas.

En la ventana Catálogo o en ArcCatalog

• Haga clic con el botón derecho del ratón en una herramienta o caja de herramientas y haga clic en Descripción del elemento. Esto abrirá la ventana Descripción del elemento, que muestra la página Descripción.
• Haga clic en el botón Editar .

En la ventana Buscar

Cuando se encuentra una herramienta o caja de herramientas en la búsqueda de la ventana Buscar, como se describe en Rápido recorrido para buscar las herramientas, puede llevar a cabo una de las siguientes acciones para acceder a su página Descripción:

• desplace el ratón sobre la herramienta o caja de herramientas; aparecerá una ventana emergente con un vínculo a Descripción del elemento, en parte inferior. Haga clic en ese vínculo para abrir la ventana Descripción del elemento y luego haga clic en el botón Editar .
• Haga clic en la línea de resumen de la herramienta o caja de herramientas que hay debajo del nombre para abrir la ventanaDescripción del elemento y luego haga clic en el botón Editar .

Introducir una descripción de la caja de herramientas

La página de descripción de una caja de herramientas utiliza una plantilla estándar proporcionada por ArcGIS. La principio la página está vacía y muestra sólo el contenido por defecto, como el nombre de la caja de herramientas y los conjuntos de herramientas. Necesita rellenar la información relevante siguiendo los consejos proporcionados en la parte inferior del editor, en estas áreas:

• Título: puede escribir un título diferente y quizás más descriptivo para su caja de herramientas. Este título alternativo se mostrará en la página Descripción.
• Miniatura: puede acceder a un archivo de imagen (como un .jpg o un .png) que ilustre los que contiene la caja de herramientas.
• Etiquetas: puede introducir palabras para identificar el tema o el contenido de su caja de herramientas en el sistema.
• Resumen: puede escribir un breve resumen que describa el contenido de la caja de herramientas.
• Descripción: puede escribir una explicación más detallada de la caja de herramientas.
• Créditos: puede reconocer la labor de personas u organizaciones que hayan contribuido al recurso.

Introducir la descripción de la herramienta

La página Descripción de una herramienta usa también una plantilla estándar proporcionada por ArcGIS, que se estructura de la misma manera que una página de referencia del sistema. Al principio la página está vacía y muestra sólo el contenido por defecto, como el nombre de la herramienta, los nombres de parámetros y los tipos de datos de parámetros. Necesita rellenar la información relevante siguiendo los consejos proporcionados en la parte inferior del editor, en estas áreas:

• Título: puede escribir un título diferente y quizás más descriptivo para su herramienta. Este título alternativo se mostrará en la página Descripción del elemento.
• Miniatura: puede acceder a un archivo de imagen (como un .jpg o un .png) que ilustre lo que hace la herramienta.
  Nota:

  La imagen sólo se muestra en la descripción del elemento, no en la ayuda del panel lateral de la herramienta.

• Etiquetas: puede introducir palabras para identificar el tema de la herramienta en el sistema.
• Resumen: puede redactar un corto resumen que describa lo que hace la herramienta.
• Uso: Puede introducir uno o más consejos que sean importantes para los usuarios.
• Sintaxis: la herramienta de sintaxis define los parámetros de la herramienta y como afectan a los resultados de ésta. Aunque los nombres y tipos de parámetros se rellenan automáticamente en la tabla, deberá introducir estas explicaciones de los mismos:
  • Explicación del cuadro de diálogo es la referencia para un parámetro en el cuadro de diálogo Herramienta. Esta referencia se muestra en el panel lateral de los cuadros de diálogo de herramienta cuando hace clic en Mostrar Ayuda >>.
  • Explicación de secuencia de comandos es la referencia para el mismo parámetro usado en la secuencia de comandos. Esta referencia se muestra en la página Descripción del elemento y en la sección Ayuda de la ventana Python.
  Para la mayoría de los parámetros, la explicación del cuadro de diálogo y la explicación de secuencia de comandos es la misma. Pero en otros, como una casilla de verificación de un cuadro de diálogo (un booleano con palabras clave en la secuencia de comandos) o un campo de varias entradas (un valor de varios parámetros en la secuencia de comandos), es posible que necesite una explicación diferente que indique la forma de interactuar con los controles del cuadro de diálogo y que especifique palabras clave o valores en la secuencia de comandos.
• Muestras de código: puede proporcionar ejemplos de código de Python que muestren cómo se usa su herramienta en la ventana Python y cómo en una secuencia de comandos independiente. Para cada ejemplo puede proporcionar un título, una descripción del ejemplo, y el código de Python.
• Créditos: puede reconocer la labor de personas u organizaciones que hayan contribuido al diseño o realización de la herramienta.

La descripción del elemento se utiliza en la búsqueda

La documentación que proporcione en Descripción del elemento se utiliza en la ventana Buscar para buscar su herramienta. La próxima vez que Buscar indexe sus herramientas, analizará sintácticamente el resumen y las palabras clave y las añadirá al índice de búsqueda.

Más información acerca de la búsqueda y la indexación de ArcGIS