OPFGuide

An OPF <guide> element.

class yael.opfguide.OPFGuide(internal_path=None, obj=None, string=None)[source]

Build an OPF <guide> element or parse it from obj or string.

add_reference(reference)[source]

Add the given <reference> (OPFReference) to the guide.

Parameters:reference (yael.opfreference.OPFReference) – the <reference> (OPFReference) to be added
reference_by_id(v_id)[source]

Return the <reference> 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.opfreference.OPFReference
reference_by_type(v_type)[source]

Return the <reference> child with given type.

Parameters:v_type (str) – the desired type
Returns:the child with given type, or None if not found
Return type:yael.opfreference.OPFReference
references

The children elements in this guide.

Return type:list of yael.opfreference.OPFReference objects
v_id

The value of the id attribute.

Return type:str