Vintage Story Wiki:How to translate the wiki/en: Difference between revisions
From Vintage Story Wiki
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
| Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
== Principles for translation == | |||
* Is the page going to get major changes in the future? If so, maybe finish writing it before you tag it for translation. | |||
* If the content inside the <code><nowiki><translate></nowiki></code><code><nowiki></translate></nowiki></code> doesn't need to be translated, ''don't put it inside the tags''. Better to have multiple sets of translation tags than one massive one that creates future problems. | |||
* "Maintenance" tags (categories, navboxes) should not be inside the translate tags. | |||
* Make use of our templates for translatable content: | |||
*: {{ll|Template:Page language link|2=Template:Page language link}} | |||
*: {{ll|Template:Localized link|2=Template:Localized link}} | |||
*: {{ll|Template:Translatable template|2=Template:Translatable template}} | |||
=== How to mark for translation === | === How to mark for translation === | ||
''PLEASE read the [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example official MediaWiki documentation] for this feature!'' | |||
[[File:Translate.PNG|thumb|500px|right|This is how it should look after translation & language tags were added]] | [[File:Translate.PNG|thumb|500px|right|This is how it should look after translation & language tags were added]] | ||
# Go to the page you want to translate and click edit | # Go to the page you want to translate and click edit. Make sure the page is complete, or close to being complete! | ||
# | # Add the language selector bar by typing in <code><nowiki><languages /></nowiki></code>. | ||
# 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" | # Enclose the text you want to translate using <code><nowiki><translate></nowiki></code><code><nowiki></translate></nowiki></code> tags. You can add as many sets of these tags as you want. Make sure navboxes and category tags are ''excluded''. | ||
# 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". | |||
# Go to the [[Special:Translate|translation center]] and start thunder typing ;-) | # Go to the [[Special:Translate|translation center]] and start thunder typing ;-) | ||
# | |||
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 === | === How to update translations === | ||
| Line 39: | Line 52: | ||
== How to translate templates == | |||
[[File:Template-translate.PNG|thumb|500px|right|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 <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. | |||
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. | |||
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.) | |||
== Translating categories == | |||
Categories can also be translated, and if done correctly will automatically put translated pages in their relevant language code subpage. | |||
=== Translating a Category page === | |||
You can tag a Category page for translation in the same way as any other page, by adding <code><nowiki><languages/></nowiki></code> for the language selector bar then adding a set of <code><nowiki><translate></nowiki></code><code><nowiki></translate></nowiki></code> tags. The translate tags must be present even if there is no content in the Category page. [https://wiki.vintagestory.at/index.php?title=Category%3AItems&type=revision&diff=43848&oldid=28218 See this diff] as an example of what to add to an empty Category page. | |||
=== Translation-aware category tags === | |||
On the article that should be included in the translatable category, change the Category tags so that they read: | |||
<code><nowiki>[[Category:CategoryName{{#translation:}}]]</nowiki></code> | |||
[[ | For example, <code><nowiki>[[Category:Metals]]</nowiki></code> should become <code><nowiki>[[Category:Metals{{#translation:}}]]</nowiki></code>. | ||
Then save and re-mark the page for translation to update the page across all languages. | |||
[[Category:Wiki Editing]] | [[Category:Wiki Editing]] | ||
