Manuel d'administration > Installation > Nouvelle installation > Installation de la Documentation en ligne

Installation de la Documentation en ligne

Plusieurs systèmes d'aide sont à votre disposition pour l'Interface Utilisateur sous forme de Documentation en ligne (F1). Les systèmes à utiliser dépendent de la plateforme du système sur laquelle l'Interface Utilisateur est installée.

Formats d'aide

Aide HTML

L'aide HTML ne peut fonctionner que sur les plateformes où Microsoft HTML Help Viewer est disponible (Microsoft Windows).

WebHelp

WebHelp peut fonctionner sur toutes les plateformes où un navigateur HTML est disponible. Pour que toutes les fonctions soient disponibles, JavaScript doit être autorisé.

PDF

Les manuels en format PDF peuvent être ouverts sur toutes les plateformes sur lesquelles un programme d'affichage PDF (p. ex. Adobe Reader) est installé. Ce format ne peut pas être ouvert par l'Interface Utilisateur (F1) !

Fichiers fournis

Les documentations sur les différents formats et langues se trouvent dans le répertoire IMAGE:DOCUMENTATION.

Répertoire	Documentation
IMAGE:DOCUMENTATION\GUIDES\HTMLHELP	Manuels de Automation Engine au format aide HTML
IMAGE:DOCUMENTATION\GUIDES\WEBHELP	Manuels de Automation Engine au format WebHelp
IMAGE:DOCUMENTATION\GUIDES\PDF	Manuels de Automation Engine au format PDF
IMAGE:DOCUMENTATION\RELEASE NOTES	Notes de mise à jour de Automation Engine au format PDF
IMAGE:DOCUMENTATION\UC4MSG\HTMLHELP	Documentation des messages au format aide HTML
IMAGE:DOCUMENTATION\UC4MSG\WEBHELP	Documentation des messages au format WebHelp

La documentation en format WebHelp est également disponible sous forme compressée dans des fichiers tar (répertoire IMAGE:DOCUMENTATION\GUIDES\WEBHELP).

Déroulement

	1.	Copie de la documentation AE

documentation AE dans son intégralité
Sous Windows, si vous voulez utiliser tous les systèmes d'aide et toutes les langues, vous devez copier l'intégralité du répertoire IMAGE:DOCUMENTATION dans un répertoire de votre choix. WebHelp est fourni à raison d'une langue par fichier ZIP. Décompressez ce dernier. Lors de la décompression, veillez à ce que le contenu de l'archive ZIP soit directement décompressé dans le dossier correspondant et qu'aucun sous-dossier supplémentaire ne soit créé !
Sous UNIX, copiez les fichiers TAR dans le dossier DOCUMENTATION et décompressez-les également :

gunzip docu.tar.gz
tar xpvf docu.tar

Copie de parties de la documentation AE
Si vous préférez n'utiliser qu'un système d'aide ou qu'une seule langue, copiez simplement les répertoires correspondants. Attention, la structure des dossiers doit être préservée pour que les rubriques d'aide puissent s'afficher lorsque vous appuyez sur la touche F1 dans l'Interface Utilisateur. Il en va de même pour l'utilisation de WebHelp sous UNIX.

Exemple :
Vous désirez installer la Documentation d'aide en français.
Action incorrecte : Copier directement les fichiers CHM dans le dossier \AE\DOCUMENTATION.
Action correcte : Créer la structure de dossier \AE\DOCUMENTATION\AE\HTMLHELP\GERMAN et y sauvegarder les fichiers CHM.

Il est également possible d'enregistrer la Documentation dans un emplacement auquel tous les Utilisateurs ont accès (par exemple : un répertoire sur le Serveur). Attention, le répertoire des fichiers d'aide HTML (.CHM) doit également être mis à jour dans le registre. Vous trouverez un complément d'informations sur le site de Microsoft, dans les articles 896054 et 896358.

Il est également possible d'accéder au manuel des messages via l'aide HTML. Copiez le fichier MESSAGES.CHM dans le répertoire DOCUMENTATION\GUIDES\HTMLHELP\GERMAN (ou ENGLISH ou FRENCH)

	2.	Configuration de l'Interface Utilisateur

Entrez dans le fichier de configuration uc4config.xml de l'Interface Utilisateur le type de système d'aide et le chemin à utiliser. Si vous utilisez WebHelp, vous devez indiquer le navigateur web avec lequel l'Interface Utilisateur doit ouvrir les pages lorsque l'Utilisateur appuie sur F1.

<docu type="Format">Chemin</docu>
<browser type="Nom">Chemin</browser>

Si le dossier DOCUMENTATION est stocké en parallèle au dossier USERINTERFACE, le chemin d'accès standard peut être laissé dans le fichier de configuration uc4config.xml.

	3.	Lancement de la documentation AE

La documentation peut être appelée à tout moment avec la touche F1. Elle est ouverte exactement à la page qui contient une description de la fenêtre, de l'onglet ou du script. Dans le dernier des cas, il suffit de placer le pointeur dans le nom du script (onglet script).
La documentation AE peut aussi être ouverte manuellement dans le dossier où elle a été copiée. Vous accédez à la page d'accueil comme suit :

Aide HTML : help.chm
WebHelp : help.htm