NavDocument¶

A representation of the Navigation Document.

Basically, it is a collection of <nav> (NavElement) objects.

class yael.navdocument.NavDocument(internal_path=None, obj=None, string=None)[source]¶

Build the Navigation Document or parse it from obj or string.

add_nav(nav)[source]¶

Add the given <nav> to this Navigation Document.

Parameters:	nav (`yael.navelement.NavElement`) – the <nav> to be added

landmarks¶

The landmarks <nav> element (None if not found).

Return type:	`yael.navelement.NavElement`

nav_by_epub_type(v_epub_type)[source]¶

Return the <nav> child with given epub:type.

Parameters:	v_epub_type (str) – the desired epub:type
Returns:	the child with given epub:type, or None if not found
Return type:	`yael.navelement.NavElement`

nav_by_id(v_id)[source]¶

Return the <nav> child with given id.

Parameters:	v_id (str) – the desired id
Returns:	the child with given id, or None if not found
Return type:	`yael.navelement.NavElement`

navs¶

The list of <nav> objects in this Navigation Document.

Return type:	list of `yael.navelement.NavElement` objects

page_list¶

The page-list <nav> element (None if not found).

Return type:	`yael.navelement.NavElement`

toc¶

The toc <nav> element (None if not found).

Return type:	`yael.navelement.NavElement`