irc.gnome.org is another option for contacting GDP members.
</p></div></div><div class="sect2"><a name="notation"/><div class="titlepage"><div><h3 class="title"><a name="notation"/>Notation and Conventions</h3></div></div><p>
This Handbook uses the following notation:
- <div class="informaltable" id="id2
797668"><a name="id2797668"/><table border="0"><colgroup><col/><col/></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
+ <div class="informaltable" id="id2
416529"><a name="id2416529"/><table border="0"><colgroup><col/><col/></colgroup><tbody><tr><td><tt>/usr/bin</tt></td><td>
Directory
</td></tr><tr><td><tt>foo.sgml</tt></td><td>
Filename
</td></tr><tr><td><b>command</b></td><td>
Command or text that would be typed.
</td></tr><tr><td><b><i><tt>replaceable</tt></i></b></td><td>
- "Variable" text that can be replaced.
+ "Variable" text that can be replaced.
</td></tr><tr><td><tt>Program or Doc Code</tt></td><td>Program or document code</td></tr></tbody></table></div>
</p></div><div class="sect2"><a name="about"/><div class="titlepage"><div><h3 class="title"><a name="about"/>About This Handbook</h3></div></div><p>
This Handbook is a guide for both writing documentation for
download it anonymously from GNOME CVS under <tt>gnome-docu/gdp</tt>.
</p></div></div><div class="sect1"><a name="gettingstarted"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="gettingstarted"/>Getting Started Writing GNOME Documentation</h2></div></div><div class="sect2"><a name="selecting"/><div class="titlepage"><div><h3 class="title"><a name="selecting"/>Selecting A Document</h3></div></div><div class="sect3"><a name="know"/><div class="titlepage"><div><h4 class="title"><a name="know"/>Document Something You Know</h4></div></div><p>
The most frequently asked question of new contributors who
- join the GDP is "which document should I start
- with?". Because most people involved are volunteers, we do
+ join the GDP is "which document should I start
+ with?". Because most people involved are volunteers, we do
not <i>assign</i> projects and applications to
write documents for. The first step is all yours - you must
decide what about GNOME interests you most and find out if
help. The <i>DocTable</i> also allows
people to make announcements and suggestions and to discuss
issues in the comments section.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
795537"/>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
412924"/>Note</h3><p>
Note that the information in the
<i>DocTable</i> may not always be up-to-date
or accurate. When you assign yourself to documenting an
this for documentation, not least of which is the single
source nature of SGML. To contribute to the GDP you should
learn to use DocBook.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
795620"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
412986"/>NOTE</h3><p>
To get started writing for the GDP you do not need to rush
out and learn DocBook - if you feel it is too much to handle
for now, you can submit plain ASCII text to the <a href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list/" target="_top">
your output document appearance subtly vary between the two
DTD's. To install the GDP custom DTD with PNG image support
by hand:
- </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2796033"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: opencircle"><p><a name="id2413298"/>
Download <a href="http://www.labs.redhat.com/png/png-support.html" target="_top">the
GDP DocBook DTD for PNG support</a> and install it
where you keep your DTD's. (On Red Hat use <tt>/usr/lib/sgml/</tt>.) Note that
the 3.0 DTD is missing support for the
<tt><legalnotice></tt> tag, so it is
recommended that you use version 3.1
- </p></li><li style="list-style-type: disc"><p><a name="id2796096"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2413345"/>
Add the new DTD to your SGML CATALOG file. The location
of your SGML CATALOG file may vary depending upon your
distribution. (On Red Hat it is usually in
/usr/lib/sgml/CATALOG.) Add the following line to this
file:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN" "png-support-3.0.dtd"
</pre>
If you are using the 3.1 DTD, use:
<pre class="programlisting">
-PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
+PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN" "png-support-3.1.dtd"
</pre>
</p></li></ul></div><p>
Alternately, you can download and install the
</p><p>
Articles:
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p><p>
Books:
<pre class="programlisting">
-<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
-V1.1//EN"[]>
+<!DOCTYPE Book PUBLIC "-//GNOME//DTD DocBook PNG Variant
+V1.1//EN"[]>
</pre>
</p></div><div class="sect3"><a name="editors"/><div class="titlepage"><div><h4 class="title"><a name="editors"/>Editors</h4></div></div><p>
There are many editors on Linux and UNIX systems available
the command <tt>$</tt><b>db2ps
mydocument.sgml</b>, after which you can print out or
view the resulting .ps file.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
796573"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
413716"/>NOTE</h3><p>
The html files you get will not look quite the same as the
documentation distributed with GNOME unless you have the
custom stylesheets installed on your machine. DocBook
<title>My Image</title>
<screenshot>
<screeninfo>Sample GNOME Display</screeninfo>
- <graphic format="png" fileref="myfile" srccredit="me">
+ <graphic format="png" fileref="myfile" srccredit="me">
</graphic>
</screenshot>
</figure>
There are many resources available to help you learn DocBook.
The following resources on the web are useful for learning
DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918692"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2413930"/>
<a href="http://www.docbook.org" target="_top">http://www.docbook.org</a> - Norman
Walsh's <i>DocBook: The Definitive
Guide</i>. Online O'Reilly book on using
DocBook. Contains an excellent element reference. May be
too formal for a beginner.
- </p></li><li style="list-style-type: disc"><p><a name="id2918739"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2413963"/>
<a href="http://www.oswg.org/oswg-nightly/oswg/en_US.ISO_8859-1/articles/DocBook-Intro/docbook-intro/index.html" target="_top">A Practical Introduction to DocBook</a>
- The Open Source Writers Group's introduction to using
DocBook. This is an excellent HOW-TO type article on
getting started.
- </p></li><li style="list-style-type: disc"><p><a name="id2918780"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2413992"/>
<a href="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html" target="_top">Getting Going with DocBook: Notes for
Hackers</a> - Mark Galassi's introduction to DocBook
for hackers. This has to be one of the first
introductions to DocBook ever - still as good as it ever
was.
- </p></li><li style="list-style-type: disc"><p><a name="id2918819"/>
+ </p></li><li style="list-style-type: disc"><p><a name="id2527122"/>
<a href="http://www.freebsd.org/tutorials/docproj-primer/" target="_top">
FreeBSD Documentation Project Primer for New
Contributors</a> - FreeBSD documentation project
</p><p>
The following sections of this document are designed to help
documentation authors write correct and consistent DocBook:
- </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2918894"/>
+ </p><div class="itemizedlist"><ul><li style="list-style-type: disc"><p><a name="id2527176"/>
<a href="#docbookbasics" title="DocBook Basics ">the section called “DocBook Basics ”</a> - Descriptions of
commonly used DocBook tags.
</p></li></ul></div><p>
</p></div><div class="sect3"><a name="screenshotfiles"/><div class="titlepage"><div><h4 class="title"><a name="screenshotfiles"/>Screenshot Files</h4></div></div><p>
Screenshots should be kept in the main documentation
directory with your SGML file for applets, or should be
- kept in a directory called "figs" for application and other
+ kept in a directory called "figs" for application and other
documentation. After you use <b>db2html</b> to
convert your SGML file to HTML (see <a href="#make-output" title="Creating Something Useful with your Docs">the section called “Creating Something Useful with your Docs”</a>), you will need to copy your
screenshots (either the individual PNG files for applet
- documentation, or the whole "figs" directory for other
+ documentation, or the whole "figs" directory for other
documentation) into the newly created HTML directory. Note
that every time you use <b>db2html</b> the HTML
directory is erased and rewritten, so do not store your only
CVSROOT=':pserver:anonymous@anoncvs.gnome.org:/cvs/gnome'</b>
and then login with <b>cvs login</b>(there is no
password, just hit return). As an example, we will use the
- "gnome-docu/gdp" module which contains this and several
+ "gnome-docu/gdp" module which contains this and several
other documents. To check these documents out for the first
time, type <b>cvs -z3 checkout
gnome-docu/gdp</b>. After you have this document
to query any part (button, widget, etc.) of an application
window. This is done by either entering a CS Help mode by
clicking on an icon or by right clicking on the application
- part and selecting "What's This" or whatever is decided on
+ part and selecting "What's This" or whatever is decided on
at the time. Context sensitive help is described in more
detail in <a href="#writingcontextsensitivehelp" title="Writing Context Sensitive Help (coming in GNOME-2.0)">the section called “Writing Context Sensitive Help (coming in GNOME-2.0)”</a>
below.
</p><p>
Using 'content' as the elements to define the text of a document also
allows for search engines to make use of the actual elements to make a
- "smarter search". For example, if you are searching for all documents
- written by the author "Susie" your search engine could be made smart
+ "smarter search". For example, if you are searching for all documents
+ written by the author "Susie" your search engine could be made smart
enough to only search <author> elements, making for a faster and more
accurate search.
</p><p>
ready for this transistion, it is <i>strongly
advised</i> that the documentation writers conform to XML
syntax rules. Here are most important differences:
- </p><div class="variablelist"><dl><dt><a name="id2921205"/><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2921223"/>
+ </p><div class="variablelist"><dl><dt><a name="id2529076"/><span class="term"> <i>Minimization</i></span></dt><dd><p><a name="id2529088"/>
It is possible with some implementations of SGML to use
minimizations to close elements in a document by using
</>, for example:
if you are using Emacs with psgml
mode, you can also use menu command
Modify->Normalize.
- </p></dd><dt><a name="id2921339"/><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2921357"/>
+ </p></dd><dt><a name="id2529176"/><span class="term"> <i>Self-closing tags</i></span></dt><dd><p><a name="id2529188"/>
Also, in SGML some tags are allowed not to have closing
tags. For example, it is legal for
<tt><xref></tt> not to have a closing tag:
<tt><tt><xref
- linkend="someid"></tt></tt>. In
+ linkend="someid"></tt></tt>. In
XML, it is illegal; instead, you should use
<tt><tt><xref
- linkend="someid"/></tt></tt> (note the
+ linkend="someid"/></tt></tt> (note the
slash!).
- </p></dd><dt><a name="id2921424"/><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2921441"/>
+ </p></dd><dt><a name="id2529236"/><span class="term"> <i>Case sensitive tags</i></span></dt><dd><p><a name="id2529248"/>
In XML, unlike SGML, tags are case-senstive
<tt><title></tt> and
<tt><TITLE></tt> are different tags!
<pre class="programlisting">
-<figure id="shot1">
+<figure id="shot1">
<title>Screenshot</title>
<screenshot>
<screeninfo>Screenshot of a program</screeninfo>
- <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
+ <graphic format="PNG" fileref="figures/example_screenshot" srccredit="ME">
</graphic>
</screenshot>
</figure>
actual file name (without extension). The result will look like this:
<div class="figure"><p><a name="shot1"/><b>Figure 1. Screenshot</b></p><div class="screenshot"><p><img src="figures/example_screenshot"/></p></div></div>
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
921964"/>NOTE</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
529626"/>NOTE</h3><p>
Notice in this example that the screenshot file name does
not include the file type extension -- to find out
why, please read <a href="#jadeimages" title="Images in DocBook Tools">the section called “Images in DocBook Tools”</a>.
Note the use of tags <tt><prompt></tt> and
<tt><userinput></tt> for marking system prompt
and commands entered by user.
- <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
922180"/>NOTE</h3><p>
+ <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
529790"/>NOTE</h3><p>
Note that both <tt><programlisting></tt>
and <tt><screen></tt> preserve linebreaks,
but interpret SGML tags (unlike LaTeX
<tt><itemizedlist></tt>,
<tt><orderedlist></tt>, and
<tt><variablelist></tt>.
- </p><div class="variablelist"><dl><dt><a name="id2922298"/><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2922318"/>
+ </p><div class="variablelist"><dl><dt><a name="id2529876"/><span class="term"> <tt><itemizedlist></tt></span></dt><dd><p><a name="id2529888"/>
This is the simplest unnumbered list, parallel to
<tt><ul></tt> in HTML. Here is an example:
<pre class="programlisting">
<listitem>
<para>
<guilabel>Show hidden files</guilabel> &mdash; This will
- show all "dot files" or files that begin with a dot. This
+ show all "dot files" or files that begin with a dot. This
files typically include configuration files and directories.
</para>
</listitem>
</pre>
and output:
- </p><div class="itemizedlist"><ul><li><p><a name="id2922357"/>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2529912"/>
Show backup files --
This will show any backup file that might be on
your system.
- </p></li><li><p><a name="id2922417"/>
+ </p></li><li><p><a name="id2529958"/>
Show hidden files --
- This will show all "dot files" or files that
+ This will show all "dot files" or files that
begin with a dot. This files typically include
configuration files and directories.
- </p></li><li><p><a name="id2922449"/>
+ </p></li><li><p><a name="id2529981"/>
Mix files and directories
-- This option will display files and
directories in the order you sort them instead
or -- if none of
this applies -- use
<a href="#gui" title="GUI elements"><tt><emphasis></tt></a>.
- </p></dd><dt><a name="id2922620"/><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2922639"/>
+ </p></dd><dt><a name="id2530107"/><span class="term"> <tt><orderedlist></tt></span></dt><dd><p><a name="id2530119"/>
This list is completely analogous to
<tt><itemizedlist></tt> and has the same
syntax, but it produces numbered list. By default,
this list uses Arabic numerals for numbering entries;
you can override this using <tt>numeration</tt>,
for example <tt><orderedlist
- numeration="lowerroman"></tt>. Possible values of
+ numeration="lowerroman"></tt>. Possible values of
these attribute are <tt>arabic</tt>,
<tt>upperalpha</tt>,
<tt>loweralpha</tt>,
<tt>upperroman</tt>,
<tt>lowerroman</tt>.
- </p></dd><dt><a name="id2922720"/><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2922739"/> This list is used when each entry is
+ </p></dd><dt><a name="id2530183"/><span class="term"> <tt><variablelist></tt></span></dt><dd><p><a name="id2530195"/> This list is used when each entry is
rather long, so it should be formatted as a block of text
with some subtitle, like a small subsection. The
<tt><variablelist></tt> is more complicated
are smart enough to change the numeration (for
<tt><orderedlist></tt>) or marks of each entry
(in <tt><itemizedlist></tt>) for sub-lists
- </p></div></div><div class="sect2"><a name="inline"/><div class="titlepage"><div><h3 class="title"><a name="inline"/>Inline Elements</h3></div></div><div class="sect3"><a name="gui"/><div class="titlepage"><div><h4 class="title"><a name="gui"/>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2922909"/>
+ </p></div></div><div class="sect2"><a name="inline"/><div class="titlepage"><div><h3 class="title"><a name="inline"/>Inline Elements</h3></div></div><div class="sect3"><a name="gui"/><div class="titlepage"><div><h4 class="title"><a name="gui"/>GUI elements</h4></div></div><div class="itemizedlist"><ul><li><p><a name="id2530324"/>
<tt><guibutton></tt> -- used for
buttons, including checkbuttons and radio buttons
- </p></li><li><p><a name="id2922935"/>
+ </p></li><li><p><a name="id2530343"/>
<tt><guimenu></tt>,
<tt><guisubmenu></tt> --used for
top-level menus and submenus
respectively, for example <tt>
<guisubmenu>Utilities</guisubmenu> submenu of the
<guimenu>Main Menu</guimenu></tt>
- </p></li><li><p><a name="id2922985"/>
+ </p></li><li><p><a name="id2530378"/>
<tt><guimenuitem></tt>--an entry in a
menu
- </p></li><li><p><a name="id2923009"/>
+ </p></li><li><p><a name="id2530395"/>
<tt><guiicon></tt>--an icon
- </p></li><li><p><a name="id2923034"/>
+ </p></li><li><p><a name="id2530412"/>
<tt><guilabel></tt>--for items which have
labels, like tabs, or bounding boxes.
- </p></li><li><p><a name="id2923060"/>
+ </p></li><li><p><a name="id2530429"/>
<tt><interface></tt>-- for most everything
else... a window, a dialog box, the Panel, etc.
</p></li></ul></div><p>
to (section, figure, etc.), while the second just creates a
link (in HTML output). Here is an example:
<pre class="programlisting">
-An example of a <link linkend="extip">tip</link> was given in
-<xref linkend="notes" />.
+An example of a <link linkend="extip">tip</link> was given in
+<xref linkend="notes" />.
</pre>
which produces: An example of a <a href="#extip">tip</a> was given in <a href="#notes" title="Notes, Warnings, And Tips">the section called “Notes, Warnings, And Tips”</a>.
</p><p>
Web page or a local file, use <tt><ulink></tt>
tag, for example:
<pre class="programlisting">
- To find more about GNOME, please visit <ulink type="http"
-url="http://www.gnome.org">GNOME Web page</ulink>
+ To find more about GNOME, please visit <ulink type="http"
+url="http://www.gnome.org">GNOME Web page</ulink>
</pre>
which produces: To find more about GNOME, please visit
<a href="http://www.gnome.org" target="_top">The GNOME Web
computer-related things</h4></div></div><p>
Here are some tags used to describe operating system-related
things:
- </p><div class="itemizedlist"><ul><li><p><a name="id2923447"/> <tt><filename></tt> -- used
+ </p><div class="itemizedlist"><ul><li><p><a name="id2530717"/> <tt><filename></tt> -- used
for filenames,
e.g.<tt><filename></tt>
foo.sgml
<tt></filename></tt>
produces: <tt>foo.sgml</tt>.
- </p></li><li><p><a name="id2923504"/> <tt><filename
- class="directory"></tt> -- used for
+ </p></li><li><p><a name="id2530757"/> <tt><filename
+ class="directory"></tt> -- used for
directories, e.g.<tt><filename
- class="directory"></tt>/usr/bin
+ class="directory"></tt>/usr/bin
<tt></filename></tt>
produces: <tt>/usr/bin</tt>.
- </p></li><li><p><a name="id2923567"/>
+ </p></li><li><p><a name="id2530804"/>
<tt><application></tt> -- used for
application names,
e.g. <tt><application></tt>Gnumeric
<tt></application></tt> produces:
Gnumeric.
- </p></li><li><p><a name="id2923622"/>
+ </p></li><li><p><a name="id2530845"/>
<tt><envar></tt> -- used for
environment variables, e.g.
<tt><envar></tt>PATH<tt></envar></tt>.
- </p></li><li><p><a name="id2923664"/>
+ </p></li><li><p><a name="id2530876"/>
<tt><command></tt> -- used for
commands entered on command line, e.g.
<tt><command></tt>make install
<tt></command></tt> produces:
<b>make install</b>.
- </p></li><li><p><a name="id2923721"/>
+ </p></li><li><p><a name="id2530916"/>
<tt><replaceable></tt> -- used for
replaceable text, e.g.
<tt><command></tt>db2html<tt><replaceable></tt>
is required.
</p><p>
here is partial list of most commonly used enitites:
- </p><div class="itemizedlist"><ul><li><p><a name="id2924181"/>
+ </p><div class="itemizedlist"><ul><li><p><a name="id2531260"/>
<tt>&amp;</tt> -- ampersend (&)
- </p></li><li><p><a name="id2924202"/>
+ </p></li><li><p><a name="id2531274"/>
<tt>&lt;</tt> -- left angle bracket (<)
- </p></li><li><p><a name="id2924221"/>
+ </p></li><li><p><a name="id2531287"/>
<tt>&copy;</tt> -- copyright sign (©)
- </p></li><li><p><a name="id2924239"/>
+ </p></li><li><p><a name="id2531348"/>
<tt>&mdash;</tt> -- long dash (--)
- </p></li><li><p><a name="id2924265"/>
+ </p></li><li><p><a name="id2531314"/>
<tt>&hellip;</tt> -- ellipsis (...)
</p></li></ul></div><p>
Note that the actual look of the resulting symbols depends
application for which the documentation is written:
<pre class="programlisting">
-<sect1 id="intro">
+<sect1 id="intro">
<title>Introduction</title>
<para>
blah-blah-blah This document describes version 1.0.53 of gfoo.
</p></div><div class="sect3"><a name="license2"/><div class="titlepage"><div><h4 class="title"><a name="license2"/>Software license</h4></div></div><p>
All GNOME applications must contain information about the
license (for software, not for documentation), either in the
- "About" box or in the manual.
+ "About" box or in the manual.
</p></div><div class="sect3"><a name="bugtraq"/><div class="titlepage"><div><h4 class="title"><a name="bugtraq"/> Bug reporting</h4></div></div><p>
Application documentation should give an address for
reporting bugs and for submitting comments about the
each window or panel presented to the user using screenshots (in
PNG format only) when appropriate. They should also describe
each feature and preference option available.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
924708"/>Documentation Availability</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
531646"/>Documentation Availability</h3><p>
Applications and applets should not rely on documentation
which is only available on the internet. All manuals and
other documentation should be packaged with the application or
the templates in <a href="#template2-1x" title="Template 2: Applet Manual For GNOME 1.x">the section called “Template 2: Applet Manual For GNOME 1.x”</a> for GNOME
versions 1.x and the templates in <a href="#template2-2x" title="Template 2: Applet Manual For GNOME 2.x">the section called “Template 2: Applet Manual For GNOME 2.x”</a>
for GNOME versions 2.x.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
924802"/>Manuals For Large Applications</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
531713"/>Manuals For Large Applications</h3><p>
Manuals for very large applications, such as GNOME Workshop
components should be a <tt><book></tt> (and thus
use <tt><chapter></tt> for each primary section)
, instead of <tt><article></tt> which most
applications use(with each primary section being a
<tt><sect1></tt>).
- </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
924860"/>Applet Manuals in GNOME 2.0</h3><p>
+ </p></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
531756"/>Applet Manuals in GNOME 2.0</h3><p>
Note that applet manuals in GNOME 2.0 are treated in a special
way. The manuals for all applets are merged into a single
virtual document by Nautilus. For this reason, the header
<tt><sect2></tt>.
</p></div><p>
Application manuals should be made available by having a
- "Manual" entry in the Help pull-down menu
+ "Manual" entry in the Help pull-down menu
at the top of the
application, as described in <a href="#listingdocsinhelpmenu" title="Listing Documents in the Help Menu">the section called “Listing Documents in the Help Menu”</a>.
Applets should make their manuals available by
right-clicking on the applet.
- </p></div><div class="sect1"><a name="listingdocsinhelpmenu"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"/>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
924983"/>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="listingdocsinhelpmenu"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="listingdocsinhelpmenu"/>Listing Documents in the Help Menu</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
531851"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
application's name. The application documentation (converted
from SGML into HTML with <b>db2html</b>) should be
placed in this directory too.
- </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
925171"/>Note</h3><p>
+ </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
531991"/>Note</h3><p>
If the help files are not present in the correct directory, the
menu items will NOT appear when the program is run.
</p></div><p>
<pre class="programlisting">
GnomeUIInfo helpmenu[] = {
{GNOME_APP_UI_ITEM,
- N_("About"), N_("Info about this program"),
+ N_("About"), N_("Info about this program"),
about_cb, NULL, NULL,
GNOME_APP_PIXMAP_STOCK, GNOME_STOCK_MENU_ABOUT,
0, 0, NULL},
GNOMEUIINFO_SEPARATOR,
- GNOMEUIINFO_HELP("<i>appname</i>"),
+ GNOMEUIINFO_HELP("<i>appname</i>"),
GNOMEUIINFO_END
};
</pre>
Help menu. When the user selects any of these
topics from the Help menu, a help browser
will be started with the associated HTML documentation.
- </p></div><div class="sect1"><a name="applicationhelpbuttons"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"/>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
925335"/>Developer Information</h3><p>
+ </p></div><div class="sect1"><a name="applicationhelpbuttons"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="applicationhelpbuttons"/>Application Help Buttons</h2></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
532116"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
Browser the developer should add code based on the following example:
</p><pre class="programlisting">
gchar *tmp;
-tmp = gnome_help_file_find_file ("module", "page.html");
+tmp = gnome_help_file_find_file ("module", "page.html");
if (tmp) {
gnome_help_goto(0, tmp);
g_free(tmp);
}
- </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
925473"/>NOTE</h3><p>
+ </pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
532218"/>NOTE</h3><p>
The example above is in the C language, please refer to other
documentation or forums for other GNOME language bindings.
</p></div></div><div class="sect1"><a name="packagingappletdocs"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="packagingappletdocs"/>Packaging Applet Documentation</h2></div></div><div class="sect2"><a name="appletfiles"/><div class="titlepage"><div><h3 class="title"><a name="appletfiles"/>Applet Documentation Files</h3></div></div><p>
of the <i>GNOME Applets</i> book, you must
remember to add <tt><legalnotice></tt> and
<tt><copyright></tt> sections.
- </p></div><div class="sect2"><a name="appletmenu"/><div class="titlepage"><div><h3 class="title"><a name="appletmenu"/>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
925721"/>Developer Information</h3><p>
+ </p></div><div class="sect2"><a name="appletmenu"/><div class="titlepage"><div><h3 class="title"><a name="appletmenu"/>Adding Documentation to an Applet Menu</h3></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title"><a name="id2
532404"/>Developer Information</h3><p>
This section is for developers. Documentation authors
generally do not need to know this material.
</p></div><p>
To add an applet's manual to its applet menu, use:
<pre class="programlisting">
/* add an item to the applet menu */
-applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
-_("Manual"), &open_manual, NULL);
+applet_widget_register_callback(APPLET_WIDGET(applet), "manual",
+_("Manual"), &open_manual, NULL);
</pre>
Here the second argument is an arbitrary name for the
callback, the third argument is the label which will appear
item to the applet's menu. This is a
stock menu item and is done:
<pre class="programlisting">
-applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
- GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
+applet_widget_register_stock_callback (APPLET_WIDGET(applet), "about",
+ GNOME_STOCK_MENU_ABOUT, _("About"), &my_applet_cb_about,
NULL);
</pre>
</p><p>
More information can be found at <a href="http://developer.gnome.org/doc/tutorials/applet/index.html" target="_top">Writing
GNOME panel applets using the GTK+/GTK-- widget set</a>.
</p></div></div><div class="sect1"><a name="writingcontextsensitivehelp"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="writingcontextsensitivehelp"/>Writing Context Sensitive Help (coming in GNOME-2.0)</h2></div></div><p>
- Context sensitive help, also known as "pop-up" help, will allow
+ Context sensitive help, also known as "pop-up" help, will allow
a user to obtain help information about specific buttons or
parts of an application.
</p><p>
developer to give an id to a particular portion of the User
Interface, for example, a button. Once the interface is complete
a Perl script can then be run against the interface code to
- create a "map" file. This map file allows the developer or
+ create a "map" file. This map file allows the developer or
writer to associate particular paragraph sections from an XML
document to the interface items.
</p><p>
user launches context sensitive help on the interface (either by
pressing a button and then clicking on the interface item they
want information on, or by right mouse clicking on the interface
- item and selecting a pop-up menu item like "What's This") a
+ item and selecting a pop-up menu item like "What's This") a
small transient window will appear with brief but detailed
information on the interface item.
</p></div><div class="sect1"><a name="referring"/><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="referring"/>Referring to Other GNOME Documentation (coming in
</p></div><div class="sect2"><a name="balance"/><div class="titlepage"><div><h3 class="title"><a name="balance"/>Achieving a Balanced Style</h3></div></div><p>
Just as you need to juggle expert and novice readers,
you'll have to juggle a number of other extremes as you write:
- <div class="itemizedlist"><ul><li><p><a name="id2926279"/>
+ <div class="itemizedlist"><ul><li><p><a name="id2532825"/>
Documents should be complete, yet concise. You should
describe every feature, but you'll have decide how much
detail is really necessary. It's not, for example,
you spend fewer words on the obvious, you can spend more
time clarifying the ambiguous labels and explaining
items that are more complex.
- </p></li><li><p><a name="id2926306"/>
+ </p></li><li><p><a name="id2532845"/>
Be engaging and friendly, yet professional. Games
documents may be less formal than productivity
application documents (people don't
maintain a standard of style which holds the reader's
interest without resorting to jokes and untranslatable
allusions or puns.
- </p></li><li><p><a name="id2926345"/>
+ </p></li><li><p><a name="id2532874"/>
Examples, tips, notes, and screenshots are useful to
break up long stretches of text, but too many can get in
the way, and make your documents too choppy to read.
It's good to provide a screenshot of any dialog windows
a user might run into, but if a dialog box has several
tabs, it's not usually necessary to have one for each.
- </p></li><li><p><a name="id2926368"/>
+ </p></li><li><p><a name="id2532892"/>
The GDP strives to have all of its documentation conform
to certain standards of style and content, but every
document (and every writer) is different. You will need
bug reports, writers must check for errors in their documents.
Poor grammar, bad spelling, and gross technical errors in
draft documents are fine. However, if those problems show up
- in a "real" release, they can count against the credibility of
+ in a "real" release, they can count against the credibility of
GNOME and Linux. They'll also make you look bad.
</p><p>
There is no substitute for a human proofreader; use a
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
<!-- if not using PNG graphic, replace reference above with
- .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
+ .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
-->
-<!ENTITY version "1.0.53">
+<!ENTITY version "1.0.53">
<!-- replace version above with actual application version number-->
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged.
Remember that this is a guide, rather than a perfect model to follow
<!-- =============Document Header ============================= -->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<artheader>
<title>MY-GNOME-APP</title>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. You may obtain a copy of the <citetitle>GNU Free
Documentation License</citetitle> from the Free Software
- Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
to: Free Software Foundation, Inc., 59 Temple Place - Suite
330, Boston, MA 02111-1307, USA.
</para>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
- <sect1 id="intro">
+ <sect1 id="intro">
<title>Introduction</title>
<para>
<!-- ================ Usage ================================ -->
<!-- This section should describe basic usage of the application. -->
- <sect1 id="usage">
+ <sect1 id="usage">
<title>Using MY-GNOME-APP</title>
<para>
<application>MY-GNOME-APP</application> can be used to produce a
</para>
<!-- ========= Basic Usage =========================== -->
- <sect2 id="mainwin">
+ <sect2 id="mainwin">
<title>Basic usage</title>
<para>
Starting <application>MY-GNOME-APP</application> opens the
<interface>Main window</interface>, shown in <xref
- linkend="mainwindow-fig">. The window is at first empty.
+ linkend="mainwindow-fig">. The window is at first empty.
<!-- ==== Figure ==== -->
- <figure id="mainwindow-fig">
+ <figure id="mainwindow-fig">
<title>MY-GNOME-APP Main Window</title>
<screenshot>
<screeninfo>MY-GNOME-APP Main Window</screeninfo>
- <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png" srccredit="ME">
</graphic>
</screenshot>
</figure>
</para>
- <!-- For this app, one could put "proving" or "edit" (probably even
+ <!-- For this app, one could put "proving" or "edit" (probably even
both of them) as sect2's seperate from the main window
section. Since they were both so closely involved with the main
window, I decided to have them as sect3's isntead. Judgement
call. -->
- <sect3 id="proving">
+ <sect3 id="proving">
<title>Proving a Theorem</title>
<para>
To get a proof of a theorem, select
</para>
</warning>
</sect3>
- <sect3 id="editing">
+ <sect3 id="editing">
<title>Editing Proofs</title>
<para>
Once you have proven the theorem, it will be displayed in
============================================================= -->
- <sect2 id="toolbar">
+ <sect2 id="toolbar">
<title>Toolbar</title>
<para>
- The toolbar (shown in <xref linkend="figure-usage-toolbar">)
+ The toolbar (shown in <xref linkend="figure-usage-toolbar">)
provides access to several commonly used routines.
- <figure id="figure-usage-toolbar">
+ <figure id="figure-usage-toolbar">
<title>MY-GNOME-APP Toolbar</title>
<screenshot>
<screeninfo>MY-GNOME-APP Toolbar</screeninfo>
- <graphic fileref="usage-toolbar.png" format="png"></graphic>
+ <graphic fileref="usage-toolbar.png" format="png"></graphic>
</screenshot>
</figure>
<variablelist>
</sect2>
<!-- ========= Menus =========================== -->
- <sect2 id="menubar">
+ <sect2 id="menubar">
<!-- Describing the menubar ensures comprehensive feature
coverage. Nest itemizedlists inside variablelists so that each
<para>
<guimenuitem>Preferences&hellip;</guimenuitem>
&mdash; This opens the <link
- linkend="prefs"><interface>Preferences
+ linkend="prefs"><interface>Preferences
Dialog</interface></link>, which allows you to configure
many settings.
</para>
<!-- ============= Customization ============================= -->
- <sect1 id="prefs">
+ <sect1 id="prefs">
<title>Customization</title>
<para>
To change the application settings, select
<guimenuitem>Preferences...</guimenuitem>
</menuchoice>. This opens the
<interface>Preferences</interface> dialog, shown in <xref
- linkend="preferences-fig">.
+ linkend="preferences-fig">.
</para>
- <figure id="preferences-fig">
+ <figure id="preferences-fig">
<title>Preferences Dialog</title>
<screenshot>
<screeninfo>Preferences Dialog</screeninfo>
- <graphic fileref="SCREENSHOT" format="png"
- srccredit="ME">
+ <graphic fileref="SCREENSHOT" format="png"
+ srccredit="ME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of. -->
- <sect1 id="bugs">
+ <sect1 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This application has no known bugs.
<!-- ============= Authors ================================ -->
- <sect1 id="authors">
+ <sect1 id="authors">
<title>Authors</title>
<para>
<application>MY-GNOME-APP</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). To find more information about
<application>MY-GNOME-APP</application>, please visit the <ulink
- url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
+ url="http://www.my-gnome-app.org" type="http">MY-GNOME-APP Web
page</ulink>. Please send all comments, suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>.) You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also add your comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect1 id="license">
+ <sect1 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
<pre class="programlisting">
-<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
- <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
+<!DOCTYPE Article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+ <!entity APPLETNAME.sgml SYSTEM "applet_template_1.sgml">
<!-- Template Version: 1.0.1 (do not remove this line) -->
]>
Documentation Project Team. Please use it for writing GNOME
documentation, making obvious changes. In particular, all the words
written in UPPERCASE (with the exception of GNOME) should be
- replaced. As for "legalnotice", please leave the reference
+ replaced. As for "legalnotice", please leave the reference
unchanged,make sure to add/remove trademarks to the list as
appropriate for your document.
thanks ;-).
-->
-<article id="index"> <!-- please do not change the id -->
+<article id="index"> <!-- please do not change the id -->
<!-- ============= Document Header ============================= -->
<artheader>
-->
<!-- do not put authorname in the header except in copyright - use
- section "authors" below -->
+ section "authors" below -->
<legalnotice>
<para>
by the Free Software Foundation with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy
of the <citetitle>GNU Free Documentation License</citetitle> from
- the Free Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to:
+ the Free Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to:
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
</para>
<!-- Template Version: 1.0.1 (do not remove this line) -->
- <sect1 id="APPLET">
+ <sect1 id="APPLET">
<title>APPLET Applet</title>
<para>
<application>APPLET</application> applet, shown in <xref
- linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
+ linkend="APPLETapplet-fig">, allows you to &hellip;. To add this
applet to a <interface>Panel</interface>,
right-click on the <interface>Panel</interface> and choose
<menuchoice>
</menuchoice>.
</para>
- <figure id="APPLETapplet-fig">
+ <figure id="APPLETapplet-fig">
<title>APPLET Applet</title>
<screenshot>
<screeninfo>APPLET Applet</screeninfo>
- <graphic format="png" fileref="APPLET_applet"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_applet"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- ============= Usage ================================ -->
- <sect2 id="APPLET-usage">
+ <sect2 id="APPLET-usage">
<title>Usage</title>
<para>
(Place a short description of how to use the applet here.)
<listitem>
<para>
<guimenuitem>Properties&hellip;</guimenuitem> &mdash;
- opens the <link linkend="APPLET-prefs">
+ opens the <link linkend="APPLET-prefs">
<guilabel>Properties</guilabel></link> dialog.
</para>
</listitem>
<!-- ============= Customization ============================= -->
- <sect2 id="APPLET-prefs">
+ <sect2 id="APPLET-prefs">
<title>Customization</title>
<para>
You can customize <application>APPLET</application>
applet by right-clicking on it and choosing
<guimenuitem>Properties&hellip;</guimenuitem>. This will open the
<interface>Properties</interface> dialog(shown in <xref
- linkend="APPLET-settings-fig">), which allows you to
+ linkend="APPLET-settings-fig">), which allows you to
change various settings.
</para>
- <figure id="APPLET-settings-fig">
+ <figure id="APPLET-settings-fig">
<title>Properties dialog</title>
<screenshot>
<screeninfo>Properties dialog</screeninfo>
- <graphic format="png" fileref="APPLET_settings"
- srccredit="YOURNAME">
+ <graphic format="png" fileref="APPLET_settings"
+ srccredit="YOURNAME">
</graphic>
</screenshot>
</figure>
<!-- This section should describe known bugs and limitations of
the program if there are any - please be frank and list all
problems you know of -->
- <sect2 id="bugs">
+ <sect2 id="bugs">
<title>Known Bugs and Limitations</title>
<para>
This applet has no known bugs.
<!-- ============= Authors ================================ -->
- <sect2 id="authors">
+ <sect2 id="authors">
<title>Authors</title>
<para>
<application>APPLET</application> was written by GNOME-HACKER
(<email>hacker@gnome.org</email>). Please send all comments,
suggestions, and bug
- reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
+ reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
bug tracking database</ulink>. (Instructions for submitting bug
reports can be found <ulink
- url="http://bugs.gnome.org/Reporting.html" type="http">
+ url="http://bugs.gnome.org/Reporting.html" type="http">
on-line</ulink>. You can also use <application>Bug Report
Tool</application> (<command>bug-buddy</command>), available in the
<guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
<para>
This manual was written by ME
(<email>MYNAME@MYADDRESS</email>). Please send all comments and
- suggestions regarding this manual to the <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">GNOME Documentation
+ suggestions regarding this manual to the <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">GNOME Documentation
Project</ulink> by sending an email to
<email>docs@gnome.org</email>. You can also submit comments online
- by using the <ulink type="http"
- url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
+ by using the <ulink type="http"
+ url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
Status Table</ulink>.
</para>
<!-- ============= Application License ============================= -->
- <sect2 id="license">
+ <sect2 id="license">
<title>License</title>
<para>
This program is free software; you can redistribute it and/or
included as an appendix to the <citetitle>GNOME Users
Guide</citetitle>. You may also obtain a copy of the
<citetitle>GNU General Public License</citetitle> from the Free
- Software Foundation by visiting <ulink type="http"
- url="http://www.fsf.org">their Web site</ulink> or by writing to
+ Software Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing to
<address>
Free Software Foundation, Inc.
<street>59 Temple Place</street> - Suite 330
</p><p>
<pre class="programlisting">
-<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
-<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
+<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
+<!ENTITY TEMPLATE-APPLET SYSTEM "gnome-applet-template.sgml.part">
]>
-<book id="gnome-applets">
+<book id="gnome-applets">
<bookinfo>
<title>GNOME Applets</title>
</bookinfo>
<!-- #### Introduction ###### -->
- <chapter id="applets-intro">
+ <chapter id="applets-intro">
<title>Introduction</title>
<!-- #### Intro | What Are Applets? ###### -->
- <sect1 id="applets-what-are">
+ <sect1 id="applets-what-are">
<title>What Are Applets?</title>
<para>
Applets are one of the most popular and useful objects you can add
</para>
<para>
- <figure id="example-applets-fig">
+ <figure id="example-applets-fig">
<title>Example Applets</title>
<screenshot>
<screeninfo>Example Applets</screeninfo>
- <graphic fileref="example_applets" format="png"
- srccredit="muet">
+ <graphic fileref="example_applets" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
Several example applets are shown in <xref
- linkend="example-applets-fig">. From left to right, they are: (1)
+ linkend="example-applets-fig">. From left to right, they are: (1)
<application>Mixer Applet</application>, which allows you to turn
on/off sound and control its volume by clicking on the applet. (2)
<application>Sound Monitor</application> Applet, which displays
<interface>Panels</interface> and using them. The following
chapters go through each of the standard GNOME applets describing
them in detail. There are also additional applets which can be
- downloaded off the Web. See <ulink type="http"
- url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
+ downloaded off the Web. See <ulink type="http"
+ url="http://www.gnome.org/applist/list-martin.phtml">The GNOME
Software Map</ulink> for lists of additional GNOME applications
and applets.
</para>
</sect1>
<!-- #### Intro | Adding, Moving, and Removing Applets ###### -->
- <sect1 id="applet-add-move-replace">
+ <sect1 id="applet-add-move-replace">
<title>Adding, Moving, and Removing Applets</title>
- <sect2 id="adding-applets">
+ <sect2 id="adding-applets">
<title>Adding Applets to a Panel</title>
<para>
To add an applet to a <interface>Panel</interface>, right-click
</para>
</sect2>
- <sect2 id="moving-applets">
+ <sect2 id="moving-applets">
<title>Moving Applets In or Between Panels</title>
<para>
It is easy to move applets in a <interface>Panel</interface> or
other objects, the behavior depends on the global preferences
you have set for your <interface>Panels</interface> in the
<application>GNOME Control Center</application>: the applet you are
- moving can switch places with other objects, "push" all objects
- it meets, or "jump" over all other objects without disturbing
+ moving can switch places with other objects, "push" all objects
+ it meets, or "jump" over all other objects without disturbing
them. You can also override the default behavior by holding
- <keycap>Shift</keycap> button (for "push" mode),
- <keycap>Ctrl</keycap> (for "switched" mode), or
- <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
+ <keycap>Shift</keycap> button (for "push" mode),
+ <keycap>Ctrl</keycap> (for "switched" mode), or
+ <keycap>Alt</keycap> (for "free" mode, i.e. jumping other other
objects without disturbing them) button while dragging.
</para>
<para>
</para>
</sect2>
- <sect2 id="removing-applets">
+ <sect2 id="removing-applets">
<title>Removing Applets from a Panel</title>
<para>
To remove an applet from a <interface>Panel</interface>,
<!-- #### Intro | The Right-Click Pop-Up Menu ###### -->
- <sect1 id="right-click-pop-up-menu">
+ <sect1 id="right-click-pop-up-menu">
<title>The Right-Click Pop-Up Menu</title>
<para>
Clicking the right mouse button on any applet brings up
often has additional items which vary depending on the particular
applet.
</para>
- <sect2 id="standard-right-click-items">
+ <sect2 id="standard-right-click-items">
<title>Standard Pop-Up Items</title>
<para>
All applets should have the following items in their right-click
</para>
</sect2>
- <sect2 id="applet-properties-dialog">
+ <sect2 id="applet-properties-dialog">
<title>The Applet Properties Dialog</title>
<para>
Many applets have customizable properties. These applets will
right-click <guimenu>pop-up menu</guimenu> which brings up the
<interface>Properties</interface> dialog where you can alter the
appearance or behaviour of the applet.
- <figure id="example-props-dialog-fig">
+ <figure id="example-props-dialog-fig">
<title>An Example Applet Properties Dialog</title>
<screenshot>
<screeninfo>An Example Applets Properties Dialog</screeninfo>
- <graphic fileref="applet_props_dialog" format="png"
- srccredit="muet">
+ <graphic fileref="applet_props_dialog" format="png"
+ srccredit="muet">
</graphic>
</screenshot>
</figure>
</para>
</sect2>
- <sect2 id="common-right-click-items">
+ <sect2 id="common-right-click-items">
<title>Other Common Pop-Up Items</title>
<para>
Many applets also have one or more of the following items in their
</sect2>
</sect1>
- <sect1 id="feedback">
+ <sect1 id="feedback">
<title>Feedback</title>
- <sect2 id="reporting-bugs">
+ <sect2 id="reporting-bugs">
<title>Reporting Applet Bugs</title>
<para>
- GNOME users are encouraged to report bugs to <ulink type="http"
- url="http://bugs.gnome.org">The GNOME Bug Tracking
+ GNOME users are encouraged to report bugs to <ulink type="http"
+ url="http://bugs.gnome.org">The GNOME Bug Tracking
System</ulink>. The easiest way to submit bugs is to use the
<application>Bug Report Tool</application> program by selecting
<menuchoice>
reproduce the the scenario.
</para>
</sect2>
- <sect2 id="documentation-feedback">
+ <sect2 id="documentation-feedback">
<title>Providing Feedback</title>
<para>
GNOME users are welcome to provide suggestions for how
<application>Bug Report Tool</application> discussed above.
Suggestions for documentation changes can be emailed directly to
the documentation author (whose email should be included in the
- "Authors" section of the document) or by sending an email to
+ "Authors" section of the document) or by sending an email to
<email>docs@gnome.org</email>.
</para>
</sect2>
- <sect2 id="joining-gnome">
+ <sect2 id="joining-gnome">
<title>Joining GNOME</title>
<para>
GNOME is a community project, created by hundreds of programmers,
documentation writers, icon design artists, web masters, and
other people, most of whom work on a volunteer basis. New GNOME
contributors are always welcome. To join the GNOME team, visit
- these web sites: developers &mdash; <ulink type="http"
- url="http://developer.gnome.org">The GNOME Development
- Site</ulink>, documentation writers &mdash; <ulink type="http"
- url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
- Project</ulink>, icon design artists &mdash; <ulink type="http"
- url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
- general &mdash; <ulink type="http"
- url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
- or just join the gnome-list email list (see <ulink type="http"
- url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
+ these web sites: developers &mdash; <ulink type="http"
+ url="http://developer.gnome.org">The GNOME Development
+ Site</ulink>, documentation writers &mdash; <ulink type="http"
+ url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
+ Project</ulink>, icon design artists &mdash; <ulink type="http"
+ url="http://gnome-icons.sourceforge.net/">Gnome Icon Web</ulink>,
+ general &mdash; <ulink type="http"
+ url="http://developer.gnome.org/helping/">Helping GNOME</ulink>,
+ or just join the gnome-list email list (see <ulink type="http"
+ url="http://www.gnome.org/resources/mailing-lists.html">GNOME Mailing
Lists</ulink>) to discuss what you are interested in doing.
</para>
</sect2>
</chapter>
<!-- ############### Template Applets ##################### -->
- <chapter id="template-applets">
+ <chapter id="template-applets">
<title>Template Applets</title>
&TEMPLATE-APPLET
<!-- stated in a translation approved by the Foundation. -->
<!-- ############### GNOMEAPPLET ############### -->
- <sect1 id="GNOMEAPPLET">
+ <sect1 id="GNOMEAPPLET">
<title>GNOMEAPPLET Applet</title>
<para>
<application>GNOMEAPPLET</application> applet, shown in <xref
- linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
+ linkend="GNOMEAPPLET-fig">, does this and that. To learn how to
add this applet to a <interface>Panel</interface>, see <xref
- linkend="adding-applets">.
+ linkend="adding-applets">.
</para>
- <figure id="GNOMEAPPLET-fig">
+ <figure id="GNOMEAPPLET-fig">
<title>GNOMEAPPLET</title>
<screenshot>
<screeninfo>GNOMEAPPLET</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-fig" srccredit="ME">
</graphic>
</screenshot>
</figure>
- <sect2 id="GNOMEAPPLET-usage">
+ <sect2 id="GNOMEAPPLET-usage">
<title>Usage</title>
<para>
This applet does nothing. To use it, just
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-right-click">
+ <sect2 id="GNOMEAPPLET-right-click">
<title>Right-Click Pop-Up Menu Items</title>
<para>
In addition to the standard menu items (see <xref
- linkend="standard-right-click-items">), the right-click pop-up menu has
+ linkend="standard-right-click-items">), the right-click pop-up menu has
the following items:
<itemizedlist>
<listitem>
<para>
<guimenuitem>Properties...</guimenuitem> &mdash; This menu
item opens the <interface>Properties</interface> dialog (see
- <xref linkend="GNOMEAPPLET-properties">) which allows you to
+ <xref linkend="GNOMEAPPLET-properties">) which allows you to
customize the appearance and behavior of this applet.
</para>
</listitem>
<para>
<guimenuitem>Run Hello World...</guimenuitem> &mdash; This
menu item starts the program <application>Hello
- World</application>, used to say "hello" to the world.
+ World</application>, used to say "hello" to the world.
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-properties">
+ <sect2 id="GNOMEAPPLET-properties">
<title>Properties</title>
<para>
You can configure <application>GNOMEAPPLET</application> applet by
right-clicking on the applet and choosing the
<guimenuitem>Properties...</guimenuitem> menu item. This will open the
<interface>Properties</interface> dialog, shown in <xref
- linkend="GNOMEAPPLET-properties-fig">.
+ linkend="GNOMEAPPLET-properties-fig">.
</para>
- <figure id="GNOMEAPPLET-properties-fig">
+ <figure id="GNOMEAPPLET-properties-fig">
<title>Properties Dialog</title>
<screenshot>
<screeninfo>Properties Dialog</screeninfo>
- <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
+ <graphic format="png" fileref="GNOMEAPPLET-properties" srccredit="ME">
</graphic>
</screenshot>
</figure>
dialog, including descriptions of the <guibutton>OK</guibutton>,
<guibutton>Apply</guibutton>, <guibutton>Cancel</guibutton>, and
<guibutton>Help</guibutton> buttons, see <xref
- linkend="applet-properties-dialog">.
+ linkend="applet-properties-dialog">.
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-bugs">
+ <sect2 id="GNOMEAPPLET-bugs">
<title> Known Bugs and Limitations</title>
<para>
There are no known bugs in the
</para>
</sect2>
- <sect2 id="GNOMEAPPLET-authors">
+ <sect2 id="GNOMEAPPLET-authors">
<title>Authors</title>
<para>
This applet was writen by HACKER-NAME
which you are reading now was written by
YOUR-NAME <email>YOUR-EMAIL</email>. For information on submitting
bug reports and suggestions for improvements, see <xref
- linkend="feedback">.
+ linkend="feedback">.
</para>
</sect2>
projects / platform / upstream / libxslt.git / commitdiff