latexml::bib(3pm) [debian man page]

LaTeXML::Bib(3pm)					User Contributed Perl Documentation					 LaTeXML::Bib(3pm)

NAME

       "LaTeXML::Bib" - implements a BibTeX parser for LaTeXML.

DESCRIPTION

       "LaTeXML::Bib" serves as a low-level parser of BibTeX database files.  It parses and stores a "LaTeXML::Bib::BibEntry" for each entry into
       the current STATE.  BibTeX "string" macros are substituted into the field values, but no other processing of the data is done.  See
       "LaTeXML::Package::BibTeX.pool.ltxml" for how further processing is carried out, and can be customized.

   Creating a Bib
       "my $bib = LaTeXML::Bib->newFromFile($bibname);"
	   Creates a "LaTeXML::Bib" object representing a bibliography from a BibTeX database file.

       "my $bib = LaTeXML::Bib->newFromString($string);"
	   Creates a "LaTeXML::Bib" object representing a bibliography from a string containing the BibTeX data.

   Methods
       "$string = $bib->toTeX;"
	   Returns a string containing the TeX code to be digested by a LaTeXML object to process the bibliography.  The string contains all
	   @PREAMBLE data and invocations of "\ProcessBibTeXEntry{$key}" for each bibliographic entry. The $key can be used to lookup the data
	   from $STATE as "LookupValue('BIBITEM@'.$key)".  See "BibTeX.pool" for how the processing is carried out.

   BibEntry objects
       The representation of a BibTeX entry.

       "$type = $bibentry->getType;"
	   Returns a string naming the entry type of the entry (No aliasing is done here).

       "$key = $bibentry->getKey;"
	   Returns the bibliographic key for the entry.

       "@fields = $bibentry->getFields;"
	   Returns a list of pairs "[$name,$value]" representing all fields, in the order defined, for the entry.  Both the $name and $value are
	   strings.  Field names may be repeated, if they are in the bibliography.

       "$value = $bibentry->getField($name);"
	   Returns the value (or "undef") associated with the the given field name. If the field was repeated in the bibliography, only the last
	   one is returned.

AUTHOR

       Bruce Miller <bruce.miller@nist.gov>

COPYRIGHT

       Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.

perl v5.10.1							    2009-06-11							 LaTeXML::Bib(3pm)

LaTeXML::Parameters(3pm)				User Contributed Perl Documentation				  LaTeXML::Parameters(3pm)

NAME

       "LaTeXML::Parameters" - formal parameters, including "LaTeXML::Parameter".

DESCRIPTION

       Provides a representation for the formal parameters of LaTeXML::Definitions:

       "LaTeXML::Parameter"
	   represents an individual parameter.

   Parameters Methods
       "$parameters = parseParameters($prototype,$for);"
	   Parses a string for a sequence of parameter specifications.	Each specification should be of the form

	    {}	   reads a regular TeX argument, a sequence of
		   tokens delimited by braces, or a single token.
	    {spec} reads a regular TeX argument, then reparses it
		   to match the given spec. The spec is parsed
		   recursively, but usually should correspond to
		   a single argument.
	    [spec] reads an LaTeX-style optional argument. If the
		   spec is of the form Default:stuff, then stuff
		   would be the default value.
	    Type   Reads an argument of the given type, where either
		   Type has been declared, or there exists a ReadType
		   function accessible from LaTeXML::Package::Pool.
	    Type:value, or Type:value1:value2...    These forms
		   pass additional Tokens to the reader function.
	    OptionalType  Similar to Type, but it is not considered
		   an error if the reader returns undef.
	    SkipType  Similar to OptionalType, but the value returned
		   from the reader is ignored, and does not occupy a
		   position in the arguments list.

       "@parameters = $parameters->getParameters;"
	   Return the list of "LaTeXML::Parameter" contained in $parameters.

       "@tokens = $parameters->revertArguments(@args);"
	   Return a list of LaTeXML::Token that would represent the arguments such that they can be parsed by the Gullet.

       "@args = $parameters->readArguments($gullet,$fordefn);"
	   Read the arguments according to this $parameters from the $gullet.  This takes into account any special forms of arguments, such as
	   optional, delimited, etc.

       "@args = $parameters->readArgumentsAndDigest($stomach,$fordefn);"
	   Reads and digests the arguments according to this $parameters, in sequence.	this method is used by Constructors.

AUTHOR

       Bruce Miller <bruce.miller@nist.gov>

COPYRIGHT

       Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.

perl v5.10.1							    2009-06-11						  LaTeXML::Parameters(3pm)