This documentation covers the use of the Scratch2Win onsite user target Joomla plugin.
Installation
Download the plugin package i.e. plg_system_scratch2win.zip and install the same using Joomla Extension Installer. Now go to Plugin Manager, configure your display item/items and enable them. It will be listed as "System - Scratch2Win" in Joomla plugin manager.
Configuration
You can display three different items in your site at a time. Each items comes with various individual settings. These settings are explained below.
Item Options
Publish
You can publish or disable every individual items separately under the plugin.
Access
Set the Joomla User Level who will be able to view this item.
Display Limit
Set your desired display limit for the item. Enter any integer value. This will be the number of times the item will be displayed to any visitor based on your "Display Interval" settings
Display Interval
Set your desired display interval for the item.
- No Limit - The item will be displayed every time the page is loaded. No display limit.
- Limit Per Session - The item will be displayed the number of times that you have set as Display Limit per user session.
- Limit per Day - The item will be displayed the number of times that you have set as Display Limit per day per user.
- Limit per Week - The item will be displayed the number of times that you have set as Display Limit per week per user.
- Limit per Month - The item will be displayed the number of times that you have set as Display Limit per month per user.
Show On
You can show the items on all pages or select few menu items where the item to be displayed.
Display Style
Set your desired display style - Modal Popup or Slide Box.
Loading Delay
Set the delay in micro seconds (eg. 3000 = 3 seconds) after which the item will be displayed after page load.
Auto Close Time
Set the delay in micro seconds (eg. 10000 = 10seconds) after which the item will be closed automatically after page load. Auto Close Time will be reset if the visitor mouse over the item.
Show Scratch Pad
Include a Scratch Pad in the item. If you set this as Yes then you will be see the following settings.
Scratch Pad Width
Width of the Scratch Pad area in pixels.
Scratch Pad Height
Height of the Scratch Pad area in pixels.
Coupon Image
Select the Coupon Image which will be revealed on scratch. You can upload your own coupon image to root/images/scratch2win/coupons
Overlay Image
Set the Overlay Image which will overlay the coupon image before scratch. You can upload your own overlay image to root/images/scratch2win/overlay
Overlay Color
This will act as a additional protection to your coupon image along with Overlay Image. If your overlay image is transparent then overlay color will be displayed.
Scratcher Size
Size of the scratcher in pixels.
Overlay Color
Select your cursor style. You can upload your own customized cursor image to root/images/scratch2win/cursors
Outer Border
Select the outer border color of the item.
Overall Background
Select the background color of the item.
Overall Text Color
Select the text color for contents of the item. This may be overridden by your Templates css. You can still customize the text colors with your text editor below.
Scratch Pad Border
Select the scratch pad border color of the item.
Header
Enter your header texts or any html. You can use mos code {name} to show logged in user's name and {username} to show logged in user's user name.
Description
Enter your description texts or any html. You can use mos code {name} to show logged in user's name and {username} to show logged in user's user name. You can also load any other module inside the description area using Joomla load module content plugin and its mos code. eg. {loadmodule mod_login}
Footer
Enter your footer texts or any html.
Advanced Options
Load jQuery Library
jQuery library is required for the plugin. If your site is already loading jQuery then you must disable this to avoid JavaScript conflict.
Show Auto Close Counter
Show or hide auto close message and counter.