Dokumentation offline anzeigen

Sie können die Produktdokumentation, die online auf Ihrem Computer angezeigt wird, herunterladen und offline anzeigen.

Vorbereitungen

Suchen Sie die Produktdokumentation, die Sie anzeigen möchten, und laden Sie sie herunter. WebSphere® Application Server Die Dokumentation kann vom Server „ https://public.dhe.ibm.com/software/webserver/appserv/library/ “ heruntergeladen werden. Die Liberty -Dokumentation befindet sich im liberty Verzeichnis „ https://public.dhe.ibm.com/software/webserver/appserv/library/liberty/ “.

Die Dokumentation für andere Versionen und Produkte von WebSphere Application Server ist ebenfalls auf dem Server verfügbar:

9.0.5: https://public.dhe.ibm.com/software/webserver/appserv/library/v90/
8.5.5: https://public.dhe.ibm.com/software/webserver/appserv/library/v85/
Sehen Sie sich andere Verzeichnisse auf dem Server an, um Dokumentationen zu älteren Versionen zu suchen.

Der Server unterstützt auch FTPS, zum Beispiel ftps://public.dhe.ibm.com/software/webserver/appserv/library/. Sie können daher Dateien mit FTP-Download-Software herunterladen, statt diese über einen Browser herunterzuladen.

Informationen zu dieser Task

Die Dokumentation im PDF-Format können Sie in einem PDF-Reader anzeigen.

Bei Dokumentationen im HTML-Format, die in komprimierten Datein (.zip oder .jar) gespeichert sind, können Sie die heruntergeladene Dokumentation auf unterschiedliche Art und Weise anzeigen:

Zeigen Sie einzelne HTML-Dateien in einem Browser an. Sie können die Produktdokumentation vom Server herunterladen, heruntergeladene komprimierte ZIP- oder JAR-Dateien extrahieren und die HTML-Dateien einzeln anzeigen.
Tipp: Dokumentationsdateien mit einer .jar Erweiterung wie com.ibm.websphere.wlp.core.doc_9.0.0.jar sind ZIP-Dateien mit einer .jar Erweiterung. Sie können ein Dienstprogramm zum Dekomprimieren verwenden, um die Inhalte der .jar-Datei zu extrahieren, um direkt auf die HTML-Dateien zuzugreifen und diese anzuzeigen. Alternativ können Sie die Erweiterung .jar in .zip ändern, um auf die HTML-Dateien zuzugreifen, ohne die Inhalte der komprimierten Datei zu extrahieren.

Einige Produktdokumentationsdateien enthalten Sitemaps und Inhaltsverzeichnisse. Die Datei com.ibm.websphere.express.doc_7.0.0.zip enthält beispielsweise eine Sitemap in der Datei htmlnav.html in der zugehörigen Datei doc.zip. Nachdem Sie die Inhalte aus der Datei doc.zip extrahiert haben, können Sie die Datei htmlnav.html in einem Browser aufrufen, um das Inhaltsverzeichnis der Dokumentation für Express 7.0 anzuzeigen und so auf einzelne HTML-Dateien zugreifen.
Alle HTML-Dateien für die Produktdokumentation finden Sie unter Eclipse oder unter WebSphere Developer Tools für Eclipse.
Zeigen Sie alle HTML-Dateien für die Produktdokumentation in IBM Knowledge Center Customer Installed (KCCI) an. KCCI ist ein Webanwendungsarchiv (WAR-Datei), das auf einem Liberty- oder WebSphere Application Server -Server ausgeführt wird. Für diese Option benötigen Sie eine Lizenz für Liberty oder WebSphere Application Server, um die KCCI-WAR-Datei zu erhalten, und Sie müssen die KCCI-WAR-Datei auf einem Server bereitstellen.
Zeigen Sie alle HTML-Dateien für die Produktdokumentation im Knowledge Center für z/OS an, wenn Sie z/OS 2.2 oder höher haben.

Dokumentation lokal in Eclipse oder WebSphere Developer Tools anzeigen

Vorbereitungen

Hinweis: Mit der Veröffentlichung von Java 11 können Sie „ SimRel “ 2018-12 als erste Version der „ Eclipse IDE “ installieren, die die neue Funktion offiziell unterstützt.

Vorgehensweise

Installieren Sie Eclipse oder WebSphere Developer Tools for Eclipse. Sie können „ Eclipse ” unter http://www.eclipse.org/downloads/ herunterladen. Sie können die Dokumentation lokal mit Eclipse oder WebSphere Developer Tools anzeigen.
Führen Sie beispielsweise die folgenden Schritte aus, um Eclipse for Java EE Developers (Oxygen) unter Windows zu installieren.
1. Gehen Sie zu https://www.eclipse.org/downloads/packages/eclipse-ide-java-ee-developers/oxygen2 und laden Sie „ Eclipse IDE “ in ein temporäres Verzeichnis auf Ihrem Computer herunter. Die IDE hat einen Namen wie eclipse-jee-oxygen-2-win32-x86_64.zip.
2. Erstellen Sie zwei Verzeichnisse auf Ihrem Computer: eclipse_oxygen und eclipse_workspace.
3. Installieren Sie „ Eclipse “ Sauerstoff zu C:\eclipse_oxygen. Entpacken Sie die eclipse-jee-oxygen-2-win32-x86_64.zip IDE-Datei in das C:\eclipse_oxygen Verzeichnis.
Installieren Sie Java SDK 8 auf Ihrem Computer.
Tipp: Wenn auf Ihrem Computer die Version 9.0 oder die Version 8.5.5 von „ WebSphere Application Server “ installiert ist, haben Sie wahrscheinlich Java SDK 8 installiert. Diese Produkte verwenden Java SDK 8. Beispielsweise lautet die Installation des Java SDK 8 unter Windows „ IBM 64-Bit-SDK für Windows, Java Technology Edition, Version 8”. Wenn Sie bereits eine Java SDK 8-Installation haben, notieren Sie sich den Pfad zur javaw.exe Datei.

Auf den folgenden Seiten finden Sie Downloadpakete und Installationsanweisungen für IBM Java SDK 8:
- Installieren und Aktualisieren von „ IBM SDK, Java Technology Edition“ auf verteilten Betriebssystemen in der Dokumentation „Version- 9.0 “.
- Installieren von „ IBM “ „ WebSphere “ SDK Java Technology Edition Version „ 8.0 “ mithilfe der Befehlszeile in der Dokumentation zu „Version 8.5.5 “.
- IBM SDK Java Technology Edition Version 8.0 für WebSphere Application Server unter Verwendung von Installation Manager auf der Support-Website IBM
- Installieren des SDK in der Dokumentation zum „ IBM SDK, Java Technology Edition, Version 8“
Wenn Sie eine ZIP-Datei von einem Server heruntergeladen haben, die mehrere Dokumentation-JARs, -ZIP-Dateien oder Verzeichnisse enthält, extrahieren Sie die heruntergeladene ZIP-Datei in ein temporäres Verzeichnis. Die extrahierten JAR-Dateien, ZIP-Dateien oder Verzeichnisse sind Plug-ins.

Die Datei com.ibm.websphere.wlp.core.doc.zip im Serververzeichnis liberty enthält hauptsächlich .jar-Dateien. Die com.ibm.websphere.wlp.core.doc_9.0.0.jar Datei ist das englische Dokumentations-Plugin „ WebSphere Application Server “ von Liberty Core. Das com.ibm.websphere.wlp.core.doc_9.0.0_de.jar ist das deutsche Plugin „ WebSphere Application Server Liberty Core Documentation“. Die Liberty-Dokumentation verfügt über Plugin-Übersetzungen in Deutsch (de), Spanisch (es), Französisch (fr), Japanisch (ja), Koreanisch (ko), vereinfachtes Chinesisch (zh_CN) und traditionelles Chinesisch (zh_TW). Diese Plugins wurden für eine frühere Version der Dokumentation unter https://www.ibm.com/docs/en/SSD28V_liberty/com.ibm.websphere.wlp.core.doc/ae/cwlp_core_about.html verwendet. Die anderen extrahierten Dateien enthalten Javadoc, Glossar, Serverkonfiguration und Funktionen (autogen) Dokumentation und Nachrichten-Plugins).

Die Namen der Plug-ins ähneln den Namen, die in den URLs der online verfügbaren Dokumentation angezeigt werden. Beispielsweise befindet sich die Liberty Javadoc unter https://www.ibm.com/docs/en/SSEQTP_liberty/com.ibm.websphere.javadoc.liberty.doc/com.ibm.websphere.appserver.api.json_1.0-javadoc/index.html in der com.ibm.websphere.javadoc.liberty.doc.jar Datei und ihr Plugin-Name lautet com.ibm.websphere.javadoc.liberty.doc.
Kopieren Sie die extrahierten Plugins, die Sie anzeigen möchten, in das eclipse\plugins Verzeichnis Ihrer Installation von Eclipse oder WebSphere Developer Tools.

Kopieren Sie beispielsweise die Datei com.ibm.websphere.wlp.core.doc_9.0.0.jar in das Verzeichnis C:\eclipse_oxygen\eclipse\plugins. Sie müssen mindestens das englische Plug-in com.ibm.websphere.wlp.core.doc_9.0.0.jar in das Verzeichnis eclipse\plugins kopieren.

Für die übersetzten Versionen benötigen Sie außerdem noch die entsprechende JAR-Datei com.ibm.websphere.wlp.core.doc_9.0.0_**.jar. Wenn Sie die Javadoc, das Glossar, die Serverkonfiguration und die Featuredokumentation (autogen) sowie Nachrichten anzeigen möchten, kopieren Sie auch die anderen Plug-ins in der Datei com.ibm.websphere.wlp.core.doc.zip in das Verzeichnis eclipse\plugins.

Sie benötigen die .properties-Dateien für Eclipse bzw. WebSphere Developer Tools nicht. Kopieren Sie nicht die .properties-Dateien in das Verzeichnis eclipse\plugins. Die .properties-Dateien sind für KCCI.
Starten Sie Eclipse bzw. WebSphere Developer Tools.

Wenn beispielswesise IBM SDK for Java 8.0.5.10 im Verzeichnis c:\jdk_80510 installiert ist, können Sie Eclipse Oxygen mit dieser Java 8-Version und der Option -clean von einer Befehlszeile ausführen.
1. Öffnen Sie eine Befehlszeile und wechseln Sie in das Eclipse-Installationsverzeichnis.
```
cd C:\eclipse_oxygen\eclipse
```
2. Starten Sie „ Eclipse “ über die Befehlszeile im Installationsverzeichnis von „ Eclipse “ mit den Optionen -vm -clean und.
```
eclipse -vm c:\jdk_80510\jre\bin\javaw.exe -clean
```
Wenn „ Eclipse “ gestartet wird, wählen Sie den gewünschten Arbeitsbereich aus und klicken Sie dann auf „Starten “.

Wählen Sie beispielsweise das Verzeichnis C:\eclipse_oxygen_workspace bzw. das Verzeichnis aus, das Sie für den Arbeitsbereich erstellt haben. Klicken Sie anschließend auf Starten.
Klicken Sie in „ Eclipse “ auf „Hilfe“ > „Hilfeinhalt “. Die Dokumentation, die Sie in das eclipse\plugins Verzeichnis kopiert haben, wird im Inhalt angezeigt.

Die Dokumentation WebSphere Application Server Liberty Core (All operating systems), Version 9.0 unter Inhalt ist das Plug-in com.ibm.websphere.wlp.core.doc_9.0.0.jar.
Um die Dokumentation in einem Browser anzuzeigen, klicken Sie mit der rechten Maustaste auf eine Datei unter „Inhalt“ und wählen Sie „In neuem Fenster öffnen“.

Klicken Sie beispielsweise mit der rechten Maustaste auf WebSphere Application Server Liberty Core (All operating systems), Version 9.0 > In neuem Fenster öffnen.

Wenn die Eclipse-Installation auf einem Server ausgeführt wird, auf den andere Personen zugreifen können, können Sie diesen Personen die Browser-URL zum Anzeigen der Dokumentation senden.

Wenn Sie eine übersetzte Dokumentation anzeigen möchten, fügen Sie an das Ende der URL die entsprechend Abkürzung für die gewünschte Sprache hinzu (&lang=** oder ?lang=**) und drücken Sie die Eingabetaste. Geben Sie beispielsweise zum Anzeigen der französischen Version entweder &lang=fr oder ?lang=fr ein. Lesen Sie die Informationen zum Anzeigen übersetzter Versionen in der Eclipse-Dokumentation.
Wenn die Übersetzung nicht in der Eclipse-Hilfe angezeigt wird, verwenden Sie die Befehlsdateien, um die Dokumentation zu öffnen und zu schließen.
1. Lokalisieren Sie die Datei org.eclipse.help.base_N.N.N.vNNN.jar im Verzeichnis C:\eclipse_oxygen\eclipse\plugins. Hierbei steht N.N.N.vNNN für die von Ihnen heruntergeladene Eclipse-Version. Der Dateiname für Eclipse Oxygen ist org.eclipse.help.base_4.2.102.v20171130-0510.jar.
2. Erstellen Sie im Verzeichnis C:\eclipse_oxygen eine Datei und nennen Sie sie ic_start.cmd. Fügen Sie mit einem Texteditor den folgenden Befehl zur Datei hinzu. Stellen Sie sicher, dass der Wert für -classpath den Pfad zur Datei org.eclipse.help.base_N.N.N.vNNN.jar in Ihrer Installation angibt. Geben Sie außerdem den Listener-Port für Eclipse an. In diesem Beispiel ist die Portnummer 8680.
```
java -classpath eclipse\plugins\org.eclipse.help.base_4.2.102.v20171130-0510.jar  org.eclipse.help.standalone.Infocenter -eclipsehome eclipse -port 8680 -command start -noexec -clean
```
3. Erstellen Sie im Verzeichnis C:\eclipse_oxygen eine Datei und nennen Sie sie ic_stop.cmd. Fügen Sie mit einem Texteditor den folgenden Befehl zur Datei hinzu. Stellen Sie sicher, dass der Wert für -classpath den Pfad zur Datei org.eclipse.help.base_N.N.N.vNNN.jar in Ihrer Installation angibt.
```
java -classpath eclipse\plugins\org.eclipse.help.base_4.2.102.v20171130-0510.jar  org.eclipse.help.standalone.Infocenter -eclipsehome eclipse -command shutdown
```
4. Führen Sie die Datei ic_start.cmd aus, indem Sie doppelt auf den Dateinamen klicken, oder führen Sie den Befehl über eine Befehlszeile aus. Es wird ein Befehlsfenster geöffnet, das geöffnet bleibt, bis Sie die Datei ic_stop.cmd ausführen.
5. Wenn die ic_start.cmd Datei ausgeführt wird, rufen Sie in Ihrem Browser die Adresse auf, um die http://localhost:port_number/help/index.jsp Dokumentation auf Ihrem Computer zu starten. In diesem Beispiel ist die URL: http://localhost:8680/help/index.jsp.
6. Geben Sie zum Anzeigen einer Übersetzung einen Sprachparameter in der URL an.
  1. Wählen Sie ein Thema in der Dokumentation aus, das Sie anzeigen möchten.
  2. Klicken Sie mit der rechten Maustaste auf das Thema und wählen Sie die Option zum Öffnen des Links in einem neuen Fenster oder auf einer neuen Registerkarte aus. Die URL für das neue Fenster bzw. die neue Registerkarte zeigt auf ein bestimmtes Dokumentationsthema.
  3. Fügen Sie an das Ende der URL die entsprechende Abkürzung für die gewünschte Sprache hinzu (&lang=** oder ?lang=**) und drücken Sie die Eingabetaste. Wenn Sie beispielsweise in Eclipse Oxygen die französische Version anzeigen möchten, fügen Sie &lang=fr an das Ende der Themen-URL und drücken Sie die Eingabetaste.
Sie können die Dokumentation durchsuchen. Geben Sie einen Suchbegriff im Suchfeld ein und klicken Sie auf Los. Wenn Sie den Suchvorgang das erste Mal ausführen, dauert das Indexieren einige Minuten. Nach der Indexierung werden Suchvorgänge in der Regel innerhalb von Sekunden ausgeführt.

Dokumentation lokal im Knowledge Center for z/OS anzeigen

Vorgehensweise

Konfigurieren Sie das Knowledge Center für „ z/OS “.
Erstellen Sie ein Unterverzeichnis von /global/kc4z/data/content für die Dokumentation, die Sie anzeigen möchten. Erstellen Sie beispielsweise für die WebSphere Application ServerFreiheit für z/OS nicht versionierte Dokumentation das /global/kc4z/data/content/wlpzos900 Verzeichnis. Weitere Informationen finden Sie unter Verwalten von Produktdokumentationsinhalten im Knowledge Center für z/OS.
Laden Sie die Dokumentation, die Sie anzeigen möchten, vom Server herunter. Die für den Download verfügbaren ZIP-Dateien enthalten verschiedene Dokumentation-JAR-Dateien, -ZIP-Dateien und Verzeichnisse. Extrahieren Sie die heruntergeladene ZIP-Datei in das von Ihnen erstellte Unterverzeichnis /global/kc4z/data/content. Die extrahierten JAR-Dateien, ZIP-Dateien oder Verzeichnisse sind Plug-ins.

Extrahieren Sie beispielsweise den Inhalt der com.ibm.websphere.wlp.zseries.doc.zip Datei im Verzeichnis liberty „server“ unter „ https://public.dhe.ibm.com/software/webserver/appserv/library/liberty/ “ in das /global/kc4z/data/content/wlpzos900 Verzeichnis „directory“.

Die Datei com.ibm.websphere.zseries.doc.zip enthält hauptsächlich die .jar-Dateien. Die com.ibm.websphere.zseries.doc_9.0.0.jar Datei ist das englische Plugin „ WebSphere Application Server Liberty for z/OS “ für nicht versionierte Dokumentation. Die com.ibm.websphere.zseries.doc.nl1_9.0.0.jar ist die Landessprache oder übersetzt „ WebSphere Application Server “ ( Freiheit für z/OS ) unversioniertes Dokumentations-Plugin. Diese Plugins wurden für die Dokumentation unter https://www.ibm.com/docs/en/SS7K4U_liberty/com.ibm.websphere.wlp.zseries.doc/ae/cwlp_about.html verwendet. Die anderen extrahierten Dateien stellen Javadoc, das Glossar, die Serverkonfiguration und die Featuredokumentation (autogen) sowie Nachrichten-Plug-ins bereit.

Die Namen der Plug-ins ähneln den Namen, die in den URLs der online verfügbaren Dokumentation angezeigt werden. Beispielsweise befindet sich die Liberty Javadoc unter https://www.ibm.com/docs/en/SS7K4U_liberty/com.ibm.websphere.javadoc.liberty.doc/com.ibm.websphere.appserver.api.json_1.0-javadoc/index.html in der com.ibm.websphere.javadoc.liberty.doc.jar Datei und ihr Plugin-Name lautet com.ibm.websphere.javadoc.liberty.doc.
Konfigurieren Sie die .properties Datei für Ihre Dokumentation. Siehe Verwalten von Produktdokumentationsinhalten im Knowledge Center für z/OS.

Die Datei com.ibm.websphere.wlp.zseries.doc.zip enthält zwei .properties-Dateien, die Sie bearbeiten und für das Knowledge Center for z/OS verwenden können. Die Datei no_ditamap.properties ist von den beiden .properties-Dateien die Datei, die einfacher in der Handhabung ist. Für WebSphere Application Server Liberty für z/OS nicht versionierte Dokumentation, setzen Sie den product Wert auf SS7K4U_liberty und den path Wert auf das Verzeichnis, das die Plugins enthält, /global/kc4z/data/content/wlpzos900.

Tipp: Sie können Plugins für die gesamte Dokumentation von WebSphere Application Server im /global/kc4z/data/content/wlpzos900 Verzeichnis ablegen und die no_ditamap.properties Datei verwenden, um die Dokumentation für viele Produkte anzuzeigen.

Die andere Eigenschaftendatei SS7K4U_liberty.properties setzt voraus, dass das Verzeichnis /global/kc4z/data/content/wlpzos900 ein as_ditamaps-Unterverzeichnis enthält, das die .ditamap-Produktdateien bereitstellt. Sie können die Dateien für das Unterverzeichnis as_ditamaps aus der Datei Liberty_as_ditamaps.zip oder aus der Datei Liberty_all_product_doc.zip vom Server abrufen. Stellen Sie sicher, dass in der Datei SS7K4U_liberty.properties der path-Wert für das Verzeichnis mit den Plug-ins festlegt ist. Der toc-Wert ist bereits auf die Master-Map gesetzt.
Konfigurieren Sie die KC_taxonomy.ditamap für Ihre Dokumentation. Siehe Verwalten von Produktdokumentationsinhalten im Knowledge Center für z/OS.

Stellen Sie sicher, dass die Datei KC_taxonomy.ditamap ein subjectdef-Element für SS7K4U_liberty enthält. Die Liberty_properties_files.zip Datei im Verzeichnis liberty „server“ enthält eine KC_taxonomy.ditamap Datei mit subjectdef Elementen für alle Produkte von WebSphere Application Server.
Stoppen Sie den Server mit dem Knowledge Center for z/OS und starten Sie ihn erneut.
Rufen Sie in Ihrem Webbrowser die Adresse http://host_name:9080/zos/knowledgecenter/ URL auf.