Developer output format for user documentation

[Timothée Giet]

Hi,

Thanks Johnny for raising this topic.

About the intermediate format choice, I think latex could be a good
choice as I think it has good support for non-latin languages, I'm not
sure about this for docbook.

About the content, sure it would be great to reuse the documentation and
translations we have inside the application. Though we will need some
additional content for:
-A generic presentation of how GCompris works
-the main settings
-the in-activity settings
-the command line options

and maybe other points I didn't think about yet.

Timo.


Le 06/05/2020 à 15:05, Johnny Jazeix a écrit :
> Hi,
>
> With multiple dataset coming, we have a great opportunity to generate
> a user manual from the code.
>
> By parsing the ActivityInfo.qml and Data.qml files, we have a lot of
> information on activities and on how to use GCompris.
>
> For the final users, what is good would be to have both an online
> manual (html pages) and offline (pdf).
>
> I was wondering which intermediate format we should use to generate
> these: latex, docbook...
>
> Do you have any preference?
>
> Regarding translations, as we use the same strings as in GCompris, the
> aim is to retrieve the existing po files directly and not add new
> strings (or only the minimum in a separate po file).
>
> Johnny