1EBook::EPUB::NCX(3)   User Contributed Perl Documentation  EBook::EPUB::NCX(3)
2
3
4

NAME

6       EBook::EPUB::NCX
7

SYNOPSIS

9       Class that "Navigation Center eXtended" file of OPF document
10

DESCRIPTION

12       The Navigation Control file for XML applications (NCX) exposes the
13       hierarchical structure of a Publication to allow the user to navigate
14       through it. The NCX is similar to a table of contents in that it
15       enables the reader to jump directly to any of the major structural
16       elements of the document, i.e. part, chapter, or section, but it will
17       often contain more elements of the document than the publisher chooses
18       to include in the original print table of contents. It can be
19       visualized as a collapsible tree familiar to PC users.
20

SUBROUTINES/METHODS

22       add_navpoint(%opts)
23           Add refrence to an OPS Content Document that is a part of
24           publication. %opts is an anonymous hash, for possible key values
25           see EBook::EPUB::NCX::NavPoint.  Method returns created
26           EBook::EPUB::NCX::NavPoint object that could be used later for
27           adding subsections.
28
29       all_navpoints()
30           Returns array of EBook::EPUB::NCX::NavPoint objects, current
31           content of NCX
32
33       add_author([$author)
34           Add $author to authors list
35
36       new(%opts)
37           Create new object. %opts is anonymous hash with possible key
38           values:
39               author
40               title
41               uid
42
43       title([$title)
44           Get/set book title
45
46       to_xml()
47           Returns XML representation of NCX
48
49       uid([$uid)
50           Get/set unique identfier for book
51

AUTHOR

53       Oleksandr Tymoshenko, <gonzo@bluezbox.com>
54

BUGS

56       Please report any bugs or feature requests to  <gonzo@bluezbox.com>
57

59       Copyright 2009, 2010 Oleksandr Tymoshenko.
60
61       <http://bluezbox.com>
62
63       This module is free software; you can redistribute it and/or modify it
64       under the terms of the BSD license. See the LICENSE file included with
65       this distribution.
66
67
68
69perl v5.12.1                      2010-07-15               EBook::EPUB::NCX(3)
Impressum