[goobox] added documentation for the preferences dialog



commit 7f3360381d7ee06c1d1c72b33a94c6f7380d4034
Author: Paolo Bacchilega <paobac src gnome org>
Date:   Sat Nov 14 17:30:33 2009 +0100

    added documentation for the preferences dialog

 help/C/goobox.xml |   99 ++++++++++++++++++++++++++++++++++++++++++++++++++---
 src/actions.c     |   12 +++---
 2 files changed, 100 insertions(+), 11 deletions(-)
---
diff --git a/help/C/goobox.xml b/help/C/goobox.xml
index cc53e5d..3fbd781 100644
--- a/help/C/goobox.xml
+++ b/help/C/goobox.xml
@@ -2,9 +2,9 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";[
   <!ENTITY legal SYSTEM "legal.xml">
-  <!ENTITY goobox-version "0.7.1">
-  <!ENTITY manual-version "1.0">
-  <!ENTITY date "Genuary 2005">
+  <!ENTITY goobox-version "2.1.0">
+  <!ENTITY manual-version "2.0">
+  <!ENTITY date "November 2009">
   <!ENTITY goobox "<application>CD Player</application>">
 <!-- replace version above with actual application version number -->
 <!--  Template Version: 1.0.1  (do not remove this line) -->
@@ -21,7 +21,7 @@
     </abstract>
 
     <copyright>
-      <year>2005</year>
+      <year>2005, 2009</year>
       <holder>Paolo Bacchilega</holder>
     </copyright>
 
@@ -48,7 +48,7 @@
         <firstname>Paolo</firstname>
 	<surname>Bacchilega</surname>
 	<affiliation>
-	  <address> <email>paolo bacchilega libero it</email> </address>
+	  <address> <email>paobac src gnome org</email> </address>
         </affiliation>
       </author>
     </authorgroup>
@@ -64,6 +64,13 @@
         <para>First version, program version 0.7.1</para>
 	</revdescription>
       </revision>
+      <revision>
+	<revnumber>2.0</revnumber>
+        <date>2009-11-14</date>
+        <revdescription>
+        <para>Second version, program version 2.1.0</para>
+	</revdescription>
+      </revision>      
     </revhistory>
     <!-- this is version of manual, not application --> 
     <releaseinfo>
@@ -92,6 +99,88 @@
     </para>
   </sect1>
 
+  <!-- ============= Preferences ================================== -->
+
+  <sect1 id="preferences">
+    <title>Preferences</title>
+    <para>
+      To configure &goobox;, open the
+      <guilabel>Preferences</guilabel> dialog by choosing
+      <menuchoice><guimenu>Edit</guimenu><guisubmenu>Preferences</guisubmenu>
+      </menuchoice>.
+    </para>
+    <para>
+      This dialog contains two tabs described in detail below.
+      At the bottom of the dialog window, you'll find the following buttons:
+    </para>
+    <itemizedlist>
+      <listitem>
+        <para><guibutton>Help</guibutton>: shows this manual.
+        </para>
+      </listitem>
+      <listitem>
+        <para><guibutton>Close</guibutton>: closes the dialog.
+        </para>
+      </listitem>
+    </itemizedlist>
+    <para>
+      Keep in mind that when you change an option it will automatically
+      applied. This is why there is no <guibutton>Ok</guibutton> or
+      <guibutton>Apply</guibutton> button.
+    </para>  
+    
+    <!-- ########### General Tab ################## -->
+    
+    <sect2 id="preferences-general">
+      <title>General Tab</title>
+      <para>
+        This tab allows you to set the following options:
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>Select the device to use.       
+          </para>
+        </listitem>
+        <listitem>
+          <para>Whether to automatically play a newly inserted disk.          
+          </para>
+        </listitem>
+      </itemizedlist>
+    </sect2>
+
+    <!-- ########### Extraction Tab ################## -->
+    
+    <sect2 id="preferences-extraction">
+      <title>Extraction Tab</title>
+      <para>
+        This tab allows you to set the extraction options:
+      </para>
+      <itemizedlist>
+        <listitem>
+          <para>The destination folder.  Files are saved in a subfolder of 
+          the destination folder, following the scheme Artist/Album/track. 
+          </para>
+        </listitem>
+        <listitem>
+          <para>The audio files format to use.  
+          Some formats allow you to set the quality of the file, this can be
+          usefull because usually there is a trade-off between audio quality 
+          and file size.
+          Use the <guilabel>Properties</guilabel> button to set the file 
+          format properties.
+          </para>
+        </listitem>
+        <listitem>
+          <para>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.    
+          </para>
+        </listitem>
+      </itemizedlist>
+    </sect2>
+    
+  </sect1>
+  
   <!-- ============= Keyboard Shortcuts ================================== -->
   <sect1 id="goobox-shortcuts">
   <title>Quick Reference: Keyboard Shortcuts</title>
diff --git a/src/actions.c b/src/actions.c
index 96d7240..a10621f 100644
--- a/src/actions.c
+++ b/src/actions.c
@@ -130,13 +130,13 @@ activate_action_about (GtkAction *action,
 {
 	GooWindow  *window = data;
 	const char *authors[] = {
-		"Paolo Bacchilega <paolo bacchilega libero it>", 
+		"Paolo Bacchilega <paobac src gnome org>",
+		NULL
+	};
+	const char *documenters [] = {
+		"Paolo Bacchilega <paobac src gnome org>",
 		NULL
 	};
-	/*
-	  const char     *documenters [] = {
-	  NULL
-	  };*/
 	const char *translator_credits = _("translator_credits");
         char       *license_text;
         const char *license[] = {
@@ -162,7 +162,7 @@ activate_action_about (GtkAction *action,
                                "copyright", _("Copyright \xc2\xa9 2004-2009 Free Software Foundation, Inc."),
                                "comments", _("Play CDs and save the tracks to disk as files"),
                                "authors", authors,
-                               /*"documenters", documenters,*/
+                               "documenters", documenters,
                                "translator_credits", strcmp (translator_credits, "translator_credits") != 0 ? translator_credits : NULL,
                                "logo-icon-name", "goobox",
                                "license", license_text,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]