Advanced Features

7.3.4.1. Opening Specific Documents

7.3.4.1.1. Opening Documents from the File Manager

To open a document, such as an XML file, from the file manager, open the document in Nautilus File Manager, or drag the icon from Nautilus to the Yelp document pane or launcher.

7.3.4.1.2. Using the Command Line to Open Documents

Yelp Help Browser supports opening documents from the command line. There are a number of URIs (Uniform Resource Identifiers) that can be used. These include:

file:

Use this URI when you want to access a file with yelp, for example:

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

Use this URI when you want to access GNOME help documents, which are typically written in DocBook format.

yelp ghelp:gcalctool

If you want to open the help document at a particular section, append a question mark to the end of the URI, followed by the section id.

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

Use this URI when you want to access a particular man page. You can append the section of the man page you would like to view if there are multiple man pages with the same name. The section number should be enclosed in parenthesis and therefore it may be necessary to escape the argument so that the shell does not interpret the parenthesis.

yelp man:gcalctool

or

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

Use this URI when you want to access a particular GNU info page.

yelp info:make

7.3.4.2. Refreshing Content on Demand

Yelp Help Browser supports the Ctrl+R shortcut keys, which will reload the DocBook document that is currently open. This allows developers to view changes to documents as they are made.