You are here

Home » API reference » Webform Invitation 2.0.x

README.txt in Webform Invitation 2.0.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
-- SUMMARY --

The Webform Invitation module allows you to restrict submissions to a webform
by generating codes which may then be distributed e.g. by email to
participants. Upon activating the invitation mode for a webform a new element
will automatically be added to the webform where the code has to be entered.
The code may also be submitted by adding ?code=[CODE] to the webform's URL.
When the participant hits the submit button, the code will be checked for 
validity.


-- REQUIREMENTS --

Webform module version 8.x-5.x installed.


-- INSTALLATION --

Install as usual.


-- CONFIGURATION --

No special configuration necessary. Works out of the box.


-- USAGE --

When installed, this module adds a new tab to webforms called "Invitation"
(next to "View", "Test", "Results" and "Build").
There are four sub-tabs called "Settings" (default action), "List codes",
"Generate", and "Download".

The "Settings" tab currently only contains the option to enable or disable
invitations for the current webform.
"List codes" shows a simple list of all invitation codes that have been
generated for the current webform and whether or not they have been used.
"Generate" provides a form to generate invitation codes. You may choose the
number of generated codes and their type (MD5 or custom).
"Download" tab has no special content but lets you download the list of 
not used generated codes as an Excel sheet including code and full URL to
access the webform with auto-submitting the invitation code.

File

README.txt
View source 
  1. -- SUMMARY --

  2. 

  3. The Webform Invitation module allows you to restrict submissions to a webform

  4. by generating codes which may then be distributed e.g. by email to

  5. participants. Upon activating the invitation mode for a webform a new element

  6. will automatically be added to the webform where the code has to be entered.

  7. The code may also be submitted by adding ?code=[CODE] to the webform's URL.

  8. When the participant hits the submit button, the code will be checked for 

  9. validity.

  10. 

  11. 

  12. -- REQUIREMENTS --

  13. 

  14. Webform module version 8.x-5.x installed.

  15. 

  16. 

  17. -- INSTALLATION --

  18. 

  19. Install as usual.

  20. 

  21. 

  22. -- CONFIGURATION --

  23. 

  24. No special configuration necessary. Works out of the box.

  25. 

  26. 

  27. -- USAGE --

  28. 

  29. When installed, this module adds a new tab to webforms called "Invitation"

  30. (next to "View", "Test", "Results" and "Build").

  31. There are four sub-tabs called "Settings" (default action), "List codes",

  32. "Generate", and "Download".

  33. 

  34. The "Settings" tab currently only contains the option to enable or disable

  35. invitations for the current webform.

  36. "List codes" shows a simple list of all invitation codes that have been

  37. generated for the current webform and whether or not they have been used.

  38. "Generate" provides a form to generate invitation codes. You may choose the

  39. number of generated codes and their type (MD5 or custom).

  40. "Download" tab has no special content but lets you download the list of 

  41. not used generated codes as an Excel sheet including code and full URL to

  42. access the webform with auto-submitting the invitation code.