Translate Toolkit & Pootle toolkit

toolkit:accelerator_accelerator

Sat, 05 Jan 2008 18:11:00 +0000

1199556500		current
Line 4:		Line 4:
	\| & \| [[guide:KDE desktop]], [[guide:Mozilla]] (when using [[toolkit:moz2po]]) \|		\| & \| [[guide:KDE desktop]], [[guide:Mozilla]] (when using [[toolkit:moz2po]]) \|
	\| _ \| [[guide:GNOME desktop]] \|		\| _ \| [[guide:GNOME desktop]] \|
-	\| ~ \| [[:OpenOffice.org]] \|	+	\| ~ \| [[guide:OpenOffice.org]] \|

toolkit:base_classes

Wed, 28 Jul 2010 11:17:47 +0000

1185652817		current
Line 11:		Line 11:
	* Parsing a file when given a file name or file contents (whole file in a string)		* Parsing a file when given a file name or file contents (whole file in a string)
	* Writing a file to disk		* Writing a file to disk
-	* Support for source and target languages (as required in the [[LISA]] standards)	+	* Getting and setting source and target languages
-	* Support for "multifiles", in other words a file that contain other entities that corresponds to files in other formats. Examples: ZIP, XPI and [[XLIFF]].	+	* Accessing units, and determining if they are translatable, translated, a unique identifier for the unit in the file, etc.
		+	* Support for plural units that can vary between different languages (as the PO format allows with msgid_plural, etc.)
		+
		+	Other possibilities:
	* Support for variable number of languages in the format. Examples: .txt and .properties support one language, PO supports two, [[TMX]] supports many.		* Support for variable number of languages in the format. Examples: .txt and .properties support one language, PO supports two, [[TMX]] supports many.
-	* Support for plurality that can vary between different languages (as the PO format allows with msgid_plural, etc.)	+	* Support for "multifiles", in other words a file that contain other entities that corresponds to files in other formats. Examples: ZIP, XPI and [[XLIFF]]. In reality this is only used by some of the converters. This isn't present in the base class yet.

	All these do not mean that all formats must support al these features, but in the formats that do support these features, it must be accessible through the base class, and it must be possible to interrogate the storage format through the base class to know which features it supports.		All these do not mean that all formats must support al these features, but in the formats that do support these features, it must be accessible through the base class, and it must be possible to interrogate the storage format through the base class to know which features it supports.
Line 24:		Line 27:
	This class represents a single conceptual string in a single language. It must know its own requirements for escaping and implement it internally. Escaped versions are only used for internal representation and only exposed for file creation and testing (unit tests, for example).		This class represents a single conceptual string in a single language. It must know its own requirements for escaping and implement it internally. Escaped versions are only used for internal representation and only exposed for file creation and testing (unit tests, for example).

-	Note that when storing different plural forms of the same string, they should be stored in this class. The main object is the singular string, and all of the string forms can be accessed in a list at x.strings. Most of the time the object can be dealt with as a single string, only when it is necessary to deal with plural forms do the extra strings have to be taken into account	+	Note that when storing different plural forms of the same string, they should be stored in this class. The main object is the singular string, and all of the string forms can be accessed in a list at x.strings. Most of the time the object can be dealt with as a single string, only when it is necessary to deal with plural forms do the extra strings have to be taken into account.

-	Comments/notes could possibly be supported in this class.	+	Any string from a plural unit must be a multistring.

	==== Translation unit ====		==== Translation unit ====
	This class represents a unit of one or several related messages/strings. In most formats the contained strings will be translations of some original message/string. It must associate a language value with each message/string. It must know how to join all contained messages/strings to compile a valid representation. For formats that support at least two languages, the first two languages will serve as "source" and "target" languages for the common case of translating from one language into another language.		This class represents a unit of one or several related messages/strings. In most formats the contained strings will be translations of some original message/string. It must associate a language value with each message/string. It must know how to join all contained messages/strings to compile a valid representation. For formats that support at least two languages, the first two languages will serve as "source" and "target" languages for the common case of translating from one language into another language.
		+
		+	Some future ideas:

	As the number of of languages can be seen as one "dimension" of the translation unit, plurality can be seen as a second dimension. A format can thus be classified according to the dimensionality that it supports, as follows:		As the number of of languages can be seen as one "dimension" of the translation unit, plurality can be seen as a second dimension. A format can thus be classified according to the dimensionality that it supports, as follows:
Line 39:		Line 44:
	Comments/notes are supported in this class. Quality or status information (fuzzy, last-changed-by) should be stored. TODO: see if this should be on unit level or language level.		Comments/notes are supported in this class. Quality or status information (fuzzy, last-changed-by) should be stored. TODO: see if this should be on unit level or language level.

-	==== File ====	+	==== Store ====
	This class represents a whole collection of translation units, usually stored in a single file. It supports the concept of a header, and possibly comments at file level. A file will not necessarily be contained alone in single file on disc. See "multifile" below.		This class represents a whole collection of translation units, usually stored in a single file. It supports the concept of a header, and possibly comments at file level. A file will not necessarily be contained alone in single file on disc. See "multifile" below.

	==== Multifile ====		==== Multifile ====
		+	This abstraction is only used by a few converters.
		+
	This class represents a storage format that contains other files or file like objects. Examples include ZIP, XPI and XLIFF, and OpenOffice SDF files. It must give access to the contained files, and possibly give access to the translation units contained in those files, as if they are contained natively.		This class represents a storage format that contains other files or file like objects. Examples include ZIP, XPI and XLIFF, and OpenOffice SDF files. It must give access to the contained files, and possibly give access to the translation units contained in those files, as if they are contained natively.

Line 53:		Line 60:
	* Flesh out the API, clean and clear definitions.		* Flesh out the API, clean and clear definitions.
	* Document the API.		* Document the API.
-	* We need to discuss the class hierarchy, eg:	+	* We need to discuss the class hierarchy, e.g.:
	<code>		<code>
	base		base

toolkit:building

Fri, 04 Apr 2008 09:38:51 +0000

1207055402		current
Line 12:		Line 12:

	Consult the README in the source distribution for the build dependencies.		Consult the README in the source distribution for the build dependencies.
		+
		+	=== Building Python packages with C extensions under Windows ===
		+
		+	In order to build modules which have C extensions, you will need either the Visual Studio C++ compiler or [[http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780\|MinGW]].
		+
		+	Make sure that your Visual Studio C++ or MinGW program path is part of your system's program path, since the Python build system requires this.
		+
		+	To build and install a package with MinGW, you need to execute:
		+	''python setup.py build -c mingw32 install''
		+	from the command line.
		+
		+	To build a Windows installer when using MinGW, execute:
		+	''python setup.py build -c mingw32 bdist_wininst''

	==== Building ====		==== Building ====

toolkit:catkeys

Fri, 16 Jul 2010 09:39:56 +0000

	current
Line 1:	Line 1:
	+	====== Haiku catkeys ======
	+	Localisation for the [[http://www.haiku-os.org/\|Haiku]] operating system is done with a file format called catkeys. It is a bilingual file format.

	+	It is supported since version 1.8.0 of the Translate Toolkit.
	+
	+	===== Links =====
	+
	+	* [[http://www.haiku-os.org/blog/pulkomandy/2009-09-24_haiku_locale_kit_translator_handbook\|Some notes about the format]]
	+	* [[http://dev.haiku-os.org/browser/haiku/trunk/data/catalogs/\|Some example files]]

toolkit:checking_for_inconsistencies

Fri, 27 Jul 2007 15:06:10 +0000

toolkit:cleanup_translator_comments

Tue, 30 Sep 2008 07:58:04 +0000

1205394554		current
Line 1:		Line 1:
	====== Cleanup translator comments ======		====== Cleanup translator comments ======

-	Translate Toolkit 1.1 saw source comments being concerted to developer comments instead of translator comments.	+	Translate Toolkit 1.1 saw source comments being converted to developer comments instead of translator comments.

	This use case shows you how to get rid of the old translator comments.		This use case shows you how to get rid of the old translator comments.

toolkit:conformance

Wed, 28 Jul 2010 11:03:31 +0000

1264771266		current
Line 1:		Line 1:
	====== Standards conformance ======		====== Standards conformance ======
-	This page links to pages documenting standard conformance for different standards or file formats.	+	This page links to pages documenting standard conformance for different standards or file [[formats]].

	===== LISA and OASIS standards =====		===== LISA and OASIS standards =====

toolkit:contributing

Sat, 21 Aug 2010 07:59:03 +0000

1282035022		current
Line 25:		Line 25:
	Check for any files that are missing, tools that were not installed, etc.		Check for any files that are missing, tools that were not installed, etc.

-	Run unit tests to see if there are any issues. You'll need the [[http://codespeak.net/py/dist/test.html\|py.test]] unit test software	+	[[developers:testing_guidelines#running tests\|Run unit tests]] to see if there are any issues. Please report any failures.
-	which you can install from your distribution. Alternatively you can install it with easy_install:	+
-		+
-	easy_install py	+
-		+
-	To run the tests you do	+
-		+
-	py.test	+
-		+
-	from the translate src directory, or	+
-		+
-	py.test storage/test_dtd.py	+
-		+
-	to run a specific set of tests.	+
-		+
-	Report any failures.	+
-		+
-	Note: If your Pootle tests fail with an error along the lines of:	+
-	URLError: <urlopen error (-2, 'Name or service not known')>	+
-		+
-	Check your http_proxy environment variable. Usually it helps just to unset it:	+
-	unset http_proxy	+

	Finally, simply work with the software. Checking all your current usage patterns and report problems.		Finally, simply work with the software. Checking all your current usage patterns and report problems.

toolkit:copyright

Tue, 19 Jun 2007 12:16:33 +0000

1149672674		current
Line 1:		Line 1:
	====== Copyright ======		====== Copyright ======

-	The Translate Toolkit documentation (everything which is included with the Translate Toolkit and is under the toolkit/ namespace on the wiki) is released under the [[http://www.gnu.org/licenses/gpl.html\|GNU General Public License (GPL)]].	+	The Translate Toolkit documentation (everything which is included with the Translate Toolkit or is under the toolkit/ namespace on the wiki) is released under the [[http://www.gnu.org/licenses/gpl.html\|GNU General Public License (GPL)]].

toolkit:creating_a_terminology_list_from_your_existing_translations

Tue, 30 Sep 2008 08:44:14 +0000

1222764092		current
Line 9:		Line 9:
	===== Quick Overview =====		===== Quick Overview =====

-	These are the steps that we will undertake	+	This describes a multi-stage process for extracting terminology from translation files. It is provided for historical interest and completeness, but you will probably find that using [[poterminology]] is easier and will give better results than following this process.

	- Filter our phrases of more than N words		- Filter our phrases of more than N words

toolkit:creating_mozilla_pot_files

Thu, 26 Mar 2009 15:52:45 +0000

1225808902		current
Line 21:		Line 21:
	that you can use for translation or updating your existing PO files.		that you can use for translation or updating your existing PO files.

		+	There are also [[mozilla_l10n_scripts\|other scripts]] that can help with creating and updating POT and PO files for [[Mozilla]] localisation.

	===== Using CVS =====		===== Using CVS =====

toolkit:csv

Fri, 04 Jan 2008 14:33:02 +0000

1185653386		current
Line 1:		Line 1:
	====== CSV ======		====== CSV ======
-	CSV (Comma Separated Values) is a simple file format for general data interchange. It can be used in the toolkit for simple data interchange, and can be edited with most spreadsheet programs. There is no formal specification for the CSV file format, but more information can be acquired from http://en.wikipedia.org/wiki/Comma-separated_values	+	CSV (Comma Separated Values) is a simple file format for general data interchange. It can be used in the toolkit for simple data interchange, and can be edited with most spreadsheet programs. There is no formal specification for the CSV file format, but more information can be acquired from [[wp>Comma-separated values]]

	For information on more file formats, see [[conformance]].		For information on more file formats, see [[conformance]].

toolkit:csv2po

Sat, 20 Jun 2009 10:16:02 +0000

1200475377		current
Line 2:		Line 2:

	Convert between CSV (Comma Separated Value) files and the PO format. This is useful for those translators who can only use a Spreadsheet, a modern spreadsheet can open CSV files for editing. It is also useful if you have other data such as translation memory in CSV format and you wish to use it with your PO translations.		Convert between CSV (Comma Separated Value) files and the PO format. This is useful for those translators who can only use a Spreadsheet, a modern spreadsheet can open CSV files for editing. It is also useful if you have other data such as translation memory in CSV format and you wish to use it with your PO translations.
		+
		+	If you are starting out with your own CSV files (not created by po2csv), take note of the assumptions of the column layout explained below.

	===== Usage =====		===== Usage =====

toolkit:csv2tbx

Tue, 29 Sep 2009 07:52:11 +0000

1200475378		current
Line 28:		Line 28:
	===== CSV file layout =====		===== CSV file layout =====

-	The CSV file is expected in to have three columns, of which the default layout is	+	The CSV file is expected to have three columns (separated by commas, not other characters like semicolons), of which the default layout is

	^ Column ^ Data ^ Description ^		^ Column ^ Data ^ Description ^
Line 57:		Line 57:
	===== Two column CSV =====		===== Two column CSV =====

-	csv2tbx --columnorder=(source,target) foo.csv foo.tbx	+	csv2tbx --columnorder=source,target foo.csv foo.tbx

	===== Notes =====		===== Notes =====

toolkit:developers

Thu, 29 Mar 2012 23:06:54 +0000

1333062308		current
Line 82:		Line 82:
	Where we are headed is to get to a level where the storage formats themselves are more aware of themselves and their abilities. Thus the converter could end up as one program that accepts storage format plugins to convert from anything to almost anything else. Although our target localisation formats are PO and XLIFF only.		Where we are headed is to get to a level where the storage formats themselves are more aware of themselves and their abilities. Thus the converter could end up as one program that accepts storage format plugins to convert from anything to almost anything else. Although our target localisation formats are PO and XLIFF only.

-	If you want to create a new converter it is best to look at a simple instance such as [[csv2tbx]] or [[txt2po]] and their associated storage classes. The [[http://translate.sourceforge.net/doc/api/public/translate.storage.base-module.html\|storage base class documentation]] will give you the information you need for the storage class implementation.	+	If you want to create a new converter it is best to look at a simple instance such as [[csv2tbx]] or [[txt2po]] and their associated storage classes. The [[http://readthedocs.org/docs/translate-toolkit/en/latest/api/storage.html#module-translate.storage.base\|storage base class documentation]] will give you the information you need for the storage class implementation.

	===== Tools =====		===== Tools =====

toolkit:dtd

Fri, 11 Apr 2008 13:42:54 +0000

1207921374		current
Line 3:		Line 3:
	Mozilla makes use of a .dtd file to store many of its translatable elements, the [[moz2po]] converter can handle these.		Mozilla makes use of a .dtd file to store many of its translatable elements, the [[moz2po]] converter can handle these.

		+	===== References =====
		+
		+	* [[http://www.w3.org/TR/REC-xml/\|XML specification]]

	===== Features =====		===== Features =====
Line 12:		Line 15:
	===== Issues =====		===== Issues =====

-	* We don't escape character entities like <, & - this doesn't break anything but it would be nicer to see © rather then ©	+	* We don't escape character entities like <, & - this doesn't break anything but it would be nicer to see © rather than ©

toolkit:duplicates_duplicatestyle

Tue, 29 Jun 2010 11:13:25 +0000

1200409913		current
Line 1:		Line 1:
	====== --duplicates=DUPLICATESTYLE ======		====== --duplicates=DUPLICATESTYLE ======

-	Gettext PO files only allow one message with a common msgid (source string). Many other formats allow duplicate entries. To create a valid PO file you need to merge these duplicate entries into one PO message. However, this often negatively affects the roundrip or is not what is expected by the user. Thus we have a number of methods of handling duplicates which we call //duplicate styles//.	+	Gettext PO files only allow one message with a common msgid (source string). Many other formats allow duplicate entries. To create a valid PO file you need to merge these duplicate entries into one PO message. However, this often negatively affects the roundtrip or is not what is expected by the user. Thus we have a number of methods of handling duplicates which we call //duplicate styles//.

	Also affected are conversions in which the source format is empty (allowing possible translation). As the header in a PO file is identified by an empty source string, your message will appear to be a duplicate of the header. In this case duplicate removal is critical.		Also affected are conversions in which the source format is empty (allowing possible translation). As the header in a PO file is identified by an empty source string, your message will appear to be a duplicate of the header. In this case duplicate removal is critical.

-	Previously the tools used msgid_comment (KDE style comments) to disambiguate text. However, with the release of Gettext 0.15, the new msgctxt disambiguation is now recommended, especially if you wish to use your files with other Gettext the tools. Many other pieces of software now also support this feature, and will probably become the best choice for almost all circumstances.	+	Previously the tools used msgid_comment (KDE style comments) to disambiguate text. However, with the release of Gettext 0.15, the new msgctxt disambiguation is now recommended, especially if you wish to use your files with other Gettext the tools. Many other pieces of software now also support this feature, and will probably become the best choice for almost all circumstances. It is the default in our converters.

	===== merge =====		===== merge =====
Line 18:		Line 18:
	</code>		</code>

-	If however the source text is blank (these are often configuration options in Mozilla) then the //merge// style will use KDE comments as used in the //msgid_comment// style in order to create unambiquous entries that can still be used for configuration.	+	If however the source text is blank (these are often configuration options in Mozilla) then the //merge// style will use KDE comments as used in the //msgid_comment// style in order to create unambiguous entries that can still be used for configuration.

	<code po>		<code po>
Line 27:		Line 27:
	#: file1.dtd:translators_email		#: file1.dtd:translators_email
	msgid "_: file1.dtd:translators_email\n"		msgid "_: file1.dtd:translators_email\n"
		+	msgstr ""
		+	</code>
		+
		+
		+	===== msgctxt =====
		+
		+	This uses the msgctxt feature of Gettext that was introduced with Gettext 0.15. Some tools might not support it 100%. This option is the default in recent releases of the Translate Toolkit.
		+
		+	<code po>
		+	#: file1.dtd:instruction_manual
		+	msgctxt "instruction_manual"
		+	msgid "Manual"
		+	msgstr ""
		+
		+	#: file1.dtd:manual_process
		+	msgctxt "manual_process"
		+	msgid "Manual"
	msgstr ""		msgstr ""
	</code>		</code>
Line 32:		Line 49:
	===== keep =====		===== keep =====

-	Duplictes are not merged and each appear in their own message. This type of PO file will not work with the Gettext tools.	+	Duplicates are not merged and each appear in their own message. This type of PO file will not work with the Gettext tools. This choice has been removed in Translate Toolkit 1.3.0.

	<code po>		<code po>
Line 46:		Line 63:
	===== msgid_comment =====		===== msgid_comment =====

-	If a duplicates is discovered then we make use of the KDE style comments to make them unique.	+	If a duplicates is discovered then we make use of the KDE style comments to make them unique. This choice has been removed in Translate Toolkit 1.3.0.

	<code po>		<code po>
Line 61:		Line 78:

	You can see that both the entries //instruction_manual// and //manual_process// have source strings of //"Manual"//. By adding		You can see that both the entries //instruction_manual// and //manual_process// have source strings of //"Manual"//. By adding
-	the KDE style comment we make the messages unique. This is helful for many people but isn't quite perfect in that in many cases	+	the KDE style comment we make the messages unique. This is helpful for many people but isn't quite perfect in that in many cases your language will use the same word and you don't want it split - you now simply have more work.
-	your language will use the same word and you don't want it split - you now simply have more work.	+

	===== msgid_comment_all =====		===== msgid_comment_all =====

-	This operates the same as //msgid_comment// except now every message has a KDE style comment added regardless if it is a duplicate or not.	+	This operates the same as //msgid_comment// except now every message has a KDE style comment added regardless if it is a duplicate or not. This choice has been removed in Translate Toolkit 1.3.0.

-	===== msgctxt =====
-
-	This uses the new feature of gettext that was introduced with gettext 0.15. Several tools might not support it 100%. This option for duplicatestyle was added in version 1.0 of the translate toolkit.
-
-	<code po>
-	#: file1.dtd:instruction_manual
-	msgctxt "instruction_manual"
-	msgid "Manual"
-	msgstr ""
-
-	#: file1.dtd:manual_process
-	msgctxt "manual_process"
-	msgid "Manual"
-	msgstr ""
-	</code>

toolkit:errorlevel_errorlevel

Wed, 05 Sep 2007 13:30:27 +0000

1185653660		current
Line 1:		Line 1:
	====== --errorlevel=ERRORLEVEL ======		====== --errorlevel=ERRORLEVEL ======

-	Choose the level of feedback that you need when errors occur. Mostly useful for debugging.	+	This is a parameter that can be passed to most of the programs in the translate toolkit in order to choose the level of feedback that you need when errors occur. It is mostly useful for debugging. Please report your errors to the developers with --errorlevel=traceback.

	===== none =====		===== none =====

toolkit:features

Tue, 17 Aug 2010 09:57:42 +0000

1282039062		current
Line 1:		Line 1:
	====== Features ======		====== Features ======

-	* Work with ONE localisation format. You'll no longer be editing DTD files in one tools, .properties in another, OpenOffice GSI in a third. Simply do all your localisation in a PO or XLIFF editor	+	* Work with ONE localisation format. You'll no longer be editing DTD files in one tool, .properties in another, OpenOffice GSI in a third. Simply do all your localisation in a PO or XLIFF editor
	* Converters for a number of [[formats]]		* Converters for a number of [[formats]]
	* OpenOffice.org SDF/GSI		* OpenOffice.org SDF/GSI

toolkit:filteraction_action

Mon, 23 Oct 2006 18:05:09 +0000

1161624451		current
Line 13:		Line 13:
	Only exclude errors that are listed as serious by the convertor. All other are included.		Only exclude errors that are listed as serious by the convertor. All other are included.

-	===== exclude =====	+	===== exclude-all =====

	Exclude any message that fails a test.		Exclude any message that fails a test.

toolkit:flex

Tue, 27 Jul 2010 21:29:53 +0000

1280235123		current
Line 1:		Line 1:
	====== Adobe Flex properties files ======		====== Adobe Flex properties files ======
-	Adobe Flex applications use .properties files similar to [[properties\|Java properties]], but with UTF-8 encoding.	+	Adobe Flex applications use .properties files similar to [[properties\|Java properties]], but with UTF-8 encoding, and therefore [[prop2po]] and [[po2prop]] is used for conversion.

	We welcome more testing and feedback, but based on our solid support for properties, this probably works perfectly.		We welcome more testing and feedback, but based on our solid support for properties, this probably works perfectly.

toolkit:formats

Wed, 25 Jan 2012 15:53:36 +0000

1307564218		current
Line 85:		Line 85:
	* NSIS installer: [[http://trac.vidalia-project.net/browser/vidalia/trunk/src/tools\|Existing C++ implementation]]		* NSIS installer: [[http://trac.vidalia-project.net/browser/vidalia/trunk/src/tools\|Existing C++ implementation]]
	* WiX - MSI (Microsoft Installer) creator. [[http://wix.mindcapers.com/wiki/Localization\|Localization instructions]], [[http://www.mail-archive.com/wix-users@lists.sourceforge.net/msg15489.html\|more notes on localisation]]. This is a custom XML format, another one!		* WiX - MSI (Microsoft Installer) creator. [[http://wix.mindcapers.com/wiki/Localization\|Localization instructions]], [[http://www.mail-archive.com/wix-users@lists.sourceforge.net/msg15489.html\|more notes on localisation]]. This is a custom XML format, another one!
-	* [[http://www.opengroup.org/onlinepubs/009695399/utilities/gencat.html\|gencat]]: precedes gettext, looking in man packages is the best information I could find. Also [[http://dev.linuxfoundation.org/navigator/browse/cmd_single.php?cmd=list-by-name&Cname=gencat\|LSB requires it]].	+	* catgets/[[http://www.opengroup.org/onlinepubs/009695399/utilities/gencat.html\|gencat]]: precedes gettext, looking in man packages is the best information I could find. Also [[http://dev.linuxfoundation.org/navigator/browse/cmd_single.php?cmd=list-by-name&Cname=gencat\|LSB requires it]]. There is some info about the source (msgfile) format on [[http://www.gnu.org/software/libc/manual/html_node/The-message-catalog-files.html#The-message-catalog-files\|GNU website]]
	* Trados:		* Trados:
	* .tmw		* .tmw

toolkit:general_usage

Tue, 17 Aug 2010 08:36:29 +0000

1185543533		current
Line 5:		Line 5:
	===== Input & Output =====		===== Input & Output =====

-	The last two arguments of your command are the input and output directories:	+	The last two arguments of your command are the input and output files/directories:

	moz2po <input> <output>		moz2po <input> <output>
Line 15:		Line 15:
	===== Error Reporting =====		===== Error Reporting =====

-	All tools accept the option --errorlevel. If you find a bug add this option and send the traceback to the developers.	+	All tools accept the option --errorlevel. If you find a bug, add this option and send the traceback to the developers.


Line 22:		Line 22:
	===== Templates =====		===== Templates =====

-	If you are working with any file format and you wish to preserve comments and layout then use your source file	+	If you are working with any file format and you wish to preserve comments and layout then use your source file as a template.
-	as a template.	+

	po2dtd -t <source-file> <input> <output>		po2dtd -t <source-file> <input> <output>

-	This will use the files in <source-file> as a template merge the PO files in <input> and create new DTD files in <output>	+	This will use the files in <source-file> as a template, merge the PO files in <input>, and create new DTD files in <output>

	If you ran this without the templates you would get valid DTD files but they would not preserve the layout or all the comments from the source DTD file		If you ran this without the templates you would get valid DTD files but they would not preserve the layout or all the comments from the source DTD file
Line 35:		Line 34:
	pomerge -t <old> <fixes> <new>		pomerge -t <old> <fixes> <new>

-	This would take the <old> files merge in the <fix>'s and output new PO files, preserving formatting, into <new>. You can use the same directory for <old> and <new> if you want the merges to overwrite files in <old>	+	This would take the <old> files merge in the <fix>'s and output new PO files, preserving formatting, into <new>. You can use the same directory for <old> and <new> if you want the merges to overwrite files in <old>.

	===== source2target =====		===== source2target =====

toolkit:gsi

Thu, 11 Oct 2007 12:21:32 +0000

	current
Line 1:	Line 1:
	+	====== OpenOffice.org GSI/SDF format ======

	+	OpenOffice.org uses an internal format called SDF to manage localisation text. The toolkit can successfully manage all features of this format covnerting it to XLIFF or PO format with the [[oo2po]] and [[oo2xliff]] tools.
	+
	+	===== Features =====
	+
	+	* Handles all translatable text from the SDF
	+	* Can also use 'x-comments' 'language' found in the SDF to provide translator comments

toolkit:history

Tue, 17 Aug 2010 09:48:34 +0000

1206621025		current
Line 27:		Line 27:
	===== WordForge project =====		===== WordForge project =====

-	In 2006 with funding from the [[http://www.soros.org/\|Open Society Institute]] (OSI) and [[http://www.idrc.ca/\|IDRC]] the toolkit was adapted to allow many core changes. The first being to introduce the concept of a base class from which PO and XLIFF storage formats are derived. This allowed tools to be adapted to allow output to XLIFF or PO files. The tools themselves where adapted to allow them to work with the core formats XLIFF and PO as well as all base class derived formats. Thus we can count, XLIFF, PO, MO and other formats.	+	In 2006 with funding from the [[http://www.soros.org/\|Open Society Institute]] (OSI) and [[http://www.idrc.ca/\|IDRC]] the toolkit was adapted to allow many core changes. The first being to introduce the concept of a base class from which PO and XLIFF storage formats are derived. This allowed tools to be adapted to allow output to XLIFF or PO files. The tools themselves where adapted to allow them to work with the core formats XLIFF and PO as well as all base class derived formats. Thus we can count XLIFF, PO, MO and other formats.

	Additional contributions during this phase where the adaptation of Pootle to use XLIFF as well as PO. The creation of tools to manage translation memory files and glossary files.		Additional contributions during this phase where the adaptation of Pootle to use XLIFF as well as PO. The creation of tools to manage translation memory files and glossary files.
Line 34:		Line 34:

	As part of the WordForge project Pootling was created which in the same way that Pootle is a web-based wrapper around the toolkit so Pootling is a GUI wrapper around the toolkit.		As part of the WordForge project Pootling was created which in the same way that Pootle is a web-based wrapper around the toolkit so Pootling is a GUI wrapper around the toolkit.
		+
		+
		+	===== ANLoc project =====
		+	The [[http://africanlocalisation.net\|African Network for Localisation]] provided the opportunity for further improvements to the project. We saw the first official releases of [[virtaal:index\|Virtaal]] and massive improvements to all the translation tools.
		+
		+	Format support improved a lot, with several bilingual file formats now support (Wordfast TM, Qt TS, etc.), and several monolingual file formats (PHP arrays, video subtitles, Mac OS X strings, etc.).
		+

toolkit:html

Thu, 26 Mar 2009 09:26:29 +0000

1192104661		current
Line 3:		Line 3:
	The Translate Toolkit is able to process HTML files using the [[html2po]] converter.		The Translate Toolkit is able to process HTML files using the [[html2po]] converter.

-	The HTML support is basic so please be aware of that	+	The HTML support is basic, so please be aware of that.

	===== Conformance =====		===== Conformance =====

toolkit:html2po

Fri, 28 Nov 2008 07:21:33 +0000

1200475378		current
Line 38:		Line 38:
	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|		\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	\| -wWRAP, --wrap=WRAP \| set number of columns to wrap html at \|		\| -wWRAP, --wrap=WRAP \| set number of columns to wrap html at \|
		+	\| --notidy \| don't use tidy to clean up HTML, even if installed (new in version 1.2.1) \|
	\| --fuzzy \| use translations marked fuzzy \|		\| --fuzzy \| use translations marked fuzzy \|
	\| --nofuzzy \| don't use translations marked fuzzy (default) \|		\| --nofuzzy \| don't use translations marked fuzzy (default) \|

toolkit:ical

Wed, 24 Sep 2008 16:33:47 +0000

1222266256		current
Line 40:		Line 40:
	==== Broken Lotus Notes ====		==== Broken Lotus Notes ====

-	Lotus notes creates broken iCalendar files. They include _ (underscore) is some of the property names, [A-Z0-9\-] are the only valid chars. Therefore, we require vobject >= v0.6.5 (but there is unfortunately no way to check for the version of vobject)	+	Lotus notes creates broken iCalendar files. They include _ (underscore) is some of the property names, [A-Z0-9\-] are the only valid chars. Therefore, we require vobject >= v0.6.5 (but there is unfortunately no way to check for the version of vobject). See vobject bug [[https://bugzilla.osafoundation.org/show_bug.cgi?id=12008\|#12008]] for further details.

	===== Development Notes =====		===== Development Notes =====

toolkit:ical2po

Fri, 26 Sep 2008 14:54:06 +0000

	current
Line 1:	Line 1:
	+	====== ical2po ======

	+	Converts iCalendar (*.ics) files to Gettext PO format.
	+
	+	<note>New in v1.2</note>
	+
	+	===== Usage =====
	+
	+	ical2po [options] <ical> <po>
	+	po2ical [options] -t <ical> <po> <ical>
	+
	+	Where:
	+	\| <ical> \| is a valid .ics file or directory of those files \|
	+	\| <po> \| is a directory of PO or POT files \|
	+
	+	Options (ical2po):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in php format \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|
	+	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') \|
	+
	+	Options (po2ical):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in po, pot formats \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in php format \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| --fuzzy \| use translations marked fuzzy \|
	+	\| --nofuzzy \| don't use translations marked fuzzy (default) \|
	+
	+	===== Examples =====
	+
	+	This example looks at roundtrip of iCalendar translations. While you can do recovery of translations, its unlikely that you will ever need to do that.
	+
	+	First we need to create a set of POT files.
	+
	+	ical2po -P ical.ics ical.pot
	+
	+	The ical.ics file is converted to Gettext POT files called ical.pot. Directories of iCalendar files can also be processed.
	+
	+	Begin translating the ical.pot file by first copying it to make a PO file.
	+
	+	cp ical.pot ical-af.po
	+
	+	You are now in a position to translate the file ical-af.po in your favourite translation tool.
	+
	+	Once translated you can convert back as follows:
	+
	+	po2ical -t ical.ics ical-af.po ical-af.ics
	+
	+	Your translations found in the Afrikaans PO file, ''ical-ad.po'', will be converted to .ics using the file ''ical.ics'' as a template and creating your newly translated .ics file ''ical-af.ics''.
	+
	+	To update your translations simply redo the POT creation step and make use of [[pot2po]] to bring your translation up-to-date.
	+
	+
	+	===== Notes =====
	+
	+	The converter will only process events in the calender file, the file itself can contain many other things that could be localisable. Please raise a bug if you want to extract additional items.
	+
	+	The converter does not make use of the LANGUAGE attribute which is permitted in the format. The LANGUAGE attribute does not aid multilingualism in this context so is ignored.
	+
	+	The converter could conceivably also process [[wp>vCard]] files, but this has not been implemented for lack of a clear need. Please raise a bug with an example if you have such a file that could benefit from localisation.
	+
	+	===== Bugs =====
	+
	+	None known

toolkit:important_changes

Wed, 15 Sep 2010 00:48:43 +0000

1282033985		current
Line 13:		Line 13:
	===== trunk =====		===== trunk =====
	This section describes the changes in the (unreleased) development files. It should reflect upcoming changes in the next version of the toolkit and latest [[http://translate.sourceforge.net/snapshots/\|beta or rc release]].		This section describes the changes in the (unreleased) development files. It should reflect upcoming changes in the next version of the toolkit and latest [[http://translate.sourceforge.net/snapshots/\|beta or rc release]].
		+
		+
		+	==== Mozilla DTD files change ====
		+
		+	We now preserve spaces in DTD files i.e.
		+
		+	<!ENTITY some.label "definition">
		+
		+	Will preserve the spaces around the entity name ''some.lable''
		+
		+	You probably want to run po2moz once to isolate the space changes from real translations.

	===== 1.6.0 =====		===== 1.6.0 =====

toolkit:index

Thu, 29 Mar 2012 23:08:57 +0000

1332773184		current
Line 8:		Line 8:
	To help improve the quality of your localisation, the Toolkit includes tools to help check, validate, merge and extract messages from your localizations. And of course there are many other [[features\|benefits]].		To help improve the quality of your localisation, the Toolkit includes tools to help check, validate, merge and extract messages from your localizations. And of course there are many other [[features\|benefits]].

-	The Toolkit has a long [[history]] and is part of our project to build standards based localisation tools for Free and Open Source Software. At this stage the Translate Toolkit API already forms the technological basis of the translation tools built by ourselves and several other projects. If you want to use the Toolkit to build translation tools, you might be interested in the [[http://translate.sourceforge.net/doc/api\|API documentation for the Translate Toolkit]].	+	The Toolkit has a long [[history]] and is part of our project to build standards based localisation tools for Free and Open Source Software. At this stage the Translate Toolkit API already forms the technological basis of the translation tools built by ourselves and several other projects. If you want to use the Toolkit to build translation tools, you might be interested in the [[http://readthedocs.org/docs/translate-toolkit/en/latest/api/\|API documentation for the Translate Toolkit]].

	This documentation is maintained in the wiki at http://translate.sourceforge.net/wiki/toolkit/index .		This documentation is maintained in the wiki at http://translate.sourceforge.net/wiki/toolkit/index .

toolkit:ini

Fri, 16 Jan 2009 10:01:14 +0000

1232099956		current
Line 12:		Line 12:
	The format supports two dialects:		The format supports two dialects:

-	* default: standard iniparse handling of INI files	+	* default: standard iniparse handling of INI files
-	* inno: follows Inno escaping conventions	+	* inno: follows [[http://www.innosetup.com/files/istrans/\|Inno]] escaping conventions

	===== References =====		===== References =====

toolkit:ini2po

Wed, 02 Feb 2011 13:41:16 +0000

1236941145		current
Line 24:		Line 24:
	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|		\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|		\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|
-	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgid_comment, msgctxt, keep, msgid_comment_all (default: 'msgctxt') \|	+	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgctxt, (default: 'msgctxt') \|

	Options (po2ini):		Options (po2ini):
Line 50:		Line 50:
	All .ini files found in the ''ini/'' directory are converted to Gettext POT files and placed in the ''pot/'' directory.		All .ini files found in the ''ini/'' directory are converted to Gettext POT files and placed in the ''pot/'' directory.

-	If you are translating for the first time then you can skip the next step. If you need to recovery your existing translations then we do the following:	+	If you are translating for the first time then you can skip the next step. If you need to recover your existing translations then we do the following:

	ini2po -t lang/ zu/ po-zu/		ini2po -t lang/ zu/ po-zu/

-	Using the English .ini files found in ''lang/'' and your existing Zulu translation in ''zu/'' we create a set of PO files in ''po-zu/''. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations.	+	Using the English .ini files found in ''lang/'' and your existing Zulu translation in ''zu/'' we create a set of PO files in ''po-zu/''. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision. If they are not, you will have to review all translations.

	You are now in a position to translate your recovered translations or your new POT files.		You are now in a position to translate your recovered translations or your new POT files.

toolkit:installation

Mon, 19 Mar 2012 21:23:17 +0000

1332191946		current
Line 24:		Line 24:
	===== Download =====		===== Download =====

-	Download a stable [[http://sourceforge.net/projects/translate/files/Translate%20Toolkit/\|released version]]. Or if you have a python environment, run `easy_install translate-toolkit`. For those who need problems fixed, or who want to work on the bleeding edge, get the latest source from [[installation#installing_from_subversion\|Subversion]].	+	Download a stable [[http://sourceforge.net/projects/translate/files/Translate%20Toolkit/\|released version]]. Or if you have a python environment, run `easy_install translate-toolkit`. For those who need problems fixed, or who want to work on the bleeding edge, get the latest source from [[installation#installing_from_Git\|Git]].

	For most Windows users, the file named "translate-toolkit-...-setup.exe" is the best choice and contains everything you need if you just want to run Toolkit commands. If you want to use it for development, you will need to install it with easy_install or from the source package.		For most Windows users, the file named "translate-toolkit-...-setup.exe" is the best choice and contains everything you need if you just want to run Toolkit commands. If you want to use it for development, you will need to install it with easy_install or from the source package.

toolkit:json2po

Wed, 02 Feb 2011 13:38:56 +0000

	current
Line 1:	Line 1:
	+	====== json2po ======
	+
	+	Converts .json files to Gettext PO format.
	+
	+	===== Usage =====
	+
	+	json2po [options] <json> <po>
	+	po2json [options] -t <json> <po> <json>
	+
	+	Where:
	+	\| <json> \| is a valid .json file or directory of those files \|
	+	\| <po> \| is a directory of PO or POT files \|
	+
	+	Options (json2po):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in php format \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|
	+	\| --filter=FILTER \| leaves to extract e.g. 'name,desc': (default: extract everything) \|
	+	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgctxt, (default: 'msgctxt') \|
	+
	+	Options (po2json):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in po, pot formats \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in php format \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| --fuzzy \| use translations marked fuzzy \|
	+	\| --nofuzzy \| don't use translations marked fuzzy (default) \|
	+
	+	===== Examples =====
	+
	+	This example looks at roundtrip of .json translations as well as recovery of existing translations.
	+
	+	First we need to create a set of POT files.
	+
	+	json2po -P json/ pot/
	+
	+	All .json files found in the ''json/'' directory are converted to Gettext POT files and placed in the ''pot/'' directory.
	+
	+	If you are translating for the first time then you can skip the next step. If you need to recover your existing translations then we do the following:
	+
	+	json2po -t lang/ zu/ po-zu/
	+
	+	Using the English .json files found in ''lang/'' and your existing Zulu translation in ''zu/'' we create a set of PO files in ''po-zu/''. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision. If they are not, you will have to review all translations.
	+
	+	You are now in a position to translate your recovered translations or your new POT files.
	+
	+	Once translated you can convert back as follows:
	+
	+	po2json -t lang/ po-zu/ zu/
	+
	+	Your translations found in the Zulu PO directory, ''po-zu/'', will be converted to .json using the files in ''lang/'' as templates and placing your newly translated .json files in ''zu/''.
	+
	+	To update your translations simply redo the POT creation step and make use of [[pot2po]] to bring your translation up-to-date.
	+
	+
	+
	+	===== Bugs =====
	+
	+	None known

toolkit:junitmsgfmt

Mon, 26 Mar 2012 14:46:30 +0000

1273675345		current
Line 2:		Line 2:
	(Available since Translate Toolkit 1.7.0)		(Available since Translate Toolkit 1.7.0)

-	Run msgfmt and provide JUnit type output for use in continuous integration systems like Hudson.	+	Run msgfmt and provide JUnit type output for use in continuous integration systems like Hudson and Jenkins.

	===== Usage =====		===== Usage =====

toolkit:levenshtein_distance

Fri, 29 Jan 2010 13:25:58 +0000

1264771558		current
Line 2:		Line 2:
	The [[wp>Levenshtein distance]] is used for measuring the "distance" or similarity of two character strings. Other similarity algorithms can be supplied to the code that does the matching.		The [[wp>Levenshtein distance]] is used for measuring the "distance" or similarity of two character strings. Other similarity algorithms can be supplied to the code that does the matching.

-	This code is used in [[pot2po]], [[tmserver]] and [[virtaal:index\|Virtaal]]. It is implemented in the toolkit, but can optionally use the fast C implementation provided by [[https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161\|python-Levenshtein]] if it is installed. It is strongly recommended that python-levenshtein be installed.	+	This code is used in [[pot2po]], [[tmserver]] and [[virtaal:index\|Virtaal]]. It is implemented in the toolkit, but can optionally use the fast C implementation provided by [[http://sourceforge.net/projects/translate/files/python-Levenshtein/\|python-Levenshtein]] if it is installed. It is strongly recommended that python-levenshtein be installed.

	To exercise the code the classfile "Levenshtein.py" can be executed directly with		To exercise the code the classfile "Levenshtein.py" can be executed directly with

toolkit:lookupserver

Thu, 05 Aug 2010 10:28:12 +0000

1248431096		current
Line 1:		Line 1:
-	<note>Note that lookupserver has been replaced by [[tmserver]] as the best way to provide a translation memory service. This is kept for reference only. Tmserver should be used for all work.</note>	+	<note>Note that lookupserver has been replaced by [[tmserver]] as the best way to provide a translation memory service. This is kept for reference only. Tmserver should be used for all work. The lookupservice and lookup client has been removed from the Toolkit with version 1.8.0.</note>

	====== lookupserver ======		====== lookupserver ======

toolkit:migrating_to_firefox

Sat, 05 Jan 2008 18:19:53 +0000

1199556500		current
Line 3:		Line 3:
	This quickstart shows you how to migrate your existing translations		This quickstart shows you how to migrate your existing translations
	of the [[guide:Mozilla]] suite to the [[guide:Firefox]] web-browser. The same		of the [[guide:Mozilla]] suite to the [[guide:Firefox]] web-browser. The same
-	instructions can be used to migrate [[:Thunderbird]].	+	instructions can be used to migrate [[guide:Thunderbird]].

	Note: This guide assumes that you are or will be using PO files.		Note: This guide assumes that you are or will be using PO files.

toolkit:migrating_translations

Sat, 01 Jan 2011 17:11:40 +0000

1293901900		current
Line 24:		Line 24:

	This will create new POT files in //ooo-20-pot//.		This will create new POT files in //ooo-20-pot//.
-
	===== Checking your old PO files for errors =====		===== Checking your old PO files for errors =====

Line 33:		Line 32:
	pocompendium check.po -d ooo-113-old		pocompendium check.po -d ooo-113-old

-	This will create a compendium PO files, //check.po//, from all the PO files in the directory //ooo-113-old//. Where //ooo-113-old// contains	+	This will create a compendium PO files, //check.po//, from all the PO files in the directory //ooo-113-old//, where //ooo-113-old// contains
	all your old translations. pocompendium is a wrapper around various Gettext tools, encoding errors will appear as errors from those tools.		all your old translations. pocompendium is a wrapper around various Gettext tools, encoding errors will appear as errors from those tools.

toolkit:mo

Mon, 06 Oct 2008 14:08:03 +0000

1204033642		current
Line 8:		Line 8:
	The toolkit can create .mo files from PO or XLIFF files, handling plurals and msgctxt. It can also read .mo files, allowing counting, etc and also allowing the .mo files to act as a translation memory.		The toolkit can create .mo files from PO or XLIFF files, handling plurals and msgctxt. It can also read .mo files, allowing counting, etc and also allowing the .mo files to act as a translation memory.

-	==== No hash table ====	+	Since version 1.2 of the Translate Toolkit, the hash table is also generated (the Gettext .mo file works fine without it). Due to slight differences in the construction of the hashing, the generated files are not identical to those generated by msgfmt, but they should be functionally equivalent and 100% usable. Bug [[bug>326]] tracked the implementation of the hashing. The hash is platform dependent.
-		+
-	The hash table is not implemented (the Gettext .mo file works fine without it). This might result in slower performance although the Gettext manual raises doubts about the speed gain. The hash is platform dependent. Bug [[bug>326]] is tracking implementation of hashing.	+

toolkit:moz-l10n-builder

Tue, 04 Nov 2008 12:47:43 +0000

1225802454		current
Line 33:		Line 33:

	moz-l10n-builer is not currently distributed as part of the toolkit. You can get the [[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/moz-l10n-builder\|latest version from Subversion]]		moz-l10n-builer is not currently distributed as part of the toolkit. You can get the [[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/moz-l10n-builder\|latest version from Subversion]]
-	and you will also need this [[http://translate.svn.sourceforge.net/viewvc/checkout/translate/src/trunk/tools/mozilla-l10n.patch\|minor patch]] to the mozilla source code.	+	and you will also need this [[http://translate.svn.sourceforge.net/viewvc/checkout/translate/src/trunk/tools/mozilla/mozilla-l10n.patch\|minor patch]] to the mozilla source code.

	===== Usage =====		===== Usage =====

toolkit:moz2po

Tue, 04 Nov 2008 14:55:43 +0000

toolkit:mozilla_l10n_scripts

Wed, 18 Mar 2009 15:41:41 +0000

1236613896		current
Line 7:		Line 7:
	All of these scripts are available on Subversion from [[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/\|here]].		All of these scripts are available on Subversion from [[https://translate.svn.sourceforge.net/svnroot/translate/src/trunk/tools/mozilla/\|here]].

		+	We are currently generating POT files for most major betas, RCs and releases of Firefox and Thunderbird. They are available here:
		+	http://l10n.mozilla.org/pootle/pot/
		+
		+	As a start you might want to just use these POT files and gradually learn more about the processes described below. Contact us for more help on using these.

	===== Requirements =====		===== Requirements =====

toolkit:multifile_multifilestyle

Wed, 19 Oct 2005 09:45:09 +0000

	current
Line 1:	Line 1:
	+	====== --multifile=MULTIFILESTYLE ======

	+	This options determines how the POT/PO files are spli from the source files. In many cases
	+	you have source files that generate either too many small files or one large files which you would rather see
	+	split up into smaller files.
	+
	+	===== single =====
	+
	+	Output individual files.
	+
	+	===== toplevel =====
	+
	+	Split the source files at the top level. Ie you see a number of top level files.
	+
	+	===== onefiles =====
	+
	+	One large file instead of many smaller files.

toolkit:odf

Thu, 12 Feb 2009 14:18:13 +0000

1234447323		current
Line 10:		Line 10:
	http://translate.svn.sourceforge.net/viewvc/translate/src/trunk/translate/storage/odf_shared.py?view=log		http://translate.svn.sourceforge.net/viewvc/translate/src/trunk/translate/storage/odf_shared.py?view=log

-	More complex tag uses are still needed to extract 100% correctly in the case of some spreadsheet values where the presentation form is stored along with the internal values.	+	More complex tag uses are still needed to extract 100% correctly in some complex cases. For more information, see the list of [[odf:testing\|issues from testing]].

toolkit:odf2xliff

Tue, 17 Feb 2009 11:10:18 +0000

1233844661		current
Line 55:		Line 55:
	===== Bugs =====		===== Bugs =====

-	This filter is not yet extensively used - we appreciate your feedback. See [[xliff]] to see how well our implementation conforms to the XLIFF standard. Possible issues were listed during [[odf:testing]].	+	This filter is not yet extensively used - we appreciate your feedback. For more information on conformance to standards, see the [[xliff]] or [[odf]] pages. Possible issues were listed during [[odf:testing]].

toolkit:omegat_glossary

Thu, 26 Nov 2009 13:17:56 +0000

1259241430		current
Line 21:		Line 21:
	===== Issues =====		===== Issues =====

-	* UTF-8 files works correctly.
	* There has not been extensive testing on system encoded files and there are likely to be issues in these files for encodings that fall outside of common ASCII characters.		* There has not been extensive testing on system encoded files and there are likely to be issues in these files for encodings that fall outside of common ASCII characters.
		+	* Files with additional columns are read correctly but cannot be written.

toolkit:oo2po

Tue, 08 Apr 2008 20:19:15 +0000

1207573440		current
Line 103:		Line 103:


		+
		+
		+	===== helpcontent2 =====
		+
		+	The escaping of ''helpcontent2'' from SDF files was very confusing, bug [[bug>295]] implemented a fix that appeared in version 1.1.0 (All known issues were fixed in 1.1.1). Translators are now able to translate helpcontent2 with clean escaping.

	===== Bugs =====		===== Bugs =====

-	''helpcontent2'' escaping in SDF files ares very confusing, but bug [[bug>295]] a tracked a fix that appeared in version 1.1.0. All known issues were fixed in 1.1.1.	+	None known

toolkit:oo2xliff

Fri, 04 Jan 2008 14:38:02 +0000

1199457402		current
Line 1:		Line 1:
-	~~REDIRECT>oo2po~~	+	~~REDIRECT>toolkit:oo2po~~

toolkit:personality_type

Tue, 17 Aug 2010 08:06:10 +0000

1271229542		current
Line 3:		Line 3:
	===== java (default) =====		===== java (default) =====

-	Create output strictly according to the specification for .properties files. This will use escaped Unicode for any non-assci characters. Thus the following string found in a PO file:	+	Create output strictly according to the specification for .properties files. This will use escaped Unicode for any non-ASCII characters. Thus the following string found in a PO file:

	ṽḁḽṻḝ		ṽḁḽṻḝ
Line 20:		Line 20:

	Skype .lang files are .properties files in UTF-16. The & is used as an accelerator (marked in the PO header).		Skype .lang files are .properties files in UTF-16. The & is used as an accelerator (marked in the PO header).
		+
		+	===== flex =====
		+
		+	Flex follows the Mozilla approach, a UTF-8 encoded file with no escaped unicode. We include it as its own dialect for ease of use.
		+
		+	===== strings =====
		+
		+	Much Mac OS X and iPhone software is translated using .strings files. These are quite different from properties files and we treat them here as key value files.
		+
		+	The files are in UTF-16 with a few minor escaping conventions.

toolkit:phase

Fri, 04 Jan 2008 14:16:19 +0000

1199456138		current
Line 12:		Line 12:
	* [[man>diff]]		* [[man>diff]]
	* [[man>cvs]]		* [[man>cvs]]
		+


	===== Latest Version =====		===== Latest Version =====

-	phase is not currently distributed as part of the toolkit. You can get the [[http://translate.svn.sourceforge.net/viewvc/checkout/translate/src/trunk/tools/phase\|latest version from Subversion]]	+	phase is not currently distributed as part of the toolkit. You can get the [[svn>/trunk/tools/phase\|latest version from Subversion]]

	===== Usage =====		===== Usage =====

toolkit:php

Mon, 19 Apr 2010 13:28:30 +0000

1271683525		current
Line 23:		Line 23:
	$string[ 'name' ]		$string[ 'name' ]
	</code>		</code>
-		+	* PHP array syntax for localisation (since > 1.6.0):
-	===== Non-Conformance =====	+
-		+
-	The following are not yet supported:	+
-	* PHP array syntax for localisation	+
	<code php>		<code php>
	$lang = array(		$lang = array(
Line 34:		Line 30:
	);		);
	</code>		</code>
		+
		+	===== Non-Conformance =====
		+
		+	The following are not yet supported:
		+
	* [[http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc\|herdoc]] and [[http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.nowdoc\|nowdoc]] are not managed		* [[http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc\|herdoc]] and [[http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.nowdoc\|nowdoc]] are not managed

toolkit:php2po

Mon, 19 Apr 2010 13:31:06 +0000

1271683866		current
Line 67:		Line 67:
	All .php files found in the ''lang/en'' directory are converted to Gettext POT files and placed in the ''pot'' directory.		All .php files found in the ''lang/en'' directory are converted to Gettext POT files and placed in the ''pot'' directory.

-	If you are translating for the first time then you can skip the next step. If you need to recovery your existing translations then we do the following:	+	If you are translating for the first time then you can skip the next step. If you need to recover your existing translations then we do the following:

	php2po -t lang/en lang/zu po-zu/		php2po -t lang/en lang/zu po-zu/

-	Using the English PHP files found in ''lang/en'' and your existing Zulu translation in ''lang/zu'' we create a set of PO files in ''po-zu''. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations.	+	Using the English PHP files found in ''lang/en'' and your existing Zulu translation in ''lang/zu'' we create a set of PO files in ''po-zu''. These will now have your translations. Please be aware that in order for that to work 100% you need to have both English and Zulu at the same revision, if they are not you will have to review all translations.

	You are now in a position to translate your recovered translations or your new POT files.		You are now in a position to translate your recovered translations or your new POT files.

toolkit:po

Thu, 26 Mar 2009 09:39:51 +0000

1234773458		current
Line 11:		Line 11:
	* Obsolete messages		* Obsolete messages
	* Message Context (msgctxt)		* Message Context (msgctxt)
		+	* Language header (since gettext version 0.17)
		+	* Previous message ID and context (#\| msgid and #\| msgctxt)

	===== Supported comments =====		===== Supported comments =====
Line 18:		Line 19:
	* source location comments <code>#: sourcefile.xxx:35</code>		* source location comments <code>#: sourcefile.xxx:35</code>
	* typecomments <code>#, fuzzy</code>		* typecomments <code>#, fuzzy</code>
-	* msgidcomments <code>magid "_: within msgid\n"</code>Also know as KDE style comments as they are used by KDE for message disambiguation and comments to translators.	+	* msgidcomments <code>magid "_: within msgid\n"</code>Also know as KDE style comments as they are used by KDE for message disambiguation and comments to translators. (support for this is being phased out)
	* obsolete messages <code>#~ msgid "Blah"		* obsolete messages <code>#~ msgid "Blah"
	#~ msgstr "Bleeh"</code>		#~ msgstr "Bleeh"</code>

-	===== Unsupported Features =====	+	* previous msgid and msgctxt <code> #\| msgid "previous message"</code>


-	==== Previous msgid ====	+	===== Unsupported Features =====
-		+
-	#\| msgid "previous message"	+
-		+
-	In Gettext 0.16. While we don't do anything with these we will not destro them needlessly since the parse can now capture them.	+

	==== Alternate language ====		==== Alternate language ====
Line 36:		Line 33:
	msgid[af] "Engels"		msgid[af] "Engels"

-	Unsure of when or if this was added to Gettext.	+	(This was proposed but not yet accepted in a released version of Gettext.)

toolkit:po2csv

Thu, 10 Jan 2008 09:33:31 +0000

1121950434		current
Line 1:		Line 1:
-	====== po2csv and csv2po ======	+	~~REDIRECT>toolkit:csv2po~~
-		+
-	Converts PO files into CSV (Comma Seperated Value) files. A CSV file can be opened in most spreadsheets	+
-	which therefore allows you to [[guide:tools:spreadsheet\|translate using a spreadsheet]]	+
-		+
-	===== Usage =====	+
-		+
-	po2csv [-P] <input> <csv>	+
-	csv2po [--charset=CHARSET] [-t <templates>] <csv> <output>	+
-		+
-	Where:	+
-	\| <input> \| contains a number of PO files \|	+
-	\| <csv> \| contains the resultant CSV files \|	+
-	\| <templates> \| are the reference POT or PO files \|	+
-	\| <output> \| the newly created PO files migrated from CSV \|	+
-		+
-	Options:	+
-	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|	+
-	\| --charset=CHARSET \| set charset to decode from CSV files \|	+
-		+
-	===== Examples =====	+
-		+
-	po2csv -P templates csv	+
-		+
-	Transform POT files found in //templates// into CSV files in //csv//	+
-		+
-	po2csv zulu zulu-csv	+
-		+
-	Convert PO files found in //zulu// to CSV files in //zulu-csv//	+
-		+
-	csv2po --charset=windows-1250 -t templates csv zulu	+
-		+
-	Convert CSV files found in //csv// into PO files that will be placed in //zulu// using PO files found in //template// as templates for the reconstruction of the PO files. The CSV files are also converted to //WINDOWS-1250// encoding to UTF-8.	+
-		+
-	===== Bugs =====	+
-		+
-	po2csv assumes that the file is in UTF-8, it probably should read the encoding from the PO header.	+
-	You cannot change the columns and it would probably be usefull if you could in cases where translators	+
-	have moved columns. We should probably work out how to include translator comments.	+

toolkit:po2html

Thu, 10 Jan 2008 09:34:39 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:html2po~~

toolkit:po2ini

Tue, 15 Apr 2008 14:51:45 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:ini2po~~

toolkit:po2moz

Thu, 10 Jan 2008 09:30:57 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:moz2po~~

toolkit:po2oo

Wed, 09 Jan 2008 19:33:19 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:oo2po~~

toolkit:po2php

Wed, 16 Jan 2008 09:37:56 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:php2po~~

toolkit:po2prop

Thu, 10 Jan 2008 09:36:51 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:prop2po~~

toolkit:po2rc

Sun, 06 Apr 2008 20:14:59 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:rc2po~~

toolkit:po2sub

Mon, 22 Jun 2009 12:24:04 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:sub2po~~

toolkit:po2tmx

Thu, 18 Mar 2010 11:11:49 +0000

1223632781		current
Line 1:		Line 1:
	====== po2tmx ======		====== po2tmx ======

-	Convert Gettext PO files to a TMX translation memory file. TMX is the Translation Memory	+	Convert Gettext [[PO]] files to a [[TMX]] translation memory file. TMX is the Translation Memory eXchange format developed by [[http://lisa.org/\|LISA]] (Localization Industry Standards Association).
-	eXchange format developed by [[http://lisa.org/\|LISA]] (Localization Industry Standards Association)	+
		+	If you are interested in po2tmx, you might also be interested in [[posegment]] that can be used to perform some automated segmentation on sentence level.

	===== Usage =====		===== Usage =====

toolkit:po2ts

Wed, 09 Jan 2008 08:02:42 +0000

1199865707		current
Line 1:		Line 1:
-	~~REDIRECT>ts2po~~	+	~~REDIRECT>toolkit:ts2po~~

toolkit:po2txt

Wed, 09 Jan 2008 19:35:09 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:txt2po~~

toolkit:po2wordfast

Fri, 13 Mar 2009 10:46:19 +0000

1200475380		current
Line 1:		Line 1:
	====== po2wordfast ======		====== po2wordfast ======
-
-	<note>Only in v1.1 of the Translate Toolkit</note>

	Convert Gettext PO files to a [[Wordfast]] translation memory file.		Convert Gettext PO files to a [[Wordfast]] translation memory file.

toolkit:po2xliff

Thu, 10 Jan 2008 09:35:53 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:xliff2po~~

toolkit:poclean

Wed, 16 Jan 2008 09:23:01 +0000

1180019403		current
Line 21:		Line 21:
	\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|		\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	\| -tTEMPLATE, --template=TEMPLATE \| read from TEMPLATE in po, pot formats \|		\| -tTEMPLATE, --template=TEMPLATE \| read from TEMPLATE in po, pot formats \|
-	\| [[--psyco=PSYCO\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|	+	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|

	===== Examples =====		===== Examples =====

toolkit:pocommentclean

Tue, 30 Sep 2008 21:03:31 +0000

1205394365		current
Line 7:		Line 7:
	* [[man>sed]]		* [[man>sed]]

-	===== Latest Version =====

-	pocommentclean is not currently distributed as part of the toolkit. You can get the [[http://translate.svn.sourceforge.net/viewvc/checkout/translate/src/trunk/tools/pocommentclean\|latest version from Subversion]]

	===== Usage =====		===== Usage =====

toolkit:pocompendium

Tue, 30 Sep 2008 08:51:49 +0000

1222764709		current
Line 9:		Line 9:

	GNU Gettext:		GNU Gettext:
-	* [[man>msgsttrib]]	+	* [[man>msgattrib]]
	* [[man>msgcat]]		* [[man>msgcat]]
	* [[man>msghack]] (may not be present on your installation of Gettext, but is only required for the invert command)		* [[man>msghack]] (may not be present on your installation of Gettext, but is only required for the invert command)

toolkit:pocompile

Tue, 26 Feb 2008 14:02:29 +0000

1200475381		current
Line 38:		Line 38:

	Create an MO file from an XLIFF file called //file.xlf// (available from version 1.1 of the toolkit).		Create an MO file from an XLIFF file called //file.xlf// (available from version 1.1 of the toolkit).
		+

	===== Bugs =====		===== Bugs =====

-	Gettext plurals and msgctxt are not handled before version 1.1 of the toolkit (as yet unreleased).	+	Gettext plurals and msgctxt are not handled before version 1.1 of the toolkit.
		+
		+	The .mo implementation does not support Gettext hash tables.

toolkit:poconflict

Thu, 03 Jan 2008 09:31:46 +0000

		current
Line 1:		Line 1:
		+	~~REDIRECT>toolkit:poconflicts~~

toolkit:poconflicts

Wed, 16 Jan 2008 09:23:02 +0000

1199353054		current
Line 23:		Line 23:
	\| -xEXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|		\| -xEXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in po format \|		\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in po format \|
-	\| [[psyco_psyco\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|	+	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	\| -I, --ignore-case \| ignore case distinctions \|		\| -I, --ignore-case \| ignore case distinctions \|
	\| -v, --invert \| invert the conflicts thus extracting conflicting destination words \|		\| -v, --invert \| invert the conflicts thus extracting conflicting destination words \|

toolkit:pocount

Tue, 21 Jul 2009 13:28:53 +0000

1245161006		current
Line 103:		Line 103:

	* There are some miscounts related to word breaks.		* There are some miscounts related to word breaks.
-	* There may be miscounts of total incomplete files in full mode.
	* When using the short output formats the columns may not be exactly aligned. This is because the number of digits in different columns is unknown before all input files are processed. The chosen tradeoff here was instanteous output (after each processed file) instead of waiting for the last file to be processed.		* When using the short output formats the columns may not be exactly aligned. This is because the number of digits in different columns is unknown before all input files are processed. The chosen tradeoff here was instanteous output (after each processed file) instead of waiting for the last file to be processed.

toolkit:podebug

Mon, 03 Jan 2011 10:53:08 +0000

1249309486		current
Line 89:		Line 89:
	unique alphanumeric sequences which are prepended to the target text. Thus now in your application you have your translated		unique alphanumeric sequences which are prepended to the target text. Thus now in your application you have your translated
	text and a alphanumeric value. Its is then easy to search for that value and find your problem string.		text and a alphanumeric value. Its is then easy to search for that value and find your problem string.
		+
		+	===== More reading =====
		+
		+	Here are some more examples in a series of blog posts:
		+	* http://translate.org.za/blogs/friedel/en/content/pseudolocalisation-podebug-1
		+	* http://translate.org.za/blogs/friedel/en/content/pseudolocalisation-podebug-2
		+	* http://translate.org.za/blogs/friedel/en/content/pseudolocalisation-podebug-3-interview-rail-aliev

	===== Bugs =====		===== Bugs =====

	None known		None known

toolkit:poen

Wed, 12 Nov 2008 06:47:16 +0000

1226472416		current
Line 2:		Line 2:

	<note warning>		<note warning>
-	This has been removed from Translate Toolkit > 1.2. Rather use [[podebug]] as follows:	+	poen has been removed from Translate Toolkit > 1.2. Rather use [[podebug]] as follows:
	<code>		<code>
	podebug --rewrite=en -f "" pot/ po/		podebug --rewrite=en -f "" pot/ po/

toolkit:pofilter

Wed, 03 Mar 2010 10:51:54 +0000

1242047182		current
Line 32:		Line 32:
	\| --fuzzy \| include elements marked fuzzy (default) \|		\| --fuzzy \| include elements marked fuzzy (default) \|
	\| --nofuzzy \| exclude elements marked fuzzy \|		\| --nofuzzy \| exclude elements marked fuzzy \|
-	\| --header \| include a PO header in the output \|	+	\| --header \| include a PO header in the output (always the case since version 1.6) \|
	\| --nonotes \| don't add notes about the errors (since version 1.3) \|		\| --nonotes \| don't add notes about the errors (since version 1.3) \|
	\| --autocorrect \| output automatic corrections where possible rather than describing issues \|		\| --autocorrect \| output automatic corrections where possible rather than describing issues \|

toolkit:pofilter_tests

Fri, 30 Dec 2011 08:34:28 +0000

1312556567		current
Line 44:		Line 44:
	checks that acronyms that appear are unchanged		checks that acronyms that appear are unchanged

-	If the acronym URL appears in the original this test will check that it appears in the translation. Translating acronyms is a language decision but many languages leave them unchanged in that case this test is useful for tracking down translations of the acronym and correcting them.	+	If an acronym appears in the original this test will check that it appears in the translation. Translating acronyms is a language decision but many languages leave them unchanged. In that case this test is useful for tracking down translations of the acronym and correcting them.

	==== blank ====		==== blank ====

toolkit:pofilter_tests_table

Mon, 21 Feb 2011 12:00:04 +0000

1298237683		current
Line 15:		Line 15:

	''pofilter --gnome -l''		''pofilter --gnome -l''
-
-	===== Adding new tests and new language adaptations =====
-
-	If you have an idea for a new test or want to add target language adaptations for your language then please help us with information about your test idea and the specifics of your language.
-
	===== Quality checks in Virtaal =====		===== Quality checks in Virtaal =====

Line 43:		Line 38:
	\|[[pofilter_tests#validchars\|Valid characters]] \| [[pofilter_tests#variables\|Placeholders]]\|		\|[[pofilter_tests#validchars\|Valid characters]] \| [[pofilter_tests#variables\|Placeholders]]\|
	\|[[pofilter_tests#xmltags\|XML tags]] \|\|		\|[[pofilter_tests#xmltags\|XML tags]] \|\|
		+	===== Adding new tests and new language adaptations =====
		+
		+	If you have an idea for a new test or want to add target language adaptations for your language then please help us with information about your test idea and the specifics of your language.
		+
		+
	===== Test Classification =====		===== Test Classification =====

toolkit:poglossary

Wed, 11 Jun 2008 12:52:34 +0000

1212530908		current
Line 1:		Line 1:
		+	<note>poglossary has been superseded by [[poterminology]]</note>
		+
	====== poglossary ======		====== poglossary ======

toolkit:pogrep

Tue, 12 Apr 2011 07:38:12 +0000

1236941085		current
Line 64:		Line 64:

	None known		None known
		+
		+	===== Further reading =====
		+	Here is a blog post explaining how pogrep can be used to do more targeted localisation of GNOME:
		+	http://translate.org.za/blogs/friedel/en/content/better-lies-about-gnome-localisation
		+

toolkit:pomerge

Tue, 14 Dec 2010 06:42:09 +0000

1292249104		current
Line 33:		Line 33:
	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation (set mode) \|		\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation (set mode) \|
	\| --mergeblanks=MERGEBLANKS \| whether to overwrite existing translations with blank translations (yes/no). Default is yes. \|		\| --mergeblanks=MERGEBLANKS \| whether to overwrite existing translations with blank translations (yes/no). Default is yes. \|
-	\| --mergefuzzy=MERGEFUZZY \| whether to overwrite existing translations with fuzzy translations (yes/no). Default is yes. \|	+	\| --mergefuzzy=MERGEFUZZY \| whether to overwrite existing translations with fuzzy translations (yes/no). Default is yes. (new in version 1.9) \|
	\| --mergecomments=MERGECOMMENTS \| whether to merge comments as well as translations (yes/no). Default is yes. \|		\| --mergecomments=MERGECOMMENTS \| whether to merge comments as well as translations (yes/no). Default is yes. \|

toolkit:pomigrate2

Tue, 30 Sep 2008 21:10:59 +0000

1220013149		current
Line 15:		Line 15:
	* [[man>msgmerge]]		* [[man>msgmerge]]

-	===== Latest Version =====

-	pomigrate2 is not currently distributed as part of the toolkit. You can get the [[svn>trunk/tools/pomigrate2\|latest version from Subversion]]

	===== Usage =====		===== Usage =====

toolkit:popuretext

Tue, 12 Jan 2010 13:00:06 +0000

1263301206		current
Line 3:		Line 3:
	Extracts all the source text from a directory of POT files or the target text from a directory of PO files, removing PO headers and optionally the accelerator keys.		Extracts all the source text from a directory of POT files or the target text from a directory of PO files, removing PO headers and optionally the accelerator keys.

-	If you want to use other tools to analyse the text within a translation project then this is the tool for you. You can use it to, for instance, calculate word frequencies to create an initial glossary based on the pure source text.	+	If you want to use other tools to analyse the text within a translation project, then this is the tool for you. For example, you can use it to calculate word frequencies to create an initial glossary based on the pure source text.

	===== Prerequisites =====		===== Prerequisites =====

-	* GNU Gettext	+	* GNU Gettext
-	* sed	+	* sed

toolkit:poreencode

Tue, 30 Sep 2008 21:07:15 +0000

1199456718		current
Line 8:		Line 8:


-	===== Latest Version =====

-	poreencode is not currently distributed as part of the toolkit. You can get the [[http://translate.svn.sourceforge.net/viewvc/checkout/translate/src/trunk/tools/poreencode\|latest version from Subversion]]

	===== Usage =====		===== Usage =====

toolkit:porestructure

Tue, 30 Sep 2008 08:54:08 +0000

1200475384		current
Line 26:		Line 26:
	===== Examples =====		===== Examples =====

-	See the examples for [[poconflicts#examples]] for the complete process using poconflict, porestructure, and pomerge.	+	The documentation for poconflicts has [[poconflicts#examples]] for the complete process using poconflict, porestructure, and pomerge.

	===== Bugs =====		===== Bugs =====

	None Known		None Known

toolkit:posegment

Tue, 11 Nov 2008 08:49:52 +0000

1226393392		current
Line 29:		Line 29:
	\| --source-language=LANG \| the source language code (default 'en') \|		\| --source-language=LANG \| the source language code (default 'en') \|
	\| --keepspaces \| Disable automatic stripping of whitespace \|		\| --keepspaces \| Disable automatic stripping of whitespace \|
		+	\| --only-aligned \| Removes units where sentence number does not correspond \|

	===== Examples =====		===== Examples =====

toolkit:posplit

Tue, 06 Sep 2011 14:31:11 +0000

1315319471		current
Line 3:		Line 3:
	Takes an existing PO file and splits it into three components: translated, untranslated and fuzzy. This is useful for reviewing translations or for extracting good translations from a compendium file.		Takes an existing PO file and splits it into three components: translated, untranslated and fuzzy. This is useful for reviewing translations or for extracting good translations from a compendium file.

-	Note that the input file is removed by the script (until version 1.9.1). The generated) output files can be combined again with msgcat.	+	Note that the input file is removed by the script (until version 1.9.1). The generated output files can be combined again with msgcat.

	===== Prerequisites =====		===== Prerequisites =====

toolkit:poswap

Mon, 21 Jul 2008 21:06:27 +0000

1200475385		current
Line 1:		Line 1:
	====== poswap ======		====== poswap ======

-	This tool builds a new translation file with the target text (translation) of the input file(s) as source language of the output file it creates. As an example, this makes it possible to have French as the source file for translation, rather than English. poswap was introduced in version 1.0 of the translate toolkit.	+	This tool builds a new translation file with the target text (translation) of the input file(s) as source language of the output file it creates.

-	Note that this requires no change in the software project and is only a manipulation of the strings in the existing files. The only requirement for this tool is a French translation.	+	This makes it possible to have French as the source file for translation, rather than English. Note that this requires no change in the software project and is only a manipulation of the strings in the existing files. The only requirement for this tool is a French translation.
		+
		+	It can also be used to convert translatable files that use logical IDs instead of source text into a format usable by human localisers.

	===== Usage =====		===== Usage =====

toolkit:pot2po

Mon, 17 Mar 2008 10:16:41 +0000

1205748831		current
Line 49:		Line 49:
	* If we cannot find a match we will first look through the current and obsolete messages and then through any global translation memory		* If we cannot find a match we will first look through the current and obsolete messages and then through any global translation memory
	* Fuzzy matching makes use of the [[Levenshtein distance]] algorithm to detect the best matches		* Fuzzy matching makes use of the [[Levenshtein distance]] algorithm to detect the best matches
		+
		+
		+	===== Performance =====
		+
		+	Fuzzy matches are usually of good quality. Installation of the [[https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161\|python-Levenshtein]] package will speed up fuzzy matching. Without this a Python based matcher is used which is considerably slower.
		+
		+	Install psyco for additional speedup (it is used by most toolkit tools if it is installed.)

	===== Bugs =====		===== Bugs =====

	* [[pomerge]] and pot2po should probably become one.		* [[pomerge]] and pot2po should probably become one.
-	* Versions before 1.0 were slow, but 1.0 should be much faster. Fuzzy matches are usually of good quality. Installation of the [[https://sourceforge.net/project/showfiles.php?group_id=91920&package_id=260161\|python-Levenshtein]] package will speed up fuzzy matching. Remember to install psyco for speedup. (It is used by most toolkit tools if it is installed.)

toolkit:poterminology

Sun, 02 Oct 2011 04:47:40 +0000

1279619898		current
Line 146:		Line 146:

	When using terminology files generated by poterminology as input, a plethora of translator comments marked with (poterminology) may be generated, with the number of these increasing on each iteration. You may wish to run [[pocommentclean]] (or a slightly modified version of it which only removes (poterminology) comments) on the input and/or output files, especially since translator comments are displayed as tooltips by Pootle (thankfully, they are truncated at a few dozen characters).		When using terminology files generated by poterminology as input, a plethora of translator comments marked with (poterminology) may be generated, with the number of these increasing on each iteration. You may wish to run [[pocommentclean]] (or a slightly modified version of it which only removes (poterminology) comments) on the input and/or output files, especially since translator comments are displayed as tooltips by Pootle (thankfully, they are truncated at a few dozen characters).
-
-	Currently, any translation items using plural forms will be entirely ignored for terminology extraction. The singular form for the item should be used, but this is not yet implemented (it is tracked as bug [[bug>532]]).

	Default threshold settings may eliminate all output terms; in this case, poterminology should suggest threshold option settings that would allow output to be generated (this enhancement is tracked as "bug" [[bug>582]]).		Default threshold settings may eliminate all output terms; in this case, poterminology should suggest threshold option settings that would allow output to be generated (this enhancement is tracked as "bug" [[bug>582]]).

toolkit:poterminology_stopword_file

Tue, 30 Sep 2008 19:39:57 +0000

	current
Line 1:	Line 1:
	+	====== Stopword file format ======
	+
	+	The default stopword file for [[poterminology]] describes the syntax of these files and provides a good default for most applications using English source text. You can find the location of the default stopword file by looking at the output of poterminology --help, or using the following command:
	+
	+	poterminology --manpage \| sed -n '/STOPFILE/s/.($.$).*/\1/p'
	+
	+	<note>New in v1.2</note>
	+
	+	===== Overview =====
	+
	+	The basic syntax of this file is line-oriented, with the first character of each line determining its function. The order of the lines is generally not significant (with one exception noted below), and the selection of function characters was made so that an ASCII sort of the file would leave it in a generally logical order (except for comment lines).
	+
	+	Apart from comment lines (which begin with '#') and empty lines (which are also ignored), there are three general types of lines, which may appear in any order:
	+
	+	* case mapping specifiers
	+
	+	* stoplist regular expressions
	+
	+	* stoplist words
	+
	+	==== Case mapping specifiers ====
	+
	+	A line beginning with a '!' specifies upper-/lower-case mapping for words or phrases before comparison with this stoplist (no mapping is applied to the words or regular expressions in this file, only to the source messages). The second character on this line must be one of the following:
	+
	+	* C no uppercase / lowercase mapping is performed
	+	* F 'Title Case" words / terms are folded to lower case (default)
	+	* I all words are mapped to lowercase
	+
	+	These correspond to the equivalent --preserve-case / --fold-titlecase / --ignore-case options to poterminology, but are completely independent and only apply to stoplist matching. You can run poterminology with -I to map all terms to lowercase, and if the case mapping specifier in the stopword file is '!C' a stoplist with "pootle" in it will not prevent a term containing "Pootle" from passing the stoplist (and then being mapped to "pootle").
	+
	+	There should only be one case mapping specifier in a stoplist file; if more than one are present, the last one will take precedence over the others, and its mapping will apply to all entries. If multiple stoplist files are used, the last case mapping specifier processed will apply to all entries in all files.
	+
	+	==== Stoplist regular expressions ====
	+
	+	Lines beginning with a '/' are regular expression patterns - any word that matches will be ignored by itself, and any phrase containing it will be excluded as well. The regular expression consists of all characters on the line following the initial '/' - these are extended regular expressions, so grouping, alternation, and such are available.
	+
	+	Regular expression patterns are only checked if the word itself does not appear in the stoplist file as a word entry. The regular expression patterns are always applied to individual words, not phrases, and must match the entire word (i.e. they are anchored both at the start and end).
	+
	+	Use regular expressions sparingly, as evaluating them for every word in the source files can be expensive. In addition to stoplist regular expressions, poterminology has precompiled patterns for C and Python format specifiers (e.g. %d) and XML/HTML <elements> and &entities; - these are removed before stoplist processing and it is not possible to override this.
	+
	+	==== Stoplist words ====
	+
	+	All other lines should begin with one of the following characters, which indicate whether the word should be ignored (as a word alone), disregarded in a phrase (i.e. a phrase containing it is allowed, and the word does not count against the --term-words length limit), or any phrase containing it should be excluded.
	+
	+	* + allow word alone, allow phrases containing it
	+	* : allow word alone, disregarded (for --term-word-length) inside phrase
	+	* < allow word alone, but exclude any phrase containing it
	+	* = ignore word alone, but allow phrases containing it
	+	* > ignore word alone, disregarded (for --term-word-length) inside phrase
	+	* @ ignore word alone, and exclude any phrase containing it
	+
	+	Generally '+' is only needed for exceptions to regular expression patterns, but it may also be used to override an entry in a previous stoplist if you are using multiple stoplists.
	+
	+	Note that if a word appears multiple times in a stoplist file with different function characters preceding it, the __last entry will take precedence__ over the others. This is the only exception to the general rule that order is not important in stopword files.
	+
	+	===== Default file example =====
	+
	+	# apply title-case folding to words before comparing with this stoplist
	+	!F
	+
	+	The fold-titlecase setting is the default, even if it were not explicitly specified. This allows capitalized words at the start of a sentence (e.g. "Who") to match a stopword "who" but allows acronyms like WHO (World Health Organization) to be included in the terminology. If you are using poterminology with source files that contain large amounts of ALL UPPERCASE TEXT you may find the ignore-case setting to be preferable.
	+
	+	# override regex match below for phrases with 'no'
	+	+no
	+
	+	The regular expression /..? below would normally match the word 'no' and both ignore it as a term and exclude any phrases containing it. The above will allow it to appear as a term and in phrases.
	+
	+	# ignore all one or two-character words (unless =word appears below)
	+	/..?
	+	# ignore words with parenthesis, typically function() calls and the like
	+	/.\(.
	+	# ignore numbers, both cardinal (e.g. 1,234.0) and ordinal (e.g. 1st, 22nd)
	+	/[0-9,.]+(st\|nd\|rd\|th)?
	+
	+	These regular expressions ignore a lot of uninteresting terms that are typically code or other things that shouldn't be translated anyhow. There are many exceptions to the one or two-character word pattern in the default stoplist file, not only with = like '=in' but also '+no' and ':on' and '<ok' and '>of'.
	+
	+	# allow these words by themselves and don't count against length for phrases
	+	:off
	+	:on
	+
	+	These prepositions are common as button text and thus useful to have as terms; they also form an important part of phrases so are disregarded for term word count to allow for slightly longer phrases including them.
	+
	+	# allow these words by themselves, but ignore any phrases containing them
	+	<first
	+	<hello
	+	<last
	+
	+	These are words that are worth including in a terminology, as they are common in applications, but which aren't generally part of idiomatic phrases.
	+
	+	# ignore these words by themselves, but allow phrases containing them
	+	=able
	+	=about
	+	=actually
	+	=ad
	+	=as
	+	=at
	+
	+	This is the largest category of stoplist words, and these are all just rather common words. The purpose of a terminology list is to provide specific translation suggestions for the harder words or phrases, not provide a general dictionary, so these words are not of interest by themselves, but may well be part of an interesting phrase.
	+
	+	# ignore these words by themselves, but allow phrases containing them, and
	+	# don't count against length for phrases
	+	#
	+	# (possible additions to this list for multi-lingual text: >di >el >le)
	+	#
	+	>a
	+	>an
	+	>and
	+
	+	These very common words aren't of interest by themselves, but often form an important part of phrases so are disregarded for term word count to allow for slightly longer phrases including them.
	+
	+	# ignore these words and any phrases containing them
	+	@ain't
	+	@aint
	+	@al
	+	@are
	+
	+	These are "junk" words that are not only uninteresting by themselves, they generally do not contribute anything to the phrases containing them.

toolkit:pretranslate

Tue, 08 Mar 2011 17:01:28 +0000

1228242731		current
Line 12:		Line 12:

	Where:		Where:
-	\| <input> \| is the translation file or directory to be pretranslate \|	+	\| <input> \| is the translation file or directory to be pretranslated \|
	\| <output> \| is the translation file or a directory where the pretranslated version will be stored \|		\| <output> \| is the translation file or a directory where the pretranslated version will be stored \|

toolkit:progress_progress

Sat, 28 Jul 2007 20:13:15 +0000

1185653571		current
Line 3:		Line 3:
	All of the programs can give visual feedback. This options allows you to select the style of that feedback.		All of the programs can give visual feedback. This options allows you to select the style of that feedback.

-	In the examples we are converting and OpenOffice.org 2.0 sdf/gsi file into POT files using [[toolkit:oo2po]].	+	In the examples we are converting and OpenOffice.org 2.0 sdf/gsi file into POT files using [[oo2po]].

	===== none =====		===== none =====

toolkit:prop2po

Tue, 17 Aug 2010 10:58:21 +0000

1282032777		current
Line 49:		Line 49:
	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|		\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	\| [[--personality=TYPE]] \|override the input file format: flex (since 1.8.0), mozilla, java, strings(since 1.8.0), skype (since 1.5.3) (for .properties files, default: java) \|		\| [[--personality=TYPE]] \|override the input file format: flex (since 1.8.0), mozilla, java, strings(since 1.8.0), skype (since 1.5.3) (for .properties files, default: java) \|
-	\| --encoding=ENCODING \| override the encoding set by the personality \|	+	\| --encoding=ENCODING \| override the encoding set by the personality (since 1.8.0) \|
	\| --fuzzy \| use translations marked fuzzy \|		\| --fuzzy \| use translations marked fuzzy \|
	\| --nofuzzy \| don't use translations marked fuzzy (default) \|		\| --nofuzzy \| don't use translations marked fuzzy (default) \|

toolkit:properties

Tue, 17 Aug 2010 08:16:31 +0000

1282032897		current
Line 13:		Line 13:

	* Does not fold access keys together as done in the Mozilla [[DTD]] format.		* Does not fold access keys together as done in the Mozilla [[DTD]] format.
		+	* We don't allow filtering of unchanged values. In Java you can inherit translations, if the key is missing from a file then Java will look to other files in the hierarchy to determine the translation.

	===== Examples =====		===== Examples =====

toolkit:psyco_mode

Sat, 26 Jan 2008 21:23:38 +0000

1201382618		current
Line 7:		Line 7:
	By default it is switched on, so you can safely ignore this option and benefit from psyco optimisations anyway.		By default it is switched on, so you can safely ignore this option and benefit from psyco optimisations anyway.

-	Note psyco only work on i386 architectures.	+	Note psyco only works on i386 architectures.

	To install psyco, you can look for it in your distribution's packages, or obtain it here: http://psyco.sourceforge.net/		To install psyco, you can look for it in your distribution's packages, or obtain it here: http://psyco.sourceforge.net/

toolkit:py2web2po

Thu, 05 Feb 2009 13:26:10 +0000

1233840370		current
Line 3:		Line 3:
	Converts web2py translation files to PO files and vice versa.		Converts web2py translation files to PO files and vice versa.

-	Web2py ([[http://mdp.cti.depaul.edu]], formerly known as Gluon) is a open-source, Python-based web application framework by Massimo Di Pierro (inspired by Django and Rails).	+	Web2py ([[http://mdp.cti.depaul.edu]], formerly known as Gluon) is an open-source, Python-based web application framework by Massimo Di Pierro (inspired by Django and Rails).

	Web2py uses an internal localization engine based on Python dictionaries, which is applied with the T() lookup function. Web2py provides a built-in translation interface for the T()-engine, which is excellent for rapid application development.		Web2py uses an internal localization engine based on Python dictionaries, which is applied with the T() lookup function. Web2py provides a built-in translation interface for the T()-engine, which is excellent for rapid application development.

toolkit:qm

Tue, 24 Feb 2009 12:39:02 +0000

1188285483		current
Line 1:		Line 1:
	====== Qt .qm ======		====== Qt .qm ======
-
-	NOTE: In still to be released 1.1 of the toolkit

	A .qm file is a compiled Qt [[.ts]] file. In many ways it is similar to Gettext, in that it uses a hashing table to lookup the translated text. In older version they store only the hash and the translation which doesn't make the format useful for recovering translated text.		A .qm file is a compiled Qt [[.ts]] file. In many ways it is similar to Gettext, in that it uses a hashing table to lookup the translated text. In older version they store only the hash and the translation which doesn't make the format useful for recovering translated text.

toolkit:qt_phrase_book

Sun, 21 Sep 2008 01:45:48 +0000

1221961516		current
Line 21:		Line 21:
	There are no missing features in our support in the toolkit. The only slight difference are:		There are no missing features in our support in the toolkit. The only slight difference are:

-	* We don't focus on adding and removing items, just updating and reading	+	* We don't focus on adding and removing items, just updating and reading
-	* Comments are not properly escaped on reading, they might be on writing	+	* Comments are not properly escaped on reading, they might be on writing
-	* An XML header is output on writing while it seems that no files in the wild contain an XML header.	+	* An XML header is output on writing while it seems that no files in the wild contain an XML header.
-	* The ''<definition>'' is aimed at users, the toolkits addnote feature focuses on programmer, translators, etc comments while there is really only one source of comments in a .qph. This causes duplication on the offline editor.	+	* The ''<definition>'' is aimed at users, the toolkits addnote feature focuses on programmer, translators, etc comments while there is really only one source of comments in a .qph. This causes duplication on the offline editor.

toolkit:quoting_and_escaping

Sat, 28 Jul 2007 20:00:58 +0000

1149694565		current
Line 22:		Line 22:
	Strings are quoted using either double or single quotes. The quoting character may not occur within the string. There is no provision for escaping. XML entities can be used e.g. ''''' can be used to denote a single quote within the single-quoted string.		Strings are quoted using either double or single quotes. The quoting character may not occur within the string. There is no provision for escaping. XML entities can be used e.g. ''''' can be used to denote a single quote within the single-quoted string.

-	Some DTD files seem to have backslash-escapes, but these are anomalies: see [[http://groups.google.com/group/mozilla.dev.l10n/browse_thread/thread/58256c1f59c22798/b4bac2de4182f3e0\|discussion thread on mozilla l10n-dev]]	+	Some DTD files seem to have backslash-escapes, but these are anomalies: see [[http://groups.google.com/group/mozilla.dev.l10n/browse_thread/thread/58256c1f59c22798/b4bac2de4182f3e0\|discussion thread on Mozilla l10n-dev]]

	===== Mozilla properties format =====		===== Mozilla properties format =====

toolkit:rc

Tue, 28 Apr 2009 14:15:59 +0000

1207727651		current
Line 1:		Line 1:
	====== Windows RC files ======		====== Windows RC files ======

-	Windows .rc files, or resource files, are used to store translatable text, dialogs, menu, etc. for Windows application.	+	Windows .rc files, or resource files, are used to store translatable text, dialogs, menu, etc. for Windows applications. The format can be handled by the Translate Toolkit [[rc2po]] and po2rc.

	<note>New in v1.2</note>		<note>New in v1.2</note>

toolkit:rc2po

Sat, 18 Jun 2011 17:13:21 +0000

1308406545		current
Line 81:		Line 81:
	===== Bugs =====		===== Bugs =====

-	None knowness	+	None known

toolkit:rewrite_style

Tue, 30 Aug 2011 15:22:37 +0000

1248876691		current
Line 57:		Line 57:
	New in version 1.4		New in version 1.4

-	Change the text into a version that uses equivalent latin characters that are upside down.	+	Change the text into a version that uses equivalent Latin characters that are upside down.

	msgid "English"		msgid "English"
	msgstr "‮Ǝuƃʅısɥ"		msgstr "‮Ǝuƃʅısɥ"

-	''flipped'' can give an output that simulates RTL languages. It inserts RTL characters to try to achieve RTL like results. Its not perfect but will give you some sense of whether your application can do RTL. Or just use it for fun!	+	''flipped'' can give an output that simulates RTL languages. It inserts RTL characters to try to achieve RTL-like results. Its not perfect but will give you some sense of whether your application can do RTL. Or just use it for fun!
		+
		+	For really testing right-to-left GUIs, you want to make sure that the whole application is shown in RTL, not just the strings. Test your pseudo-translated file as a translation of an RTL language like Arabic or Hebrew. In case the application relies on other files coming from libraries (like GTK+), you might need to repeat the process for them, or at least ensure that you have the Arabic/Hebrew .mo files for them installed.

	===== unicode =====		===== unicode =====

toolkit:running_the_tools_on_microsoft_windows

Mon, 27 Aug 2007 12:22:27 +0000

1186567913		current
Line 23:		Line 23:
	C:\Program Files\GnuWin32\bin\		C:\Program Files\GnuWin32\bin\

		+	===== Change Windows file to Unix file ======
		+
		+	Some programs in Windows will add CRLFs to the file which is considered rather poor practice for l10ns that require Unix files. To fix a text file, drag and drop it to the dos2unix.exe utility at Bastet.com:
		+
		+	[[http://www.bastet.com/]]

toolkit:strings

Fri, 30 Jul 2010 13:41:58 +0000

1280235503		current
Line 2:		Line 2:
	Mac OSX .strings files are used for some Cocoa / Carbon application localization, such as for the iPhone, iPod, and OSX. They are somewhat similar to Java properties, and therefore [[prop2po]] and [[po2prop]] is used for conversion.		Mac OSX .strings files are used for some Cocoa / Carbon application localization, such as for the iPhone, iPod, and OSX. They are somewhat similar to Java properties, and therefore [[prop2po]] and [[po2prop]] is used for conversion.

		+	This is supported by the Translate Toolkit since version 1.8.0.

	===== References =====		===== References =====

toolkit:sub2po

Mon, 22 Jun 2009 12:22:27 +0000

	current
Line 1:	Line 1:
	+	====== sub2po and po2sub ======
	+
	+	sub2po allows you to use the same principles of PO files with [[subtitles]]. In PO only items that change are marked fuzzy and only new items need to be translated, unchanged items remain unchanged for the translation.
	+
	+
	+	===== Usage =====
	+
	+	sub2po [options] <foo.srt> <foo.po>
	+	po2sub [options] [-t <foo.srt>] <XX.po> <foo-XX.srt>
	+
	+	Where:
	+	\| foo.srt \| is the input subtitle file \|
	+	\| foo.po \| is an empty PO file that may be translated \|
	+	\| XX.po \| is a PO file translated into the XX language \|
	+	\| foo-XX.srt \| is the foo.srt file translated into language XX \|
	+
	+	Options (sub2po):
	+
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -iINPUT, --input=INPUT \| read from INPUT in .srt format \|
	+	\| -xEXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	+	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|
	+	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgctxt (default) \|
	+
	+	Options (po2sub):
	+
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -iINPUT, --input=INPUT \| read from INPUT in po, pot formats \|
	+	\| -xEXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -oOUTPUT, --output=OUTPUT \| write to OUTPUT in srt format \|
	+	\| -tTEMPLATE, --template=TEMPLATE \| read from TEMPLATE in txt format \|
	+	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| --fuzzy \| use translations marked fuzzy \|
	+	\| --nofuzzy \| don't use translations marked fuzzy (default) \|
	+
	+	==== Examples ====
	+
	+	To create the POT files is simple:
	+
	+	sub2po -P SUBTITLE_FILE subtitles.pot
	+
	+	A translator would copy the POT file to their own PO file and then create translations of the entries. If you wish to create a PO file and not a POT file then leave off the //-P// option.
	+
	+	To convert back:
	+
	+	po2sub -t SUBTITLE_FILE subtitles-XX.po subtitles-XX.srt
	+
	+
	+	==== Translating ====
	+
	+	Translate as normal. However, see the issues mentioned at [[subtitles]].
	+
	+	==== Bugs ====
	+	There might be some issues with encodings, since the srt files don't specify them. We assume files to be encoded in UTF-8, so a conversion should solve this easily. Note that most of the handling of the srt files come from gaupol.

toolkit:subtitles

Mon, 22 Jun 2009 11:07:47 +0000

1234466812		current
Line 1:		Line 1:
	====== Subtitles ======		====== Subtitles ======
		+
		+	The translation of subtitles are supported in the toolkit with the commands [[sub2po]] and po2sub.

	The following formats are supported for subtitles:		The following formats are supported for subtitles:

toolkit:support_for_toolkit_tmx

Thu, 18 Mar 2010 11:10:41 +0000

1268910169		current
Line 2:		Line 2:
	===== Support for TMX =====		===== Support for TMX =====

-	Although TMX is supposed to be an exchange standard, not all tools create or read standard TMX files, and consequently some tools may not be able to use the Toolkit's TMXes and vice versa.	+	Although [[TMX]] is supposed to be an exchange standard, not all tools create or read standard TMX files, and consequently some tools may not be able to use the Toolkit's TMXes and vice versa.

	Have a good Unicode editor handy so that you can fiddle with the encoding of the file in extreme cases. For MS Windows users, we suggest Babelpad.		Have a good Unicode editor handy so that you can fiddle with the encoding of the file in extreme cases. For MS Windows users, we suggest Babelpad.
Line 13:		Line 13:

	=== Virtaal ===		=== Virtaal ===
-	Since these tests were made, we have also released [[virtal:index\|Virtaa]], which can use TMX files as well as many other formats.	+	Since these tests were made, we have also released [[virtaal:index\|Virtaal]], which can use TMX files as well as many other formats.

	=== Cafetran 2007 ===		=== Cafetran 2007 ===

toolkit:symb2po

Thu, 05 Feb 2009 09:10:56 +0000

1229507449		current
Line 3:		Line 3:
	Converts Symbian-style translation files to PO files and vice versa. The Symbian translation files currently have a strong Buddycloud flavour, but the tools will be made more general as the need arises.		Converts Symbian-style translation files to PO files and vice versa. The Symbian translation files currently have a strong Buddycloud flavour, but the tools will be made more general as the need arises.

-	<note>These tools currently only appear in the development version of the toolkit. You can get it by [[toolkit:installation\|checking out the code from Subverion]]</note>	+	<note>Appears in version 1.3 of the toolkit.</note>

	===== Usage =====		===== Usage =====

toolkit:tbx

Thu, 15 Jul 2010 14:51:35 +0000

1279191445	current
Line 241:	Line 241:


	+
	+	Below you can see a diagram that shows the levels and the data that goes in each level. Click on the image to enlarge.
	+
	+	{{:toolkit:tbx_levels_structure.png?560px\|}}

toolkit:text

Thu, 11 Oct 2007 12:29:00 +0000

1192105700		current
Line 4:		Line 4:

	In some cases you will need to adjust the source text for the conversion management to work well. This is because the text file format support considered units to be space separated blocks of text.		In some cases you will need to adjust the source text for the conversion management to work well. This is because the text file format support considered units to be space separated blocks of text.
		+

	===== Example =====		===== Example =====
Line 9:		Line 10:
	Heading		Heading
	=======		=======
		+
	Paragraph One		Paragraph One
		+
	Paragraph Two:		Paragraph Two:
	* First bullet		* First bullet

toolkit:tiki2po

Mon, 15 Dec 2008 18:26:47 +0000

	current
Line 1:	Line 1:
	+	====== tiki2po ======

	+	Converts [[http://tikiwiki.org\|TikiWiki]] language.php files to Gettext PO format.
	+
	+	===== Usage =====
	+
	+	tiki2po [options] <tiki> <po>
	+	po2tiki [options] <po> <tiki>
	+
	+	Where:
	+	\| <tiki> \| is a valid language.php file for TikiWiki \|
	+	\| <po> \| is a PO file \|
	+
	+	Options (tiki2po):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in php format \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	+	\| --include-unused \| When converting, include strings in the "unused" section? \|
	+
	+	Options (po2tiki):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in po, pot formats \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in php format \|
	+
	+	===== Examples =====
	+
	+	These examples demonstrate the use of tiki2po:
	+
	+	tiki2po language.php language.po
	+
	+	Convert the tiki language.php file to .po
	+
	+	po2tiki language.po language.php
	+
	+	Convert a .po file to a tiki language.php file
	+
	+
	+	===== Notes =====
	+
	+	* Templates are not currently supported.
	+
	+	===== Bugs =====
	+
	+	None known

toolkit:tmserver

Thu, 15 Jan 2009 15:07:00 +0000

	current
Line 1:	Line 1:
	+	====== tmserver ======
	+	tmserver is a Translation Memory service that can be queried via HTTP using a simple REST like URL/http and data is exchanged between server and client encoded in JSON
	+
	+	===== Usage =====
	+	tmserver.py --bind=HOSTNAME --port=PORT [--tmdb=TMDBFILE] [--import-translation-file=TMFILE [--import-source-lang=SOURCE_LANG] [--import-target-lang=TARGET_LANG]]
	+
	+	TMDBFILE is the sqlite database file containing [[tmdb]] translation memory data, if not specified a new temporary database is created
	+
	+	TMFILE is a translation file (po, xliff, etc.) that should be imported into the database (mostly useful when no tmdb file is specified).
	+
	+	Options:
	+	\| -h, --help \| show this help message and exit \|
	+	\| -d TMDBFILE, --tmdb=TMDBFILE \| translation memory database \|
	+	\| -f TMFILES, --import-translation-file=TMFILE \| translation file to import into the database \|
	+	\| -t TARGET_LANG, --import-target-lang=TARGET_LANG \| target language of translation files \|
	+	\| -s SOURCE_LANG, --import-source-lang=SOURCE_LANG \| source language of translation files \|
	+	\| -b BIND, --bind=HOSTNAME \| adress to bind server to \|
	+	\| -p PORT, --port=PORT \| port to listen on \|
	+
	+	===== Testing =====
	+	easiest way to run the server for testing is to pass it a large translation file (maybe generated by [[pocompendium]]) to create a tmdb database on the fly.
	+
	+	tmserver -b localhost -p 8080 -f compendium.po -s en_US -t ar
	+
	+	The server can be queried using a webbrowser. the url would be http://HOST:PORT/tmserver/SOURCE_LANG/TARGET_LANG/unit/STRING
	+
	+	So to see suggestions for "open file" try the url http://localhost:8080/tmserver/en_US/ar/unit/open+file
	+
	+	===== API =====
	+	===== Example Client =====

toolkit:tmx

Thu, 18 Mar 2010 11:09:37 +0000

1185652973		current
Line 3:		Line 3:

	===== Standard conformance =====		===== Standard conformance =====
-
-	FIXME: I think with base class and string escaping we now do strip markup in as much as we have relatively standard escaping (DB)

	Summary: TMX version 1.4 conformance to Level 1, except that no markup is stripped.		Summary: TMX version 1.4 conformance to Level 1, except that no markup is stripped.

toolkit:ts

Thu, 04 Mar 2010 22:38:33 +0000

1244799747		current
Line 12:		Line 12:
	===== Complete =====		===== Complete =====

-	Note that [[ts2po]] uses and older version and does not support all of these features. [[virtaal:index\|Virtaal]] and other users of the new ts class support the following:	+	Note that [[ts2po]] uses and older version and does not support all of these features. [[virtaal:index\|Virtaal]], [[pootle:index\|Pootle]] and other users of the new ts class support the following:

	* Context		* Context
-	* Message: status (unfinished, finished), source, translation	+	* Message: status (unfinished, finished, obsolete), source, translation, location
		+	* Notes: comment, extracomment, translatorcomment (last two since Toolkit 1.6.0)
	* Plurals: numerusform		* Plurals: numerusform

toolkit:ts2po

Wed, 24 Mar 2010 16:23:37 +0000

1269447817		current
Line 3:		Line 3:
	Convert Qt .ts localization files to Gettext .po format files using ts2po and convert the translated [[PO]] files back to [[TS]] using po2ts.		Convert Qt .ts localization files to Gettext .po format files using ts2po and convert the translated [[PO]] files back to [[TS]] using po2ts.

-	The Qt toolkit comes with a localization application, Qt Linguist, however you might wish to standardise on one localization tool. ts2po allows you to standardise on the PO format and PO related tools. Note that [[:virtaal:index\|Virtaal]] and [[:pootle:index:Pootle]] can work with .ts files directly without needing conversion.	+	The Qt toolkit comes with a localization application, Qt Linguist, however you might wish to standardise on one localization tool. ts2po allows you to standardise on the PO format and PO related tools. Note that [[:virtaal:index\|Virtaal]] and [[:pootle:index\|Pootle]] can work with .ts files directly without needing conversion.

	===== Usage =====		===== Usage =====

toolkit:txt2po

Mon, 21 Jan 2008 08:28:10 +0000

1200475387		current
Line 123:		Line 123:

	First we retrieve the file in raw dokuwiki format, then we create a POT file for editing. We created a French translation and using po2txt plus the original file as a template we output fr.txt which is a French version of the original txt2po.txt. This file can now be uploaded to the wiki server.		First we retrieve the file in raw dokuwiki format, then we create a POT file for editing. We created a French translation and using po2txt plus the original file as a template we output fr.txt which is a French version of the original txt2po.txt. This file can now be uploaded to the wiki server.
		+

	==== MediaWiki ====		==== MediaWiki ====

-	To retrieve the raw media wiki syntax add '?action=raw' to you wiki URL. The following retrieves the Translate Toolkit page from Wikipedia in raw MediaWiki format [[http://en.wikipedia.org/wiki/Translate_Toolkit?action=raw]]	+	To retrieve the raw media wiki syntax add '?action=raw' to you wiki URL. The following retrieves the Translate Toolkit page from Wikipedia in raw MediaWiki format [[http://en.wikipedia.org/wiki/Translate_Toolkit?action=raw]] or [[http://en.wikipedia.org/w/index.php?title=Pootle&action=raw]].

	to process follow the instructions above but substituting the MediaWiki retrieval method.		to process follow the instructions above but substituting the MediaWiki retrieval method.

toolkit:using_csv2po

Fri, 27 Jul 2007 14:52:12 +0000

1185547849		current
Line 1:		Line 1:
	====== Using csv2po ======		====== Using csv2po ======

-	[[toolkit:csv2po]] allows you to create CSV files from PO files. This allows you to	+	[[csv2po]] allows you to create CSV files from PO files. This allows you to
	send translation work to translators who do not or cannot use PO Editors but who		send translation work to translators who do not or cannot use PO Editors but who
	can use a Spreadsheet.		can use a Spreadsheet.
Line 7:		Line 7:
	===== Quickstart =====		===== Quickstart =====

-	- [[toolkit:pofilter]] --fuzzy --review -t untranslated <po-dir> <po-filtered-dir> (this step is optional)	+	- [[pofilter]] --fuzzy --review -t untranslated <po-dir> <po-filtered-dir> (this step is optional)
	- divide into sections		- divide into sections
-	- [[toolkit:csv2po\|po2csv]] <po-dir\|po-filtered-dir> <csv-out>	+	- [[csv2po\|po2csv]] <po-dir\|po-filtered-dir> <csv-out>
	- edit in Excel or OpenOffice.org Calc		- edit in Excel or OpenOffice.org Calc
-	- [[toolkit:csv2po]] --charset=windows-1250 -t templates <csv-in> <po-in> (you must work against a template directory, the charset option corrects problems with characters sets)	+	- [[csv2po]] --charset=windows-1250 -t templates <csv-in> <po-in> (you must work against a template directory, the charset option corrects problems with characters sets)
-	- [[toolkit:phase]] - to do basic checks sort out encoding issues	+	- [[phase]] - to do basic checks sort out encoding issues
-	- [[toolkit:pomerge]] --mergeblank=no -t <po-dir> <po-in> <po-dir>	+	- [[pomerge]] --mergeblank=no -t <po-dir> <po-in> <po-dir>
	- cvs diff -u > x.diff --- check the changes		- cvs diff -u > x.diff --- check the changes
	- cvs ci --- commit changes		- cvs ci --- commit changes
Line 58:		Line 58:
	(we use zip because most people are Windows users)		(we use zip because most people are Windows users)

-	==== Creating a wordcount ====	+	==== Creating a word count ====

	Professional translators work on source word counts. So we create a word count		Professional translators work on source word counts. So we create a word count
Line 104:		Line 104:
	the csv2po command without templates as this allows you to preserve the original file layout.		the csv2po command without templates as this allows you to preserve the original file layout.
	Only run it without -t if you are dealing with a partial part of the PO that you will		Only run it without -t if you are dealing with a partial part of the PO that you will
-	merge back using a [[toolkit:pomerge]].	+	merge back using a [[pomerge]].

	Note (1): running csv2po using the input PO files as templates give spurious		Note (1): running csv2po using the input PO files as templates give spurious

toolkit:using_oo2po

Fri, 27 Jul 2007 15:03:11 +0000

1185548556		current
Line 7:		Line 7:

	- [[ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT\|Download the latest POT and GSI files]]		- [[ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT\|Download the latest POT and GSI files]]
-	- [[toolkit:oo2po]] -P <gsi> <new-pots>	+	- [[oo2po]] -P <gsi> <new-pots>

	===== Detailed Description =====		===== Detailed Description =====
Line 18:		Line 18:
	* [[ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT\|Download the latest POT and GSI files]]		* [[ftp://ftp.linux.cz/pub/localization/OpenOffice.org/devel/POT\|Download the latest POT and GSI files]]

-	However, you will need this file if you need to use some of the other features of [[toolkit:oo2po]] such as changing the source language from English.	+	However, you will need this file if you need to use some of the other features of [[oo2po]] such as changing the source language from English.

	==== Produce the POT files using oo2po ====		==== Produce the POT files using oo2po ====

toolkit:using_pofilter

Sat, 05 Jan 2008 18:05:00 +0000

1238081044		current
Line 7:		Line 7:

	===== Quickstart =====		===== Quickstart =====
-		+	//Use any preferred text editor wherever ''vim'' is used.//
-	- pofilter -l (select a filter)	+	- Select filter(s): ''pofilter -l''
-	- pofilter -i existing_files/ -o errors/ [-t specific tests] [--excludefilter don't perform specific tests]	+	- Run filter(s): ''pofilter -i existing_files/ -o errors/ [-t specific tests] [--excludefilter don't perform specific tests]''
-	- *vim errors/.po (delete** items you don't want changed, set fuzzy if needed, delete if not needed)	+	- Delete items you don't want changed, set fuzzy if needed, delete if not needed: ''vim errors/*.po''
-	- pomerge -i errors/ -o existing_files/ -t existing_files/ (will overwrite existing files)	+	- Merge changes back: ''pomerge -i errors/ -o existing_files/ -t existing_files/'' (will overwrite existing files)
-	- cvs diff -u existing_files/ > x.diff	+	- Create a patch for the changes: ''cvs diff -u existing_files/ > x.diff''
-	- vim x.diff (check to see that the updates are what you want)	+	- Check to see that the updates are what you want: ''vim x.diff''
-	- cvs ci existing_files/	+	- Commit changes: ''cvs ci existing_files/''

	===== Detailed Description =====		===== Detailed Description =====

toolkit:utx

Mon, 20 Sep 2010 05:34:22 +0000

	current
Line 1:	Line 1:
	+	====== Universal Terminology eXchange (UTX) ======

	+	UTX is implemented by the Asia-Pacific Association for
	+	Machine Translation
	+
	+	===== Resources =====
	+
	+	* [[http://www.aamt.info/english/utx/index.htm\|UTX site]]
	+	* [[http://www.aamt.info/english/utx/utx-simple-1.00-specification-e.pdf\|Specification]] (v1.0)
	+
	+	===== Conformance =====
	+
	+	The Translate Toolkit implementation of UTX can correctly:
	+
	+	* Handle the header. Although we don't generate the header at the moment
	+	* Read any of the standard columns and optional columns. Although we can access these extra columns we don't do much with them.
	+
	+	Adjustments and not implemented features where the spec is not clear:
	+	* We do not implement the "#." comment as we need clarity on this
	+	* The "<space>" override for no part of speech is not implemented
	+	* The spec calls for 2 header lines, while examples in the field have 2-3 lines. We can read as many as supplied but assume the last header line is the column titles
	+	* We remove # from all field line entries, some examples in the field have ''#tgt'' as a column name

toolkit:wiki

Thu, 11 Oct 2007 14:29:37 +0000

1192106394		current
Line 13:		Line 13:
	* [[http://wiki.splitbrain.org/wiki:dokuwiki\|docuwiki]] - heading, bullet, numbered list		* [[http://wiki.splitbrain.org/wiki:dokuwiki\|docuwiki]] - heading, bullet, numbered list
	* [[http://www.mediawiki.org/wiki/MediaWiki\|MediaWiki]] - heading, bullet, numbered list		* [[http://www.mediawiki.org/wiki/MediaWiki\|MediaWiki]] - heading, bullet, numbered list
		+

	===== Possible uses =====		===== Possible uses =====
Line 19:		Line 20:

	With further enhancement the tool could probably be capable of converting from one wiki syntax to another, but that is of course not its main aim		With further enhancement the tool could probably be capable of converting from one wiki syntax to another, but that is of course not its main aim
		+
		+	===== Additional notes on MediaWiki =====
		+
		+	Media wiki can also export in XML format, see http://en.wikipedia.org/wiki/Special:Export and http://www.mediawiki.org/wiki/Manual:Parameters_to_Special:Export this however exports in XML so not directly usable by txt2po.
		+
		+	For importing please see http://en.wikipedia.org/wiki/Help:Import this is disabled on most wikis so not directly usable currently.

toolkit:wml

Fri, 27 Jun 2008 10:53:09 +0000

1214482846		current
Line 1:		Line 1:
	====== Wireless Markup Language ======		====== Wireless Markup Language ======
-	This page documents the support for WML and is used for planning our work on it. For more information about WML, see ....	+	This page documents the support for [[wp>Wireless Markup Language\|WML]] and is used for planning our work on it. For more information about WML, see ....

	This is implemented as a generic XML document type that is handled similarly to the way the [[developers:projects:ODF]] project handles ODF documents.		This is implemented as a generic XML document type that is handled similarly to the way the [[developers:projects:ODF]] project handles ODF documents.

toolkit:wordfast

Fri, 13 Mar 2009 10:46:47 +0000

1218031760		current
Line 1:		Line 1:
	====== Wordfast Translation Memory ======		====== Wordfast Translation Memory ======
-
-	(Only in v1.1)

	The Wordfast format, as used by the [[wp>Wordfast]] translation tool, is a simple tab delimited file.		The Wordfast format, as used by the [[wp>Wordfast]] translation tool, is a simple tab delimited file.

toolkit:xliff

Thu, 26 Mar 2009 09:31:45 +0000

1238059905		current
Line 2:		Line 2:

	XLIFF is the OASIS standard for translation. See http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm.		XLIFF is the OASIS standard for translation. See http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm.
-
-
-
-
	===== Flavours =====		===== Flavours =====

-	XLIFF also had documents that specify the conversion from various standard source documents and localisation formats.	+	XLIFF also has documents that specify the conversion from various standard source documents and localisation formats.

	* PO - For conformance to the po2xliff spec, see [[xliff2po]].		* PO - For conformance to the po2xliff spec, see [[xliff2po]].
Line 40:		Line 36:

	Here is a small report on the [[guide:tools:XLIFF support by MS Windows programs]].		Here is a small report on the [[guide:tools:XLIFF support by MS Windows programs]].
-

toolkit:xliff2oo

Wed, 09 Jan 2008 19:34:23 +0000

1199907142		current
Line 1:		Line 1:
-	~~REDIRECT>toolkit:po2oo~~	+	~~REDIRECT>toolkit:oo2po~~

toolkit:xliff2po

Thu, 05 Feb 2009 14:39:28 +0000

1200475388		current
Line 2:		Line 2:

	Converts XLIFF localization files to Gettext PO files. XLIFF is the XML Localization Interchange File Format		Converts XLIFF localization files to Gettext PO files. XLIFF is the XML Localization Interchange File Format
-	developed by [[http://lisa.org/\|LISA]] (The Localization Industry Standards Authority) to allow translation	+	developed by [[http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xliff\|OASIS]] (Organization for the Advancement of Structured Information Standards) to allow translation
	work to be standardised no matter what the source format and to allow the work to be freely moved from tool to		work to be standardised no matter what the source format and to allow the work to be freely moved from tool to
	tool.		tool.

1199556500		current
Line 4:		Line 4:
	\| & \| [[guide:KDE desktop]], [[guide:Mozilla]] (when using [[toolkit:moz2po]]) \|		\| & \| [[guide:KDE desktop]], [[guide:Mozilla]] (when using [[toolkit:moz2po]]) \|
	\| _ \| [[guide:GNOME desktop]] \|		\| _ \| [[guide:GNOME desktop]] \|
-	\| ~ \| [[:OpenOffice.org]] \|	+	\| ~ \| [[guide:OpenOffice.org]] \|

1200475378		current
Line 38:		Line 38:
	\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|		\| [[psyco_mode\|--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	\| -wWRAP, --wrap=WRAP \| set number of columns to wrap html at \|		\| -wWRAP, --wrap=WRAP \| set number of columns to wrap html at \|
		+	\| --notidy \| don't use tidy to clean up HTML, even if installed (new in version 1.2.1) \|
	\| --fuzzy \| use translations marked fuzzy \|		\| --fuzzy \| use translations marked fuzzy \|
	\| --nofuzzy \| don't use translations marked fuzzy (default) \|		\| --nofuzzy \| don't use translations marked fuzzy (default) \|

	current
Line 1:	Line 1:
	+	====== json2po ======
	+
	+	Converts .json files to Gettext PO format.
	+
	+	===== Usage =====
	+
	+	json2po [options] <json> <po>
	+	po2json [options] -t <json> <po> <json>
	+
	+	Where:
	+	\| <json> \| is a valid .json file or directory of those files \|
	+	\| <po> \| is a directory of PO or POT files \|
	+
	+	Options (json2po):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in php format \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in po, pot formats \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| -P, --pot \| output PO Templates (.pot) rather than PO files (.po) \|
	+	\| --filter=FILTER \| leaves to extract e.g. 'name,desc': (default: extract everything) \|
	+	\| [[--duplicates=DUPLICATESTYLE]] \| what to do with duplicate strings (identical source text): merge, msgctxt, (default: 'msgctxt') \|
	+
	+	Options (po2json):
	+	\| --version \| show program's version number and exit \|
	+	\| -h, --help \| show this help message and exit \|
	+	\| --manpage \| output a manpage based on the help \|
	+	\| [[--progress=PROGRESS]] \| show progress as: dots, none, bar, names, verbose \|
	+	\| [[--errorlevel=ERRORLEVEL]] \| show errorlevel as: none, message, exception, traceback \|
	+	\| -i INPUT, --input=INPUT \| read from INPUT in po, pot formats \|
	+	\| -x EXCLUDE, --exclude=EXCLUDE \| exclude names matching EXCLUDE from input paths \|
	+	\| -o OUTPUT, --output=OUTPUT \| write to OUTPUT in php format \|
	+	\| -t TEMPLATE, --template=TEMPLATE \| read from TEMPLATE in php format \|
	+	\| [[--psyco=MODE]] \| use psyco to speed up the operation, modes: none, full, profile \|
	+	\| --fuzzy \| use translations marked fuzzy \|
	+	\| --nofuzzy \| don't use translations marked fuzzy (default) \|
	+
	+	===== Examples =====
	+
	+	This example looks at roundtrip of .json translations as well as recovery of existing translations.
	+
	+	First we need to create a set of POT files.
	+
	+	json2po -P json/ pot/
	+
	+	All .json files found in the ''json/'' directory are converted to Gettext POT files and placed in the ''pot/'' directory.
	+
	+	If you are translating for the first time then you can skip the next step. If you need to recover your existing translations then we do the following:
	+
	+	json2po -t lang/ zu/ po-zu/
	+
	+	Using the English .json files found in ''lang/'' and your existing Zulu translation in ''zu/'' we create a set of PO files in ''po-zu/''. These will now have your translations. Please be aware that in order for the to work 100% you need to have both English and Zulu at the same revision. If they are not, you will have to review all translations.
	+
	+	You are now in a position to translate your recovered translations or your new POT files.
	+
	+	Once translated you can convert back as follows:
	+
	+	po2json -t lang/ po-zu/ zu/
	+
	+	Your translations found in the Zulu PO directory, ''po-zu/'', will be converted to .json using the files in ''lang/'' as templates and placing your newly translated .json files in ''zu/''.
	+
	+	To update your translations simply redo the POT creation step and make use of [[pot2po]] to bring your translation up-to-date.
	+
	+
	+
	+	===== Bugs =====
	+
	+	None known

1150281865		current
Line 6:		Line 6:
	Other cases in which you can expect inconsistencies:		Other cases in which you can expect inconsistencies:

-	* Multiple translators are invovled	+	* Multiple translators are involved
	* Translations are very old		* Translations are very old
-	* You preped this set of translations with translations from multiple sources	+	* You prepared this set of translations with translations from multiple sources
	* You changed terminology at some stage in the translation		* You changed terminology at some stage in the translation
	* You did not do a formal glossary development stage		* You did not do a formal glossary development stage
Line 14:		Line 14:
	===== What we won't be able to achieve =====		===== What we won't be able to achieve =====

-	We cannot find gramatical errors and we won't be able to find all cases of words, etc	+	We cannot find grammatical errors and we won't be able to find all cases of words, etc

	===== Scenario =====		===== Scenario =====
Line 23:		Line 23:
	- Terminology is well defined but not well used by the old translators		- Terminology is well defined but not well used by the old translators

-	We'll look at the translations first from the English, or source text, point of view. Then we will look at it from the Afrikaans point of view. The first will pick up where whe have translated the same English word differently in Afrikaans ie an inconsistency. While the second will determine if we use the same English word for different English words, possibly this will confuse a user.	+	We'll look at the translations first from the English, or source text, point of view. Then we will look at it from the Afrikaans point of view. The first will pick up where we have translated the same English word differently in Afrikaans ie an inconsistency. While the second will determine if we use the same English word for different English words, possibly this will confuse a user.

	==== Step 1: Extracting conflicting target text translations ====		==== Step 1: Extracting conflicting target text translations ====
Line 43:		Line 43:
	etc...		etc...

-	These are normal PO files which you can edit in any PO editor or text editor. If we look at the first file ''change.po'' we can see that the source text //Change// was translated as //Verander// and //Wysig//. The translators job is noe to correct these PO files, ignoring instances where the diffeerence is in fact corret.	+	These are normal PO files which you can edit in any PO editor or text editor. If we look at the first file ''change.po'' we can see that the source text //Change// was translated as //Verander// and //Wysig//. The translators job is noe to correct these PO files, ignoring instances where the difference is in fact correct.

-	Once all fixes have been made we can merge our changes back into the origianl files.	+	Once all fixes have been made we can merge our changes back into the original files.

-	==== Step 2: Merging our corrections back into the oroginal files ====	+	==== Step 2: Merging our corrections back into the original files ====

-	Our files in //af-conflicts// are in a flat structure. We need to structure them into the heirachy of the existing pofiles.	+	Our files in //af-conflicts// are in a flat structure. We need to structure them into the hierarchy of the existing PO files.

	porestructure af-conflicts af-restructured		porestructure af-conflicts af-restructured
Line 69:		Line 69:
	poconflicts -v -I --accelerator="&" af af-conflicts-invert		poconflicts -v -I --accelerator="&" af af-conflicts-invert

-	We use the same command line as in Step 1 but add //-v// to allow us to invert the match. We are also now outputing to //af-conflicts-invert// to make things clear.	+	We use the same command line as in Step 1 but add //-v// to allow us to invert the match. We are also now outputting to //af-conflicts-invert// to make things clear.

	This time the PO files that are created have Afrikaans names		This time the PO files that are created have Afrikaans names

1225810053		current
Line 86:		Line 86:
	po2moz -lzu-ZA -t en-US.xpi zu zu-ZA.xpi		po2moz -lzu-ZA -t en-US.xpi zu zu-ZA.xpi

-	Create a Zulu language (//-lzu-ZA//) XPI called //zu-ZA.xpi// from translations found in //zu// using //en-US.xpi// as a template. We use a template to ensure that our DTD and .properties files appear exactly as those in en-US	+	Create a Zulu language (''-lzu-ZA'') XPI called ''zu-ZA.xpi'' from translations found in ''zu'' using ''en-US.xpi'' as a template. We use a template to ensure that our DTD and .properties files appear exactly as those in en-US

	po2moz -t l10n/en-US po/xh l10n/xh		po2moz -t l10n/en-US po/xh l10n/xh

-	Create Mozilla files using the templates files in //l10n/en-US// (see above for how to create them) with PO translations in //po/xh// and ouput then	+	Create Mozilla files using the templates files in ''l10n/en-US'' (see above for how to create them) with PO translations in ''po/xh'' and ouput them to ''l10n/xh''. The files now in ''l10n/xh'' are ready for submission to Mozilla and can be used to build a language pack or translated version of Mozilla.
-	to //l10n/xh//. The files now in //l10n/xh// are ready for submission to Mozilla and can be used to build a language pack or translated version of Mozilla.	+


Line 101:		Line 100:
	Localisation of XHTML is not yet perfect, you might want to work with the files directly.		Localisation of XHTML is not yet perfect, you might want to work with the files directly.

-	Bug [[bug>129]] tracks the outstanding features	+	Bug [[bug>129]] tracks the outstanding features which would allow complete localisation of Mozilla including; all help, start pages, rdf files, etc. It also tracks some bugs.
-	which would allow complete localisation of Mozilla including; all help, start pages, rdf files, etc.	+
-	It also tracks some bugs.	+

-	Accesskeys don't yet work in .properties files and in several cases where the Mozilla dtd files don't follow the normal conventions, for example in security/manager/chrome/pippki/pref-ssl.dtd.po. You might also want to check the files mentioned in this bug [[mozbug>329444]] where mistakes in the DTD-definitions cause problems in the matching of accelerators with the text.	+	Accesskeys don't yet work in .properties files and in several cases where the Mozilla .dtd files don't follow the normal conventions, for example in ''security/manager/chrome/pippki/pref-ssl.dtd.po''. You might also want to check the files mentioned in this bug [[mozbug>329444]] where mistakes in the DTD-definitions cause problems in the matching of accelerators with the text.

	You might want to give special attention to the following files since it contains customisations that are not really translations.		You might want to give special attention to the following files since it contains customisations that are not really translations.
Line 113:		Line 110:
	Also, all width, height and size specifications need to be edited with feedback from testing the translated interfaces.		Also, all width, height and size specifications need to be edited with feedback from testing the translated interfaces.

-	There are some constructed strings in the Mozilla code which we can't do much about. Take good care to read the localisation notes. For an example, see mail/chrome/messenger/downloadheaders.dtd.po. In that specific file, the localisation note from the DTD file is lost, so take good care of those.	+	There are some constructed strings in the Mozilla code which we can't do much about. Take good care to read the localisation notes. For an example, see ''mail/chrome/messenger/downloadheaders.dtd.po''. In that specific file, the localisation note from the DTD file is lost, so take good care of those.

-	The file extension of the original Mozilla file is required to tell the Toolkit how to do the conversion. Therefore, a file like foo.dtd must be named foo.dtd.po in order to po2moz to recognise it as a DTD file.	+	The file extension of the original Mozilla file is required to tell the Toolkit how to do the conversion. Therefore, a file like foo.dtd must be named foo.dtd.po in order to ''po2moz'' to recognise it as a DTD file.