View source for Template:Spoken Wikipedia/doc

{{Documentation subpage}}
{{High-use|1817}}
{{Lua|Module:Spoken Wikipedia}}

This template links to the [[Wikipedia:WikiProject Spoken Wikipedia|spoken]] version of the article, adds a small sound icon at the top of the article with a link to the audio file, and adds the article into [[:Category:Spoken articles]].

==Usage==
Place this template near the top of the last section of the article:

 {{tlf|Spoken Wikipedia|date{{=}}<var>YYYY-MM-DD</var>|Filename 1.ogg|Filename 2.ogg|Filename 3.ogg ...}}

Where date is of article revision that corresponds to the audio file, in any format, supported by [[Module:Date]], e.g. [[ISO 8601]]. See also [[Template:Date/doc#Examples]].

Example at [[Black]]:

:<code><nowiki>{{Spoken Wikipedia|date=2005-08-16|black.ogg}}</nowiki></code>

===Parameters===
;{{para|1}}, {{para|2}}, {{para|3}}...
:Filenames for the recording. Arbitrary amount of files is supported. At least one file must be specified.
;{{para|date}}
:Date of the recording.
;{{para|page}}
:Which page is read in the recording. Defaults to subject page name. Can be used to put the template on pages, other than the subject's page.

==Tracking categories==
* When filenames are missing, page is added to [[:Category:Spoken Wikipedia without file]].
* When parameter {{para|date}} is missing, page is added to [[:Category:Spoken Wikipedia without date]].

==Microformat==
{{UF-audio}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Filename",
			"description": "Filename of the audio file for the spoken version (without the File: prefix). Use |2=, |3=, and so on for multiple files.",
			"example": "En-Visual impairment-article.ogg",
			"type": "wiki-file-name",
			"required": true
		},
		"2": {
			"label": "2nd filename",
			"description": "Second filename",
			"example": "Football (soccer) Part Two.ogg",
			"type": "wiki-file-name",
			"required": false
		},
		"3": {
			"label": "3rd filename",
			"description": "Third filename.",
			"example": "Fermi paradox 3.ogg",
			"type": "wiki-file-name",
			"required": false
		},
		"date": {
			"label": "Date of recording",
			"description": "Date of the version of the article spoken. Should be formatted using [[Template:Start date]].",
			"example": "2020-12-01",
			"required": true
		},
		"page": {
			"description": "Specifies that the recording is of a page other than the page where the template appears. Do not use for same page.",
			"type": "wiki-page-name"
		},
		"nocat": {}
	},
	"paramOrder": [
		"date",
		"1",
		"2",
		"3",
		"page",
		"nocat"
	],
	"description": "Adds a box and topicon for readers to play the spoken version of a page"
}
</templatedata>

==See also==
* [[Wikipedia:WikiProject Spoken Wikipedia]]
* {{tl|Audio}}
* {{tl|Listen}}

{{Top icon templates}}<includeonly>
{{Sandbox other||
<!-- categories and interwiki links -->
[[Category:Audio templates]]
[[Category:Title templates]]
[[Category:Top icon content award templates]]
}}</includeonly>