projects / com.zyxware.civiwci.git / blame
| Commit | Line | Data |
|---|---|---|
| a218e680 | 1 | |
| 3db58255 J |
2 | Widget Creation Interface (WCI) Extension |
| 3 | ||
| 4 | Overview | |
| 5 | ||
| 6 | This is a CiviCRM CMS independent extension for Widget Creation Interface (WCI). which will allow users to create widgets and associate progress bar to show status of the goal set. User can create embed code which can be used by other sites to embed the widget. | |
| 7 | ||
| 8 | Prerequisite | |
| 9 | ||
| 10 | - CMS. (Preferably Drupal Version 7.x) | |
| 11 | - CiviCRM Version 4.7.x or above | |
| 12 | ||
| 13 | Features | |
| 14 | ||
| 15 | - Widget : Create, Edit and Delete | |
| 16 | - Progress bar : Create, Edit and Delete | |
| 17 | - Embed Code : Create, Edit and Delete | |
| 18 | - Default Profile setting | |
| 19 | - Setting | |
| 20 | ||
| 21 | Progress bar | |
| 22 | ||
| 23 | To draw a progress bar we need a starting amount, goal amount and current amount. Using 'Create Progress bar' (civicrm/wci/progress-bar/add) form user can set these information. Current amount for the progress bar is taken from the contributions done in the selected Civi Contribution page. User can select multiple source contribution pages and percentage of amount to take from those contribution pages for calculating current amount in the progress bar. By clicking save the information is saved to database and form gets forwarded to 'Manage Progress bar' page. There user can edit or delete already created progress bars. | |
| 24 | ||
| 25 | Widget | |
| 26 | ||
| 27 | A lot of widget properties can be set here. User can give colors, texts, image for the widget and its elements. There is provision to show either amount or percentage on top of the progress bar in the widget. Also can hide or show border, title, and progress bar caption. Advanced users can override default template by checking 'Override' check box. At that time they have to provide custom template code which should be based on smarty v2. | |
| 28 | ||
| 29 | Mailing list Groups can be added using Civi Group(civicrm/group/add?reset=1). To get that group in the CreateWidget form check 'Mailing List' check box only. | |
| 30 | ||
| 31 | By clicking Save and Preview button information will be saved to the database and a sample widget will be displayed on top of the form. To go to the Manage Widget page click 'Save' button. There user can edit, or delete existing widgets. | |
| 32 | ||
| 33 | Embed Code | |
| 34 | ||
| 35 | To use the widget in other web sites, user has to create embed code. This can be done in 'New Embed Code' (civicrm/wci/embed-code/add) form. Select a widget, give a title and save and preview, it will show the preview of the widget and embed code that can be used in other web sites. Click 'Save' to save and go to 'Manage Embed Code' page where user can edit or delete existing embed codes. | |
| 36 | ||
| 37 | Settings | |
| 38 | ||
| 39 | Mailing list subscription feature also exposed though widget. To use that first create a Profile. Then in that profile add field of type 'contact' as 'email'. Add one more field 'contact' as 'group'. Use 'Public Pages' for 'Visibility'. Note the profile id. Use this id in the Widget Settings(civicrm/wci/settings) for Default profile. | |
| 40 | ||
| 41 | For getting better performance WCI widget uses a cache system. A timeout value can be provided 'Widget cache timeout' field for saving the widget in database for that specified time. | |
| 42 | Static widgets (widgets with out progress bar) will be caches permanently unless there is any change in the widget. | |
| 43 | ||
| 44 | CiviCRM-WCI development is sponsored by Zyxware Tehnologies, Kerala, India. |