-
Notifications
You must be signed in to change notification settings - Fork 48
/
readme.txt
257 lines (184 loc) · 12.4 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
=== MailChimp List Subscribe Form ===
Contributors: crowdfavorite
Tags: mailchimp, email, newsletter, signup, marketing, plugin, widget
Requires at least: 2.8
Tested up to: 4.0
Stable tag: 1.4.3
== Description ==
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.
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!
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!
== Installation ==
This section describes how to install the plugin and get started using it.
= Version 2.8+ =
1. Unzip our archive and upload the entire `mailchimp` directory to your `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Go to Settings and look for "MailChimp Setup" in the menu
4. Enter your MailChimp API Key and let the plugin verify it.
5. Select One of your lists to have your visitors subscribe to.
6. (optionally) Turn on or off the Monkey Rewards option
7. (optionally) Turn your Merge Vars and Interest Groups `on` and `off`
8. Finally, go to Appearance->Widgets and drag the `MailChimp Widget` widget into one of your Widget Areas
9. And you are DONE!
= Advanced =
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:
If you are using Wordpress v2.8 or higher, you can use the short-code:
` [mailchimpsf_form] `
If you are adding it inside a php code block, pop this in:
` mailchimpSF_signup_form(); `
Or, if you are dropping it in between a bunch of HTML, use this:
`<?php mailchimpSF_signup_form(); ?>`
Where ever you want it to show up.
Note: in some environments you will need to install the Exec_PHP plugin to use that method of display. It can be found here:
http://wordpress.org/extend/plugins/exec-php/
== Developer Mode ==
You can enable "Devleoper Mode" by adding the following line to your `wp-config.php` file just above the "That's all, stope editing!" line.
define('MAILCHIMP_DEV_MODE', true);
This will enable the MailChimp List Subscribe plugin to operate without the need to connect an external MailChimp Account, and will provide a
subscription form widget that will not actually submit anywhere.
This will allow you to style and configure the widget in non-production environments that are not publicly accessible.
For more Developer Mode customization options see the following article:
http://connect.mailchimp.com/how-to/how-to-article-configuring-developer-mode-for-the-list-subscribe-wordpress-plugin
== Upgrading ==
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!
== Internationalization (i18n) ==
Currently we have the plugin configured so it can be easily translated and the following languages supported:
* ar_SA - Arabic in Saudi Arabia and Middle East (thanks to [Lenin](http://twitter.com/nine_l) for compiling and Nagwa Ibrahim, Egypt for translating)
* bg_BG - Bulgarian in Bulgaria (thanks to [SiteGround](http://www.siteground.com/wordpress-hosting.htm) for contributing)
* ca - Catalan (thanks to [DeMomentSomTres Vilafranca Web Design](http://demomentsomtres.com) for contributing
* bn_BD - Bangla in Bangladesh (thanks to [Lenin](http://twitter.com/nine_l) for contributing)
* cs_CZ - Czech in the Czech Republic (thanks to [Peter Kahoun](http://kahi.cz/) for contributing)
* da_DK - Danish in Denmark (thanks to Jan Lund for contributing)
* de_DE - German in Germany (thanks to Michael Jaekel for contributing)
* el_GR - Modern Greek in Greece (thanks to Ιωάννης Δημοφέρλιας (John Dimoferlias) for contributing)
* en_US - English in the U.S.
* es_CL - Spanish in Chile (thanks to Tomás Nader for contributing)
* es_ES - Spanish in Spain (thanks to [Claudia Mansilla](http://cricava.com/) for contributing)
* et_ET - Estonian in Estonia (thanks to [Helen Urbanik](http://www.motomaania.ee/) for contributing)
* fr_FR - French in France (thanks to [Maxime Toulliou](http://www.maximetoulliou.com/) for contributing)
* he_IL - Hebrew in Israel (thanks to [שגיב בית](http://www.sagive.co.il) for contributing)
* hu_HU - Hungarian in Hungary (thanks to Okostobi for contributing)
* it_IT - Italian in Italy (thanks to [Stefan Des](http://www.stefandes.com) for contributing)
* ko_KR - Korean (thanks to 백선기 (SK Baek) for contributing)
* nb_NO - Norwegian (thanks to [Alexander Roterud aka Defrag](http://www.tigerpews.com) for contributing)
* nl_BE - Dutch (thanks to [Filip Stas](http://suddenelfilio.net/) for contributing)
* pt_BR - Portuguese in Brazil (thanks to Maria Manoela Porto for contributing)
* pt_PT - Portuguese in Portugal (thanks to [Tiago Faria](http://xroot.org) for contributing)
* ro_RO - Romanian in Romania (thanks to Alexandru Armin Roșu for contributing)
* ru_RU - Russian in the Russian Federation (thanks to [Илья](http://fatcow.com) for contributing)
* sv_SE - Swedish in Sweden (thanks to [Sebastian Johnsson](http://www.agiley.se/) for contributing)
* tr_TR - Turkish in Turkey (thanks to [Hakan E.](http://kazancexpert.com/) for contributing)
If your language is not listed above, feel free to create a translation. Here are the basic steps:
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
2. Grab a transalation editor. [POedit](http://www.poedit.net/) works for us
3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
4. [Fork](http://help.github.com/fork-a-repo/) the [repository on github](https://github.com/crowdfavorite/wp-mailchimp)
5. [Clone](http://help.github.com/remotes/#clone) the _develop_ branch
6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
7. Make a [pull request](http://help.github.com/send-pull-requests/)
== Frequently Asked Questions ==
= What in the world is MailChimp? =
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.
To learn more, just check out our site: [MailChimp](http://mailchimp.com/features/all/)
= Wait a minute, you want me to pay to try this? =
*Absolutely not!* We welcome you to come signup for a [FREE Trial Account](http://mailchimp.com/signup/) and see if you find it useful.
= I want this in my language, do you have a translation? =
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:
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
2. Grab a transalation editor. [POedit](http://www.poedit.net/) works for us
3. Translate each line - if you need some context, just open up mailchimp.php and search for the line number or text
4. [Fork](http://help.github.com/fork-a-repo/) the [repository on github](https://github.com/crowdfavorite/wp-mailchimp)
5. [Clone](http://help.github.com/remotes/#clone) the _develop_ branch
6. Add the appropriately named files to the /po/ directory and edit the /readme.txt to include how you'd like to be attributed
7. Make a [pull request](http://help.github.com/send-pull-requests/)
== Screenshots ==
1. Entering your MailChimp login info
2. Selecting your MailChimp list
3. Configuring your Signup Form display format (optional)
4. Configuring extra fields on your Signup Form (optional)
5. An example Signup Form Widget
== Upgrade Notice ==
= 1.4.3 =
Fixed an issue with improper URLs to updating profile settings
Fixed an issue in which backslashes, single and double quotes were having an extra slash attached
Fixed an issue in which logging out then attempting to reconnect with OAuth prevented actual login
Updated translation files to support the latest strings
Adjust how alerts are handled to prevent header from being seen
Update instances of home_url to properly refernce admin_url
Update to prevent PHP warnings when WP_DEBUG is enabled
= 1.4.2 =
add customized wp_nonces functions for post-back behavior to fix 4.0 callbacks
= 1.4.1 =
Fix for checkbox weirdness on 3.8
= 1.4 =
Added Developer Mode "Kitchen Sink" to aid in styling without having to authenticate a MailChimp account.
= 1.3 =
Now using OAuth flow within plugin for user authentication
Admin UI refresh
= 1.2.11 =
Merged pull request from https://github.com/headshift/wp-mailchimp adding additional translation strings.
= 1.2.10 =
Fixed submission error when apostrophes are present
= 1.2.8=
Fixes bug where entire phone numbers were only being deposited in the area code portion
= 1.2.6 =
Fixes major bug with "Settings" link on Plugins screen.
= 1.2.5 =
Added support for multiple interest groups, field formatting based on type and date picker.
== Changelog ==
= 1.4.3 =
* Prevent assets from having double slashes in the URL which causes issues with caching plugins
* Prevent WP error bars from overlapping the header image and text
* Fixed an issue which generated the incorrect URL to update a profile
* Fixed an issue which would occasionally prevent connection for users with versions of PHP < 5.6.0
= 1.4.2 =
* Update to address changes in nonces for WP 4.0
= 1.4.1 =
* Update styles to be compatible with upcoming 3.8 wp-admin changes
= 1.4 =
* Developer Mode "Kitchen Sink" takes over plugin for local development
* Developer Mode has filters of changable content
* Fix bug related to required US phone validation
= 1.3 =
* Now using OAuth flow for user authentication
* Admin UI refresh
= 1.2.14 =
* Add link to edit profile within error when duplicate signup occurs
= 1.2.13 =
* Fixed bug preventing address fields from submitting correctly.
= 1.2.12 =
* Update spanish language files (es_ES and es_MX)
= 1.2.9 =
* Fixed bug where multiple checkbox type interest groups were returning an invalid error
* Fixed bug where assets were not enqueueing properly if the plugin directory was not set to 'mailchimp'. Now supports any directory name.
= 1.2.8 =
* Fixed bug where entire phone numbers were only being deposited in the area code portion
= 1.2.7 =
* CSS should now always load correctly on the front end
* Adding Hebrew and Romanian language support
* Updating translation contribution instructions
* Tested version is now 3.3.1
= 1.2.6 =
* Fixed bug with "Settings" link appearing on all plugins (props Jason Lane)
* Resolved issue with unnecessary calls to the MailChimp API during upgrade check
* Resolved PHP warning when there weren't any interest groups
= 1.2.5 =
* Field formatting based on type
* Support for multiple interest groups (a data upgrade procedure must be run by visiting the WordPress dashboard)
* Added jQuery datepicker option to be used with dates.
* Added a handful of new translations
* Fixing various PHP notices and deprecated functions (props Jeffry Ghazally)
= 1.2.4 =
* Version bump for proper listing on wordpress.org
= 1.2.3 =
* 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)
* Update MCAPI wrapper to bring back PHP4 support (note: PHP 5.2 to be required starting with WordPress 3.2)
= 1.2.2 =
* Change MCAPI wrapper to use a more unique class name, v1.3 of the API, and a much lighter client library
= 1.2.1 =
* Fixed internationalization path bug.
* Fixed instances where i18n functions weren't necessary in admin.
* Added more strings to be translated.
= 1.2 =
* Recommended Upgrade, please see "Upgrading" section of readme.
* Security and various other improvements