User Tools

Site Tools


en:classifier:list
This version is outdated by a newer approved version.DiffThis version (2014/09/04 02:05) is a draft.
Approvals: 0/1

This is an old revision of the document!


List classifier

A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.

The following table lists all of the configuration options available for List.

OptionDescriptionValue
List Options
metadata (REQUIRED) Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' to separate metadata fields within each level.
metadata_selection_mode Determines how many metadata values the document is classified by, within each level. Use '/' to separate the levels. Default: firstvalidmetadata
List
bookshelf_type Controls when to create bookshelves Default: never
List
classify_sections Classify sections instead of documents.
partition_type_within_level The type of partitioning done. Can be specified for each level. Separate levels by '/'. Default: per_letter
List
partition_size_within_level The number of items in each partition (only applies when partition_type_within_level is set to 'constant_size' or 'approximate_size'). Can be specified for each level. Separate levels by '/'.
partition_name_length The length of the partition name; defaults to a variable length from 1 up to 3 characters, depending on how many are required to distinguish the partition start from its end. This option only applies when partition_type_within_level is set to 'constant_size'.
sort_leaf_nodes_using Metadata fields used for sorting the leaf nodes. Use '|' to separate the metadata groups to stable sort and ';' to separate metadata fields within each group. Default: Title
reverse_sort_leaf_nodes Sort the leaf documents in reverse order.
sort_using_unicode_collation Sort using the Unicode Collation Algorithm. Requires http://www.unicode.org/Public/UCA/latest/allkeys.txt file to be downloaded into perl's lib/Unicode/Collate folder.
use_hlist_for Metadata fields to use a hlist rather than a vlist. Use ',' to separate the metadata groups and ';' to separate the metadata fields within each group.
filter_metadata Metadata element to test against for a document's inclusion into the classifier. Documents will be included if they define this metadata.
filter_regex Regular expression to use in the filter_metadata test. If a regex is specified, only documents with filter_metadata that matches this regex will be included.
standardize_capitalization Metadata values are lowercased for sorting into bookshelves. Set this option to use these lowercase values for bookshelf display names. Otherwise, the majority case variant will be used.
removeprefix A prefix to ignore in metadata values when sorting.
removesuffix A suffix to ignore in metadata values when sorting.
Options Inherited from BaseClassifier
buttonname The label for the classifier screen and button in navigation bar. The default is the metadata element specified with -metadata.
no_metadata_formatting Don't do any automatic metadata formatting (for sorting.)
builddir Where to put the built indexes.
outhandle The file handle to write output to. Default: STDERR
verbosity Controls the quantity of output. 0=none, 3=lots. Default: 2

metadata_selection_mode option values

ValueDescription
firstvalueOnly classify by a single metadata value, the first one encountered.
firstvalidmetadata Classify by all the metadata values of the first element in the list that has values.
allvaluesClassify by all metadata values found, from all elements in the list.

bookshelf_type option values

ValueDescription
alwaysCreate a bookshelf icon even if there is only one item in each group at the leaf nodes.
duplicate_onlyCreate a bookshelf icon only when there are more than one item in each group at the leaf nodes.
neverNever create a bookshelf icon even if there are more than one item in each group at the leaf nodes.

partition_type_within_level option values

ValueDescription
per_letterCreate a partition for each letter.
approximate_sizeCreate a partition per letter, then group or split the letters to get approximately the same sized partitions.
constant_sizeCreate partitions with constant size.
noneNone.
en/classifier/list.1409796341.txt.gz · Last modified: 2019/09/16 01:45 (external edit)