Template:Translate/doc: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Doc/subpage}}
<!-- Please place categories where indicated at the bottom of this page.) -->
<!-- Please place categories where indicated at the bottom of this page.) -->
== Usage ==
== Usage ==
{{todo|document all the type shortcuts}}
This template is used on pages that need its content to be translated.
This template is used on pages that need its content to be translated.


==Parameters==
==Parameters==                                   <!-- requested to merge: Finish Translation, Translating, Machine Translation; since june 8 2023 ; -->
{| class="standard-table plainlinks"
{| class="standard-table plainlinks"
! Parameters
! Parameters
Line 12: Line 13:
|-
|-
| No Parameters
| No Parameters
| For use when entire pages need to he translated
| For use when entire pages need to be translated
| {{Code|<nowiki>{{Translate}}</nowiki>}}
| {{Code|<nowiki>{{Translate}}</nowiki>}}
| {{translate}}
| {{translate|nocat=1|namespaceoverride=Article}}
|-  
|-  
| {{param|1}}
| {{param|1}}
| For articles that may be mostly translated, but may have some incomplete sections
| For articles that may be mostly translated, but may have some incomplete sections.
| {{Code|<nowiki>{{Translate|Example text}}</nowiki>}}
| {{Code|<nowiki>{{Translate|Example text}}</nowiki>}}
| {{translate|example text}}
| {{translate|Example text|nocat=1|namespaceoverride=Article}}
|-
|-
| {{param|type}}
| {{param|namespaceoverride}}
| For use on template pages. Can only be {{Code|template}} or blank
| Overrides the <nowiki>{{NAMESPACE}}</nowiki> magic word. Can only be {{Code|Template}} or blank
| {{Code|<nowiki>{{Translate|Example text|type=template}}</nowiki>}}
| {{Code|<nowiki>{{Translate|Example text|namespaceoverride=Article}}</nowiki>}}
| {{translate|Example text|type=template}}
| {{translate|Example text|namespaceoverride=Article|nocat=1}}
|-
|-
| {{param|langs}}
| {{param|lang <1-5>}}
| For use with {{code|<nowiki>type=translate</nowiki>}}. Specifies which languages are needed.
| For use on template pages. Specifies which languages are needed.
| {{Code|<nowiki>{{Translate|Example text|type=template|langs=Chinese(zh), Spanish(es), Russian(ru)}}</nowiki>}}
| {{Code|<nowiki>{{Translate|Example text|lang 1=zh|lang 2=de|lang 3=ru}}</nowiki>}}
| {{translate|Example text|type=template|langs=Chinese(zh), Spanish(es), Russian(ru)}}
| {{translate|Example text|lang 1=zh|lang 2=de|lang 3=ru|nocat=1}}
|-
|-
| {{param|nocat}}
| {{param|strings}}
| For use on template pages. Adds some text that links to the template's /strings subpage. Should either be {{code|true}} or blank.<br>If set to true you can specify a link using {{param|link}} parameter.
| {{Code|<nowiki>{{Translate|Example text|strings=true}}</nowiki>}}
| {{Translate|Example text|strings=true|nocat=1}}
|-
|height="50px" | {{param|nocat}}
| Prevents page from being added to the [[:Category:To be translated|Category:To be translated]] category.
| Prevents page from being added to the [[:Category:To be translated|Category:To be translated]] category.
|colspan="2" style=text-align:center;|{{code|<nowiki>{{Translate|nocat=1}}</nowiki>}}
|colspan="2" style=text-align:center;|{{code|<nowiki>{{Translate|nocat=1}}</nowiki>}}
|-
|{{param|type|finish}}
|For use when pages have been translated but not fully.
|{{Code|<nowiki>{{Translate|type=finish}}</nowiki>}}
|{{translate|type=finish|nocat=1}}
|-
|{{param|type|inprogress}}
|For use when pages that are currently being translated or will be translated soon.
|{{Code|<nowiki>{{Translate|type=inprogress}}</nowiki>}}
|{{translate|type=inprogress|nocat=1}}
|-
|{{param|type|machine}}
|For use when pages have been translated by a machine (e.g. Google Translate).
|{{Code|<nowiki>{{Translate|type=machine}}</nowiki>}}
|{{Translate|type=machine|nocat=1}}
|-
|{{param|type|update}}
|For use when the translated pages hasn't been updated for long time.
|{{Code|<nowiki>{{Translate|type=update}}</nowiki>}}
|{{Translate|type=update|nocat=1}}
|}
|}
<includeonly>{{sandbox other||
<includeonly>{{sandbox other||

Latest revision as of 07:11, 22 August 2024

Edit-copy.png
This is a documentation subpage for Template:Translate.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Usage

Todo: document all the type shortcuts

This template is used on pages that need its content to be translated.

Parameters

Parameters Description Example Result
No Parameters For use when entire pages need to be translated {{Translate}}
Info content.png
This page needs to be translated.
This page either contains information that is only partially or incorrectly translated, or there isn't a translation yet.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
Also, please make sure the article complies with the alternate languages guide.
{{{1}}} For articles that may be mostly translated, but may have some incomplete sections. {{Translate|Example text}}
Info content.png
This page needs to be translated.
This page either contains information that is only partially or incorrectly translated, or there isn't a translation yet.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
Also, please make sure the article complies with the alternate languages guide.
The following content or section specifically needs to be translated:
Example text
{{{namespaceoverride}}} Overrides the {{NAMESPACE}} magic word. Can only be Template or blank {{Translate|Example text|namespaceoverride=Article}}
Info content.png
This page needs to be translated.
This page either contains information that is only partially or incorrectly translated, or there isn't a translation yet.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
Also, please make sure the article complies with the alternate languages guide.
The following content or section specifically needs to be translated:
Example text
{{{lang <1-5>}}} For use on template pages. Specifies which languages are needed. {{Translate|Example text|lang 1=zh|lang 2=de|lang 3=ru}}
Info content.png
This template needs translations.
This template does not contain translations for the following languages: 中文 (zh), Deutsch (de), Русский (ru)
If you are fluent in one of these languages, please help out by translating the text inside this template. This can be done by using the {{language}} template where appropriate.
Also, please make sure the article complies with the alternate languages guide.
The following content or section specifically needs to be translated:
Example text
{{{strings}}} For use on template pages. Adds some text that links to the template's /strings subpage. Should either be true or blank.
If set to true you can specify a link using {{{link}}} parameter. 		{{Translate|Example text|strings=true}}
Info content.png
This template needs translations.
This template does not contain translations for the most popular languages.
If you are fluent in one of these languages, please help out by translating the text inside this template. This can be done by using the template's /strings subpage or the {{language}} template where appropriate.
Also, please make sure the article complies with the alternate languages guide.
The following content or section specifically needs to be translated:
Example text
{{{nocat}}} Prevents page from being added to the Category:To be translated category. {{Translate|nocat=1}}
{{{type|finish}}} For use when pages have been translated but not fully. {{Translate|type=finish}}
Info content.png
This page has not been fully translated.
You can help by finishing the translation.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
Also, please make sure the article complies with the alternate languages guide.
{{{type|inprogress}}} For use when pages that are currently being translated or will be translated soon. {{Translate|type=inprogress}}
Info content.png
This page is being translated.
You can help by finishing the translation.
If this page cannot be translated for some reason, or is left untranslated for an extended period of time after this notice is posted, the page should be requested to be deleted.
Also, please make sure the article complies with the alternate languages guide.
{{{type|machine}}} For use when pages have been translated by a machine (e.g. Google Translate). {{Translate|type=machine}}
Info content.png
This page is Machine translated
It is not recommended to use machine translation without any corrections.
If the article is not corrected in the long term, it will be removed.
Also, please make sure the article complies with the alternate languages guide.
{{{type|update}}} For use when the translated pages hasn't been updated for long time. {{Translate|type=update}}
Info content.png
This translated page needs to be updated.
You can help by updating the translation.
Also, please make sure the article complies with the alternate languages guide.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:Translate/doc&oldid=447520"