File:  [mozdev] / calendarhelp / www / translate.html
Revision 1.4: download - view: text, annotated - select for diffs - revision graph
Sun May 1 09:17:34 2005 UTC (12 years, 5 months ago) by whiteley
Branches: MAIN
CVS tags: HEAD
mention draft.xbl (for testing context tags)

<!-- MAIN CONTENT -->
<h5 class="page-header">Guidelines for translators</h5>

<p>
This document contains guidelines for translators who translate help
documentation for the project.
</p>

<p>
<strong>Note: </strong>When you see the term "Sunbird" in this document, it refers to any version of
Mozilla Calendar.
</p>


<h5 id="intro">Introduction</h5>
<p>
Sunbird's help is written in US English.  It can be translated into other 
languages.
</p>

<p>
Sunbird keeps the content of the help for each language separate.  All
languages share the help viewer code.  The visual style of the help depends
on the theme (skin) that the user chooses, so it is independent of the
language.
</p>



<h5 id="files">Files</h5>
<p>
For information about getting source files, see the
<a href="source.html">Source files</a> page.
The US English source files are in the directory
<code>calendarhelp/text/en-US </code>
Other files that you need to translate are in the directory
<code>calendarhelp/locale/en-US</code>
</p>

<p>
Translate the contents of files with these extensions:
<table class="plain">
<tr><td><code>.xhtml</code></td><td>The text of the help.</td></tr>
<tr><td><code>.css</code></td><td>Reusable content</td></tr>
<tr><td><code>.dtd</code></td><td>Reusable content</td></tr>
<tr><td><code>.png</code></td><td>Image (in the image directory)</td></tr>
<tr><td><code>.properties</code></td><td>Used by builder</td></tr>
</table>
</p>

<p>
Do not change the names of the files&mdash;leave them in English.
</p>



<h5 id="xhtml">XHTML files</h5>

<p>
An xhtml file contains HTML wrapped in XML.
The HTML is normal HTML, but the tagging is strict.
</p>

<p>
To translate the file, translate the content of the tags.
Also translate the contents of any <code>alt</code> or
<code>title</code> attributes.
Do not change any other attributes.
</p>

<p>
For example, to translate:
<blockquote<pre>
&lt;h3 id="words"&gt;Words used in the application&lt;/h3&gt;
</pre></blockquote>
Translate only the text 'Words used in the application'.
Do not change <code>id="words"</code>&mdash;leave the id attribute in English.
</p>

<p>
To test the file, view it in a browser.
The style sheet <code>draft.css</code> together with the bindings <code>draft.xbl</code>
provide a special style that reveals
the <code>&lt;index&gt;</code> tags and entities.
You can modify <code>draft.css</code> if you prefer&mdash;it is not built
into the content pack.
</p>



<h5 id="css">CSS files</h5>
<p>
In the CSS files, translate the text inside doublequote characters.
Do not change anything else.
</p>



<h5 id="png">PNG files</h5>
<p>
Some PNG files contain translatable text, and others do not.
Look at each file and make a decision whether to translate it.
</p>

<p>
If you need to translate the file, try to get the base version with no text.
Copy the base version and add text in your language so it has the same meaning
as the US English version.
</p>

<p>
If there is no base version available, you might have to remove the text from
the English version or create a new image from scratch.
</p>

<p>
Save the translated images as 256-color PNG files.
Do not change the image size.
</p>



<h5 id="index">Properties</h5>
<p>
The properties files contains some strings and the collating sequence for your locale.
They are used by the builder.
In <code>help.properties</code>, specify the sequence of lowercase characters used for sorting.
</p>

<hr>


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>