Documentation translation - Revision history

Moini: Remove contents of outdated page. Up-to-date instructions are available in the repository.

2019-10-24T17:55:34Z

Remove contents of outdated page. Up-to-date instructions are available in the repository.

← Older revision		Revision as of 17:55, 24 October 2019
Line 1:		Line 1:
	Go back to the main [[Translation information]] page.		Go back to the main [[Translation information]] page.

	~~== Tutorials ==~~		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-known [[Translation information#PO translation files\|PO format]]. If you want to help, download them~~ [https://gitlab.com/inkscape/inkscape-docs/documentation ~~here]. You will find each tutorial in its own subdirectory, with a .pot template.~~

	~~Once you are satisfied with what you have done, [[Translation information#Submit finished work\|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):~~
	* [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]

	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 ([https://gitlab.com/inkscape/inkscape/tree/master/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 [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.~~

	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.

	~~=== 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:~~
	# 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 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.

	~~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 [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.

	~~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]).]~~

	~~== 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 ==~~

	~~'''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.

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

Patrick87: /* Tutorials */ remove bzr link

2019-10-24T17:44:49Z

Tutorials: remove bzr link

← Older revision		Revision as of 17:44, 24 October 2019
Line 5:		Line 5:
	Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.		Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.

	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.		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 [https://gitlab.com/inkscape/inkscape-docs/documentation here]. You will find each tutorial in its own subdirectory, with a .pot template.

	Once you are satisfied with what you have done, [[Translation information#Submit finished work\|submit it]].		Once you are satisfied with what you have done, [[Translation information#Submit finished work\|submit it]].

Moini: /* Keyboard shortcuts and command line references */

2018-02-13T00:42:50Z

Keyboard shortcuts and command line references

← Older revision		Revision as of 00:42, 13 February 2018
Line 54:		Line 54:
	== Keyboard shortcuts and command line references ==		== 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 [~~http~~://~~bazaar~~.~~launchpad.net~~/~inkscape~~.dev~~/inkscape/~~trunk/files~~/ inkscape-docs repository], then [[Translation information#Submit finished work\|send us your work]].		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 ==

Moini: /* Verification */

2018-02-13T00:41:32Z

Verification

← Older revision		Revision as of 00:41, 13 February 2018
Line 36:		Line 36:
	To create up-to-date tutorials (the ‘tutorial-*.svg’ files), you'll need to build them from the tutorial PO files.		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:		'''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:
	# 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 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 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.		# 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.
Line 48:		Line 50:
	# 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.		# 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]).		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]).]

	== Keyboard shortcuts and command line references ==		== Keyboard shortcuts and command line references ==

Moini: /* Header and footer */ update links for header + footer, currently they go to the 0.92.x version on gitlab.

2018-02-13T00:36:15Z

Header and footer: update links for header + footer, currently they go to the 0.92.x version on gitlab.

← Older revision		Revision as of 00:36, 13 February 2018
Line 11:		Line 11:
	=== Header and footer ===		=== 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 (~~click on ‘download file’~~):		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):
	* [~~http~~://~~bazaar~~.~~launchpad.net~~/~inkscape~~.dev~~/inkscape-docs/~~trunk~~/~~view~~/~~head:~~/tutorials/_tutorial-header.svg Last revision of header]		* [https://gitlab.com/inkscape/inkscape-docs/documentation/raw/0.92.x/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]		* [https://gitlab.com/inkscape/inkscape-docs/documentation/raw/0.92.x/tutorials/_tutorial-footer.svg Last revision of footer]

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

Moini: /* Tutorials */ Update for move to gitlab of Inkscape proper (inkscape-docs not moved yet)

2017-06-09T19:21:01Z

Tutorials: Update for move to gitlab of Inkscape proper (inkscape-docs not moved yet)

Frigory: Some more details

2016-07-17T13:39:33Z

Some more details

← Older revision		Revision as of 13:39, 17 July 2016
Line 15:		Line 15:
	* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]		* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]

	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 ~~such as~~ ‘DejaVu Sans’ or ‘Bistream Vera Sans’, in italic) and convert it to a path when you're done.		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 ===		=== Committing a translation to the Inkscape trunk ===
Line 52:		Line 52:
	== Keyboard shortcuts and command line references ==		== 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, then [[Translation information#Submit finished work\|send us your work]].		Just translate the [[Translation information#PO translation files\|PO file]] for your language in the ‘keys/’ and ‘man/’ directories of the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/ inkscape-docs repository], then [[Translation information#Submit finished work\|send us your work]].

	== User Manual ==		== User Manual ==

Frigory: Reviewed tutorials part; merged keyboard shortcuts and man pages

2016-07-17T12:35:31Z

Reviewed tutorials part; merged keyboard shortcuts and man pages

← Older revision		Revision as of 12:35, 17 July 2016
Line 1:		Line 1:
	Go back to the main [[Translation information]] page.		Go back to the main [[Translation information]] page.

	== ~~Tutorial translation~~ ==		== Tutorials ==

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

	The ''translations'' of the tutorials however are in the well-know [[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].		The ''translations'' of the tutorials however are in the well-know [[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.

	* 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!		Once you are satisfied with what you have done, [[Translation information#Submit finished work\|submit it]].
	* 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 entitled ‘Translation to <your language>’, upload the PO file there as attachment. You need to create an account on 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. This may be 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 ===		=== 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 (click ~~download file~~ on):		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 (click on ‘download file’):
	* [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-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]		* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]

	You should notice that some strings in the header are paths, not editable texts — this is to ensure that ~~this~~ text will correctly ~~render~~ to the end-user. To translate it, you will have to recreate the text object yourself (use a generic sans-serif font such as ‘DejaVu Sans’ or ‘Bistream Vera Sans’, in italic) and convert it to a path when you're done.		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 such as ‘DejaVu Sans’ or ‘Bistream Vera Sans’, in italic) and convert it to a path when you're done.

	~~=== 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 ===		=== Committing a translation to the Inkscape trunk ===
Line 44:		Line 21:
	When you have commit access to the Inkscape Bazaar repository and when adding a new tutorial SVG to it ([http://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:		When you have commit access to the Inkscape Bazaar repository and when adding a new tutorial SVG to it ([http://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].		* 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.		* 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'''~~:		* 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>		<pre>
	msgid "tutorial-basic.svg"		msgid "tutorial-basic.svg"
Line 55:		Line 32:
	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.		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~~ ==		=== Verification ===

	* ~~TBD~~		To create up-to-date tutorials (the ‘tutorial-*.svg’ files), you'll need to build them from the tutorial PO files.
	* Just find or ~~create~~ your ~~PO in~~ the [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/~~head~~:/~~keys~~/ ~~keys~~/ directory] in inkscape-docs trunk.
			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 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.

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

			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]).

			== 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, then [[Translation information#Submit finished work\|send us your work]].

	== User Manual ==		== User Manual ==
Line 70:		Line 64:
	* 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.		* 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.		* 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 [http://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 Launchpad].
	* Rename it to inkscape.xx.pod, where xx is the code for your language.
	* Open inkscape.xx.pod in your favorite 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]]

Frigory: Some more reviews, but a bigger one must be done

2016-07-12T00:24:42Z

Some more reviews, but a bigger one must be done

← Older revision		Revision as of 00:24, 12 July 2016
Line 5:		Line 5:
	Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.		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:~~		The ''translations'' of the tutorials however are in the well-know [[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].

	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!		* 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.		* 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.		Once you are satisfied with what you have done, submit it to the Launchpad bug tracker. Open a new bug entitled ‘Translation to <your language>’, upload the PO file there as attachment. You need to create an account on 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. This may be performed by the developer during the addition of the tutorial to the trunk, so please also update your local Inkscape po-file.

	Thanks!		Thanks!
Line 18:		Line 16:
	=== Header and footer ===		=== 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):		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 (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-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]		* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]

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

	=== Verification ===		=== Verification ===
Line 42:		Line 42:
	=== Committing a translation to the Inkscape trunk ===		=== 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:		When you have commit access to the Inkscape Bazaar repository and when adding a new tutorial SVG to it ([http://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].		* 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.		* 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''':		* 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''':
Line 58:		Line 58:

	* TBD		* 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.		* Just find or create your PO in the [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head:/keys/ keys/ directory] in inkscape-docs trunk.

	== User Manual ==		== User Manual ==
Line 73:		Line 73:
	== Manual pages (man) ==		== 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.'''		'''Obsolete! Just find or create your PO in the [http://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~~].		* First download inkscape.pod from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/inkscape.pod Launchpad].
	* Rename it to inkscape.xx.pod, where xx is the code for your language.		* 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.		* Open inkscape.xx.pod in your favorite 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].		* 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.		* 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]]

Frigory: Quick review

2016-07-12T00:11:25Z

Quick review

← Older revision		Revision as of 00:11, 12 July 2016
Line 16:		Line 16:
	Thanks!		Thanks!

	== ~~Tutorial header~~ and footer ~~translation~~ ==		=== 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):		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-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]		* [http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/view/head:/tutorials/_tutorial-footer.svg Last revision of footer]

	== Verification ~~of tutorial translation~~ ==		=== Verification ===

	To create up-to-date tutorials (the '''tutorial-*.svg''' files), you'll need to build them from the tutorial PO files.		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:		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 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 <~~pre~~>type java</~~pre~~> from the command line -- check that '''java''' actually points to the SDK's '''java''' executable that you installed		# 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:		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).		# 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).
	# <~~pre~~>cd javaclasses/org/inkscape/xslt; javac files.java</~~pre~~> (this rebuilds '''files.class''', which is a Java class file)		# <code>cd javaclasses/org/inkscape/xslt; javac files.java</code> (this rebuilds '''files.class''', which is a Java class file)
	# <~~pre~~>cd tutorials/</~~pre~~>		# <code>cd tutorials/</code>
	# <~~pre~~>make svg</~~pre~~> (this creates all tutorial SVGs for all languages -- can take long)		# <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.		# 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.		# 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]).		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]).

	== ~~Adding~~ a ~~new tutorial~~ to the ~~inkscape~~ trunk ==		=== 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 ~~the~~ it ([~~http~~://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:		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].		* 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.		* 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'''		* 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>		<pre>
	msgid "tutorial-basic.svg"		msgid "tutorial-basic.svg"
Line 51:		Line 52:
	</pre>		</pre>
	: then whenever the locale is French, Inkscape will display the French (and not the default English) basic tutorial for users.		: then whenever the locale is French, Inkscape will display the French (and not the default English) basic tutorial for users.
	* Update the [[TranslationStatus \| translation status]] in the wiki.

	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.		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.
Line 58:		Line 58:

	* TBD		* 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 ==		== User Manual ==

	* See also [[Embedded Help]]		'''Obsolete!'''
	* 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.		* See also [[Embedded Help]].
	* 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.		* First download the user manual xml document from [http://inkscape.svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/xml/ SVN].
	* ~~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.		* Edit the trunk/xml/inkscapeUTF.xml file. All languages are inside.
	* ~~submit~~ your work as a patch in the patch tracker and warn Cédric Gemy (cedric at le-radar.com) by email.		* 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) ==		== 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].		* First download inkscape.pod from [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/inkscape.pod bazaar].

← Older revision		Revision as of 19:21, 9 June 2017
Line 5:		Line 5:
	Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.		Inkscape's tutorial sources are in Docbook XML format, with illustrations in SVG.

	The ''translations'' of the tutorials however are in the well-~~know~~ [[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.		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.

	Once you are satisfied with what you have done, [[Translation information#Submit finished work\|submit it]].		Once you are satisfied with what you have done, [[Translation information#Submit finished work\|submit it]].
Line 19:		Line 19:
	=== Committing a translation to the Inkscape trunk ===		=== 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 ([~~http~~://~~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:		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:

	* 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].		* 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.		* 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’:		* 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’:
Line 30:		Line 30:
	: then whenever the locale is French, Inkscape will display the French (and not the default English) basic tutorial for users.		: 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.		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.

	=== Verification ===		=== Verification ===
Line 41:		Line 41:

	When this is complete create or update the tutorial SVG files:		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).		# 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>javac javaclasses/org/inkscape/xslt/files.java</code> (this rebuilds ‘files.class’, which is a Java class file)
	# <code>cd tutorials/</code>		# <code>cd tutorials/</code>