Annotation of calendarhelp/www/translate.html, revision 1.2

1.1       whiteley    1: <!-- MAIN CONTENT -->
                      2: <h5 class="page-header">Guidelines for translators</h5>
                      3: 
                      4: <p>
                      5: This document contains guidelines for translators who translate help
                      6: documentation for the project.
                      7: </p>
                      8: 
                      9: <p>
                     10: <strong>Note: </strong>When you see the term "Sunbird" in this document, it refers to any version of
                     11: Mozilla Calendar.
                     12: </p>
                     13: 
                     14: 
                     15: <h5 id="intro">Introduction</h5>
                     16: <p>
                     17: Sunbird's help is written in US English.  It can be translated into other 
                     18: languages.
                     19: </p>
                     20: 
                     21: <p>
                     22: Sunbird keeps the content of the help for each language separate.  All
                     23: languages share the help viewer code.  The visual style of the help depends
                     24: on the theme (skin) that the user chooses, so it is independent of the
                     25: language.
                     26: </p>
                     27: 
                     28: 
                     29: 
                     30: <h5 id="files">Files</h5>
                     31: <p>
                     32: For information about getting source files, see the
                     33: <a href="source.html">Source files</a> page.
                     34: The US English help content is in the directory calendarhelp/locale/en-US/calendarhelp.
                     35: This directory contains all the files that you need to translate.
                     36: </p>
                     37: 
                     38: <p>
                     39: Translate the contents of files with these extensions:
                     40: <table class="plain">
                     41: <tr><td><code>.xhtml</code></td><td>The text of the help.</td></tr>
                     42: <tr><td><code>.css</code></td><td>Reusable content</td></tr>
                     43: <tr><td><code>.png</code></td><td>Image (in the image directory)</td></tr>
                     44: <tr><td><code>.properties</code></td><td>Collating order</td></tr>
                     45: </table>
                     46: </p>
                     47: 
                     48: <p>
                     49: Do not change the names of the files&mdash;leave them in English.
                     50: </p>
                     51: 
                     52: 
                     53: 
                     54: <h5 id="xhtml">XHTML files</h5>
                     55: 
                     56: <p>
                     57: An xhtml file contains HTML wrapped in XML.
                     58: The HTML is normal HTML, but the tagging is strict.
                     59: </p>
                     60: 
                     61: <p>
                     62: To translate the file, translate the content of the tags.
                     63: Also translate the contents of any <code>alt</code> or
                     64: <code>title</code> attributes.
                     65: Do not change any other attributes.
                     66: </p>
                     67: 
                     68: <p>
                     69: For example, to translate:
                     70: <blockquote<pre>
                     71: &lt;h3 id="words"&gt;Words used in the application&lt;/h3&gt;
                     72: </pre></blockquote>
                     73: Translate only the text 'Words used in the application'.
                     74: Do not change <code>id="words"</code>&mdash;leave the id attribute in English.
                     75: </p>
                     76: 
                     77: 
                     78: 
                     79: <h5 id="css">CSS file</h5>
                     80: <p>
                     81: In the CSS file, help.css, translate the text inside doublequote characters.
                     82: Do not change anything else.
                     83: </p>
                     84: 
                     85: 
                     86: 
                     87: <h5 id="png">PNG files</h5>
                     88: <p>
                     89: Some PNG files contain translatable text, and others do not.
                     90: Look at each file and make a decision whether to translate it.
                     91: </p>
                     92: 
                     93: <p>
                     94: If you need to translate the file, try to get the base version with no text.
                     95: Copy the base version and add text in your language so it has the same meaning
                     96: as the US English version.
                     97: </p>
                     98: 
                     99: <p>
                    100: If there is no base version available, you might have to remove the text from
                    101: the English version or create a new image from scratch.
                    102: </p>
                    103: 
                    104: <p>
                    105: Save the translated images as 256-color PNG files.
                    106: Do not change the image size.
                    107: </p>
                    108: 
                    109: 
                    110: 
                    111: <h5 id="index">Properties</h5>
                    112: <p>
                    113: The file help.properties contains the collating sequence for your locale, so
                    114: that the index builder and the glossary builder sort entries in the correct
                    115: order.
                    116: In this file, specify the sequence of lowercase characters used for sorting.
                    117: </p>
                    118: 
1.2     ! whiteley  119: <hr>
1.1       whiteley  120: 

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