--- name: "Biber::SortList" section: "3pm" platform: "linux" package: "biber" version: "2.7-2" release: "Debian 9 (Stretch)" platforms: ["linux"] url: "https://new.carta.tech/Biber::SortList" --- # Biber::SortList(3pm) Biber::SortList objects ## 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, `""` Philip Kime `""` ## BUGS Please report any bugs or feature requests on our Github tracker at \. ## 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.