Difference between revisions of "User Deposit Agreement"
(Created page with "== DOCUMENTATION NOT COMPLETE == == Why add a user deposit agreement? == You may wish for users to explicitly comply with a set of user agreement terms and conditions. The t...") |
(→Process for adding a user deposit agreement) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
You may wish for users to explicitly comply with a set of user agreement terms and conditions. The terms may be stated in a hosted file which can be linked to or hosted within your eprints instance as a pdf or xpage file. | You may wish for users to explicitly comply with a set of user agreement terms and conditions. The terms may be stated in a hosted file which can be linked to or hosted within your eprints instance as a pdf or xpage file. | ||
+ | |||
+ | == Versions == | ||
+ | |||
+ | EPrints 3.4 (All minor versions) | ||
== Process for adding a user deposit agreement == | == Process for adding a user deposit agreement == | ||
− | To be | + | '''Requirement:''' To add a radio button to which the user would just need to select that they had read the statement and can proceed ahead with deposit. |
+ | |||
+ | '''Create a new field "User Deposit Agreement"''' | ||
+ | |||
+ | { | ||
+ | name => 'user_deposit_agreement', | ||
+ | type => 'set', | ||
+ | input_style => 'medium', | ||
+ | options => [ | ||
+ | 'TRUE' | ||
+ | ], | ||
+ | }, | ||
+ | |||
+ | This will create a new field User Deposit Agreement with a radio button. Name of the options 'TRUE' need to be defined (as set out in the field). | ||
+ | |||
+ | We will define it in following way: | ||
+ | |||
+ | '''1. Radio button to have TRUE option'''<br> | ||
+ | |||
+ | '''Syntax:''' datasetid + "_fieldopt_" + fieldname + "_" + optionname <br> | ||
+ | |||
+ | '''Example:''' eprint_fieldopt_user_agreement_deposit_TRUE <br> | ||
+ | |||
+ | |||
+ | '''To give name to radio button:''' <epp:phrase id="eprint_fieldopt_user_deposit_agreement_TRUE"><label xmlns:epc="http://eprints.org/ep3/control">Yes, I agree.</label></epp:phrase> <br> | ||
+ | |||
+ | |||
+ | '''2. Radio button to have FALSE option'''<br> | ||
+ | |||
+ | '''Syntax:''' datasetid + "_fieldopt_" + fieldname + "_" + optionname<br> | ||
+ | |||
+ | '''Example:''' eprint_fieldopt_user_agreement_deposit_FALSE <br> | ||
+ | |||
+ | '''To give name to radio button:''' <epp:phrase id="eprint_fieldopt_user_deposit_agreement_FALSE"><label xmlns:epc="http://eprints.org/ep3/control">No, I disagree.</label></epp:phrase> <br> | ||
+ | |||
+ | '''Relevant Document to refer:''' https://wiki.eprints.org/w/Set_field#:~:text=multiple%20%3D%3E%200.-,check%20boxes,-if%20input_style%20%3D%3E%20%27long |
Latest revision as of 13:12, 5 December 2023
Contents
DOCUMENTATION NOT COMPLETE
Why add a user deposit agreement?
You may wish for users to explicitly comply with a set of user agreement terms and conditions. The terms may be stated in a hosted file which can be linked to or hosted within your eprints instance as a pdf or xpage file.
Versions
EPrints 3.4 (All minor versions)
Process for adding a user deposit agreement
Requirement: To add a radio button to which the user would just need to select that they had read the statement and can proceed ahead with deposit.
Create a new field "User Deposit Agreement"
{
name => 'user_deposit_agreement', type => 'set', input_style => 'medium', options => [ 'TRUE' ],
},
This will create a new field User Deposit Agreement with a radio button. Name of the options 'TRUE' need to be defined (as set out in the field).
We will define it in following way:
1. Radio button to have TRUE option
Syntax: datasetid + "_fieldopt_" + fieldname + "_" + optionname
Example: eprint_fieldopt_user_agreement_deposit_TRUE
To give name to radio button: <epp:phrase id="eprint_fieldopt_user_deposit_agreement_TRUE"><label xmlns:epc="http://eprints.org/ep3/control">Yes, I agree.</label></epp:phrase>
2. Radio button to have FALSE option
Syntax: datasetid + "_fieldopt_" + fieldname + "_" + optionname
Example: eprint_fieldopt_user_agreement_deposit_FALSE
To give name to radio button: <epp:phrase id="eprint_fieldopt_user_deposit_agreement_FALSE"><label xmlns:epc="http://eprints.org/ep3/control">No, I disagree.</label></epp:phrase>
Relevant Document to refer: https://wiki.eprints.org/w/Set_field#:~:text=multiple%20%3D%3E%200.-,check%20boxes,-if%20input_style%20%3D%3E%20%27long