Recaptcha field: Difference between revisions
mNo edit summary |
Added ToC. Added API and Examples sections. Reorganised other sections. |
||
| 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 == | == Properties == | ||
| Line 27: | Line 21: | ||
== Required Phrases == | == Required Phrases == | ||
'''validate:recaptcha_mismatch''' - Phrase to display if reCAPTCHA submission errored in some way. | '''validate:recaptcha_mismatch''' - Phrase to display if reCAPTCHA submission errored in some way. | ||
== API == | |||
See [[API:EPrints/MetaField/Recaptcha|API page]]. | |||
== Examples == | |||
Most basic example. | |||
{ | |||
name => 'captcha', | |||
type => 'recaptcha', | |||
} | |||
Revision as of 21:50, 8 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
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
Properties
As for Id fields.
Required Phrases
validate:recaptcha_mismatch - Phrase to display if reCAPTCHA submission errored in some way.
API
See API page.
Examples
Most basic example.
{
name => 'captcha',
type => 'recaptcha',
}