View source for Template:Autotranslate/doc

{{Shared Template Warning|Template:Autotranslate|origin=Commons}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Autotranslate}}
{{TemplateBox
| 2 = ...
| 2d-en = Any additional parameter passed to {{tl|Autotranslate}} will be passed to {{tl|Autotranslate}}'s subtemplates. Parameter names are case independent and the subtemplates '''will only ''see lower case'' names'''.
| 2d-td-en = <nowiki>Any additional parameter passed to {{Autotranslate}} will be passed to {{Autotranslate}}'s subtemplates. Parameter names are case independent and the subtemplates **will only *see lower case* names**.</nowiki>
| 2stat = optional-

| 1 = base
| 1label-en = Translations Page
| 1d-en = Name of the template's translations page, like "Template:Information". Usually can use <code><nowiki>base={{subst:PAGENAME}}</nowiki></code>.
| 1d-td-en = Name of the template's translations page, like "Template:Information", or "Template:Information/i18n".
| 1type = wiki-template-name
| 1av   = {{((}}subst:PAGENAME{{))}}/i18n
| 1stat = required

| 3 = lang
| 3label-en = Language
| 3d-en = display language
| 3type = string
| 3def  = <code>{{Magic word|int|lang}}</code>
| 3def-td = <nowiki>{{int:lang}}</nowiki>
| 3stat = optional-

| name = Autotranslate
| desc-en = This template is used as a part of the larger mechanism to show a template content in the user's interface language. It allows you to set up set of language subtemplates and call proper subtemplate based on users chosen language. All parameters passed to Autotranslate will be passed to the subtemplates. See [[Help:Autotranslate]] for help on the whole process. In most cases to use this template, you can use the following code snippet:
<pre style="overflow:auto">
{{#invoke:Autotranslate|autotranslate|base={{subst:PAGENAME}}/i18n}}
</pre>

| desc-td-en = This template is used as a part of the larger mechanism to show a template content in the user's interface language. It allows you to set up set of language subtemplates and call proper subtemplate based on users chosen language. All parameters passed to Autotranslate will be passed to the subtemplates. See “Help:Autotranslate” for help on the whole process.

| namespace = template
| usergroup = all
| placement = top

| i18n-method = -
| i18n-desc = Used by {{C|templates using Autotranslate for internationalisation}} and {{C|templates using the Translate extension for internationalisation}}.

| seealso = 
* {{tl|LangSwitch}} for all-translations-on-one-page template i18n mechanism template.
* {{tl|Multilingual link}} chooses link to Wikipedia article in the user interface language.

| setscats = [[:Category:Autotranslated templates]]
| relieson = [[Module:Autotranslate]]

| print = multi
| useTemplateData = 1
}}

== How to convert a template ==
Before you apply this template, first you have to prepare the template.

=== Pick a template ===
&mdash;See for example [http://commons.wikimedia.org/w/index.php?title=Template:Cc-by-1.0&oldid=12667239 Template:Cc-by-1.0 before changes].<br />
First you have to pick a template to autotranslate.<br />
''In this documentation, we will name our "selected template" as:'' <code>Template:<var>Template name</var></code>
*See [[Commons:Template i18n]] for a list of templates needing translation or translated.

=== Create a layout template ===
&mdash;See for example [[Template:Apache/layout]].<br />
You must create a layout template, named <code>Template:<var>Template name</var>/layout</code>, to contain the layout of all language versions of the template. The easiest way to do this is to copy a layout template of a similar template.<br />
This template should not add any categories when transcluded.

=== Convert existing language versions ===
&mdash;See for example [[Template:Apache/en]].<br />
All versions must be subpages of <code>Template:<var>Template name</var></code>, and this name must use the appropriate prefix, [[m:List_of_Wikipedias|as used on Wikipedia]] when adding a new language &ndash;ISO 639 language code&ndash;.
:For example, the Spanish subpage must be named <code>Template:<var>Template name</var>/es</code>
Usually the English-language template links to the main template &ndash;<code>Template:<var>Template name</var></code>&ndash;. This is incorrect, point it instead to the <code>Template:<var>Template name</var>/en</code> subpage.

Each language version of the template should be checked and converted to use the layout template &ndash;<code>Template:<var>Template name</var>/layout</code>&ndash;.<br />Start with the English language version and compare it to the current template.

Note that everything that is not supposed to be included together with the template, like <code><nowiki>{{translated tag|cleanup}}</nowiki></code> or <code><nowiki>{{documentation}}</nowiki></code>, must be inside a <code>&lt;noinclude&gt;</code> tag.

Here is the syntax you must use for <code>Template:<var>Template name</var>/&lt;<var>prefix</var>&gt;</code>.
 <nowiki>{{</nowiki><code><var>Template name</var>/layout</code>
 |text=&lt;''translated text of the template''&gt;
 |lang=&lt;''prefix''&gt;
 <nowiki>}}&lt;noinclude>
{{translated tag|license}}
&lt;/noinclude></nowiki>

=== Create a documentation page ===
&mdash;See for example [[Template:Apache/doc]].<br />
Create a documentation page at <code>Template:<var>Template name</var>/doc</code>. This documentation page should include some code for creating language versions of the template. {{tl|TemplateBox}} has a <code>|il8n=autotranslate</code> option which provides a standard explanation of how to localise an autotranslated template.

=== Convert the main template ===
&mdash;See for example [[Template:Apache]].<br />
The last step is to enable the template. Be sure to check everything before you enable the template. You can cause a really big mess!
To enable the template, put this code in the template &ndash;<code>Template:<var>Template name</var></code>&ndash;.
 <nowiki>{{#invoke:Autotranslate|autotranslate|</nowiki>base=<var>template name</var>}}

==See also==
{{#invoke:Autotranslate|autotranslate|base=I18n templates}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Internationalization templates]]
[[Category:Autotranslated templates| *]]
[[Category:Lua-based templates]]
}}</includeonly>