1EBook::EPUB::Metadata(3U)ser Contributed Perl DocumentatiEoBnook::EPUB::Metadata(3)
2
3
4

NAME

6       EBook::EPUB::Metadata
7

SYNOPSIS

9       Class that represents metadata element of OPF document. Provides
10       information about the publication as a whole
11

SUBROUTINES/METHODS

13       new()
14           Create new object
15
16       encode($xmlwriter)
17           Encode object to XML form using XML::Writer instance
18
19       add_author($name, [$formal_name])
20           Add author of the document. For details see add_contributor.
21
22       add_creator($name, [fileas => $formal_name, role => $role])
23           Add primary creator or author of the publication of the
24           publication. See add_contributor for details
25
26       add_contributor($name, [fileas => $formal_name, role =>])
27           Add person/organization that contributed to publication. $name is
28           the name in human-readable form, e.g. "Arthur Conan Doyle",
29           $formal_name is in form, suitable for machine processing, e.g.
30           "Doyle, Arthur Conan". $role reflects kind of contribution to
31           document. See Section 2.2.6 of OPF specification for list of
32           possible values
33           <http://www.idpf.org/2007/opf/OPF_2.0_final_spec.html#Section2.2.6>
34
35       add_date($date, [$event])
36           Date of publication, in the format defined by "Date and Time
37           Formats" at http://www.w3.org/TR/NOTE-datetime and by ISO 8601 on
38           which it is based. In particular, dates without times are
39           represented in the form YYYY[-MM[-DD]]: a required 4-digit year, an
40           optional 2-digit month, and if the month is given, an optional
41           2-digit day of month. $event is an optional description of event
42           that date refers to. Possible values may include: creation,
43           publication, and modification.
44
45       add_description($description)
46           Add description of the publication content
47
48       add_identifier($ident, [$scheme])
49           Add unique identifier of the publication. $scheme is an optional
50           paramater to specify identification system of this particular
51           identifier. e.g. ISBN, DOI
52
53       add_meta_item($name, $value)
54           Add metadata item that does not belong to Dublin Core
55           specification. Metadata is set by simple name/value pair.
56
57       add_format($format)
58           The media type or dimensions of the resource. Best practice is to
59           use a value from a controlled vocabulary (e.g. MIME media types).
60
61       add_language($lang)
62           Add language of the content of the publication. $lang must comply
63           with RFC 3066 (see http://www.ietf.org/rfc/rfc3066.txt)
64
65       add_relation($relation)
66           An identifier of an auxiliary resource and its relationship to the
67           publication.
68
69       add_rights($rights)
70           A statement about rights, or a reference to one. In this
71           specification, the copyright notice and any further rights
72           description should appear directly.
73
74       add_source($source)
75           Information regarding a prior resource from which the publication
76           was derived
77
78       add_subject($subject)
79           Add subject of the publication
80
81       add_title($title)
82           Add title of the publication
83
84       add_translator($name, [$formal_name])
85           Add translator of the document. $name is in human-readable form,
86           e.g. "Arthur Conan Doyle", $formal_name is in form, suitable for
87           machine processing, e.g.  "Doyle, Arthur Conan"
88
89       add_type($type)
90           type includes terms describing general categories, functions,
91           genres, or aggregation levels for content. The advised best
92           practice is to select a value from a controlled vocabulary.
93

AUTHOR

95       Oleksandr Tymoshenko, <gonzo@bluezbox.com>
96

BUGS

98       Please report any bugs or feature requests to  <gonzo@bluezbox.com>
99

101       Copyright 2009, 2010 Oleksandr Tymoshenko.
102
103       <http://bluezbox.com>
104
105       This module is free software; you can redistribute it and/or modify it
106       under the terms of the BSD license. See the LICENSE file included with
107       this distribution.
108
109
110
111perl v5.12.1                      2010-08-18          EBook::EPUB::Metadata(3)
Impressum