You are here

README.txt in User registration password 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation
 * Configuration
 * Email templates
 * Token
 * Multilangual sites
 * Known issues
 * De-installation
 * Upgrade notes


INTRODUCTION
------------

User Registration Password let's users register with a password
on the registration form when 'Require email verification when
a visitor creates an account' is enabled on the configuration page.

By default, users can create accounts directly on the registration form, set
their password and be immediately logged in, or they can create their account,
wait for a verification email, and then create their password.

With this module, users are able to create their account along with their
password and simply activate their account when receiving the verification
email by clicking on the activation link provided via this email.

User Registration Password transforms the checkbox on the
admin/config/people/accounts page into a radio list with 3 options.

The first 2 are default Drupal behaviour:
0 Do not require a verification email, and let users set their password on the
  registration form.
0 Require a verification email, but wait for the approval email to let users set
  their password.

The newly added option is:
X Require a verification email, but let users set their password directly on the
  registration form.

The first 2 disable User Registration Password, only the 3rd option activates
the behaviour implemented by this module.


INSTALLATION
------------

Installation is like any other module, just place the files in the modules
directory and enable the module on the 'Extend' page.


CONFIGURATION
-------------

The module sets the correct configuration settings on install, including the
correct account activation email template. But if you want to change something,
these steps describe how to configure the module in more detail.

On the admin/config/people/accounts page make sure you have selected:

Who can register accounts?
0 Administrators only
X Visitors
0 Visitors, but administrator approval is required

Then select 'Require a verification email, but let users set their password
directly on the registration form.' at:

Require email verification when a visitor creates an account
0 Do not require a verification email, and let users set their password on the
  registration form.
0 Require a verification email, but wait for the approval email to let users set
  their password.
X Require a verification email, but let users set their password directly on the
  registration form.

The module is now configured and ready for use. This is also the only way to
configure it correctly. This module will also not work if you do not have
'Visitors' selected at 'Who can register accounts?' on the same page.


EMAIL TEMPLATES
----------------

Regarding email templates:

You do not have to alter any email templates, User Registration Password
overrides the default 'Account activation' email template during installation.
So there is no need to change anything anymore on a fresh installation.

If you have previously modified the account activation email template before you
installed this module and discovered that it overrides the default Account
activation email template, no worries! The installer saves your changes to the
template to a temporally variable and revives them when you uninstall User
Registration Password. Your modifications are revived and you can now copy paste
them to a text file and re-install User Registration Password again and make the
changes to the 'account activation' email template based on your previous
version.


TOKEN
-----

The token provided by this module:

[user:registrationpassword-url]

Place this token in your registration email template (the installer tries to do
this during install, if that fails you have to manually add it).

Also see the token widget on the admin account form for all available tokens.


MULTILANGUAL SITES
------------------

All variables (including email) are all translateable via the core user
configuration translation page at admin/config/people/accounts/translate or via
the general translate configuration page.

Ones configured correctly, users will receive an email in their default
language, setting available on user's edit page. It does not matter what the
site language is, this setting will be leading and supercede the site's default
language. So it is logical and corrent that if you have an German based site
with, let's say German and English languages enabled, and German is also the
site's default language, still when users have English as their default browser
language, they will receive an English email.


KNOWN ISSUES
------------

None yet that we didn't solve.

If you run into problems, like access denied or other (possibly) cache-related
issues, or if you have enabled the module via drush, remember to clear
the site cache via the admin/config/development/performance page.

If this does not help, first try on IRC if anyone can help you, if you still
are not able to get it to work, open a new issue with a descent title and
description of the problem here:
http://drupal.org/node/add/project-issue/user_registrationpassword


DE-INSTALLATION
---------------

If you want to disable the module temporally, just select the first or second
option on the the admin/config/people/accounts page at:

Require email verification when a visitor creates an account
1 Do not require a verification email, and let users set their password on the
  registration form.
2 Require a verification email, but wait for the approval email to let users set
  their password.
3 Require a verification email, but let users set their password directly on the
  registration form.

This disables the User Registration Password functionality without
uninstalling it.

If you want to remove the module uninstall it as you do for any other module via
the admin/modules page.


UPGRADE NOTES
-------------

Variables should work, named constants changed, so if you implement these you
might want to revisit this code.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Installation
  5. * Configuration
  6. * Email templates
  7. * Token
  8. * Multilangual sites
  9. * Known issues
  10. * De-installation
  11. * Upgrade notes
  12. INTRODUCTION
  13. ------------
  14. User Registration Password let's users register with a password
  15. on the registration form when 'Require email verification when
  16. a visitor creates an account' is enabled on the configuration page.
  17. By default, users can create accounts directly on the registration form, set
  18. their password and be immediately logged in, or they can create their account,
  19. wait for a verification email, and then create their password.
  20. With this module, users are able to create their account along with their
  21. password and simply activate their account when receiving the verification
  22. email by clicking on the activation link provided via this email.
  23. User Registration Password transforms the checkbox on the
  24. admin/config/people/accounts page into a radio list with 3 options.
  25. The first 2 are default Drupal behaviour:
  26. 0 Do not require a verification email, and let users set their password on the
  27. registration form.
  28. 0 Require a verification email, but wait for the approval email to let users set
  29. their password.
  30. The newly added option is:
  31. X Require a verification email, but let users set their password directly on the
  32. registration form.
  33. The first 2 disable User Registration Password, only the 3rd option activates
  34. the behaviour implemented by this module.
  35. INSTALLATION
  36. ------------
  37. Installation is like any other module, just place the files in the modules
  38. directory and enable the module on the 'Extend' page.
  39. CONFIGURATION
  40. -------------
  41. The module sets the correct configuration settings on install, including the
  42. correct account activation email template. But if you want to change something,
  43. these steps describe how to configure the module in more detail.
  44. On the admin/config/people/accounts page make sure you have selected:
  45. Who can register accounts?
  46. 0 Administrators only
  47. X Visitors
  48. 0 Visitors, but administrator approval is required
  49. Then select 'Require a verification email, but let users set their password
  50. directly on the registration form.' at:
  51. Require email verification when a visitor creates an account
  52. 0 Do not require a verification email, and let users set their password on the
  53. registration form.
  54. 0 Require a verification email, but wait for the approval email to let users set
  55. their password.
  56. X Require a verification email, but let users set their password directly on the
  57. registration form.
  58. The module is now configured and ready for use. This is also the only way to
  59. configure it correctly. This module will also not work if you do not have
  60. 'Visitors' selected at 'Who can register accounts?' on the same page.
  61. EMAIL TEMPLATES
  62. ----------------
  63. Regarding email templates:
  64. You do not have to alter any email templates, User Registration Password
  65. overrides the default 'Account activation' email template during installation.
  66. So there is no need to change anything anymore on a fresh installation.
  67. If you have previously modified the account activation email template before you
  68. installed this module and discovered that it overrides the default Account
  69. activation email template, no worries! The installer saves your changes to the
  70. template to a temporally variable and revives them when you uninstall User
  71. Registration Password. Your modifications are revived and you can now copy paste
  72. them to a text file and re-install User Registration Password again and make the
  73. changes to the 'account activation' email template based on your previous
  74. version.
  75. TOKEN
  76. -----
  77. The token provided by this module:
  78. [user:registrationpassword-url]
  79. Place this token in your registration email template (the installer tries to do
  80. this during install, if that fails you have to manually add it).
  81. Also see the token widget on the admin account form for all available tokens.
  82. MULTILANGUAL SITES
  83. ------------------
  84. All variables (including email) are all translateable via the core user
  85. configuration translation page at admin/config/people/accounts/translate or via
  86. the general translate configuration page.
  87. Ones configured correctly, users will receive an email in their default
  88. language, setting available on user's edit page. It does not matter what the
  89. site language is, this setting will be leading and supercede the site's default
  90. language. So it is logical and corrent that if you have an German based site
  91. with, let's say German and English languages enabled, and German is also the
  92. site's default language, still when users have English as their default browser
  93. language, they will receive an English email.
  94. KNOWN ISSUES
  95. ------------
  96. None yet that we didn't solve.
  97. If you run into problems, like access denied or other (possibly) cache-related
  98. issues, or if you have enabled the module via drush, remember to clear
  99. the site cache via the admin/config/development/performance page.
  100. If this does not help, first try on IRC if anyone can help you, if you still
  101. are not able to get it to work, open a new issue with a descent title and
  102. description of the problem here:
  103. http://drupal.org/node/add/project-issue/user_registrationpassword
  104. DE-INSTALLATION
  105. ---------------
  106. If you want to disable the module temporally, just select the first or second
  107. option on the the admin/config/people/accounts page at:
  108. Require email verification when a visitor creates an account
  109. 1 Do not require a verification email, and let users set their password on the
  110. registration form.
  111. 2 Require a verification email, but wait for the approval email to let users set
  112. their password.
  113. 3 Require a verification email, but let users set their password directly on the
  114. registration form.
  115. This disables the User Registration Password functionality without
  116. uninstalling it.
  117. If you want to remove the module uninstall it as you do for any other module via
  118. the admin/modules page.
  119. UPGRADE NOTES
  120. -------------
  121. Variables should work, named constants changed, so if you implement these you
  122. might want to revisit this code.