Anexo A: Ayuda en línea personalizada

4D permite asociar un archivo de ayuda en línea personalizado a cada una de sus bases. 

El sistema de ayuda en línea personalizado de 4D es compatible con todos los entornos 4D (base monopuesto o cliente-servidor, interpretada o compilada, ejecutada con 4D Desktop Interpreted, o integrado con 4D Desktop Volume, etc.).

4D soporta dos formatos de archivos de ayuda: CHM y HTML. Estos formatos corresponden a los estándares de la industria informática.

Además, puede asociar una sección específica de este archivo de ayuda a cada formulario de la base, lo cual le permite ofrecer una ayuda contextual en línea.

Debe utilizar uno de los siguientes formatos:

• Formato HTML compilado (extensión “.CHM”): formato estándar de ayuda en línea para Windows. Los archivos CHM son abiertos por la aplicación Microsoft® HTML Help Executable (HH.EXE), integrada al sistema operativo. Estos archivos son compatibles con Windows XP y Windows Vista.
  Microsoft® ofrece gratuitamente la aplicación HTML Help Workshop, necesaria para la preparación y compilación de los archivos .CHM.
• Formato HTML (extensión “.HTM” ): este es el formato HTML. Con este formato puede crear una ayuda en línea idéntica para todas las plataformas. La ayuda en línea se muestra en un navegador web.

Una vez generado el archivo Ayuda, debe asociarlo a una base de manera que se abra cuando los usuarios llamen la ayuda en línea (ver Llamar la ayuda en línea desde una base) Para asignar un archivo de ayuda a una base, asegúrese de que:

• El nombre del archivo de ayuda sea idéntico al del archivo de estructura de la base. Obligatoriamente debe tener la extensión “.CHM” o “.HTM”, dependiendo de su formato y plataforma. 
• El archivo de ayuda esté ubicado junto al archivo de estructura o en la carpeta Resources ubicada en el mismo nivel del archivo de estructura de la base.

4D Server: si quiere que la ayuda sea accesible a todos los equipos clientes, ubique el archivo en la carpeta Resources. Entonces será transferido automáticamente a las estaciones de trabajo de los clientes.

Los plug-ins pueden tener un archivo de ayuda, el cual debe ubicarse en la carpeta PlugIns tanto en aplicaciones monopuesto como en cliente/servidor. El archivo de ayuda de un plug-in debe tener el mismo nombre del plug-in con la extensión .CHM o .HTM. Par los plug-ins propuestos en forma de carpeta, el archivo ayuda debe ubicarse:
- junto al ejecutable del plug-in, en /Contents/MacOS o /Contents/Windows
- o en la carpeta /Contents/Resources del plug-in.

Los componentes pueden igualmente incluir un archivo de ayuda personalizado, ubicado junto al archivo de estructura del componente. Para mayor información, consulte Ayuda en línea para componentes.

La creación de ayuda en línea contextual se realiza asociando un número de sección con cada uno de sus formularios. Cuando llama la ayuda en línea desde un formulario, se muestra la página de ayuda correspondiente. Cuando el usuario llama la ayuda en línea, se muestra el tema de ayuda que tiene el mismo ID que el formulario.

La ayuda en línea contextual está disponible:

• bajo Windows, si la ayuda en línea está en formato CHM.
• bajo Windows y Mac OS, si la ayuda en línea está en formato HTML.

La asignación de un número de identificación a un formulario se efectúa en las propiedades del formulario, para mayor información, consulte la sección Ayuda.

Una vez haya asignado el número de identificación para el formulario, necesita asignar el mismo número de identificación al archivo ayuda. Esta operación varía de acuerdo al formato que está utilizando:

• Para los archivos CHM, consulte la documentación de la aplicación HTML Help Workshop.
• Para los archivos HTML, debe declarar cada sección con la ayuda de un ancla y asignarle un número.
  Una sección se declara utilizando un marcador de tipo:
  

  <A NAME="Section">

  
  Por ejemplo:
  

   <A NAME="21">

  
  El URL de la sección es de esta forma:
  

  <A HREF="#Section">...</A>

  
  Por ejemplo:
  

  <A HREF="#21">...</A>

Si el número de sección pasado al formulario es 0 o si no existe en el archivo, 4D muestra la primera página del archivo de ayuda.

En 4D, puede llamar una ayuda en línea personalizada de una base de datos de dos formas:

• Eligiendo Ayuda de NombreBase en el menú Ayuda. En este caso, se muestra la primera página del archivo ayuda.
• presionando la tecla F1 (Mac OS y Windows) o la tecla Help (Mac OS únicamente) cuando se muestra un formulario en modo Aplicación. En este caso, si un número de ayuda ya ha sido asociado al formulario, se muestra la página correspondiente (ayuda contextual); de lo contrario se muestra la primera página del archivo ayuda.

Nota: bajo Mac OS, el funcionamiento de la tecla F1 puede personalizarse. En modo Aplicación, cuando el usuario presiona la tecla F1:

• si un archivo “NomBase.HTM” existe junto al archivo de estructura de la base, se implementa el mecanismo estándar de gestión de ayudas en línea de 4D. El archivo de ayuda se abre en una ventana del navegador por defecto.
• De lo contrario, 4D no hace nada y el desarrollador debe procesar el evento como quiera. Esto permite configurar sistemas de ayuda totalmente personalizados o asignar otra función a la tecla F1.