Configuration/installation

Cette section contient des rubriques relatives à l'installation, la configuration et la personnalisation du système d'aide afin qu'il puisse fonctionner dans différents environnements et produits.

Modes du système d'aide

Le système d'aide peut fonctionner sous trois modes : plan de travail (normal), centre de documentation et autonome. Le mode plan de travail permet de servir l'aide intégrée au produit, généralement via un menu Aide. Ce mode offre également une aide contextuelle ainsi qu'une vue, qui ne sont pas disponibles dans les deux autres modes. Le mode Autonome a le même objectif que le mode plan de travail, mais est destiné aux produits qui ne fonctionnent pas sous Eclipse (l'aide sera moins intégrée). Le mode Centre de documentation est utilisé pour servir le contenu de l'aide de manière globale sur Internet. Pour plus d'informations, consultez les liens précédents.

Prise en charge de la plateforme RCP (Rich Client Platform)

Le système d'aide est un composant RCP facultatif. Cela signifie qu'il ne fait pas partie du produit de base RCP, mais qu'il peut être intégré afin de fournir une aide à l'application RCP.

Personnalisation du produit

L'aide fournit des préférences que les produits peuvent utiliser pour personnaliser le système d'aide en fonction de leurs besoins. Elles permettent de personnaliser l'image de marque, l'apparence, la fonctionnalité d'activation et désactivation, etc.

Préindexation

Dans le cas des produits qui offrent un grand nombre de documents d'aide, la phase d'indexation initiale qui se produit lors de la première recherche peut être fastidieuse. Pour éviter ce temps d'attente, vous pouvez préindexer la table des matières de l'aide et envoyer l'index préparé accompagné de votre documentation. Ceci est un compromis entre les performances (en évitant la phase d'indexation) et l'espace (nécessaire pour stocker l'index).