Installation de votre propre documentation dans z/OS Explorer

Si votre organisation a des processus et procédures d'exploitation du système, vous voudrez peut-être les inclure dans le sommaire de l'aide de z/OS® Explorer pour qu'ils soient disponibles lorsque vous utilisez z/OS Explorer. Vous pouvez créer votre propre plug-in de documentation et l'intégrer entièrement dans le sommaire de l'aide de z/OS Explorer ou bien, à titre d'étape temporaire, vous pouvez intégrer des fichiers HTML et des fichiers texte existants dans la fonction de recherche de l'aide de z/OS Explorer.

Création d'un plug-in

z/OS Explorer est construit sur la plateforme à source ouverte Eclipse, qui fournit un environnement extensible de développement intégré. A l'aide de la plateforme Eclipse, n'importe qui peut construire des utilitaires qui s'intègrent de manière transparente avec l'environnement et d'autres outils. La clé de l'intégration transparente des outils avec Eclipse est le plug-in. A l'exception d'un petit noyau d'exécution, tout ce qui compose Eclipse est un plug-in. Cela signifie qu'un plug-in que vous développez s'intègre avec Eclipse et donc avec z/OS Explorer, exactement de la même manière que d'autres plug-ins.

Lorsque vous créez un plug-in de documentation, il est totalement intégré avec z/OS Explorer et son contenu est affiché dans le sommaire de l'aide.

Vous pouvez créer votre propre plug-in de documentation à l'aide de l'environnement de développement de plug-ins Eclipse (PDE), qui est disponible dans l'environnement de développement intégré Eclipse (IDE). L'environnement de développement intégré Eclipse est une source ouverte, qui peut être téléchargée à partir du site Web d'Eclipse http ://www.eclipse.org. La documentation explique comment démarrer et un aide-mémoire fournit des instructions étape par étape pour créer un plug-in.

Intégration de fichiers HTML et fichiers texte avec la fonction de recherche de l'aide de z/OS Explorer

Si vous n'avez pas encore créé un plug-in de documentation, mais que vous avez des fichiers HTML ou des fichiers texte auxquels vous voulez accéder dans z/OS Explorer, vous pouvez placer les fichiers dans un dossier spécial pour qu'ils puissent être insérés dans l'index de recherche de z/OS Explorer. Lorsque vous exécutez une recherche d'informations d'aide, toutes les correspondances avec votre documentation sont affichées en même temps que les résultats pour z/OS Explorer. Cependant, lorsque vous affichez le sommaire de l'aide, vos documents n'apparaissent pas.

Cette méthode d'intégration des fichiers HTML et fichiers texte est uniquement conçue comme une solution temporaire jusqu'à ce que vous créiez un plug-in de documentation.

Pour inclure vos fichiers HTML ou fichiers texte dans le sommaire de l'aide de z/OS Explorer, procédez comme suit :

  1. Cliquez sur Aide > Gérer la documentation personnalisée dans le menu de plan de travail. Le gestionnaire de fichiers ouvre une fenêtre sur votre bureau électronique qui affiche le contenu du dossier mydocs dans z/OS Explorer.
  2. Copiez les fichiers HTML ou fichiers texte que vous voulez insérer dans z/OS Explorer et coller-les dans le dossier mydocs.
  3. Fermez la fenêtre mydocs.
  4. Cliquez sur Aide > Recréer l'index de recherche dans le menu de plan de travail. Une boîte de dialogue vous demande confirmation. L'opération nécessite le redémarrage de z/OS Explorer.
  5. Cliquez sur OK pour continuer ou cliquez sur Annuler si vous ne voulez pas redémarrer z/OS Explorer pour le moment. Vous devez exécuter l'étape de recréation pour les fichiers à insérer dans la recherche de l'aide.

Lorsque z/OS Explorer redémarre, toute recherche dans l'aide que vous effectuez recherche désormais dans votre propre documentation en plus de celle de z/OS Explorer. Tous les résultats trouvés dans votre propre documentation sont indiqués avant les résultats trouvés dans la documentation de z/OS Explorer.

Remarque : lorsque des résultats de recherche sont trouvés dans des fichiers HTML, le nom de fichier figurant entre les balises <Title></Title> s'affiche. Cependant, les fichiers texte ne comportent pas de balises de titre. C'est pourquoi les résultats des fichiers texte affichent le chemin comme le montre cette capture d'écran Capture d'écran de résultats montrant les résultats de la recherche dans la documentation propre au client en tête des résultats. Les deux premiers résultats ont de véritables titres parce qu'ils proviennent de fichiers HTML. Les 3 résultats suivants affichent les chemins, car ils proviennent de fichiers texte..

Rubrique parent :