View source for User:Vestrian24Bio/Sandbox/IPL/Final preload/doc

{{Documentation subpage}}
{{Always substitute}}{{Transclusionless}}
{{Lua|Module:Arguments|Module:Check for unknown parameters|Module:Color contrast|Module:Delink|Module:Format link|Module:Hatnote|Module:Hatnote list|Module:Icon|Module:Infobox|Module:InfoboxImage|Module:Labelled list hatnote|Module:Navbar|Module:Navbox|Module:Ns has subpages|Module:Official website|Module:Pagetype|Module:Portal|Module:Portal bar|Module:String|Module:TableTools|Module:Unsubst|Module:Wikitable|Module:Yesno}}

== Usage ==
This is a preload form for creating final match articles for [[Indian Premier League]]. See the [[Template:Indian Premier League final preload/doc/example|Example here]]. After substitution necessary citations should be added and links should be checked before adding content.

See [[Template:Indian Premier League final preload/doc/usage|here]] for a list of pages that were (or to be) created using this Preload form.

== Code ==
<syntaxhighlight lang="wikitext">{{Subst:Indian Premier League final preload
|year= <!-- Do not wikilink -->
|team1= <!-- Do not wikilink -->
|team2= <!-- Do not wikilink -->
|date= <!-- Do not wikilink; Use the dmy format -->
|stadium= <!-- Add with wikilink -->
|city= <!-- Add with wikilink -->
|prevyear= <!-- Do not wikilink -->
|nextyear= <!-- Do not wikilink -->
}}</syntaxhighlight>
{{clear}}
=== Example ===
{{#Section:User:Vestrian24Bio/Sandbox/IPL/Final_preload/doc/example|EW}}
See the visual outcome at the [[User:Vestrian24Bio/Sandbox/IPL/Final_preload/doc/example|Example page]].

== Details ==
All parameters are compulsory; leaving out any would cause substitution errors.

=== Team qualified from Qualifier 1 ===
The team which qualified from Qualifier 1. Do not wikilink. This parameter is used in the Infobox, Lead, Road to the Final, Match summary boxes and Navbox. It also generates relevant colors and wikilinks using the strings [[Template:IPL Teams 1|IPL Teams 1]], [[Template:IPL Teams 2|IPL Teams 2]], [[Template:IPL Team colors 1|IPL Team colors 1]] and [[Template:IPL Team colors 2|IPL Team colors 2]] as shown below.

{{IPL Team colors 2/outcome}}

=== Team qualified from Qualifier 2 ===
The team which qualified from Qualifier 2. Do not wikilink. This parameter is used in the Infobox, Lead, Road to the Final, Match summary boxes and Navbox. It also generates relevant colors and wikilinks using the strings [[Template:IPL Teams 1|IPL Teams 1]], [[Template:IPL Teams 2|IPL Teams 2]], [[Template:IPL Team colors 1|IPL Team colors 1]] and [[Template:IPL Team colors 2|IPL Team colors 2]] as shown above.

== TemplateData ==
{{TemplateData header}}

<templatedata>
{
	"description": {
		"en": "Preload form for creating Indian Premier League Final match articles.",
		"fr": "Formulaire de préchargement pour créer des articles concernant les matchs de la Premier League Final indiens."
	},
	"format": "inline",
	"params": {
		"year": {
			"label": {
				"en": "Year",
				"fr": "année"
			},
			"description": "The year which the final is taking place. Do not wikilink.",
			"example": "2024",
			"type": "number",
			"required": true
		},
		"team1": {
			"label": {
				"en": "Team qualified from Qualifier 1",
				"fr": "équipe1"
			},
			"description": "The team which qualified from Qualifier 1. Do not wikilink.",
			"example": "kkr",
			"type": "string",
			"suggestedvalues": [
				"csk",
				"dc",
				"gt",
				"kkr",
				"lsg",
				"mi",
				"pbks",
				"rr",
				"rcba",
				"srh"
			],
			"required": true
		},
		"team2": {
			"label": {
				"en": "Team qualified from Qualifier 2",
				"fr": "équipe2"
			},
			"description": "The team which qualified from Qualifier 2. Do not wikilink.",
			"example": "srh",
			"type": "string",
			"suggestedvalues": [
				"csk",
				"dc",
				"gt",
				"kkr",
				"lsg",
				"mi",
				"pbks",
				"rr",
				"rcba",
				"srh"
			],
			"required": true
		},
		"date": {
			"label": {
				"en": "Date",
				"fr": "dare"
			},
			"description": "The date when the final is taking place. Do not wikilink; Use the dmy format.",
			"example": "26 May 2024",
			"type": "date",
			"required": true
		},
		"stadium": {
			"label": {
				"en": "Stadium",
				"fr": "stade"
			},
			"description": "The stadium where the final is taking place. Should be wikilinked.",
			"example": "[[M. A. Chidambaram Stadium]]",
			"required": true
		},
		"city": {
			"label": {
				"en": "City",
				"fr": "ville"
			},
			"description": "The city where the final is taking place. Should be wikilinked.",
			"example": "[[Chennai]]",
			"required": true
		},
		"prevyear": {
			"label": {
				"en": "Previous year",
				"fr": "année précédente"
			},
			"description": "The previous season of IPL. Do not wikilink.",
			"example": "2023",
			"type": "number",
			"required": true
		},
		"nextyear": {
			"label": {
				"en": "Next year",
				"fr": "année suivante"
			},
			"description": "The next season of IPL. Do not wikilink.",
			"example": "2025",
			"type": "number",
			"required": true
		}
	}
}
</templatedata>

== See also ==
* [[Template:Indian Premier League Teams by season preload]]
<!-- * [[Template:Women's Premier League final preload]] -->

<includeonly>{{Sandbox other||
{{DEFAULTSORT:final preload, Indian Premier League}}
[[Category:Indian Premier League preloads]]
}}</includeonly>