Jump to content

Teamplaid:substitution/documentation

O Wiktionary

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

Paramadairean na teamplaide[Stiùirich an TemplateData]

ParamadairTuairisgeulSeòrsaStaid
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

Bun-roghainn
Ball-eisimpleir
never
Luach fèin-obrachail
Sreangriatanach
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

Bun-roghainn
Ball-eisimpleir
unless older versions cannot be found
Luach fèin-obrachail
Sreangroghainneil

Ùsaid - Usage

[deasaich]

Eisimpleirean - Examples

[deasaich]

With middle text but no additional text at the end

[deasaich]

{{substitution|not}}

produces:

With both middle text and additional text at the end

[deasaich]

{{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

[deasaich]

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

produces:

Faic cuideachd - Also see

List of subst helper templates

[deasaich]
  • {{require subst}}: Prints an error unless substituted.
    • {{subst only}}: For the doc of the above templates; prints a message asking for it be substituted.
    • {{nosubst}}: The reverse of {{subst only}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
    • {{substitution}}: Allows free-fill description of whether the template should be substituted and under what conditions.
  • {{issubst}}: Returns "yes" if substituted.
  • {{ifsubst}}: Forks if substituted or not.
  • Mòideal:Unsubst: Prevents substitution.
  • Mòideal:Unsubst-infobox: Prevents substitution for infoboxes, cleans up parameters.