Présentation du navigateur d'aide Yelp

L'application Yelp Help Browser (Navigateur d'aide Yelp) permet de consulter la documentation de GNOME et d'autres composants dans des formats divers. Ces formats comprennent les fichiers docbook, les pages d'aide HTML, les pages de manuel et les pages info (la prise en charge des pages de manuel et des pages info est une option à la compilation). En dépit des différents formats pris en charge, Yelp fait tout son possible pour présenter une apparence la plus cohérente possible quel que soit le format du document original.

Le navigateur d'aide Yelp est internationalisé, ce qui signifie qu'il prend en charge l'affichage de documents dans différentes langues. Les documents doivent bien sûr être traduits pour chaque langue et installés correctement pour que le navigateur d'aide Yelp soit capable de les afficher.

Le navigateur d'aide Yelp peut être lancé de différentes manières :

• Choisissez System (Système) → Help (Aide).

• Saisissez yelp dans la ligne de commande.

Interface de Yelp Help Browser (Navigateur d'aide Yelp)

Le volet du navigateur affiche la table des matières de la documentation. Cette table des matières vous permet d'accéder à la documentation recherchée.

Le navigateur d'aide Yelp contient les éléments décrits dans le tableau suivant.

Menubar (Barre de menus)

File (Fichier)

Ce menu permet d'ouvrir une nouvelle fenêtre, de voir la page "A propos de ce document", d'imprimer le document actuel ou de fermer la fenêtre.

Edit (Edition)

Ce menu permet de copier, de tout sélectionner, de rechercher ou de définir les préférences.

Go (Aller à)

Ce menu permet de se rendre à la page suivante ou précédente et d'afficher le sommaire de l'aide. Si vous consultez un document docbook, ce menu permet de passer à la section suivante ou précédente et d'afficher le sommaire.

Bookmarks (Signets)

Ce menu permet d'ajouter ou de modifier des signets.

Help (Aide)

Ce menu permet d'afficher des informations au sujet du navigateur d'aide Yelp et des contributeurs de ce projet par l'élément de menu About (A propos). Ouvrez le présent document avec l'élément de menu Contents (Sommaire) ou en appuyant sur F1.

Barre d'outils

Back (Précédent)

Revenir en arrière dans l'historique de navigation du document.

Forward (Avancer)

Avancer dans l'historique de navigation du document.

Home (Début doc.)

Revenir à la table des matières principale.

Search (Recherche)

Rechercher un mot ou une phrase dans tous les documents d'aide du bureau.

Utilisation de Yelp

Yelp permet d'effectuer les opérations suivantes :

• Ouvrir des documents

• Effectuer une recherche dans des documents

• Afficher la page About the Document (A propos de ce document) d'un document

• Imprimer une page ou un document

• Définir des préférences pour la consultation des documents

• Ajouter et modifier des signets

Ouverture d'un document par le biais de l'interface utilisateur

• Procédez de l'une des manières suivantes pour ouvrir un document dans le navigateur d'aide Yelp :
  • Dans une application, choisissez Help (Aide) → Contents (Sommaire) et accédez au document souhaité via le sommaire.
  • Faites glisser un fichier XML Docbook depuis le gestionnaire de fichiers vers la fenêtre ou le lanceur d'application de Yelp.
  • Appuyez sur la touche F1.

  ---

  Astuce - Pour recharger le document DocBook actuellement ouvert, appuyez sur Ctrl +R. Cette combinaison de touches vous permet de visualiser les modifications apportées à un document au fur et à mesure de leur saisie.

  ---

Recherche dans des documents

Cette section indique comment rechercher des documents.

Recherche dans une page en cours

1. Choisissez Edit (Edition) → Find (Rechercher) ou appuyez sur Ctrl+F.

   La barre de recherche s'affiche en bas de la fenêtre.

2. Entrez le mot ou phrase à rechercher dans le champ Recherche de la barre de recherche, puis appuyez sur Entrée.

   Si le mot ou la phrase est trouvé sur la page, sa première occurrence est mise en surbrillance. Appuyez à nouveau sur la touche Entrée pour mettre en surbrillance l'occurrence suivante.

3. (Facultatif) Cliquez sur Close (Fermer) dans la barre de recherche pour la fermer.

Recherche dans des documents indexés

1. Cliquez sur le champ Search (Recherche) de la barre d'outils ou appuyez sur Alt+ S.
2. Saisissez le mot ou la phrase à recherche, puis appuyez sur la touche Entrée.

   La liste de tous les documents dans lesquels le mot ou la phrase ont été trouvés s'affiche.

3. Cliquez sur le nom d'un document pour afficher une page présentant la correspondance.

   Après avoir affiché une page présentant la correspondance, cliquez sur le bouton Back (Précédent) dans la barre d'outils pour revenir à la liste des résultats de la recherche.

Ouverture d'une nouvelle fenêtre

1. Cliquez sur File (Fichier) → New Window (Nouvelle fenêtre).
2. Appuyez sur Ctrl+N.

Affichage d'informations sur un document DocBook

Cette option n'est disponible que pour la documentation DocBook. Les notices légales et les contributeurs de la documentation sont visibles dans cette section.

• Choisissez File (Fichier) → About This Document (A propos de ce document) pour visualiser les informations relatives au document actuellement ouvert.

Impression de la page en cours

• Choisissez File (Fichier) → Print this Page (Imprimer cette page) pour imprimer la page que vous êtes en train de visualiser.

Impression d'un document Docbook

Cette option n'est disponible que pour la documentation DocBook.

• Click File (Fichier) → Print this Document (Imprimer ce document) pour imprimer l'ensemble du document.

Fermeture d'une fenêtre

• Vous pouvez fermer une fenêtre de l'une des manières suivantes :
  • Choisissez File (Fichier) → Close Window (Fermer la fenêtre).
  • Appuyez sur Ctrl+W

Configuration des préférences

• Choisissez Edit (Edition) → Preferences (Préférences).

  Les options suivantes sont disponibles dans la boîte de dialogue Préférences (Préférences) :

  • Use system fonts (Utiliser les polices système) : affiche la documentation avec les polices par défaut définies pour le bureau Oracle Solaris. Pour choisir vos propres polices d'affichage de la documentation, décochez cette option et cliquez sur les boutons en regard des libellés Variable Width (Chasse variable) et Fixed Width (Chasse fixe).

  • Variable Width (Chasse variable) : sélectionnez cette police lorsqu'une chasse statique ou fixe n'est pas nécessaire.

  • Fixed Width (Chasse fixe) : sélectionnez cette police lorsque tous les caractères doivent avoir la même dimension. En général, cette police sert à écrire des commandes, des bouts de programme ou d'autres textes similaires.

  • Browse with caret (Naviguer avec le curseur) : sélectionnez cette option pour voir le curseur lorsque vous parcourez le document.

Ajout d'un signet

1. Choisissez Bookmarks (Signets) → Add Bookmark (Ajouter un signet) ou appuyez sur Ctrl+ D.

   La fenêtre Add Bookmark (Ajouter un signet) s'affiche.

2. Saisissez le titre du signet dans le champ Title (Titre).
3. Cliquez sur Add (Ajouter) pour ajouter le signet.

Edition des signets

1. Choisissez Bookmarks (Signets) → Edit Bookmarks (Editer les signets) ou appuyez sur Ctrl+ B.

   La fenêtre Bookmarks (Signets) s'affiche. Elle offre les options suivantes :

   • Open (Ouvrir) : ouvre le signet sélectionné dans une nouvelle fenêtre.

   • Rename (Renommer) : permet de renommer un signet.

   • Remove (Enlever) : permet de supprimer le signet de la collection.

2. Cliquez sur le bouton Close (Fermer) pour sortir de la fenêtre d'édition des signets.

Affichage de l'aide

• Choisissez Help (Aide) → Contents (Sommaire) pour afficher l'aide en ligne du navigateur d'aide Yelp.

Déplacement dans Yelp Help Browser (Navigateur d'aide Yelp)

Vous pouvez vous déplacer dans le navigateur d'aide Yelp de la manière suivante :

• Pour remonter dans l'historique de navigation du document :

  • Choisissez Go (Aller à) → Back (Précédent).

  • Appuyez sur Alt+Flèche gauche.

  • Utilisez le bouton Back (Précédent) dans la barre d'outils.

• Pour avancer dans l'historique de navigation du document :

  • Choisissez Go (Aller à) → Forward (Suivant).

  • Appuyez sur Alt+Flèche droite.

  • Utilisez le bouton Forward (Suivant) dans la barre d'outils.

• Pour afficher le sommaire de l'aide :

  • Choisissez Go(Aller à) → Help Topics (Sommaire de l'aide).

  • Appuyez sur Alt+Origine.

  • Utilisez le bouton Help Topics (Sommaire de l'aide) dans la barre d'outils.

• Pour retourner à la section précédente :

  • Choisissez Go (Aller à) → Previous Section (Section précédente).

  • Appuyez sur Alt+Flèche haut

• Pour aller à la section suivante :

  • Choisissez Go (Aller à) → Next Section (Section suivante).

  • Appuyez sur Alt+Flèche bas

Ouverture de documents à partir de la ligne de commande

Le navigateur d'aide Yelp prend en charge l'ouverture de documents à partir de la ligne de commande. Plusieurs URI (Uniform Resource Identifiers) peuvent être utilisés, notamment les suivantes :

-file:

Donne accès à un fichier avec yelp, par exemple :

yelp file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml

-ghelp: ou -gnome-help:

Donne accès aux documents d'aide de GNOME, écrits au format DocBook.

yelp ghelp:gcalctool

Si vous souhaitez ouvrir le document d'aide à une section bien précise, complétez l'URI avec un point d'interrogation suivi de l'identifiant de la section.

yelp ghelp:user-guide?yelp-advanced-cmdline

-man:

Donne accès à une page de manuel particulière. Vous pouvez compléter l'URI avec le numéro de section de la page de manuel souhaitée s'il en existe plusieurs avec le même nom. Le numéro de section doit être entouré de parenthèses, il est donc souhaitable de neutraliser l'argument afin que le shell n'interprète pas les parenthèses.

yelp man:gcalctool

ou

yelp 'man:intro(1)'
yelp 'man:intro(2)'

-info:

Donne accès à la page info GNU indiquée.

yelp info:make