Xailer 8.1 – Generador de ayudas

La nueva versión incorpora un completo generador de ayudas en formato HTML que permite crear las ayudas de cualquier aplicación de gestión de una forma muy sencilla y potente.

A partir de la versión 8.1 el control TForm (formulario) incluye una nueva propiedad de nombre XHtmlHelp. Cuando pulse sobre el botón de edición en el inspector de propiedades se le mostrará esta pantalla de edición HTML:

El ID se corresponde con el identificador de la página de ayuda para ese formulario y el título, es el texto que se mostrará en la parte superior de la pagina. Es obligatorio introducir algún ID, sin embargo, no es obligatorio el título. Si lo deja en blanco, simplemente esa página no tendrá título y el área que ocupa el título desaparecerá.

Por cada ayuda que usted cree, Xailer creará un archivo con el mismo nombre que el fuente, pero de extensión .XHH en el directorio ‘source‘ con el contenido HTML del documento recién creado, que incluye todas las imágenes que haya incorporado.

Nuestro sistema de control versiones XVC gestiona de forma automática la existencia de estos archivos y los incluye en el repositorio, sin que tenga que hacer nada más. Si utiliza SVN, deberá añadir los archivos de forma manual a través Tortoise SVN o por línea de comando.

Pulsando la opción de menú Proyecto->Ayudas del proyecto se nos mostrará el gestor de ayudas, que tiene el siguiente aspecto:

En el lado derecho se muestran inicialmente todas las ayudas asignadas a cada uno de los formularios y es su responsabilidad el moverlas al lado izquierdo para construir la tabla de contenidos. Una vez movida a la tabla de contenidos (lado izquierdo), podrá utilizar los botones de dirección para subir, bajar o cambiar su anidación de una forma sencilla. No es necesario que todas las páginas de ayuda que usted cree, aparezcan en la tabla de contenidos.

Observe que existe un botón con unos engranajes que permite compilar las ayudas en un único archivo de extensión .XHLP. Lógicamente, dicho archivo deberá incorporarse como un archivo más de la aplicación que desea distribuir o entregar a su cliente. Xailer crea con todas las ayudas un único archivo comprimido, con un formato propietario, sólo accesible a través de nuestro gestor de ayudas.

En el editor puede incluir todo el texto de se ayuda. Es posible incorporar imágenes, tablas, estilos de texto y enlaces a páginas Web o cualquier otra página de ayuda. Para esto último deberá utilizar como protocolo la palabra ‘help://‘. Por ejemplo si quisiese poner un enlace a la página ‘NuevoCliente’, escribiría el enlace como: ‘help://Nuevocliente‘. Eso es todo.

Para que todo nuestro sistema de ayudas funcione sólo hay que añadir una línea de código al inicio de nuestra aplicación que es:

oApplication:oHelp := THelp():New( "MiFichero.XHLP" )

Cuando el usuario pulse la tecla F1 en cualquier formulario, se le mostrará la ayuda de ese formulario en concreto. Por ejemplo:

Ya no hay escusas para hacer aplicaciones 100% profesionales. Espero que os haya gustado.

Un saludo

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *