[ SourceForge ] SylpheedDoc

Home

Documentation

Contribution

How to contribute to this effort?

Correct and improve the existing documents

Basically, you can rewrite some parts of the existing documents in order to make these parts more clear, more up-to-date, or to correct mistakes. As the Sylpheed documentation is written in the DocBook XML format, this can be done by modifying the appropriate XML source file, or by providing a patch against the current revision of the appropriate XML source file.

If you are not that technically skilled, you can also contribute your changes by simply providing a chunk of modified text from the edited document. Since the DocBook XML format is in principle a plain text, it is not a big deal for the more skilled contributors to supply the required XML markup afterwards. For more information on DocBook XML, please follow the link entitled "The tools we use".

The primary contact place intended for discussions between the Project contributors is the mailing list sylpheeddoc-users@lists.sourceforge.net. You can also access the mailing list archives from your web browser by visiting the mailing lists section on http://sourceforge.net/projects/sylpheeddoc/develop.

Now, if you decide to change a document from the Sylphhed documentation collection available on this site, please contact the Project contributors before that, in order to make sure someone else is not working on the part you want to modify. The best way to do it is to get in touch with others by sending a message to the sylpheeddoc-users@lists.sourceforge.net mailing list.

Read the "The tools we use" section for a complete description of the tools we use to write, store, transform and publish the documentation.

Translate a document

We need translators! If you want to contribute a new translation for the FAQ or the manual, go ahead!

Again, the best way to do it is to get in touch with the Project contributors preferably by sending a message to the sylpheeddoc-users@lists.sourceforge.net mailing list.

The reference version is always the English one (sounds obvious but it does not hurt to repeat it).