Template:UcfirstSwitch

{{{1}}}

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:UcfirstSwitch/doc.

This template converts a text’s first letter to upper case if the second parameter is truthy. It’s useful in templates, where the second parameter comes from a parameter of that template or some complex condition, so that the text needs to be given only once.

Usage

{{UcfirstSwitch |1= |2= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

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

This template converts a text’s first letter to upper case if the second parameter is truthy. It’s useful in templates, where the second parameter comes from a parameter of that template or some complex condition, so that the text needs to be given only once.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Text	1	The text to display (first letter lower case, otherwise useless)	Content	required
switch	2	Boolean value indicating whether the first letter of the text should be upper cased Default 0	Boolean	suggested

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:
{{boolean}}

Localization

This template is not intended to be localized.

Example

{{UcfirstSwitch|text|0}} text

{{UcfirstSwitch|text|1}} Text