Jump to content

Template:Wrapper/doc

Bisangiddwa ku Wikipedia
For tagging wrappable segments within nowrap-scoped text, see Template:Wrap. For a wrapper template generator, see Module:Template wrapper.

This template is a doc page banner that flags a wrapper template. {{Wrapper|target template}}Template:Br {{Wrapper|target template|all=yes|exclude=excluded param1, param2, ...}}

This template has one required positional parameter, and three optional named params:

  • |1= – name of the template, excluding namespace (required)
  • |all=yes – alters the default wording (Any field from {{Example}} can work...) to All fields from {{Example}} will work here."
  • |exclude=string – adds "(except string)" after "from Example". Use this to list params in Template:Example not available in the wrapper.
  • |nocat=yes – disable automatic categorization into [[Category:Templates calling Example]]
Example 1: {{Wrapper|Wikibreak}}
This example might appear on the doc page of {{Exams}} or {{Vacation}}:
{{Wrapper|Wikibreak}} →
Example 2: {{Wrapper|Sfnlink|exclude=rev}}
This example might appear on the doc page of {{Sfnlinka}}:
{{Wrapper|Sfnlink|exclude=rev}} →
Example 3: {{Wrapper|Sfnlink|all=yes|exclude=rev and lang}}
This example might appear on the doc page of {{Sfnlinka}}:
{{Wrapper|Sfnlink|all=yes|exclude=rev and lang}} →

TemplateData

[kolera mu edit source]
See a monthly parameter usage report for Template:Wrapper in articles based on its TemplateData.

TemplateData for Wrapper

No description.

Template parameters

ParameterDescriptionTypeStatus
Template1

name of template this is a wrapper for (without "Template:")

Example
Wikibreak
Stringrequired
nocatnocat

Disables categorization

Example
yes
Booleanoptional
allall

For wrappers that use the module, changes the second sentence to read "All fields from <template> will work here."

Booleanoptional
excludeexclude

string listing params of <template> excluded from use here.

Example
params 'P-one' and 'P-two'
Stringoptional