[goobox] ported the documentation to Mallard
- From: Paolo Bacchilega <paobac src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [goobox] ported the documentation to Mallard
- Date: Mon, 22 Aug 2011 20:49:40 +0000 (UTC)
commit 4fef964435162ad9e3c7351df41404ef534f9337
Author: Paolo Bacchilega <paobac src gnome org>
Date: Mon Aug 22 19:54:43 2011 +0200
ported the documentation to Mallard
help/C/goobox.xml | 373 -----------------------------------------------
help/C/index.page | 19 +++
help/C/legal.xml | 85 +----------
help/C/preferences.page | 63 ++++++++
help/C/shortcuts.page | 85 +++++++++++
help/Makefile.am | 10 +-
src/actions.c | 4 +-
src/dlg-preferences.c | 2 +-
8 files changed, 186 insertions(+), 455 deletions(-)
---
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..90ac8fd
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="guide" id="index">
+ <info>
+ <credit type="author">
+ <name>Paolo Bacchilega</name>
+ <email>paobac src gnome org</email>
+ <years>2005-2011</years>
+ </credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+ <revision docversion="1.0" date="2005-01-20" status="final" pkgversion="0.7.1"/>
+ <revision docversion="2.0" date="2009-11-14" status="final" pkgversion="2.1.0"/>
+ <revision docversion="3.0" date="2011-08-22" status="review" pkgversion="3.0.0"/>
+ </info>
+
+ <title><app>CD Player</app> Help</title>
+ <p>
+ With <app>CD Player</app> you can play audio Compact Discs (CDs) and save the CD tracks as audio files.</p>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
index d6906f9..86d6173 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,76 +1,9 @@
- <legalnotice id="legalnotice">
- <para>
- Permission is granted to copy, distribute and/or modify this
- document under the terms of the GNU Free Documentation
- License (GFDL), Version 1.1 or any later version published
- by the Free Software Foundation with no Invariant Sections,
- no Front-Cover Texts, and no Back-Cover Texts. You can find
- a copy of the GFDL at this <ulink type="help"
- url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
- distributed with this manual.
- </para>
- <para> This manual is part of a collection of GNOME manuals
- distributed under the GFDL. If you want to distribute this
- manual separately from the collection, you can do so by
- adding a copy of the license to the manual, as described in
- section 6 of the license.
- </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 FREE DOCUMENTATION 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>
-
\ No newline at end of file
+<license xmlns="http://projectmallard.org/1.0/";
+ href="http://creativecommons.org/licenses/by-sa/3.0/";>
+<p>This work is licensed under a
+<link href="http://creativecommons.org/licenses/by-sa/3.0/";>Creative Commons
+Attribution-Share Alike 3.0 Unported License</link>.</p>
+<p>As a special exception, the copyright holders give you permission to copy,
+modify, and distribute the example code contained in this document under the
+terms of your choosing, without restriction.</p>
+</license>
diff --git a/help/C/preferences.page b/help/C/preferences.page
new file mode 100644
index 0000000..ccf4fff
--- /dev/null
+++ b/help/C/preferences.page
@@ -0,0 +1,63 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic"
+ id="goobox-preferences">
+ <info>
+ <link type="guide" xref="index" />
+ <title type="sort">0</title>
+ </info>
+ <title>Preferences</title>
+ <p>
+ To configure <app>CD Player</app> open the <app>Preferences</app> dialog
+ by choosing <guiseq><gui style="menu">Edit</gui><gui style="menuitem">Preferences</gui></guiseq>.
+ </p>
+ <p>
+ This dialog contains two tabs described in detail below.
+ At the bottom of the dialog window, you'll find the following buttons:
+ </p>
+ <terms>
+ <item>
+ <title><gui style="button">Help</gui></title>
+ <p>Shows this page.</p>
+ </item>
+ <item>
+ <title><gui style="button">Close</gui></title>
+ <p>Closes the dialog.</p>
+ </item>
+ </terms>
+ <p>
+ Keep in mind that when you change an option it will automatically
+ applied. This is why there is no <gui style="button">Ok</gui> or
+ <gui style="button">Apply</gui> button.
+ </p>
+
+ <section>
+ <title>General Tab</title>
+ <p>This tab allows you to set the following options:</p>
+ <list>
+ <item>
+ <p>Select the device to use.</p></item>
+ <item>
+ <p>Whether to automatically play a newly inserted disk.</p></item>
+ </list>
+ </section>
+
+
+ <section>
+ <title>Extraction Tab</title>
+ <p>This tab allows you to set the extraction options:</p>
+ <list>
+ <item><p>The destination folder. Files are saved in a subfolder of
+ the destination folder, following the scheme Artist/Album/track. </p></item>
+ <item><p>The audio files format to use.
+ Some formats allow you to set the quality of the file, this can be
+ useful because usually there is a trade-off between audio quality
+ and file size.
+ Use the <gui style="button">Properties</gui> button to set the file
+ format properties.</p></item>
+ <item><p>Whether to save a playlist file in PLS format that contains
+ the list of the extracted files. The playlist is saved in the same
+ folder of the audio files.</p></item>
+ </list>
+ </section>
+
+</page>
diff --git a/help/C/shortcuts.page b/help/C/shortcuts.page
new file mode 100644
index 0000000..ceed50e
--- /dev/null
+++ b/help/C/shortcuts.page
@@ -0,0 +1,85 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="topic"
+ id="goobox-keyboard-shortcuts">
+ <info>
+ <link type="guide" xref="index" />
+ <title type="sort">1</title>
+ </info>
+ <title>Keyboard Shortcuts</title>
+ <p>Quick reference for some useful keyword shortcuts. Look in the menus for
+ other available shortcuts.</p>
+ <table shade="rows" frame="bottom" rules="groups">
+ <thead>
+ <tr>
+ <td><p>Keyboard Shortcut</p></td>
+ <td><p>Description</p></td>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><p><key>Space</key></p></td>
+ <td><p>Play/Pause the current track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>Escape</key></p></td>
+ <td><p>Stop playing the current track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>N</key></p></td>
+ <td><p>Play the next track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>P</key></p></td>
+ <td><p>Play the previous track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>J</key></p></td>
+ <td><p>Eject the CD from the tray</p></td>
+ </tr>
+ <tr>
+ <td><p><key>E</key></p></td>
+ <td><p>Open the <app>Extract</app> dialog</p></td>
+ </tr>
+ <tr>
+ <td><p><key>1</key></p></td>
+ <td><p>Play the 1st track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>2</key></p></td>
+ <td><p>Play the 2nd track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>3</key></p></td>
+ <td><p>Play the 3rd track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>4</key></p></td>
+ <td><p>Play the 4th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>5</key></p></td>
+ <td><p>Play the 5th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>6</key></p></td>
+ <td><p>Play the 6th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>7</key></p></td>
+ <td><p>Play the 7th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>8</key></p></td>
+ <td><p>Play the 8th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>9</key></p></td>
+ <td><p>Play the 9th track</p></td>
+ </tr>
+ <tr>
+ <td><p><key>0</key></p></td>
+ <td><p>Play the 10th track</p></td>
+ </tr>
+ </tbody>
+ </table>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 54d65c2..e7a42ac 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,9 +1,13 @@
include $(top_srcdir)/gnome-doc-utils.make
dist-hook: doc-dist-hook
-DOC_MODULE = goobox
-DOC_ENTITIES = legal.xml
-DOC_INCLUDES =
+DOC_ID = goobox
+DOC_INCLUDES = legal.xml
+
+DOC_PAGES = \
+ index.page \
+ preferences.page \
+ shortcuts.page
DOC_LINGUAS = ca cs de es fr oc sl sv
diff --git a/src/actions.c b/src/actions.c
index 04b1c70..23355c8 100644
--- a/src/actions.c
+++ b/src/actions.c
@@ -111,7 +111,7 @@ void
activate_action_manual (GtkAction *action,
gpointer data)
{
- show_help_dialog (GTK_WINDOW (data), NULL);
+ show_help_dialog (GTK_WINDOW (data), "");
}
@@ -119,7 +119,7 @@ void
activate_action_shortcuts (GtkAction *action,
gpointer data)
{
- show_help_dialog (GTK_WINDOW (data), "goobox-shortcuts");
+ show_help_dialog (GTK_WINDOW (data), "goobox-keyboard-shortcuts");
}
diff --git a/src/dlg-preferences.c b/src/dlg-preferences.c
index 0738e68..42a4a41 100644
--- a/src/dlg-preferences.c
+++ b/src/dlg-preferences.c
@@ -114,7 +114,7 @@ static void
help_button_clicked_cb (GtkWidget *widget,
DialogData *data)
{
- show_help_dialog (GTK_WINDOW (data->window), "preferences");
+ show_help_dialog (GTK_WINDOW (data->window), "goobox-preferences");
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
