Template:Spoken Wikipedia/doc

This is a documentation subpage for Template:Spoken Wikipedia.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 2,100 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Spoken Wikipedia (sandbox)

This template links to the 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:

{{Spoken Wikipedia|date=YYYY-MM-DD|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:

{{Spoken Wikipedia|date=2005-08-16|black.ogg}}

Parameters

|1=, |2=, |3=...: Filenames for the recording. Arbitrary amount of files is supported. At least one file must be specified.
|date=: Date of the recording.
|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 |date= is missing, page is added to Category:Spoken Wikipedia without date.

Microformat

The HTML mark-up produced by this template includes an hAudio microformat that makes an audio recording's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Subtemplates

Date-of-publication ("published") information will only be included in the microformat if {{start date}} (or, where appropriate, {{start date and age}}) is used in a parent infobox/template. Do not, however, use {{start date}} or {{start date and age}} if a date before 1583 CE is involved.

Use {{duration}} to specify the duration/length of a recording. For instance, if the recording's duration is 3 minutes 45 seconds, use {{duration|m=3|s=45}} (which appears as: 3:45). If needed, |h= may be included to specify a number of hours.

Please do not remove instances of these subtemplates.

Classes used

The HTML classes of this microformat include:

haudio
fn
album
description
category
contributor
duration
h
item
min
photo
position
price
published
s

Please do not rename or remove these classes
nor collapse nested elements which use them.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Spoken Wikipedia in articles based on its TemplateData.

TemplateData for Spoken Wikipedia

Adds a box and topicon for readers to play the spoken version of a page

Template parameters
Parameter		Description	Type	Status
Date of recording	`date`	Date of the version of the article spoken. Should be formatted using [[Template:Start date]]. Example 2020-12-01	Unknown	required
Filename	`1`	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	File	required
2nd filename	`2`	Second filename Example Football (soccer) Part Two.ogg	File	optional
3rd filename	`3`	Third filename. Example Fermi paradox 3.ogg	File	optional
page	`page`	Specifies that the recording is of a page other than the page where the template appears. Do not use for same page.	Page name	optional
nocat	`nocat`	no description	Unknown	optional