Skip to content
Snippets Groups Projects
Commit 9e38e1ac authored by Emmanuel Milou's avatar Emmanuel Milou
Browse files

[#1976] Build documentation squeleton with docbook

parent 862a96e0
No related branches found
No related tags found
No related merge requests found
################################################################################################################
TIPS
I already created page samples. Each docbook document represents a chapter in the user manual. The file manual.docbook is the main file, and includes all the chapters to build one document.
# Adding a new chapter
Create a new file new-chapter.docbook. Copy the squeleton of an other docbook file if needed. These files are xml-based files. Here is a link to a quick overview of the syntax to use:
http://www.ibm.com/developerworks/library/l-docbk.html.
Then add your new file reference in manual.docbook (at the beginning and at the end)
You are done!
# Generating the manual
You may need to install sgmltools-lite package: sudo apt-get install sgmltools-lite
Run:
sgmltools -b html manual.docbook
It will output HTML files in the manual directory.
Enjoy !
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="accounts">
<title>SIP/IAX2 accounts</title>
<para>
</para>
</chapter>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="addressbook">
<title>How to use the address books</title>
<para>
</para>
</chapter>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="audio">
<title>Audio configuration</title>
<sect1 label="Audio interfaces">
<para>
ALSA and Pulseaudio native interfaces are available.
</para>
<sect2 label="Pulseaudio">
<para>
</para>
</sect2>
<sect2 label="ALSA">
<para>
</para>
</sect2>
</sect1>
<sect1 label="Codecs overview">
<para>
</para>
</sect1>
</chapter>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="introduction">
<title>A brief introduction to SFLphone</title>
<para>
SFLphone 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>
SFLphone 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, SFLphone supports advanced enterprise-class call features: unlimited number of calls, call transfer and on/off hold option.
</para>
<para>
Besides the native ALSA interface, SFLphone now fully supports PulseAudio sound server so you could experience the great possibilities it offers (sound mixing, per application volume control, ...).
</para>
</chapter>
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY sflphone "SFLphone">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" >
<!-- chapters in separate docbook files -->
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY accounts SYSTEM "accounts.docbook">
<!ENTITY secure SYSTEM "secure.docbook">
<!ENTITY audio SYSTEM "audio.docbook">
<!ENTITY addressbook SYSTEM "addressbook.docbook">
]>
<book>
<bookinfo>
<title>&sflphone; User Manual</title>
<date>2009-08-06</date>
<releaseinfo>&sflphonerelease;</releaseinfo>
<authorgroup>
<author>
<firstname>Pierre-Luc</firstname>
<surname>Bacon</surname>
<affiliation>
<address><email>pierre-luc.bacon@savoirfairelinux.com</email></address>
</affiliation>
</author>
<author>
<firstname>Emmanuel</firstname>
<surname>Milou</surname>
<affiliation>
<address><email>emmanuel.milou@savoirfairelinux.com</email></address>
</affiliation>
</author>
<author>
<firstname>J&eacute;r&eacute;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>
<copyright>
<year>2009</year>
<holder>Savoir-faire Linux Inc</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<abstract>
SFLphone is an enterprise-class SIP/IAX2 compatible softphone for GNU/Linux, published under the GPLv3 license.
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>GNOME</keyword>
<keyword>SFLphone</keyword>
<keyword>client</keyword>
<keyword>softphone</keyword>
<keyword>enterprise</keyword>
</keywordset>
</bookinfo>
&introduction;
&accounts;
&audio;
&addressbook;
&secure;
</book>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<chapter id="secure">
<title>Secure communications</title>
<para>
<para>
</chapter>
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment