MetaField Object

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

---

Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User

Built in Fields

Field Name	Type	Description
metafieldid	counter field	The ID number of this MetaField Object (unique within a single repository)
mfdatasetid	set field	The dataset to which te=he metafield belongs.
name	text field	The name of the metafield
type	set field	The type of the metafield
provenance	set field	The provenance of the metafield
phrase_name	multiple multilang field	Human-readable phrase name for the metafield
phrase_help	multiple multilang field	Human-readable phrase help text for the metafield
multiple	boolean field	Whether the metafield can have multiple values.
allow_null	boolean field	Does the metafield allow null values.
export_as_xml	boolean field	Should teh field be exported in XML and other formats.
volatile	boolean field	Is the metafield volatile, (likely to change regularly).
min_resolution	set field	The minimum resolution of the metafield, (e.g. day, second, etc.).
sql_index	boolean field	Does the metafield get indexed within the database.
render_input	text field	A different or bespoke function to render the input field for the metafield.
render_value	text field	A different or bespoke function to render the value for the metafield.
input_ordered	boolean field	Whether the input for this metafield is ordered.
maxlength	int field	The maximum length of the metafield.
browse_link	text field	The link to a browse view for the metafield if it is a subject metafield.
top	text field	The top subject in the subject tree that should be used as options for the subject metafield.
datasetid	text field	The dataset ID for the metafield, if it is a search, subobject, dataobjref, fields, itemref or file field.
set_name	text field	The name of the file that contains the options for the namedset metafield.
options	text field	The commas separated list of options for the set metafield.
render_order	set field	The order to render a name if the metafield is for a name.
hide_honourific	boolean field	Whether to hide the honourfic sub-field if a name metafield.
hide_lineage	boolean field	Whether to hide the lineage sub-field if a name metafield.
family_first	boolean field	Whether to render the family name sub-field before the given name if a name metafield.
input_style	set field	A particular style for displaying the input form element for the metafield.
input_rows	int field	The number of input rows for the metafield.
input_cols	int field	The number of input columns for the metafield.
input_boxes	int field	The number of input boxes for the metafield.
sql_counter	text field	The name to give to the sql counter for a counter metafield. Typically the same as the metafield's name.
default_value	text field	The default value for the metafield.