Chimpy

Documentation

• created: 12/01/2013
• latest update: 02/04/2014
• by: RightPress
• www.rightpress.net/chimpy

Chimpy integrates your WordPress website with MailChimp.

This plugin allows you to create and display signup forms. It fully supports advanced MailChimp functionality like groups and merge fields.

This plugin also allows you to set up display conditions - based on them different form may be selected for different sections of your website.

To install Chimpy plugin simply:

• Make sure you have WordPress 3.5+ installed
• Download the plugin from CodeCanyon
• Unzip the downloaded file and locate a file called chimpy.zip under Plugin
• Log in to your WordPress administrator zone
• Go to Plugins --> Add New --> Upload
• Upload file chimpy.zip
• Activate the uploaded plugin

• Download the plugin from CodeCanyon
• Extract the archive
• Locate a folder called chimpy under Plugin
• Upload this folder to wp-content/plugins
• In administrator zone, go to Plugins and activate this plugin

• Integrate WordPress with MailChimp
• Create unlimited signup forms
• Conditional form selection
• Target different forms to different parts of website
• Add signup form widget to any sidebar
• Display signup form as a popup
• "Subscribe to unlock" functionality implemented
• Display forms using shortcode or PHP function
• Display forms under post content
• Add opt-in checkbox to standard WordPress forms
• Synchronize WordPress users with MailChimp list
• Perfectly crafter form design
• 9 predefined color schemes
• Possible to customize styles
• MailChimp groups supported
• MailChimp fields (merge tags) supported
• Change frontend labels directly from admin page
• Translation ready (.pot file included)

• WordPress 3.5+
• PHP cURL extension
• MailChimp account

As soon as you install Chimpy, you will find the following menu link under Settings:

You can access Chimpy settings page by clicking on this link.

Set your MailChimp API key and control general settings:

• MailChimp API key - API key is required for this plugin to communicate with MailChimp servers. To get an API key, login to your MailChimp account and navigate to Account Settings > Extras > API keys.
• Integration status - informs whether connection to MailChimp can be successfully established.

• Require double opt-in - controls whether a double opt-in confirmation message is sent before user is actually subscribed.
• Send welcome email - if double opt-in is disabled and this setting is enabled, MailChimp will send your lists Welcome Email on user subscription. This has no effect if double opt-in is enabled.
• Replace interest groups on update - setting is used by MailChimp to determine whether interest groups are added to a set of existing interest groups of particular user or they are completely replaced with new interest groups. This is applicable when user is already subscribed to the list and profile is being updated.
• Update existing subscribers - control whether existing subscribers are updated when they fill out the signup form again or error is displayed. This has no effect for Sync functionality.

• Display field labels inline - controls whether signup form field labels are displayed inside fields as value placeholders (inline) or above fields.
• Max form width in pixels - if your website features a wide layout, you may wish to set the max width for the form to look better. This has no effect for forms displayed as popup.
• Override CSS - you can further customize the appearance of your signup forms by adding custom CSS to this field. To make changes to the style, simply use CSS class chimpy_custom_css as a basis.

Forms page allows you to create multiple MailChimp signup forms.

To add a new form, click on the following button:

This will add a new section with blank form settings:

To detele one of the forms, simply click on the X icon next to its section name.

Each form can be configured by making changes in one of the following five sections.

• Form title - title of the form, will be displayed in a signup form header.
• Text above form - message to display above form fields.
• Text below form - message to display below form fields.
• Submit button label - form submit button label.
• Color scheme - select one of the predefined color schemes. You can further customize the look & feel of your forms by adding custom CSS rules to Settings > Override CSS.

• Mailing list - select one of your MailChimp mailing lists for users to be subscribed to.
• Interest groups - select interest groups that you want to add automatically or allow users to choose in the form. If no interest groups are available, either mailing list has not been selected yet in the field above or you have no interest groups created for this list.

This section allows you to configure multiple form fields that are linked to the MailChimp merge tags. Click on the Add Field button to add additional field. Click on the X button next to the field to remove it.
Each field must be linked to one MailChimp tag and each tag may be used only once on one form.
If no merge tags are available, you have not selected any list or no merge tags (fields) are configured on your MailChimp account for the selected list.
You can optionally select an icon which will be displayed on the right side of the form.

You can define conditions that need to be matched for this form to be displayed. The following display conditions are available:

• Always display this form - no conditions will be checked.
• Disable this form - form will never be displayed.
• Front page only - form will only be displayed on front page.
• Specific pages - form will be displayed on the selected pages only.
• Specific posts - form will be displayed on the selected posts only.
• Specific post categories - form will be displayed on posts that are associated with one or more of the selected categories.
• URL contains - form will be displayed on pages which have the defined string in their URL.
• Pages not - inversed selection of pages, form will be displayed everywhere else but on selected pages.
• Posts not - inversed selection of posts, form will be displayed everywhere else but on selected posts.
• Post categories not - inversed selection of post categories, form will be displayed everywhere else bet on posts that belong to selected categories.
• URL does not contain - form will be displayed everywhere else but on pages which have the specified string in the URL.

For all options except the first three you will be provided with a field to select pages, posts and categories or to enter URL fragment.

This plugin allows you to display a signup form as a popup which can dramatically increase the signup rate.

• Enable popup - displays popup with mailing list signup form as configured. You can use form conditions for more granual control.
• Form to display - select one of the forms created under tab Forms to display as a popup.
• Open delay in seconds - if set, form will be opened after a specified number of seconds counting from the complete page load.
• Display in - page types where you want the popup to be fired.

• Page frequency - popup will be displayed once in every X pages opened. Leaving blank or setting value to 1 will have the same effect.
• Time frequency in minutes - popup will be displayed once in every X minutes.
• Allow dismissing - if enabled, users will be provided with an option (a link to click) to hide the popup forever without filling in the form.
• Dismiss link text - if popup dismissing is enabled, this will be the text of the dismiss link.

This plugin allows you to display a signup form below all posts and pages automatically.

• Display signup form below - page types where you want the form to be displayed below the main content. You can use form conditions for more granular control.
• Allow only these forms - if you leave this field empty, all forms will have a chance to be displayed. The final form will be selected using form conditions as configured under tab Forms.

This plugin allows you to lock content so only subscribers can access it. Signup form is provided in place of content and user is redirected to actual content automatically after submitting the form.

• Enable content locking - if enabled, posts or pages that match form display conditions will be locked. Only subscribers will be able to access that content. This functionality uses cookies for tracking. If subscriber clears browser cookies, content will be locked again. Use form conditions to control which pages will be locked.
• Form to display - select one of the forms created under tab Forms to display instead of locked content.
• Title - title to display above signup form.
• Message - message to display above signup form.

You can add an opt-in checkbox to standard WordPress forms.

• Add signup checkbox to - select WordPress forms where you would like mailing list opt-in checkbox to appear.
• Checkbox label - label to display next to the checkbox.
• Default state - default checkbox state.
• Mailing list - select one of your MailChimp mailing lists to subscribe visitors to. To save additional fields, create merge tags FNAME, LNAME, ROLE and USERNAME under your list settings in MailChimp.

This plugin is capable of synchronizing WordPress users with mailing list of your choice.

• User roles to sync - select user roles that you would like to synchronize with MailChimp. This feature sends data to MailChimp when one of the following actions occur - user is created, user is updated and user is deleted.
• Mailing list - select one of your MailChimp mailing lists to sync user data with. To save additional fields, create merge tags FNAME, LNAME, ROLE and USERNAME under your list settings in MailChimp.

Select date and birthday field format if you are going to use date and birthday fields.

Translate frontend labels to your language or simply change them to your taste.

It is important to fully understand how this plugin displays signup forms to your customers.
First of all, you must create at least one signup form under Forms. Then, you must activate at least one form display method.
When doing so, you may limit which forms can be displayed using particular display method.

When this plugin notices an opportunity to display a signup form anywhere (i.e. where you set it to be displayed), it will iterate over all forms that you have
configured and allowed for this particular display method and will check if conditions that are set for them are matched. It will display the first form
that matches conditions. That is - if you have multiple forms and the first form does not have any conditions (set to "Always display this form"), this plugin will always
display the first form and will never consider displaying other forms.

It is possible to reorder forms - simply click on the form title and drag it above or below other forms.

The best approach would be to have the most specific forms at the top and the most general ones (e.g. "fallback" form with a setting "Always display this form") at the bottom.

If you have any questions, feel free to visit the support center or submit a support ticket.