⧼vector-jumptocontent⧽

Arclanguage field: Difference between revisions

From EPrints Documentation
No edit summary
Made structure more conformant for metadata field types.
Line 1: Line 1:
{{fieldtypes}}
{{fieldtypes}}


== Inherritance ==
== 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 more 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.


== 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 || description  
Line 18: Line 20:


== 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',
}

Revision as of 20:03, 10 April 2023

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 more multi-langauge repository where you might want to record the language metadata for a data object or a specific metadata field is captured in.

Inheritance

Additional Properties

As for Set fields except for:

name default description
options n/a This property is not inherited from set field.

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',
}