Template:TemplateBox

Template documentation

This documentation is transcluded from Template:TemplateBox/doc. (edit | history)

No description yet available.

Usage

{{TemplateBox
 |1                  =
 |1d                 =
 |1label             =
 |1aliases           =
 |1type              =
 |1set               =
 |1def               =
 |1av                =
 |1sv                =
 |1stat              =
 |useTemplateData    =
 |name               =
 |desc               =
 |namespace          =
 |usergroup          =
 |placement          =
 |usage-notes        =
 |type               =
 |example            =
 |example-value      =
 |i18n-method        =
 |i18n-desc          =
 |i18n-mediawiki-msg =
 |i18n-subpage       =
 |i18n-data-file     =
 |seealso            =
 |setscats           =
 |print              =
 |shorthand          =
 |relieson           =
 |mustbesubst        =
 |docsub-page        =
}}

Usage notes: For a copy-paste form with short parameter descriptions see section Usage – with short parameter descriptions

Template parameters

Parameter	Description		Default	Status
1			empty	optional
1d 1d-en 1description 1description-en			empty	optional
1d-td 1d-td-en 1description-td 1description-td-en			empty	optional
1label 1label-en 1label-td 1label-td-en			empty	optional
1aliases			empty	optional
1type			empty	optional
1set			empty	optional
1def 1def-td 1default			empty	optional
1av			not specified	optional
1sv			not specified	optional
1stat 1stat-td 1deprecated 1required	: required optional optional- deprecated		optional	optional
useTemplateData			empty	suggested
name			{{BASEPAGENAME}}	required
desc desc-en description description-en desc-td description-td			empty	required
namespace			empty	required
usergroup			empty	required
placement	: top bottom licence source		empty	optional
usage-notes			empty	optional
type			empty	optional
example			empty	optional
example-value			{{TEMPLATENAME|<example>}}	optional
i18n-method	: autotranslate switch - custommediawiki-msg mediawiki-msg ext.translate TNT		empty	optional
i18n-desc			empty	optional
i18n-mediawiki-msg			empty	optional
i18n-subpage			i18n	optional
i18n-data-file			I18n/{{{name}}}.tab	optional
seealso			empty	optional
setscats			empty	optional
print			empty	optional
lines			empty	deprecated
shorthand			empty	optional
relieson			empty	optional
mustbesubst			empty	optional
docsub-page			{{NAMESPACE}}:{{BASEPAGENAME}}	optional

Template data

Parameter text is empty The template provides a uniform way to provide basic information about the use of a template. See: [[Commons:Template documentation]] and [[Commons:TemplateData]]. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status name (param) 1 parameter name (similarly 2, 3, …). Note that if all of the parameters beginning with a number are removed from the template, the usage notes will state "The template takes no parameters." String optional aliases (param) 1aliases An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Name the aliases and separate them by "'''/'''"; e.g.'''d/desc/description'''. <small>''(→ see also on mediawiki: [[mw:Extension:TemplateData#Param object|overview]] or [[mw:Help:TemplateData#aliases|details]])''</small> String optional autovalue (param) 1av Dynamically-generated default value in wikitext, such as today's date or the editing user's name; this will often involve wikitext substitution, such as "subst:CURRENTYEAR". Default not specified String optional description (param) 1d 1d-en 1description 1description-en description of the parameter (similarly 2d, 3d, …) String optional TemplateData description (param) 1d-td 1d-td-en 1description-td 1description-td-en description of the parameter (similarly 2d-td, 3d-td, …) for the TemplateData extension which does not accept Wiki-markup. If this parameter is omitted, 1d is used. You can always override the defaults specifically for TemplateData by appending "-td" to the parameter-name. You can specify a language by appending your language-code. E.g. "3d-td-en" would be the English translation of the description of parameter 3 which will be used in TemplateData. String optional default (param) 1def 1def-td 1default Fixed default value for the parameter (similarly "2def", "3def", …) Unknown optional label (param) 1label 1label-en 1label-td 1label-td-en A (very) brief name for the parameter. Try to keep under 20-ish characters. "1label-de" would be the German translation of this label. String optional set (param) 1set Label and ID of a set in one. Multiple parameters can be grouped in a set, if either none or all of them must be supplied. Try to keep under 20-ish characters. <small>''(→ see also on mediawiki: [[mw:Extension:TemplateData#TemplateData object|overview]])''</small> String optional status (param) 1stat 1stat-td 1deprecated 1required <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-12">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong>: required <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-13">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> optional <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-14">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> optional- <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-15">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> deprecated <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-16">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> Suggested values required suggested optional optional- deprecated Default optional String optional suggested (param) 1sv Suggested values, separated by "/" Default not specified Unknown optional type (param) 1type The type of the parameter, for (soft) type hinting. Please refer to the [https://github.com/wikimedia/mediawiki-extensions-TemplateData/blob/master/Specification.md#34-type list of possible values]. <small>''(→ see also on mediawiki: [[mw:Extension:TemplateData#Param object|overview]] or [[mw:Help:TemplateData#type|details]])''</small> String optional description (template) desc desc-en description description-en desc-td description-td description of what the template does String required docsub-page docsub-page “page” parameter from {{Documentation subpage}} Default {{NAMESPACE}}:{{BASEPAGENAME}} Page name optional example example Example value for one single (unnamed) parameter; a possible value (e.g. for the [[Template:catseealso]]) can be: '''lakes'''. If there are more than one parameter you have to separate them with '''{{!}}'''; e.g '''1=lakes{{!}}for=for more informations'''.<br>There is also <code>example2</code> for a second example. String optional example-result example-value Example use of the template with the value of the <code>example</code> parameter; so according to the example above the value of <code>example-value</code> parameter will be '''{{catseealso|lakes}}'''; with two parameters it will be '''{{catseealso|lakes|for=for more informations}}'''. On the doc-page of the template it will render this code and show the result in a box with the title "renders as:" under the example code. If you keep <code>example-value</code> parameter empty, it will render {{catseealso|lakes}} by default.<br>There is also <code>example2-value</code> for a second example. Default {{TEMPLATENAME|&lt;example&gt;}} String optional I18n Data File i18n-data-file The tabular data file on Wikimedia Commons in the Data namespace. The “I18n/” prefix and the “.tab” file extension is added automatically if its missing. Default I18n/{{{name}}}.tab Auto value I18n/{{subst:ROOTPAGENAME}}.tab String optional translation info i18n-desc additional info about the localization String optional mediawiki-message i18n-mediawiki-msg When using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to: String optional translation method i18n-method <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-22">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong>: autotranslate <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-23">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> switch <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-24">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> - <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-25">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> custommediawiki-msg <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-26">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> mediawiki-msg <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-27">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> ext.translate <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-28">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> TNT <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-29">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> Suggested values - autotranslate ext.translate switch mediawiki-msg custommediawiki-msg TNT String optional translation subpage i18n-subpage When using “ext.translate” as method, optionally put the name of the sub-page here. A dot ('''.''') means that the current template hosts the translation on its subpages directly. Default i18n String optional lines ''Deprecated!'' Use parameter <code>print</code> instead. Unknown deprecated must be subst mustbesubst Set to '''yes''' (or any value) if the template must be substituted. This puts "subst:" into the template example under [[#Usage|Usage]]-section. String optional title (template) name name of the template <small>''(needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)''</small> Default <small>{{'''BASE'''PAGENAME}}</small> Page name required namespace namespace namespaces, the template is intended to be used in; possible values: all talks contents Main Talk User User talk Commons Commons talk File File talk MediaWiki MediaWiki talk Template Template talk Help Help talk Category Category talk Creator Creator talk Special Any other values will show as “unknown”. Default no namespace specified String required placement placement <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-17">Lua error in Module:LangSwitch at line 135: attempt to concatenate a nil value.</span></strong>: top <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-18">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> bottom <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-19">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> licence <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-20">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> source <strong class="error"><span class="scribunto-error" id="mw-scribunto-error-21">Lua error in Module LangSwitch at line 135: attempt to concatenate a nil value.</span></strong> Suggested values top bottom license source String optional print print The way the parameters are typically arranged in the [[#Usage|Usage]]-section; possible values: '''one''' - parameters arranged in one line (default): '''multi''' - parameters arranged in multiple lines: '''infobox''' - multiple lines, the equals signs are aligned with each other: Suggested values multi one infobox Default one (if type parameter ≠ '''infobox'''<sup>[[Template talk:TemplateBox#Parameter "print" - dependency with "type"-parameter not working|this dependency is not working, everytime "one" by default]]</sup>) String optional relies on relieson List of templates on which the template's basic functionality relies (each on a new code line; e.g. '''* [[Module:TemplateBox]]''') String optional see also seealso List of relevant links (each on a new code line; e.g. '''* [[Commons:TemplateData]]''') String optional categorizes into setscats List of categories which are automatically set by the template (each on a new code line; e.g. '''* [[:Category:Rivers]]''') String optional shorthand shorthand Shorthand(s) for easy use (redirects to main template), separated by comma, e.g. '''{{tl|catseealso}}, {{tl|csa}}''' for [[Template:Cat see also]]. On the doc-pages they will be listed in the [[#Usage|Usage]]-section directly beneath the code example (and above the <code>usage-notes</code> if given), see examples of lists of redirects [[Template:CatDiffuse/doc|here]] and with an additional searches-for-more-redirects [[Template:Cat see also/doc|here]]. String optional type (template) type what type is the template ('''infobox''', '''formatting''', '''licence tag''', …) String optional usage-notes usage-notes Notes about the correct usage of the template; will be listed in the [[#Usage|Usage]]-section beneath the code example and the shorthands, if given. String optional expose TemplateData useTemplateData Whether the template should expose TemplateData - Omitting means "false". Setting to “1”, “true”, or “yes” means "true". Setting to “only” will suppress the house-made table. Setting useTemplateData to “export” will turn TemplateBox into a preformatted Copy & Paste template. Suggested values 1 only Auto value only String suggested usergroup usergroup usergroup that is meant to use the template; possible values: all bot administrator admin sysop bureaucrat crat checkuser licensereviewer vrt autoconfirmed autopatrolled filemover oversight patroller rollbacker steward upwizcampeditors Suggested values all bot administrator admin sysop bureaucrat crat checkuser licensereviewer otrs autoconfirmed autopatrolled filemover oversight patroller rollbacker steward upwizcampeditors Default no user group specified String 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: all users

Placement:

Relies on:

• Module:TemplateBox
• Module:TNTTools
• Module:Languages
• {{Documentation subpage}}

⧼Seealso⧽

• Commons:Template documentation
• Commons:TemplateData
• Template:Documentation/preload10
• Template:Documentation/preload20
• Template:Documentation/preload30
• {{Documentation}}
• {{Doc-inline}}, {{doc-end}}

Localization

This template makes use of {{Autotranslate}} and the translate extension. The layout of the template can be found under Template:TemplateBox/layout.

Translate this template now!

 Administrate translations.

Usage – with short parameter descriptions

• Standard form for copy & paste with comments explaining shortly each parameter
• Additional comments and space for categories is included so it can work as a complete copy paste form for new doc pages.
• The parameter names are without language code:

<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{TemplateBox
 <!-- TEMPLATE PARAMETERS SECTION (for 2nd parameter copy paste & change "1" → "2") -->
 |1          = <!-- 1st parameter: name of the first parameter the template takes-->
  |1label    = <!-- 1st parameter: label, very brief name, preferably less than 20 characters -->
  |1d        = <!-- 1st parameter: description (+LANGUAGE CODE) -->
  |1d-td     = <!-- 1st parameter: description for TemplateData without any wiki markup (+LANGUAGE CODE) -->
  |1aliases  = <!-- 1st parameter: alternative names that may be used, separated by "/" -->
  |1type     = <!-- 1st parameter: type (values: number, string, line, boolean, date, url, wiki-page-name, unknown/…) -->
  |1set      = <!-- 1st parameter: set ID / Label (to group multiple parameters in a set) -->
  |1def      = <!-- 1st parameter: fixed default value (+LANGUAGE CODE) -->
  |1av       = <!-- 1st parameter: autovalue, dynamically-generated default value, e.g. current year -->  
  |1sv       = <!-- 1st parameter: suggested values to help users select the desired value, separated by "/" -->  
  |1stat     = <!-- 1st parameter: status (values: required, optional, optional- or deprecated) -->
 <!-- TEMPLATE SECTION -->
 |useTemplateData    = <!-- expose TemplateData (values: true, export; default: false) -->
 |name               = <!-- template title -->
 |desc               = <!-- template description (+LANGUAGE CODE) -->
 |namespace          = <!-- namespaces, the template is intended to be used (values: all, File, Category,…) -->
 |usergroup          = <!-- usergroup that is meant to use the template (values: all, admin,…) -->
 |placement          = <!-- placement on the page (values: top, bottom, licence or source) -->
 |usage-notes        = <!-- notes about the correct usage of the template -->
 |type               = <!-- template type (values: infobox, formatting, licence tag,…) -->
 |example            = <!-- example value for one (unnamed) parameter -->
 |example-value      = <!-- example use of the template with the value of the example parameter -->
 |i18n-method        = <!-- translation method (values: mediawiki-msg, ext.translate, autotranslate,…) -->
 |i18n-desc          = <!-- translation info -->
 |i18n-mediawiki-msg = <!-- name of the message when using “mediawiki-msg” as method -->
 |i18n-subpage       = <!-- translation subpage when using "ext.translate" as method -->
 |i18n-data-file     = <!-- tabular data file on Wikimedia Commons in the Data namespace -->
 |seealso            = <!-- relevant links (each of them on a new code line with * in the beginning) -->
 |setscats           = <!-- categories which are automatically set by the template -->
 |print              = <!-- template code layout in the Usage-section (values: one, multi, infobox) -->
 |shorthand          = <!-- redirects to the main template -->
 |relieson           = <!-- list of templates on which the template's basic functionality relies -->
 |mustbesubst        = <!-- set to yes (or any value) if the template must be substituted. -->
 |docsub-page        = <!-- page parameter from {{Documentation subpage}} -->
}}<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->

}}</includeonly>

About: TemplateData

{{Commons:TemplateData}}

( NOTE : the {{sed|1}} template links appears HERE : >>> )

edit