Difference between revisions of "Documentation translation"

From Inkscape Wiki
Jump to: navigation, search
(Keyboard shortcuts and command line references)
 
(62 intermediate revisions by 11 users not shown)
Line 1: Line 1:
= Tutorial Translation =
+
Go back to the main [[Translation information]] page.
  
Inkscape tutorial sources are in [[DocBook]] format, with illustrations in SVG. If you want to translate one or more tutorials, first download the [[DocBook]] source here:
+
== Tutorials ==
  
http://svn.sourceforge.net/viewcvs.cgi/inkscape/doc-docbook/trunk/
+
Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.  
  
Each tutorial is in its own subdirectory. You need the *.xml file, for example basic/tutorial-basic.xml. 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.
+
The ''translations'' of the tutorials however are in the well-known [[Translation information#PO translation files|PO format]]. If you want to help, download them [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head%3A/tutorials/ here]. You will find each tutorial in its own subdirectory, with a .pot template.
  
* 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.
+
Once you are satisfied with what you have done, [[Translation information#Submit finished work|submit it]].
  
* Save your file as <original name>.<language suffix>.xml, for example basic/tutorial-basic.es.xml for Spanish.
+
=== Header and footer ===
  
* Do not use symbolic entities like &amp;aacute; (they're not defined in XML without a DTD). Instead use either numeric entities such as &amp;#225; or simply write your text in UTF-8.
+
The header and footer for the translation can as well be translated. Their translation is to date still a bit different from the tutorial translation as the header and footer SVG files need to be modified directly (so without using a PO file). To translate the tutorial header and footer, download and rename the following files (in the browser, save the page as _tutorial-header.<your two-letter language code here>.svg or _tutorial-footer.<your two-letter language code here>.svg, respectively):
 +
* [https://gitlab.com/inkscape/inkscape-docs/documentation/raw/0.92.x/tutorials/_tutorial-header.svg Last revision of header]
 +
* [https://gitlab.com/inkscape/inkscape-docs/documentation/raw/0.92.x/tutorials/_tutorial-footer.svg Last revision of footer]
  
* 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.
+
You should notice that some strings in the header are paths, not editable texts — this is to ensure that the text will render correctly to the end user. To translate it, you will have to recreate the text object yourself (use a generic sans-serif font with appropriate license, e.g. ‘DejaVu Sans’ or ‘Bistream Vera Sans’, in italic) and convert it to a path when you're done. Also consider the translucent ‘tutorial’ text path in the background.
  
* When finished, run [http://xmlsoft.org/xmllint.html xmllint] on your file to make sure it's well-formed.
+
=== Committing a translation to the Inkscape trunk ===
  
* 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.
+
When you have a gitlab account, so you can fork the repository and make a merge request, and when you are adding a new tutorial SVG to it ([https://gitlab.com/inkscape/inkscape/tree/master/share/tutorials to the tutorial directory]), it's recommended to also perform the following steps:
  
* 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.
+
* Add the filename of the tutorial SVG (and any additional files it needs, like PNG images referenced from the SVG) to ‘share/tutorials/Makefile.am’ in the [https://gitlab.com/inkscape/inkscape/tree/master/ main Inkscape trunk].
 +
* If the SVG refers to a PNG, then that PNG should exist in the SVG's directory — make sure to also commit that PNG.
 +
* Modify the translation of the tutorial filename in the main PO file so as to make Inkscape display the localized tutorial instead of the default (English) one. An example: if the <code>"tutorial-basic.svg"</code> string is translated the following way in ‘po/fr.po’:
 +
<pre>
 +
msgid "tutorial-basic.svg"
 +
msgstr "tutorial-basic.fr.svg"
 +
</pre>
 +
: then whenever the locale is French, Inkscape will display the French (and not the default English) basic tutorial for users.
  
==Tools==
+
You may also check the tutorials with the [https://gitlab.com/inkscape/inkscape/blob/master/po/check_for_tutorial_problems.sh check_for_tutorial_problems.sh] script. See the comments inside the script for more information.
* OmegaT - http://www.omegat.org/omegat/omegat_en/omegat.html
+
* Transolution - http://transolution.python-hosting.com/
+
  
===Transforming XML into PO files===
+
=== Verification ===
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/).
+
To create up-to-date tutorials (the ‘tutorial-*.svg’ files), you'll need to build them from the tutorial PO files.
  
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.
+
'''The section below is outdated!'''
  
<pre>
+
[First of all, you need to check whether you have the necessary software. You need a Java SDK, Saxon, and the GNOME documentation utils, before you can actually build the SVGs of the tutorials:
## use this at the very beginning, when there is no translation at all:
+
# Install Saxon 6.5.x if it's not already installed. It is a tool that converts XML to SVG using XSLT. You need to have version 6.5.x, because the build process doesn't work with newer versions. Preferably, you install it with your package manager under Linux. For example, under openSUSE, install '''saxon-6.5.5''' or a similarly named package — NOT '''saxon8''' or similar.<br/> You can also download it manually from the project page on SourceForge ([http://saxon.sf.net saxon.sf.net]). Look for the section ‘Older products’ and its subsection ‘Saxon 6.5.5’. Download the zip file and unzip it into a suitable directory that's accessible by the build script (e.g. in /usr/share/java). The build scripts needs to find ‘saxon.jar’ in your Java classpath, so you may want to check your classpath in case of a Java problem.
xml2po --output=basic/tutorial-basic.pot basic/tutorial-basic.xml
+
# Install the Java SDK (JRE is not enough) if it's not already installed. You can check your installation with <code>type java</code> from the command line — check that '''java''' actually points to the SDK's '''java''' executable that you installed.
  
## use this when there is a *.de.xml, but you want a de.po:
+
When this is complete create or update the tutorial SVG files:
xml2po --output=basic/de.po --reuse=basic/tutorial-basic.de.xml basic/tutorial-basic.xml
+
# Update your local copy of the [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/ inkscape-docs trunk] and the [https://gitlab.com/inkscape/inkscape/tree/master/ main inkscape trunk] from bzr (see also [[Working with Bazaar]] for some more information on the commands and workflow of Bazaar).
 +
# <code>javac javaclasses/org/inkscape/xslt/files.java</code> (this rebuilds ‘files.class’, which is a Java class file)
 +
# <code>cd tutorials/</code>
 +
# <code>make svg</code> (this creates all tutorial SVGs for all languages — can take long)
 +
# Check the newly created tutorial SVGs (which you'll find in their specific tutorial directories: ‘advanced/’, ‘basic/’, etc.) for overlapping text (often caused by font settings) and other problems. It's recommended to perform the check under a different operating system. If the SVGs have overlapping text, check the default fonts on your computer.
 +
# If you want to commit the newly created tutorial SVGs, then copy the new ‘tutorial-*.svg’ files to the ‘share/tutorials/’ directory of your local copy of the main Inkscape trunk and commit them to the main Inkscape trunk.
  
## xml2po is not happy when this directory doesn't exist:
+
For more information, see ‘tutorials/README’ (web version [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/annotate/head%3A/tutorials/README here]) and ‘tutorials/Makefile.targets’ (web version [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/annotate/head%3A/tutorials/Makefile.targets here]).]
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
+
 
+
</pre>
+
  
= Keyboard and mouse translation =
+
== Keyboard shortcuts and command line references ==
  
 +
Just translate the [[Translation information#PO translation files|PO file]] for your language in the ‘keys/’ and ‘man/’ directories of the [https://gitlab.com/inkscape/inkscape-docs/documentation/ inkscape-docs repository], then [[Translation information#Submit finished work|send us your work]].
  
= User Manual =
+
== User Manual ==
  
 +
'''Obsolete!'''
  
 +
* See also [[Embedded Help]].
 +
* First download the user manual xml document from [http://inkscape.svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/xml/ 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 =
+
[[Category: Translation]]

Latest revision as of 00:42, 13 February 2018

Go back to the main Translation information page.

Tutorials

Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.

The translations of the tutorials however are in the well-known PO format. If you want to help, download them here. You will find each tutorial in its own subdirectory, with a .pot template.

Once you are satisfied with what you have done, submit it.

Header and footer

The header and footer for the translation can as well be translated. Their translation is to date still a bit different from the tutorial translation as the header and footer SVG files need to be modified directly (so without using a PO file). To translate the tutorial header and footer, download and rename the following files (in the browser, save the page as _tutorial-header.<your two-letter language code here>.svg or _tutorial-footer.<your two-letter language code here>.svg, respectively):

You should notice that some strings in the header are paths, not editable texts — this is to ensure that the text will render correctly to the end user. To translate it, you will have to recreate the text object yourself (use a generic sans-serif font with appropriate license, e.g. ‘DejaVu Sans’ or ‘Bistream Vera Sans’, in italic) and convert it to a path when you're done. Also consider the translucent ‘tutorial’ text path in the background.

Committing a translation to the Inkscape trunk

When you have a gitlab account, so you can fork the repository and make a merge request, and when you are adding a new tutorial SVG to it (to the tutorial directory), it's recommended to also perform the following steps:

  • Add the filename of the tutorial SVG (and any additional files it needs, like PNG images referenced from the SVG) to ‘share/tutorials/Makefile.am’ in the main Inkscape trunk.
  • If the SVG refers to a PNG, then that PNG should exist in the SVG's directory — make sure to also commit that PNG.
  • Modify the translation of the tutorial filename in the main PO file so as to make Inkscape display the localized tutorial instead of the default (English) one. An example: if the "tutorial-basic.svg" string is translated the following way in ‘po/fr.po’:
msgid "tutorial-basic.svg"
msgstr "tutorial-basic.fr.svg"
then whenever the locale is French, Inkscape will display the French (and not the default English) basic tutorial for users.

You may also check the tutorials with the check_for_tutorial_problems.sh script. See the comments inside the script for more information.

Verification

To create up-to-date tutorials (the ‘tutorial-*.svg’ files), you'll need to build them from the tutorial PO files.

The section below is outdated!

[First of all, you need to check whether you have the necessary software. You need a Java SDK, Saxon, and the GNOME documentation utils, before you can actually build the SVGs of the tutorials:

  1. Install Saxon 6.5.x if it's not already installed. It is a tool that converts XML to SVG using XSLT. You need to have version 6.5.x, because the build process doesn't work with newer versions. Preferably, you install it with your package manager under Linux. For example, under openSUSE, install saxon-6.5.5 or a similarly named package — NOT saxon8 or similar.
    You can also download it manually from the project page on SourceForge (saxon.sf.net). Look for the section ‘Older products’ and its subsection ‘Saxon 6.5.5’. Download the zip file and unzip it into a suitable directory that's accessible by the build script (e.g. in /usr/share/java). The build scripts needs to find ‘saxon.jar’ in your Java classpath, so you may want to check your classpath in case of a Java problem.
  2. Install the Java SDK (JRE is not enough) if it's not already installed. You can check your installation with type java from the command line — check that java actually points to the SDK's java executable that you installed.

When this is complete create or update the tutorial SVG files:

  1. Update your local copy of the inkscape-docs trunk and the main inkscape trunk from bzr (see also Working with Bazaar for some more information on the commands and workflow of Bazaar).
  2. javac javaclasses/org/inkscape/xslt/files.java (this rebuilds ‘files.class’, which is a Java class file)
  3. cd tutorials/
  4. make svg (this creates all tutorial SVGs for all languages — can take long)
  5. Check the newly created tutorial SVGs (which you'll find in their specific tutorial directories: ‘advanced/’, ‘basic/’, etc.) for overlapping text (often caused by font settings) and other problems. It's recommended to perform the check under a different operating system. If the SVGs have overlapping text, check the default fonts on your computer.
  6. If you want to commit the newly created tutorial SVGs, then copy the new ‘tutorial-*.svg’ files to the ‘share/tutorials/’ directory of your local copy of the main Inkscape trunk and commit them to the main Inkscape trunk.

For more information, see ‘tutorials/README’ (web version here) and ‘tutorials/Makefile.targets’ (web version here).]

Keyboard shortcuts and command line references

Just translate the PO file for your language in the ‘keys/’ and ‘man/’ directories of the inkscape-docs repository, then send us your work.

User Manual

Obsolete!

  • 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.