en:classifier:list
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
en:classifier:list [2014/09/04 02:05] – external edit 127.0.0.1 | en:classifier:list [2019/09/16 22:39] – kjdon | ||
---|---|---|---|
Line 5: | Line 5: | ||
The following table lists all of the configuration options available for List. | The following table lists all of the configuration options available for List. | ||
- | ^Option^Description^Value^ | + | ^Option^Description^Values^ |
^//List Options// | ^//List Options// | ||
- | | **metadata** |(REQUIRED) Metadata fields used for classification. Use '/' | + | | **metadata** |(REQUIRED) Metadata fields used for classification. Use '/' |
- | | **metadata_selection_mode** | Determines how many metadata values the document is classified by, within each level. Use '/' | + | | **metadata_selection_mode_within_level** | Determines how many metadata values the document is classified by, within each level. Use '/' |
- | | **bookshelf_type** |Controls when to create bookshelves |//Default: never//\\ [[List# | + | |**metadata_sort_mode_within_level** | How to sort the values of metadata within each partition. Use '/' |
+ | | **bookshelf_type** |Controls when to create bookshelves. This only applies to the last level. Other levels will get bookshelf_type = always. | ||
| **classify_sections** |Classify sections instead of documents. | | | | **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 '/' | + | | **partition_type_within_level** |The type of partitioning done. Can be specified for each level. Separate levels by '/' |
- | | **partition_size_within_level** |The number of items in each partition (only applies when partition_type_within_level is set to ' | + | | **partition_size_within_level** |The number of items in each partition (only applies when partition_type_within_level is set to ' |
- | | **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 ' | + | | **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 ' |
- | | **sort_leaf_nodes_using** |Metadata fields used for sorting the leaf nodes. Use < | + | |**partition_sort_mode_within_level** | How to sort the values of metadata to create the partitions. |** unicode:** Sort using the Unicode Collation Algorithm. Requires http:// |
+ | | **numeric_partition_type_within_level** |The type of partitioning done at each level, | ||
+ | | **numeric_partition_size_within_level** |The number of items in each numeric partition (only applies when numeric_partition_type_within_level is set to ' | ||
+ | | **numeric_partition_name_length** |Control how many consecutive digits are grouped to make the number for the numeric partition name. -1 implies all the digits.| //Default: -1// | | ||
+ | |**numeric_partition_sort_mode_within_level** | How to sort the values of numeric metadata to create the numeric partitions. |** unicode:** Sort using the Unicode Collation Algorithm. Requires http:// | ||
+ | |**numbers_first** | Sort the numbers to the start of the list (By default, metadata values starting with numbers are sorted at the end).| | | ||
+ | | **sort_leaf_nodes_using** |Metadata fields used for sorting the leaf nodes (i.e. those documents in a bookshelf). Use < | ||
+ | |**sort_leaf_nodes_sort_mode** | How to sort the leaf node metadata fields. | ** unicode:** Sort using the Unicode Collation Algorithm. Requires http:// | ||
| **reverse_sort_leaf_nodes** |Sort the leaf documents in reverse order. | | | | **reverse_sort_leaf_nodes** |Sort the leaf documents in reverse order. | | | ||
- | | **sort_using_unicode_collation** |Sort using the Unicode Collation Algorithm. Requires http:// | + | | **sort_using_unicode_collation** |Sort using the Unicode Collation Algorithm. Requires http:// |
- | | **use_hlist_for** |Metadata fields | + | |
| **filter_metadata** |Metadata element to test against for a document' | | **filter_metadata** |Metadata element to test against for a document' | ||
| **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. | | | | **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. | | | | **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. | | | ||
+ | | **use_formatted_metadata_for_bookshelf_display** | Metadata values are formatted for sorting (unless -no_metadata_formatting is specified). This might include lower-casing, | ||
| **removeprefix** |A prefix to ignore in metadata values when sorting. | | | | **removeprefix** |A prefix to ignore in metadata values when sorting. | | | ||
| **removesuffix** |A suffix to ignore in metadata values when sorting. | | | | **removesuffix** |A suffix to ignore in metadata values when sorting. | | | ||
Line 32: | Line 40: | ||
- | === metadata_selection_mode option values=== | ||
- | ^Value^Description^ | + | |
- | |firstvalue|Only 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. | | + | |
- | |allvalues|Classify by all metadata values found, from all elements in the list. | | + | |
- | + | ||
- | === bookshelf_type option values=== | + | |
- | ^Value^Description^ | ||
- | |always|Create a bookshelf icon even if there is only one item in each group at the leaf nodes.| | ||
- | |duplicate_only|Create a bookshelf icon only when there are more than one item in each group at the leaf nodes.| | ||
- | |never|Never 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=== | ||
- | ^Value^Description^ | ||
- | |per_letter|Create a partition for each letter.| | ||
- | |approximate_size|Create a partition per letter, then group or split the letters to get approximately the same sized partitions.| | ||
- | |constant_size|Create partitions with constant size.| | ||
- | |none|None.| | ||
en/classifier/list.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1