1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "BibTeX::Parser::Entry 3"
.TH BibTeX::Parser::Entry 3 "2017-12-09" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
BibTeX::Parser::Entry \- Contains a single entry of a BibTeX document.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This class ist a wrapper for a single BibTeX entry. It is usually created
by a BibTeX::Parser.
.PP
.Vb 1
\& use BibTeX::Parser::Entry;
\&
\& my $entry = BibTeX::Parser::Entry\->new($type, $key, $parse_ok, \e%fields);
\&
\& if ($entry\->parse_ok) {
\& my $type = $entry\->type;
\& my $key = $enty\->key;
\& print $entry\->field("title");
\& my @authors = $entry\->author;
\& my @editors = $entry\->editor;
\&
\& ...
\&
\& print $entry\->to_string;
\& }
.Ve
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "new"
.IX Subsection "new"
Create new entry.
.SS "parse_ok"
.IX Subsection "parse_ok"
If the entry was correctly parsed, this method returns a true value, false otherwise.
.SS "error"
.IX Subsection "error"
Return the error message, if the entry could not be parsed or undef otherwise.
.SS "type"
.IX Subsection "type"
Get or set the type of the entry, eg. '\s-1ARTICLE\s0' or '\s-1BOOK\s0'. Return value is
always uppercase.
.SS "key"
.IX Subsection "key"
Get or set the reference key of the entry.
.ie n .SS "field($name [, $value])"
.el .SS "field($name [, \f(CW$value\fP])"
.IX Subsection "field($name [, $value])"
Get or set the contents of a field. The first parameter is the name of the
field, the second (optional) value is the new value.
.SS "cleaned_field($name)"
.IX Subsection "cleaned_field($name)"
Retrieve the contents of a field in a format that is cleaned of TeX markup.
.SS "cleaned_author"
.IX Subsection "cleaned_author"
Get an array of BibTeX::Parser::Author objects for the authors of this
entry. Each name has been cleaned of accents and braces.
.SS "cleaned_editor"
.IX Subsection "cleaned_editor"
Get an array of BibTeX::Parser::Author objects for the editors of this
entry. Each name has been cleaned of accents and braces.
.SS "author([@authors])"
.IX Subsection "author([@authors])"
Get or set the authors. Returns an array of BibTeX::Author
objects. The parameters can either be BibTeX::Author objects
or strings.
.PP
Note: You can also change the authors with \f(CW$entry\fR\->field('author', \f(CW$authors_string\fR)
.SS "editor([@editors])"
.IX Subsection "editor([@editors])"
Get or set the editors. Returns an array of BibTeX::Author
objects. The parameters can either be BibTeX::Author objects
or strings.
.PP
Note: You can also change the authors with \f(CW$entry\fR\->field('editor', \f(CW$editors_string\fR)
.SS "fieldlist ()"
.IX Subsection "fieldlist ()"
Returns a list of all the fields used in this entry.
.SS "has($fieldname)"
.IX Subsection "has($fieldname)"
Returns a true value if this entry has a value for \f(CW$fieldname\fR.
.SS "pre ()"
.IX Subsection "pre ()"
Return the text in BibTeX file before the entry
.SS "raw_bibtex ()"
.IX Subsection "raw_bibtex ()"
Return raw BibTeX entry (if available).
.SS "to_string ([options])"
.IX Subsection "to_string ([options])"
Returns a text of the BibTeX entry in BibTeX format. Options are
a hash.
.ie n .IP """canonize_names""" 4
.el .IP "\f(CWcanonize_names\fR" 4
.IX Item "canonize_names"
If true (the default), authors' and editors'
names are translated into canonical bibtex form. The command
\&\f(CW\*(C`$entry\->to_string(canonize_names=>0)\*(C'\fR overrides this behavior.
.ie n .IP """field_capitalization""" 4
.el .IP "\f(CWfield_capitalization\fR" 4
.IX Item "field_capitalization"
Capitalization of the field names.
Can take values 'Uppercase', 'Lowercase' (the default) or 'Titlecase'
.ie n .IP """print_pre""" 4
.el .IP "\f(CWprint_pre\fR" 4
.IX Item "print_pre"
False by default. If true, the text in the Bib file before the
entry is printed. Note that at present we assume the text
before the entry \s-1NEVER\s0 has the @ symbol inside
.ie n .IP """type_capitalization""" 4
.el .IP "\f(CWtype_capitalization\fR" 4
.IX Item "type_capitalization"
Capitalization of the type names.
Can take values 'Uppercase' (the default), 'Lowercase' or 'Titlecase'
.SH "VERSION"
.IX Header "VERSION"
version 1.01
.SH "AUTHOR"
.IX Header "AUTHOR"
Gerhard Gossen <gerhard.gossen@googlemail.com> and
Boris Veytsman <boris@varphi.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013\-2016 by Gerhard Gossen and Boris Veytsman
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
