kdeprintfax documentation

[Kurt Pfeifle]

On Thursday 20 April 2006 18:02, Ray Lischner wrote:

> I see that little documentation exists for kdeprintfax. The only way I 
> could figure out how to modify a fax command line was to read the 
> source code. I can share what I learned, so non-programmers can 
> benefit, so I'm willing to write some documentation (e.g., for the 
> command line tags).

That's really great! Thank you for that offer.

> I'm not sure about formats, templates, etc., and  
> where I should send the documentation when done. Any pointers?

KDE documentation is written in DocBook, and checked into the
KDE source code repository as such. From DocBook it is then auto-
converted by different tools into HTML, PDF, whatever.. and also
picked up by the translation teams.

Now, DocBook is not easy to use or learn.

-->  Therefore, it is OK to submit in any non-proprietary, easy to
-->  edit format (ASCII is preferred), and a volunteer will take 
-->  over the job to do the markup.

If you want to have a look at the KDE documentation guidelines
(including docbook + tools), see here:

  http://l10n.kde.org/docs/
  http://l10n.kde.org/docs/doc-primer/
  http://l10n.kde.org/docs/current.php
  http://kde-files.org/content/show.php?content=26176
  http://l10n.kde.org/docs/tools.php  

The kde-doc mailing list is here: 
  
  kde-doc-english at kde.org 
  --> subscribe: https://mail.kde.org/mailman/listinfo/kde-doc-english 

You may find it sometimes the quickest to ask documentation writer
questions in the IRC channel called #kde-docs on Freenode.net.

Once you find yourself comfortable with starting, send a mail to Phil 
Rodriguez (CC'd) and tell him which part of the documentation you are
working on, so he knows. (Phil does some KDE doc work coordination).

Thanks again!

Cheers,
Kurt