Biber::SortList (3)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Biber::SortList.3pm".)

NAME

Biber::SortList - Biber::SortList objects

new

    Initialize a Biber::SortList object

set_section

    Sets the section of a sort list

get_section

    Gets the section of a sort list

set_sortschemename

    Sets the sortscheme name of a sort list

get_sortschemename

    Gets the sortschemename of a sort list

set_sortnamekeyschemename

    Sets the sortnamekeyscheme name of a sort list

get_sortnamekeyschemename

    Gets the sortnamekeyschemename of a sort list

set_sortinit_collator

    Sets the sortinit collator for this list

get_sortinit_collator

    Gets the sortinit collator for this list

get_labelprefix

    Gets the labelprefix setting of a sort list

set_labelprefix

    Sets the labelprefix setting of a sort list

set_name

    Sets the name of a sort list

get_name

    Gets the name of a sort list

set_type

    Sets the type of a sort list

get_type

    Gets the type of a section list

set_keys

    Sets the keys for the list

get_keys

    Gets the keys for the list

count_keys

    Count the keys for the list

get_listdata

    Gets all of the list metadata

set_extrayeardata_for_key

  Saves extrayear field data for a key

set_extrayeardata

    Saves extrayear field data for all keys

get_extrayeardata

    Gets the extrayear field data for a key

set_extratitledata_for_key

  Saves extratitle field data for a key

set_extratitledata

    Saves extratitle field data for all keys

get_extratitledata

    Gets the extratitle field data for a key

set_extratitleyeardata_for_key

  Saves extratitleyear field data for a key

set_extratitleyeardata

    Saves extratitleyear field data for all keys

get_extratitleyeardata

    Gets the extratitleyear field data for a key

set_extraalphadata_for_key

    Saves extraalpha field data for a key

set_extraalphadata

    Saves extraalpha field data for all keys

get_extraalphadata

    Gets the extraalpha field data for a key

get_sortdataschema

    Gets the sortdata schema for a sortlist

set_sortdataschema

    Saves the sortdata schema for a sortlist

set_sortdata

    Saves sorting data in a list for a key

get_sortdata

    Gets the sorting data in a list for a key

set_sortinitdata_for_key

 Saves sortinit data for a specific key

set_sortinitdata

 Saves sortinit data for all keys

get_sortinit_for_key

    Gets the sortinit in a list for a key

set_sortscheme

    Sets the sortscheme of a list

get_sortscheme

    Gets the sortscheme of a list

add_filter

    Adds a filter to a list object

get_filters

    Gets all filters for a list object

instantiate_entry

  Do any dynamic information replacement for information
  which varies in an entry between lists. This is information which
  needs to be output to the .bbl for an entry but which is a property
  of the sorting list and not the entry per se so it cannot be stored
  statically in the entry and must be pulled from the specific list
  when outputting the entry.

  Currently this means:

  * sortinit
  * sortinithash
  * extrayear
  * extraalpha
  * extratitle
  * extratitleyear
  * labelprefix

AUTHORS

Francois Charette, "<firmicus at ankabut.net>" Philip Kime "<philip at kime.org.uk>"

BUGS

Please report any bugs or feature requests on our Github tracker at <github.com/plk/biber/issues>.

COPYRIGHT & LICENSE

Copyright 2009-2016 Francois Charette and Philip Kime, all rights reserved.

This module is free software. You can redistribute it and/or modify it under the terms of the Artistic License 2.0.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.