Difference between revisions of "Arclanguage field"

From EPrints Documentation
Jump to: navigation, search
(Description)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{fieldtypes}}
 +
 +
 +
== Description ==
 +
This field provides a set of language options but rather than being provided by the <tt>options</tt> attribute of the field configuration, the languages specified for the [[EPrints Glossary#Archive|archive]] (in <code>$c->{languages}</code> is used. 
 +
 +
This field is only useful for multi-langauge repository where you might want to record the language metadata for a [[EPrints Glossary#Data object|data object]] or a specific [[EPrints Glossary#Metadata field|metadata field]] is captured in.  However, you are probably better off using the [[Multilang field]].  Therefore, this field is somewhat deprecated.
 +
 +
== Inheritance ==
 
* [[Metadata]]
 
* [[Metadata]]
 
** [[Set field]]
 
** [[Set field]]
 
*** [[Arclanguage field]]
 
*** [[Arclanguage field]]
  
== Description ==
+
== Additional Properties ==
 
+
As for [[Set field#Additional_Properties|Set fields]] except for:
== Properties ==
 
 
 
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
+
! Name !! Default Value !! Required? !! Description !! Notes
 
|-
 
|-
| '''options''' || n/a || '''This property is ''not'' inherited from [[set field]].'''
+
| '''options''' || ''n/a'' || NO || Options from which to choose. || NOT inherited from [[Set field]]. Options provided automatically.
 
|}
 
|}
  
 
== Required Phrases ==
 
== Required Phrases ==
 +
No additional phrases beyond those required for [[Set field#Required_Phrases|Set fields]].
 +
 +
== Database ==
 +
Arclanguage fields are stored in the database as
 +
fieldname VARCHAR(255)
 +
 +
== API ==
 +
See [[API:EPrints/MetaField/Arclanguage|API page]].
 +
 +
== Examples ==
 +
Most basic example.
 +
{
 +
    name => 'language',
 +
    type => 'arclanguage',
 +
}

Latest revision as of 16:17, 16 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 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


Description

This field provides a set of language options but rather than being provided by the options attribute of the field configuration, the languages specified for the archive (in $c->{languages} is used.

This field is only useful for multi-langauge repository where you might want to record the language metadata for a data object or a specific metadata field is captured in. However, you are probably better off using the Multilang field. Therefore, this field is somewhat deprecated.

Inheritance

Additional Properties

As for Set fields except for:

Name Default Value Required? Description Notes
options n/a NO Options from which to choose. NOT inherited from Set field. Options provided automatically.

Required Phrases

No additional phrases beyond those required for Set fields.

Database

Arclanguage fields are stored in the database as

fieldname VARCHAR(255)

API

See API page.

Examples

Most basic example.

{
    name => 'language', 
    type => 'arclanguage',
}