How to translate manual written in AsciiDoc

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

How to translate manual written in AsciiDoc

VibekeTB
I am not a developer. I want to move our manuals and online help from Word (where I am a super user) to MadCap Flare which I have only used for a few months but am impressed with. It has a WYSYWYG interface and great capabilities. But my developer colleagues are trying to convince me to user AsciiDoc for writing all our manuals and online help. And I can see some of the attraction, though I am convinced et.

I have a question about when we need to translate our manuals or online help to another language. Are there professional translation tools that support the adoc format? So far I have tested MadCap Lingo and SDL Trados Studio and they cannot read the format. Would we need to export to html to translate? And how do you convert the localised files back to the adoc format after translation?

Reply | Threaded
Open this post in threaded view
|

Re: How to translate manual written in AsciiDoc

ciampix
On Mon, Nov 13, 2017 at 07:49:45AM -0700, VibekeTB [via Asciidoctor :: Discussion] wrote:

>
>
> I am not a developer. I want to move our manuals and online help from Word
> (where I am a super user) to MadCap Flare which I have only used for a few
> months but am impressed with. It has a WYSYWYG interface and great
> capabilities. But my developer colleagues are trying to convince me to user
> AsciiDoc for writing all our manuals and online help. And I can see some of
> the attraction, though I am convinced et.
>
> I have a question about when we need to translate our manuals or online help
> to another language. Are there professional translation tools that support
> the adoc format? So far I have tested /MadCap Lingo /and /SDL Trados Studio/
> and they cannot read the format. Would we need to export to html to
> translate? And how do you convert the localised files back to the adoc
> format after translation?

The KiCad (http://kicad-pcb.org/) documentation
(http://kicad-pcb.org/help/documentation/) is written in Asciidoc and
translated in multiple languages (currently 9) and multiple formats
(html, pdf and epub) through the use of po4a
(http://po4a.alioth.debian.org/) and some convenient (c)make files. See
this for some considerations that have brough us to choose Asciidoc:
https://github.com/KiCad/kicad-doc/tree/master/doc_alternatives

With this method you can use any po file editor you like (poedit, emacs,
vim, etc.), even on-line services like transifex
(https://www.transifex.com/), Pootle (http://pootle.translatehouse.org/)
or Launchpad (https://launchpad.net/)

Regards

--


Marco Ciampa

I know a joke about UDP, but you might not get it.

------------------------

 GNU/Linux User #78271
 FSFE fellow #364

------------------------

Reply | Threaded
Open this post in threaded view
|

Re: How to translate manual written in AsciiDoc

ciampix
In reply to this post by VibekeTB
On Mon, Nov 13, 2017 at 07:49:45AM -0700, VibekeTB [via Asciidoctor :: Discussion] wrote:

>
>
> I am not a developer. I want to move our manuals and online help from Word
> (where I am a super user) to MadCap Flare which I have only used for a few
> months but am impressed with. It has a WYSYWYG interface and great
> capabilities. But my developer colleagues are trying to convince me to user
> AsciiDoc for writing all our manuals and online help. And I can see some of
> the attraction, though I am convinced et.
>
> I have a question about when we need to translate our manuals or online help
> to another language. Are there professional translation tools that support
> the adoc format? So far I have tested /MadCap Lingo /and /SDL Trados Studio/
> and they cannot read the format. Would we need to export to html to
> translate? And how do you convert the localised files back to the adoc
> format after translation?

The KiCad (http://kicad-pcb.org/) documentation
(http://kicad-pcb.org/help/documentation/) is written in Asciidoc and
translated in multiple languages (currently 9) and multiple formats
(html, pdf and epub) through the use of po4a
(http://po4a.alioth.debian.org/) and some convenient (c)make files. See
this for some considerations that have brough us to choose Asciidoc:
https://github.com/KiCad/kicad-doc/tree/master/doc_alternatives

With this method you can use any po file editor you like (poedit, emacs,
vim, etc.), even on-line services like transifex
(https://www.transifex.com/), Pootle (http://pootle.translatehouse.org/)
or Launchpad (https://launchpad.net/)

Regards

--


Marco Ciampa

I know a joke about UDP, but you might not get it.

------------------------

 GNU/Linux User #78271
 FSFE fellow #364

------------------------