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

From Vintage Story Wiki
(Updating to match new version of source page)
Tags: Mobile edit Mobile web edit
 
(Mark for deletion)
Tag: Replaced
 
Line 1: Line 1:
<languages/>
{{Delete|Outdated duplicate of [[Vintage Story Wiki:How to translate the wiki]].}}
 
== 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 ===
''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]]
 
# 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>.
# 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 ;-)
 
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 ===
 
[[File:Update-translation.PNG|thumb|500px|right]]
 
# Go to the page you want to translate and switch to the language you want to translate to
# If the page does not offer the option for that language yet, no translation has been started
# 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
# Click on "translated version" to continue working on the translation.
 
=== How to actually translate ===
 
# Click on the "translate" or "translated version" page after the page was marked for translation
# This will open up the translation page, with the original English text showing up on the left side of the screen
# 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
# 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.
# Clicking on a section to the left will open a text box below, in which the translation can be typed.
# 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:
* <code><nowiki>__TOC__</nowiki></code> - To create a Table Of Contents at the beginning of a page.
* <code><nowiki>{| class="wikitable sortable"</nowiki></code> - Or any other "wikitable" lines, used together with plenty of <code>|-</code> 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.
*<code><nowiki>[[File:MeatInFirepit.png|200px|thumb|right|text]]</nowiki></code> - 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!
* <code><nowiki>[[quern|text]]</nowiki></code> - 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.<br><br>
 
If in doubt, don't hesitate to ask in the discords wiki-and-translation channel for help!
 
 
== 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, '''make sure the Category tags are not included in the <code><nowiki><translate></nowiki></code> tags''', then 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.
 
== Using translation variables ==
 
''Note: our version of the Translate extension is outdated, so current MediaWiki documentation does not apply for this feature.''
 
Sometimes, you ''don't'' want to translate something in a page - maybe it is something like a number, a special link name, or some piece of code that should not be translated. In this case, you can use a translation variable in order to make sure translation of the page does not change it.
 
Translation variables are written like this: <code><nowiki>&lt;tvar&#124;name&gt;variable&lt;/&gt;</nowiki></code>
 
To translators, it will look like this:
 
: some text that isn't the variable ''$name'' some more text
 
When translating, simply paste in the ''$name'' part and it will appear in your translation exactly as it is in the original page.
 
=== Example ===
<code><nowiki>Hello! This is a sentence which includes a translation variable: &lt;tvar&#124;tvar-example&gt;&#128578;I'm a translation variable&lt;/&gt;. Look at it in different languages!</nowiki></code>
 
Hello! This is a sentence which includes a translation variable: &#128578;I'm a translation variable. Look at it in different languages!
 
 
[[Category:Wiki Editing]]

Latest revision as of 12:07, 29 January 2024

Delete.png

This Category talk is a candidate for deletion.
Reason: Outdated duplicate of Vintage Story Wiki:How to translate the wiki.
Before deletion, check what links to this page, the page history, and the page log.