Difference between revisions of "Keywords field"
(Added keywords field) |
(Added examples. Improved other sections unhide ToC.) |
||
| Line 1: | Line 1: | ||
{{fieldtypes}} | {{fieldtypes}} | ||
| − | + | ||
| + | |||
| + | == Description == | ||
| + | Stores a list of keywords as a <tt>longtext</tt> field but allows searching for exact matches on individual keyword phrases separated by a user-specifiable separator. | ||
| + | |||
== Inheritance == | == Inheritance == | ||
| − | |||
* [[Metadata]] | * [[Metadata]] | ||
** [[Text field]] | ** [[Text field]] | ||
*** [[Longtext field]] | *** [[Longtext field]] | ||
**** [[Keywords field]] | **** [[Keywords field]] | ||
| − | |||
| − | |||
| − | |||
== Properties == | == Properties == | ||
| − | |||
As for [[Longtext field]]s with the following difference... | As for [[Longtext field]]s with the following difference... | ||
| Line 22: | Line 21: | ||
== Required Phrases == | == Required Phrases == | ||
| + | No additional phrases. | ||
| + | |||
| + | == Database == | ||
| + | Keywords fields are stored in the database as | ||
| + | |||
| + | fieldname LONGTEXT | ||
| + | |||
| + | == API == | ||
| + | See [[API:EPrints/MetaField/Keywords|API page]]. | ||
| + | |||
| + | == Examples == | ||
| + | Most basic example. | ||
| + | { | ||
| + | name => 'keywords', | ||
| + | type => 'keywords', | ||
| + | } | ||
| + | Use a semi-colon (<tt>;</tt> as a separator. | ||
| + | { | ||
| + | name => 'terms', | ||
| + | type => 'keywords', | ||
| + | separator => ';', | ||
| + | } | ||
Revision as of 11:31, 23 March 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
Stores a list of keywords as a longtext field but allows searching for exact matches on individual keyword phrases separated by a user-specifiable separator.
Inheritance
Properties
As for Longtext fields with the following difference...
| name | default | description |
| separator | , | Can be overridden in the field definition. |
Required Phrases
No additional phrases.
Database
Keywords fields are stored in the database as
fieldname LONGTEXT
API
See API page.
Examples
Most basic example. {
name => 'keywords', type => 'keywords',
} Use a semi-colon (; as a separator. {
name => 'terms', type => 'keywords', separator => ';',
}
