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

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.
1.3       whiteley   34: The US English source files are in the directory
                     35: <code>calendarhelp/text/en-US </code>
                     36: Other files that you need to translate are in the directory
                     37: <code>calendarhelp/locale/en-US</code>
1.1       whiteley   38: </p>
                     39: 
                     40: <p>
                     41: Translate the contents of files with these extensions:
                     42: <table class="plain">
                     43: <tr><td><code>.xhtml</code></td><td>The text of the help.</td></tr>
                     44: <tr><td><code>.css</code></td><td>Reusable content</td></tr>
1.3       whiteley   45: <tr><td><code>.dtd</code></td><td>Reusable content</td></tr>
1.1       whiteley   46: <tr><td><code>.png</code></td><td>Image (in the image directory)</td></tr>
1.3       whiteley   47: <tr><td><code>.properties</code></td><td>Used by builder</td></tr>
1.1       whiteley   48: </table>
                     49: </p>
                     50: 
                     51: <p>
                     52: Do not change the names of the files&mdash;leave them in English.
                     53: </p>
                     54: 
                     55: 
                     56: 
                     57: <h5 id="xhtml">XHTML files</h5>
                     58: 
                     59: <p>
                     60: An xhtml file contains HTML wrapped in XML.
                     61: The HTML is normal HTML, but the tagging is strict.
                     62: </p>
                     63: 
                     64: <p>
                     65: To translate the file, translate the content of the tags.
                     66: Also translate the contents of any <code>alt</code> or
                     67: <code>title</code> attributes.
                     68: Do not change any other attributes.
                     69: </p>
                     70: 
                     71: <p>
                     72: For example, to translate:
                     73: <blockquote<pre>
                     74: &lt;h3 id="words"&gt;Words used in the application&lt;/h3&gt;
                     75: </pre></blockquote>
                     76: Translate only the text 'Words used in the application'.
                     77: Do not change <code>id="words"</code>&mdash;leave the id attribute in English.
                     78: </p>
                     79: 
1.3       whiteley   80: <p>
                     81: To test the file, view it in a browser.
1.4     ! whiteley   82: The style sheet <code>draft.css</code> together with the bindings <code>draft.xbl</code>
        !            83: provide a special style that reveals
1.3       whiteley   84: the <code>&lt;index&gt;</code> tags and entities.
                     85: You can modify <code>draft.css</code> if you prefer&mdash;it is not built
                     86: into the content pack.
                     87: </p>
                     88: 
1.1       whiteley   89: 
                     90: 
1.3       whiteley   91: <h5 id="css">CSS files</h5>
1.1       whiteley   92: <p>
1.3       whiteley   93: In the CSS files, translate the text inside doublequote characters.
1.1       whiteley   94: Do not change anything else.
                     95: </p>
                     96: 
                     97: 
                     98: 
                     99: <h5 id="png">PNG files</h5>
                    100: <p>
                    101: Some PNG files contain translatable text, and others do not.
                    102: Look at each file and make a decision whether to translate it.
                    103: </p>
                    104: 
                    105: <p>
                    106: If you need to translate the file, try to get the base version with no text.
                    107: Copy the base version and add text in your language so it has the same meaning
                    108: as the US English version.
                    109: </p>
                    110: 
                    111: <p>
                    112: If there is no base version available, you might have to remove the text from
                    113: the English version or create a new image from scratch.
                    114: </p>
                    115: 
                    116: <p>
                    117: Save the translated images as 256-color PNG files.
                    118: Do not change the image size.
                    119: </p>
                    120: 
                    121: 
                    122: 
                    123: <h5 id="index">Properties</h5>
                    124: <p>
1.3       whiteley  125: The properties files contains some strings and the collating sequence for your locale.
                    126: They are used by the builder.
                    127: In <code>help.properties</code>, specify the sequence of lowercase characters used for sorting.
1.1       whiteley  128: </p>
                    129: 
1.2       whiteley  130: <hr>
1.1       whiteley  131: 

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