EBook::EPUB::Metadata(User Contributed Perl DocumentatEBook::EPUB::Metadata(3)NAMEEBook::EPUB::MetadataSYNOPSIS
Class that represents metadata element of OPF document. Provides
information about the publication as a whole
SUBROUTINES/METHODS
new()
Create new object
encode($xmlwriter)
Encode object to XML form using XML::Writer instance
add_author($name, [$formal_name])
Add author of the document. For details see add_contributor.
add_creator($name, [fileas => $formal_name, role => $role])
Add primary creator or author of the publication of the
publication. See add_contributor for details
add_contributor($name, [fileas => $formal_name, role =>])
Add person/organization that contributed to publication. $name is
the name in human-readable form, e.g. "Arthur Conan Doyle",
$formal_name is in form, suitable for machine processing, e.g.
"Doyle, Arthur Conan". $role reflects kind of contribution to
document. See Section 2.2.6 of OPF specification for list of
possible values
<http://www.idpf.org/2007/opf/OPF_2.0_final_spec.html#Section2.2.6>
add_date($date, [$event])
Date of publication, in the format defined by "Date and Time
Formats" at http://www.w3.org/TR/NOTE-datetime and by ISO 8601 on
which it is based. In particular, dates without times are
represented in the form YYYY[-MM[-DD]]: a required 4-digit year, an
optional 2-digit month, and if the month is given, an optional
2-digit day of month. $event is an optional description of event
that date refers to. Possible values may include: creation,
publication, and modification.
add_description($description)
Add description of the publication content
add_identifier($ident, [$scheme])
Add unique identifier of the publication. $scheme is an optional
paramater to specify identification system of this particular
identifier. e.g. ISBN, DOI
add_meta_item($name, $value)
Add metadata item that does not belong to Dublin Core
specification. Metadata is set by simple name/value pair.
add_format($format)
The media type or dimensions of the resource. Best practice is to
use a value from a controlled vocabulary (e.g. MIME media types).
add_language($lang)
Add language of the content of the publication. $lang must comply
with RFC 3066 (see http://www.ietf.org/rfc/rfc3066.txt)
add_relation($relation)
An identifier of an auxiliary resource and its relationship to the
publication.
add_rights($rights)
A statement about rights, or a reference to one. In this
specification, the copyright notice and any further rights
description should appear directly.
add_source($source)
Information regarding a prior resource from which the publication
was derived
add_subject($subject)
Add subject of the publication
add_title($title)
Add title of the publication
add_translator($name, [$formal_name])
Add translator of the document. $name is in human-readable form,
e.g. "Arthur Conan Doyle", $formal_name is in form, suitable for
machine processing, e.g. "Doyle, Arthur Conan"
add_type($type)
type includes terms describing general categories, functions,
genres, or aggregation levels for content. The advised best
practice is to select a value from a controlled vocabulary.
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-08-18 EBook::EPUB::Metadata(3)
