Ayuda contextual

Cada algoritmo de Sextante tiene su correspondiente ayuda contextual, con objeto de que todo usuario pueda extraer de cada módulo el mayor provecho posible. Para ver la ayuda contextual de una extensión, debe hacerse clic en el botón de ayuda que se encuentra en la parte inferior de la ventana de ejecución del algoritmo.

images/es/ayuda_context.png

Situación del icono de ayuda contextual.

Fundamentalmente, se describe lo que hace el algoritmo, los parámetros de entrada que se necesitan y la salida de información geográfica, alfanumérica o textos y gráficas que éste genera. Pero la ventana de ayuda contextual no sólo contiene información de cada algoritmo, sino también de cada elemento de la interfaz gráfica de usuario de Sextante. Se puede ver esta información en la parte superior izquierda del árbol de navegación.

images/es/ayuda1.png

Situación de la ayuda.

Los ficheros de ayuda asociados a cada algoritmo son almacenados como ficheros XML y pueden ser editados usando el gestor de ayuda contextual. Para ello, haz clic con el botón derecho en el nombre del algoritmo en la ventana de la ayuda contextual y selecciona la opción Editar ayuda.

La ventana de edición de ayuda está estructurada en dos paneles. En el panel de la izquierda encontramos una lista con todos los parámetros necesarios para documentar una determinada extensión: información, parámetros de entrada y salidas que genera la extensión. En el panel de la derecha podemos escribir el contenido de la ayuda contextual y añadir imágenes si se considera oportuno.