epublib.nav.util module

class PageBreakData(filename: str, label: str = '')

Bases: object

Data for a page break.

Parameters:

  • filename – The filename (and optional fragment) of the page break.

  • page – The page number.

  • label – The label to use for the page in the page list. If not given, the page number will be used as label.

class TOCEntryData(
filename: str,
label: str,
id: str | None = None,
children: list[~epublib.nav.util.TOCEntryData] = <factory>,
)

Bases: object

Data for a table of contents entry.

Parameters:

  • filename – The filename (and optional fragment) of the entry.

  • label – The label to use for the entry in the table of contents.

  • id – An optional identifier for the entry.

  • children – A list of child entries. Defaults to an empty list.

class LandmarkEntryData(filename: str, label: str, epub_type: str)

Bases: object

Represents a landmark, a special navigation point in an EPUB file.

Parameters:

  • filename – The filename (and optional fragment) of the landmark.

  • label – The label to use for the landmark.

  • epub_type – The EPUB type of the landmark, e.g. “toc” or “cover”.