[wmtech] User Self Delete Pro - Manual, Instructions & Installation / Upgrade Guide

Welcome to WMTech Quality Add-Ons!
We care about our products!​

This is the manual and installation guide for our [WMTech] User Self Delete PRO product.
If you are looking for instructions about our [WMTech] User Self Delete LITE product, please take a look >>here<< because they are different!​

AUTOMATIC INSTALLATION INSTRUCTIONS:

We recommend the use of an automated installation and upgrade system.
Two of them are available for free to download at xenforo.com:

• Add-on Install & Upgrade by Chris D
• Install and Upgrade by Waindigo by Jon W

Please try one of them!


MANUAL INSTALLATION INSTRUCTIONS:

1. Download the add-on from our products section after licensing it for your forum(s). Please note, that we are enforcing our license. Please do not download, if you don't agree to it!
2. Upload everything from the "upload" directory in our software package into your web servers forum directory.
3. Install "addon-userselfdeletepro-1xx.xml" in your Xenforo ACP (ACP > Home > Install Add-On).
4. Access "ACP > Home > Options > [WMTech] User Self Delete PRO" to check and setup the options of this add-on.
5. Access "ACP > Users > User Group Permissions". Select the user group you wish to assign user self delete control. There is one permission that needs to be set and it is located in the section named 'General Permissions':
   • [WMTech] PRO - Delete own account
     Set this to "Allow" to allow deletion of own account

Now you can enjoy our add-on at your board!

Special Installation Instructions (e.g. interactions with other add-ons):

• If you have any version of "User Self Delete Lite" or any version of "User Self Delete" (formerly by Chris D) installed the installation process automatically transfers all permissions of that installed add-on and all pending deletion requests to this add-on. It also automatically uninstalls the other add-on.
• Feel free to delete the folder of the uninstalled add-on after the installation of this add-on because it is no longer needed. The folders to be removed are either "/library/UserSelfDelete" or "/library/WMTech/UserSelfDeleteLite".

UPGRADE INSTRUCTIONS:

1. Download the new version of the add-on from our products section after licensing it for your forum(s). You may need to relicense even free add-ons, if your last version is older than 6 months. Please note, that we are enforcing our license. Please do not download, if you don't agree to it!
2. Upload everything from the "upload" directory in our software package into your web servers forum directory overwriting all existing files with the new ones!
3. Go to your Xenforo "ACP > Home > List Add-Ons" and select "[WMTech] User Self delete PRO". At the dropdown arrow on the right, choose "Upgrade Add-On". A pop-up appears and let you select the XML file "addon-userselfdeletepro-1xx.xml" we provide in the upgrade software package.
4. Access "ACP > Home > Options > [WMTech] User Self delete PRO" to inspect existing options and setup any new options of this add-on.
5. Access "ACP > Users > User Group Permissions". Select the user group you wish to check user self deletion control and check the permissions.

This completes an upgrade process and refreshes your board with the enhanced power of a new version.

Special Upgrade Instructions:

• None so far.

ADMIN MANUAL:

Available Options in ACP:
Home > Options > [WMTech] User Self Delete PRO

• Show Link in Account Dropdown Menu?
  If checked, a link to delete the account will be shown to the user directly and prominently in the visitor navigation tab drop down menu.
  If not checked, the link can only be seen in the account navigation sidebar menu.
  Default: Off
  
  
• Contact Information for Users during the Grace Period
  The explanation text on the "Delete Your Account" page for your users provides a contact link so that deleted users can contact you. If left blank this will use the default settings from the Basic Board Information options. If the contact URL is an e-mail address, be sure to prefix it with "mailto:". Default: System contact setting
  PLEASE NOTE: A user with a pending deletion process cannot access any pages at your site (even not "Contact"). This is why we recommend to use an e-mail address!
  
  
• Send Confirmation E-Mail after Each Deletion Request?
  Send Confirmation Mail to User automatically sends a confirmation e-mail message to the requesting user's e-mail address after a deletion request. This can be used as a security feature to prevent accidental deletion of accounts, eg. if foreign people have access to an account.
  Send Confirmation Mail to User & Copy to Admin automatically also sends a copy of each deletion confirmation e-mail to the board's contact e-mail address. This is very convenient if you want to know which users request deletion.
  Send No Confirmation selected means no confirmation e-mail messages will be sent.
  Default: Send Confirmation Mail to User
  
  
• Change Custom User Title?
  If checked, the custom user title of the user requesting the deletion will be changed or added to be "Pending Deletion" (phrase can be changed). This informs your other users that this account will be deleted soon. If the user decides to cancel his deletion request during the grace period, the changed user title will be restored.
  If not checked, the user title won't be changed or added.
  Default: On
  
  
• Disable Personal Conversations?
  If checked, the personal conversation system for a user requesting deletion will be disabled. Since this user cannot access any page at your forum during the deletion grace period, he cannot see or read any personal messages too. If disabled, no new conversation with him can be started.
  If not checked, the current conversation settings of the user stay unchanged.
  Default: On
  
  
• Enable Personal Conversation Autoresponder?
  If checked, a personal conversation auto respond message will be created and activated (message can be customized with phrases) and sent to all users who send a personal conversation message to the user who requested a deletion during the deletion grace period. Thus notifying the users about the receiver not being able to read the message.
  If not checked, no personal conversation auto respond message will be activated.
  Default: Off
  PLEASE NOTE: This feature requires the add-on "Conversation Essentials" to be installed. If you do not have this add-on installed, checking this option has no function.
  PLEASE ALSO NOTE: Activating an autoresponder makes no sense if you've deactivated the Personal Conversation System for the user above!
  
  
• Grace Period (days)
  Set the period of time that the user or the admin has time to cancel the account deletion. At the end of the grace period the account will be deleted automatically.
  Default: 3, Min: 1, Max: 180
  
  
• Send Reminder E-Mail to User Shortly before Deletion?
  If checked, an e-mail message will be sent to the user requesting deletion 1 day before the end of the grace period before the account deletion will be performed. This e-mail message (customizable with phrases) reminds the user of the deletion and provides instructions for the cancelation of the account deletion process.
  If not checked, no reminder e-mail messages will be sent.
  Default: On
  PLEASE NOTE: Reminder e-mails -regardless of this switch- will be sent only if the grace period is at least 2 days or more!
  
  
• Change Content Attribution after Deletion?
  If you enter a username here, the forum content of a deleted user will be attributed to this username after the account will be deleted. By default, it remains attributed to the username of the deleted account with a "Guest" subtitle. If you wish to override this and make it anonymous, e.g. "Deleted User", use this option.
  If empty, the attribution of content of deleted users will not be changed and the XenForo default behavior persists. Default: Empty (no content attribution change)
  PLEASE NOTE: This must be a valid forum user. So please create the user before entering the name here!
  
  
• Auto-Cleaning of Deletion-Log (days)
  The days counting from the day of deletion after which old entries from the deletion log will be automatically removed. Set this to "0" to retain all log entries forever.
  Default: 60, Min: 0 (never clean), Max: 1000
  
  
• Privacy: Anonymize Self-Deletion-Log Entry
  If checked, the deleted user's username is removed from the admin log upon deletion.
  If not checked, the user's username stays in the log.
  Default: Off
  
  
• Privacy: Remove Deletion Reason from Log
  If checked, the user's reason for requesting his deletion is removed from the admin log upon deletion.
  If not checked, the user's reason stays in the log.
  Default: Off

Available Administrator Actions in ACP:
Tools > Logs > User Self Delete Log

• Clear User Self Delete Log
  Removes ALL entries from the log except all still pending requests. Shows confirmation screen before executing the request.
  
  
• Cancel Request
  Each pending deletion request can be cancelled by the administrator. Shows confirmation screen before executing the request.

Available Permissions in ACP:
Users > Permissions > User Group Permissions
Users > Permissions > User Permissions

• [WMTech] PRO - Delete own account
  Select "Allow" to allow this user group or this user to delete his own account.

Available Phrases and Templates in ACP:
Appearance > Templates

• All public templates of this add-on start with "wmt_usd_" The name of the templates is self-explanatory.

Appearance > Template Modifications

• This add-on uses template modifications instead of deprecated template hooks. All template modifications are VERY IMPORTANT for this add-on to be able to work. They are designed for the default style only! If you use any custom style, please check if all modifications have been applied correctly by looking at the numbers in the right column of the line with the modification name. If there is a grey or red number, the modification could not be applied thus making this add-on functionless. Contact us or your style designer to solve those issues!

Appearance > Phrases

• All phrases of this add-on start with "wmt_usd_" The name of the phrases is self explanatory.

Development > Admin Templates (only available in "Debug Mode")

• All admin templates of this add-on start with "wmt_usd_" The name of the templates is self-explanatory.

Development > Email Templates (only available in "Debug Mode")

• All email templates of this add-on start with "wmt_usd_" The name of the templates is self-explanatory.

USER MANUAL:

The user of your XenForo forum is presented with a new link in his account settings reading "Delete Your Account". There is an option to provide this link to your user in the account navigation drop down also.

If the user clicks this link, he can read an information about deleting his account and what will change or not change after deletion. Eg. he will be informed that all written and uploaded content will stay even after the deletion of his account. If you opted to change the attribution of all content, he will be informed about that also.

He will further be informed that his account will stay in a "Pending Deletion" state for the period of time you set up in the options ("Grace Period"). During this state he cannot access any areas at your site and cannot perform any action at all. But he can cancel the deletion request any time during this period.

To perform the deletion request the user is asked for a reason of his deletion request and needs to give his password to confirm his request.

To perform a cancelation of the pending deletion request the user is asked about his password for confirmation.

The user optionally will be sent a confirmation e-mail immediately after his request for deletion.

The user optionally will be sent a reminder e-mail app. 1 day before the deletion occurs.