Überblick über den Yelp-Hilfebrowser

Der Yelp-Hilfebrowser ermöglicht Ihnen, die Dokumentation zu GNOME und anderer Komponenten in einer Vielzahl von Formaten anzuzeigen. Zu diesen Formaten gehören docbook-Dateien, HTML-Hilfeseiten, Manpages und Infoseiten (die Unterstützung für Manpages und Infoseiten muss optional bei der Kompilierung von Yelp angegeben werden). Mit Yelp soll, unabhängig vom zugrunde liegenden Dokumentformat, eine einheitliche Ansicht erreicht werden.

Da der Yelp-Hilfebrowser internationalisiert ist, können Dokumente in verschiedenen Sprachen angezeigt werden. Die Dokumente müssen zunächst lokalisiert bzw. übersetzt und so abgespeichert werden, dass der Yelp-Hilfebrowser sie anzeigen kann.

Zum Starten des Yelp-Hilfebrowser haben Sie folgende Möglichkeiten:

• Wählen Sie "System → Hilfe".

• Geben Sie in die Befehlszeile yelp ein.

Benutzeroberfläche des Yelp-Hilfebrowsers

In der Verwaltungsleiste wird das Inhaltsverzeichnis oder die Dokumentation angezeigt. Navigieren Sie mithilfe des Inhaltsverzeichnisses zur gewünschten Dokumentation.

Der Yelp-Hilfebrowser enthält die in folgender Tabelle beschriebenen Elemente.

Menüleiste

Datei

Verwenden Sie dieses Menü, um ein neues Fenster zu öffnen, die Seite "About this Document (Informationen über dieses Dokument)" anzuzeigen, das aktuelle Dokument zu drucken oder das Fenster zu schließen.

Bearbeiten

Verwenden sie dieses Menü zum Kopieren, Auswählen, Suchen oder zum Festlegen von Einstellungen.

Gehe zu

Verwenden Sie dieses Menü, um durch die Hilfethemenseiten zu navigieren. Wenn Sie ein docbook-Dokument betrachten, können Sie auf diese Weise zum nächsten Abschnitt, zum vorherigen Abschnitt oder zum Inhaltsverzeichnis springen.

Lesezeichen

Verwenden Sie dieses Menü, um Lesezeichen hinzuzufügen oder diese zu bearbeiten.

Hilfe

Zeigen Sie die Informationen zum Yelp-Hilfebrowser und den Mitwirkenden am Projekt über den Menüeintrag "About (Info)" an. Rufen Sie dieses Dokument über den Menüeintrag "Contents (Inhalt)" oder durch Drücken von F1 auf.

Werkzeugleiste

Zurück

Navigieren Sie in der Dokumentenhistorie zurück.

Vor

Navigieren Sie in der Dokumentenhistorie nach vorne.

Persönlicher Ordner

Sie kehren zum Hauptinhaltsverzeichnis zurück.

Suchen

Durchsuchen Sie alle Desktop-Hilfedokumente nach einem bestimmten Wort oder Ausdruck.

Mit Yelp arbeiten

Sie können mit Yelp folgende Aktionen durchführen:

• Dokumente öffnen

• Dokumente suchen

• Seite "About this Document (Informationen über dieses Dokument)" eines Dokuments anzeigen

• Seite oder Dokument drucken

• Legen Sie Einstellungen fest, um mit den Dokumenten zu arbeiten

• Lesezeichen hinzufügen und bearbeiten

So öffnen Sie ein Dokument über die GUI

• Sie haben zum Öffnen eines Dokuments über den Yelp-Hilfebrowser folgende Möglichkeiten:
  • Wählen Sie in einer Anwendung "Hilfe → Inhalt", und rufen Sie das gewünschte Dokument über das Inhaltsverzeichnis auf.
  • Ziehen Sie eine DocBook-XML-Datei vom Dateimanager in das Yelp-Fenster oder den Anwendungsstarter.
  • Drücken Sie F1.

  ---

  Tipp - Um das aktuell geöffnete DocBook-Dokument zu aktualisieren, drücken Sie Strg+R. Mithilfe dieser Tastenkombination können Sie Änderungen an Dokumenten sofort anzeigen.

  ---

Nach Dokumenten suchen

In diesem Abschnitt wird die Suche nach Dokumenten beschrieben.

So suchen Sie auf einer aktuellen Seite

1. Wählen Sie "Edit → Find (Bearbeiten → Suchen)", oder drücken Sie Strg+F.

   Die Suchleiste wird unten im Fenster angezeigt.

2. Geben Sie in der Suchleiste im Suchfeld das Wort oder den Ausdruck ein, nach dem Sie suchen möchten, und drücken Sie dann die Eingabetaste.

   Wenn das Wort oder der Ausdruck auf der Seite gefunden wurde, wird der erste Treffer hervorgehoben. Drücken Sie die Eingabetaste erneut, um den nächsten Treffer hervorzuheben.

3. (Optional) Klicken Sie zum Schließen der Suchleiste auf "Schließen".

So suchen Sie nach indizierten Dokumenten

1. Klicken Sie in der Werkzeugleiste auf das Suchfeld, oder drücken Sie Alt+S.
2. Geben Sie das Wort oder den Ausdruck ein, nach dem Sie suchen möchten, und drücken Sie dann die Eingabetaste.

   Eine Liste aller Dokumente, in denen das Wort oder der Ausdruck gefunden wurde, wird angezeigt.

3. Klicken Sie auf den Dokumentnamen, um eine entsprechende Seite anzuzeigen.

   Nachdem eine entsprechende Seite angezeigt wurde, klicken Sie in der Werkzeugleiste auf den Knopf "Back (Zurück)", um zur Liste mit den Suchergebnissen zurückzukehren.

So öffnen Sie ein neues Fenster

1. Klicken Sie auf "File → New Window (Datei → Neues Fenster)".
2. Drücken Sie Strg+N.

So zeigen Sie Informationen zu einem DocBook-Dokument an

Diese Option ist nur für die DocBook-Dokumentation verfügbar. Rechtliche Hinweise und Mitwirkende an der Dokumentation werden in diesem Abschnitt aufgeführt.

• Wählen Sie "File → About This Document (Datei → Informationen über dieses Dokument)", um Informationen zu dem aktuell geöffneten Dokument anzuzeigen.

So drucken Sie die aktuelle Seite

• Wählen Sie "File → Print this Page (Datei → Diese Seite drucken)", um die gerade angezeigte Seite zu drucken.

So drucken Sie ein DocBook-Dokument

Diese Option ist nur für die DocBook-Dokumentation verfügbar.

• Wählen Sie "Datei → Dieses Dokument drucken", um das gesamte Dokument zu drucken.

So schließen Sie ein Fenster

• Ihnen stehen zum Schließen eines Fensters folgende Möglichkeiten zur Verfügung:
  • Wählen Sie "Datei → Fenster schließen".
  • Drücken Sie Strg+W.

So legen Sie Einstellungen fest

• Wählen Sie "Bearbeiten → Einstellungen".

  Die folgenden Optionen sind im Dialog "Einstellungen" verfügbar:

  • Use system fonts (Systemschriften verwenden) – Zeigt die Dokumentation mithilfe der Standardschriften des Oracle Solaris-Desktops an. Um eigene Schriften für die Anzeige von Dokumentation auszuwählen, deaktivieren Sie die Option, und klicken Sie auf den Knopf "Variable Width (Variable Breite)" bzw. "Fixed Width (Feste Breite)".

  • Variable Breite – Wählen Sie diese Schrift, wenn eine Schrift mit statischer oder fester Breite nicht notwendig ist.

  • Feste Breite – Wählen Sie diese Schrift, wenn alle Zeichen gleich groß sein müssen. Eine solche Schrift wird zur Kennzeichnung von Befehlen, Programmcodeblöcken oder anderen Texten verwendet, die unter diese Kategorien fallen.

  • Mit Textcursor navigieren – Wählen Sie diese Option, wenn Sie einen Cursor im Dokument anzeigen lassen möchten, während Sie das Dokument durchsuchen.

So fügen Sie ein Lesezeichen hinzu

1. Wählen Sie "Bookmarks → Add Bookmark (Lesezeichen" → "Lesezeichen hinzufügen)", oder drücken Sie Strg+D.

   Das Fenster "Add Bookmark (Lesezeichen hinzufügen)" wird angezeigt.

2. Geben Sie den gewünschten Lesezeichentitel im Feld "Titel" ein.
3. Klicken Sie auf "Hinzufügen", um das Lesezeichen hinzuzufügen.

So bearbeiten Sie Lesezeichen

1. Wählen Sie "Bookmarks → Edit Bookmarks (Lesezeichen" → "Lesezeichen bearbeiten)", oder drücken Sie Strg+B.

   Das Fenster "Bookmarks (Lesezeichen)" wird angezeigt. Es umfasst die folgenden Optionen:

   • Öffnen – Das ausgewählte Lesezeichen wird in einem neuen Fenster angezeigt.

   • Umbenennen – Ändert den Titel eines Lesezeichens.

   • Entfernen – Entfernt das Lesezeichen aus der Sammlung.

2. Klicken Sie auf "Schließen", um das Lesezeichenfenster zu schließen.

So zeigen Sie die Hilfe an

• Wählen Sie "Help → Contents (Hilfe → Inhalte)", um die Onlinehilfe zum Yelp-Hilfebrowser anzuzeigen.

Durch den Yelp-Hilfebrowser navigieren

Sie können durch den Yelp-Hilfebrowser wie folgt navigieren:

• So navigieren Sie in der Dokumentenhistorie zurück

  • Wählen Sie "Go → Back (Gehe zu → Zurück)".

  • Drücken Sie Alt+Pfeiltaste nach links.

  • Verwenden Sie den Knopf "Back (Zurück)" in der Werkzeugleiste.

• So navigieren Sie in der Dokumentenhistorie nach vorne

  • Wählen Sie "Go → Forward (Gehe zu → Vor)".

  • Drücken Sie Alt+Pfeiltaste nach rechts.

  • Verwenden Sie den Knopf "Forward (Vorwärts)" in der Werkzeugleiste.

• So navigieren Sie zu den Hilfethemen

  • Wählen Sie "Go → Help Topics (Gehe zu → Hilfe-Themen)".

  • Drücken Sie Alt+Pos1.

  • Verwenden Sie den Knopf "Help Topics (Hilfe-Themen)" in der Werkzeugleiste.

• So gehen Sie zum vorherigen Abschnitt

  • Wählen Sie "Go → Previous Section (Gehe zu → Vorheriger Abschnitt)".

  • Drücken Sie Alt+Bild auf.

• So gehen Sie zum nächsten Abschnitt

  • Wählen Sie "Go → Next Section (Gehe zu → Nächster Abschnitt)".

  • Drücken Sie Alt+Bild ab.

Dokumente von der Befehlszeile aus öffnen

Der Yelp-Hilfebrowser unterstützt das Öffnen von Dokumenten von der Befehlszeile aus. Unter anderem können folgende URIs (Uniform Resource Identifiers) verwendet werden:

-file:

Greift über Yelp auf eine Datei zu. Beispiel:

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

-ghelp: oder -gnome-help:

Greift auf GNOME-Hilfedokumente mit DocBook-Format zu.

yelp ghelp:gcalctool

Wenn Sie das Hilfedokument in einem bestimmten Abschnitt öffnen möchten, fügen Sie ein Fragezeichen am Ende des URI hinzu, und dann die Abschnitts-ID.

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

-man:

Greift auf eine bestimmte Manpage zu. Wenn mehrere Manpages mit demselben Namen vorhanden sind, können Sie den Manpage-Abschnitt anhängen, den Sie anzeigen möchten. Die Abschnittsnummer muss in Klammern eingeschlossen werden, um das Argument auszuschließen, sodass die Shell die Klammer nicht interpretiert.

yelp man:gcalctool

oder

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

-info:

Greift auf die angegebene GNU-Infoseite zu.

yelp info:make