Annexe A : Aide en ligne personnalisée

4D vous permet d’associer un fichier d’aide en ligne personnalisée à chacune de vos bases, afin de fournir aux utilisateurs des informations supplémentaires sur le fonctionnement de votre application. 

Le système d’aide en ligne personnalisée de 4D est compatible avec tous les environnements 4D (base monoposte ou client/serveur, interprétée ou compilée, exécutée avec 4D Desktop Interpreted, intégrée avec 4D Desktop Volume...).

4D accepte deux formats de fichiers d’aide : CHM et HTML. Ces formats correspondent aux standards de l’industrie informatique.

En outre, vous pouvez associer une page spécifique du fichier d’aide à chaque formulaire de la base, ce qui vous permet de fournir une aide en ligne contextuelle.

Le fichier d’aide en ligne de votre application peut être fourni dans l’un des formats suivants :

• Format HTML compilé (extension “.CHM”) : il s’agit du format standard des aides en ligne pour Windows. Les fichiers CHM sont ouverts par l’application Microsoft® HTML Help Executable (HH.EXE), intégrée au système d’exploitation. Ces fichiers sont compatibles Windows XP et Windows Vista.
  Microsoft® fournit gratuitement l’application HTML Help Workshop, nécessaire à la préparation et la compilation des fichiers .CHM.
• Format HTML (extension “.HTM”) : ce format est utilisé par tous les navigateurs Web. L’utilisation d’un tel format permet de créer une aide en ligne identique sur toutes les plates-formes. L’aide en ligne est alors affichée dans un navigateur Web.

Une fois votre fichier d’aide en ligne généré, vous pouvez l’associer à une base de manière à ce qu’il soit automatiquement appelé si l’utilisateur sollicite l’aide en ligne (cf. ci-dessous le paragraphe Appeler l’aide en ligne depuis une base 4D) pendant qu’il travaille dans la base. Pour cela :

• Le nom du fichier d’aide doit être identique à celui du fichier de structure de la base. Il doit impérativement porter soit l’extension “.CHM”, soit “.HTM” (suivant son format). Par exemple, si le fichier de structure de la base s’appelle “Facturation.4DB”, le fichier d’aide en ligne devra être nommé “Facturation.CHM” ou “Facturation.HTM”. 
• Le fichier d’aide doit être placé à côté du fichier de structure ou dans le dossier Resources situé au même niveau que le fichier de structure de la base.

4D Server : Si vous souhaitez que l’aide soit accessible sur les postes clients, placez le fichier dans le dossier Resources. Il sera alors automatiquement transféré sur les postes clients. 

Les plug-ins peuvent disposer d’un fichier d’aide, ce dernier devant être placé dans le dossier PlugIns aussi bien en application monoposte qu’en client/serveur. Le fichier d’aide du Plug-in doit porter le nom du plug-in avec l’extension .CHM ou .HTM. Pour les plug-ins proposés sous forme de dossier, le fichier d'aide doit être placé :
- à côté de l'exécutable du plug-in, donc dans /Contents/MacOS ou /Contents/Windows
- ou bien dans le dossier /Contents/Ressources du plug-in.

Les composants peuvent également comporter un fichier d’aide personnalisé, placé à côté du fichier de structure du composant. Pour plus d’informations, reportez-vous au paragraphe Aide en ligne des composants.

L’aide en ligne de votre base peut être contextuelle, c’est-à-dire qu’elle peut afficher automatiquement les informations qui correspondent au contexte dans lequel se trouve l’utilisateur au moment où il sollicite le fichier d’aide. Le principe de création d’une aide en ligne contextuelle pour les bases 4D consiste à associer un numéro de rubrique à vos formulaires. Lorsque l’utilisateur appelle l’aide en ligne alors que le formulaire est affiché à l’écran, la page d’aide correspondante est affichée.

L’aide en ligne contextuelle est disponible :

• sous Windows, si l’aide en ligne est au format CHM.
• sous Windows et Mac OS, si l’aide en ligne est au format HTML.

L’assignation d’un numéro de rubrique d’aide à un formulaire s’effectue dans les Propriétés du formulaire. Pour plus d’informations sur ce point, reportez-vous au paragraphe Aide.

Vous devez ensuite assigner le même numéro à la page correspondante du fichier d’aide en ligne. Cette opération varie en fonction du format que vous utilisez :

• Pour les fichiers CHM, reportez-vous à la documentation de l’application HTML Help Workshop.
• Pour les fichiers HTML, vous devez déclarer chaque section à l’aide d’une “ancre” et lui assigner un numéro.
  Une section est déclarée à l’aide d’un marqueur du type
  

  <A NAME="Section">

  
  Par exemple :
  

   <A NAME="21">

  
  L’URL de la section est de la forme :
  

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

  
  Par exemple :
  

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

Si le numéro de rubrique passé dans le formulaire est 0 ou s’il n’existe pas dans le fichier, 4D affiche la première page du fichier d’aide.

Une fois créée, l’aide en ligne personnalisée d’une base de données peut être appelée de deux manières :

• en choisissant Aide de NomBase dans le menu Aide. Dans ce cas, la première page du fichier d’aide est affichée.
• en appuyant sur la touche F1 (Mac OS et Windows) ou Aide (Mac OS uniquement) lorsqu’un formulaire est affiché à l’écran en mode Application. Dans ce cas, si un numéro de rubrique d’aide a été associé au formulaire, la page correspondante est affichée (aide contextuelle), sinon la première page du fichier d’aide est affichée.

Note : Sous Mac OS, le fonctionnement de la touche F1 peut être personnalisé. En mode Application, lorsque l’utilisateur appuie sur la touche F1 :

• si un fichier “NomBase.HTM” existe à côté du fichier de structure de la base, le mécanisme standard de gestion des aides en ligne de 4D est mis en oeuvre. Le fichier d’aide est ouvert dans une fenêtre du navigateur par défaut.
• dans le cas contraire, 4D ne fait rien et le développeur peut traiter l’événement comme il l’entend. Ce principe permet de mettre en place des systèmes d’aide entièrement personnalisés ou d’affecter une autre fonction à la touche F1.