Template:Screen reader-only/doc

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

This template is used on approximately 61,000 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.

Redirect

{{sronly}}

The pages listed in this category are templates.

This page is part of OODA WIKI's administration and not part of the encyclopedia.

Further template category notes

This category contains pages in the template namespace. It should not be used to categorize articles or pages in other namespaces.

To add a template to this category:

If the template has a separate documentation page (usually called "Template:template name/doc"), add
[[Template:Screen reader-only/doc]]
to the <includeonly> section at the bottom of that page. Otherwise, add
<noinclude>[[Template:Screen reader-only/doc]]</noinclude>
to the end of the template code, making sure it starts on the same line as the code's last character.

This category is an index of templates which use TemplateStyles. It is automatically populated by {{Uses TemplateStyles}}.

This template generates invisible text that will be read aloud by screen readers.

Screen reader only

The text supplied as the sole unnamed parameter is not to be displayed in a browser, but should be voiced by a screen reader.

First part. {{Screen reader-only|Second part only for a screen reader.}} Third part. → First part. Second part only for a screen reader. Third part.

Usage

This template should only be used to hide text from sighted readers when that text substantially duplicates adjacent text that is visible.

Table captions

The main usage case is when a table is placed immediately below a heading, where the heading is effectively identical to the table's caption. This template may be used to hide the caption from a sighted reader (as it would be duplicative), while allowing a screen reader to hear the caption – for example, if the screen reader reads a list of tables in the article to allow navigation directly to a particular table.

If the table is moved to another location away from the heading, then this template should be removed to allow sighted readers to see the table caption. This is a requirement of WCAG 1.3.1.

Example

The table below has a caption "Example table" that will be voiced by a screen reader.

|+ {{Screen reader-only|Example table}}

Example table

Example table
Header	Information
Row hdr 1	data 1
Row hdr 2	data 2
Row hdr 3	data 3

TemplateData

Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Screen reader-only

The text supplied is not to be displayed in a browser, but should be voiced by a screen reader.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Text	`1`	no description	String	required