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 uses TemplateStyles: |
Screen reader only
[kulemba source]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
[kulemba source]This template should only be used to hide text from sighted readers when that text substantially duplicates adjacent text that is visible.
Table captions
[kulemba source]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
[kulemba source]The table below has a caption "Example table" that will be voiced by a screen reader.
|+ {{Screen reader-only|Example table}}
Example table
[kulemba source]| Header | Information |
|---|---|
| Row hdr 1 | data 1 |
| Row hdr 2 | data 2 |
| Row hdr 3 | data 3 |
TemplateData
[kulemba source]TemplateData for Screen reader-only
The text supplied is not to be displayed in a browser, but should be voiced by a screen reader.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text | 1 | no description | String | required |