Opened 8 years ago

Closed 7 years ago

#5029 closed defect (fixed)

Automate text-to-XHTML translation of Tor user manual

Reported by: rransom Owned by: rransom
Priority: Medium Milestone:
Component: User Experience/Tor Support Version:
Severity: Keywords:
Cc: Runa Actual Points:
Parent ID: Points:
Reviewer: Sponsor:


From the README:

3. Convert the English version of the user manual to XHTML:
    $ pandoc en/tsum.text -o short-user-manual_en.xhtml

    You need to update the xhtml file with header, footer and base64
    representation of how-tor-works.png.

That step should be automated.

(More generally, the whole build process for all languages should be automated.)

Child Tickets

Change History (2)

comment:1 in reply to:  description Changed 8 years ago by runa

Replying to rransom:

(More generally, the whole build process for all languages should be automated.)

Great idea. A few things to consider, though:

  • You want to pull only files that are 100% translated. We don't need to ship documentation that is 50% translated and 50% English. The Transifex client has an option for this.
  • You will need to edit the text to include the header, footer, base64 encoded image and, in general, make the XHTML file look pretty.
  • Every now and then, you end up with a translated file that actually contains some English. An automated build process is fine, but we will still need a manual verification step somewhere.

comment:2 Changed 7 years ago by runa

Resolution: fixed
Status: newclosed

The short user manual is now being translated as XHTML, closing this ticket.

Note: See TracTickets for help on using tickets.