summaryrefslogtreecommitdiff
Side-by-side diff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/i18n.sgm31
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm
index 9ebdf6d..d55ebd0 100644
--- a/docs/usermanual/i18n.sgm
+++ b/docs/usermanual/i18n.sgm
@@ -56,80 +56,79 @@
<para>
To ensure a high quality of the translations the translatiors have to keep certain things
in mind.
</para>
<itemizedlist mark='opencircle'>
<listitem>
<para>
The applications do not speak to the user. This means that for example it should not
be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>.
</para>
</listitem>
<listitem>
<para>
Try not to use exclamationmarks. If the users sees them to often the ! looses it function
as a amplifier of a warning.
</para>
</listitem>
<listitem>
<para>
Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" instead
of "this is a demonstation !".
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Examplecode</title>
<para>
In the next paragraph you see an example of what the XML looks like.
</para>
-<!--
- <programlisting>
- <message>
- <source>New</source>
- <translation>Neu</translation>
- </message>
- <message>
- <source>Today</source>
- <translation>Heute</translation>
- </message>
- <message>
- <source>Day</source>
- <translation type="unfinished"></translation>
- </message>
- </programlisting>
--->
+<literallayout>
+ &lt;message&gt;
+ &lt;source&gt;New&lt;/source&gt;
+ &lt;translation&gt;Neu&lt;/translation&gt;
+ &lt;/message&gt;
+ &lt;message&gt;
+ &lt;source&gt;Today&lt;/source&gt;
+ &lt;translation&gt;Heute&lt;/translation&gt;
+ &lt;/message&gt;
+ &lt;message&gt;
+ &lt;source&gt;Day&lt;/source&gt;
+ &lt;translation type="unfinished"&gt;&lt;/translation&gt;
+ &lt;/message&gt;
+</literallayout>
+
<para>
As you can see the markup is very simple. The part between two source-tags is
the english text which appears if there is no translation yet. In the first
case this is <quote>New</quote>. The next row is where the translated string
would be. The first two messages are already translated, the third is
not. This is marked by the
<programlisting>type="unfinished"</programlisting>
</para>
<para>
If you choose to use an editor like VIM instead of the prefered tool
-Linguist- you have to remove that mark and add the translated string
between the two translation-tags.
</para>
<para>
It might happen that you see <emphasis>type="obsolete"</emphasis> in a
.ts-file. You should not translate these stings as they do no longer appear in the
application. The translationcoordinator removes those strings from time to time. In
Linguist those strings are grey and not translatable.
</para>
</section>
<section>
<title>Filetypes</title>
<para>
As a translator one needs to know three different filetypes.
<filename class='extension'>ts</filename>
.ts-files are the most important files for translators. In these files are all strings which
need to be translated and the translations themselfs. All .ts-files are located in
<filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de).