Tryton - Documentation

[Axel Braun]

Dear Community,

I would like to point you to a discussion on the german mailing list:
https://groups.google.com/forum/m/#!msg/tryton-de/Q8pcB-cO3xc/Mt1JzwUj51gJ

It deals with the creation of holistic User- and Admin documentation for
Tryton. Target language is currently german, but it is build up in a way that
it can be translated to other languages (e.g. the reftags are in English).

The documentation was created by our Debain -Maintainer and long-term Tryton-
supporter Mathias Behrle as a crowd-funding approach: One part will be funded
by customers, one part by Mathias, and some amount (3000€) needs to come from
the community.

The german community is currently committed to 1950€. I would like to bring
this to your attention in order to fund the missing amount.

I feel this may be interesting as a translation basis for langages different
from Spanish or English.

For a proof-reading in german see http://www.m9s.biz/doku/

Happy funding!
Axel

[Raimon Esteve]

Hie

Last Tryton Unconference in Belgium and Catalonia (Barcelona), Nan's
guys present a trytond-doc project.

It's easy:

1- Use Sphinx and inherit doc. Depend modules you installed, you could
generate a custom documentation.
2- Fields, menus and views (screens) from your trytond
server-database. In case next version change a label field, name
menu,... is not necessary to change in your documentation.

Some references:

trydoc on pypi: https://pypi.python.org/pypi/trydoc/
Spanish DOC source: https://bitbucket.org/trytonspain/trytond-doc
Spanish User DOC: http://doc.tryton-erp.es/

Regards,

Raimon

[Albert Cervera i Areny]

2016-03-31 0:18 GMT+02:00 Raimon Esteve <raimon...@gmail.com>:
> Hie
>
> 2016-03-30 22:02 GMT+02:00 Axel Braun <axel....@gmx.de>:
>> Dear Community,
>>
>> I would like to point you to a discussion on the german mailing list:
>> https://groups.google.com/forum/m/#!msg/tryton-de/Q8pcB-cO3xc/Mt1JzwUj51gJ
>>
>> It deals with the creation of holistic User- and Admin documentation for
>> Tryton. Target language is currently german, but it is build up in a way that
>> it can be translated to other languages (e.g. the reftags are in English).
>>
>> The documentation was created by our Debain -Maintainer and long-term Tryton-
>> supporter Mathias Behrle as a crowd-funding approach: One part will be funded
>> by customers, one part by Mathias, and some amount (3000€) needs to come from
>> the community.
>>
>> The german community is currently committed to 1950€. I would like to bring
>> this to your attention in order to fund the missing amount.
>>
>> I feel this may be interesting as a translation basis for langages different
>> from Spanish or English.
>>
>> For a proof-reading in german see http://www.m9s.biz/doku/
>
> Last Tryton Unconference in Belgium and Catalonia (Barcelona), Nan's
> guys present a trytond-doc project.

And with Zikzakmedia's help we have pretty good coverage, specially
for base modules, accounting, sales and purchases.

>
> It's easy:
>
> 1- Use Sphinx and inherit doc. Depend modules you installed, you could
> generate a custom documentation.
> 2- Fields, menus and views (screens) from your trytond
> server-database. In case next version change a label field, name
> menu,... is not necessary to change in your documentation.
>
> Some references:
>
> trydoc on pypi: https://pypi.python.org/pypi/trydoc/
> Spanish DOC source: https://bitbucket.org/trytonspain/trytond-doc
> Spanish User DOC: http://doc.tryton-erp.es/
>
> Regards,
>
> Raimon
>

> --
> You received this message because you are subscribed to the Google Groups "tryton" group.
> To view this discussion on the web visit https://groups.google.com/d/msgid/tryton/CAN2HbXVCDkawW0iREFB1iRzU_OYN5nf5woKW1tVtaHzb-0kOTQ%40mail.gmail.com.



--
Albert Cervera i Areny
http://www.NaN-tic.com
Tel. 93 553 18 03

[Dominique Chabord]

Hello,

Seems this german discussion is two years old. Any update since ?

@Albert : can you tell us what prevents your initial proposal to
expand more widely ? Are there still issues that need a general
agreement ?

A point which is unclear to me is translationsystem. Can you tell us
what the best translation strategy would be in your idea ?

Regards

> To view this discussion on the web visit https://groups.google.com/d/msgid/tryton/CADWJ7GmO__6sEAFeDuCnWQx-0XDXkZNPfqHtK80hWgrS_ijZcg%40mail.gmail.com.

[Albert Cervera i Areny]

2016-03-31 10:56 GMT+02:00 Dominique Chabord <dominiqu...@sisalp.org>:
> Hello,
>
> Seems this german discussion is two years old. Any update since ?
>
> @Albert : can you tell us what prevents your initial proposal to
> expand more widely ?

Contributions... and a version in English.

As we already stated we do not have the resources for creating the
documentation in English and then translating it into Spanish (and we
need the latter at least), so we went ahead and wrote it in Spanish.

> Are there still issues that need a general
> agreement ?

Not really, unless somebody wants to propose some changes :) The docs
of core modules are in a separate repository so we don't need the doc
to be integrated in core.

> A point which is unclear to me is translationsystem. Can you tell us
> what the best translation strategy would be in your idea ?

There are several things to consider:

- Images: As they're rendered dynamically, the language is the one you
configure in the database so it already supports any language.
- Menu entries and other texts: Same as above. It's taken from the database.
- The text/documentation itself: The idea is to have a directory per
language, so it'd be in the line of wikipedia or Tryton's web page,
where each language has its documents. Yet, Sphinx has a translation
system so if there was a real effort to write the docs in english
first, we could use Sphinx tools so we have a source language and the
rest are real translations instead of separate documents.

The key, and I have a hard time thinking it's really going to happen
soon is that somebody steps up and writes the original documentation
in English.

> To view this discussion on the web visit https://groups.google.com/d/msgid/tryton/CAHZrxK5gYc0F0Rz64gqsyH1WG96gmg2gok6T2AGiOTaw69SLNA%40mail.gmail.com.

[Axel Braun]

Hi,

Am Donnerstag, 31. März 2016, 11:27:36 schrieb Albert Cervera i Areny:

> > Seems this german discussion is two years old. Any update since ?

I think Mathias continues to work on this.....

> > @Albert : can you tell us what prevents your initial proposal to
> > expand more widely ?
>
> Contributions... and a version in English.
>
> As we already stated we do not have the resources for creating the
> documentation in English and then translating it into Spanish (and we
> need the latter at least), so we went ahead and wrote it in Spanish.

Yes, this is difficult in any case, if you are not a native speaker (ES->EN,
DE->EN). As written, the tags in the german approach are already in english,
whereas the spanish version has spanish tags:

http://doc.tryton-erp.es/_sources/party/party.txt
.. inheritref:: party/party:section:crear-un-tercero
.. inheritref:: party/party:paragraph:identificadores
.. inheritref:: party/party:section:terceros-multicompania
.. inheritref:: party/party:section:informes

Another difference that i could see that Mathias' approach is closer to the
menu structure, additional to the functional descriptions. That makes live for
newbies easier.

Dont get me wrong Albert, I dont want to 'rate down' the work of you and your
team! Purpose was just to point out that there is some other work that wants
to be finished, Differences are normal and a way to learn from each other

Have a good evening
Axel

[Albert Cervera i Areny]

Indeed. Our idea is not to follow the menu structure but the
processes. Hence the difference.

>
> Have a good evening
> Axel
>

> --
> You received this message because you are subscribed to the Google Groups "tryton" group.

> To view this discussion on the web visit https://groups.google.com/d/msgid/tryton/3628342.61lO65AEeo%40t520.axxite.internal.