1LaTeXML::Pre::BibTeX(3)User Contributed Perl DocumentatioLnaTeXML::Pre::BibTeX(3)
2
3
4

NAME

6       "LaTeXML::Pre::BibTeX" - implements a BibTeX parser for LaTeXML.
7

DESCRIPTION

9       "LaTeXML::Pre::BibTeX" serves as a low-level parser of BibTeX database
10       files.  It parses and stores a "LaTeXML::Pre::BibTeX::Entry" for each
11       entry into the current STATE.  BibTeX "string" macros are substituted
12       into the field values, but no other processing of the data is done.
13       See "LaTeXML::Package::BibTeX.pool.ltxml" for how further processing is
14       carried out, and can be customized.
15
16   Creating a BibTeX
17       "my $bib = LaTeXML::Pre::BibTeX->newFromFile($bibname);"
18           Creates a "LaTeXML::Pre::BibTeX" object representing a bibliography
19           from a BibTeX database file.
20
21       "my $bib = LaTeXML::Pre::BibTeX->newFromString($string);"
22           Creates a "LaTeXML::Pre::BibTeX" object representing a bibliography
23           from a string containing the BibTeX data.
24
25   Methods
26       "$string = $bib->toTeX;"
27           Returns a string containing the TeX code to be digested by a
28           LaTeXML object to process the bibliography.  The string contains
29           all @PREAMBLE data and invocations of "\\ProcessBibTeXEntry{$key}"
30           for each bibliographic entry. The $key can be used to lookup the
31           data from $STATE as LookupValue('BIBITEM@'.$key).  See
32           "BibTeX.pool" for how the processing is carried out.
33
34   BibEntry objects
35       The representation of a BibTeX entry.
36
37       "$type = $bibentry->getType;"
38           Returns a string naming the entry type of the entry (No aliasing is
39           done here).
40
41       "$key = $bibentry->getKey;"
42           Returns the bibliographic key for the entry.
43
44       "@fields = $bibentry->getFields;"
45           Returns a list of pairs "[$name,$value]" representing all fields,
46           in the order defined, for the entry.  Both the $name and $value are
47           strings.  Field names may be repeated, if they are in the
48           bibliography.
49
50       "$value = $bibentry->getField($name);"
51           Returns the value (or "undef") associated with the the given field
52           name. If the field was repeated in the bibliography, only the last
53           one is returned.
54

AUTHOR

56       Bruce Miller <bruce.miller@nist.gov>
57

59       Public domain software, produced as part of work done by the United
60       States Government & not subject to copyright in the US.
61
62
63
64perl v5.36.0                      2023-01-22           LaTeXML::Pre::BibTeX(3)
Impressum