This version (2014/04/14 11:52) is a draft.
Approvals: 0/1

Hierarchy classifier

Classifier for generating a hierarchical classification. This may be based on structured metadata, or may use a supplementary structure file (use the -hfile option).

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

OptionDescriptionValue
Hierarchy Options
separator Regular expression used for the separator, if using structured metadata. Default: [\\\/|\\\|]
suppresslastlevel Ignore the final part of the metadata value. This is useful for metadata where each value is unique, such as file paths.
suppressfirstlevel Ignore the first part of the metadata value. This is useful for metadata where the first element is common, such as the import directory in gsdlsourcefilename.
Options Inherited from HFileHierarchy
metadata (REQUIRED) A single metadata field, or a comma separated list of metadata fields, used for classification. If a list is specified, the first metadata type that has values will be used. May be used in conjunction with the -firstvalueonly and -allvalues flags, to select only the first value, or all metadata values from the list.
firstvalueonly Use only the first metadata value found.
allvalues Use all metadata values found.
hfile Use the specified classification structure file.
sort Metadata field to sort leaf nodes by. Leaves will not be sorted if not specified.
reverse_sort Sort leaf nodes in reverse order (use with -sort).
hlist_at_top Display the first level of the classification horizontally.
documents_last Display document nodes after classifier nodes.
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