Inicio | Donaciones | Contacto
Generalidades Implantación Interfaz SAF CEF REF SOF Anexos
 
- Introducción
- Administración
- Registros
- Reportes

Motores del proyecto Forseti











Documentación de Ayuda

Este módulo está enfocado a empresas que desean modificar el sistema forseti. Por ejemplo, una empresa podría obtener el código fuente y desarrollar un módulo extra para sus propias necesidades. Puede utilizar el módulo de Documentación de ayuda para documentar su nuevo módulo y así servirle de soporte a sus usuarios.

Antes de poder interactuar con la documentación, hay que dar de alta toda la estructura de ésta a nivel local, para que entonces, podamos empezar a modificarla. La clase JAyu se encarga de generar la documentación del sistema a nivel local. Esto es importante porque para accesar a la documentación del SAF o CEF, en cualquier instalación por defecto, el usuario final solo lo puede hacer través de la  página web forseti.org.mx. Al correr el proceso del servicio JAyu, la documentación de tu sistema se guardará en la base  de datos y entonces podrá ser accesada localmente. Para poder preparar el sistema para modificar la documentación de ayuda será necesario ingresar al código fuente de la clase JAyu y seguir las instrucciones que en ella se indican. La clase JAyu se encuentra dentro del paquete por defecto del código fuente del proyecto forseti.

El módulo de "Documentación de ayuda" involucra tres submódulos que son:

  1. "Menús principales"
  2. "Menús secundarios"
  3. "Páginas de ayuda".

Para entender como se relacionan estos submódulos entre si, podemos ver que dentro de la documentación general los menús principales engloban a Generalidades, Implantación, Interfaz, SAF, CEF, SOF y Anexos. Dentro de cada uno de ellos, por ejemplo al hacer click en SAF, aparecerán del lado izquierdo Introducción, Administración, Registros y Reportes. Estos son menús secundarios del menú principal SAF. Al presionar un menú secundario como Registros, aparecerán del lado derecho las páginas de ayuda pertenecientes a Registros del SAF.

Antes de ver como agregar páginas de ayuda, debemos entender cómo se generan. Para esto, forseti utiliza una plantilla llamada "forseti_doc.html" que se encuentra dentro del directorio forseti_doc y este a su vez dentro del directorio bin de nuestra instalación. Esta plantilla indica al sistema la posición de los elementos del menú principal, de los menús secundarios, de las páginas de ayuda y de las páginas asociadas a esta página. Entonces el sistema genera las páginas con la información de la ayuda que está contenida en la base de datos principal FORSETI_ADMIN poniéndoles el nombre de su clave, por ejemplo 010202.html si la clave de la página de ayuda es 010202. Es esta misma clave la que utiliza el sistema para generar las referencias de los menús principales, secundarios y páginas ligadas a sus respectivas páginas de ayuda. NOTA: La generación de toda esta ayuda se hace página por página a través de código html sin involucrar frames ni mucho menos iframes.


 
Páginas en este tema:
- Servidor y Empresas
Detalles del módulo administrativo del servidor y sus empresas
- Documentación de Ayuda
Introducción del módulo de la documentación de ayuda para el sistema Forseti
- Menús principales
Detalles del móudolo de menús principales para la documentación de ayuda
- Menús secundarios
Detalles del móudolo de menús secundarios para la documentación de ayuda
- Páginas de Ayuda
Detalles del móudolo de páginas de ayuda
- Control SSL
Módulo del control de certificados digitales utilizados en el servicio tomcat
- Administración de Roles
Módulo para la gestón de roles de usuarios y sus permisos dentro del SAF
Positive SSL
Licencia Pública General de Affero (AGPL) | Sobre Forseti
Derechos Reservados © 2014 - 2015 Organización Forseti A.C.