Template:Barnstar documentation/doc

Purpose

This template is used to provide generic documentation for most of the barnstar templates.

Parameters available

• |autosubst= set to yes if you wish for a bot to automatically substitute the template.
• |header= Used to add any header notes to docs. Add things such as shortcut links here.
• |for= Used to briefly describe what the award is for.
• |usage= Used to replace the standard Usage-section with a user defined.
• |nomessage= set to yes if there is not any option to customise the awards message.
• |autosign= set to yes if the template automatically signs the message.
• |alt= set to yes if there is an alt parameter which is used to show an alternative image.
• |footer= Used to add any footer notes to docs.
• Categorization:
  • if the |nocat= is set to yes, the template will not be added to any categories.
  • |cat= Category name (without "Category:"), if it is something more specific than Wikipedia barnstar templates
  • If |cat= is not specified, templates will be added automatically to Category:Wikipedia barnstar templates,
  • if the |alt= is set to yes, they will be added to Category:Wikipedia barnstar templates with alternative versions,

Templates beginning with The like {{The Jupiter Barnstar}} should include a {{DEFAULTSORT}} (in this case: {{DEFAULTSORT:Jupiter Barnstar, The}}).

Usage (of this template)

• Like the general {{Documentation}} template, place {{Barnstar documentation}} between <noinclude> tags below the barnstar template code. Be sure to place the first tag, <noinclude> (the opening tag), after the very last code of the barnstar template. If the opening tag is placed on its own line below the template code, then it will introduce undesirable whitespace below the end-product barnstar template.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Barnstar documentation

No description.

Template parameters

Parameter		Description	Type	Status
autosubst	autosubst	no description	Unknown	optional
header	header	no description	Unknown	optional
for	for	no description	Unknown	optional
usage	usage	no description	Unknown	optional
nomessage	nomessage	no description	Unknown	optional
autosign	autosign	no description	Unknown	optional
alt	alt	no description	Unknown	optional
footer	footer	no description	Unknown	optional
sandbox	sandbox	no description	Unknown	optional
template page	template page	no description	Unknown	optional
testcases	testcases	no description	Unknown	optional
nocat	nocat nocats	no description	Unknown	optional
cat	cat	no description	Unknown	optional