Difference between revisions of "Recaptcha field"

From EPrints Documentation
Jump to: navigation, search
(Added ToC. Added API and Examples sections. Reorganised other sections.)
m (Properties)
Line 16: Line 16:
 
*** [[Recaptcha field]]
 
*** [[Recaptcha field]]
  
== Properties ==
+
== Additional Properties ==
As for [[Id field]]s.
+
As for [[Id field#Additional_Phrases|Id fields]].
  
 
== Required Phrases ==
 
== Required Phrases ==

Revision as of 22:54, 9 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

Additional 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',
}