Template:Nosubst/doc: Difference between revisions

Latest revision as of 22:26, 20 April 2020

This template should not be substituted.

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Nosubst.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

This template marks that the template it’s used on should not be substituted (it should be transcluded instead).

Usage

Template parameters

Parameter text is empty

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.

Wikipedia's help about TemplateData • Commons-specific information

This template marks that the template it’s used on should not be substituted (it should be transcluded instead).

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
explanation	`1`	A more detailed description of why the template in question should not be substituted.	Content	optional

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:

On the documentation subpage (not the template page itself)

Relies on:
{{Ombox}}

Example

{{Nosubst|Example text.}}

renders as:

This template should not be substituted. Example text.

Localization

This template is not intended to be localized.

@@ Line 1: / Line 1: @@
-{{Documentation subpage}}
 {{Nosubst}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{TemplateBox
+  |1        = 1
+  |1label-en= explanation
+  |1d-en    = A more detailed description of why the template in question should not be substituted.
+  |1aliases = <!-- List of aliases, separated by / (a slash) -->
+  |1type    = content
+  |1def     = <!-- default value for the parameter -->
+  |1stat    = optional-
-=== Usage ===
+  |name               = Nosubst
+  |desc               = This template marks that the template it’s used on should not be substituted (it should be transcluded instead).
-<code><nowiki>{{Nosubst}}</nowiki></code>
+  |usage-notes        =
+  |namespace          = template
-This template should be placed on the <big>[[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpage|subpage]]</big> (not the template page itself) of any template that should '''not''' be substituted (and transcluded instead).
+  |usergroup          = all
+  |shorthand          =
-;Parameters
+  |mustbesubst        =
-* This template accepts one optional parameter, which can be used to give a more detailed description of why the template in question should not be substituted. For example, <code><nowiki>{{Nosubst|Example text.}}</nowiki></code> produces:
+  |setscats           =
-{{Nosubst|Example text.}}
+  |placement          = On the [[w:Wikipedia:Template documentation|documentation]] [[w:Wikipedia:Subpage|subpage]] (not the template page itself)
+  |example            = Example text.
-{{List of subst helper templates}}
+  |example-value      =
+  |relieson           = {{tl|ombox}}
-<includeonly>{{sandbox other||
+  |seealso            =
-<!-- CATEGORIES HERE, THANKS -->
+  |print              =
-[[Category:Wikipedia metatemplates]]
+  |type               =
+  |i18n-method        = -
+  |i18n-desc          =
+  |i18n-subpage       =
+  |i18n-mediawiki-msg =
+  |useTemplateData    = only
+}}<includeonly>
 [[Category:Template namespace templates]]
-}}</includeonly>
+</includeonly>

commons>Tacsipacsi