[gnome-media] Bug 563343 - first stab at profiles documentation
- From: Marc-Andre Lureau <malureau src gnome org>
- To: svn-commits-list gnome org
- Subject: [gnome-media] Bug 563343 - first stab at profiles documentation
- Date: Sun, 14 Jun 2009 12:35:53 -0400 (EDT)
commit c2460ab2b589dc2dcbda8b585ee256bdcdfcaaae
Author: Marc-André Lureau <marcandre lureau gmail com>
Date: Sun Jun 14 18:18:02 2009 +0300
Bug 563343 - first stab at profiles documentation
configure.ac | 1 +
profiles/Makefile.am | 2 +-
.../gnome-audio-profiles-profile-window.png | Bin 0 -> 24668 bytes
.../gnome-audio-profiles-profiles-window.png | Bin 0 -> 18913 bytes
profiles/help/C/gnome-audio-profiles.xml | 262 ++++++++++++++++++++
profiles/help/C/legal.xml | 73 ++++++
profiles/help/ChangeLog | 4 +
profiles/help/Makefile.am | 9 +
profiles/help/gnome-audio-profiles.omf.in | 9 +
9 files changed, 359 insertions(+), 1 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 08f2bee..e54e4ad 100644
--- a/configure.ac
+++ b/configure.ac
@@ -737,6 +737,7 @@ profiles/Makefile
profiles/gnome-audio-profiles.schemas.in
profiles/gnome-media-profiles.pc
profiles/glade/Makefile
+profiles/help/Makefile
cddb-slave2/cddb-slave.desktop.in
gnome-cd/gnome-cd.desktop.in
grecord/gnome-sound-recorder.desktop.in
diff --git a/profiles/Makefile.am b/profiles/Makefile.am
index e892953..efc1d76 100644
--- a/profiles/Makefile.am
+++ b/profiles/Makefile.am
@@ -73,4 +73,4 @@ EXTRA_DIST = $(glade_DATA) $(schema_DATA) $(pkgconfig_DATA)
CLEANFILES = $(schema_DATA)
# "." is dirty hack to first build our .la in this dir before moving to glade
-SUBDIRS = . glade
+SUBDIRS = . help glade
diff --git a/profiles/help/C/figures/gnome-audio-profiles-profile-window.png b/profiles/help/C/figures/gnome-audio-profiles-profile-window.png
new file mode 100644
index 0000000..da2885c
Binary files /dev/null and b/profiles/help/C/figures/gnome-audio-profiles-profile-window.png differ
diff --git a/profiles/help/C/figures/gnome-audio-profiles-profiles-window.png b/profiles/help/C/figures/gnome-audio-profiles-profiles-window.png
new file mode 100644
index 0000000..871cf62
Binary files /dev/null and b/profiles/help/C/figures/gnome-audio-profiles-profiles-window.png differ
diff --git a/profiles/help/C/gnome-audio-profiles.xml b/profiles/help/C/gnome-audio-profiles.xml
new file mode 100644
index 0000000..78be927
--- /dev/null
+++ b/profiles/help/C/gnome-audio-profiles.xml
@@ -0,0 +1,262 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+ <!ENTITY appname "gnome-audio-profiles">
+ <!ENTITY app "<application>GNOME Audio Profiles</application>">
+ <!ENTITY appversion "2.27.3">
+ <!ENTITY manrevision "2.27.0">
+ <!-- Information about the entities
+ Use the app and appname entities to specify the name of the application.
+ Use the appversion entity to specify the version of the application.
+ Use the manrevision entity to specify the revision number of this manual.
+ Use the date entity to specify the release date of this manual.
+ -->
+ ]>
+<!--
+ (Do not remove this comment block.)
+ Maintained by the GNOME Documentation Project
+ http://live.gnome.org/DocumentationProject
+ Template version: 3.0 beta
+ Template last modified 2006-11-21
+
+ -->
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+ <articleinfo>
+ <title>&app; Manual</title>
+ <abstract role="description">
+ <para>&app; is a set of audio encoding configurations for
+ GStreamer based applications.</para>
+ </abstract>
+
+ <copyright>
+ <year>2008-2009</year>
+ <holder>GNOME Documentation Project</holder>
+ </copyright>
+
+ <!-- An address can be added to the publisher information. -->
+ <publisher role="maintainer">
+ <publishername>GNOME Documentation Project</publishername>
+ </publisher>
+
+ <xi:include href="legal.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <!-- The file legal.xml contains link to license for the documentation,
+ and other legal stuff such as "NO WARRANTY" statement.
+ Please do not change any of this. -->
+
+ <authorgroup>
+ <author>
+ <firstname>Marc-Andre</firstname>
+ <surname>Lureau</surname>
+ <affiliation>
+ <orgname>GNOME Project</orgname>
+ <address> <email>marcandre lureau gmail com</email> </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+
+
+ <!-- According to GNU FDL, revision history is mandatory if you are -->
+ <!-- modifying/reusing someone else's document. If not, you can omit it. -->
+ <!-- Remember to remove the &manrevision; entity from the revision entries other
+ -->
+ <!-- than the current revision. -->
+ <!-- The revision numbering system for GNOME manuals is as follows: -->
+ <!-- * the revision number consists of two components -->
+ <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
+ <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
+ <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
+ <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
+ <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
+ <!-- to V3.0, and so on. -->
+ <revhistory>
+ <revision>
+ <revnumber>Audio Profiles Manual V&manrevision;</revnumber>
+ <date>June 2009</date>
+ <revdescription>
+ <para>Fill some blanks, add screenshots.</para>
+ <para>Release with GNOME Media 2.27.3</para>
+ <para role="author">Marc-Andre Lureau</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>Audio Profiles Manual V0.1</revnumber>
+ <date>December 2008</date>
+ <revdescription>
+ <para role="author">Marc-Andre Lureau</para>
+ <para role="publisher">GNOME Documentation Project</para>
+ </revdescription>
+ </revision>
+ </revhistory>
+
+ <releaseinfo>This manual describes version &appversion; of GNOME Audio Profiles.
+ </releaseinfo>
+ <legalnotice>
+ <title>Feedback</title>
+ <para>To report a bug or make a suggestion regarding the &app; application or
+ this manual, follow the directions in the
+ <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
+ </para>
+ <!-- Translators may also add here feedback address for translations -->
+ </legalnotice>
+ </articleinfo>
+
+ <indexterm zone="index">
+ <primary>GNOME Audio Profiles</primary>
+ </indexterm>
+
+ <!-- ============= Document Body ============================= -->
+ <!-- ============= Introduction ============================== -->
+
+ <sect1 id="gnome-audio-profiles-introduction">
+ <title>Introduction</title>
+ <para>&app; let you select and modify a list of pre-defined encoding formats.
+ By default, &app; provides the following audio format:</para>
+ <itemizedlist>
+ <listitem>
+ <para>AAC-MP4 - The new standard of lossy compression.</para>
+ </listitem>
+ <listitem>
+ <para>Ogg Vorbis - Xiph.Org lossy compression.</para>
+ </listitem>
+ <listitem>
+ <para>Speex - Xiph.Org lossy compression optimized for voice.</para>
+ </listitem>
+ <listitem>
+ <para>FLAC - Xiph.Org lossless audio compression.</para>
+ </listitem>
+ <listitem>
+ <para>MP3 - The popular lossy compression format.</para>
+ </listitem>
+ <listitem>
+ <para>MP2 - MPEG-1 Audio Layer II, largely supported.</para>
+ </listitem>
+ <listitem>
+ <para>WAV - Lossless.</para>
+ </listitem>
+ </itemizedlist>
+
+ <note>
+ <para>Some format may be illegal in your jurisdiction.</para>
+ </note>
+ </sect1>
+
+ <sect1 id="gnome-audio-profiles-usage">
+ <title>Usage</title>
+ <para>Use &app; to modify a list of pre-defined encoding formats.</para>
+
+ <sect2 id="gnome-audio-profiles-profiles-edit">
+ <title>Profile selection dialog</title>
+
+ <para>The following window is displayed to modify, add or remove
+ the pre-defined formats.</para>
+
+ <!-- ==== Figure ==== -->
+ <figure id="gnome-audio-profiles-profiles-window">
+ <title>&app; Window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gnome-audio-profiles-profiles-window.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows &app; main window. Contains list of
+ profiles and modification options.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <!-- ==== End of Figure ==== -->
+
+ <para>Select one of the profiles and click "Edit" to modify
+ it. The "Profile modification window" will be displayed.</para>
+
+ <para>"Delete" will remove the currently selected profile from the
+ list of profiles.</para>
+
+ <para>To create a new profile, click "New". The "Profile
+5~ modification window" will be displayed.</para>
+
+ </sect2>
+
+ <sect2 id="gnome-audio-profiles-profile-edit">
+ <title>Profile editing</title>
+
+ <para>&app; let you modify the parameters of an audio profile.</para>
+
+ <!-- ==== Figure ==== -->
+ <figure id="gnome-audio-profiles-profile-window">
+ <title>Profile modification window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/gnome-audio-profiles-profile-window.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows &app; profile window. </phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <!-- ==== End of Figure ==== -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Profile name - user friendly name of the profile.</para>
+ </listitem>
+ <listitem>
+ <para>Profile description - long description of this profile.</para>
+ </listitem>
+ <listitem>
+ <para>GStreamer pipeline - the GStreamer encoding pipeline.</para>
+ </listitem>
+ <listitem>
+ <para>File extension - the filename extension associated to
+ this profile.</para>
+ </listitem>
+ <listitem>
+ <para>Active - whether this profile is listed in client
+ application.</para>
+ </listitem>
+ </itemizedlist>
+
+ </sect2>
+
+ </sect1>
+
+ <!-- ============= Bugs ================================== -->
+ <!-- This section is optional and is commented out by default.
+ You can use it to describe known bugs and limitations of the
+ program if there are any - please be frank and list all
+ problems you know of.
+
+ <sect1 id="mayapp-bugs">
+ <title>Known Bugs and Limitations</title>
+ <para> </para>
+ </sect1>
+ -->
+ <!-- ============= About ================================== -->
+ <!-- This section contains info about the program (not docs), such as
+ author's name(s), web page, license, feedback address. This
+ section is optional: primary place for this info is "About.." box of
+ the program. However, if you do wish to include this info in the
+ manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
+ <sect1 id="gnome-audio-profiles-about">
+ <title>About &app;</title>
+ <para>
+ To report a bug or make a suggestion regarding this application or
+ this manual, follow the directions in the
+ <ulink url="ghelp:user-guide?feedback-bugs" type="help">Feedback section of the GNOME User Guide</ulink>.
+ </para>
+
+ <para> This program is distributed under the terms of the GNU
+ Library General Public license as published by the Free Software
+ Foundation; either version 2 of the License, or (at your option)
+ any later version. A
+ <ulink url="ghelp:lgpl" type="help">copy of this license</ulink>
+ is included with this documentation; another can be found in the file
+ COPYING included with the source code of this program. </para>
+
+ </sect1>
+</article>
diff --git a/profiles/help/C/legal.xml b/profiles/help/C/legal.xml
new file mode 100644
index 0000000..e15dec0
--- /dev/null
+++ b/profiles/help/C/legal.xml
@@ -0,0 +1,73 @@
+ <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
+ 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 --git a/profiles/help/ChangeLog b/profiles/help/ChangeLog
new file mode 100644
index 0000000..d1440df
--- /dev/null
+++ b/profiles/help/ChangeLog
@@ -0,0 +1,4 @@
+2008-12-15 Marc-Andre Lureau <marcandre lureau gmail com>
+
+ * Initial documentation. Closes #563343
+
diff --git a/profiles/help/Makefile.am b/profiles/help/Makefile.am
new file mode 100644
index 0000000..42d7a7f
--- /dev/null
+++ b/profiles/help/Makefile.am
@@ -0,0 +1,9 @@
+include $(top_srcdir)/build-aux/gnome-doc-utils.make
+dist-hook: doc-dist-hook
+DOC_MODULE = gnome-audio-profiles
+DOC_ENTITIES = legal.xml
+DOC_INCLUDES =
+DOC_FIGURES = \
+ figures/gnome-audio-profiles-profiles-window.png \
+ figures/gnome-audio-profiles-profile-window.png
+DOC_LINGUAS =
diff --git a/profiles/help/gnome-audio-profiles.omf.in b/profiles/help/gnome-audio-profiles.omf.in
new file mode 100644
index 0000000..e738d7d
--- /dev/null
+++ b/profiles/help/gnome-audio-profiles.omf.in
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+ <resource>
+ <subject category="GNOME|Applications|Sound and Video"/>
+ <type>user's guide</type>
+ <relation seriesid="0b4175ce-79cd-4155-8e4e-172ed4328c4f"/>
+ <rights type="GNU FDL" license.version="1.1" holder="GNOME Documentation Project"/>
+ </resource>
+</omf>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
