1EBook::EPUB::Metadata(3U)ser Contributed Perl DocumentatiEoBnook::EPUB::Metadata(3)
2
3
4
6 EBook::EPUB::Metadata
7
9 Class that represents metadata element of OPF document. Provides
10 information about the publication as a whole
11
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_coverage($coverage)
36 The extent or scope of the content of the resource.
37
38 add_date($date, [$event])
39 Date of publication, in the format defined by "Date and Time
40 Formats" at http://www.w3.org/TR/NOTE-datetime and by ISO 8601 on
41 which it is based. In particular, dates without times are
42 represented in the form YYYY[-MM[-DD]]: a required 4-digit year, an
43 optional 2-digit month, and if the month is given, an optional
44 2-digit day of month. $event is an optional description of event
45 that date refers to. Possible values may include: creation,
46 publication, and modification.
47
48 add_description($description)
49 Add description of the publication content
50
51 add_identifier($ident, [$scheme])
52 Add unique identifier of the publication. $scheme is an optional
53 paramater to specify identification system of this particular
54 identifier. e.g. ISBN, DOI
55
56 add_meta_item($name, $value)
57 Add metadata item that does not belong to Dublin Core
58 specification. Metadata is set by simple name/value pair.
59
60 add_format($format)
61 The media type or dimensions of the resource. Best practice is to
62 use a value from a controlled vocabulary (e.g. MIME media types).
63
64 add_language($lang)
65 Add language of the content of the publication. $lang must comply
66 with RFC 3066 (see http://www.ietf.org/rfc/rfc3066.txt)
67
68 add_publisher($publisher)
69 An entity responsible for making the resource available
70
71 add_relation($relation)
72 An identifier of an auxiliary resource and its relationship to the
73 publication.
74
75 add_rights($rights)
76 A statement about rights, or a reference to one. In this
77 specification, the copyright notice and any further rights
78 description should appear directly.
79
80 add_source($source)
81 Information regarding a prior resource from which the publication
82 was derived
83
84 add_subject($subject)
85 Add subject of the publication
86
87 add_title($title)
88 Add title of the publication
89
90 add_translator($name, [$formal_name])
91 Add translator of the document. $name is in human-readable form,
92 e.g. "Arthur Conan Doyle", $formal_name is in form, suitable for
93 machine processing, e.g. "Doyle, Arthur Conan"
94
95 add_type($type)
96 type includes terms describing general categories, functions,
97 genres, or aggregation levels for content. The advised best
98 practice is to select a value from a controlled vocabulary.
99
101 Oleksandr Tymoshenko, <gonzo@bluezbox.com>
102
104 Please report any bugs or feature requests to <gonzo@bluezbox.com>
105
107 Copyright 2009, 2010 Oleksandr Tymoshenko.
108
109 <http://bluezbox.com>
110
111 This module is free software; you can redistribute it and/or modify it
112 under the terms of the BSD license. See the LICENSE file included with
113 this distribution.
114
115
116
117perl v5.30.1 2020-01-29 EBook::EPUB::Metadata(3)