සැකිල්ල:TemplateBox/උපදෙස්

මෙම සැකිල්ල ලුවා භාවිතා කරයි:

This template uses TemplateStyles:

Template:TemplateBox/styles.css

මෙය "" සඳහා උපදෙස් උප පිටුවක් වේ (සැකිල්ල සඳහා එම පිටුව වෙතට යොමු වන්න).
මෙහි ඇත්තේ භාවිත තොරතුරු, ප්‍රවර්ග, සහ මූලික සැකිල්ල පිටුවට අදාළ නොවන වෙනත් අන්තර්ගතය වේ.

මෙම සැකිල්ල ලුවා භාවිතා කරයි:

This template uses TemplateStyles:

Template:TemplateBox/styles.css

No description yet available.

Usage

{{TemplateBox
|1                  =
|1d                 =
|1label             =
|1aliases           =
|1type              =
|1set               =
|1def               =
|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
`1stat` `1stat-td` `1deprecated` `1required`	status of the parameter (similarly `2stat`, `3stat`, …); possible values: required optional optional- optional and not present in the standard form deprecated		optional	optional
`useTemplateData`			empty	suggested
`name`			{{BASEPAGENAME}}	required
`desc` `desc-en` `description` `description-en` `desc-td` `description-td`			empty	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”.	LangSwitch Error: no default	required
`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	LangSwitch Error: no default	required
`placement`	placement	placement on the page; possible values: top bottom licence source	empty	optional
`usage-notes`	usage-notes	Notes about the correct usage of the template; will be listed in the Usage-section beneath the code example and the shorthands, if given.	empty	optional
`type`	type (template)	what type is the template (infobox, formatting, licence tag, …)	empty	optional
`example`			empty	optional
`example-value`			{{TEMPLATENAME\|<example>}}	optional
`i18n-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 TNT Using Module:TNT and a tabular translations file on Wikimedia Commons.		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`			LangSwitch Error: no default	optional
`lines`			empty	optional
`shorthand`			empty	optional
`relieson`			empty	optional
`mustbesubst`			empty	optional
`docsub-page`			{{NAMESPACE}}:{{BASEPAGENAME}}	optional

Template data

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
	Description	Type	Status
`1`		String	optional
`1aliases`		String	optional
`1d` `1d-en` `1description` `1description-en`		String	optional
`1d-td` `1d-td-en` `1description-td` `1description-td-en`		String	optional
`1def` `1def-td` `1default`		Unknown	optional
`1label` `1label-en` `1label-td` `1label-td-en`		String	optional
`1set`		String	optional
`1stat` `1stat-td` `1deprecated` `1required`	status of the parameter (similarly <code>2stat</code>, <code>3stat</code>, …); possible values: required optional optional- optional and not present in the standard form deprecated Suggested values `required` `suggested` `optional` `optional-` `deprecated` Default optional	String	optional
`1type`		String	optional
`desc` `desc-en` `description` `description-en` `desc-td` `description-td`		String	required
`docsub-page`	Default {{NAMESPACE}}:{{BASEPAGENAME}}	Page name	optional
`example`		String	optional
`example-value`	Default {{TEMPLATENAME\|<example>}}	String	optional
`i18n-data-file`	Default I18n/{{{name}}}.tab Auto value `I18n/{{subst:ROOTPAGENAME}}.tab`	String	optional
`i18n-desc`		String	optional
`i18n-mediawiki-msg`		String	optional
`i18n-method`	method the localization is achieved by. Known values: autotranslate using {{[[:Template:autotranslate\|autotranslate]]}} or applying a similar method switch using {{[[:Template:LangSwitch\|LangSwitch]]}} in the template itself - no localization needed custommediawiki-msg using MediaWiki namespace messages mediawiki-msg using MediaWiki namespace messages, translated on [[translatewiki:\|translatewiki.net]] ext.translate using {{[[:Template:autotranslate\|autotranslate]]}} or applying a similar method on a subpage that is marked for translation using the translate extension TNT Using [[Module:TNT]] and a tabular translations file on Wikimedia Commons. Suggested values `-` `autotranslate` `ext.translate` `switch` `mediawiki-msg` `custommediawiki-msg` `TNT`	String	optional
`i18n-subpage`	Default i18n	String	optional
`lines`		Unknown	optional
`mustbesubst`		String	optional
`name`	Default <small>{{'''BASE'''PAGENAME}}</small>	Page name	required
`namespace`	Default no namespace specified	String	required
`placement`	placement on the page; possible values: top bottom licence source Suggested values `top` `bottom` `license` `source`	String	optional
`print`	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
`relieson`		String	optional
`seealso`		String	optional
`setscats`		String	optional
`shorthand`		String	optional
`type`		String	optional
`usage-notes`		String	optional
`useTemplateData`	Suggested values `1` `only` `TNT` `TNT:{{subst:BASEPAGENAME}}` Auto value `only`	String	suggested
`usergroup`	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:

in the '/doc' subpage of a template

Relies on:

⧼Seealso⧽

Localization

Boarisch ∙ català ∙ Bahasa Indonesia ∙ Deutsch (Sie-Form) ∙ dansk ∙ čeština ∙ Canadian English ∙ Deutsch ∙ Bahasa Melayu ∙ sicilianu ∙ italiano ∙ русский ∙ eesti ∙ беларуская (тарашкевіца) ∙ Tiếng Việt ∙ português ∙ euskara ∙ English ∙ magyar ∙ Zazaki ∙ Nederlands ∙ português do Brasil ∙ Türkçe ∙ slovenščina ∙ polski ∙ latviešu ∙ galego ∙ slovenčina ∙ македонски ∙ norsk bokmål ∙ Lëtzebuergesch ∙ español ∙ svenska ∙ hrvatski ∙ français ∙ suomi ∙ Plattdüütsch ∙ occitan ∙ norsk nynorsk ∙ српски / srpski ∙ українська ∙ मराठी ∙ বাংলা ∙ ਪੰਜਾਬੀ ∙ മലയാളം ∙ ไทย ∙ 한국어 ∙ 日本語 ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ العربية ∙ فارسی ∙ +/−

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

Usage – with short parameter descriptions

Standard form for copy & paste with comments explaining shortly each parameter
The parameter names are without language code:

{{TemplateBox
 <!-- TEMPLATE PARAMETERS SECTION (for 2nd parameter copy paste & change "1" → "2") -->
 |1          = <!-- parameter name -->
  |1d        = <!-- parameter description (+LANGUAGE CODE) -->
  |1d-td     = <!-- parameter description for TemplateData (+LANGUAGE CODE) -->
  |1label    = <!-- parameter label, very brief, preferably less than 20 characters -->
  |1aliases  = <!-- parameter alternative names that may be used, separated by "/" -->
  |1type     = <!-- parameter type (values: string, number,…) -->
  |1set      = <!-- parameter set ID / Label (to group multiple parameters in a set) -->
  |1def      = <!-- parameter default value (+LANGUAGE CODE) -->
  |1stat     = <!-- 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}} -->
}}

Standard form for copy & paste with very short comments explaining very shortly each parameter (for example if editing on mobile devices)
For the parameter names the language code is preset to English (-en):

{{TemplateBox
 <!--TEMPLATE PARAMETERS SECTION (for 2.param copy paste & "1"→"2")-->
 |1           = <!--param name-->
  |1d-en      = <!--param en-description (English)-->
  |1d-td-en   = <!--param en-description for TemplateData-->
  |1label     = <!--param label, preferably <20 characters-->
  |1aliases   = <!--param alternative names, separated by "/"-->
  |1type      = <!--param type (string/number/…)-->
  |1set       = <!--param set ID/Label for grouping parameters-->
  |1def-en    = <!--param default value (in English)-->
  |1stat      = <!--param status (required/optional/…)-->
 <!--TEMPLATE SECTION-->
 |useTemplateData    = <!--expose TemplateData (false/true/export)-->
 |name               = <!--template title-->
 |desc-en            = <!--template en-description (English)-->
 |namespace          = <!--template's namespaces (all/Category/…)-->
 |usergroup          = <!--template's usergroup (all/admin/…)-->
 |placement          = <!--template's placement (top/source/…)-->
 |usage-notes        = <!--notes about the correct usage-->
 |type               = <!--template type (infobox/formatting/…)-->
 |example            = <!--example value for one (unnamed) parameter-->
 |example-value      = <!--example use of the templatea-->
 |i18n-method        = <!--translation method-->
 |i18n-desc          = <!--translation info-->
 |i18n-mediawiki-msg = <!--name of the message (method=“mediawiki-msg”)-->
 |i18n-subpage       = <!--translation subpage (method="ext.translate")-->
 |i18n-data-file     = <!--tabular data file on Wikimedia Commons-->
 |seealso            = <!--list of relevant links-->
 |setscats           = <!--list of categories automatically set-->
 |print              = <!--template code layout (one/multi/infobox)-->
 |shorthand          = <!--redirects to the main template-->
 |relieson           = <!--list of templates the template relies on-->
 |mustbesubst        = <!--if template must be substituted: yes-->
 |docsub-page        = <!--{{Documentation subpage}} page parameter-->
}}

About: TemplateData

Complications

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

සංස්කරණය

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.