⧼vector-jumptocontent⧽

Arclanguage field: Difference between revisions

From EPrints Documentation
Moj (talk | contribs)
No edit summary
 
Actually leave in as should become available
 
(11 intermediate revisions by 4 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:
{| border="1" cellpadding="3" cellspacing="0"
! 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 field#Required_Phrases|Set fields]].


== Properties ==
== Database ==
Arclanguage fields are stored in the database as
fieldname VARCHAR(255)


No extra properties.
== API ==
See [[API:EPrints/MetaField/Arclanguage|API page]].


== Required Phrases ==
== Examples ==
Most basic example.
{
    name => 'language',
    type => 'arclanguage',
}

Latest revision as of 09:44, 9 July 2024


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