1EBook::EPUB::Guide(3) User Contributed Perl DocumentationEBook::EPUB::Guide(3)
2
3
4

NAME

6       EBook::EPUB::Guide
7

SYNOPSIS

9       Class that represents guide element of OPF document
10

DESCRIPTION

12       The guide element identifies fundamental structural components of the
13       publication, to enable Reading Systems to provide convenient access to
14       them.
15
16       The structural components of the books are listed in reference elements
17       contained within the guide element. These components could refer to the
18       table of contents, list of illustrations, foreword, bibliography, and
19       many other standard parts of the book. Reading Systems are not required
20       to use the guide element in any way.
21
22       See section 2.6 of OPF specification
23

SUBROUTINES/METHODS

25       add_reference(%opts)
26           Add reference to guide element. %opts is an anonymous hash, for
27           possible key values see EBook::EPUB::Guide::Reference
28
29       all_references()
30           Returns array of EBook::EPUB::Guide::Reference objects, current
31           content of guide element
32
33       encode($xmlwriter)
34           Encode object to XML form using XML::Writer instance
35
36       new()
37           Create new object
38

AUTHOR

40       Oleksandr Tymoshenko, <gonzo@bluezbox.com>
41

BUGS

43       Please report any bugs or feature requests to  <gonzo@bluezbox.com>
44

46       Copyright 2009, 2010 Oleksandr Tymoshenko.
47
48       <http://bluezbox.com>
49
50       This module is free software; you can redistribute it and/or modify it
51       under the terms of the BSD license. See the LICENSE file included with
52       this distribution.
53
54
55
56perl v5.12.1                      2010-01-21             EBook::EPUB::Guide(3)
Impressum