Estructura
%HRTABLE%
- STTA usa una biblioteca propia para gestionar la infraestructra de la Ayuda del módulo que evalua etiquetas y texto para devolver texto HTML:
- Los ficheros html del "directorio base (help)" no contienen "cadenas de texto localizadas", usan variables de texto o valores del entorno en base a al idioma configurado en Webmin.
- En algunos casos se "incluyen" otros ficheros para confeccionar la página, se incluyen secciones completas o se generarn valores de atributos de configuración del entorno.
- El valor de LANG (que figura entre % ) es sustituido por el del idioma Webmin(ej: es, en, etc)
- Todo el "texto localizado" en el idioma correspondiente, está en el subdirectorio LANG del "directorio base (help)" del módulo.
- El directorio dentro del módulo que contiene la ayuda es "help" que contiene:
- Ficheros html con la arquitectura básica del tema correspondiente:
- Carga de cabecera de página, etiqueta HTML "head".
- Bloques de cabecera de la página de página, etiqueta HTML "headimg" y "headertitle".
- "Include" de fichero LANG/head del tema. Texto de encabezado del tema.
- "Include" de fichero LANG/msg del tema. Recuadro con información general en modo resumen y detalles relevantes.
- "Include" de fichero LANG/body del tema. Texto con descripción y análisis detallado del tema.
- Carga de referecias cruzadas (caja ), etiqueta HTML "footlinks".
- Carga de pies y bloques de pie de la página, etiqueta HTML "foot".
- Directorios LANG del idioma correspondiente para ser "incluídos" por la arquitectura base de las páginas, con la estructura siguiente:
- Ficheros html de tipo general de la ayuda.
- LANG/head/tema. Texto de encabezado del tema.
- LANG/msg/tema. Recuadro con información general en modo resumen y detalles relevantes.
- LANG/body/tema. Texto con descripción y análisis detallado del tema.
- LANG/config/tema. Texto con detalles de la configuración de la sección.
Preguntas Frecuentes
%HRTABLE%
- ¿ Se puede desactivar la ayuda ?
Sí, coambiando el valor de la variable $infoCfg{help_active} (help_active) en
- ¿ Cómo se puede generar una estrucura de ayuda para otro idioma ?
Usando el script mklanghelp.sh desde el directorio del módulo de STTA (ver ).
- ¿ Sobre qué ficheros hay que modificar el texto o traducir a otro idioma ?
Sobre los ficheros del directorio help/LANG (ej: help/es para Español) y los ficheros LANG correspondientes al idioma del directorio "lang" del módulo, en especial el genérico y el del directorio "lang/help".
- ¿ Se pueden usar variables del entorno y valores de cadenas de texto ?
Sí, usando las siguietes expresiones entre < >, donde las palabras text, config e infoCfg van precedidas del signo $ :
- "exec text{nombre-de-la-variable}" es sustituído por el valor de la cadena de texto correspondiente.
- "exec config{nombre-de-la-variable}" es sustituído por el valor de la variable correspondiente.
- "infoCfg{nombre-del-parámetro}" (no hay que incluirlo entre <>) es sustituído por el valor de la cadena de texto del formulario de configuración correspondiente (ficheros "config.info.LANG).
- ¿ Cómo se puden usar los iconos de alerta en las páginas ?
Escribiendo los siguientes textos entre signos % :
- "W" muestra un %W%
- "I" muestra un %I%
- "H" muestra un %H%
- "N" muestra un %N%
- "S" muestra un %S%
- "U" muestra un %U%
- "P" muestra un %P%
- "OK" muestra un %OK%
- "INFO" muestra un %INFO%
- "AR" muestra un %AR%