Help:Translating

Help page
Revision as of 07:35, 7 June 2024 by FuzzyBot (talk | contribs) (Updating to match new version of source page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The Resonite wiki uses the Translate MediaWiki extension, for enabling translations and for content to be surfaced in different languages.

The extension has extensive documentation and video tutorials available.

For brevity, we'll also present some information here.

Translating

Before Translating

Ensure, that you've been marked as an "automoderated user". This will prevent translations going to the moderation queue. To do this follow the instructions on our contributing page. Then you're ready to start!

Preparing a page for translation

This information is based on mediawiki's tutorial.

  1. Ensure the page is at a reasonable level of stability
    • Pages that are under construction or change frequently should not be included until they are ready.
  2. Add <languages /> to the top of the page in the source editing view.
  3. Surround translatable elements in <translate></translate> tags.
    • See further guidance on this below
  4. Mark this page for translation

Best practices for translate tags

These are based on Mediawiki's Examples.

  • Do not wrap the whole page in <translate>
    • This is a problem we had in he past which lead to confusion sometimes.
  • Instead wrap select parts with the tags.
  • A good example is actually the source of previous linked mediawiki page.
  • Be careful around:
    • Tables
    • Images
    • Templates
    • Lists

Tables

Don't:


<translate>

{| class="wikitable"
|+ Food complements
|-
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}

</translate>

  • Wrapping a whole table in translate tags makes it hard to translate.

Do

{| class="wikitable"
|+<translate nowrap>Food complements</translate>
|-
|<translate nowrap>Orange</translate>
|<translate nowrap>Apple</translate>
|-
|<translate nowrap>Bread</translate>
|<translate nowrap>Pie</translate>
|-
|<translate nowrap>Butter</translate>
|<translate nowrap>Ice cream</translate>
|}
  • Wrapping each individual item in translate tags makes it easier to translate.

Images

Wrap only, the description/alt-text in <translate> e.g.


[[File:MediaWiki database schema latest.svg|thumb|link=https://www.mediawiki.org/w/index.php?title=Manual:Database_layout/diagram&action=render|<translate>Database schema of MediaWiki core</translate>]]

Example Pages

The following pages have examples of good uses of the <translate> tags:

Tutorials

We have a number of tutorials available for translating pages: