Eigene Dokumentation im z/OS Explorer erstellen

Wenn es in Ihrem Unternehmen Systembetriebsprozesse und -prozeduren gibt, möchten Sie diese u. U. in das z/OS® Explorer-Hilfeverzeichnis einbeziehen, damit sie bei der Nutzung des z/OS® Explorer verfügbar sind. Sie können Ihr eigenes Dokumentations-Plug-in erstellen und es vollständig in das z/OS® Explorer-Hilfeverzeichnis integrieren, oder Sie können vorläufig vorhandene HTML- und Textdateien in die Suchfunktion der z/OS® Explorer-Hilfe integrieren.

Plug-in erstellen

Der z/OS Explorer baut auf der Eclipse-Open-Source-Plattform auf, die eine erweiterbare integrierte Entwicklungsumgebung bereitstellt. Mithilfe der Eclipse-Plattform kann jeder Tools erstellen, die sich nahtlos in die Umgebung und andere Tool integrieren lassen. Der Schlüssel für die nahtlose Integration von Tools in Eclipse ist das Plug-in. Mit Ausnahme eines kleinen Laufzeit-Kernel ist alles in Eclipse ein Plug-in. Dies bedeutet, dass ein von Ihnen entwickeltes Plug-in ganz genau wie andere Plug-ins in Eclipse und somit in den z/OS Explorer integriert wird.

Wenn Sie ein Dokumentations-Plug-in erstellen, wird es vollständig in den z/OS Explorer integriert. und die Inhalte werden im Hilfeverzeichnis angezeigt.

Sie können ein eigenes Dokumentations-Plug-in mithilfe der Eclipse Plug-in Development Environment (PDE) erstellen, die in der Eclipse Integrated Development Environment (IDE) verfügbar ist. Die Eclipse IDE ist Open Source und kann von der Eclipse-Website http://www.eclipse.org heruntergeladen werden. Die Dokumentation erläutert die ersten Schritte, und ein Cheat-Sheet enthält Schritt- für-Schritt-Anleitungen zum Erstellen eines Plug-in.

HTML- und Textdateien in die z/OS Explorer-Hilfesuche integrieren

Wenn Sie noch kein Dokumentations-Plug-in erstellt haben, aber HTML- oder Textdateien haben, auf die Sie im z/OS Explorer zugreifen möchten, können Sie die Dateien in einen speziellen Ordner ablegen, damit sie in den z/OS Explorer-Suchindex einbezogen werden können. Wenn Sie eine Suche nach Hilfeinformationen durchführen, werden alle Übereinstimmungen mit Ihrer Dokumentation zusammen mit den z/OS Explorer-Ergebnissen angezeigt. Wenn Sie jedoch das Hilfeverzeichnis anzeigen, werden Ihre Dokumente nicht angezeigt.

Diese Methode, HTML- und Textdateien zu integrieren, ist nur als vorläufige Lösung vorgesehen, bis Sie ein Dokumentations-Plug-in erstellen.

Führen Sie die folgenden Schritte aus, um Ihre HTML- oder Textdateien in die z/OS Explorer-Hilfesuche einzubeziehen:

  1. Klicken Sie im Workbench-Menü auf Hilfe > Benutzerdefinierte Dokumentation verwalten. Der Dateimanager öffnet ein Fenster auf Ihrer Arbeitsoberfläche, in dem der Inhalt des Ordners mydocs im z/OS Explorer angezeigt wird.
  2. Kopieren Sie alle HTML- oder Textdateien, die Sie in den z/OS Explorer einbeziehen möchten, und fügen Sie sie im Ordner "mydocs" ein.
  3. Schließen Sie das Fenster "mydocs".
  4. Klicken Sie im Workbench-Menü auf Hilfe > Suchindex erneut erstellen. In einem Dialogfeld werden aufgefordert, den Vorgang zu bestätigen. Die Operation erfordert einen Neustart des z/OS Explorer.
  5. Klicken Sie auf OK, um fortzufahren, oder auf Abbrechen, wenn Sie den z/OS Explorer zu diesem Zeitpunkt nicht neu starten möchten. Sie müssen den Neuerstellungsschritt ausführen, damit die Dateien in die Hilfesuche einbezogen werden.

Wenn der z/OS Explorer neu gestartet wird, wird jede von Ihnen durchgeführte Hilfesuche auch Ihre Dokumentation sowie die z/OS Explorer-Dokumentation durchsuchen. Alle Ergebnisse, die in Ihrer eigenen Dokumentation gefunden werden, werden vor den Ergebnissen aufgelistet, die in der z/OS Explorer-Dokumentation gefunden werden.

Hinweis: Wenn Suchergebnisse in HTML-Dateien gefunden werden, wird der Dateiname in den Tags <Titel></Titel> angezeigt. Textdateien enthalten jedoch keine Titeltags, deswegen werden Ergebnisse in Textdateien so wie in dieser Bildschirmaufnahme angezeigt Eine Bildschirmaufname von Suchergebnissen, bei denen Ergebnisse  in der benutzerdefinierten Dokumentation an oberster Stelle angezeigt werden. Die ersten beiden Ergebnisse haben ordnungsgemäße Namen, weil diese in HTML-Dateien enthalten sind. Die nächsten drei Ergebnisse zeigen Dateipfade, da es sich hierbei um Textdateien handelt..

Übergeordnetes Thema: -Aufgaben einrichten und verwenden können