Drn@ecs.soton.ac.uk: Added MetaField Object

2022-02-15T00:40:32Z

Added MetaField Object

New page

{{dataobj}}
__NOTOC__
=== Built in Fields ===

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

MetaField Object - Revision history

Drn@ecs.soton.ac.uk: Added MetaField Object