digiKam and Showfoto documentation : we needs contributors

[Gilles Caulier-4]

Hi all digiKam users,

Following all messages posted here, we can said that application documentation need to be re-written, updated, fixed a lots. There are important question posted in this room which must be factored in the user documentation.

This one was not been updated and maintained since.... 2011. The current doc is not so bad but a lots of parts are missing and need a fresh update using 5.x release.

Few weeks ago, i was contacted by Wolfgang Scheffner, a German user who want to contribute to write documentation. So i started to review all files, and prepare the contents to be updated.

See my post on this bugzilla entry for details :

https://bugs.kde.org/show_bug.cgi?id=238802#c3

The documentation is written in docbook format (XML based). It's not too complicated to understand. In all cases, if a possible contributor don't want to touch docbook file as well, I can process integration of simple text file in docbook as well. The most important is to have English contents to share in the documentation about most common operations done by end users with digiKam.

A first approach to update the documentation is to backport and adapt the old contents from KDE wiki pages :

https://userbase.kde.org/Digikam/Tutorials

I'm still open for all questions about this topic if someone is interested to contribute and share experience through the official documentation.

Thanks in advance

Gilles Caulier

 

[Carsten Fuchs]

Hi Gilles,

Am 2016-08-27 um 12:11 schrieb Gilles Caulier:
> The documentation is written in docbook format (XML based).

Have you considered using http://asciidoctor.org/ ?

Best regards,
Carsten

[Gilles Caulier-4]

No. I never hear about this tool...

But in fact, the docbook syntaxt used to write the handbook is not complicated, as it's really limited to few XML sentences to build section, link, title, and screenshot.

Gilles Caulier

2016-08-28 10:14 GMT+02:00 Carsten Fuchs <[hidden email]>:

Hi Gilles,

Am 2016-08-27 um 12:11 schrieb Gilles Caulier:

The documentation is written in docbook format (XML based).

Have you considered using http://asciidoctor.org/ ?

Best regards,
Carsten

[Carsten Fuchs]

Am 2016-08-28 um 10:27 schrieb Gilles Caulier:
> No. I never hear about this tool...
>
> But in fact, the docbook syntaxt used to write the handbook is not
> complicated, as it's really limited to few XML sentences to build
> section, link, title, and screenshot.

I used to write all my documentation in LaTeX, HTML (more or less
handwritten), a couple of other formats and (many years ago) made an
attempt at DocBook, rejecting it as I just found it too complicated to
deal with (a lot more complicated than LaTeX).

Recently I had to redo a documentation that was originally written in
Word, using the opportunity to try out AsciiDoc(tor), using PanDoc for
the conversion. It took a bit to set up and get used to (mostly because
I normally don't deal with Ruby), and I've only begun with it, but so
far, I'm very happy. It's the first tool that I use whose main purpose
is to generate DocBook output (although I'll likely skip that and take
the HTML, PDF and e-Book output directly).

Best regards,
Carsten

Le 28/08/2016 à 10:52, Carsten Fuchs a écrit :

> Recently I had to redo a documentation that was originally written in
> Word, using the opportunity to try out AsciiDoc(tor), using PanDoc for
> the conversion.

I was said that pandoc can do nearly every conversion, so do not too
much fear the original format.

tldp.org may give clues.

jdd