'Portlets' is Plone-speak for the boxes that appear to the left or right side of the main content area on a page. the eCampaigning Tool comes with a range of portlets for you to use and some you can relatively easily add to. In most cases, portlets need to be used within an Action Edition (vs. across a whole site).
eCampaigning Tool portlets are in the /ecampaigning_templates folder under portal_skins via the ZMI. They are added in the standard Plone way to the left or right 'slot' using the standard syntax: here/<portlet template name>/macros/portlet
Ready-To-Go Portlets
Two portlets are ready to do with now:
- An action listing portlet. Lists all non-expired Action Editions and their action counts. To use it add "here/portlet_campaign_actions/macros/portlet" to the left_slots or right_slots property via ZMI
- An action participants listing portlet. List supporters who have not selected to be anonymous (this option must be on for form or put in each record for it to work) To use it add "here/portlet_action_participants/macros/portlet" to the left_slots or right_slots property via ZMI
- Planned: an action progress bar portlet for use across a site
- Planned: an action form portlet for use across a site
- Planned: a tell-a-friend portlet that opens a pre-written tell-a-friend message in their email client (with personalised elements including tracked links and name)
Portlet Templates
For situation where you would like to display different portlets on different steps of the Action Edition process, you can use the following portlet templates to customise what is displayed in the portlet for each step.
- portlet_ectool_step_1: Only shows on step 1 of any Action Editions
- portlet_ectool_step_2: Only shows on step 2 of any Action Editions
- portlet_ectool_step_3: Only shows on step 3 of any Action Editions
Quick Reference
- Get tracking variables from the session: python:request['SESSION']?['entry_url']? or python:request['SESSION']?['origin_url']? or python:request['SESSION']?['onsite_origin_url']?
