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. See a monthly parameter usage report for Template:Barnstar documentation in articles based on its TemplateData.

TemplateData for Barnstar documentation

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

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Auto-substitute	autosubst	set to yes if you wish for a bot to automatically substitute the template. Suggested values yes	String	optional
Header	header	Used to add any header notes to docs. Add things such as shortcut links here.	Content	optional
Award for	for	Used to briefly describe what the award is for. Example Awarded to recognize particularly fine contributions to Wikipedia, to let people know that their hard work is seen and appreciated.	Content	optional
Usage	usage	Used to replace the standard Usage-section on the documentation of this barnstar instance with a user defined 'usage' section.	Content	optional
No Message	nomessage	set to 'yes' if there are **no** options to customise the awards message. yes -> cannot customize message. Suggested values yes no	String	optional
Auto-sign	autosign	set to 'yes' if the template automatically signs the message (automatically signing the barnstar with the awarder's signature) Suggested values yes no Default yes	String	optional
Does an 'alt' version of this barnstar exist?	alt	set to 'yes' if there is an 'alt' parameter which is used to show an alternative image. Setting this to 'yes' will also add this barnstar template to the 'Wikipedia barnstar templates with alternative versions' category (unless 'nocat' is set to 'yes'). Suggested values yes no Default no	String	optional
Documentation footer	footer	Used to add any footer notes to this barnstar's docs.	Content	optional
Barnstar sandbox	sandbox	Link to the '/sandbox' page for this barnstar template	Unknown	optional
Barnstar template page	template page	Link to the actual template page for this barnstar	Unknown	optional
Barnstar testcases page	testcases	Link to the actual '/testcases' page for this barnstar	Unknown	optional
nocat	nocat nocats	If 'yes', this barnstar template will not be added to any categories Suggested values yes no	String	optional
Barnstar Category name	cat	Category name (without "Category:"), if it is something more specific than 'Category:Wikipedia barnstar templates' Default Wikipedia barnstar templates	String	optional

See also

• Template:Barnstar