GNOME.ORG

Using Yelp

7.3.3.1. Open a Document

To open a document in Yelp Help Browser:

  • In an application, click Help ▸ Contents
  • Use the Table of Contents to navigate to the desired document.
  • You can drag a Docbook XML file from Nautilus to the Yelp window or launcher.
  • Press the F1 key.

Alternatively, you may view a particular document by invoking Yelp Help Browser from the command line or dragging files to Yelp. See Opening Specific Documents for more on this.

7.3.3.2. Open a New Window

To open a new window:

  • Click File ▸ New Window
  • Use the key combination Ctrl+N

7.3.3.3. About This Document

To view information about the currently open document:

  • Click File ▸ About This Document

This option is only available for DocBook documentation. Legal notices and documentation contributors are usually listed in this section.

7.3.3.4. Print a Page

To print any page that you are able to view in Yelp Help Browser:

  • Click File ▸ Print this Page

7.3.3.5. Print a Document

To print an entire document:

  • Click File ▸ Print this Document

This option is only available for DocBook documentation.

7.3.3.6. Close a Window

To close a window in Yelp Help Browser, do the following:

  • Click File ▸ Close Window
  • Use the key combination Ctrl+W

7.3.3.7. Set Preferences

To set your preferences in Yelp Help Browser:

  • Click Edit ▸ Preferences
A window will appear that looks like Figure 7-2:

Figure 7-2 Yelp Help Browser Preferences Window
The options that are available in this dialog have the following functions:

Use system fonts

Check this option to display documentation using the default fonts used by the GNOME Desktop.

To choose your own fonts to display documentation, uncheck this option and click on the buttons next to the text Variable Width or Fixed Width.

Variable Width

This is the font to use when a static or fixed width font is not required. The majority of text will be of this type.

Fixed Width

This is the font to use when all text characters need to be of the same size. This font is usually used to indicate commands, program blocks, or other text that falls under these categories.

Browse with caret

Click this option if you would like see a caret or cursor in the Yelp Browser Pane. This allows you to browse the document more easily by showing where the cursor is located in the document.

7.3.3.8. Go Back in Document History

To go back in the document history:

  • Click Go ▸ Back
  • Use the key combination Alt+Left
  • Use the Back button in the Toolbar

7.3.3.9. Go Forward in Document History

To go forward in the document history:

  • Click Go ▸ Forward
  • Use the key combination Alt+Right
  • Use the Forward button in the Toolbar

7.3.3.10. Go to Help Topics

To go to the Help Topics:

  • Click Go ▸ Help Topics
  • Use the key combination Alt+Home
  • Use the Help Topics button in the Toolbar

7.3.3.11. Go to Previous Section

To go to the previous section:

  • Click Go ▸ Previous Section
  • Use the key combination Alt+Up

This option is only available in DocBook formatted documents.

7.3.3.12. Go to Next Section

To go to the next section:

  • Click Go ▸ Next Section
  • Use the key combination Alt+Down

This option is only available in DocBook formatted documents.

7.3.3.13. Go to Contents

To go to the contents for a document:

  • Click Go ▸ Contents

This option is only available in DocBook formatted documents.

7.3.3.14. Add a Bookmark

To add a bookmark for a particular document:

  • Click Bookmarks ▸ Add Bookmark
  • Use the key combination Ctrl+D
A window will appear that looks like Figure 7-3.

Figure 7-3 Add Bookmark Window
Enter your desired bookmark title in to the Title text entry field. Then click Add to add the bookmark, or click Cancel to cancel the request.

7.3.3.15. Edit Bookmarks

To edit your collection of bookmarks:

  • Click Bookmarks ▸ Edit Bookmarks...
  • Use the key combination Ctrl+B
A window will appear that looks like Figure 7-4.

Figure 7-4 Edit Bookmarks Window
You can manage your bookmarks using this window in the following ways:

Open

Use this button to open the selected bookmark in a new window.

Rename

Use this button to rename the title of your bookmark.

Remove

Use this button to delete the bookmark from your collection.

Once you are finished managing your bookmarks, click the Close button to exit the Edit Bookmarks Window.

7.3.3.16. Get Help

To get help using Yelp Help Browser (and see this document):

  • Click Help ▸ Contents

Starting Yelp Advanced Features