summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm')
-rw-r--r--Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm263
1 files changed, 0 insertions, 263 deletions
diff --git a/Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm b/Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm
deleted file mode 100644
index c91647d5544..00000000000
--- a/Master/texmf-dist/doc/support/bibtexperllibs/BibTeXParserEntry.3pm
+++ /dev/null
@@ -1,263 +0,0 @@
-.\" 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.