text::bibtex::bibsort(3pm) [debian man page]

Text::BibTeX::BibSort(3pm)				User Contributed Perl Documentation				Text::BibTeX::BibSort(3pm)

NAME

       Text::BibTeX::BibSort - generate sort keys for bibliographic entries

SYNOPSIS

	  # Assuming $entry comes from a database of the 'Bib' structure
	  # (i.e., that it's blessed into the BibEntry class, which inherits
	  # the sort_key method from BibSort):
	  $sort_key = $entry->sort_key;

DESCRIPTION

       "Text::BibTeX::BibSort" is a base class of "Text::BibTeX::BibEntry" for generating sort keys from bibliography entries.	It could in
       principle (and, someday, might) offer a wide range of highly customizable sort-key generators.  Currently, though, it provides only a
       single method ("sort_key") for public use, and that method only pays attention to one structure option, "sortby".

METHODS

       sort_key ()
	   Generates a sort key for a single bibliographic entry.  Assumes this entry conforms to the "Bib" database structure.  The nature of
	   this sort key is controlled by the "sortby" option, which can be either "name" or "year".  (The "namestyle" also has a role, in
	   determining how author/editor names are formatted for inclusion in the sort key.)

	   For by-name sorting (which is how BibTeX's standard styles work), the sort key consists of one of the "author", "editor",
	   "organization", or "key" fields (depending on the entry type and which fields are actually present), followed by the year and the
	   title.  All fields are drastically simplified to produce the sort key: non-English letters are mercilessly anglicized, non-alphabetic
	   characters are stripped, and everything is forced to lowercase.  (The first two steps are done by the "purify_string" routine; see
	   "Generic string-processing functions" in Text::BibTeX for a brief description, and the descripton of the C function
	   "bt_purify_string()" in bt_misc for all the gory details.)

SEE ALSO

       Text::BibTeX::Structure, Text::BibTeX::Bib, Text::BibTeX::BibFormat

AUTHOR

       Greg Ward <gward@python.net>

COPYRIGHT

       Copyright (c) 1997-2000 by Gregory P. Ward.  All rights reserved.  This file is part of the Text::BibTeX library.  This library is free
       software; you may redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-06-02						Text::BibTeX::BibSort(3pm)

Check Out this Related 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)

Linux and UNIX Man Pages

text::bibtex::bibsort(3pm) [debian man page]

Check Out this Related Man Page