Template:Current sport-related/doc

Guidelines
Do not subst.
 * Note that every article on Wikipedia has a General disclaimer indicating that the article contents may not be accurate. As such, this template is redundant.
 * This template is for articles which involve an article about an evolving current sports-related event which is either changing rapidly or about which understanding is rapidly evolving. This is an advisory to readers that the article may be incomplete and subject to change.
 * As an advisory to editors, it may also be used in those occasions that many editors (perhaps a hundred or more) edit an article on the same day.
 * It is not intended to be used to mark an article that merely has recent news articles about the topic; if it were, thousands of articles would have this template.
 * Generally it is expected that this template and its closely related templates will appear on an article for perhaps a day or two, occasionally several days.
 * If you desire that an article be noticed as a topic about or related to a significant current event, see How the Current events page works.


 * [ Check main (article) namespace links]

Usage
This template contains 4 optional image parameters:


 * mini, if set "mini=1", creates a smaller version of the template.
 * sport, automatically switches the image to be more specific to replace the football (soccer ball) image. Currently supports: American football, Australian rules football, basketball, baseball, cricket, cycling, golf, hockey, motorsports, netball, Olympics, rugby, tennis, volleyball, boxing, curling, squash, swimming, athletics, lacrosse
 * image, which can switch to an alternate image that is not supported.
 * event, which can change the event to something other than the default sports-related event text.

Examples





 * An optional second link provision ( } ) can be used to link from a generic page (New England Patriots [TEAM]) to last year and this year's articles as follows by defining the lead-in text parameter   and } (which is always nested in square-brackets:

Parameters
{	"params": { "1": {			"label": "Name of page", "description": "The title of the page describing the current event", "type": "wiki-page-name", "required": true },		"sport": { "label": "Sport", "description": "Name of the sport referred to", "type": "line" },		"mini": { "label": "Minimise template", "description": "Make small version of template (enter 1 to minify)", "type": "number" },		"image": { "label": "Image name", "description": "File name of an image not supported by the template", "type": "wiki-file-name" },		"2": {			"label": "Second related event", "description": "Title of a page describing another page related to the current event", "type": "wiki-page-name" },		"second": { "label": "Introduction to second event", "description": "Words to introduce the second event", "type": "line" }	},	"description": "Indicates that the article refers to a current sports event and provides a link to that event." }