Difference between revisions of "Subject field"
(Added standard sections some with content. Unhide ToC) |
m (→Properties) |
||
Line 10: | Line 10: | ||
*** [[Subject field]] | *** [[Subject field]] | ||
− | == Properties == | + | == Additional Properties == |
− | As for [[ | + | As for [[Set field#Additional_Properties|Set fields]] except for: |
{| border="1" cellpadding="3" cellspacing="0" | {| border="1" cellpadding="3" cellspacing="0" |
Revision as of 23:03, 9 April 2023
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid
Contents
Description
This field is like a Set field but rather than explicitly defining its set of options within the field configuration, the field configuration attribute top
specifies the root of the subjects sub-tree to use as a set of options.
Inheritance
Additional Properties
As for Set fields except for:
name | default | description |
input_style | 0 | as for set field but with a different default. |
nestids | 1 | Options are colon (:) separated path of sub-tree IDs rather than just the specific subject ID. |
options | n/a | This property is not inherited from set field. |
showall | 0 | Show all options under top , not just those marked as depositable.
|
showtop | 0 | Show the subject option defined by top as well as the options underneath.
|
top | subjects | Specifies the sub-tree of the subjects tree to get options. |
Required Phrases
No additional phrases. Also datasetid + "_fieldopt_" + fieldname + "_" + optionname
phrases are not required, as these are taken from the name assigned to the subject.
Database
Namedset fields are stored in the database as
fieldname VARCHAR(255)
API
See API page.
Examples
Most basic example. Using divisions subjects tree sub-tree to provide options.
{ name => 'division', type => 'subject', top => 'divisions', }
Allow multiple subject options to be selected.
{ name => 'subjects', type => 'subject', multiple => 1, top => 'subjects', }
Rendered value will link to corresponding listings page in subjects browse view.
{ name => 'subjects', type => 'subject', multiple => 1, top => 'subjects', browse_link => 'subjects', }