You are here

README.txt in User registration password 7

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

 * Introduction
 * Installation
 * Configuration
 * E-mail templates
 * 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 e-mail 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 e-mail, 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
e-mail by clicking on the activation link provided via this e-mail.

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 e-mail, and let users set their password on the
  registration form.
0 Require a verification e-mail, but wait for the approval e-mail to let users
  set their password.

The newly added option is:
X Require a verification e-mail, 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 offered by this module.


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

Installation is like any other module, just place the files in the
sites/all/modules directory and enable the module on the modules page.


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

From the 7.x-1.3 release and higher the module sets the correct
configuration settings on install, including the correct account
activation e-mail 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 e-mail, but let users set their password
directly on the registration form.' at:

Require e-mail verification when a visitor creates an account
0 Do not require a verification e-mail, and let users set their password on the
  registration form.
0 Require a verification e-mail, but wait for the approval e-mail to let users
  set their password.
X Require a verification e-mail, 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.


E-MAIL TEMPLATES
----------------

Regarding e-mail templates:

You do not have to alter any e-mail templates, User Registration Password
overrides the default 'Account activation' e-mail template from version
7.x-1.3 and from 6.x-1.0 (and higher) during installation. So there is no
need to change anything anymore on a fresh installation.

If you have previously modified the account activation e-mail template
before you installed this module and discovered that it overrides the
default Account activation e-mail template, no worries! The installer saves
your changes to the template to a temporally variable and revives them when
you disable AND 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' e-mail template based on your previous version.


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

For multilangual sites: i18n / variables are supported for the e-mail template.
Be sure to enable them at the admin/config/regional/i18n/variable page and to
translate them via the admin/config/regional/translate page.

Ones configured correctly, users will receive an e-mail 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 e-mail.


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 e-mail verification when a visitor creates an account
1 Do not require a verification e-mail, and let users set their password on the
  registration form.
2 Require a verification e-mail, but wait for the approval e-mail to let users
  set their password.
3 Require a verification e-mail, but let users set their password directly on
  the registration form.

This disables the User Registration Password functionality without
disabling / uninstalling it.

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


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

1.4 - 1.5

Due to some code changes the registry is cleared in an update hook. It might
also be required to clear the caches on your site, please test to make sure.

The Drupal coding standards issues have been fixed, all code now validates. This
includes renaming of all named constants, so we advice a review of your code if
you use these in any place in your custom code.

1.3 - 1.4

You need to run update.php to fix the variable name we changed.
Visit admin/reports/status and click on the update database link
or update.php direct from your browser.

1.0 - 1.3

In earlier versions, this module did not override the default 'Account
activation' e-mail template. To prevent questions and keep in line with the
level of information we would like to offer with this module, we provide the
default e-mail template this module will use to override the 'Account
activation' e-mail template. When you update from 1.0/1.1/1.2 to 1.3, this
template is not activated when you run the updater. You have to change this
manually, just like before version 1.3, so most of you already know this.
From versions 6.x-1.0 and 7.x-1.3 and up, the installer overrides the default
'Account activation' e-mail template, so we only list it here as extra
information.

Modified 'Account activation' e-mail template for User Registration password:
--------------------------------------------------------------------------------

[user:name],

Your account at [site:name] has been activated.

You will be able to log in to [site:login-url] in the future using:

username: [user:name]
password: your password.

-- [site:name] team

--------------------------------------------------------------------------------

You can edit the 'Account activation' e-mail template at the
admin/config/people/accounts page.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Installation
  5. * Configuration
  6. * E-mail templates
  7. * Multilangual sites
  8. * Known issues
  9. * De-installation
  10. * Upgrade notes
  11. INTRODUCTION
  12. ------------
  13. User Registration Password let's users register with a password
  14. on the registration form when 'Require e-mail verification when
  15. a visitor creates an account' is enabled on the configuration page.
  16. By default, users can create accounts directly on the registration form, set
  17. their password and be immediately logged in, or they can create their account,
  18. wait for a verification e-mail, and then create their password.
  19. With this module, users are able to create their account along with their
  20. password and simply activate their account when receiving the verification
  21. e-mail by clicking on the activation link provided via this e-mail.
  22. User Registration Password transforms the checkbox on the
  23. admin/config/people/accounts page into a radio list with 3 options.
  24. The first 2 are default Drupal behaviour:
  25. 0 Do not require a verification e-mail, and let users set their password on the
  26. registration form.
  27. 0 Require a verification e-mail, but wait for the approval e-mail to let users
  28. set their password.
  29. The newly added option is:
  30. X Require a verification e-mail, but let users set their password directly on
  31. the registration form.
  32. The first 2 disable User Registration Password, only the 3rd option activates
  33. the behaviour offered by this module.
  34. INSTALLATION
  35. ------------
  36. Installation is like any other module, just place the files in the
  37. sites/all/modules directory and enable the module on the modules page.
  38. CONFIGURATION
  39. -------------
  40. From the 7.x-1.3 release and higher the module sets the correct
  41. configuration settings on install, including the correct account
  42. activation e-mail template. But if you want to change something, these
  43. 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 e-mail, but let users set their password
  50. directly on the registration form.' at:
  51. Require e-mail verification when a visitor creates an account
  52. 0 Do not require a verification e-mail, and let users set their password on the
  53. registration form.
  54. 0 Require a verification e-mail, but wait for the approval e-mail to let users
  55. set their password.
  56. X Require a verification e-mail, but let users set their password directly on
  57. the 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. E-MAIL TEMPLATES
  62. ----------------
  63. Regarding e-mail templates:
  64. You do not have to alter any e-mail templates, User Registration Password
  65. overrides the default 'Account activation' e-mail template from version
  66. 7.x-1.3 and from 6.x-1.0 (and higher) during installation. So there is no
  67. need to change anything anymore on a fresh installation.
  68. If you have previously modified the account activation e-mail template
  69. before you installed this module and discovered that it overrides the
  70. default Account activation e-mail template, no worries! The installer saves
  71. your changes to the template to a temporally variable and revives them when
  72. you disable AND uninstall User Registration Password. Your modifications are
  73. revived and you can now copy paste them to a text file and re-install
  74. User Registration Password again and make the changes to the 'account
  75. activation' e-mail template based on your previous version.
  76. MULTILANGUAL SITES
  77. ------------------
  78. For multilangual sites: i18n / variables are supported for the e-mail template.
  79. Be sure to enable them at the admin/config/regional/i18n/variable page and to
  80. translate them via the admin/config/regional/translate page.
  81. Ones configured correctly, users will receive an e-mail in their default
  82. language, setting available on user's edit page. It does not matter what the
  83. site language is, this setting will be leading and supercede the site's default
  84. language. So it is logical and corrent that if you have an German based site
  85. with, let's say German and English languages enabled, and German is also the
  86. site's default language, still when users have English as their default browser
  87. language, they will receive an English e-mail.
  88. KNOWN ISSUES
  89. ------------
  90. None yet that we didn't solve.
  91. If you run into problems, like access denied or other (possibly) cache-related
  92. issues, or if you have enabled the module via drush, remember to clear
  93. the site cache via the admin/config/development/performance page.
  94. If this does not help, first try on IRC if anyone can help you, if you still
  95. are not able to get it to work, open a new issue with a descent title and
  96. description of the problem here:
  97. http://drupal.org/node/add/project-issue/user_registrationpassword
  98. DE-INSTALLATION
  99. ---------------
  100. If you want to disable the module temporally, just select the first or second
  101. option on the the admin/config/people/accounts page at:
  102. Require e-mail verification when a visitor creates an account
  103. 1 Do not require a verification e-mail, and let users set their password on the
  104. registration form.
  105. 2 Require a verification e-mail, but wait for the approval e-mail to let users
  106. set their password.
  107. 3 Require a verification e-mail, but let users set their password directly on
  108. the registration form.
  109. This disables the User Registration Password functionality without
  110. disabling / uninstalling it.
  111. If you want to remove the module, just disable and uninstall it as you do
  112. for any other module via the admin/modules page.
  113. UPGRADE NOTES
  114. -------------
  115. 1.4 - 1.5
  116. Due to some code changes the registry is cleared in an update hook. It might
  117. also be required to clear the caches on your site, please test to make sure.
  118. The Drupal coding standards issues have been fixed, all code now validates. This
  119. includes renaming of all named constants, so we advice a review of your code if
  120. you use these in any place in your custom code.
  121. 1.3 - 1.4
  122. You need to run update.php to fix the variable name we changed.
  123. Visit admin/reports/status and click on the update database link
  124. or update.php direct from your browser.
  125. 1.0 - 1.3
  126. In earlier versions, this module did not override the default 'Account
  127. activation' e-mail template. To prevent questions and keep in line with the
  128. level of information we would like to offer with this module, we provide the
  129. default e-mail template this module will use to override the 'Account
  130. activation' e-mail template. When you update from 1.0/1.1/1.2 to 1.3, this
  131. template is not activated when you run the updater. You have to change this
  132. manually, just like before version 1.3, so most of you already know this.
  133. From versions 6.x-1.0 and 7.x-1.3 and up, the installer overrides the default
  134. 'Account activation' e-mail template, so we only list it here as extra
  135. information.
  136. Modified 'Account activation' e-mail template for User Registration password:
  137. --------------------------------------------------------------------------------
  138. [user:name],
  139. Your account at [site:name] has been activated.
  140. You will be able to log in to [site:login-url] in the future using:
  141. username: [user:name]
  142. password: your password.
  143. -- [site:name] team
  144. --------------------------------------------------------------------------------
  145. You can edit the 'Account activation' e-mail template at the
  146. admin/config/people/accounts page.