Difference between revisions of "Documentation translation"

From Inkscape Wiki
Jump to navigation Jump to search
(Quick review)
(Remove contents of outdated page. Up-to-date instructions are available in the repository.)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Go back to the main [[Translation information]] page.
Go back to the main [[Translation information]] page.


== Tutorial translation ==
See [https://gitlab.com/inkscape/inkscape-docs/documentation the README file in the Inkscape documentation repository on Gitlab]
 
Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.
 
The ''translations'' of the tutorials however are in the well-know PO format. If you want to help, download them here:
 
http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head%3A/tutorials/
 
* Each tutorial is in its own subdirectory. You need the <code><LANG>.po</code> file, for example <code>basic/fr.po</code>. Please coordinate with the previous translator listed in that file!
* If there is none of these files, get the <code><tutorial>.pot</code> file, rename it to <code><LANG>.po</code> and start translating.
 
Once you are satisfied with what you have done, submit it to the Launchpad bug tracker. Open a new bug with name translation to <your language>, upload the po-file there as attachment. You need to create an account on ubuntu launchpad if you have no account there, yet. When you are also working on the translation of the inkscape program itself, pay attention to the fact that for each new translated tutorial, there is also a need to slightly modify the programs po-file of your language. See the sections below. Probably this is performed by the developer during the addition of the tutorial to the trunk, so please also update your local Inkscape po-file.
 
Thanks!
 
=== 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-file needs to be modified directly (so without using a po-file). To translate the tutorial header and footer, download and rename the following files (click download file on):
* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-header.svg Last revision of header]
* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]
 
=== Verification ===
 
To create up-to-date tutorials (the '''tutorial-*.svg''' files), you'll need to build them from the tutorial PO files.
 
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:
# 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.
# Install Java SDK (JRE is not enough) if it's not already installed. Under openSUSE, the package name should be '''java-1_6_0-sun-devel''' or something similar. 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.
 
When this is complete create or update the tutorial SVG files:
# Update your local copy of the [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/ inkscape-docs trunk] and the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files main inkscape trunk] from BZR (see also [[Working with Bazaar]] for some more information on the commands and workflow of bazaar).
# <code>cd javaclasses/org/inkscape/xslt; javac 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/''', ...) 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.
 
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]).
 
=== Committing a translation to the Inkscape trunk ===
 
When you have commit access to the Inkscape bazaar repository and when adding a new tutorial SVG to it ([https://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/tutorials/ 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 [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files 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.
 
You may also check the tutorials with the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/po/check_for_tutorial_problems.sh check_for_tutorial_problems.sh] script. See the comments inside the script for more information.
 
== Keyboard and mouse translation ==
 
* TBD
* Just find or create your PO in the [https://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head:/keys/ keys/ directory] in inkscape-docs trunk.
 
== 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.
 
== Manual pages (man) ==
 
'''Obsolete! Just find or create your PO in the [https://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head:/man/ man/ directory] in inkscape-docs trunk.'''
 
* First download inkscape.pod from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/inkscape.pod bazaar].
* 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 [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/inkscape.fr.pod inkscape.fr.pod].
* Finally, submit your work in the [https://bugs.launchpad.net/inkscape patch tracker] and drop a mail to the inkscape devel mailing list.


[[Category: Translation]]
[[Category: Translation]]

Latest revision as of 17:55, 24 October 2019

Go back to the main Translation information page.

See the README file in the Inkscape documentation repository on Gitlab

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=Documentation_translation&oldid=116411"