Sistema
de Ayudas de SISINF
Explicación
1. Introducción
El Sistema de ayudas de SISINF le
permite integrar a su sistema explicaciones y ayudas que hacen mas fácil para
el usuario final la ejecución del sistema. También puede servirle para hacer la
documentación del mismo.
Se describe a continuación como
integrarlo a su sistema desde el punto de vista de programación, también se
vera como usar algunas opciones de este menú.
El primer paso es copiar los archivos IS*.SIS del directorio de documentación a donde estén su DBD y programas.
El segundo paso es integrar a la DBDSxx de su aplicación el archivo ISADBD.SIS el cual contiene las definiciones de archivo y áreas de trabajo necesarias. Para ello ponga &I ADBD en la DBDSxx.SIS
Luego en los programas de la aplicación PSxxyy.SIS debe también incluir
las rutinas de documentación poniendo &I APRO y si tiene variables tipo texto
pone &I ATXT
2. Primer
Nivel
El nivel mas sencillo de ayudas en sus programas
es poner en la definición de AREAS mediante OPCION TERMINAL una tecla de ayuda
con la opción de /TECLAS-DE-FUNCION y a continuación la tecla por ejemplo 1 ‘*Ayuda’
También poner la opción /AYUDA-GLOBAL DESPLEGAR-AYUDA-A
Con esto el usuario final podrá dar F1
y ver la ayuda que Usted teclee mediante el uso de la opción “Ayudas de
áreas” del menú para ayudas (programa PSDCF0). Al teclear la ayuda Usted
deberá de dar el número del área y las iniciales del programa, luego el texto
de dicha ayuda.
El principal trabajo es teclear el
texto, pero para hacerlo más sencillo Usted puede poner primero las
instrucciones en los programas, posteriormente ejecutando en forma simultanea
su sistema y este sistema de ayudas, recorrer su sistema y pedir ayuda. Si la
ayuda NO esta definida aparecerá un letrero indicándolo, junto con el número de área e iniciales de
programa, con esto Usted puede agregarlo a las ayudas.
Internamente el sistema de ayudas
dependiendo del tipo de área busca en “Ayudas programa u opciones” una
ayuda que se adiciona al final. Así para un área del tipo menú de letreros
busca la ayuda para ML que puede ser " Selecciones su opción y de RETORNO". Entonces esta leyenda se
adjunta a todas las ayudas de menú,
evitando tener que poner ciertas
redacciones en todas ellas. Si Usted
ejecuta “Listar y Buscar Ayudas” del
menú para ayudas PSDCF0, pone como directorio el del sistema de documentación,
selecciona programa, llaves y da ?? se desplegaran estos tipos de ayuda que
complementan las explicaciones. Usted puede copiarlas a sus ayudas con las
modificaciones necesarias.
3. Poner explicaciones
Un segundo nivel de ayudas consiste en
poner EXPLICACIONES (como esta) a las diferentes opciones de su sistema. Para
ello debe agregar la opción de Explicación
dentro del menú principal de cada programa, poner &I IMPR para incluir las rutinas y ejecutar
las siguientes instrucciones de SISINF para dar la explicación:
*
*
Explicación
*
NUM-AYUDA = …...
EJECUTA RUTINA DESPLEGAR-EXPLICACION
EJECUTA ...
En NUM-AYUDA deberá poner un número
entre 1 y 9999 y ejecutando “Ayuda
programas u opciones” del menú para
ayudas PSDCF0, agregar dando como datos dicho número incluyendo ceros a la izquierda
y el texto de la ayuda. Con esto sus programas tendrán explicaciones.
Nuevamente el principal trabajo es el
tecleo de las explicaciones, pero se
puede poner la lógica antes descrita y si todavía NO se tecla la ayuda aparecerá
un letrero indicándolo, junto con el número de la ayuda.
Si quita el comentario de OPCION IMPRIMIR /DESPLEGAR-ARCHIVO que esta al final de ISIMPR.SIS se puede desplegar la explicación, guardarla en un archivo y así
tener algo de la documentación del
sistema.
4. Nivel Avanzado
En las áreas de /RENGLON
y /COLUMNA muchas veces se desea dar una ayuda general y una ayuda
especifica para ciertas variables. Si se usa la rutina DESPLEGAR-AYUDA-AV se puede dar una ayuda general del
área (tal como ya se hizo) y dar ayudas
especificas para cada variable con la opción “Ayuda de variable” del menú para ayudas PSDCF0. Los datos son el
nombre de la variable , las iniciales del programa (si este dato se deja en
blanco se usa en todos los programas) y el texto de la ayuda.
El mismo caso se puede tener en las
áreas de /MENU de letreros en que se desea una ayuda
general y una ayuda de cada opción del menú. Para ello se pone DESPLEGAR-AYUDA-AO
y se da la ayuda del
área tal como ya se indico y luego con la opción “Ayuda programa u opciones” del menú para ayudas PSDCF0 se teclea la
ayuda. Se recomienda para este caso que
las opciones del menú se hagan de forma que no se tengan duplicados, Así la
opción de modificación puede ser 'MA1'
donde M es modificación y A1 las iniciales del programa. Cuando se definió el
letrero en la definición del área se tenia:
‘MA1’
‘Modificación’ $
Cuando se teclea la ayuda se dará como dato MA1 y el texto de la ayuda.
Por ultimo, en algunos menús, sobre
todo en el principal, solo se desea dar explicación del programa que se ejecuta
para ello usar la rutina DESPLEGAR-AYUDA-O y con “Ayuda
programa u opciones” teclear las de cada programa dando como dato las
iniciales del programa y el texto de la ayuda..
También para hacer la redacción de las
ayudas un poco mas amigable se pueden incluir en las mismas datos de la
ejecución del programa. Para ello poner en la ayuda "[AYUDA-DATO-1]" y en el programa mover un valor a la
variable AYUDA-DATO-1. Se tienen de
la 1 a 5.
5. Otras opciones del
sistema
Ø Se permite Agregar, Quitar, Modificar y
Consultar las ayudas registradas en los
diferentes archivos del sistema.
Ø Se puede copiar una ayuda a otra
modificándola. Lo anterior permite ahorrar trabajo con ayudas parecidas.
Ø Se tiene una opción para pasar una o
varias ayudas a un reporte para ser desplegadas y / o impresas.
Ø Se puede pasar una o varias ayudas al
temporal ASCII con nombre T802. Luego copiar a otro directorio de otro sistema
como T801 y agregarlas a las ayudas de dicho sistema.
Ø Se puede pasar todos los archivos de
ayudas a un temporal ASCII con nombre T801,
pasarlo a otra maquina y generar nuevamente los archivos con dicho temporal.
Ø La opción Listar y Buscar ayudas como
su nombre lo indica permite desplegar o imprimir información buscada en los
diferentes archivos. Así por ejemplo buscar todas las ayudas de un programa.