Hilfeinhalt für Webprodukte verwalten

Das Hilfebereitstellungssystem ist in einer Webarchivdatei (WAR-Datei) gepackt, die auf Ihrem Hilfeserver implementiert wird. Die WAR-Datei enthält die grundlegende Hilfestruktur, die Hilfe zur Hilfe und die kontextbezogene Hilfe.
Sie können die WAR-Datei für die Hilfe auf drei Arten für den Zugriff auf den Hilfeinhalt konfigurieren:
  1. Webhilfe von ibm.com (ferne Hilfe): Sie können direkt in einem Information Center auf ibm.com auf Hilfeinhalt zugreifen; in diesem Fall ist der Inhalt immer auf dem neuesten Stand. Diese Option wird manchmal auch als ferne Hilfe bezeichnet.
  2. Heruntergeladener Hilfeinhalt (lokale Hilfe): Sie können den Hilfeinhalt direkt auf den Hilfeserver herunterladen und dort darauf zugreifen. Diese Option wird manchmal auch als lokale Hilfe bezeichnet.
  3. Webhilfe über ein Intranet-Information Center (Webhilfe): Sie können auf Hilfeinhalt in einem Information Center zugreifen, das sich auf einem Intranet-Server befindet. Diese Option verwendet die ferne Hilfe, um auf das Intranet-Information Center zu verweisen, und wird manchmal auch als Intranet-Hilfe bezeichnet. Diese Option kann in Unternehmensumgebungen verwendet werden, um die Hilfe für mehrere Implementierungen über ein Intranet-Information Center bereitstellen zu können.

Die drei Optionen für die Bereitstellung von Hilfeinhalt

Die folgende Tabelle enthält Verwaltungs- und Verwendungsdetails für die drei Optionen, die in Bezug auf den Hilfeinhalt zur Verfügung stehen.
Tabelle 1. Hilfeinhalt - Optionen
Hilfeoption 1. Webhilfe von ibm.com (ferne Hilfe) 2. Heruntergeladener Hilfeinhalt (lokale Hilfe) 3. Webhilfe über ein Intranet-Information Center (Webhilfe)
Beschreibung

Mit dieser Option können Sie auf die Hilfe direkt auf ibm.com zugreifen. Der Hilfeserver muss über eine Internetverbindung verfügen.

Mit dieser Option greifen Sie direkt auf die lokal installierte Hilfe auf dem Hilfeserver zu.

Mit dieser Option können Sie auf die Hilfe auf dem Intranet-Server zugreifen. Das Intranet-Information Center muss konfiguriert sein und der Hilfeserver muss über eine Verbindung zu dem Intranet-Server verfügen, auf dem sich das Information Center befindet.

Diese Option kann in Unternehmensumgebungen verwendet werden.

Verwaltung Diese Hilfekonfiguration ist die Standardeinstellung. Gehen Sie wie folgt vor, um die ferne Hilfe zu konfigurieren:
  1. Navigieren Sie auf dem Hilfeserver zur Seite für das ferne Information Center mit der Produkthilfe.
  2. Konfigurieren Sie die Hilfe zur Verwendung der fernen Hilfe über ein Information Center auf ibm.com.
Gehen Sie wie folgt vor, um die lokale Hilfe zu konfigurieren:
  1. Navigieren Sie auf dem Hilfeserver zur Update-Seite.
  2. Laden Sie die Hilfe von ibm.com auf den lokalen Hilfeserver herunter. Einzelheiten hierzu finden Sie unter Hilfeinhalt herunterladen.
  3. Konfigurieren Sie die Hilfe so, dass die ferne Hilfe nicht verwendet wird.
Gehen Sie wie folgt vor, um die Intranet-Hilfe zu konfigurieren:
  1. Erstellen Sie auf dem Intranet-Server ein Information Center für Ihr Produkt.
  2. Navigieren Sie auf dem Hilfeserver zur Seite für das ferne Information Center mit der Produkthilfe.
  3. Konfigurieren Sie die Hilfe so, dass die ferne Hilfe über das Intranet-Information Center verwendet wird.
Aktualisierung des Inhalts Aktualisierungen sind nicht erforderlich. Der Inhalt ist immer auf dem neuesten Stand. Gehen Sie wie folgt vor, um den Inhalt für die lokale Hilfe zu aktualisieren:
  1. Navigieren Sie auf dem Hilfeserver zur Downloadseite für die lokale Hilfe.
  2. Aktualisieren Sie den Inhalt. Einzelheiten hierzu finden Sie unter Hilfeinhalt aktualisieren.
Anmerkung: Wenn Sie automatisches Updates eingestellt haben, wird der Inhalt immer dann aktualisiert, wenn Sie die Hilfe neu starten, sofern der Hilfeserver zu diesem Zeitpunkt über eine Internetverbindung zu ibm.com verfügt. Die Sites in der Liste Favoriten werden auf Updates geprüft. Sie können die Liste Verfügbarer Inhalt filtern, sodass nur die Favoriten angezeigt werden.
Befolgen Sie zum Aktualisieren des Inhalts auf dem Intranet-Server die Anweisungen zum Herunterladen von Hilfe, verwenden Sie aber anstelle des Hilfeservers den Intranet-Server.
Klicken Sie zum Verwenden der Hilfe aus dem Produkt rechts im Banner auf ? > Hilfeinhalt.
Anmerkung: Bei Tomcat-Anwendungsservern wird die Hilfe gestartet und gestoppt, wenn das Produkt gestartet bzw. gestoppt wird. Bei IBM WebSphere Application Server muss die WAR-Hilfedatei manuell gestartet und gestoppt werden.