Description

A separator denoting the position before which a break occurs between two contiguous pages in a statically paginated version of the content.

Examples

Example 1 — Pagebreak using hr element
<hr id="pg004" role="doc-pagebreak" aria-label="4">
Example 2 — Pagebreak with explicit number
<div id="pg032" role="doc-pagebreak">32</div>
Example 3 — Pagebreak inline in a paragraph
<p> … the <span id="pg159" role="doc-pagebreak" aria-label="159"/>
   interregnum period was characterized by …</p>

Relation to ARIA

doc-pagebreak inherits its semantics from the separator role.

Usage

doc-pagebreak is typically used on hr, div and span elements. The page number must be clearly expressed either in an aria-label attribute or as the text content of the element. While using a prefix like "page" or "pg" is common in the id for the element, do not include such prefixes in the label (i.e., the label should only include a number unless the source also includes a prefix).

For a simplified list of all the elements the role is allowed on, refer to the mapping table in the EPUB Type to ARIA Role Authoring Guide. For the official list of allowed elements, refer to ARIA in HTML.

Related Links