Préférences du système d'aide

Vous pouvez configurer et fabriquer le système d'aide d'Eclipse pour l'adapter à votre produit en spécifiant des valeurs par défaut personnalisées pour de nombreuses préférences.

Le système d'aide se divise en plusieurs plug-ins distincts. Les tableaux ci-après indiquent les préférences disponibles et le plug-in qui les définit. Consultez la rubrique Personnalisation d'un produit pour apprendre à remplacer certaines de ces préférences.
 

Plug-in org.eclipse.help :

Clé de préférence Syntaxe
Valeur par défaut
baseTOCS Tri de la table des matières.  Liste triée des tables des matières des manuels de l'aide tels qu'ils apparaîtraient sur une étagère. Toutes les autres tables des matières seront établies en fonction de ces manuels. Les tables des matières qui ne figurent pas dans cette liste seront ignorées. Pour l'emplacement de chaque table des matières, utilisez /IDplug-in/chemin/vers/toc.xml. /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS Désactivation des tables des matières. Liste des tables des matières d'aide (livres) qui seront ignorées par le système d'aide. Les tables des matières désactivées n'apparaîtront pas dans la liste des livres, et ne peuvent être liées. Les sujets définis par les tables des matières désactivées ne seront pas disponibles pour la recherche. Les tables des matières n'apparaissant pas dans cette liste seront ignorées. Pour l'emplacement de chaque table des matières, utilisez /IDplug-in/chemin/vers/toc.xml.

Plug-in org.eclipse.help.base :

Clé de préférence Syntaxe
Valeur par défaut
banner Emplacement de la page de bannière à afficher dans le cadre supérieur
Exemple : banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height Hauteur du cadre de la bannière
Exemple : banner_height=60

help_home Page à afficher dans la zone de contenu à l'ouverture de l'aide. Indiquez votre page html sous la forme /IDplug-in/chemin/vers/home.html. /org.eclipse.help.base/doc/help_home.html
linksView Définissez la valeur true ou false pour contrôler l'affichage de la vue des liens liés.
Remarque : cette option n'impacte pas le centre de documentation.
true
bookmarksView Définissez la valeur true ou false pour contrôler l'affichage de la vue des signets.
Remarque : cette option n'impacte pas le centre de documentation.
true
windowTitlePrefix Définissez la valeur true ou false pour contrôler le titre de la fenêtre du navigateur. Si la valeur est true, le titre s'affiche sous la forme "Aide - <NOM_PRODUIT>" ; dans les autres cas, le titre s'affiche sous la forme "<NOM_PRODUIT>", où <NOM_PRODUIT> est le nom de l'ensemble des produits Eclipse dans le dispositif principal. true
loadBookAtOnceLimit Nombre maximal de rubriques d'un manuel pouvant être chargé par la fonction de navigation dans le navigateur sous la forme d'un document. Le système de navigation des manuels plus gros est chargé dynamiquement, par groupes de niveaux. Des rubriques supplémentaires sont téléchargées en fonction des besoins, lorsque l'arborescence est développée. 1000
dynamicLoadDepthsHint Nombre de niveaux conseillés pour la fonction de navigation des rubriques à télécharger dans le navigateur pour les gros manuels. La valeur doit être supérieure à 0. Le nombre réel de niveaux peut différer pour les arborescences de grande taille si le nombre de niveaux conseillés contient beaucoup de rubriques.
3
imagesDirectory Répertoire contenant des images utilisées dans la vue de l'aide. Les noms des images doivent être identiques aux noms figurant dans le plug-in org.eclipse.help.webapp. Utilisez le format /IDplug-in/répertoire. images
advanced.toolbarBackground Arrière-plan CSS pour les barres d'outils. La valeur est utilisée dans les navigateurs qui affichent l'interface utilisateur de l'aide avancée. ButtonFace
advanced.viewBackground Arrière-plan CSS pour les vues de navigation. La valeur est utilisée dans les navigateurs qui affichent l'interface utilisateur de l'aide avancée. Window
advanced.toolbarFont Police CSS pour les barres d'outils. La valeur est utilisée dans les navigateurs qui affichent l'interface utilisateur de l'aide avancée. icon
advanced.viewFont Police CSS pour les vues de navigation. La valeur est utilisée dans les navigateurs qui affichent l'interface utilisateur de l'aide avancée. icon
basic.toolbarBackground Couleur d'arrière-plan pour les barres d'outils. La valeur est utilisée dans les navigateurs qui utilisent une interface utilisateur d'aide standard. #D4D0C8
basic.viewBackground Couleur d'arrière-plan pour les vues de navigation. La valeur est utilisée dans les navigateurs qui utilisent une interface utilisateur d'aide standard. #FFFFFF
locales Liste des environnements locaux que le centre de documentation reconnaît et pour lesquels il fournit un contenu personnalisé ; si les environnements locaux (ou les langues) acceptés par le navigateur client ne correspondent pas à l'un des environnements locaux de cette liste, le navigateur affiche le contenu pour l'environnement local par défaut, c'est-à-dire pour l'environnement local du serveur ou l'environnement local spécifié par l'option de ligne de commande eclipse -nl ; si aucune liste n'est indiquée, le navigateur affiche le contenu pour l'environnement local favori. Remarque : si vous ne précisez pas cette option, la mémoire et l'espace disque requis pour la création des arborescences de navigation et des index pour chaque environnement local favori distinct des navigateurs accédant au centre de documentation est considérable.
Exemple : locales=en ja zh_CN zh_TW

productIndex Si l'index de la documentation pré-compilée est fourni avec chaque produit, vous devez indiquer au système d'aide l'ID du plug-in fournissant l'index.
always_external_browser
Utilisez un navigateur imbriqué si possible (sous Windows ou Linux), ou utilisez systématiquement un navigateur externe. La valeur true entraîne l'utilisation d'un navigateur externe. Elle n'a pas d'effet s'il n'existe aucun navigateur imbriqué disponible sur une plate-forme donnée.
false
default_browser

Navigateur externe par défaut. Il s'agit de l'ID de l'un des navigateurs Web externes ajoutés au point d'extension org.eclipse.help.base.browser, que le système d'aide va utiliser. La méthode available() d'adaptateur du navigateur doit renvoyer la valeur true sur le système actuel.

Cette option permet de contrôler les navigateurs externes en mode d'aide autonome. En mode plan de travail, le système d'aide utilise les navigateurs fournis par le système de prise en charge des navigateurs de plan de travail.

Valeur par défaut définie dynamiquement en fonction du navigateur disponible sur un système donné
custom_browser_path

Chemin de l'exécutable du navigateur personnalisé

Cette option contrôle les navigateurs externes en mode d'aide autonome. En mode plan de travail, le système d'aide utilise les navigateurs fournis par le système de prise en charge des navigateurs de plan de travail.

C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1 - pour Windows,
"konqueror %1" - pour Linux
"mozilla %1" - pour d'autres plate-formes
showDisabledActivityTopics Le système d'aide filtre les rubriques des fonctionnalités désactivées. Cette option permet de contrôler le comportement et l'existence du bouton Afficher toutes les rubriques.
Valeurs admises : never, off, on, always
 never - les rubriques des fonctionnalités désactivées ne s'affichent pas
 off - l'utilisateur peut choisir d'afficher toutes les rubriques, en masquant initialement les rubriques désactivées
 on - l'utilisateur peut choisir d'afficher toutes les rubriques, sans masquer initialement les rubriques désactivées
 always - les rubriques des fonctionnalités désactivées sont affichées (le filtrage est désactivé)
off
activeHelp Permet d'activer et de désactiver l'exécution de l'aide active. Cette option n'impacte pas la configuration du centre de documentation, dans lequel l'aide active est désactivée.
Valeurs admises :
 true - actions par défaut de l'aide active activées
 false - structure de l'aide active désactivée
true
window_infopop Permet d'activer les informations en incrustation ancienne version quand la touche d'aide est pressée dans les fenêtres du plan de travail. Si la valeur est 'false', la nouvelle aide dynamique s'ouvrira à la place. false
dialog_infopop
Permet d'activer les informations en incrustation ancienne version quand la touche d'aide est pressée dans les boîtes de dialogue. Si la valeur est 'false', la nouvelle aide dynamique s'ouvrira à la place.
false

Plug-in org.eclipse.help.appserver :

Clé de préférence Syntaxe
Valeur par défaut
port Numéro du port sur lequel le serveur est à l'écoute des demandes HTTP. Si aucun port n'est indiqué, le système en détermine un de façon arbitraire.  
host

Nom ou adresse de l'hôte à utiliser pour la connexion au serveur. Il n'existe pas de valeur par défaut et Eclipse sélectionnera une adresse locale disponible.

Les produits utilisant l'aide en mode local (plan de travail ou autonome, mais pas infocentre) peuvent utiliser le paramètre "127.0.0.1" pour cette option afin de s'assurer que le serveur d'aide n'est pas accessible par les autres utilisateurs du réseau.


Plug-in org.eclipse.tomcat :

Clé de préférence Syntaxe
Valeur par défaut
acceptCount Longueur maximale de la file d'attente pour les demandes de connexion entrantes lorsque toutes les unités d'exécution pour le traitement des demandes sont en cours d'utilisation. Toute demande reçue lorsque la file d'attente est pleine sera rejetée. 100
maxProcessors
Nombre maximal d'unités d'exécution pour le traitement des demandes qui seront créées par ce connecteur et qui détermine le nombre maximal de demandes pouvant être traitées simultanément.
75
minProcessors
Nombre d'unités d'exécution pour le traitement des demandes qui seront créées lors du premier démarrage de ce connecteur. La valeur de cet attribut doit être inférieure à la valeur définie pour maxProcessors.
5