Display narrower terms
You can use the AU_USER_SYM_SUBSET subroutine in a complex User Symbolic to displays the narrower terms of one or more selected authority terms.
Subroutine name
AU_USER_SYM_SUBSET
Field type
Example of use
You may have multiple classification systems (taxonomic or nomenclature). This symbolic will let you show just the taxonomic classification, or just the nomenclature classification. You can then display this on your website as two different fields.
Argument syntax and parameters
The subroutine is a piece of code that uses ‘arguments’. An argument is a set of options that tells the subroutine what to do. The argument parameters are commonly separated by an exclamation mark.
The AU_USER_SYM_SUBSET subroutine argument structure is:
auth.field!auth.mv!auth.file!higher.term.codes!keep.higher.terms
What the argument parameters mean
| Argument parameter | Required or optional? | Explanation |
|---|---|---|
| auth.field | Required | The internal field name or the Field Mark Count (FMC) of the field to extract authority terms from. |
| auth.mv | Optional | For multi-value authority fields, set to 0 to only process the first authority term, 1 to process all terms (default). |
| auth.file | Required | The System ID of the authority file that controls the auth.field. |
| higher.term.codes | Required |
The System ID of the highest term in the hierarchy (that is, all of the narrower terms you want will sit below this term). If you want to select multiple terms, delimit the terms with a semicolon. For example, 12;NOM;2 |
| keep.higher.terms | Optional | Default 0. If set to 1, then include the selected term if this was the term used in the field. |
Example of subroutine argument
This argument has been configured for the Classification field in the Object file. This will only display narrower terms under the top term Linnaean (LIN).
CLASSIFICATION!!CLASSIFICATION!LIN
