Updating the version and the documentation.

README.md

@@ -6,17 +6,32 @@ The generated user note will allow site administrators to see at a glance when a
 
 This can be useful for reference and for resolving disputes and queries about account activation.
 
-There are three ways that an account can be activated. These are all recorded by the plugin using different messages in the generated user note:
+There are numerous ways that an account can be activated, depending on the setting of the User component config setting "New User Account Activation".
 
+###Activation setting 0: "None"
+* Immediate activation: Site is configured to activate accounts as soon as they are registered.
+
+###Activation setting 1: "Self"
 * Self activation: User clicks on the activation link provided in his welcome email after registration.
-* Admin activation: A site administrator activates the account from the user management section of the admin panel.
-* Immediate activation: The account is created by a site administrator from within the admin panel, and is active immediately on creation.
+
+###Activation setting 2: "Administrator"
+* Self verification: User clicks on the verification link provided in his welcome email after registration. This does not activate the account, but triggers a further email to be sent to the site administrators.
+* Admin activation: One of the site administrators then clicks on the link in their email to activate the account.
+
+###Account activation via the admin panel.
+* Admin-created accounts: An account is created by a site administrator from within the admin panel. Accounts created this way are active immediately on creation.
+* Manual activation: An admin user clicks the tick icon in the 'Activated' column of the user list to activate an account manually.
+
+All six of these events are recorded by the plugin, giving different messages in the user note that is generated. The text of the notes can be configured in the plugin's config page.
+
+Where the action is carried out by someone other than the account holder, the notes try to include information about who that person was. This applies to the actions done by admin users. In the case of the two actions done on the admin panel, the system can work this out by getting the user details for the logged in admin user. However in the case of the admin activation link, the admin user does not need to be logged in for it to work. All admin users are sent the same link, so for this event we cannot tell which admin user completed the activation; just that it was done by one of them. The other events done by admin users do require the admin user to be logged in, and thus the plugin can report who did them.
 
 
 Version History
 ----------------
 * 1.0.0     2016-07-03: Initial release.
 * 1.0.1     2016-07-14: Bug fixes: Now works in all three scenarios.
+* 2.0.0     2016-12-13: Made it work with the "Administrator" option for new account activation.
 
 
 Installation
@@ -30,11 +45,7 @@ The plugin has several parameters:
 
 * User note category - This parameter allows you to specify which user notes category the generated notes should be created in. Leave blank for the default 'Uncategorised'.
 
-* Admin Activation Note - This is the text that will appear in the user note if the account is activated by a site administrator.
-
-* Self Activation Note - This is the text that will appear in the user note if the account is activated by the user via the activation email.
-
-* Immediate Activation Note - This is the text that will appear in the user note if the account is active immediately from when it is created by an admin user.
+* Several note text fields - these fields hold the text 
 
 * Subject Text - this is the text that will be used for the for the subject text on the user notes.
 
@@ -48,6 +59,17 @@ Motivation
 ----------------
 This plugin was written from scratch after attempting to resolve a user query over account activation. The account had been activated but the user claimed not to have done so himself and none of the site admins had done it either. We were unable to answer the question. Having the functionality in this plugin would have helped to resolve this.
 
+To Do
+-----
+
+* Move the message strings into a language translation file rather than having them as config settings.
+* Add text to the end of the notes stating that they were generated by the plugin.
+
+Caveats
+-------
+
+* When upgrading, if the note text does not appear, or appears incorrectly, try going to the plugin config page and hitting 'Save'.
+* With regard to the note generated when an admin user clicks an email link to activate an account: The plugin cannot know which admin user does this, so it can't specify them in the note text as it does for other events done by an admin user.
 
 License
 ----------------

notifyactivation.xml

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <extension version="3.0" type="plugin" group="user" method="upgrade">
     <name>PLG_USER_NOTIFYACTIVATION_NAME</name>
-    <version>1.0.1</version>
-    <creationDate>July 2016</creationDate>
+    <version>2.0.0</version>
+    <creationDate>December 2016</creationDate>
     <author>Simon Champion</author>
     <authorEmail>[email protected]</authorEmail>
     <authorUrl></authorUrl>