epub4kmp-core/io.documentnode.epub4kmp.epub/NCXDocument

NCXDocument

object NCXDocument(source)

Reads and writes the NCX (Navigation Control file for XML) document defined by namespace http://www.daisy.org/z3986/2005/ncx/.

Properties

DEFAULT_NCX_HREF

const val DEFAULT_NCX_HREF: String

const val NAMESPACE_NCX: String

const val NCX_ITEM_ID: String

const val PREFIX_DTB: String

const val PREFIX_NCX: String

Functions

createNCXResource

fun createNCXResource(book: Book): Resource

Builds an NCX Resource containing the table of contents for book.

fun createNCXResource(identifiers: List<Identifier>, title: String, authors: List<Author>, tableOfContents: TableOfContents): Resource

fun read(book: Book, epubReader: EpubReader): Resource?

readTOCReference

fun readTOCReference(navpointElement: Element, book: Book): TOCReference

fun write(writer: XmlWriter, book: Book)

fun write(writer: XmlWriter, identifiers: List<Identifier>, title: String, authors: List<Author>, tableOfContents: TableOfContents)