Yelp Help documents
- From: Brent Smith <gnome nextreality net>
- To: gnome-doc-devel-list gnome org, gnome-doc-list gnome org
- Cc:
- Subject: Yelp Help documents
- Date: Wed, 11 Jan 2006 23:44:12 -0700
I've written a manual for Yelp that uses gnome-doc-utils.
Please let me know if it works for you and if you think
certain sections need addressed or additional topics need
added.
Apply the attached patch, and then
mkdir yelp/help/C/figures/
and copy the figures there. You can find the figures at
http://www.nextreality.net/~smitten/yelp-figures/
This should do the trick:
wget
http://www.nextreality.net/~smitten/yelp-figures/{yelp_add_bookmark.png,yelp_edit_bookmarks.png,yelp_preferences.png,yelp_window.png}
I've also attached the docbook file and the legal stuff
if you don't want to apply the patch against CVS HEAD yelp.
I'd like to commit this to HEAD soon.
Thanks,
--
Brent Smith <gnome nextreality net>
IRC: smitten
diff -ruN yelp-head3/configure.in yelp-head2/configure.in
--- yelp-head3/configure.in 2006-01-06 18:23:52.000000000 -0700
+++ yelp-head2/configure.in 2006-01-11 22:36:07.000000000 -0700
@@ -16,6 +16,8 @@
AM_GCONF_SOURCE_2
+GNOME_DOC_INIT
+
AC_PROG_LN_S
AC_PROG_CC
AC_PROG_CXX
@@ -241,6 +243,7 @@
data/Makefile
data/icons/Makefile
data/ui/Makefile
+help/Makefile
po/Makefile.in
yelp.desktop.in
])
diff -ruN yelp-head3/.cvsignore yelp-head2/.cvsignore
--- yelp-head3/.cvsignore 2005-07-13 16:00:12.000000000 -0600
+++ yelp-head2/.cvsignore 2006-01-11 22:36:07.000000000 -0700
@@ -24,3 +24,4 @@
autom4te*
yelp.desktop.in
INSTALL
+gnome-doc-utils.make
diff -ruN yelp-head3/help/C/legalgpl.xml yelp-head2/help/C/legalgpl.xml
--- yelp-head3/help/C/legalgpl.xml 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/C/legalgpl.xml 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1,69 @@
+ <legalnotice id="legalnotice">
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the GNU General Public License
+ (GPL), Version 2 or any later version published
+ by the Free Software Foundation. You can find
+ a copy of the GPL at this <ulink type="help"
+ url="http://www.gnu.org/licenses/gpl.html";>link</ulink> or
+ in the file COPYING-DOCS distributed with this manual.
+ </para>
+
+ <para>
+ Many of the names used by companies to distinguish their
+ products and services are claimed as trademarks. Where those
+ names appear in any GNOME documentation, and the members of
+ the GNOME Documentation Project are made aware of those
+ trademarks, then the names are in capital letters or initial
+ capital letters.
+ </para>
+
+ <para>
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
+ UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE
+ WITH THE FURTHER UNDERSTANDING THAT:
+
+ <orderedlist>
+ <listitem>
+ <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
+ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
+ IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
+ THAT THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
+ A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
+ RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
+ OF THE DOCUMENT OR MODIFIED VERSION OF THE
+ DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
+ MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
+ YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
+ CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
+ SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
+ OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
+ LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
+ VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
+ EXCEPT UNDER THIS DISCLAIMER; AND
+ </para>
+ </listitem>
+ <listitem>
+ <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
+ THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
+ CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
+ INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
+ DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
+ OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
+ PARTIES, BE LIABLE TO ANY PERSON FOR ANY
+ DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
+ CONSEQUENTIAL DAMAGES OF ANY CHARACTER
+ INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
+ OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
+ MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
+ LOSSES ARISING OUT OF OR RELATING TO USE OF THE
+ DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
+ EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
+ THE POSSIBILITY OF SUCH DAMAGES.
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ </legalnotice>
+
diff -ruN yelp-head3/help/C/yelp.xml yelp-head2/help/C/yelp.xml
--- yelp-head3/help/C/yelp.xml 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/C/yelp.xml 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1,881 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY manrevision "2.14">
+<!ENTITY appversion "2.14">
+<!ENTITY date "January 2006">
+<!ENTITY app "Yelp Help Browser">
+
+<!ENTITY legal SYSTEM "legalgpl.xml">
+]>
+<!--
+ (Do not remove this comment block.)
+ Maintained by the GNOME Documentation Project
+ http://developer.gnome.org/projects/gdp
+ Template version: 2.0 beta
+ Template last modified Mar 12, 2002
+-->
+<article id="index" lang="en">
+ <!-- please do not change the id; for translations, change lang to -->
+
+ <!-- appropriate code -->
+
+ <articleinfo>
+ <title>&app; Manual</title>
+
+ <abstract role="description">
+ <para>&app; is a documentation viewer for GNOME. You can
+ view a number of different type of help documents including docbook
+ files, HTML help, man pages and info pages (if enabled).</para>
+ </abstract>
+
+ <copyright>
+ <year>2005</year>
+
+ <holder>Brent Smith</holder>
+ </copyright>
+
+ <!-- translators: uncomment this:
+
+ <copyright>
+ <year>2005</year>
+ <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+ </copyright>
+
+ -->
+
+ <publisher>
+ <publishername>GNOME Documentation Project</publishername>
+ </publisher>
+
+ &legal;
+
+ <authorgroup>
+ <author>
+ <firstname>Brent</firstname>
+
+ <surname>Smith</surname>
+
+ <affiliation>
+ <orgname>GNOME Documentation Project</orgname>
+
+ <address> <email>gnome nextreality net</email> </address>
+ </affiliation>
+ </author>
+
+ <!-- This is appropriate place for other contributors: translators,
+ maintainers, etc. Commented out by default.
+ <othercredit role="translator">
+ <firstname>Latin</firstname>
+ <surname>Translator 1</surname>
+ <affiliation>
+ <orgname>Latin Translation Team</orgname>
+ <address> <email>translator gnome org</email> </address>
+ </affiliation>
+ <contrib>Latin translation</contrib>
+ </othercredit>
+-->
+ </authorgroup>
+
+ <revhistory>
+ <revision>
+ <revnumber>Version 2.14</revnumber>
+
+ <date>January 2006</date>
+
+ <revdescription>
+ <para role="author">GNOME Documentation Team</para>
+
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ </revhistory>
+
+ <releaseinfo>This manual describes version 2.14 of Yelp Help
+ Browser.</releaseinfo>
+
+ <legalnotice>
+ <title>Feedback</title>
+
+ <para>To report a bug or make a suggestion regarding &app;
+ or this manual, follow the directions in the <ulink type="help"
+ url="ghelp:gnome-feedback">GNOME Feedback Page</ulink>.</para>
+ </legalnotice>
+ </articleinfo>
+
+ <indexterm>
+ <primary>Yelp</primary>
+ </indexterm>
+
+ <!-- ============= Document Body ============================= -->
+
+ <!-- ============= Introduction ============================== -->
+
+ <sect1 id="yelp-introduction">
+ <title>Introduction</title>
+
+ <para>The &app; application allows you to view documentation
+ regarding GNOME and other components through a variety of formats. These
+ formats include docbook files, HTML help pages, man pages and info pages
+ (support for man pages and info pages may optionally be compiled in).
+ Despite the different formats supported, yelp does its best to provide a
+ unified look and feel regardless of the original document format.</para>
+
+ <para>&app; is internationalised meaning that it has support
+ to view documents in different languages. The documents must be localised
+ or translated for each language and installed properly for Yelp Help
+ Browser to be able to view them.</para>
+ </sect1>
+
+ <!-- ============= Getting Started ================================ -->
+
+ <sect1 id="yelp-getting-started">
+ <title>Getting Started</title>
+
+ <sect2>
+ <title>To Start &app;</title>
+
+ <para>You can start &app; in the following ways:</para>
+
+ <para><variablelist>
+ <varlistentry>
+ <term><guimenu>System</guimenu> Menu</term>
+
+ <listitem>
+ <para>Choose <application>Help</application></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Command Line</term>
+
+ <listitem>
+ <para>Execute the following command:
+ <command>yelp</command></para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </sect2>
+
+ <sect2>
+ <title>Interface</title>
+
+ <para>When you start &app;, you will see the following
+ window appear.</para>
+
+ <para><figure id="fig-yelp-window">
+ <title>&app; Window</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/yelp_window.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>&app; contains the following elements in <xref
+ linkend="fig-yelp-window" /></para>
+
+ <variablelist>
+ <varlistentry>
+ <term><interface>Menubar</interface></term>
+
+ <listitem>
+ <para><variablelist>
+ <varlistentry>
+ <term><guimenu>File</guimenu></term>
+
+ <listitem>
+ <para>Use this menu to Open a New Window, view the About
+ this Document page, Print the current document, or Close
+ the window.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guimenu>Edit</guimenu></term>
+
+ <listitem>
+ <para>Use this menu to Copy, Select all, Find..., or to
+ set your Preferences.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guimenu>Go</guimenu></term>
+
+ <listitem>
+ <para>Use this menu to navigate Back, Forward, to the Help
+ Topics page. When viewing a DocBook document, use this
+ menu to navigate to the Next Section, Previous Section or
+ to the Contents.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guimenu>Bookmarks</guimenu></term>
+
+ <listitem>
+ <para>Use this menu to Add Bookmark(s), or Edit
+ Bookmark(s).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guimenu>Help</guimenu></term>
+
+ <listitem>
+ <para>View information about &app; and
+ contributors to the project through the
+ <guimenuitem>About</guimenuitem> menuitem. Open this
+ document with the <guimenuitem>Contents</guimenuitem>
+ menuitem or by pressing <keycap>F1</keycap>.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><interface>Toolbar</interface></term>
+
+ <listitem>
+ <para><variablelist>
+ <varlistentry>
+ <term><guibutton>Back</guibutton></term>
+
+ <listitem>
+ <para>Use this button to navigate back in your document
+ history.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guibutton>Forward</guibutton></term>
+
+ <listitem>
+ <para>Use this button to navigate forward in your document
+ history.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guibutton>Help Topics</guibutton></term>
+
+ <listitem>
+ <para>Use this button to return to the main table of
+ contents (shown in <xref
+ linkend="fig-yelp-window" />)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry id="yelp-browser-pane" xreflabel="Yelp Browser Pane">
+ <term><interface>Browser Pane</interface></term>
+
+ <listitem>
+ <para>The browser pane is where you will be presented with the
+ table of contents or the documentation. Use the table of contents
+ to navigate to the documentation you need.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ </sect1>
+
+ <!--===================== Usage ========================-->
+
+ <sect1>
+ <title>Usage</title>
+
+ <sect2>
+ <title>Open a Document</title>
+
+ <para>To open a document in &app;, use the Table of Contents
+ to navigate to the desired document</para>
+
+ <para>Alternatively, you may view a particular document by invoking Yelp
+ Help Browser from the command line. Please see <xref
+ linkend="yelp-advanced-cmdline" />.</para>
+ </sect2>
+
+ <sect2>
+ <title>Open a New Window</title>
+
+ <para>To open a new window:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>File</guimenu>
+
+ <guimenuitem>New Window</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Ctrl</keycap>+<keycap>N</keycap></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>About This Document</title>
+
+ <para>To view information about the currently open document:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>File</guimenu>
+
+ <guimenuitem>About This Document</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist><note>
+ <para>This option is only available for DocBook documentation. Legal
+ notices and documentation contributors are usually listed in this
+ section.</para>
+ </note></para>
+ </sect2>
+
+ <sect2>
+ <title>Print a Page</title>
+
+ <para>To print any page that you are able to view in Yelp Help
+ Browser:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>File</guimenu>
+
+ <guimenuitem>Print this Page</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>Print a Document</title>
+
+ <para>To print an entire document:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>File</guimenu>
+
+ <guimenuitem>Print this Document</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist><note>
+ <para>This option is only available for DocBook
+ documentation.</para>
+ </note></para>
+ </sect2>
+
+ <sect2>
+ <title>Close a Window</title>
+
+ <para>To close a window in &app;"</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>File</guimenu>
+
+ <guimenuitem>Close Window</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Ctrl</keycap>+<keycap>W</keycap></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>Set Preferences</title>
+
+ <para>To set your preferences in &app;:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Edit</guimenu>
+
+ <guimenuitem>Preferences</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist>A window will appear that looks like <xref
+ linkend="yelp-preferences" />:</para>
+
+ <para><figure id="yelp-preferences">
+ <title>&app; Preferences Window</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/yelp_preferences.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>The options that are available in this dialog have the
+ following functions:</para>
+
+ <para><variablelist>
+ <varlistentry>
+ <term><guilabel>Use system fonts</guilabel></term>
+
+ <listitem>
+ <para>Check this option to display documentation using the
+ default fonts used by the GNOME Desktop.</para>
+
+ <para>To choose your own fonts to display documentation, uncheck
+ this option and click on the buttons next to the text
+ <guilabel>Variable Width</guilabel> or <guilabel>Fixed
+ Width</guilabel>.</para>
+
+ <para><variablelist>
+ <varlistentry>
+ <term><guilabel>Variable Width</guilabel></term>
+
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guilabel>Fixed Width</guilabel></term>
+
+ <listitem>
+ <para>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.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guilabel>Browse with caret</guilabel></term>
+
+ <listitem>
+ <para>Click this option if you would like see a caret or cursor
+ in the <xref linkend="yelp-browser-pane" />. This allows you to
+ browse the document more easily by showing where the cursor is
+ located in the document.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </sect2>
+
+ <sect2>
+ <title>Go Back in Document History</title>
+
+ <para>To go back in the document history:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Back</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Alt</keycap>+<keycap>Left</keycap></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the <guibutton>Back</guibutton> button in the
+ <interface>Toolbar</interface></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>Go Forward in Document History</title>
+
+ <para>To go forward in the document history:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Forward</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Alt</keycap>+<keycap>Right</keycap></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the <guibutton>Forward</guibutton> button in the
+ <interface>Toolbar</interface></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>Go to Help Topics</title>
+
+ <para>To go to the Help Topics:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Help Topics</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Alt</keycap>+<keycap>Home</keycap></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the <guibutton>Help Topics</guibutton> button in the
+ <interface>Toolbar</interface></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+
+ <sect2>
+ <title>Go to Previous Section</title>
+
+ <para>To go to the previous section:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Previous Section</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Alt</keycap>+<keycap>Up</keycap></para>
+ </listitem>
+ </itemizedlist><note>
+ <para>This option is only available in DocBook formatted
+ documents.</para>
+ </note></para>
+ </sect2>
+
+ <sect2>
+ <title>Go to Next Section</title>
+
+ <para>To go to the next section:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Next Section</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Alt</keycap>+<keycap>Down</keycap></para>
+ </listitem>
+ </itemizedlist><note>
+ <para>This option is only available in DocBook formatted
+ documents.</para>
+ </note></para>
+ </sect2>
+
+ <sect2>
+ <title>Go to Contents</title>
+
+ <para>To go to the contents for a document:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Go</guimenu>
+
+ <guimenuitem>Contents</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist><note>
+ <para>This option is only available in DocBook formatted
+ documents.</para>
+ </note></para>
+ </sect2>
+
+ <sect2>
+ <title>Add a Bookmark</title>
+
+ <para>To add a bookmark for a particular document:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Bookmarks</guimenu>
+
+ <guimenuitem>Add Bookmark</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Ctrl</keycap>+<keycap>D</keycap></para>
+ </listitem>
+ </itemizedlist>A window will appear that looks like <xref
+ linkend="yelp-add-bookmark" />.</para>
+
+ <para><figure id="yelp-add-bookmark">
+ <title>Add Bookmark Window</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/yelp_add_bookmark.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>Enter your desired bookmark title in to the
+ <guilabel>Title</guilabel> text entry field. Then click
+ <guibutton>Add</guibutton> to add the bookmark, or click
+ <guibutton>Cancel</guibutton> to cancel the request.</para>
+ </sect2>
+
+ <sect2>
+ <title>Edit Bookmarks</title>
+
+ <para>To edit your collection of bookmarkst:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Bookmarks</guimenu>
+
+ <guimenuitem>Edit Bookmarks...</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+
+ <listitem>
+ <para>Use the key combination
+ <keycap>Ctrl</keycap>+<keycap>B</keycap></para>
+ </listitem>
+ </itemizedlist>A window will appear that looks like <xref
+ linkend="yelp-edit-bookmarks" />.</para>
+
+ <para><figure id="yelp-edit-bookmarks">
+ <title>Edit Bookmarks Window</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/yelp_edit_bookmarks.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>You can manage your bookmarks using this window in the
+ following ways:</para>
+
+ <para><variablelist>
+ <varlistentry>
+ <term><guibutton>Open</guibutton></term>
+
+ <listitem>
+ <para>Use this button to open the selected bookmark in a new
+ window.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guibutton>Rename</guibutton></term>
+
+ <listitem>
+ <para>Use this button to rename the title of your
+ bookmark.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guibutton>Remove</guibutton></term>
+
+ <listitem>
+ <para>Use this button to delete the bookmark from your
+ collection.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>Once you are finished managing your bookmarks, click
+ the <guibutton>Close</guibutton> button to exit the <interface>Edit
+ Bookmarks Window</interface>.</para>
+ </sect2>
+
+ <sect2>
+ <title>Get Help</title>
+
+ <para>To get help using &app; (and see this
+ document):</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Click <menuchoice>
+ <guimenu>Help</guimenu>
+
+ <guimenuitem>Contents</guimenuitem>
+ </menuchoice></para>
+ </listitem>
+ </itemizedlist></para>
+ </sect2>
+ </sect1>
+
+ <!--=============== Advanced Features ====================-->
+
+ <sect1 id="yelp-advanced">
+ <title>Advanced Features</title>
+
+ <sect2 id="yelp-advanced-cmdline"
+ xreflabel="Using the Command Line to Open Documents">
+ <title>Using the Command Line to Open Documents</title>
+
+ <para>&app; supports opening documents from the command
+ line. There are a number of URIs (Uniform Resource Identifiers) that can
+ be used. These include:</para>
+
+ <para><variablelist>
+ <varlistentry>
+ <term><option>file:</option></term>
+
+ <listitem>
+ <para>Use this URI when you want to access a file with
+ yelp</para>
+
+ <para><informalexample>
+ <para><command><prompt>$</prompt> yelp
+ file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml</command></para>
+ </informalexample></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>ghelp:</option> or
+ <option>gnome-help:</option></term>
+
+ <listitem>
+ <para>Use this URI when you want to access GNOME help documents,
+ which are typically written in DocBook format.</para>
+
+ <informalexample>
+ <para><command><prompt>$</prompt> yelp
+ ghelp:gcalctool</command></para>
+ </informalexample>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>man:</option></term>
+
+ <listitem>
+ <para>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.</para>
+
+ <informalexample>
+ <para><command><prompt>$</prompt> yelp
+ man:gcalctool</command></para>
+ </informalexample>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>info:</option></term>
+
+ <listitem>
+ <para>Use this URI when you want to access a particular GNU info
+ page.</para>
+
+ <informalexample>
+ <para><command><prompt>$</prompt> yelp
+ info:make</command></para>
+ </informalexample>
+ </listitem>
+ </varlistentry>
+ </variablelist></para>
+ </sect2>
+
+ <sect2>
+ <title>Refreshing Content on Demand</title>
+
+ <para>&app; supports the keycombo
+ <keycap>Ctrl</keycap>+<keycap>R</keycap> which will reload the DocBook
+ document that is currently open. This allows developers to view changes
+ to documents as they are made.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="yelp-moreinfo">
+ <title>More Information</title>
+
+ <para>This section details some of the helper applications which Yelp Help
+ Browser uses, and provides resources where you can get more information
+ about &app;.</para>
+
+ <sect2>
+ <title>Scrollkeeper</title>
+
+ <para>&app; uses scrollkeeper to generate the table of
+ contents for DocBook and HTML documentation, and also keep track of
+ translations for each document.</para>
+ </sect2>
+
+ <sect2>
+ <title>GNOME Documentation Utilites</title>
+
+ <para>The documentation distributed with GNOME uses this set of
+ utilities for a variety of things:</para>
+
+ <para><itemizedlist>
+ <listitem>
+ <para>Ease translation of documents to different languages.</para>
+ </listitem>
+
+ <listitem>
+ <para>Provide a set of tools to help package and install
+ documentation into the correct location and register the
+ documentation with scrollkeeper.</para>
+ </listitem>
+
+ <listitem>
+ <para>Perform conversion from DocBook format to a format suitable
+ for display.</para>
+ </listitem>
+ </itemizedlist>&app; relies on GNOME Documentation
+ Utilities to perform conversion from DocBook to HTML which it uses
+ to</para>
+ </sect2>
+
+ <sect2>
+ <title>Mailing List</title>
+
+ <para>For further information on &app; please subscribe to
+ the mailing list, gnome-doc-devel-list gnome org </para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="yelp-joininggdp">
+ <title>Joining the GNOME Documentation Project</title>
+
+ <para>If you are interesting in helping produce and update documentation
+ for the GNOME project, please visit the following link: <ulink
+ url="http://live.gnome.org/DocumentationProject";>http://live.gnome.org/DocumentationProject</ulink></para>
+ </sect1>
+</article>
diff -ruN yelp-head3/help/ChangeLog yelp-head2/help/ChangeLog
--- yelp-head3/help/ChangeLog 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/ChangeLog 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1,4 @@
+2006-01-11 Brent Smith <gnome nextreality net>
+
+ Initial commit of documentation for yelp. Please use this
+ ChangeLog to track translations to yelp.xml.
diff -ruN yelp-head3/help/.cvsignore yelp-head2/help/.cvsignore
--- yelp-head3/help/.cvsignore 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/.cvsignore 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1 @@
+*.omf
diff -ruN yelp-head3/help/Makefile.am yelp-head2/help/Makefile.am
--- yelp-head3/help/Makefile.am 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/Makefile.am 2006-01-11 23:25:57.000000000 -0700
@@ -0,0 +1,13 @@
+include $(top_srcdir)/gnome-doc-utils.make
+dist-hook: doc-dist-hook
+
+DOC_MODULE = yelp
+DOC_ENTITIES = legalgpl.xml
+DOC_INCLUDES =
+DOC_FIGURES = \
+ figures/yelp_add_bookmark.png \
+ figures/yelp_edit_bookmarks.png \
+ figures/yelp_preferences.png \
+ figures/yelp_window.png
+
+DOC_LINGUAS =
diff -ruN yelp-head3/help/yelp.omf.in yelp-head2/help/yelp.omf.in
--- yelp-head3/help/yelp.omf.in 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/help/yelp.omf.in 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+ <resource>
+ <subject category="GNOME|Utilities"/>
+ <type>user's guide</type>
+ <relation seriesid="9192b066-8310-11da-98fa-f341457f8507"/>
+ <rights type="GNU GPL" license.version="2" holder="Brent Smith"/>
+ </resource>
+</omf>
diff -ruN yelp-head3/m4/.cvsignore yelp-head2/m4/.cvsignore
--- yelp-head3/m4/.cvsignore 1969-12-31 17:00:00.000000000 -0700
+++ yelp-head2/m4/.cvsignore 2006-01-11 22:36:07.000000000 -0700
@@ -0,0 +1 @@
+gnome-doc-utils.m4
diff -ruN yelp-head3/Makefile.am yelp-head2/Makefile.am
--- yelp-head3/Makefile.am 2005-11-30 15:25:17.000000000 -0700
+++ yelp-head2/Makefile.am 2006-01-11 22:36:25.000000000 -0700
@@ -1,4 +1,4 @@
-SUBDIRS = src stylesheets po data
+SUBDIRS = src stylesheets po data help
ACLOCAL_AMFLAGS = -I m4
@@ -18,12 +18,15 @@
intltool-update.in \
idl/GNOME_Yelp.idl \
important_docs.xml \
- $(desktop_in_files)
+ gnome-doc-utils.make \
+ $(desktop_in_files) \
+ m4
DISTCLEANFILES = \
intltool-extract \
intltool-merge \
- intltool-update
+ intltool-update \
+ gnome-doc-utils.make
CLEANFILES = $(desktop_DATA)
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License
(GPL), Version 2 or any later version published
by the Free Software Foundation. You can find
a copy of the GPL at this <ulink type="help"
url="http://www.gnu.org/licenses/gpl.html";>link</ulink> or
in the file COPYING-DOCS distributed with this manual.
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
</para>
<para>
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
UNDER THE TERMS OF THE GNU GENERAL PUBLIC LICENSE
WITH THE FURTHER UNDERSTANDING THAT:
<orderedlist>
<listitem>
<para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
THAT THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
OF THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
EXCEPT UNDER THIS DISCLAIMER; AND
</para>
</listitem>
<listitem>
<para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
PARTIES, BE LIABLE TO ANY PERSON FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
LOSSES ARISING OUT OF OR RELATING TO USE OF THE
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
THE POSSIBILITY OF SUCH DAMAGES.
</para>
</listitem>
</orderedlist>
</para>
</legalnotice>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY manrevision "2.14">
<!ENTITY appversion "2.14">
<!ENTITY date "January 2006">
<!ENTITY app "Yelp Help Browser">
<!ENTITY legal SYSTEM "legalgpl.xml">
]>
<!--
(Do not remove this comment block.)
Maintained by the GNOME Documentation Project
http://developer.gnome.org/projects/gdp
Template version: 2.0 beta
Template last modified Mar 12, 2002
-->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
<articleinfo>
<title>&app; Manual</title>
<abstract role="description">
<para>&app; is a documentation viewer for GNOME. You can
view a number of different type of help documents including docbook
files, HTML help, man pages and info pages (if enabled).</para>
</abstract>
<copyright>
<year>2005</year>
<holder>Brent Smith</holder>
</copyright>
<!-- translators: uncomment this:
<copyright>
<year>2005</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<publisher>
<publishername>GNOME Documentation Project</publishername>
</publisher>
&legal;
<authorgroup>
<author>
<firstname>Brent</firstname>
<surname>Smith</surname>
<affiliation>
<orgname>GNOME Documentation Project</orgname>
<address> <email>gnome nextreality net</email> </address>
</affiliation>
</author>
<!-- This is appropriate place for other contributors: translators,
maintainers, etc. Commented out by default.
<othercredit role="translator">
<firstname>Latin</firstname>
<surname>Translator 1</surname>
<affiliation>
<orgname>Latin Translation Team</orgname>
<address> <email>translator gnome org</email> </address>
</affiliation>
<contrib>Latin translation</contrib>
</othercredit>
-->
</authorgroup>
<revhistory>
<revision>
<revnumber>Version 2.14</revnumber>
<date>January 2006</date>
<revdescription>
<para role="author">GNOME Documentation Team</para>
<para role="publisher">GNOME Documentation Project</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo>This manual describes version 2.14 of Yelp Help
Browser.</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>To report a bug or make a suggestion regarding &app;
or this manual, follow the directions in the <ulink type="help"
url="ghelp:gnome-feedback">GNOME Feedback Page</ulink>.</para>
</legalnotice>
</articleinfo>
<indexterm>
<primary>Yelp</primary>
</indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="yelp-introduction">
<title>Introduction</title>
<para>The &app; application allows you to view documentation
regarding GNOME and other components through a variety of formats. These
formats include docbook files, HTML help pages, man pages and info pages
(support for man pages and info pages may optionally be compiled in).
Despite the different formats supported, yelp does its best to provide a
unified look and feel regardless of the original document format.</para>
<para>&app; is internationalised meaning that it has support
to view documents in different languages. The documents must be localised
or translated for each language and installed properly for Yelp Help
Browser to be able to view them.</para>
</sect1>
<!-- ============= Getting Started ================================ -->
<sect1 id="yelp-getting-started">
<title>Getting Started</title>
<sect2>
<title>To Start &app;</title>
<para>You can start &app; in the following ways:</para>
<para><variablelist>
<varlistentry>
<term><guimenu>System</guimenu> Menu</term>
<listitem>
<para>Choose <application>Help</application></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command Line</term>
<listitem>
<para>Execute the following command:
<command>yelp</command></para>
</listitem>
</varlistentry>
</variablelist></para>
</sect2>
<sect2>
<title>Interface</title>
<para>When you start &app;, you will see the following
window appear.</para>
<para><figure id="fig-yelp-window">
<title>&app; Window</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/yelp_window.png" />
</imageobject>
</mediaobject>
</figure>&app; contains the following elements in <xref
linkend="fig-yelp-window" /></para>
<variablelist>
<varlistentry>
<term><interface>Menubar</interface></term>
<listitem>
<para><variablelist>
<varlistentry>
<term><guimenu>File</guimenu></term>
<listitem>
<para>Use this menu to Open a New Window, view the About
this Document page, Print the current document, or Close
the window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Edit</guimenu></term>
<listitem>
<para>Use this menu to Copy, Select all, Find..., or to
set your Preferences.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Go</guimenu></term>
<listitem>
<para>Use this menu to navigate Back, Forward, to the Help
Topics page. When viewing a DocBook document, use this
menu to navigate to the Next Section, Previous Section or
to the Contents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Bookmarks</guimenu></term>
<listitem>
<para>Use this menu to Add Bookmark(s), or Edit
Bookmark(s).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guimenu>Help</guimenu></term>
<listitem>
<para>View information about &app; and
contributors to the project through the
<guimenuitem>About</guimenuitem> menuitem. Open this
document with the <guimenuitem>Contents</guimenuitem>
menuitem or by pressing <keycap>F1</keycap>.</para>
</listitem>
</varlistentry>
</variablelist></para>
</listitem>
</varlistentry>
<varlistentry>
<term><interface>Toolbar</interface></term>
<listitem>
<para><variablelist>
<varlistentry>
<term><guibutton>Back</guibutton></term>
<listitem>
<para>Use this button to navigate back in your document
history.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Forward</guibutton></term>
<listitem>
<para>Use this button to navigate forward in your document
history.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Help Topics</guibutton></term>
<listitem>
<para>Use this button to return to the main table of
contents (shown in <xref
linkend="fig-yelp-window" />)</para>
</listitem>
</varlistentry>
</variablelist></para>
</listitem>
</varlistentry>
<varlistentry id="yelp-browser-pane" xreflabel="Yelp Browser Pane">
<term><interface>Browser Pane</interface></term>
<listitem>
<para>The browser pane is where you will be presented with the
table of contents or the documentation. Use the table of contents
to navigate to the documentation you need.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<!--===================== Usage ========================-->
<sect1>
<title>Usage</title>
<sect2>
<title>Open a Document</title>
<para>To open a document in &app;, use the Table of Contents
to navigate to the desired document</para>
<para>Alternatively, you may view a particular document by invoking Yelp
Help Browser from the command line. Please see <xref
linkend="yelp-advanced-cmdline" />.</para>
</sect2>
<sect2>
<title>Open a New Window</title>
<para>To open a new window:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>File</guimenu>
<guimenuitem>New Window</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Ctrl</keycap>+<keycap>N</keycap></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>About This Document</title>
<para>To view information about the currently open document:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>File</guimenu>
<guimenuitem>About This Document</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist><note>
<para>This option is only available for DocBook documentation. Legal
notices and documentation contributors are usually listed in this
section.</para>
</note></para>
</sect2>
<sect2>
<title>Print a Page</title>
<para>To print any page that you are able to view in Yelp Help
Browser:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print this Page</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>Print a Document</title>
<para>To print an entire document:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Print this Document</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist><note>
<para>This option is only available for DocBook
documentation.</para>
</note></para>
</sect2>
<sect2>
<title>Close a Window</title>
<para>To close a window in &app;"</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Close Window</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Ctrl</keycap>+<keycap>W</keycap></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>Set Preferences</title>
<para>To set your preferences in &app;:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Preferences</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist>A window will appear that looks like <xref
linkend="yelp-preferences" />:</para>
<para><figure id="yelp-preferences">
<title>&app; Preferences Window</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/yelp_preferences.png" />
</imageobject>
</mediaobject>
</figure>The options that are available in this dialog have the
following functions:</para>
<para><variablelist>
<varlistentry>
<term><guilabel>Use system fonts</guilabel></term>
<listitem>
<para>Check this option to display documentation using the
default fonts used by the GNOME Desktop.</para>
<para>To choose your own fonts to display documentation, uncheck
this option and click on the buttons next to the text
<guilabel>Variable Width</guilabel> or <guilabel>Fixed
Width</guilabel>.</para>
<para><variablelist>
<varlistentry>
<term><guilabel>Variable Width</guilabel></term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Fixed Width</guilabel></term>
<listitem>
<para>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.</para>
</listitem>
</varlistentry>
</variablelist></para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Browse with caret</guilabel></term>
<listitem>
<para>Click this option if you would like see a caret or cursor
in the <xref linkend="yelp-browser-pane" />. This allows you to
browse the document more easily by showing where the cursor is
located in the document.</para>
</listitem>
</varlistentry>
</variablelist></para>
</sect2>
<sect2>
<title>Go Back in Document History</title>
<para>To go back in the document history:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Back</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Alt</keycap>+<keycap>Left</keycap></para>
</listitem>
<listitem>
<para>Use the <guibutton>Back</guibutton> button in the
<interface>Toolbar</interface></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>Go Forward in Document History</title>
<para>To go forward in the document history:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Forward</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Alt</keycap>+<keycap>Right</keycap></para>
</listitem>
<listitem>
<para>Use the <guibutton>Forward</guibutton> button in the
<interface>Toolbar</interface></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>Go to Help Topics</title>
<para>To go to the Help Topics:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Help Topics</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Alt</keycap>+<keycap>Home</keycap></para>
</listitem>
<listitem>
<para>Use the <guibutton>Help Topics</guibutton> button in the
<interface>Toolbar</interface></para>
</listitem>
</itemizedlist></para>
</sect2>
<sect2>
<title>Go to Previous Section</title>
<para>To go to the previous section:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Previous Section</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Alt</keycap>+<keycap>Up</keycap></para>
</listitem>
</itemizedlist><note>
<para>This option is only available in DocBook formatted
documents.</para>
</note></para>
</sect2>
<sect2>
<title>Go to Next Section</title>
<para>To go to the next section:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Next Section</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Alt</keycap>+<keycap>Down</keycap></para>
</listitem>
</itemizedlist><note>
<para>This option is only available in DocBook formatted
documents.</para>
</note></para>
</sect2>
<sect2>
<title>Go to Contents</title>
<para>To go to the contents for a document:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Go</guimenu>
<guimenuitem>Contents</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist><note>
<para>This option is only available in DocBook formatted
documents.</para>
</note></para>
</sect2>
<sect2>
<title>Add a Bookmark</title>
<para>To add a bookmark for a particular document:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Add Bookmark</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Ctrl</keycap>+<keycap>D</keycap></para>
</listitem>
</itemizedlist>A window will appear that looks like <xref
linkend="yelp-add-bookmark" />.</para>
<para><figure id="yelp-add-bookmark">
<title>Add Bookmark Window</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/yelp_add_bookmark.png" />
</imageobject>
</mediaobject>
</figure>Enter your desired bookmark title in to the
<guilabel>Title</guilabel> text entry field. Then click
<guibutton>Add</guibutton> to add the bookmark, or click
<guibutton>Cancel</guibutton> to cancel the request.</para>
</sect2>
<sect2>
<title>Edit Bookmarks</title>
<para>To edit your collection of bookmarkst:</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Edit Bookmarks...</guimenuitem>
</menuchoice></para>
</listitem>
<listitem>
<para>Use the key combination
<keycap>Ctrl</keycap>+<keycap>B</keycap></para>
</listitem>
</itemizedlist>A window will appear that looks like <xref
linkend="yelp-edit-bookmarks" />.</para>
<para><figure id="yelp-edit-bookmarks">
<title>Edit Bookmarks Window</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/yelp_edit_bookmarks.png" />
</imageobject>
</mediaobject>
</figure>You can manage your bookmarks using this window in the
following ways:</para>
<para><variablelist>
<varlistentry>
<term><guibutton>Open</guibutton></term>
<listitem>
<para>Use this button to open the selected bookmark in a new
window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Rename</guibutton></term>
<listitem>
<para>Use this button to rename the title of your
bookmark.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Remove</guibutton></term>
<listitem>
<para>Use this button to delete the bookmark from your
collection.</para>
</listitem>
</varlistentry>
</variablelist>Once you are finished managing your bookmarks, click
the <guibutton>Close</guibutton> button to exit the <interface>Edit
Bookmarks Window</interface>.</para>
</sect2>
<sect2>
<title>Get Help</title>
<para>To get help using &app; (and see this
document):</para>
<para><itemizedlist>
<listitem>
<para>Click <menuchoice>
<guimenu>Help</guimenu>
<guimenuitem>Contents</guimenuitem>
</menuchoice></para>
</listitem>
</itemizedlist></para>
</sect2>
</sect1>
<!--=============== Advanced Features ====================-->
<sect1 id="yelp-advanced">
<title>Advanced Features</title>
<sect2 id="yelp-advanced-cmdline"
xreflabel="Using the Command Line to Open Documents">
<title>Using the Command Line to Open Documents</title>
<para>&app; supports opening documents from the command
line. There are a number of URIs (Uniform Resource Identifiers) that can
be used. These include:</para>
<para><variablelist>
<varlistentry>
<term><option>file:</option></term>
<listitem>
<para>Use this URI when you want to access a file with
yelp</para>
<para><informalexample>
<para><command><prompt>$</prompt> yelp
file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml</command></para>
</informalexample></para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>ghelp:</option> or
<option>gnome-help:</option></term>
<listitem>
<para>Use this URI when you want to access GNOME help documents,
which are typically written in DocBook format.</para>
<informalexample>
<para><command><prompt>$</prompt> yelp
ghelp:gcalctool</command></para>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term><option>man:</option></term>
<listitem>
<para>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.</para>
<informalexample>
<para><command><prompt>$</prompt> yelp
man:gcalctool</command></para>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term><option>info:</option></term>
<listitem>
<para>Use this URI when you want to access a particular GNU info
page.</para>
<informalexample>
<para><command><prompt>$</prompt> yelp
info:make</command></para>
</informalexample>
</listitem>
</varlistentry>
</variablelist></para>
</sect2>
<sect2>
<title>Refreshing Content on Demand</title>
<para>&app; supports the keycombo
<keycap>Ctrl</keycap>+<keycap>R</keycap> which will reload the DocBook
document that is currently open. This allows developers to view changes
to documents as they are made.</para>
</sect2>
</sect1>
<sect1 id="yelp-moreinfo">
<title>More Information</title>
<para>This section details some of the helper applications which Yelp Help
Browser uses, and provides resources where you can get more information
about &app;.</para>
<sect2>
<title>Scrollkeeper</title>
<para>&app; uses scrollkeeper to generate the table of
contents for DocBook and HTML documentation, and also keep track of
translations for each document.</para>
</sect2>
<sect2>
<title>GNOME Documentation Utilites</title>
<para>The documentation distributed with GNOME uses this set of
utilities for a variety of things:</para>
<para><itemizedlist>
<listitem>
<para>Ease translation of documents to different languages.</para>
</listitem>
<listitem>
<para>Provide a set of tools to help package and install
documentation into the correct location and register the
documentation with scrollkeeper.</para>
</listitem>
<listitem>
<para>Perform conversion from DocBook format to a format suitable
for display.</para>
</listitem>
</itemizedlist>&app; relies on GNOME Documentation
Utilities to perform conversion from DocBook to HTML which it uses
to</para>
</sect2>
<sect2>
<title>Mailing List</title>
<para>For further information on &app; please subscribe to
the mailing list, gnome-doc-devel-list gnome org </para>
</sect2>
</sect1>
<sect1 id="yelp-joininggdp">
<title>Joining the GNOME Documentation Project</title>
<para>If you are interesting in helping produce and update documentation
for the GNOME project, please visit the following link: <ulink
url="http://live.gnome.org/DocumentationProject";>http://live.gnome.org/DocumentationProject</ulink></para>
</sect1>
</article>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
