Rendition

An abstract Rendition, holding:

  1. the Package Document (required)
  2. the Navigation Document (required in EPUB 3)
  3. the NCX TOC (EPUB 2, optional in EPUB 3)
  4. the Media Overlay Documents (optional in EPUB 3)
  5. the Multiple Rendition rendition:* properties (optional in EPUB 3)
class yael.rendition.Rendition(internal_path=None, obj=None, string=None)[source]

Build an abstract Rendition or parse it from obj or string.

add_mo_document(mo_document)[source]

Add the given Media Overlay Document to this Rendition.

Parameters:mo_document (yael.modocument.MODocument) – the Media Overlay Document to be added
landmarks

The landmarks <nav> associated with this Rendition, or None if not present.

Return type:yael.navelement.NavElement
mo_documents

The Media Overlay Documents associated with this Rendition.

Return type:list of yael.modocument.MODocument objects
nav_document

The Navigation Document associated with this Rendition, or None if not present.

Return type:yael.navdocument.NavDocument
ncx_toc

The NCX TOC associated with this Rendition, or None if not present.

Return type:yael.ncxtoc.NCXToc
pac_document

The Package Document associated with this Rendition, or None if not present.

Return type:yael.pacdocument.PacDocument
toc

The TOC associated with this Rendition.

If the Rendition belongs to an EPUB 3 publication, return the <nav> TOC in the Navigation Document.

If the Rendition belongs to an EPUB 2 publication, return the NCX TOC.

If not present, return None.

Return type:yael.navelement.NavElement or yael.ncxtoc.NCXToc
v_full_path

The value of the full-path attribute.

Return type:str
v_media_type

The value of the media-type attribute.

Return type:str
v_rendition_accessmode

The value of the rendition:accessMode attribute.

Return type:str
v_rendition_label

The value of the rendition:label attribute.

Return type:str
v_rendition_language

The value of the rendition:language attribute.

Return type:str
v_rendition_layout

The value of the rendition:layout attribute.

Return type:str
v_rendition_media

The value of the rendition:media attribute.

Return type:str