Bech: update : é allowed formats for the right part of mnemonic files

2018-06-15T12:16:57Z

update : é allowed formats for the right part of mnemonic files

Bech: /* Getting and installing apertium-c-formatters package */ Update for Git

2018-06-15T12:07:37Z

Getting and installing apertium-c-formatters package: Update for Git

Bech: Link to French page

2014-10-06T10:32:46Z

Link to French page

Bech: Creating page

2012-10-18T11:58:25Z

Creating page

New page

Mnemonic files are an alternative to <code>.po</code> files to generate multilingual user interfaces.

Except for the possible comments (starting with #) at the beginning of a file, the mnemonic files is made of lines with the following format:

Mnemonic "formatted_string_for_printf"

In these lines, the mnemonic (starting on the first column) must be kept unchanged from a language to another, while the string farther to the right is translated.

However, a string to be translated can contain the sequences <code>\r</code> or <code>\n</code> or other similar ones which, not only should not be translated, but must not disturb the translation of the following word when it touches the letter having a special meaning.

Similarly, indications of format as <code>%s</code>, <code>%3d</code>, <code>%4.2f</code> ... are kept unchanged.

'''Mnemonic files''' format is not directly carried out by Apertium package. It is necessary to recover the package '''apertium-c-formatters''' to have a deformatter which takes into account specificities of this format.

== Getting and installing apertium-c-formatters package ==

If you did not already recover apertium-c-formatters package for [[translating man pages]], let start by making the following operations:

Download apertium-c-formatters from SVN:
<pre>
svn checkout http://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-c-formatters
</pre>

Compile the source files:
<pre>
make
</pre>

Yes, compilation is very simple, and fast!

Install the tools:
<pre>
make install
</pre>

The above command assumes you have write access to <code>/usr/local/bin</code> and <code>/usr/local/share/man</code>. If not, enter the command:
<pre>
sudo make install
</pre>

By defaut, as for lttoolbox, apertium, and the language pairs, the installation is done in <code>/usr/local/bin</code> and <code>/usr/local/share</code>. If you wish to change the installation directory, you will have to change the first line of the ''makefile''.

<pre>
install_dir=/usr/local
</pre>

will be replaced by the parent directory where the executable commands will be. For example, if you put:

<pre>
install_dir=/usr
</pre>

tools will be installed in <code>/usr/bin</code> and man pages in <code>/usr/share/man</code> .

== Using ==

=== Available tools ===

Available tools to translate the mnemonic files are the following:

* '''desmnemo''' : deformatter for mnemonic files,
* '''remnemo''' : generic reformatter used for mnemonic files,
* '''apertium-mnemo''' : a shell intended to make the translation of mnemonic files easier.

=== Translation by calling the various tools ===

Assuming we are in the directory <code>samples-mnemo</code> of the package apertium-c-formatter and we want to translate into Spanish the file <code>mess-libremail.en</code> We can type:

<pre>
cat mess-libremail.en | desmnemo | apertium -f none en-es | remnemo > mess-libremail.es-utf
</pre>

If the source language was not English, we could first notice that we translate a mnemonic file using UTF-8 charset. If the file format is encoded ISO-8859-''n'' (or any other character set), we need to convert the data into UTF-8 to make them compatible with Apertium, which will also provide a result UTF-8 encoded.

In addition, the command <code>apertium</code> is executed with the <code>-f none</code> option, which is necessary for the deformatter <code>apertium-destxt</code> not to be used.

We can also give file names as parameters of the deformatter and the reformatter:

<pre>
desmnemo mess-libremail.en | apertium -f none en-es | remnemo - mess-libremail.es-utf
</pre>

We can notice the dash '''<code>-</code>''' as the first parameter of <code>remnemo</code> . Reformatters usually use the standard input (in this case the result produced by the command <code>apertium</code>) whereas it can be useful to preserve the result of reformatting in a file. But the problem is the general syntax of apertium reformatters require to specify the output file as the 2nd parameter. The '''<code>-</code>''' as the first parameter permit to overcome this problem.

=== More simple with the command apertium-mnemo ===

When a data format is integrated directly into the <code>apertium</code> command, there is the '''<code>-f</code>''' option to translate data produced in this format without having to call "by hand" a deformatter and a reformatter. The command <code>apertium-mnemo</code> is a shell which permits to do in the same way.

For example, to translate into Esperanto the file <code>mess-libremail.en</code> , we can type:

<pre>
cat mess-libremail.en | apertium-mnemo en-eo > mess-libremail.es-utf
</pre>

or even better:

<pre>
apertium-mnemo en-eo mess-libremail.en mess-libremail.es-utf
</pre>

The options '''<code>-u</code>''' and '''<code>-d datadir</code>''' of the command <code>apertium</code> are caried out by <code>apertium-mnemo</code>. You just have place them before the parameter indicating the translation direction (as for the command <code>apertium</code>).

[[Category:Formats]]
[[Category:Documentation in English]]

← Older revision		Revision as of 10:32, 6 October 2014
Line 1:		Line 1:
			[[Traduction des fichiers mnémoniques\|En français]]

	Mnemonic files are an alternative to <code>.po</code> files to generate multilingual user interfaces.		Mnemonic files are an alternative to <code>.po</code> files to generate multilingual user interfaces.

@@ Line 6: / Line 6: @@
  Mnemonic             "formatted_string_for_printf"
+               or
+ Mnemonic             character_string
 In these lines, the mnemonic (starting on the first column) must be kept unchanged from a language to another, while the string farther to the right is translated.
@@ Line 62: / Line 64: @@
 * '''desmnemo''' : deformatter for mnemonic files,
-* '''remnemo'''  : generic reformatter used for mnemonic files,
+* '''remnemo'''  : reformatter for mnemonic files,
 * '''apertium-mnemo''' : a shell intended to make the translation of mnemonic files easier.

@@ Line 19: / Line 19: @@
 If you did not already recover apertium-c-formatters package for [[translating man pages]], let start by making the following operations:
-Download apertium-c-formatters from SVN:
+Download apertium-c-formatters from GIT:
 <pre>
-svn checkout http://apertium.svn.sourceforge.net/svnroot/apertium/trunk/apertium-c-formatters
+git clone --depth 1 https://github.com/apertium/apertium-c-formatters
 </pre>

Translating mnemonic files - Revision history

Bech: update : é allowed formats for the right part of mnemonic files

Bech: /* Getting and installing apertium-c-formatters package */ Update for Git

Bech: Link to French page

Bech: Creating page