2005-10-24 [mones] 1.9.15cvs98

* manual/Makefile
	* manual/account.xml
	* manual/ack.xml
	* manual/addrbook.xml
	* manual/advanced.xml
	* manual/faq.xml
	* manual/glossary.xml
	* manual/gpl.xml
	* manual/handling.xml
	* manual/intro.xml
	* manual/keyboard.xml
	* manual/manual.xml
	* manual/plugins.xml
	* manual/starting.xml
	* manual/dtd/sdocbook.dtd
		Initial manual structure and some content.
This commit is contained in:
Ricardo Mones 2005-10-24 10:09:38 +00:00
parent d417a9254d
commit 4fb5834b5d
18 changed files with 2505 additions and 1 deletions

View file

@ -1,3 +1,22 @@
2005-10-24 [mones] 1.9.15cvs98
* manual/Makefile
* manual/account.xml
* manual/ack.xml
* manual/addrbook.xml
* manual/advanced.xml
* manual/faq.xml
* manual/glossary.xml
* manual/gpl.xml
* manual/handling.xml
* manual/intro.xml
* manual/keyboard.xml
* manual/manual.xml
* manual/plugins.xml
* manual/starting.xml
* manual/dtd/sdocbook.dtd
Initial manual structure and some content.
2005-10-23 [wwp] 1.9.15cvs97
* src/gtk/about.c

View file

@ -934,3 +934,4 @@
( cvs diff -u -r 1.11 -r 1.12 src/.cvsignore; ) > 1.9.15cvs95.patchset
( cvs diff -u -r 1.4.2.19 -r 1.4.2.20 src/gtk/about.c; cvs diff -u -r 1.1.2.1 -r 1.1.2.2 src/gtk/authors.h; ) > 1.9.15cvs96.patchset
( cvs diff -u -r 1.4.2.20 -r 1.4.2.21 src/gtk/about.c; ) > 1.9.15cvs97.patchset
( diff -u /dev/null manual/Makefile; diff -u /dev/null manual/account.xml; diff -u /dev/null manual/ack.xml; diff -u /dev/null manual/addrbook.xml; diff -u /dev/null manual/advanced.xml; diff -u /dev/null manual/faq.xml; diff -u /dev/null manual/glossary.xml; diff -u /dev/null manual/gpl.xml; diff -u /dev/null manual/handling.xml; diff -u /dev/null manual/intro.xml; diff -u /dev/null manual/keyboard.xml; diff -u /dev/null manual/manual.xml; diff -u /dev/null manual/plugins.xml; diff -u /dev/null manual/starting.xml; diff -u /dev/null manual/dtd/sdocbook.dtd; ) > 1.9.15cvs98.patchset

View file

@ -11,7 +11,7 @@ MINOR_VERSION=9
MICRO_VERSION=15
INTERFACE_AGE=0
BINARY_AGE=0
EXTRA_VERSION=97
EXTRA_VERSION=98
EXTRA_RELEASE=
EXTRA_GTK2_VERSION=

33
manual/Makefile Normal file
View file

@ -0,0 +1,33 @@
# Makefile for Sylpheed-Claws manual generation from DocBook sources.
# Copyright 2005 by Ricardo Mones and the Sylpheed-Claws Team.
# Inspired by "The Debian SGML/XML HOWTO" by Stéphane Bortzmeyer.
# This is distributed according to the General Public License.
#
MAIN=manual
XMLS=$(glob *.xml)
OUT=dist
all: $(MAIN)
$(MAIN): $(OUT) $(MAIN).pdf $(MAIN).ps $(MAIN).txt $(MAIN).html
@echo "Generation Ok."
$(OUT):
mkdir -p $(OUT)
$(MAIN).pdf: $(XMLS)
docbook2pdf -o $(OUT)/pdf $(MAIN).xml
$(MAIN).ps: $(XMLS)
docbook2ps -o $(OUT)/ps $(MAIN).xml
$(MAIN).html: $(XMLS)
docbook2html -o $(OUT)/html $(MAIN).xml
$(MAIN).txt: $(XMLS)
docbook2txt -o $(OUT)/txt $(MAIN).xml
clean:
rm -rf dist

36
manual/account.xml Normal file
View file

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_account">
<title>Account customisation</title>
<section id="account_basic">
<title>Basic preferences</title>
<para>
</para>
</section>
<section id="account_prefs">
<title>Preferences for writting</title>
<para>
</para>
</section>
<section id="account_types">
<title>Account types</title>
<para>
</para>
</section>
<section id="account_multiple">
<title>Multiple accounts</title>
<para>
</para>
</section>
<section id="account_morefilt">
<title>More filtering</title>
<para>
</para>
</section>
</section>

7
manual/ack.xml Normal file
View file

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<appendix id="ap_ack">
<title>Acknowledgements</title>
<para>
</para>
</appendix>

41
manual/addrbook.xml Normal file
View file

@ -0,0 +1,41 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_addrbook">
<title>Address book</title>
<section id="addrbk_basic">
<title>Basic management</title>
<para>
</para>
</section>
<section id="addrbk_expimp">
<title>Exporting and importing addresses</title>
<para>
</para>
</section>
<section id="addrbk_advanced">
<title>Advanced features</title>
<section id="addrbk_adv_ldap">
<title>Using LDAP servers</title>
<para>
</para>
</section>
<section id="addrbk_adv_jpilot">
<title>Integration with JPilot</title>
<para>
</para>
</section>
<section id="addrbk_adv_vcard">
<title>VCard support</title>
<para>
</para>
</section>
</section>
</section>

39
manual/advanced.xml Normal file
View file

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_advanced">
<title>Advanced features</title>
<section id="adv_actions">
<title>Actions</title>
<para>
</para>
</section>
<section id="adv_templates">
<title>Templates</title>
<para>
</para>
</section>
<section id="adv_processing">
<title>Processing</title>
<para>
</para>
</section>
<section id="adv_plugins">
<title>Plugins</title>
<para>
Plugins are the mechanism of extending Sylpheed-Claws capabilities. Imagine you want to store your mails in a remote <acronym>SQL</acronym> database. In most mailers out there this is simply impossible without reworking the internals of it. With Sylpheed-Claws you can simply write a plugin to achieve the task.
</para>
<para>This is only an example of the possibilities. Already exist a good number of plugins developed for Sylpheed-Claws, and more are to come. The <link linkend="ch_plugins">Extending Sylpheed-Claws section</link> is devoted to all of them.
</para>
</section>
<section id="adv_hidden">
<title>Hidden preferences</title>
<para>
</para>
</section>
</section>

1885
manual/dtd/sdocbook.dtd Normal file

File diff suppressed because it is too large Load diff

235
manual/faq.xml Normal file
View file

@ -0,0 +1,235 @@
<?xml version="1.0" encoding="utf-8"?>
<appendix id="ap_faq">
<title>The Sylpheed-Claws FAQ</title>
<section id="faq_general">
<title>General information</title>
<section>
<title>What is Sylpheed? What is Sylpheed-Claws?</title>
<para>
Sylpheed is an e-mail client (and news reader) based on GTK+, running on the X Window System, and aiming for:
</para>
<itemizedlist>
<listitem>
<para>
Quick response
</para>
</listitem>
<listitem>
<para>
Graceful, and sophisticated interface
</para>
</listitem>
<listitem>
<para>
Easy configuration, intuitive operation
</para>
</listitem>
<listitem>
<para>
Abundant features
</para>
</listitem>
</itemizedlist>
<para>
Sylpheed-Claws is the extended version of Sylpheed.
</para>
</section>
<section>
<title>What are the differences between Sylpheed and Sylpheed-Claws?</title>
<para>
For a list of features, and differences between Sylpheed and Sylpheed-Claws, see <ulink url="http://sylpheed-claws.sourceforge.net/features.php">the online features page</ulink>.
</para>
</section>
<section>
<title>Where can I get Sylpheed-Claws?</title>
<para>
See the <ulink url="http://sylpheed-claws.sourceforge.net/downloads.php">Downloads page</ulink>.
</para>
</section>
<section>
<title>Who writes Sylpheed-Claws?</title>
<para>
Sylpheed-Claws is developed by the Sylpheed-Claws Team. Sylpheed-Claws is also regularly syncronised with the original version of Sylpheed written by Hiroyuki Yamamoto.
</para>
</section>
<section>
<title>What does the name Sylpheed mean?</title>
<para>
It means 'light weight', like air. This comes from the name of the wind spirits, the Sylphs.
</para>
</section>
<section>
<title>How does Sylpheed-Claws store mails?</title>
<para>
Mails are stored in the MH mailfile format as used by MH and EMH. Maildir and mbox formats are supported via two plugins available on the <ulink url="http://sylpheed-claws.sourceforge.net/plugins.php">Plugins page</ulink>.
</para>
</section>
<section>
<title>Why does the auto collection of mail not work?</title>
<para>
Auto collection works since version 0.5.1. If you need it or want it, you should upgrade.
</para>
</section>
<section>
<title>Does Sylpheed-Claws have mail filtering?</title>
<para>
Yes. You can find it in <quote>Configuration</quote> menu, <quote>Filtering...</quote> option.
</para>
</section>
<section>
<title>Can Sylpheed-Claws handle IMAP mail?</title>
<para>
Yes. As of version 0.4.99 IMAP is supported.
</para>
</section>
<section>
<title>Can Sylpheed-Claws handle local unix mailboxes?</title>
<para>
Yes.
</para>
</section>
<section>
<title>Can Sylpheed-Claws handle IPv6?</title>
<para>
Yes, IPv6 is fully supported in Sylpheed-Claws.
</para>
</section>
<section>
<title>How many POP3, News or IMAP accounts can I set up in Sylpheed-Claws?</title>
<para>
The number is not limited. The limit is reached when your computer stops responding.
</para>
</section>
<section>
<title>Does Sylpheed-Claws support encryption like GPG?</title>
<para>
Yes. GPG is implemented and works fine. For activating it in Sylpheed-Claws, see Installation And Configuration section in this FAQ or the appropiate chapter in this manual.
</para>
</section>
<section>
<title>How does Sylpheed-Claws check for MIME types?</title>
<para>
Sylpheed-Claws uses the Mutt type of mime checking.
</para>
</section>
<section>
<title>Does Sylpheed-Claws allow me to write HTML styled messages?</title>
<para>
No. A discussion has gone around over this topic, and the outcome was that HTML mail is not wanted. If you really need to send HTML, you can of course attach a webpage to an e-mail. Several patches have been made to facilitate better HTML handling in Sylpheed. You can find these patches at the Sylpheed Patch Page (see further down in the document).
</para>
</section>
<section>
<title>Does Sylpheed-Claws have name completion in the address fields?</title>
<para>
Yes. When you search for a name that starts with "don", type "don" (without the quotes) and press the TAB key. This will show you the correct name (when only one "don" exists in your addressbook. Otherwise a dropdown list appears, which allows you to select the name you want. E.g. Donald Duck, Don Johnson. But also e-mail addresses starting with "don" will appear in the list (like "don.giovanni@maffia.org").
</para>
</section>
<section>
<title>Fine, but when I hit the TAB key I get an error message.</title>
<para>
When you want to use name completion, make sure that there are names in your address book. If there are no names, even Sylpheed-Claws has a hard time completing something.
</para>
</section>
<section>
<title>Why is Sylpheed-Claws so fast?</title>
<para>
That's what it is designed for!
</para>
</section>
<section>
<title>How can I send in patches, report bugs, talk about Sylpheed-Claws with others?</title>
<para>
To talk to others, you should join the Sylpheed-Claws users' mailing list at <ulink url="http http://sylpheed-claws.sourceforge.net/MLs.php">SourceForge</ulink>.
</para>
</section>
<section>
<title></title>
<para>
</para>
</section>
<section>
<title></title>
<para>
</para>
</section>
<section>
<title></title>
<para>
</para>
</section>
<section>
<title></title>
<para>
</para>
</section>
<section>
<title></title>
<para>
</para>
</section>
</section>
<section id="faq_instconf">
<title>Installation and configuration</title>
<para>
</para>
</section>
<section id="faq_interface">
<title>Interface</title>
<para>
</para>
</section>
<section id="faq_compose">
<title>Composing mails or news</title>
<para>
</para>
</section>
<section id="faq_filtering">
<title>Filtering and processing of messages</title>
<para>
</para>
</section>
<section id="faq_actions">
<title>Actions</title>
<para>
</para>
</section>
<section id="faq_plugins">
<title>Plugins</title>
<para>
</para>
</section>
</appendix>

7
manual/glossary.xml Normal file
View file

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<appendix id="ap_glossary">
<title>Glossary</title>
<para>
</para>
</appendix>

7
manual/gpl.xml Normal file
View file

@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<appendix id="ap_gpl">
<title>License</title>
</appendix>

30
manual/handling.xml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_handling">
<title>Basic mail handling</title>
<section id="handling_folders">
<title>Mail folders</title>
<para>
</para>
</section>
<section id="handling_organise">
<title>Folder organisation</title>
<para>
</para>
</section>
<section id="handling_filters">
<title>Simple mail filters</title>
<para>
</para>
</section>
<section id="handling_searchin">
<title>Searching for mails</title>
<para>
</para>
</section>
</section>

30
manual/intro.xml Normal file
View file

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_intro">
<title>Introduction</title>
<section id="intro_what">
<title>What is Sylpheed-Claws</title>
<para>
</para>
</section>
<section id="intro_whatnot">
<title>What Sylpheed-Claws is not</title>
<para>
</para>
</section>
<section id="intro_features">
<title>Main features</title>
<para>
</para>
</section>
<section id="intro_history">
<title>History of Sylpheed-Claws</title>
<para>
</para>
</section>
</section>

18
manual/keyboard.xml Normal file
View file

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<appendix id="ap_keyboard">
<title>Default keyboard shortcuts</title>
<section id="keyb_mail">
<title>Main window</title>
<para>
</para>
</section>
<section id="keyb_compose">
<title>Compose window</title>
<para>
</para>
</section>
</appendix>

62
manual/manual.xml Normal file
View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article SYSTEM "dtd/sdocbook.dtd" [
<!ENTITY ch_intro SYSTEM "intro.xml">
<!ENTITY ch_starting SYSTEM "starting.xml">
<!ENTITY ch_handling SYSTEM "handling.xml">
<!ENTITY ch_account SYSTEM "account.xml">
<!ENTITY ch_advanced SYSTEM "advanced.xml">
<!ENTITY ch_plugins SYSTEM "plugins.xml">
<!ENTITY ch_addrbook SYSTEM "addrbook.xml">
<!ENTITY ap_faq SYSTEM "faq.xml">
<!ENTITY ap_keyboard SYSTEM "keyboard.xml">
<!ENTITY ap_glossary SYSTEM "glossary.xml">
<!ENTITY ap_ack SYSTEM "ack.xml">
]>
<article>
<title>The Sylpheed-Claws User Manual</title>
<subtitle></subtitle>
<articleinfo>
<corpauthor>
<ulink url="http://claws.sylpheed.org">The Sylpheed Claws Team</ulink>
</corpauthor>
<author><firstname>Abhay</firstname><surname>S. Kushwaha</surname>
</author>
<author><firstname>Colin</firstname><surname>Leroy</surname>
</author>
<author><firstname>Paul</firstname><surname>Mangan</surname>
</author>
<author><firstname>Ricardo</firstname><surname>Mones</surname>
</author>
<author><firstname>Sebastian</firstname><surname>Borkenkaefer</surname>
</author>
<author><firstname>Subash</firstname><surname>Jeyan</surname>
</author>
<copyright>
<year>2005</year>
<holder>The Sylpheed Claws Team.</holder>
</copyright>
<legalnotice id="license">
<para>
This program is free software; you can redistribute it and/or modify it under the terms of the <acronym>GNU</acronym> General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
</para>
<para>
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the <acronym>GNU</acronym> General Public License for more details.
</para>
<para>
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
</para>
</legalnotice>
</articleinfo>
&ch_intro;
&ch_starting;
&ch_handling;
&ch_account;
&ch_advanced;
&ch_plugins;
&ch_addrbook;
&ap_faq;
&ap_keyboard;
&ap_ack;
&ap_glossary;
</article>

18
manual/plugins.xml Normal file
View file

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_plugins">
<title>Extending Sylpheed-Claws</title>
<section id="plugins_default">
<title>Provided plugins</title>
<para>
</para>
</section>
<section id="plugins_external">
<title>More plugins</title>
<para>
</para>
</section>
</section>

36
manual/starting.xml Normal file
View file

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<section id="ch_starting">
<title>Getting started with Sylpheed-Claws</title>
<section id="start_wizard">
<title>The initial wizard</title>
<para>
</para>
</section>
<section id="start_getting">
<title>Getting mail</title>
<para>
</para>
</section>
<section id="start_reading">
<title>Reading mail</title>
<para>
</para>
</section>
<section id="start_writting">
<title>Writting first mail</title>
<para>
</para>
</section>
<section id="start_sending">
<title>Send first mail</title>
<para>
</para>
</section>
</section>