Difference between revisions of "Documentation translation"

From Inkscape Wiki
Jump to navigation Jump to search
Line 1: Line 1:
== Tutorial Translation ==
+
Go Back to the main [http://wiki.inkscape.org/wiki/index.php/Translation_information Translation information] page.
 +
 
 +
= Tutorial Translation =
  
 
Inkscape tutorial sources are in Docbook XML format, with illustrations in SVG. If you want to translate one or more tutorials, first download the Docbook source here:
 
Inkscape tutorial sources are in Docbook XML format, with illustrations in SVG. If you want to translate one or more tutorials, first download the Docbook source here:
Line 21: Line 23:
 
* If after that you want to make any changes, download the file from the above location again, because it may have changed compared to the one you have.
 
* If after that you want to make any changes, download the file from the above location again, because it may have changed compared to the one you have.
  
===Tools===
+
== Tools ==
 
* OmegaT - http://www.omegat.org/omegat/omegat_en/omegat.html
 
* OmegaT - http://www.omegat.org/omegat/omegat_en/omegat.html
 
* Transolution - http://transolution.python-hosting.com/
 
* Transolution - http://transolution.python-hosting.com/
Line 27: Line 29:
 
* see also [[Talk:DocumentationTranslation#Ideas for Improving the Translation Process|Ideas for Improving the Translation Process]]
 
* see also [[Talk:DocumentationTranslation#Ideas for Improving the Translation Process|Ideas for Improving the Translation Process]]
  
====Transforming XML into PO files====
+
=== Transforming XML into PO files ===
 
One can also use xml2po to get PO files out of the XML sources, and also transform the PO files back to XML. After you have a PO file, follow the instructions for editing those files below.
 
One can also use xml2po to get PO files out of the XML sources, and also transform the PO files back to XML. After you have a PO file, follow the instructions for editing those files below.
  
Line 55: Line 57:
 
</pre>
 
</pre>
  
== Keyboard and mouse translation ==
+
= Keyboard and mouse translation =
  
 
* TBD
 
* TBD
  
== User Manual ==
+
= User Manual =
 
* See also [[Embedded Help]]
 
* See also [[Embedded Help]]
 
* First download the user manual xml document from [http://svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/xml/ SVN]
 
* First download the user manual xml document from [http://svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/xml/ SVN]
Line 67: Line 69:
 
* submit your work as a patch in the patch tracker and warn Cédric Gemy (cedric at le-radar.com) by email.
 
* submit your work as a patch in the patch tracker and warn Cédric Gemy (cedric at le-radar.com) by email.
  
== Man pages ==
+
= Man pages =
  
 
* first download inkscape.pod from [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/trunk/inkscape.pod?view=log SVN]
 
* first download inkscape.pod from [http://svn.sourceforge.net/viewcvs.cgi/inkscape/inkscape/trunk/inkscape.pod?view=log SVN]
Line 75: Line 77:
 
* finally, submit your work in the patch tracker and drop a mail to the inkscape devel mailing list.
 
* finally, submit your work in the patch tracker and drop a mail to the inkscape devel mailing list.
  
==Polishing Translations - Microtypography==
+
= Polishing Translations - Microtypography =
 
Here are some things to note in order to achieve good microtypography (typography at the word or character level).
 
Here are some things to note in order to achieve good microtypography (typography at the word or character level).
 
* use the proper quotes (e.g. »foo«)
 
* use the proper quotes (e.g. »foo«)
Line 85: Line 87:
 
* use the proper Unicode codepoint for "..." - "…"
 
* use the proper Unicode codepoint for "..." - "…"
  
===Links===
+
== Links ==
 
* http://de.wikipedia.org/wiki/Typografie (German)
 
* http://de.wikipedia.org/wiki/Typografie (German)
 
* [http://www.dante.de/dante/DTK/dtk96_4/Text/dtk96_4_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil I''] (PDF, German)
 
* [http://www.dante.de/dante/DTK/dtk96_4/Text/dtk96_4_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil I''] (PDF, German)
 
* [http://www.dante.de/dante/DTK/dtk97_1/Text/dtk97_1_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil II''] (PDF, German)
 
* [http://www.dante.de/dante/DTK/dtk97_1/Text/dtk97_1_neubauer_feinheiten.pdf  Marion Neubauer: ''Feinheiten bei wissenschaftlichen Publikationen – Mikrotypographie-Regeln, Teil II''] (PDF, German)
 
* [http://www.zvisionwelt.de/typokurz.pdf Christoph Bier: ''typokurz – Einige wichtige typografische Regeln''] (PDF, German)
 
* [http://www.zvisionwelt.de/typokurz.pdf Christoph Bier: ''typokurz – Einige wichtige typografische Regeln''] (PDF, German)
 +
 +
 +
= Translation information =
 +
Go Back to the main [http://wiki.inkscape.org/wiki/index.php/Translation_information Translation information] page.
  
 
[[Category: Developer Discussion]]
 
[[Category: Developer Discussion]]

Revision as of 08:43, 5 July 2006

Go Back to the main Translation information page.

Tutorial Translation

Inkscape tutorial sources are in Docbook XML format, with illustrations in SVG. If you want to translate one or more tutorials, first download the Docbook source here:

http://svn.sourceforge.net/viewcvs.cgi/inkscape/doc-docbook/trunk/

Each tutorial is in its own subdirectory. You need the *.xml file, for example basic/tutorial-basic.xml. You could get it and simply replace all English text in it with the text in your language, preserving all XML markup. See README at that location for some notes on markup. Other (better) ways are described below.

  • If there's already such a file in SVN, you can edit it instead :) If there's no xml file at the above location but there's a translation of this tutorial in SVG format (in share/tutorials in Inkscape distribution), you'll need to convert it to Docbook (and probably update). Conversion can be done simply by: select the text blocks of an SVG tutorial in Inkscape, Ctrl+C, and Ctrl+V in your text editor, then add the markup.
  • Save your file as <original name>.<language suffix>.xml, for example basic/tutorial-basic.es.xml for Spanish.
  • Do not use symbolic entities like &aacute; (they're not defined in XML without a DTD). Instead use either numeric entities such as &#225; or simply write your text in UTF-8.
  • Most illustrations don't need translations, so you leave the references to them from English XML intact. If however an illustration has some text that you want to translate, open the illustration file in Inkscape (e.g. basic/basic-f12.svg), edit it as needed, and save under a different name (e.g. basic/basic-f12-es.svg). Then change the filename reference in the XML source appropriately.
  • When finished, run xmllint on your file to make sure it's well-formed: xmllint --noout --noent --valid <filename>
  • Send the file to Joshua Andler <scislac at users dot sf dot net>, and he'll convert it to SVG and HTML and upload it to SVN and the web site.
  • If after that you want to make any changes, download the file from the above location again, because it may have changed compared to the one you have.

Tools

Transforming XML into PO files

One can also use xml2po to get PO files out of the XML sources, and also transform the PO files back to XML. After you have a PO file, follow the instructions for editing those files below.

xml2po is available in gnome-doc-utils (http://ftp.gnome.org/pub/gnome/sources/gnome-doc-utils/).

Here are some command lines that were used to translate a German tutorial (the de-locale), please adapt accordingly until we nicely integrate this into our Makefiles.

## use this at the very beginning, when there is no translation at all:
xml2po --output=basic/tutorial-basic.pot basic/tutorial-basic.xml

## use this when there is a *.de.xml, but you want a de.po:
xml2po --output=basic/de.po --reuse=basic/tutorial-basic.de.xml basic/tutorial-basic.xml

## xml2po is not happy when this directory doesn't exist:
mkdir .tmp.basic

## use this when the tutorial-basic.xml has been updated and you
## want the new stuff in your de.po:
xml2po --update-translation=basic/de.po basic/tutorial-basic.xml

## use this to create a tutorial-basic.de.xml from your de.po (ScislaC
## will use this file to create the final tutorial SVG file)
## WARNING: Unfortunately, this doesn't put localized screenshot 
## file names into the xml file!
xml2po --po-file=basic/de.po basic/tutorial-basic.xml > basic/tutorial-basic.de.xml

Keyboard and mouse translation

  • TBD

User Manual

  • See also Embedded Help
  • First download the user manual xml document from SVN
  • edit the trunk/xml/inkscapeUTF.xml file. All languages are inside.
  • Just read the file, choose the language reference you want to use (en, fr...) and translate by duplicating the node and changing lang attribute to yours.
  • when finishing editing, if necessary edit the Makefile and add your language to the Makefile. In every case test your file with some tools (xmllint...) or just type again "make your_language" : syntax errors will be displayed : please correct them.
  • submit your work as a patch in the patch tracker and warn Cédric Gemy (cedric at le-radar.com) by email.

Man pages

  • first download inkscape.pod from SVN
  • rename it to inkscape.xx.pod, where xx is the code for your language
  • open inkscape.xx.pod in your favourite text editor (pay attention to encoding which must be UTF8), and directly translate in the file.
  • you can take a look at a first example of translation with inkscape.fr.pod
  • finally, submit your work in the patch tracker and drop a mail to the inkscape devel mailing list.

Polishing Translations - Microtypography

Here are some things to note in order to achieve good microtypography (typography at the word or character level).

  • use the proper quotes (e.g. »foo«)
  • use the proper kind of dashes (with the proper amount of whitespace around them) - EN DASH (U+2013): "–", MINUS (U+2212): "−"
  • use non-breakable space where appropriate (e.g. before units; some countries use a halfspace here) - NO-BREAK SPACE (U+00A0): " "
  • use halfspace where appropriate (example: "z. B.") NARROW No-BREAK SPACE U+202F: " "
  • use "24×24", not "24x24"
  • use "90°", not "90 degrees" where appropriate
  • use the proper Unicode codepoint for "..." - "…"

Links


Translation information

Go Back to the main Translation information page.