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:  ).

Usage (of this template)

 * Like the general Documentation template, place between   tags below the barnstar template code.  Be sure to place the first tag,   (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
{	"params": { "autosubst": { "label": "Auto-substitute", "description": "set to yes if you wish for a bot to automatically substitute the template.", "type": "string", "suggestedvalues": [ "yes" ]		},		"header": { "label": "Header", "description": "Used to add any header notes to docs. Add things such as shortcut links here.", "type": "content" },		"for": { "label": "Award for", "description": "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. ", "type": "content" },		"usage": { "label": "Usage", "description": "Used to replace the standard Usage-section on the documentation of this barnstar instance with a user defined 'usage' section.", "type": "content" },		"nomessage": { "label": "No Message", "description": "set to 'yes' if there are **no** options to customise the awards message. yes -> cannot customize message.", "type": "string", "suggestedvalues": [ "yes", "no" ]		},		"autosign": { "label": "Auto-sign", "description": "set to 'yes' if the template automatically signs the message (automatically signing the barnstar with the awarder's signature)", "type": "string", "suggestedvalues": [ "yes", "no" ],			"default": "yes" },		"alt": { "label": "Does an 'alt' version of this barnstar exist?", "description": "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').", "type": "string", "suggestedvalues": [ "yes", "no" ],			"default": "no" },		"footer": { "label": "Documentation footer", "description": "Used to add any footer notes to this barnstar's docs.", "type": "content" },		"sandbox": { "label": "Barnstar sandbox", "description": "Link to the '/sandbox' page for this barnstar template" },		"template page": { "label": "Barnstar template page", "description": "Link to the actual template page for this barnstar" },		"testcases": { "label": "Barnstar testcases page", "description": "Link to the actual '/testcases' page for this barnstar" },		"nocat": { "aliases": [ "nocats" ],			"label": "nocat", "description": "If 'yes', this barnstar template will not be added to any categories", "type": "string", "suggestedvalues": [ "yes", "no" ]		},		"cat": { "label": "Barnstar Category name", "description": "Category name (without \"Category:\"), if it is something more specific than 'Category:Wikipedia barnstar templates'", "type": "string", "default": "Wikipedia barnstar templates" }	},	"description": "This template is used to provide generic documentation for most of the barnstar templates.", "format": "block" }