Template:Translate/doc

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.  

Purge the base

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}}	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 tries to comply with the alternate languages guide.
{{{1}}}	For articles that may be mostly translated, but may have some incomplete sections.	{{Translate|Example text}}	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 tries to comply 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}}	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 tries to comply 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}}	This template needs translations. This template does not contain translations for the following 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 {{Autolang}} template where appropriate. Also, please make sure that the article tries to comply 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 he true or blank. Todo: Enable manual linking to a specified strings page	{{Translate|Example text|strings=true}}	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 {{Autolang}} template where appropriate. Also, please make sure that the article tries to comply 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}}	This page has not been fully translated. You can help by finishing the translation. Also, please make sure the article tries to comply with the alternate languages guide.
{{{type|inprogress}}}	For use when pages that are currently being translated or will be translated soon.	{{Translate|type=inprogress}}	This page is being translated. You can help by finishing the translation. Also, please make sure the article tries to comply with the alternate languages guide.
{{{type|machine}}}	For use when pages have been translated by a machine (e.g. Google Translate).	{{Translate|type=machine}}	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.
{{{type|update}}}	For use when the translated pages hasn't been updated for long time.	{{Translate|type=update}}	This translated page needs to be updated. You can help by updating the translation. Also, please make sure the article tries to comply with the alternate languages guide.