Template:EPrints Metadata Fields Content - Revision history

Drn@ecs.soton.ac.uk: /* Object Methods */ Added render_name

2026-04-30T13:05:23Z

‎Object Methods: Added render_name

2026-04-30T12:48:26Z

‎Object Methods: Added more object methods

2026-04-29T15:08:22Z

Added some methods of main MetaField class

2024-07-31T10:53:08Z

‎Internal Properties

2024-07-09T09:38:22Z

Fixes some typos

2023-10-05T14:19:32Z

‎Internal Properties

2023-04-21T08:08:59Z

‎Deprecated or Buggy Properties

2023-04-21T08:07:20Z

‎Internal Properties

2023-04-21T07:40:51Z

‎Other Properties

2023-04-21T07:40:20Z

‎Other Properties

@@ Line 322: / Line 322: @@
 || The <code>EPrints::DataSet</code> object to which this field belongs.
 || Get dataset to which this field belongs.
 |-
 | '''render_help'''

@@ Line 322: / Line 322: @@
 || The <code>EPrints::DataSet</code> object to which this field belongs.
 || Get dataset to which this field belongs.
 |}
 === Utility Methods ===
 '''TO BE DONE'''

@@ Line 253: / Line 253: @@
 |-
 | '''sql_sorted''' || <tt>0</tt> || NO || Whether SQL should be sorted. || Deprecated.  Defined but no longer functional.
 |}

@@ Line 232: / Line 232: @@
 | '''parent_name''' || <tt>undef</tt> || NO || The name of the parent [[Compound field]] to which a sub-field belongs. || This is set automatically to be the name of the parent field.
 |-
-| '''provenance''' || <tt>undef</tt> || NO || Where this field configuration was generated. || Typically any field configuration either defined within a [[Data object]] or in a configuration file (in a <tt>cfg.d</tt> directory will leave this as <tt>undef</tt> by not specifying this property.  However, fields created using [[Admin/Config._Tools/Manage_Metadata_Fields|Manage Metadata Fields]] will set this to <tt>user</tt> so it is clear from where this field was created.
+| '''provenance''' || <tt>undef</tt> || NO || Where this field configuration was generated. || Typically any field configuration either defined within a [[Data Object|Data object]] or in a configuration file (in a <tt>cfg.d</tt> directory will leave this as <tt>undef</tt> by not specifying this property.  However, fields created using [[Admin/Config._Tools/Manage_Metadata_Fields|Manage Metadata Fields]] will set this to <tt>user</tt> so it is clear from where this field was created.
 |}

@@ Line 48: / Line 48: @@
 *** '''[[Uuid field|Uuid]]''' - stores a UUID.
 ** '''[[Int field|Int]]''' - an integer value
-*** '''[[Bigint field|Bigint]]'''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).
+*** '''[[Bigint field|Bigint]]''' - a large integer value (can be greater than 2,147,483,647 or less than -2,147,483.647).
-*** '''[[Counter field|Counter]]'''' - an auto-incrementing integer value.
+*** '''[[Counter field|Counter]]''' - an auto-incrementing integer value.
 *** '''[[Itemref field|Itemref]]''' - a reference to another [[Data Object]] (e.g. a user or other eprint)
 *** '''[[Pagerange field|Pagerange]]''' - a pagerange, e.g. 122-130

@@ Line 226: / Line 226: @@
 | '''confid''' || n/a || YES || The ID of the dataset to which this field belongs. || The value for this property is automatically set when the field is loaded.  It is used to work out what phrase ids etc. it uses.
 |-
-| '''join_path''' || <tt>undef</tt> || NO || How to join a field that references a different [[Data object]]. || This should never be defined within a field's configuration.  This is built by search to support building a database query to perform a user's search.
+| '''join_path''' || <tt>undef</tt> || NO || How to join a field that references a different [[Data Object]]. || This should never be defined within a field's configuration.  This is built by search to support building a database query to perform a user's search.
 |-
 | '''parent''' || <tt>undef</tt> || NO || A reference to the actual parent [[Compound field]] object. || This is set automatically as a reference to the parent field object.

@@ Line 235: / Line 235: @@
 |}
-=== Deprecated or Buggy Properties ===
+=== Deprecated Properties ===
-Don't use these!
+Do not use these!
 {| cellpadding="3" cellspacing="0" border="1"
@@ Line 250: / Line 250: @@
 | '''requiredlangs''' || <tt>[]</tt> || NO || The natural languages that should be used in the value(s) for this field ||  Deprecated.  Defined but no longer functional.
 |-
-| '''sql_langid''' || <tt>undef</tt> || NO || ||
+| '''sql_langid''' || <tt>undef</tt> || NO || The language ID for SQL. || Deprecated.  Defined but no longer functional.
 |-
-| '''sql_sorted''' || <tt>0</tt> || NO || ||
+| '''sql_sorted''' || <tt>0</tt> || NO || Whether SQL should be sorted. || Deprecated.  Defined but no longer functional.
 |}

@@ Line 210: / Line 210: @@
 | '''import''' || <tt>1</tt> || NO || Whether new data objects create from an import can set values for the field.  || E.g. <tt>eprintid</tt>, <tt>dir<tt> are determined when the eprint record is created.  Imported metadata would not choose an appropriate value for such fields.
 |-
-| '''replace_core''' ||| <tt>0</tt> || NO || Whether the field configuration should replace the exisiting [[Eprints Glossary#Core_field|core (system) field]] with the same <tt>name</tt> || This is useful for particularly bespoke requirements.  It should be used with great care, as system fields are usually hard-coded because they should not be changed.
+| '''replace_core''' ||| <tt>0</tt> || NO || Whether the field configuration should replace the exisiting [[EPrints Glossary#Core_field|core (system) field]] with the same <tt>name</tt> || This is useful for particularly bespoke requirements.  It should be used with great care, as system fields are usually hard-coded because they should not be changed.
 |-
 | '''show_in_fieldlist''' || <tt>1</tt> || NO || Whether to allow this field to appear in fields lists.  || If set to <tt>0</tt> will prevent this field appearing in [[Fields field]] lists.  This is primarily to allow you to remove it from the list of fields in the user configuration which are used to control which fields appear as columns in the Items and Review screens.