Changeset 33478

Timestamp:

2019-09-16T14:54:52+12:00 (5 years ago)

Author:

kjdon

Message:

some refining of list option descriptions

File:

• main/trunk/greenstone2/perllib/strings.properties (modified) (4 diffs)

main/trunk/greenstone2/perllib/strings.properties

@@ -648 +648 @@
 List.desc:A general and flexible list classifier with most of the abilities of AZCompactList, but with better Unicode, metadata and sorting capabilities.
 
-List.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' or ',' to separate metadata fields within each level.
+List.metadata:Metadata fields used for classification. Use '/' to separate the levels in the hierarchy and ';' or ',' to separate a list of metadata fields within each level.
 List.metadata_selection_mode_within_level:Determines how many metadata values the document is classified by, within each level. Use '/' to separate the levels.
 List.metadata_selection.firstvalue:Only classify by a single metadata value, the first one encountered.
@@ -658 +658 @@
 List.metadata_sort.alphanumeric:Sort using a more natural sort, where digits are treated as numbers and sorted numerically. E.g. 10 would sort after 9.
 
-List.bookshelf_type:Controls when to create bookshelves
+List.bookshelf_type:Controls when to create bookshelves. This only applies to the last level. Other levels will get bookshelf_type = always.  
 List.bookshelf_type.always:Create a bookshelf icon even if there is only one item in each group at the leaf nodes.
 List.bookshelf_type.never:Never create a bookshelf icon even if there is more than one item in each group at the leaf nodes.
@@ -671 +671 @@
 List.level_partition.per_digit:Create a partition for each digit 0-9.
 List.level_partition.per_number:Create a partition for each number. Control how many digits are used to create numbers using the -numeric_partition_name_length_within_level option.
-List.level_partition.single:Create a single partition 0-9 for all values that start with digits.
+List.level_partition.single:Create a single partition '0-9' for all values that start with digits.
 List.level_partition.constant_size:Create partitions with constant size.
 List.level_partition.approximate_size:Create a partition per letter, then group or split the letters to get approximately the same sized partitions. 
 List.level_partition.approximate_size_numeric:Create a partition per number (using -numeric_partition_name_length_within_level to determine how many digits to include in the number), then group or split the partitions to get approximately the same sized partitions. 
-
+List.level_partition.all_values:Create a partition for each metadata value.
 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 '/'.
 List.numeric_partition_size_within_level:The number of items in each numeric partition (only applies when -numeric_partition_type_within_level is set to 'constant_size' or 'approximate_size'). Can be specified for each level. Separate levels by '/'.
@@ -682 +682 @@
 List.partition_sort_mode_within_level:How to sort the values of metadata to create the partitions.
 List.numeric_partition_sort_mode_within_level:How to sort the values of numeric metadata to create the numeric partitions.
-List.numbers_first:Sort the numbers to the start of the list (by default, metadata values starting with numbers are sorted at the end).
-List.sort_leaf_nodes_using:Metadata fields used for sorting the leaf nodes (i.e. those documents in a bookshelf). Use '|' to separate the metadata groups to stable sort and ';' to separate metadata fields within each group.
+List.numbers_first:Sort the numbers to the start of the list. (By default, metadata values starting with numbers are sorted at the end).
+List.sort_leaf_nodes_using:Metadata fields used for sorting the leaf nodes (i.e. those documents in a bookshelf). Use '|' to separate the metadata groups to sort by, and ';' or ',' to separate metadata fields within each group. For example, "dc.Title,Title|Date" will result in a list sorted by Titles (coming from either dc.Title or Title), with those documents having the same Title sorted by Date.
 List.sort_leaf_nodes_sort_mode:How to sort the leaf node metadata fields.
 List.reverse_sort_leaf_nodes:Sort the leaf documents in reverse order.