NAME
EBook::EPUB::Guide
SYNOPSIS
Class that represents guide element of OPF document
DESCRIPTION
The guide element identifies fundamental structural components of the publication, to enable Reading Systems to provide convenient access to them.
The structural components of the books are listed in reference elements contained within the guide element. These components could refer to the table of contents, list of illustrations, foreword, bibliography, and many other standard parts of the book. Reading Systems are not required to use the guide element in any way.
See section 2.6 of OPF specification
SUBROUTINES/METHODS
- add_reference(%opts)
-
Add reference to guide element. %opts is an anonymous hash, for possible key values see EBook::EPUB::Guide::Reference
- all_references()
-
Returns array of EBook::EPUB::Guide::Reference objects, current content of guide element
- encode($xmlwriter)
-
Encode object to XML form using XML::Writer instance
- new()
-
Create new object
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.
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.