Langid field: Difference between revisions

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

Description

This field is like a Set field but intended for providing language ID options where phrases can be provided by existing languages_typename_LANGID phrases. It is used by the Multilang field to specify the language used for values in a particular field or fields.

Inheritance

Metadata
- Id field
  - Text field
    - Set field
      - Langid field

Additional Properties

As for Set fields.

Required Phrases

No additional phrases beyond those required for Set fields.

Database

Langid fields are stored in the database as

 fieldname VARCHAR(255)

API

See API page.

Examples

Most basic example.

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

@@ Line 1: / Line 1: @@
+{{fieldtypes}}
+== Description ==
+This field is like a [[Set field]] but intended for providing language ID options where phrases can be provided by existing <tt>languages_typename_LANGID</tt> phrases.  It is used by the [[Multilang field]] to specify the language used for values in a particular field or fields.
+== Inheritance ==
 * [[Metadata]]
-** [[Set field]]
+** [[Id field]]
-*** [[Langid field]]
+*** [[Text field]]
+**** [[Set field]]
+***** [[Langid field]]
-== Description ==
+== Additional Properties ==
+As for [[Set field#Additional Properties|Set fields]].
-== Properties ==
+== Required Phrases ==
+No additional phrases beyond those required for [[Set field#Required_Phrases|Set fields]].
-As for [[set field]]s with the following differences...
+== Database ==
+Langid fields are stored in the database as
+  fieldname VARCHAR(255)
-{| border="1" cellpadding="3" cellspacing="0"
+== API ==
-| name || default || description
+See [[API:EPrints/MetaField/Langid|API page]].
-|-
-| '''input_style''' || short || ''as for [[set field]] but with a different default.''
-|}
-== Required Phrases ==
+== Examples ==
+Most basic example.
+ {
+     'name' => 'language',
+     'type' => 'langid',
+ }