From 29558088d5ba1a4336f0facd53ee78072317aed8 Mon Sep 17 00:00:00 2001
From: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
Date: Thu, 3 Sep 2009 13:09:57 -0400
Subject: [PATCH] [#1976] Integrate user doc to gnome client build system
---
.gitignore | 2 +
sflphone-client-gnome/Makefile.am | 8 +-
sflphone-client-gnome/autogen.sh | 2 +
sflphone-client-gnome/configure.ac | 5 +-
sflphone-client-gnome/doc/C/legal.xml | 76 +++++++++
sflphone-client-gnome/doc/C/sflphone.xml | 151 ++++++++++++++++++
sflphone-client-gnome/doc/Changelog | 0
sflphone-client-gnome/doc/Makefile.am | 8 +
sflphone-client-gnome/doc/sflphone.omf.in | 30 ++++
.../control.jaunty | 2 +-
.../debian-sflphone-common/control.hardy | 2 +-
.../debian-sflphone-common/control.intrepid | 2 +-
.../debian-sflphone-common/control.jaunty | 2 +-
13 files changed, 282 insertions(+), 8 deletions(-)
create mode 100644 sflphone-client-gnome/doc/C/legal.xml
create mode 100644 sflphone-client-gnome/doc/C/sflphone.xml
create mode 100644 sflphone-client-gnome/doc/Changelog
create mode 100644 sflphone-client-gnome/doc/Makefile.am
create mode 100644 sflphone-client-gnome/doc/sflphone.omf.in
diff --git a/.gitignore b/.gitignore
index 5e9e29c63a..3e8caf2769 100644
--- a/.gitignore
+++ b/.gitignore
@@ -176,3 +176,5 @@ sflphone-common/libs/dbus-c++/tools/dbusxx-xml2cpp
# Ignore temp files
*~
+# GNOME doc file
+sflphone-client-gnome/gnome-doc-utils.make
diff --git a/sflphone-client-gnome/Makefile.am b/sflphone-client-gnome/Makefile.am
index a0a1e82ed9..9bea76fc88 100644
--- a/sflphone-client-gnome/Makefile.am
+++ b/sflphone-client-gnome/Makefile.am
@@ -1,14 +1,16 @@
-SUBDIRS = src pixmaps tests man po
+SUBDIRS = src pixmaps tests man po doc
ACLOCAL_AMFLAGS = -I m4
+GNOME_DOC=gnome-doc-utils.make
+
log4crc_DATA = log4crc
log4crcdir = $(datadir)/sflphone
-EXTRA_DIST = $(log4crc_DATA) sflphone.desktop.in
+EXTRA_DIST = $(log4crc_DATA) sflphone.desktop.in $(GNOME_DOC) m4
appsdir = $(datadir)/applications
apps_in_files = sflphone.desktop.in
apps_DATA = $(apps_in_files:.desktop.in=.desktop)
#@INTLTOOL_DESKTOP_RULE@
-DISTCLEANFILES= sflphone.desktop
+DISTCLEANFILES= sflphone.desktop $(GNOME_DOC)
diff --git a/sflphone-client-gnome/autogen.sh b/sflphone-client-gnome/autogen.sh
index 5c51459dbc..9001af6918 100755
--- a/sflphone-client-gnome/autogen.sh
+++ b/sflphone-client-gnome/autogen.sh
@@ -9,6 +9,8 @@ function autocmd()
}
}
+gnome-doc-prepare --force
+
autocmd libtoolize --force --copy
autocmd aclocal
autocmd autoheader
diff --git a/sflphone-client-gnome/configure.ac b/sflphone-client-gnome/configure.ac
index 29e30088ef..67fe15d2db 100644
--- a/sflphone-client-gnome/configure.ac
+++ b/sflphone-client-gnome/configure.ac
@@ -2,6 +2,7 @@ AC_INIT([SFLphone],[0.9.6~beta],[sflphoneteam@savoirfairelinux.com],[sflphone-cl
AM_CONFIG_HEADER(config.h)
LT_INIT
+GNOME_DOC_INIT
PACKAGE=SFLphone
VERSION=`cat VERSION`
@@ -54,7 +55,8 @@ PKG_CHECK_MODULES(DEPS, \
gtk+-2.0 >= 2.2 \
glib-2.0 >= 2.2 \
libebook-1.2 >= 2.22 \
- libgnomeui-2.0
+ libgnomeui-2.0 \
+ gnome-doc-utils
)
AC_SUBST(DEPS_CFLAGS)
@@ -81,6 +83,7 @@ sflphone.desktop
tests/Makefile
man/Makefile
po/Makefile
+doc/Makefile
])
diff --git a/sflphone-client-gnome/doc/C/legal.xml b/sflphone-client-gnome/doc/C/legal.xml
new file mode 100644
index 0000000000..ac97e1de4d
--- /dev/null
+++ b/sflphone-client-gnome/doc/C/legal.xml
@@ -0,0 +1,76 @@
+ <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>
+
diff --git a/sflphone-client-gnome/doc/C/sflphone.xml b/sflphone-client-gnome/doc/C/sflphone.xml
new file mode 100644
index 0000000000..70c8d6e40b
--- /dev/null
+++ b/sflphone-client-gnome/doc/C/sflphone.xml
@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+ <!ENTITY app "SFLphone">
+ <!ENTITY appversion "0.9.7 beta">
+]>
+
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change lang to -->
+<!-- appropriate code -->
+ <articleinfo>
+ <title>SFLphone Manual v1.0</title>
+
+ <copyright>
+ <year>2006</year>
+ <year>2007</year>
+ <year>2008</year>
+ <year>2009</year>
+ <holder>Savoir-faire Linux</holder>
+ </copyright>
+
+<!-- translators: uncomment this:
+
+ -->
+ <abstract role="description">
+ <para>
+ SFLphone is an enterprise-class SIP/IAX2 compatible softphone for GNU/Linux, published under the GPLv3 license.
+ </para>
+ </abstract>
+
+ <publisher>
+ <publishername>Savoir-faire Linux</publishername>
+ </publisher>
+
+ <legalnotice id="legalnotice">
+ <para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation Licence (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 licence to the manual, as described in section 6 of the licence.</para>
+ </legalnotice>
+
+ <authorgroup>
+ <author>
+ <firstname>Pierre-Luc</firstname>
+ <surname>Bacon</surname>
+ <affiliation>
+ <address><email>pierre-luc.bacon@savoirfairelinux.com</email></address>
+ </affiliation>
+ </author>
+
+ <author role="maintainer">
+ <firstname>Emmanuel</firstname>
+ <surname>Milou</surname>
+ <affiliation>
+ <address><email>emmanuel.milou@savoirfairelinux.com</email></address>
+ </affiliation>
+ </author>
+
+ <author>
+ <firstname>Jérémy</firstname>
+ <surname>Quentin</surname>
+ <affiliation>
+ <address><email>jeremy.quentin@savoirfairelinux.com</email></address>
+ </affiliation>
+ </author>
+
+ <author>
+ <firstname>Alexandre</firstname>
+ <surname>Savard</surname>
+ <affiliation>
+ <address><email>alexandre.savard@savoirfairelinux.com</email></address>
+ </affiliation>
+ </author>
+</authorgroup>
+
+<revhistory>
+ <revision>
+ <revnumber>SFLphone Manual V1.0</revnumber>
+ <date>September 2009</date>
+ <revdescription>
+ <para role="author">SFLphone team</para>
+ <para role="publisher">Savoir-faire Linux</para>
+ </revdescription>
+ </revision>
+</revhistory>
+
+<releaseinfo>This manual describes version 0.9.7 of SFLphone.</releaseinfo>
+
+</articleinfo>
+
+<indexterm>
+ <primary>SFLphone</primary>
+ </indexterm>
+
+<sect1 id="introduction">
+ <title>A brief introduction to SFLphone</title>
+<para>
+<application>SFLphone</application> is a SIP/IAX2 softphone and VoIP client for GNU/Linux. It aims at being a robust enterprise-class desktop phone and has been designed with a hundred-calls-a-day receptionist in mind.
+</para>
+<para>
+<application>SFLphone</application> is a free software and is distributed under the GNU General Public License version 3. It is developed by Savoir-Faire Linux, a Canadian Linux consulting company, in partnership with the global community.
+</para>
+<para>
+Among the many features we developed for you, we could highlight the high definition sound (wide-band audio codecs - speex, G722, Celt), audio recording, voicemail notification and call history.
+More than a simple softphone, <application>SFLphone</application> supports advanced enterprise-class call features: unlimited number of calls, call transfer and on/off hold option.
+</para>
+
+<para>
+Besides the native ALSA interface, <application>SFLphone</application> now fully supports PulseAudio sound server so you could experience the great possibilities it offers (sound mixing, per application volume control, ...).
+</para>
+</sect1>
+
+<sect1 id="accounts">
+<title>SIP/IAX2 accounts</title>
+<para>
+<application>SFLphone</application> supports both IAX2 and SIP accounts.
+</para>
+</sect1>
+
+
+<sect1 id="audio_interfaces">
+<title>Audio configuration</title>
+<para>
+ALSA and Pulseaudio native interfaces are available.
+</para>
+
+ <sect2 label="Pulseaudio">
+ <para>
+ </para>
+ </sect2>
+
+ <sect2 label="ALSA">
+ <para>
+ </para>
+ </sect2>
+
+</sect1>
+
+<sect1 id="codecs_overview">
+<title>Codecs overview</title>
+<para>
+</para>
+</sect1>
+
+<sect1 id="addressbook">
+<title>How to use the address books</title>
+
+<para>
+</para>
+
+</sect1>
+
+</article>
diff --git a/sflphone-client-gnome/doc/Changelog b/sflphone-client-gnome/doc/Changelog
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/sflphone-client-gnome/doc/Makefile.am b/sflphone-client-gnome/doc/Makefile.am
new file mode 100644
index 0000000000..e139613e55
--- /dev/null
+++ b/sflphone-client-gnome/doc/Makefile.am
@@ -0,0 +1,8 @@
+include $(top_srcdir)/gnome-doc-utils.make
+dist-hook: doc-dist-hook
+DOC_MODULE = sflphone
+DOC_ENTITIES = legal.xml
+DOC_INCLUDES =
+DOC_FIGURES = figures/main_window.png \
+ figures/open_document.png
+DOC_LINGUAS = fr de es it zh_TW zh_HK zh_CN ko pl pt_BR pt ru
diff --git a/sflphone-client-gnome/doc/sflphone.omf.in b/sflphone-client-gnome/doc/sflphone.omf.in
new file mode 100644
index 0000000000..ace92a2e53
--- /dev/null
+++ b/sflphone-client-gnome/doc/sflphone.omf.in
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<omf>
+ <resource>
+ <creator>
+ sflphoneteam@savoirfairelinux.com
+ </creator>
+ <maintainer>
+ emmanuel.milou@savoirfairelinux.com
+ </maintainer>
+ <title>
+ SFLphone Manual V1.0
+ </title>
+ <date>
+ 2009-09-03
+ </date>
+ <version identifier="0.9.7" date="2009-09-01"/>
+ <subject category="GNOME|Applications|Internet"/>
+ <description>
+ User manual for SFLphone
+ </description>
+ <type>
+ manual
+ </type>
+ <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/>
+ <identifier url="sflphone.xml"/>
+ <language code="C"/>
+ <relation seriesid="00e1b4a0-74d3-6e38-acf3-04cbb6e855c540"/>
+ <rights type="GNU FDL" license.version="1.1" holder="Savoir-faire Linux Inc"/>
+ </resource>
+</omf>
diff --git a/tools/build-system/distributions/ubuntu/debian-sflphone-client-gnome/control.jaunty b/tools/build-system/distributions/ubuntu/debian-sflphone-client-gnome/control.jaunty
index 4846a69bfb..9b9c3130e5 100644
--- a/tools/build-system/distributions/ubuntu/debian-sflphone-client-gnome/control.jaunty
+++ b/tools/build-system/distributions/ubuntu/debian-sflphone-client-gnome/control.jaunty
@@ -2,7 +2,7 @@ Source: sflphone-client-gnome
Maintainer: SavoirFaireLinux Inc <emmanuel.milou@savoirfairelinux.com>
Section: gnome
Priority: optional
-Build-Depends: debhelper (>= 5), libgcc1, autoconf, automake, libtool, libgtk2.0-dev (>=2.16), libdbus-glib-1-dev, libnotify-dev, libebook1.2-dev, check, liblog4c-dev
+Build-Depends: debhelper (>= 5), libgcc1, autoconf, automake, libtool, libgtk2.0-dev (>=2.16), libdbus-glib-1-dev, libnotify-dev, libebook1.2-dev, check, liblog4c-dev, libgnomeui-dev
Standards-Version: 3.7.3
Package: sflphone-client-gnome
diff --git a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.hardy b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.hardy
index a92d005977..e14674d170 100644
--- a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.hardy
+++ b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.hardy
@@ -2,7 +2,7 @@ Source: sflphone-common
Maintainer: SavoirFaireLinux Inc <emmanuel.milou@savoirfairelinux.com>
Section: gnome
Priority: optional
-Build-Depends: debhelper (>= 5), libgcc1, autoconf, automake, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, uuid-dev, libexpat1-dev, libzrtpcpp-dev
+Build-Depends: debhelper (>= 5), libgcc1, autoconf, automake, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, uuid-dev, libexpat1-dev
Standards-Version: 3.7.3
Package: sflphone-common
diff --git a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.intrepid b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.intrepid
index 0021d165f0..270e678112 100644
--- a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.intrepid
+++ b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.intrepid
@@ -2,7 +2,7 @@ Source: sflphone-common
Maintainer: SavoirFaireLinux Inc <emmanuel.milou@savoirfairelinux.com>
Section: gnome
Priority: optional
-Build-Depends: debhelper (>= 5), libgcc1 , autoconf, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, libspeexdsp-dev, uuid-dev, libexpat1-dev, libzrtpcpp-dev
+Build-Depends: debhelper (>= 5), libgcc1 , autoconf, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, libspeexdsp-dev, uuid-dev, libexpat1-dev
Standards-Version: 3.8.0
Package: sflphone-common
diff --git a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.jaunty b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.jaunty
index 774b06aee7..8a99d63922 100644
--- a/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.jaunty
+++ b/tools/build-system/distributions/ubuntu/debian-sflphone-common/control.jaunty
@@ -2,7 +2,7 @@ Source: sflphone-common
Maintainer: SavoirFaireLinux Inc <emmanuel.milou@savoirfairelinux.com>
Section: gnome
Priority: optional
-Build-Depends: debhelper (>= 5), libgcc1 , autoconf, automake, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, libspeexdsp-dev, uuid-dev, libexpat1-dev, libzrtpcpp-dev
+Build-Depends: debhelper (>= 5), libgcc1 , autoconf, automake, libpulse-dev, libsamplerate0-dev, libcommoncpp2-dev, libccrtp-dev, libgsm1-dev, libspeex-dev, libtool, libdbus-1-dev, libasound2-dev, libspeexdsp-dev, uuid-dev, libexpat1-dev, libzrtpcpp-dev, libssl-dev
Standards-Version: 3.7.3
Package: sflphone-common
--
GitLab