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

Parameters available are:

  • |for= Used to briefly describe what the award is for.
  • |alt= set to yes if there is an alt parameter which is used to show an alternative image.
  • |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.
  • |header= Used to add any header notes to docs. Add things such as shortcut links here.
  • |footer= Used to add any footer notes to docs.
  • |usage= Used to replace the standard Usage-section with a user defined.
  • |cat= Category name (without "Category:"), if it is something more specific than Barnstar award templates

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

Template documentation

Usage

To use this template, add {{subst:Barnstar documentation|1=Put your message here. ~~~~}} to the talk page of the user you wish to award it to.