Vintage Story Wiki:How to translate the wiki: Difference between revisions

From Vintage Story Wiki
(Marked this version for translation)
(Updated info on how to translate templates.)
Line 12: Line 12:
# Go to the [[Special:Translate|translation center]] and start thunder typing ;-)
# Go to the [[Special:Translate|translation center]] and start thunder typing ;-)
# Once translated, edit the page again, and to the very top, add <code><languages<nowiki/>/></code> - this will make the language bar appear
# Once translated, edit the page again, and to the very top, add <code><languages<nowiki/>/></code> - this will make the language bar appear
For tackling specific formatting issues in wikitext and how they interact with the translate tags, see [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_administration#Markup_examples this guide on MediaWiki]. When translating a page that uses translatable templates, do not include them within the <code><nowiki><translate></nowiki></code> tags.


=== How to update translations === <!--T:4-->
=== How to update translations === <!--T:4-->
Line 50: Line 52:


<!--T:13-->
<!--T:13-->
[[File:Template-translate.PNG|thumb|500px|right]]
[[File:Template-translate.PNG|thumb|500px|right|Veerserif's note: now outdated due to the new tnt template.]]


<!--T:14-->
<!--T:14-->
# When marking templates like the [[Template:Navbox]] for translation, it is important to consider the placement of the language & translation tags, since the whole template will be nestled inside other pages!
Templates should only be tagged and mark for translation when they are ''complete''. Make sure the <code><nowiki><languages /></nowiki></code> tag is '''outside''' of the part of the template marked for transclusion, i.e. the <code><nowiki><onlyinclude> ... </onlyinclude></nowiki></code> or <code><nowiki><includeonly> ... </includeonly></nowiki></code> part.
# Make sure to mark templates like this in the following way, nestled into <code><noinclude<nowiki/>></code> tags:
 
## The beginning of the page should show: <code><noinclude<nowiki/>></code><code><languages/<nowiki/>></code><code><translate<nowiki/>></code><code></noinclude<nowiki/>></code>
When you use a translated or translatable (i.e. tagged and marked for translation) template on any page, you '''must''' use the [[Template:Translatable template|Translatable template]] template instead! For example, if you wanted to use the <code><nowiki>{{Metals navbox}}</nowiki></code> template on a page, instead write it as <code><nowiki>{{Translatable template|Metals navbox}}</nowiki></code>. You can also use <code><nowiki>{{tnt|Metals navbox}}</nowiki></code> as a shorter version.
## The end of the page should show: <code><noinclude<nowiki/>></code><code></translate<nowiki/>></code><code></noinclude<nowiki/>></code>
 
# This ensures that the translate and language tags themselves do not appear on the page in which the template is used.
When translating a page that uses translatable templates, do not include them within the <code><nowiki><translate></nowiki></code> tags. (I'm repeating this because it's important.)


</translate>
</translate>


[[Category:Wiki Editing]]
[[Category:Wiki Editing]]

Revision as of 16:49, 4 June 2022

How to mark for translation

This is how it should look after translation & language tags were added
  1. Go to the page you want to translate and click edit
  2. To the very top add <translate>, to the very bottom add </translate>
  3. Click save, then at the top of the page a small link will appear, titled "Mark this page for translation". Click on it, scroll to the bottom and hit the button "Mark this version for translation"
  4. Go to the translation center and start thunder typing ;-)
  5. Once translated, edit the page again, and to the very top, add <languages/> - this will make the language bar appear

For tackling specific formatting issues in wikitext and how they interact with the translate tags, see this guide on MediaWiki. When translating a page that uses translatable templates, do not include them within the <translate> tags.

How to update translations

Update-translation.PNG
  1. Go to the page you want to translate and switch to the language you want to translate to
  2. If the page does not offer the option for that language yet, no translation has been started
  3. If there was a translation attempt previously, the page will show the current progress of translation at the top, adding information if the translation is up to date or not
  4. Click on "translated version" to continue working on the translation.

How to actually translate

  1. Click on the "translate" or "translated version" page after the page was marked for translation
  2. This will open up the translation page, with the original English text showing up on the left side of the screen
  3. If necessary, you can choose into which language you wish to translate in the upper right corner of the screen using the "Translate to ..." drop down menu
  4. After being marked for translation, every page is automatically segmented into sections for translation. These can be translated and saved individually, meaning there is no need to do a whole page at a time.
  5. Clicking on a section to the left will open a text box below, in which the translation can be typed.
  6. Clicking on "Save Translation" will save the text, and it will then show up to the right as the current translated version

Important notes on what to translate and what not

Everything that looks like "code" probably doesn't need translation. This includes:

  • __TOC__ - To create a Table Of Contents at the beginning of a page.
  • {| class="wikitable sortable" - Or any other "wikitable" lines, used together with plenty of |- and other such symbols to build a nice looking table. Only the actual content text within the table needs translation - if in doubt, open the original page on the side to check the content of the table.
  • [[File:MeatInFirepit.png|200px|thumb|right|text]] - To include a picture into the page. Only the "text" part here needs translating, as it is the description that shows up under the picture - the rest should not be translated!
  • [[quern|text]] - To link to a different page in the wiki, while not directly using the linked-to page name. Only translate the "text" part, this will change the word in which the link is embedded, without changing the link destination itself.

If in doubt, don't hesitate to ask in the discords wiki-and-translation channel for help!


How to translate templates

Veerserif's note: now outdated due to the new tnt template.

Templates should only be tagged and mark for translation when they are complete. Make sure the <languages /> tag is outside of the part of the template marked for transclusion, i.e. the <onlyinclude> ... </onlyinclude> or <includeonly> ... </includeonly> part.

When you use a translated or translatable (i.e. tagged and marked for translation) template on any page, you must use the Translatable template template instead! For example, if you wanted to use the {{Metals navbox}} template on a page, instead write it as {{Translatable template|Metals navbox}}. You can also use {{tnt|Metals navbox}} as a shorter version.

When translating a page that uses translatable templates, do not include them within the <translate> tags. (I'm repeating this because it's important.)