It is sometimes useful to give translation hints in the help. For example, elements can be marked up as not needing translations or comments can be left for translators to give them more context.

Use the namespace

The ITS namespace can be used on the whole page:

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      id="page">

</page>

…or just one element:

<page xmlns="http://projectmallard.org/1.0/"
      id="page">

  <p xmlns:its="http://www.w3.org/2005/11/its"></p>

</page>

Translatable/untranslatable elements

It makes sense to mark some elements as untranslatable, such as code, email addresses, URLs, and media that does not contain text. Elements that have been marked as untranslatable will not be shown to translators.

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      id="page">

  <info>
    <credit>
      <name>Rupert Monkey</name>
      <!-- This email address will not be shown to translators -->
      <email its:translate="no">rupert@example.com</email>
    </credit>
  </info>

  <!-- This image will not be shown to translators, but the title text is shown for translation -->
  <title>
    <media type="image" mime="image/png" its:translate="no" src="media/icon.png" />
    Application title 
  </title>

  <media type="image" mime="image/png" its:translate="no" src="media/icon.png">
    <span its:translate="yes">This media will not be shown to translators, but this text will be.</span>
  </media>

</page>

Comments

It is sometimes nice to give translators some context for the string. For example, if the string is taken from a different application or if something special needs to be done when it is translated.

<page xmlns="http://projectmallard.org/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      id="page">

  <p its:locNote="This is a comment for translators">locNote comments are shown to translators alongside the string.</p>

</page>

Hints

What must be marked as untranslatable?

• Email addresses
• Images that do not contain any text

What can be marked as untranslatable?

• Your name if you do not want it to be transliterated
• Code, if you give translators enough context

What must you not mark untranslatable?

Apart from the obvious…

• Other people's names
• Dates, years, numbers