మూస:TemplateBox/doc

Tracked in Phabricator
Task T54966
Resolved

Usage

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

మూస పరామితులు

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		: required optional optional- deprecated	optional	optional
useTemplateData			empty	optional
name			{{BASEPAGENAME}}	required
desc desc-en description description-en desc-td description-td			empty	required
namespace				required
usergroup				required
placement		: top bottom licence source	empty	optional
usage-notes			empty	optional
type			empty	optional
example			empty	optional
example-value			empty	optional
i18n-method		: autotranslate switch - custommediawiki-msg mediawiki-msg ext.translate	empty	optional
i18n-desc			empty	optional
i18n-mediawiki-msg			empty	optional
i18n-subpage			i18n	optional
seealso			empty	optional
setscats			empty	optional
print				optional
lines print			empty	optional
shorthand			empty	optional
relieson			empty	optional
mustbesubst			empty	optional

Template data

The template provides a uniform way to provide basic information about the use of a template. See: [[Commons:Template documentation]] and [[Commons:TemplateData]]. మూస పరామితులు ఈ మూసకు, పరామితుల ఇన్‌లైను ఫార్మాటింగు కావాలి. పరామితి వివరణ రకం స్థితి 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." స్ట్రింగు ఐచ్చికం aliases (param) 1aliases 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) స్ట్రింగు ఐచ్చికం description (param) 1d 1d-en 1description 1description-en description of the parameter (similarly 2d, 3d, …) స్ట్రింగు ఐచ్చికం 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. స్ట్రింగు ఐచ్చికం default (param) 1def 1def-td 1default default value for the parameter (similarly 2def, 3def, …) తెలియనిది ఐచ్చికం 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. స్ట్రింగు ఐచ్చికం 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. స్ట్రింగు ఐచ్చికం status (param) 1stat 1stat-td 1deprecated 1required : required[[Category Templates needing substitution checking]]<sup class="noprint Inline-Template " style="margin-left:0.1em; white-space:nowrap;">&#91;<i>[[Wikipedia:Please clarify|<span title="What makes a parameter required or optional? (December 2017)">విడమరచి రాయాలి</span>]]</i>&#93;</sup> optional optional- deprecated అప్రమేయం 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]. స్ట్రింగు ఐచ్చికం description (template) desc desc-en description description-en desc-td description-td description of what the template does స్ట్రింగు తప్పనిసరి example example Example use (works with a single unnamed parameter only). There is also '''example2''' for a second example. స్ట్రింగు ఐచ్చికం example-result example-value If there is more than one parameter you would like to show or if there are named parameters, use: [[:మూస:TemplateBox/doc/example-value]] స్ట్రింగు ఐచ్చికం translation info i18n-desc additional info about the localization స్ట్రింగు ఐచ్చికం mediawiki-message i18n-mediawiki-msg When using “mediawiki-msg” as method, optionally put the name of the message here. Falls back to: స్ట్రింగు ఐచ్చికం translation method i18n-method : autotranslate switch - custommediawiki-msg mediawiki-msg ext.translate స్ట్రింగు ఐచ్చికం translation-subpage i18n-subpage అప్రమేయం i18n స్ట్రింగు ఐచ్చికం lines print Use parameter '''print''' instead. తెలియనిది ఐచ్చికం 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". స్ట్రింగు ఐచ్చికం 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> అప్రమేయం <small>{{'''BASE'''PAGENAME}}</small> పేజీ పేరు తప్పనిసరి namespace namespace namespaces, the template is intended to be used in; possible values: [[:మూస:TemplateBox/doc/nslist]] Any other values will show as “unknown”. అప్రమేయం no namespace specified స్ట్రింగు తప్పనిసరి placement placement : top bottom licence source స్ట్రింగు ఐచ్చికం 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 ''=''. అప్రమేయం one (if type param ≠ '''infobox''') స్ట్రింగు ఐచ్చికం relies on relieson list of templates on which the template's basic functionality relies స్ట్రింగు ఐచ్చికం see also seealso relevant links (put in a list of them) స్ట్రింగు ఐచ్చికం categorizes into setscats what categories are automatically set by the template (put in a linked list of them) స్ట్రింగు ఐచ్చికం shorthand shorthand shorthand for easy use (redirects to main template). See examples [[Template:CatDiffuse/doc|here]] and [[Template:Cat see also/doc|here]] of lists of redirects, and searches for more. స్ట్రింగు ఐచ్చికం type (template) type what type is the template (infobox, formatting, licence tag, …) స్ట్రింగు ఐచ్చికం usage-notes usage-notes notes about the correct usage of the template స్ట్రింగు ఐచ్చికం expose TemplateData useTemplateData whether to expose TemplateData - Omitting means "false", setting to 1, true or yes, "true". Setting to only will suppress the house-made table. Setting useTemplateData to "export" will turn TemplateBox into a preformatted Copy & Paste template. స్ట్రింగు ఐచ్చికం usergroup usergroup usergroup that is meant to use the template; possible values: [[:మూస:TemplateBox/doc/usergroup]] అప్రమేయం no user group specified స్ట్రింగు తప్పనిసరి

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

Relies on:
Module:TemplateBox, Module:Languages

⧼Seealso⧽

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

Localization

English ∙

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

About: TemplateData

{{Commons:TemplateData}}

( NOTE : the {{sed|1}} template links appears HERE : >>> ) మూస:Sed