resources

We are pleased to announce version 1.1.0 of Sitecontact.

Installation is by a standard Xaraya module installation, adding the module to your module directory, and installing throught the Xaraya Module Listing screen.

If you are upgrading from a prior version, there are important changes for templates that you must implement otherwise you may get broken behaviour or incomplete functionality. Please read the upgrade instructions here online or upgrade.txt included with the Sitecontact module.

In this version

• improved and consistent feedback to user on field, and invalid formatted email entry, and dynamic data field entry (xarigami core)
• ability to add custom functions per form for preprocessing data
• deprecated contactus.php function and instead now have respond.php
• new respond gui and api functions provide support for submit by forms from other modules
• new result.xd template for customization of feedback on form s
• updated and improved obfuscation function for emails
• added instances for contact forms so access can be limited per form (broken in prior merges of mtn scenarios)
• addition of ability for admin to add their own cc list
• fixed the sitecontact block for reliable form return, and bad user data feedback
• updated formcaptcha and formantibot captcha code
• code updates for functions affecting the waiting content block
• extended ability for overridden templates per form, including user form display,html and text email overrides, result page overrides, and admin view and display pages for saved responses
• various bug fixes (see the Sitecontact tracker changelog)

Requirements

Xarigami core or Xaraya 1.1.2/3/4 core

If you use xaraya 1.1.2/3/4 it does not have centralized blocks security and some added dynamic-data functionality currently in xarigami core. You can still use some security checks in xaraya 1.1.2/3/4 by adding sec checks in your block templates. You may also miss some user feedback information in dynamic data that is provided with xarigami core but not xaraya 1.1.2/3/4

If you are using captcha

You will need the latest Formcaptcha 0.3.0 module. The current Formantibot 0.1.0 module is still compatible.

Usage

Check the Sitecontact Module Overview page once the module is installed for usage information and pointers to further information.

The main Sitecontact Project Home Page has Tabs to resources such as how tos, tutorials, and Sitecontact specific news. Please log bugs and feature requests via the Tracker tab. You are welcome to discuss aspects of the module and suggestions, or subscribe, via the Sitecontact Discuss tab.

Upgrade

You must be on at least verson 0.6.1 of Sitecontact to upgrade to this version. If possible, test the upgrade and template changes on your local development copy of your site. You can prepare the changed templates in advance and update them to your live site at the time you upgrade your module. The changes are provided here in detail making them look a little more extensive than what they really are.

Critical changes that may cause module to fail if not completed are marked. Changes marked as important are required to ensure you get the fixed or improved functionality. Other changes are code efficiency or tidy changes, and may improve display output. For best results diff your custom templates against the corresponding new Sitecontact template.

1. Please delete your old Sitecontact module, and replace with the Sitecontact 1.1.0 module (this assumes you have any customized templates or files in your theme). In your site in the Administration Module Listing, upgrade and then activate the module.
2. If you have custom email templates:
   
   1. Critical change - rename any email templates that you have customized per form, to use a hyphen(-) rather than an underscore(_) between the main template and the form name eg user-usermail-html-myform.xt rather than user-usermail-html_myform.xt
   2. Important change - All email forms (user, admin and both html and text) were revised for content and if possible, you should use a good diff application to copy over the new changes to your customized templates.
3. In your custom or form specific user-main.xt template:
   
   1. Critical change - ensure you change contactus.php to respond.php in the form tag. The contactus.php function is now deprecated and respond.php is the function the form submits to.
   2. Important change - Compare the new user-main.xd template at the point and your customized template. Note where username and useremail input tags are added. If you are using these fields, ensure you have the new <xar:set /> and <xar:data-input /> tags and their content. For the useremail, ensure you have the line with :
      <span class="xar-error">#$invalid['useremail']#</span>
   3. Critical change - Ensure you have all the template code in the new user-main.xd template between the comments "Dynamic Data properties input " and "Dynamic Data properties input -end" added to your template to replace existing DD property input.
   4. Important change - Ensure you have all the template code in the new user-main.xd template between the comments "Start captcha support " and "End captcha support" added to your template to replace any existing formcaptcha template code.
4. A new user-result.xd template exists that is displayed to the user on successful form submission. You can override this to form a custom page as is, or for a specific form by appending the form name in the usual way (see the module Overview).