| 1 |
=== MailChimp List Subscribe Form === |
| 2 |
Contributors: mc_jesse, crowdfavorite |
| 3 |
Tags: mailchimp, email, newsletter, signup, marketing, plugin, widget |
| 4 |
Requires at least: 2.8 |
| 5 |
Tested up to: 3.1 |
| 6 |
Stable tag: 1.2.4 |
| 7 |
|
| 8 |
== Description == |
| 9 |
|
| 10 |
The MailChimp plugin allows you to quickly and easily add a signup form for your MailChimp list as a widget on your WordPress 2.8 or higher site. |
| 11 |
|
| 12 |
Not sure what [MailChimp](http://www.mailchimp.com/features/full_list/) is or if it will be helpful? Signup up for a [FREE Trial Account](http://www.mailchimp.com/signup/) and see for yourself! |
| 13 |
|
| 14 |
After Installation, the setup page will guide you through entering your Login information, selecting your List from our Service, selecting options for the Merge Fields and Interest Groups you have setup, and then add the Widget to your site. The time from starting installation to have the form on your site should be less than 5 minutes - absolutely everything can be done via the Wordpress Setting GUI - no file editing at all! |
| 15 |
|
| 16 |
== Installation == |
| 17 |
|
| 18 |
This section describes how to install the plugin and get started using it. |
| 19 |
|
| 20 |
= Version 2.8+ = |
| 21 |
1. Unzip our archive and upload the entire `mailchimp` directory to your `/wp-content/plugins/` directory |
| 22 |
1. Activate the plugin through the 'Plugins' menu in WordPress |
| 23 |
1. Go to Settings and look for "MailChimp Setup" in the menu |
| 24 |
1. Enter your MailChimp API Key and let the plugin verify it. |
| 25 |
1. Select One of your lists to have your visitors subscribe to. |
| 26 |
1. (optionally) Turn on or off the Monkey Rewards option |
| 27 |
1. (optionally) Turn your Merge Vars and Interest Groups `on` and `off` |
| 28 |
1. Finally, go to Appearance->Widgets and drag the `MailChimp Widget` widget into one of your Widget Areas |
| 29 |
1. And you are DONE! |
| 30 |
|
| 31 |
= Advanced = |
| 32 |
If you have a custom coded sidebar or something else special going on where you can't simply enable the widget through the Wordpress GUI, all you need to do is: |
| 33 |
|
| 34 |
If you are using Wordpress v2.8 or higher, you can use the short-code: |
| 35 |
` [mailchimpsf_form] ` |
| 36 |
|
| 37 |
If you are adding it inside a php code block, pop this in: |
| 38 |
|
| 39 |
` mailchimpSF_signup_form(); ` |
| 40 |
|
| 41 |
Or, if you are dropping it in between a bunch of HTML, use this: |
| 42 |
|
| 43 |
`<?php mailchimpSF_signup_form(); ?>` |
| 44 |
|
| 45 |
Where ever you want it to show up. |
| 46 |
|
| 47 |
Note: in some environments you will need to install the Exec_PHP plugin to use that method of display. It can be found here: |
| 48 |
http://wordpress.org/extend/plugins/exec-php/ |
| 49 |
|
| 50 |
|
| 51 |
== Upgrading == |
| 52 |
|
| 53 |
If you are upgrading to version 1.2.1 and you used the widget in your sidebar previously, all you need to do is drag the `MailChimp Widget` back into the sidebar, visit the MailChimp settings page (which will have maintained your prior settings), click the "Update List" button, and you're done! |
| 54 |
|
| 55 |
== Internationalization (i18n) == |
| 56 |
Currently we have the plugin configured so it can be easily translated and the following languages supported: |
| 57 |
|
| 58 |
* bg_BG - Bulgarian in Bulgaria (thanks to [SiteGround](http://www.siteground.com/wordpress-hosting.htm) for contributing) |
| 59 |
* cs_CZ - Czech in the Czech Republic (thanks to [Peter Kahoun](http://kahi.cz/) for contributing) |
| 60 |
* da_DK - Danish in Denmark (thanks to Jan Lund for contributing) |
| 61 |
* de_DE - German in Germany (thanks to Michael Jaekel for contributing) |
| 62 |
* el_GR - Modern Greek in Greece (thanks to Ιωάννης Δημοφέρλιας (John Dimoferlias) for contributing) |
| 63 |
* en_US - English in the U.S. |
| 64 |
* et_ET - Estonian in Estonia (thanks to [Helen Urbanik](http://www.motomaania.ee/) for contributing) |
| 65 |
* fr_FR - French in France (thanks to [Maxime Toulliou](http://www.maximetoulliou.com/) for contributing) |
| 66 |
* hu_HU - Hungarian in Hungary (thanks to Okostobi for contributing) |
| 67 |
* it_IT - Italian in Italy (thanks to [Stefan Des](http://www.stefandes.com) for contributing) |
| 68 |
* ko_KR - Korean (thanks to 백선기 (SK Baek) for contributing) |
| 69 |
* nb_NO - Norwegian (thanks to [Alexander Roterud aka Defrag](http://www.tigerpews.com) for contributing) |
| 70 |
* nl_BE - Dutch (thanks to [Filip Stas](http://suddenelfilio.net/) for contributing) |
| 71 |
* pt_BR - Portuguese in Brazil (thanks to Maria Manoela Porto for contributing) |
| 72 |
* pt_PT - Portuguese in Portugal (thanks to [Tiago Faria](http://xroot.org) for contributing) |
| 73 |
* ru_RU - Russian in the Russian Federation (thanks to [Илья](http://fatcow.com) for contributing) |
| 74 |
* sv_SE - Swedish in Sweden (thanks to [Sebastian Johnsson](http://www.agiley.se/) for contributing) |
| 75 |
|
| 76 |
If your language is not listed above, feel free to create a translation. Here are the basic steps: |
| 77 |
|
| 78 |
1. Copy "mailchimp_i18n-en_US.po" to "mailchimp_i18n-LANG_COUNTRY.po" - fill in LANG and COUNTRY with whatever you use for WPLANG in wp-config.php |
| 79 |
2. Grab a transalation editor. [POedit](http://www.poedit.net/) works for us |
| 80 |
3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text |
| 81 |
4. Send it to us - api@mailchimp.com - and we'll test it and include it with our next release |
| 82 |
|
| 83 |
|
| 84 |
== Frequently Asked Questions == |
| 85 |
|
| 86 |
= What in the world is MailChimp? = |
| 87 |
|
| 88 |
Good question! [MailChimp](http://mailchimp.com/features/all/) is full of useful, powerful email marketing features that are easy to use and even a little fun (that's right---we said fun), whether you're an email marketing expert, or a small business just getting started. |
| 89 |
|
| 90 |
To learn more, just check out our site: [MailChimp](http://mailchimp.com/features/all/) |
| 91 |
|
| 92 |
|
| 93 |
= Wait a minute, you want me to pay to try this? = |
| 94 |
|
| 95 |
*Absolutely not!* We welcome you to come signup for a [FREE Trial Account](http://mailchimp.com/signup/) and see if you find it useful. |
| 96 |
|
| 97 |
= I want this in my language, do you have a translation? = |
| 98 |
Maybe! Look in the /po/ directory in our plugin package and see if your language is in there. If it is, great! If it is not, feel from to create one. Here are the basic steps: |
| 99 |
|
| 100 |
1. Copy "mailchimp_i18n-en_US.po" to "mailchimp_i18n-LANG_COUNTRY.po" - fill in LANG and COUNTRY with whatever you use for WPLANG in wp-config.php |
| 101 |
2. Grab a translation editor. [POedit](http://www.poedit.net/) works for us |
| 102 |
3. Translate each line - if you need some context, just open up mailchimp.php or mailchimp_widget.php and search for the line number or text |
| 103 |
4. Send it to us - api@mailchimp.com - and we'll test it and include it |
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
== Screenshots == |
| 108 |
|
| 109 |
1. Entering your MailChimp login info |
| 110 |
2. Selecting your MailChimp list |
| 111 |
3. Configuring your Signup Form display format (optional) |
| 112 |
4. Configuring extra fields on your Signup Form (optional) |
| 113 |
5. An example Signup Form Widget |
| 114 |
|
| 115 |
== Changelog == |
| 116 |
|
| 117 |
= 1.2.4 = |
| 118 |
* Version bump for proper listing on wordpress.org |
| 119 |
|
| 120 |
= 1.2.3 = |
| 121 |
* Change mailchimpSF_where_am_i() to use plugins_url() in place of WP_PLUGIN_URL to take SSL into account when delivering assets (props John LeBlanc) |
| 122 |
* Update MCAPI wrapper to bring back PHP4 support (note: PHP 5.2 to be required starting with WordPress 3.2) |
| 123 |
|
| 124 |
= 1.2.2 = |
| 125 |
* Change MCAPI wrapper to use a more unique class name, v1.3 of the API, and a much lighter client library |
| 126 |
|
| 127 |
= 1.2.1 = |
| 128 |
* Fixed internationalization path bug. |
| 129 |
* Fixed instances where i18n functions weren't necessary in admin. |
| 130 |
* Added more strings to be translated. |
| 131 |
|
| 132 |
= 1.2 = |
| 133 |
* Recommended Upgrade, please see "Upgrading" section of readme. |
| 134 |
* Security and various other improvements |
| 135 |
|
| 136 |
|
