Template:TemplateBox/doc

於Phabricator查看
編號T54966的工單
狀態：已解決

<translate> </translate>

The template provides a uniform way to provide basic information about the use of a template. See: Commons:Template documentation and Commons:TemplateData.

<translate> Usage</translate>

{{TemplateBox
 |desc               =
 |print              =
 |namespace          =
 |shorthand          =
 |usergroup          =
 |relieson           =
 |placement          =
 |usage-notes        =
 |1def               =
 |type               =
 |example            =
 |1stat              =
 |example-value      =
 |i18n-method        =
 |useTemplateData    =
 |i18n-desc          =
 |mustbesubst        =
 |setscats           =
 |1                  =
 |1d                 =
 |name               =
 |seealso            =
 |i18n-mediawiki-msg =
 |1d-td              =
 |1type              =
 |i18n-subpage       =
}}

模板参数

参数	描述		默认值	状态
desc desc-en description description-en desc-td description-td	description (template)	description of what the template does Template:TemplateBox/use suffix	empty	必需
print	print	The way the parameters are typically arranged (horizontally or vertically). Possible values: multi - parameters arranged in multiple lines; one - one line; infobox - multiple lines and space padding in front of the =.		可选
1set	set (param)	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.	empty	可选
namespace	namespace	namespaces, the template is intended to be used in; possible values: Any other values will show as “unknown”.		必需
shorthand	shorthand	shorthand for easy use (redirects to main template). See examples here and here of lists of redirects, and searches for more.	empty	可选
usergroup	usergroup	usergroup that is meant to use the template; possible values: Template:TemplateBox/doc/usergroup		必需
relieson	relies on	list of templates on which the template's basic functionality relies	empty	可选
placement	placement	placement on the page. Possible values: top bottom licence source	empty	可选
usage-notes	usage-notes	notes about the correct usage of the template	empty	可选
1def 1def-td 1default	default (param)	default value for the parameter (similarly 2def, 3def, …) Template:TemplateBox/use suffix	empty	可选
type	type (template)	what type is the template (infobox, formatting, licence tag, …)	empty	可选
example	example	Example use (works with a single unnamed parameter only). There is also example2 for a second example.	empty	可选
1aliases	aliases (param)	List of aliases. An alias is an alternative name for the parameter that may be used instead of (not in addition to) the primary name. Separate them by / (a slash)	empty	可选
1stat 1stat-td 1deprecated 1required	status (param)	status of the parameter (similarly 2stat, 3stat, …); possible values: required optional optional- optional and not present in the standard form deprecated	optional	可选
example-value	example-result	If there is more than one parameter you would like to show or if there are named parameters, use: Template:TemplateBox/doc/example-value	empty	可选
i18n-method	translation method	method the localization is achieved by. Known values: autotranslate using {{autotranslate}} or applying a similar method switch using {{LangSwitch}} in the template itself - no localization needed custommediawiki-msg using MediaWiki namespace messages mediawiki-msg using MediaWiki namespace messages, translated on translatewiki.net ext.translate using {{autotranslate}} or applying a similar method on a subpage that is marked for translation using the translate extension	empty	可选
useTemplateData	expose TemplateData	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.	empty	推荐
i18n-desc	translation info	additional info about the localization	empty	可选
mustbesubst	must be subst	Set to "yes" (or any value) if the template must be substituted. This puts "subst:" into the template example under "usage".	empty	可选
lines print	Use parameter print instead.		empty	可选
setscats	categorizes into	what categories are automatically set by the template (put in a linked list of them)	empty	可选
1	name (param)	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."	empty	可选
1d 1d-en 1description 1description-en	description (param)	description of the parameter (similarly 2d, 3d, …) Template:TemplateBox/use suffix	empty	可选
1label 1label-en 1label-td 1label-td-en	label (param)	A (very) brief name for the parameter. Try to keep under 20-ish characters. 1label-de would be the German translation of this label. Template:TemplateBox/use suffix	empty	可选
name	title (template)	name of the template (needed for viewing the documentation on another page than the template page, in particular for viewing the documentation page separately)	{{BASEPAGENAME}}	必需
seealso	see also	relevant links (put in a list of them)	empty	可选
i18n-mediawiki-msg	mediawiki-message	When using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to:	empty	可选
1d-td 1d-td-en 1description-td 1description-td-en	TemplateData description (param)	description of the parameter (similarly 2d-td, 3d-td, …) for Extension:TemplateData 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. Template:TemplateBox/use suffix	empty	可选
1type	type (param)	The type of the parameter, for (soft) type hinting. Please refer to the list of possible values.	empty	可选
i18n-subpage	translation-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.	i18n	可选

Template data
JSON内有语法错误。

<translate> Additional information</translate>

<translate> The template is intended to be used in the following namespaces:</translate> <translate> the Template namespace</translate>

<translate> The template is intended to be used by the following user groups:</translate> <translate> all users</translate>

<translate> Placement:</translate> <translate> </translate>

in the '/doc' subpage of a template

<translate> Relies on:</translate>

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

<translate> ⧼Seealso⧽</translate>

<translate> </translate>

• Commons:Template documentation
• Commons:TemplateData
• Template:Documentation/preload10
• Template:Documentation/preload20
• Template:Documentation/preload30

<translate> Localization</translate>

<translate> This template makes use of <tvar name="autotranslate">{{Autotranslate}}</tvar> and [[<tvar name="linktarget">:mw:Special:MyLanguage/Help:Extension:Translate</tvar>|the translate extension]].</translate> Template:Tmpl

[[[:Template:TranslateLink]] <translate> Translate this template now!</translate>]

<translate> Administrate translations.</translate>

About: TemplateData

{{Commons:TemplateData}}

Complications

( NOTE : the {{sed|1}} template links appears HERE : >>> ) Template:Sed A complication is that the template suppresses section editing links on the whole page of the documented template, and also on its documentation page, even for paragraphs outside the part produced by this template TemplateBox. Template:Sed can be used (as is done here) to create an edit link anyway.