View source for Template:Expand language/doc

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Documentation subpage}}
{{High-use}}
<noinclude>{{Interconnected template|[[Template:Expand language/howto|Expand language/howto]]|[[Template:Expand language/howto/newtopic|Expand language/howto/newtopic]]|and about 200 language expand templates}}</noinclude>
{{Template shortcut|expl}}
{{Twinkle standard installation}}

This template should not be placed directly on articles in the article namespace. Instead, use language-specific templates from [[:Category:Expand by language Wikipedia templates]] if only one language is linked. This ensures proper categorization and helps editors identify articles needing expansion from specific language Wikipedias.

This template has two purposes: it is primarily used in transclusion from other templates such as {{tl|Expand French}} or {{tl|Expand Spanish}} to mark English Wikipedia articles that can be improved by a translation from a foreign-language Wikipedia. Second, this template may be placed directly on article pages if an article can be improved by translations from multiple foreign-language Wikipedias. Generally, you should use one of the templates in [[:Category:Expand by language Wikipedia templates|this list]] whenever possible, rather than this template. If you're not sure if this is the right template to use, it probably isn't.

== Creation of a new sub template ==
The primary use of this template is to create a new wrapper template for a particular language. If you need to create {{tl|Expand Klingon}}, follow these steps. When transcluded, the sub template creates a "notice"-type {{tl|ambox}} with translation instructions in a hide/show box, and categorizes the page into one or more translation categories, depending on parameter values.

For a list of all sub templates, see [[:Category:Expand by language Wikipedia templates]].

You may start a new, {{tlc|Expand &lt;''Language-name''>}} template by following these steps:

# Create the page [[Template:Expand XXXX]] (where 'XXXX' is the language name):
#* {{edit|Template:Expand XXXX|2={{Clickable button|Create template|link=no}}|preload=Template:Expand language/template preload}} using preloaded model; alter 'XXXX' in browser url to actual language name before saving.
#* or, copy the [[Template:Expand language/template preload|sub template preload model]] and paste into the new sub template, [[Template:Expand XXXX]] 
# Edit the template, and adjust:
#* change dummy language code (<code>xx</code>) to ISO-639 code (French ⟶ <code>fr</code>, German ⟶ <code>de</code>, etc.{{efn|name=langcode values}})
#* adjust parameters (see below); in particular, the topic codes (per subcategories; see {{Section link||Required follow-up steps}}), and save the page.

=== Parameters available ===
These parameters can be used in the creation of a sub template. Language code ({{para|langcode}}) and language name ({{para|name}}) can be found at [[meta:Table of Wikimedia projects#Projects per language codes]].

* {{para|date}}{{snd}}pass-thru; set to <code><nowiki>{{{date|}}}</nowiki></code>
* {{para|fa}}{{snd}}used in category name generation. For featured articles, set {{para|fa|yes}}
* {{para|langcode}}{{snd}} 2- or 3-letter language code.{{efn|name=langcode values|For values of {{para|langcode}}, see column one from [[meta:Table of Wikimedia projects#Projects per language codes]].}} E.g., <code>fr</code>.
* {{para|name}}{{snd}}Full name of the language in English; col 2 in the [[meta:Table of Wikimedia projects#Projects per language codes|table]]. E.g., <code>French</code>
* {{para|no interwiki}}{{snd}}pass-thru; set to <code><nowiki>{{{no interwiki|}}}</nowiki></code>
* {{para|nodoc}}{{snd}}pass-thru; set to <code><nowiki>{{{nodoc|}}}</nowiki></code>
* {{para|otherarticle}}{{snd}}set to <code><nowiki>{{{1|}}}</nowiki></code>; blocks generation of tracking categories for missing args only needed in parent template.
* {{para|section}}{{snd}}pass-thru; set to <code><nowiki>{{{section|}}}</nowiki></code>
* {{para|topic}}used in category name generation; may be any string, but has conventional usage; see {{Section link||Topics}} below. 
* {{para|googlelangcode}}{{snd}}rarely used. See below.

Do not use {{para|langcode2}}, {{para|langcode3}}, {{para|otherarticle2}}, or {{para|otherarticle3}}.

==== Topics ====
Use of {{para|topic}} is a shorthand designed to make it easier for the user to categorize an article needing language expansion into the right subcategory. A user may use the simple invocation {{nowrap|{{tlx|Expand French|topic{{=}}gov}}}}, for example, resulting in categorization into "[[:Category:Government and politics articles needing translation from French Wikipedia]]", without having to remember details of the Category name, or what categories are available. Not all Expand language templates use {{para|topic}}, but those that do, choose the allowed topic values from the set ''bio'', ''cult'', ''geo'', ''gov'', ''hist'', ''mil'', ''sci'', ''sport'', ''struct'', ''tech'', and '' transport'', which imply one of a set of conventionally named subcategories.

If there are too many articles in a language category, new subcategories may be created to hold them, and if desired, a new topic code may be added to the template to handle it,{{efn|The association between a topic value and a category name occurs in the template code, in the ''#switch'' statement.  Adding a new topic involves changing the ''#switch'' statement to associate the new topic with the desired category name. This will also add one to the tally of [[WP:EXPENSIVE|expensive parser function calls]].}} even one not in the list of topic values above.{{efn|In this case, the new code will not appear in the table of topics and categories in the #Categorization section of the template doc page. To add it, you need to add a line to the <code>/topics</code> subpage to add a row to the topics table in the doc, for each new topic added that is not in the list. See for example, the use of {{para|topic|commune}} in {{tl|Expand French}}.}}

==== Uncommon override parameters ====
Param {{para|googlelangcode}} is only needed for cases where Google's language translation code is not the same as the Wikipedia language translation code. The only case currently, is for the Norwegian language variety [[Nynorsk]], and is used in [[Template:Expand Norwegian (Nynorsk)]]. Sample use:

<code><nowiki>| googlelangcode=no  <!--Not the English negative, but the langcode --></nowiki></code>

==== Required follow-up steps ====
After creating a new sub template, you need to create the [[WP:TDOC|Template doc page]], and the main tracking category for the language. If there are many hundreds or thousands of transclusions of the template, the tracking category may get very long and hard to browse; subcategories may be created for subtopics such as biographies, geography, and so on.  In the steps below, 'XXXX' represents the language name of the template you just created; so, 'XXXX' is ''French'' for [[Template:Expand French]]. 

# {{edit|Template:Expand XXXX/doc|2={{Clickable button|Create doc page|link=no}}|preload=Template:Expand language/docpage preload}} at [[Template:Expand XXXX/doc]]
#* OR: go to [[Template:Expand XXXX/doc]], and paste <code><nowiki>{{Expand language/howto|XXXX}}</nowiki></code>.
# {{edit|Category:Articles needing translation from XXXX Wikipedia|2={{Clickable button|Create category|link=no}}|preload=Template:Expand language/category preload}} at "Category:Articles needing translation from XXXX Wikipedia" (changing 'XXXX' to language name)
#* OR: go to [[:Category:Articles needing translation from XXXX Wikipedia]] and paste a copy of [[<noinclude>..</noinclude>/category preload]].

==== Optional follow-up ====
If subcategories are needed because there are too many articles for the main category, then:
* Create subcategories as needed, corresponding to one of the standard ''Topic codes''
*# Custom subcategories outside the standard ''Topic codes'' may be created if needed (see e.g., ''commune'' in {{tl|Expand French}})
*# If a subcategory is associated with a custom Topic code, then create the optional template subpage "/topics" and adjust row content as needed: {{edit|Template:Expand XXXX/topics|2={{Clickable button|Create topics page|link=no}}|preload=Template:Expand language/topics preload}}

=== Topics and categorization ===
Transclusion of a sub template categorizes the page into one or more categories based on the parameters. The language codes are converted to the full name of the language, thus ''fr'' becomes ''French'' in the category name string, ''de'' becomes ''German''; and so on. Topic codes are usually expanded. For example, when used as part of a Category name, topic code ''geo'' becomes ''Geography'', ''gov'' becomes ''Government and politics'', and so on. The exact list of available topic codes and their expansions depends on the individual sub templates.
* With a {{para|topic}} parameter: {{xt|Category:&lt;''topic''> articles needing translation from &lt;''language''>  Wikipedia}}
* Without {{para|topic}} : {{xt|Category:articles needing translation from &lt;''language''> Wikipedia}}
* For param {{para|fa}} : {{xt|Category:Featured articles needing translation from &lt;''language''> Wikipedia}}

Using the {{para|topic}} parameter categorizes the article in a subcategory associated with the topic value. Some Expand language templates have subcategories and associated topic values, and others don't. As an example, this table{{efn |name="expensive"|This section of the doc page uses fifteen [[WP:EXPENSIVE|expensive parser function calls]]; one for conditional inclusion of the {{para|fa}} and {{para|topic}} parameters, and ten for the rows in the topic table. Fifteen is a low number, and this is no cause for concern.}} shows the {{para|topic}} codes available for {{tl|Expand French}}, and links to the subcategory for each one:
<table class="wikitable" style="margin-left:4em">
<tr> <th>topic code</th> <th>topic name and category<br>for [[Template:Expand French|Expand French]]</th> <th>articles in<br/>category</th> </tr>
{{EL table row|French|bio}}
{{EL table row|French|cult}}
{{EL table row|French|geo}}
{{EL table row|French|gov}}
{{EL table row|French|hist}}
{{EL table row|French|mil}}
{{EL table row|French|sci}}
{{EL table row|French|sport}}
{{EL table row|French|struct}}
{{EL table row|French|tech}}
{{EL table row|French|transp}}
</table>

Not all languages have subcategories for every topic;  here's {{tl|Expand Catalan}} with three topics/subcategories:

<table class="wikitable" style="margin-left:4em">
<tr> <th>topic code</th> <th>topic name and category<br/>for [[Template:Expand Catalan|Expand Catalan]]</th> <th>articles in<br/>category</th> </tr>
{{EL table row|Catalan|bio}}
{{EL table row|Catalan|geo}}
{{EL table row|Catalan|gov}}
</table>

Most languages have fewer transclusions of the template, and don't need subcategories; for example, {{tl|Expand Hindi}}, {{tl|Expand Persian}}, or {{tl|Expand Turkish}}.

=== Examples ===
For a generic, copy-paste model that may be used for starting a new, sub template, see [[Template:Expand language/template preload]].  For some actual examples, see:
* {{tl|Expand German}}
* {{tl|Expand Catalan}}
* {{tl|Expand French}}
* {{tl|Expand Basque}}

== Direct transclusion on article pages ==
A secondary use of this template is to place it directly on an article page. This generally should be avoided when a specific language template (such as {{tl|Expand French}}) is available for use instead. But direct transclusion may be useful for an article that can be improved with translations from more than one foreign-language Wikipedia.

=== Usage ===
{{tlx|Expand language |langcode{{=}}{{var|xx}} |otherarticle{{=}}{{var|<Article-1 in lang-xx>}} |langcode2{{=}}{{var|yy}}|otherarticle2{{=}}{{var|<Article-2 in lang-yy>}} |langcode3{{=}}{{var|zz}} |otherarticle3{{=}}{{var|<Article-3 in lang-zz>}}}}

'''Tip:''' If there is only one language involved, then do not use this template.{{efn|name="which template"}}

=== Parameters ===
* {{para|langcode}}{{snd}} 2- or 3-letter language code of the first foreign Wikipedia article to link{{efn|name=langcode values}} E.g., <code>fr</code>. Required.
* {{para|langcode2}}{{snd}} code of the second foreign Wikipedia article.{{efn|name="which template"|If there is only one langcode and otherarticle name, then this template probably isn't the right one. Use [[:Category:Expand by language Wikipedia templates|one of the sub templates]] instead.}} E.g., <code>de</code>. Optional.)
* {{para|langcode3}}{{snd}} code of the third foreign Wikipedia article.{{efn|name=langcode values}} E.g., <code>es</code>. Optional.
* {{para|otherarticle}}{{snd}} name of the article in the original language, corresponding to the first langcode. Required.
* {{para|otherarticle2}}{{snd}} name of the article in the original language, corresponding to the second langcode. Optional.{{efn|name="which template"}} 
* {{para|otherarticle3}}{{snd}} name of the article in the original language, corresponding to the third langcode. Optional.
* {{para|section|yes}}{{snd}} optional; set to 'yes' when used in a section of the article instead of at the top. Optional.
* {{para|date}}{{snd}} optional; updated by bot if omitted.
* {{para|fa}}{{snd}} optional; whether the article is a feature article or not.

Do not use these parameters for direct transclusion:
* {{para|name}} (defaults to 'Expand language'; only needed for transcluding templates; could change css class membership if altered, which could affect rendered appearance of the box)
* {{para|topic}} (could interfere with categorization)

=== Example ===
If [[One Hundred Days Government]] can be expanded from its Spanish ([[:es:Gobierno de los Cien Días]]) and Russian ([[:ru:Стодневное правительство]]) articles:

{{tlx|Expand language |langcode{{=}}{{var|es}} |otherarticle{{=}}{{var|Gobierno de los Cien Días}} |langcode2{{=}}{{var|ru}}|otherarticle2{{=}}{{var|Стодневное правительство}} |date{{=}}{{var|<nowiki>{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}</nowiki>}}}}

==Expensive parser functions==
This template uses between 1 and 9 expensive parser functions depending on what parameters are used. On certain pages with very large numbers of other templates using expensive parser functions this may result in [[WP:TLIMIT|template limits]] being hit. 

==TemplateData==
<templatedata>
{
	"params": {
		"name": {},
		"subst": {},
		"langcode2": {},
		"section": {},
		"otherarticle": {},
		"langcode": {
			"required": true
		},
		"override_language": {},
		"langcode3": {},
		"otherarticle3": {},
		"otherarticle2": {},
		"date": {},
		"googlelangcode": {},
		"topic": {},
		"demospace": {},
		"nodoc": {},
		"category": {},
		"fa": {},
		"no interwiki": {}
	}
}
</templatedata>

== See also ==
* {{t|Being translated}}
* [[Wikipedia:Translation]]

== Notes ==
{{Notelist}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Expand by language Wikipedia templates| ]]

}}</includeonly>