Difference between revisions of "Recaptcha field"
(Added Recaptcha field page) |
(Added database section) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{fieldtypes}} | {{fieldtypes}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Description == | == Description == | ||
| + | Please refer to the notes in <tt>EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/recaptcha.pl</tt>. | ||
| − | + | If this files does not exist, copy <tt>EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example</tt> | |
| − | |||
| − | If this files does not exist, copy EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example | ||
to the path above and edit it. | to the path above and edit it. | ||
| Line 18: | Line 11: | ||
renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to). | renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to). | ||
| − | + | == Inheritance == | |
| − | + | * [[:Category:EPrints_Metadata_Fields|Metadata Field]] | |
| − | + | ** [[Id field]] | |
| + | *** [[Recaptcha field]] | ||
| − | == Properties == | + | == Additional Properties == |
| − | As for [[Id field]] | + | As for [[Id field#Additional_Phrases|Id fields]]. |
== Required Phrases == | == Required Phrases == | ||
| − | + | <tt>validate:recaptcha_mismatch</tt> - Phrase to display if reCAPTCHA submission errored in some way. | |
| + | |||
| + | == Database == | ||
| + | Recaptcha fields are not stored in the database they are just so reCAPTCHA can be added to certain forms. The result of the reCAPTCHA does not need to be stored. | ||
| + | |||
| + | == API == | ||
| + | See [[API:EPrints/MetaField/Recaptcha|API page]]. | ||
| + | |||
| + | == Examples == | ||
| + | Most basic example. | ||
| + | { | ||
| + | name => 'captcha', | ||
| + | type => 'recaptcha', | ||
| + | } | ||
Latest revision as of 08:55, 11 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
Contents
Description
Please refer to the notes in EPRINTS_PATH/archives/ARCHIVEID/cfg/cfg.d/recaptcha.pl.
If this files does not exist, copy EPRINTS_PATH/lib/defaultcfg/cfg.d/recaptcha.pl.example to the path above and edit it.
This field uses the Google "reCAPTCHA" service (https://www.google.com/recaptcha/intro/) and renders a Captcha (a test that humans can easily pass, but robots shouldn't be able to).
Inheritance
Additional Properties
As for Id fields.
Required Phrases
validate:recaptcha_mismatch - Phrase to display if reCAPTCHA submission errored in some way.
Database
Recaptcha fields are not stored in the database they are just so reCAPTCHA can be added to certain forms. The result of the reCAPTCHA does not need to be stored.
API
See API page.
Examples
Most basic example.
{
name => 'captcha',
type => 'recaptcha',
}
