mozilla

Revision 443425 of Localization notes

  • Revision slug: Localization_notes
  • Revision title: Localization notes
  • Revision id: 443425
  • Created:
  • Creator: jwilde
  • Is current revision? No
  • Comment

Revision Content

Localizers usually work on the localizable files without the context of the source files including the localized strings; it is important to add comments to the localizable files themselves, too. These comments are generally referred to as localization notes. There is an established format for those, which is described in this document.

It's important this established format as closely as possible since there are a number of tools that parse these comments for easier access and use by localizers.

DTD files 
 
<!-- LOCALIZATION NOTE (entity name): comment -->
properties files 
 
# LOCALIZATION NOTE (key): comment

File-wide comments should use the same format, be at the top of the file (after the license header, though) and just drop the (entity name/key) reference.

{{ languages( { "ja": "ja/Localization_notes" } ) }}

Revision Source

<p>Localizers usually work on the localizable files without the context of the source files including the localized strings; it is important to add comments to the localizable files themselves, too. These comments are generally referred to as <em>localization notes</em>. There is an established format for those, which is described in this document.</p>
<p>It's important this established format as closely as possible since there are a number of tools that parse these comments for easier access and use by localizers.</p>
<dl>
  <dt>
    DTD files&nbsp;</dt>
  <dd>
    &nbsp;</dd>
</dl>
<pre class="eval">
&lt;!-- LOCALIZATION NOTE (entity name): comment --&gt;
</pre>
<dl>
  <dt>
    properties files&nbsp;</dt>
  <dd>
    &nbsp;</dd>
</dl>
<pre class="eval">
# LOCALIZATION NOTE (key): comment
</pre>
<p>File-wide comments should use the same format, be at the top of the file (after the license header, though) and just drop the <em>(entity name/key)</em> reference.</p>
<p>{{ languages( { "ja": "ja/Localization_notes" } ) }}</p>
Revert to this revision