Go to main content

Oracle® Solaris 11.3 Desktop User's Guide

Exit Print View

Updated: April 2020
 
 

Working With Yelp

You can use Yelp to perform the following actions:

  • Open documents

  • Search documents

  • View the About the Document page of a document

  • Print a page or a document

  • Set preferences to work with the documents

  • Add and edit bookmarks

How to Open a Document Through the GUI

  • Open a document through the Yelp Help Browser in of the following ways:
    • In an application, choose Help → Contents and use the Table of Contents to navigate to the desired document.
    • Drag a Docbook XML file from the file manager to the Yelp window or launcher.
    • Press F1.

    Tip  - To reload the DocBook document that is currently open, press Ctrl+R. This key combination allows you to view changes to documents as they are made.

Searching Documents

This section describes how to search for documents.

How to Search in a Current Page

  1. Choose Edit → Find or press Ctrl+F.

    The search bar appears at the bottom of the window.

  2. In the Find field on the search bar, type the word or phrase that you want to search, and then press Return.

    If the word or phrase is found on the page, the first occurrence is highlighted. Press Return again to highlight the next occurrence.

  3. (Optional)Click Close on the search bar to close it.

How to Search Indexed Documents

  1. Click the Search field on the toolbar or Press Alt+S.
  2. Type the word or phrase that you want to search, and then press Return.

    A list of all the matching documents is shown in which the word or phrase is found.

  3. Click the document name to view a matching page.

    After viewing a matching page, click the Back button on the toolbar to return to the list of search results.

How to Open a New Window

  1. Click File → New Window.
  2. Press Ctrl+N.

How to Display Information About a DocBook Document

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

  • Choose File → About This Document to view the information about the currently open document.

How to Print the Current Page

  • Choose File → Print this Page to print the page that you are currently viewing.

How to Print a Docbook Document

This option is only available for DocBook documentation.

  • Click File → Print this Document to print an entire document.

How to Close a Window

  • You can close a window in any one of the following ways:
    • Choose File → Close Window.
    • Press Ctrl+W

How to Set Preferences

  • Choose Edit → Preferences.

    The following options are available in this Preferences dialog:

    • Use system fonts – Displays documentation using the default fonts used by the Oracle Solaris Desktop. To choose your own fonts to display documentation, deselect this option and click the buttons next to the Variable Width or Fixed Width.

    • Variable Width – Select this font when a static or fixed width font is not required.

    • Fixed Width – Select this font when all text characters need to be of the same size. This font is used to indicate commands, program blocks, or other text that comes under these categories.

    • Browse with caret – Select this option to locate the cursor while browsing the document.

How to Add a Bookmark

  1. Choose Bookmarks → Add Bookmark or press Ctrl+D.

    The Add Bookmark window is displayed.

  2. Type a desired bookmark title in the Title field.
  3. Click Add to add the bookmark.

How to Edit Bookmarks

  1. Choose Bookmarks → Edit Bookmarks or press Ctrl+B.

    The Bookmarks window is displayed. It provides the following options:

    • Open – Opens the selected bookmark in a new window.

    • Rename – Renames the title of a bookmark.

    • Remove – Deletes the bookmark from the collection.

  2. Click Close to exit the Bookmarks window.

How to Display Help

  • Choose Help → Contents to view the online help for the Yelp Help Browser.