Administrer le contenu d'aide pour les produits web

Le système de distribution d'aide est fourni sous la forme d'un fichier d'archive Web (WAR) qui est déployé sur votre serveur d'aide. Le fichier WAR contient la structure de base de l'aide, l'aide sur l'aide et l'aide contextuelle.
Vous pouvez configurer le fichier WAR d'aide pour accéder au contenu d'aide de trois façons différentes :
  1. Aide Web d'ibm.com (aide distante) : Vous pouvez accéder au contenu d'aide directement depuis un centre de documentation qui est hébergé sur ibm.com, de façon à ce que le contenu soit constamment à jour. Cette option est parfois appelée aide distante.
  2. Contenu d'aide téléchargé (aide locale) : Vous pouvez télécharger les contenus d'aide directement vers le serveur d'aide et accéder aux contenus à partir de celui-ci. Cette option est parfois appelée aide locale.
  3. Aide Web provenant d'un centre de documentation intranet (aide intranet) : Vous pouvez accéder contenu d'aide depuis un centre de documentation hébergé sur un serveur intranet. Cette option utilise l'aide distante pour pointer vers le centre de documentation intranet et est parfois appelée aide intranet. Cette option peut être utilisée dans des environnements d'entreprise, permettant ainsi l'utilisation d'un même centre de documentation intranet pour plusieurs déploiements d'aide.

Les trois options de distribution de contenu d'aide

Le tableau suivant contient des détails sur l'administration et les utilisations des trois options de contenu d'aide.
Tableau 1. Options de contenu d'aide
Options d'aide 1. Aide Web d'ibm.com (aide distante) 2. Contenu d'aide téléchargé (aide locale) 3. Aide Web provenant d'un centre de documentation intranet (aide intranet)
Description

Avec cette option, vous accédez directement à l'aide depuis ibm.com. Le serveur d'aide doit disposer d'une connexion Internet.

Avec cette option, vous accédez directement à l'aide depuis l'aide installée localement sur le serveur d'aide.

Avec cette option, vous accédez à l'aide qui est hébergée sur un serveur intranet. Le centre de documentation intranet doit être configuré et le serveur d'aide doit disposer d'une connexion au serveur intranet qui héberge le centre de documentation.

Cette option peut être utilisée pour les environnements d'entreprise.

Administration Cette configuration d'aide est la configuration par défaut. Pour configurer l'utilisation de l'aide distante :
  1. Sur le serveur d'aide, accédez à la page du centre de documentation distant de l'aide du produit.
  2. Configurez l'aide de façon à utiliser l'aide distante depuis un centre de documentation sur ibm.com.
Pour configurer l'aide locale :
  1. Sur le serveur d'aide, accédez à la page Mettre à jour.
  2. Téléchargez l'aide depuis ibm.com sur le serveur d'aide local. Pour plus d'informations, voir Téléchargement de contenu d'aide.
  3. Configurez l'aide de façon à ne pas utiliser l'aide distante.
Pour configurer l'utilisation de l'aide intranet :
  1. Sur le serveur intranet, créez un centre de documentation pour votre produit.
  2. Sur le serveur d'aide, accédez à la page du centre de documentation distant de l'aide du produit.
  3. Configurez l'aide de façon à utiliser l'aide distante depuis votre centre de documentation intranet.
Mettre à jour le contenu Aucune mise à jour n'est nécessaire. Le contenu est constamment à jour. Pour mettre à jour le contenu pour l'aide locale :
  1. Sur le serveur d'aide, accédez à la page de téléchargement de l'aide locale.
  2. Mettez à jour le contenu. Pour plus d'informations, voir Mise à jour du contenu d'aide.
Remarque : Si vous avez activé les mises à jour automatiques, le contenu sera mis à jour chaque fois que vous redémarrez l'aide si le serveur d'aide a une connexion Internet à ibm.com. Les mises à jour sont vérifiées sur les sites de la liste Sites favoris. Vous pouvez filtrer la liste Contenu disponible pour n'afficher que les Sites favoris.
Pour mettre à jour le contenu sur le serveur intranet, suivez les instructions pour le téléchargement de l'aide, mais utilisez le serveur intranet au lieu du serveur d'aide.
Pour utiliser l'aide du produit, dans la partie droite de la bannière, cliquez sur ? > Table des matières de l'aide.
Remarque : Pour les serveurs d'applications Tomcat, l'aide démarre et s'arrête lorsque vous démarrez ou que vous arrêtez votre produit. Pour les serveurs IBM WebSphere Application Server, vous devez démarrer et arrêter manuellement le fichier WAR d'aide.