EBook::EPUB::NCX(3) User Contributed Perl Documentation EBook::EPUB::NCX(3)NAMEEBook::EPUB::NCXSYNOPSIS
Class that "Navigation Center eXtended" file of OPF document
DESCRIPTION
The Navigation Control file for XML applications (NCX) exposes the
hierarchical structure of a Publication to allow the user to navigate
through it. The NCX is similar to a table of contents in that it
enables the reader to jump directly to any of the major structural
elements of the document, i.e. part, chapter, or section, but it will
often contain more elements of the document than the publisher chooses
to include in the original print table of contents. It can be
visualized as a collapsible tree familiar to PC users.
SUBROUTINES/METHODS
add_navpoint(%opts)
Add refrence to an OPS Content Document that is a part of
publication. %opts is an anonymous hash, for possible key values
see EBook::EPUB::NCX::NavPoint. Method returns created
EBook::EPUB::NCX::NavPoint object that could be used later for
adding subsections.
all_navpoints()
Returns array of EBook::EPUB::NCX::NavPoint objects, current
content of NCX
add_author([$author)
Add $author to authors list
new(%opts)
Create new object. %opts is anonymous hash with possible key
values:
author
title
uid
title([$title)
Get/set book title
to_xml()
Returns XML representation of NCX
uid([$uid)
Get/set unique identfier for book
AUTHOR
Oleksandr Tymoshenko, <gonzo@bluezbox.com>
BUGS
Please report any bugs or feature requests to <gonzo@bluezbox.com>
LICENSE AND COPYRIGHT
Copyright 2009, 2010 Oleksandr Tymoshenko.
<http://bluezbox.com>
This module is free software; you can redistribute it and/or modify it
under the terms of the BSD license. See the LICENSE file included with
this distribution.
perl v5.14.1 2010-07-15 EBook::EPUB::NCX(3)
