Difference between revisions of "Longtext field"

From EPrints Documentation
Jump to: navigation, search
(Added maxlength info)
(Additional Properties)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{fieldtypes}}
 
{{fieldtypes}}
__NOTOC__
 
== Inheritance ==
 
  
* [[Metadata]]
 
** [[Text field]]
 
*** [[Longtext field]]
 
  
 
== Description ==
 
== Description ==
 +
This field store larger text fields (e.g. title abstracts, reference lists, etc.) that cannot be stored in a [[Text field]] that only allows a maximum of 255 characters.
  
== Properties ==
+
== Inheritance ==
 +
* [[:Category:EPrints_Metadata_Fields|Metadata field]]
 +
** [[Text field]]
 +
*** [[Longtext field]]
  
As for [[text field]]s with the following differences...
+
== Additional Properties ==
 +
As for [[Text field#Additional_Properties|Text fields]] except for
  
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
+
! Name !! Default Value !! Required !! Description !! Notes
 
|-
 
|-
| '''input_rows''' || n/a || '''This property is taken from the repository configuration.'''
+
| '''input_rows''' || <tt>10</tt> || NO || The number of rows for the <tt>textarea</tt> in the input form. || The default value for this property is taken from <tt>cfg.d/field_property_defaults.pl</tt>.
 
|-
 
|-
| '''maxlength''' || 65535 || '''Can be overridden in the field definition.'''
+
| '''maxlength''' || <tt>65535</tt> || NO || The maximum number of characters that can be written to the <tt>textarea</tt> in the input form. || Different from [[Metadata]] default (255). Maximum length could be as much as 4294967295 (over 4 billion).  
 
|}
 
|}
  
 
== Required Phrases ==
 
== Required Phrases ==
 +
No additional phrases beyond those required for [[Text field#Required_Phrases|Text fields]].
 +
 +
== Database ==
 +
Longtext fields are stored in the database as
 +
 +
fieldname LONGTEXT
 +
 +
== API ==
 +
See [[API:EPrints/MetaField/Longtext|API page]].
 +
 +
== Examples ==
 +
Most basic example.
 +
{
 +
    name => 'task_purpose',
 +
    type => 'longtext',
 +
}
 +
Give more space, (so all text can be seen at once).
 +
{
 +
    name => 'referencetext',
 +
    type => 'longtext',
 +
    input_rows => 15,
 +
}
 +
Use a special rendering functions to display text in paragraphs.
 +
{
 +
  name => 'abstract',
 +
  type => 'longtext',
 +
  input_rows => 10,
 +
  render_single_value => 'render_paras',
 +
}
 +
Use special ordering for field for English (e.g. ignore indefinite and definite articles, etc.)
 +
{
 +
    name => 'title',
 +
    type => 'longtext',
 +
    input_rows => 3,
 +
    make_single_value_orderkey => 'EPrints::Extras::english_title_orderkey',
 +
}

Latest revision as of 09:58, 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 store larger text fields (e.g. title abstracts, reference lists, etc.) that cannot be stored in a Text field that only allows a maximum of 255 characters.

Inheritance

Additional Properties

As for Text fields except for

Name Default Value Required Description Notes
input_rows 10 NO The number of rows for the textarea in the input form. The default value for this property is taken from cfg.d/field_property_defaults.pl.
maxlength 65535 NO The maximum number of characters that can be written to the textarea in the input form. Different from Metadata default (255). Maximum length could be as much as 4294967295 (over 4 billion).

Required Phrases

No additional phrases beyond those required for Text fields.

Database

Longtext fields are stored in the database as

fieldname LONGTEXT

API

See API page.

Examples

Most basic example.

{
    name => 'task_purpose',
    type => 'longtext',
}

Give more space, (so all text can be seen at once).

{
    name => 'referencetext',
    type => 'longtext',
    input_rows => 15,
}

Use a special rendering functions to display text in paragraphs.

{
  name => 'abstract',
  type => 'longtext',
  input_rows => 10,
  render_single_value => 'render_paras',
}

Use special ordering for field for English (e.g. ignore indefinite and definite articles, etc.)

{
    name => 'title',
    type => 'longtext',
    input_rows => 3,
    make_single_value_orderkey => 'EPrints::Extras::english_title_orderkey',
}