Visualización de la ayuda desde la interfaz

[imendez]

Hola, solicito que se pueda consultar la documentación de ayuda desde la interfaz.
Supongo que de momento lo más sencillo será redireccionar a la página de la wiki que contenga la ayuda solicitada, pero esto requiere tener conexión a internet, por lo que en el futuro sería deseable tener un formato de ayuda off line.
También sería conveniente que no se redireccione al índice general de la ayuda, porque muchas veces el usuario no sabrá llegar a la página adecuada. Por eso, debería implementarse un "buscador" que guíe al usuario para encontrar el tema de ayuda que más se parezca a lo que esté buscando.

Un saludo.

[Pedro Gea]

(In [2758]) Se introduce un primer texto de ayuda.
Refs #671

[livanr68]

(In [2767]) refs #671
Bibliotecas necesarias para mostrar la ayuda en la interfaz de MMS en un formato de texto enriquecido que permite entre otras cosas hipervínculos.

[livanr68]

(In [2768]) refs #671
Se implementa una ventana que muestra Información para los objetos de MMS, hasta ahora para DataSets y Variables.
Esta ventana mostrará también una Ayuda para las clases de MMS, hasta ahora disponible sólo para los DataSets.
La Información se muestra cuando se selecciona un objeto y la Ayuda de la clase cuando se selecciona un contenedor de objetos en el árbol explorador de la interfaz.
En la ventana de Ayuda aparecen hipervínculos a páginas de la wiki de MMS.
En la descripción de los objetos el usuario puede poner también hipervínculos a páginas con información propia del proyecto.
El texto de la descripción puede ser enriquecido utilizando las capacidades de la ventana de Información.

[josp]

(In [2773]) refs #671, el ejecutable de linux debe tener el flag executable activado

[josp]

(In [2774]) refs #671, si la expansión de las macros resulta en error, este error se muestra en la ventana de forma que podamos depurarlo. Cuando esta característica se vaya a subir al paquete debemos establecerla a:

PageExpander errmode macro

mmswiki debe ser un procedimiento o alias global, ejemplo de mmswiki

[@ mmswiki "MMS Howto's" howto @]

[livanr68]

(In [2786]) refs #671
Se implementan las funciones que permitirán mostrar la ayuda para todas las clases de MMS que la tengan definida.
De momento el contenido de la ventana de Ayuda será borrado al seleccionar un contenedor en el árbol explorador de MMS correspondiente a una clase para la cual no se haya definida aún la ayuda.

[livanr68]

(In [2799]) refs #671
Se define la ayuda para varias clases de MMS.
Se culmina la implemantación de las funciones que permiten mostrar la ayuda para todas las clases de MMS que la tengan definida.
El contenido de la ventana de Ayuda será borrado al seleccionar un contenedor en el árbol explorador de MMS correspondiente a una clase para la cual no se haya definida aún la ayuda.

[livanr68]

Tareas pendientes para cerrar este ticket:

• Terminar de definir el atributo _.autodoc.help para algunas clases de MMS.
• Escribir el texto de ayuda para los contenedores del árbol explorador de MMS que no se corresponden con clases de MMS, por ejemplo para las Conexiones, ver función GetConnectionHelp en el fichero ...\MMS\mms\trunk\MMS\gui\layer_gui\00_guiMMS\layer_gui_MMS_connection.tol.
• Resolver el problema de mostrar las imágenes de los íconos de las clases que están en la carpeta "images".
• Cambiar el tipo y tamaño de la letra con que se muestra la ayuda.
• Mostrar una ayuda sobre las posibilidades que hay para escribir estos textos.
• Lo referente a la información de los objetos se tratará en otro ticket.

[livanr68]

(In [2826]) refs #671
refs #817

[Pedro Gea]

Las tareas pendientes se resolverán más adelante. Se desplaza a un hito posterior ya que no se disponen de los recursos necesarios para afrontarlo.

[josp]

(In [2969]) refs #671, se corrige un error de carga cuando los archivos están localizados en una ruta que contiene espacios en el nombre.