www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/advanced_help/help/translation.html

   1 <p>To translate a help-file indexed by <strong>Advanced help</strong>,
   2 first create a directory
   3 <code>translations/help/<em>language</em></code> in the project's
   4 root directory. The <em>language</em>  is the language code that
   5 appears on the <em>Languages</em> page in the administrative UI.</p>
   6
   7 <p>Then, copy the <code>.ini</code> file and all
   8 the <code>.html</code> files from the help directory into this.  If
   9 you need to alter an image to use it in a translation, you may also
  10 put the altered image there.</p>
  11
  12 <p>In the topics section, the <code>.ini</code> file only needs to
  13 keep the topic names (unaltered) and titles (translated). If there is
  14 a <code>name</code> or <code>index name</code> setting in the
  15 'advanced help settings' portion, that should be retained. Any
  16 retained settings should be translated. The rest of the data in the
  17 <code>.ini</code> file may be discarded or ignored.</p>
  18
  19 <p>Each <code>.html</code> file should then be translated in place.</p>
  20
  21 <p>When translating a <code>.html</code> file, you will find that
  22 the <code>&amp;path&amp;</code> keyword (used for images and links)
  23 will lead to the original directory. If you must translate items that
  24 are linked, such as images containing text,
  25 use <code>&amp;trans_path&amp;</code> instead, which will lead to the
  26 translated directory. This will allow you to pick and choose which
  27 linked items, if any, will be translated.</p>
  28
  29 <p>If a topic is not translated, the default (untranslated) version
  30 will be shown instead.</p>
  31
  32 <h2>Translating Advanced help's help files</h2>
  33
  34 <p>If you want to help with the translation of
  35 <strong>Advanced help</strong> help texts for a particular language, look for an issue named named “Translation to XXX” (where
  36 “XXX” is the language you want to translate the help texts to) in the <a href="https://www.drupal.org/project/issues/advanced_help">issue queue for Advanced help</a>.
  37 If such an issue does not exist, please can create it.
  38 Choose <em>Category</em>   “Task”,
  39 <em>Status</em> “Needs review” and
  40 <em>Component</em>  “Documentation”.
  41 Upload translated files as an attachment (change the file type from <code>.html</code> to <code>.txt</code> to be allowed to upload). </p>
  42
  43 <p>Uploaded translations will be included in the next version if
  44 reviewed and approved by other users (i.e. gets to status “RTBC”).</p>