Standards/Translation Guide

From Shotbow Wiki
Jump to: navigation, search
This page contains changes which are not marked for translation.

On this page, we'll be going over how to set up pages for translation. The translation extension can be a bit difficult to understand but, if used correctly, it can prove to be useful.

It is important to note that this guide is aimed at both translators and editors. We hope both of these groups learn to deal with the features this extension offers and the knowledge/duties aren't kept exclusive to one side.

Note: Please do NOT prepare a page for translation through the automatic method (this feature) as it does whatever it wants and completely ignores templates. Also, do not mark any pages if they're not going to be translated. Keep a decent level of communication between editors and translators to ensure efficiency when dealing with translation.

Marking a page for translation

When marking a page for translation, if it's the first time, it can be quite simple. First place the <translate> tag at the top of the page and the </translate> tag at the bottom of the page. Saving the edit will show the option to mark the page for translation.

The next step would be to just translate the page but it isn't quite done yet. In order for the automatic page translation (shows up when clicking "Mark this page for translation") to work "properly" the steps below need to be taken.

Translation units

  1. The translation extension will add a unit (seen as <!--T:#--> in the source code) when there's a paragraph. This means each paragraph will have a unit. These units are what the translator is going to see when translating.
  2. To keep it clear for both the extension and editors, do NOT break lines when:
    1. Between bullet points (or, for example, anything that goes under the Loot Chests header). The extension will add units if they're in different paragraphs.
    2. Anything under a <gallery>.
  3. DO break lines when:
    1. Between headers and paragraphs.
    2. Between paragraphs/bullet points and categories.
    3. Between paragraphs and images.

What about templates? Encase the template with </translate> and <translate> so the extension ignores it entirely. This should be done with any of the minezloot or the geninfo/dungeoninfo templates. Do not use it on templates such as the warning template or even tables such as Legendary Items tables. They must be marked with a translation unit.

Translating a page

Don't think that there needs to be an explanation for this. It's pretty straightforward except for one small detail: Duplicate pages. Once a translation of any kind is created, a duplicate page of the source page is created (shown as Pagename/en). This duplicate should be reported to an Administrator and deleted to avoid cluttering the wiki with duplicates that can't even be edited.

To ensure it's deleted properly when deleting check the box that reads "Delete all subpages". This process isn't instant as a bot will be deleting all the translated units and it may fail sometimes, so patience is required.

Notes

Worth noting that a good amount of pages may have poorly implemented translation code. If the page doesn't currently have translations, it could be rearranged and cleaned up by using the guidelines presented here or start from scratch by deleting all the translation code.

For an example of how a page has to look with translation code, see here.