diff --git a/sflphone-client-gnome/doc/C/sflphone.xml b/sflphone-client-gnome/doc/C/sflphone.xml index 296faa412d4d9523d0ec70db52fa48860c678d41..1d103c8587e164e3c69e20533bdeb8dfb4d85399 100644 --- a/sflphone-client-gnome/doc/C/sflphone.xml +++ b/sflphone-client-gnome/doc/C/sflphone.xml @@ -5,7 +5,7 @@ ]> <!-- =============Document Header ============================= --> -<article id="index" lang="en"> + <article id="index" lang="en"> <!-- please do not change the id; for translations, change lang to --> <!-- appropriate code --> <articleinfo> @@ -447,7 +447,7 @@ </sect2> - <sect2 label="Direct IP calls"> + <sect2 id="directip" label="Direct IP calls"> <para>A direct IP call is a call established between two peers without any accounts. When dialing, such a call must prefixed with <guilabel>sip:</guilabel>.</para> <para>Direct IP calls use SIP protocol to establish communication and RTP to transport data. It is right now not available with IAX2.</para> @@ -533,7 +533,7 @@ <!-- ==== Figure ==== --> <figure id="addressbook-fig"> - <title>&app; toolbar</title> + <title>Address book toolbar button</title> <screenshot> <mediaobject> <imageobject> @@ -556,4 +556,184 @@ </sect2> </sect1> +<sect1 id="preferences"> + <title>Preferences</title> + + <para>Go to <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice> to access the configuration panel.</para> + <para>Each section is detailed below.</para> + + <sect2> + <title>General</title> + <para>This section provides the user general settings regarding the application.</para> + <sect3 label="Desktop Notifications"> + <!-- ==== Figure ==== --> + <figure id="desktop-notif-settings-fig"> + <title>Desktop notifications options</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/desktop-notif-settings.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + <!-- ==== End of Figure ==== --> + + + <variablelist> + <varlistentry> + <term><guilabel>Enable notifications</guilabel></term> + <listitem><para> + Both clients use their desktop environment notification system. If checked, you will receive desktop notifications for events such as incoming calls and system messages. + </para> + <figure id="notif-example-fig"> + <title>Example of an incoming call notification</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/notif-example.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + </listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Enable voicemail notifications</guilabel></term> + <listitem><para> + The voicemail notifications are handled separatly. If checked, you will be notified with the number of unread voicemails for your accounts. + </para> + <figure id="voicemail-notif-fig"> + <title>Example of a voicemail notification</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/voicemail-notif.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + + + </listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 label="System Tray Icon"> + <!-- ==== Figure ==== --> + <figure id="systemtray-settings-fig"> + <title>System tray options</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/systemtray-settings.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + <!-- ==== End of Figure ==== --> + + + <variablelist> + <varlistentry> + <term><guilabel>Popup main window on incoming call</guilabel></term> + <listitem><para> + If SFLphone is closed on the system tray, pops the main window up on foreground when receiving an incoming call. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Never popup main window</guilabel></term> + <listitem><para> + If SFLphone is closed on the system tray, never pops the main window up on foreground when receiving an incoming call. + </para></listitem> + </varlistentry> + <varlistentry> + <term><guilabel>Hide SFLphone window on startup</guilabel></term> + <listitem><para> + On startup, SFLphone will go directly on the system tray. + </para></listitem> + </varlistentry> + + </variablelist> + + </sect3> + + + <sect3 label="Calls history"> + <!-- ==== Figure ==== --> + <figure id="callshistory-settings-fig"> + <title>Calls history options</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/callshistory-settings.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + <!-- ==== End of Figure ==== --> + + <variablelist> + <varlistentry> + <term><guilabel>Keep my history for at least n days</guilabel></term> + <listitem><para> + If checked, calls will be kept up to N days in the history. You may select a custom number of days. Do not check it if you don't want to use this feature. + </para></listitem> + </varlistentry> + </variablelist> + </sect3> + + <sect3 label="Configuration File"> + <!-- ==== Figure ==== --> + <figure id="configfile-settings-fig"> + <title>Configuration file options</title> + <screenshot> + <mediaobject> + <imageobject> + <imagedata fileref="figures/configfile-settings.png" format="PNG"/> + </imageobject> + </mediaobject> + </screenshot> + </figure> + <!-- ==== End of Figure ==== --> + + <variablelist> + <varlistentry> + <term><guilabel>Store SIP credentials as MD5 hash</guilabel></term> + <listitem><para> + If checked, your password information will be encrypted in the configuration file, instead of plain text. + </para></listitem> + </varlistentry> + </variablelist> + + + </sect3> + </sect2> + + <sect2> + <title>Audio</title> + </sect2> + + <sect2> + <title>Address book</title> + + <para>Refer to the <link linkend='addressbook'>Address books</link> section for more information.</para> + </sect2> + + <sect2> + <title>Hooks</title> + </sect2> + + <sect2> + <title>Network</title> + </sect2> + + <sect2> + <title>Direct IP calls</title> + <para>Refer to the <link linkend='directip'>Direct IP calls</link> section for more information.</para> + </sect2> +</sect1> + + </article> diff --git a/sflphone-client-gnome/doc/Makefile.am b/sflphone-client-gnome/doc/Makefile.am index a16b94b4a24d7a29c84d67bfa05cb9ba52c2f04d..fc8f89d31d95bd3e0cfe6361e6d7f76bc4250e3d 100644 --- a/sflphone-client-gnome/doc/Makefile.am +++ b/sflphone-client-gnome/doc/Makefile.am @@ -16,5 +16,11 @@ DOC_FIGURES = figures/addressbook-button.png \ figures/transfer.png \ figures/transfer-go.png \ figures/voicemail.png \ - figures/rec-settings.png + figures/rec-settings.png \ + figures/desktop-notif-settings.png \ + figures/callshistory-settings.png \ + figures/configfile-settings.png \ + figures/notif-example.png \ + figures/systemtray-settings.png \ + figures/voicemail-notif.png DOC_LINGUAS = fr de es it zh_TW zh_HK zh_CN ko pl pt_BR pt ru