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

Motores del proyecto Forseti











Páginas de Ayuda
Los paneles izquierdo, inferior y derecho de este módulo aparecen vacíos porque no se utilizan.

Las columnas por defecto que muestra el panel de cuerpo principal de este módulo son las siguientes:

  • Clave. Es la clave de la página de ayuda.
  • Descripción. Es la descripción de la página.
  • Detalle. Son los comentarios anexos a esta página.
  • Aplicación. La forma de aplicar índices de esta página al generar la ayuda (DES, FIN, REV y SREV).
  • Tipo. El tipo de página a generar (Simple o Completa)
  • Clave2. Es una clave alternativa opcional.

Procesos de las Páginas de Ayuda

Agregar elemento.

Permite dar de alta una nueva página de ayuda. Esta página se anexará al submenú derecho durante la generación, solo en las páginas de ayuda que tengan referencia al mismo menú secundario, y si ésta página es una página de tipo "COMPLETA". Las páginas se irán agregando según su orden ascendente en la clave y nunca según su orden por descripción.

El formulario para Agregar una nueva página posee los siguientes objetos:

  • Clave. Indica aquí la clave que tendrá la página.
  • Descripción. Una descripción general muy breve la cual aparecerá en el menú derecho para distinguir esta página.
  • Detalle. Una descripción más detallada de esta página. Esta aprecerá justamente debajo de la descripción general.
  • Tipo. Es el tipo de página que se desea agregar. Esta pueden ser páginas "SENCILLAS" o "COMPLETAS". Las páginas sencillas no se anexan a la estructura de la ayuda durante la generación, éstas se deben enlazar manualmente desde alguna página mediante atributos "href" utilizando la clave de la página como nombre, mas la extensión html, por ejemplo ( href="pagsencilla01.html" ). Las páginas sencillas se utilizan por ejemplo en situaciones donde es preferible mostrar ayuda contextual eliminándola de la ayuda general.
  • Clave 2. Es la clave alternativa de la página. Esta se utiliza para cargar la página de ayuda desde el módulo en la interfaz del SAF o CEF. Esta clave debe ser igual al ID de Módulo asignado ya que el mecanismo interno así lo controla.
  • Menús para esta página: En esta sección se muestra la estructura de menús y se selecciona a cual va a pertenecer esta página. Una página se puede asociar a N cantidad de menús secundarios y aparecerá en cada uno de ellos. NOTA: Aunque las páginas sencillas no forman parte de la estructura, por razones de integridad de bases de datos, éstas aún deben asociarse a algún elemento de menú secundario.

Cambiar elemento.

Permite cambiar la clave, descripción, detalle, tipo, clave2 o menús asociados de la página de ayuda seleccionada de la lista.

Editar página.

Permite gestionar el cuerpo de la página de ayuda seleccionada de la lista. La edición se genera a través de un WYSIWYG. Este es el acrónimo de What You See Is What You Get (en español, "lo que ves es lo que obtienes"). En este caso se aplica para permitir escribir la página sobre una vista preliminar similar a la de un procesador de textos, generando automáticamente el código fuente en HTML.

Enlazar páginas.

Permite enlazar la página seleccionada de la lista a cualquier otra página de la ayuda. Estos enlaces aparecerán en la parte inferior de la página como una lista ordenada por clave. Por este método, se puede enlazar a páginas tanto completas como sencillas. NOTA: En caso de enlazar hacia una página sencilla, al accesar a esta, se perderá la estructura y será necesario regresar a la página por medio del botón "Regresar" del navegador.

Subir imagen.

Permite cargar una imagen al servidor. Los formatos que soporta son jpg, gif y png. Al subir una imagen al servidor, esta se guarda en dos lugares distintos: el directorio IMG que se encuentra dentro del directorio forseti_doc y este a su vez dentro del directorio bin de nuestra instalación, y en el directorio forsetidoc de nuestra aplicación web. Una vez que se haya cargado la imagen al servidor, ésta estará disponible para ser ligada en una página de ayuda a través del editor WYSIWYG, para ello, se debe enlazar con la URL de la siguiente manera: ../forsetidoc/nombre_imagen.jpg. Con esto, podremos ver nuestra imagen tanto en el editor WYSIWYG como en la página de ayuda final de nuestra documentación.

Aplicar índices.

Los índices le indican al sistema el comportamiento de la página de ayuda dentro de la estructura de toda la documentación. Este proceso permite cambiar el tipo del índice y se aplica al generar la ayuda:
  • DES, Este índice le indica al compilador que ésta página se utilizará como pagina inicial. A diferencia de las demás páginas, solo puede haber una página inicial. Esta página se nombrará como index.html en lugar de utilizar la clave y extensión html como nombre.
  • FIN, Este índice le indica al compilador que ésta página será la página ligada por defecto al presionar el menú principal. Por ejemplo, al presionar el menú principal SAF, la página 040101 - ¿ Que es el SAF ? aparece por defecto. En este caso, esta página está ligada al menú secundario Introducción que a su vez pertenece al menú principal SAF. Solo puede existir una página con este índice por cada menú principal.
  • REV, Este índice le indica al compilador que ésta página será la página ligada por defecto al presionar un menú secundario subsecuente. En el ejemplo anterior, el menú secundario Introducción del SAF ya tiene implícita su referencia por defecto porque Introducción es el primer menú secundario del SAF, sin embargo, los subsecuentes como Administración y Registros tendrán que referenciar su página por defecto a través de este índice.
  • SREV, Este índice le indica al compilador que la página solo debe aparecer en la estructura con el menú secundario en cuestión, pero sin ser la página por defecto.

NOTA: Los menús ignorarán las páginas SIMPLES cualquiera sea su índice y no se ligarán a ninguna de ellas.

Generar inicio y web.

Permite generar toda la documentación de ayuda la cual podrá ser accesada desde el navegador web a través de la URL del sitio bajo el directorio forsetidoc, o desde algún módulo del SAF o CEF hacia la página que su clave2 sea igual al ID de ese módulo. Suponiendo que nuestra instalación escucha en la nube bajo la dirección IP 54.244.97.221, se accesa a ella de la siguiente manera:

https://54.244.97.221/forsetidoc/index.html

Además de este sitio web, la generación de ayuda crea un archivo que contiene toda y absolutamente toda la información de la estructura de la documentación. Cuando nosotros decidimos adaptar a nuestras necesidades el servidor forseti, la documentación ya no podrá ser accesada desde el sitio oficial forseti.org.mx, sin embargo este archivo servirá para reproducir la documentación dentro de nuestro servidor ( en este caso el 54.244.97.221 ). Este archivo se usa para iniciar la base de datos de la ayuda oficial que servirá de base para el complemento de nuestros propios módulos de ayuda y así tener toda la documentación actualizada. El archivo de inicio se genera en la ruta /usr/local/forseti/bin/.forseti_doc

Eliminar elemento.

Permite eliminar la página de ayuda seleccionada de la lista. Esta página ya no se podrá recuperar.

 
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.