Template:Substitution/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Mclay1
Created page with '{{Disambiguate|Template:Subst}} {{Documentation subpage}} {{Substitution|not}} ==Usage== Add this message box to a template's documentation to briefly explain the ...'
 
Ookami (talk | contribs)
m 35 revisions imported
 
(34 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{{Disambiguate|Template:Subst}}
{{Distinguish|Template:Subst|Template:Substituted}}
{{Documentation subpage}}
{{Documentation subpage}}
{{nosubst}}
==Examples==
=== With middle text but no additional text at the end ===
<code><nowiki>{{Substitution|not}}</nowiki></code>
produces:
{{Substitution|not}}
{{Substitution|not}}


==Usage==
=== With both middle text and additional text at the end===
Add this message box to a template's documentation to briefly explain the rules of [[Wikipedia:Substitution|substitution]] for the template.
<code><nowiki>{{Substitution|only (at least as of </nowiki>{{CURRENTYEAR}}<nowiki>)|if temperatures fall and it starts to snow}}</nowiki></code>
 
produces:


===Parameters===
{{Substitution|only (at least as of {{CURRENTYEAR}})|if temperatures fall and it starts to snow}}
The first parameter inserts a word between "should" and "be", e.g. "always", "never" etc. To have no word instead, insert a space.


The second parameter is optional. It adds text to the end of the sentence.
=== With no middle text but some additional text at the end===


==Example==
<code><nowiki>{{Substitution| |if you wish to ensure your emoji's image remains the same even if its template's image is changed}}</nowiki></code>
<code><nowiki>{{Substitution|sometimes|if...}}</nowiki></code>


produces:
produces:


{{Substitution|sometimes|if...}}
{{Substitution| |if you wish to ensure your emoji image remains the same even if its template image is changed}}
 
== TemplateData ==
{{TemplateDataHeader}}
<templatedata>{
  "description": "Use this template to add a message box to a template's documentation subpage indicating if and how that template  should be substituted.",
  "params": {
    "first parameter": {
      "label": "1",
      "description": "Inserts any helpful or instructive text in bold font such as 'always' or 'never' between the words 'should' and 'be' in the resulting message box; if no such instruction is desired, this parameter should be entered as a single blank typed space (in this sense, the parameter is required: it must be an instructive word OR it must be a blank typed space—it must NOT be left with no entry",
      "type": "string",
      "example": "never",
      "required": true
    },
      "second parameter": {
      "label": "2",
      "description": "This parameter takes any text you add to it and places it at the end of the sentence that the message box generates; it should NOT end in a period",
      "type": "string",
      "example": "unless older versions cannot be found",
      "default": "",
      "required": false
    }
  }
}</templatedata>
 
==See also==
* {{tl|Nosubst}}
* {{tl|Subst only}}
* {{tl|Transclusionless}}


<includeonly>
<includeonly>{{sandbox other||
[[Category:Template namespace templates]]
[[Category:Documentation header templates]]
</includeonly>
}}</includeonly>

Latest revision as of 13:55, 3 September 2020

Examples

With middle text but no additional text at the end

{{Substitution|not}}

produces:

With both middle text and additional text at the end

{{Substitution|only (at least as of 2024)|if temperatures fall and it starts to snow}}

produces:

With no middle text but some additional text at the end

{{Substitution| |if you wish to ensure your emoji's image remains the same even if its template's image is changed}}

produces:

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Substitution

Use this template to add a message box to a template's documentation subpage indicating if and how that template should be substituted.

Template parameters

ParameterDescriptionTypeStatus
1first parameter

Inserts any helpful or instructive text in bold font such as 'always' or 'never' between the words 'should' and 'be' in the resulting message box; if no such instruction is desired, this parameter should be entered as a single blank typed space (in this sense, the parameter is required: it must be an instructive word OR it must be a blank typed space—it must NOT be left with no entry

Example
never
Stringrequired
2second parameter

This parameter takes any text you add to it and places it at the end of the sentence that the message box generates; it should NOT end in a period

Default
Example
unless older versions cannot be found
Stringoptional

See also