Last modified on 2 June 2014, at 18:48

Template:Autotranslate/doc

This template is used as a part of the larger mechanism to show a template content in the user's interface language. See Help:Autotranslate for help on the whole process. It applies only to subset of templates that use unnamed parameters ("1", "2", etc.). In most cases to use this template, you can use the following code snippet:

{{Autotranslate|1={{{1|}}}|2={{{2|}}}|3={{{3|}}}|4={{{4|}}}|5={{{5|}}}|6={{{6|}}}|7={{{7|}}}|8={{{8|}}}|9={{{9|}}}|base={{subst:PAGENAME}}}}

The template automatically sets the following categories: Category:Autotranslated templates

Usage

{{Autotranslate |1= |base= }}

Help for choosing the right template for your use case:

Criterion \\ Template {{Multilingual description}} {{en}}{{fr}}… {{LangSwitch}} {{Autotranslate}} {{TNT}}
Requires JavaScript enabled for folding + + - - -
Folding can be disabled by user + + - - -
Folding is done server-side - - + + +
Folding when at least x languages are provided 1 4 1 1 1
Collation order of languages (when not folded) Latin, Latin or Cyrillic, Cyrillic, Greek, Other simple LTR alphabets, Indic, Other South Asian, Syllabaries, Hangul, Japanese scripts, Sinograms, (RTL) Hebrew, (RTL) Arabic languages as provided by the user in the wikitext // // //
Search indexing issues - - + partially (where used; language subpages of templates are indexed) -
Recommended use at categories, galleries file description pages small templates, whenever the previous options are not suitable larger templates when used on pages that do not have language subpages (e.g. not having Main page/en, Main page/de) and where the language displayed will be automatically determined by the language set in user preferences larger templates when used on pages that do have language subpages; most of the time these will be pages prepared with the Translate Extension
Contains expensive parser functions - - - + +

Template parameters

Parameter Description Default Status
1 for each unnamed parameter to be passed add 1={{{1|}}}, etc. For example for template with 9 unnamed parameters you would use the snipped shown above. empty optional
base name of the template, where it is being added, like "Template:Information". Usually can use base={{subst:PAGENAME}}. empty required

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: no user group specified

Placement: At the top of the page

Relies on:
module:fallback and module:fallbacklist

See also

  • {{Fallback}} for template i18n mechanism for templates that use un-named parameters
  • {{LangSwitch}} for all-translations-on-one-page template i18n mechanism template

Localization

This template is not intended to be localized.

How to convert a template

Before you apply this template, first you have to prepare the template.

Pick a template

—See for example Template:Cc-by-1.0 before changes.
First you have to pick a template to autotranslate.
In this documentation, we will name our "selected template" as: Template:Template name

Create a layout template

—See for example Template:Apache/layout.
You must create a layout template, named Template:Template name/layout, 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.
This template should not add any categories when transcluded.

Convert existing language versions

—See for example Template:Apache/en.
All versions must be subpages of Template:Template name, and his name must use the appropriate prefix, as used on Wikipedia when adding a new language –ISO 639 language code–. For example, Spanish subpage must be named Template:Template name/es
Usually the English language link to the main template –Template:Template name–. That is incorrect, point it to the Template:Template name/en subpage.

Each language version of the template should be checked and converted to use the layout template –Template:Template name/layout–. 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 {{translated tag|cleanup}} or {{documentation}}, must be inside a <noinclude> tag.

Here is the syntax you must use for Template:Template name/<prefix>.

{{Template name/layout
|text=<translated text of the template>
|lang=<prefix>
}}<noinclude>
{{translated tag|license}}
</noinclude>

Create a documentation page

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

Convert the main template

—See for example Template:Apache.
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 –Template:Template name–.

{{Autotranslate|1={{{1|}}}|2={{{2|}}}|3={{{3|}}}|base=template name}}