-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathreadme.txt
211 lines (151 loc) · 8.42 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
=== Cherry PopUps ===
Contributors: TemplateMonster 2002
Tags: custom post type, popup, subscribe, mailchimp, cherry framework, login, sign in, custom popup styles, custom open events
Requires at least: 4.5
Tested up to: 4.8.3
Stable tag: 1.1.8
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Cherry PopUps is a powerful and extremely useful plugin, which allows you to create customizable pop-up windows and manage them effectively.
== Documentation ==
This plugin is used to display popups of your projects on a site page. It has its own settings page which allows to save, reset and set default options. With its help you will be able to create various kinds of popups and manage them the way you like.
Full documentation <a href="http://documentation.jetimpex.com/wordpress/index.php?project=cherry_popups">here</a>
== Description ==
Cherry PopUps is a standalone plugin, however it depends on the Cherry Framework package that comes with the plugin by default. You don't need to download any additional modules manually, just be aware of this dependency.
= Flexible Settings =
When it comes to customization, Cherry PopUp offers many options to choose from. You can freely modify the look of your pop-up windows by defining its shape, color scheme, background type, etc.
Here is a list of options that you can use to reshape your pop-ups:
* Popup layout type: allows you to choose between center, center & full width and bottom & full width views;
* Show/Hide animation: allows you to apply fade, scale or move up animations;
* Base style preset: offers several styles for a better compatibility of your pop-ups with the design of your website;
* Popup content type: allows you to choose between subcribe, login register or simple popup type;
* Show once: PopUp will appears just once and won’t come up when you close it;
* Base style settings: popup style settings( background type, background color, opacity, width, height, padding, border radius);
* Overlay settings: overlay style settings( type of overlay, overlay background color, overlay opacity, use Overlay as close button );
* Custom openning event: define event(click, hover) type and selector for current popup;
You can also enable, disable or customize the overlay that will cover the content of your page when the pop-up is on.
Open and Close settings define the conditions under which pop-up windows show up and hide.
= Easy integration with Mailchimp =
One of the best ways of using pop-ups is for collecting emails via integrated newsletter subscription forms. Cherry PopUp is insegrated with Mailchimp out of the box, so you can leverage its functionality to increase traffic and user engagement of your website.
In order to connect Mailchimp to your website, just input your Mailchimp API Key and List ID.
= Login & Registration form =
Responsive Frontend Login and Registration forms. Add your login form in the frontend easily (page or post). And also the registration form.
= Customizable templates =
The plugin offers simplified templating system for .tmpl files. 13 templates are available by default:
* default-popup.tmpl - Main template for displaying popup with all available macros.
* default-simple-popup.tmpl - Template for displaying popup without subscribe form macros.
* default-subscribe-popup.tmpl - Template for displaying popup without content macros.
Cherry PopUp plugin supports templates, which can be quickly modified using macros:
* TITLE - Title of your pop-up window;
* CONTENT - General content;
* SUBSCRIBEFORM - To place a Mailchimp email subscription form;
* LOGINFORM - Login form;
* REGISTERFORM - Register form;
All you need is to create a template file with the macros listed above, and upload it to the templates folder.
Standard templates can be rewritten in the theme. For that you need to create cherry-popups folder in the root catalog of the theme and copy the necessary templates in there. You can also add your own templates. For that you need to create a file with .tmpl extension in the same folder.
= Double pop-ups =
You can enable two pop-up windows simultaneously: for example, one at the beginning, and one at the end of the page.
= Popup Identification on static page =
If standard settings are not enough for identifying visible section, there is a metablock that allows you to add a particular popup to any static page.
= Social login =
The login form allows registering using social network accounts. To use this option one needs to install additional <a href="http://miled.github.io/wordpress-social-login/">WordPress Social Login</a> plugin.
== Installation ==
1. Upload "Cherry Popups" folder to the "/wp-content/plugins/" directory
2. Activate the plugin through the "Plugins" menu in WordPress
3. Navigate to the "Cherry Popups" page available through the left menu
== Screenshots ==
1. Settings page - general settings.
2. Settings page - "Open page" settings.
3. Settings page - "Close page" settings.
4. Settings page - Mailing List manager settings(MailChimp).
5. Popup Settings - General.
6. Popup Settings - Overlay.
7. Popup Settings - Styles.
8. Popup Settings - "Open page" settings.
9. Popup Settings - "Close page" settings.
10. Popup Settings - Custom openning event.
11. Popup Settings - Advanced settings.
12. Popup Identification on static page
13. Login form
== Configuration ==
= Plugin Options =
All plugin options are gathered in PopUps -> Settings
= General settings =
* Enable popups - Enable/disable plugin functions globally for the site
* Enable Plugin on Mobile Devices - Show/hide popups on mobile devices
* Enable for logged users - Show/hide popups for logged in users
= "Open page" settings =
* Default Open Page Popup - Default open page popup identity
* Open page popup display in - Pages identification for the default popup
= "Close page" settings =
* Default Close Page Popup - Default close page popup identity
* Close page popup display in - Pages identification for the default popup
= Mailing List manager settings(MailChimp) =
* MailChimp API key - Add MailChimp Api key
* MailChimp list ID - Profile list id
= Popup Settings =
* Each popup has its own settings which are gathered in Popup settings
= General =
* Popup layout type - Choose popup layout type (center, fullwidth center, fullwidth bottom, fullwidth)
* Show/Hide animation - Choose show/hide animation effects(fade, scale, move up)
* Base style preset - Popup controls base color styles(default, light, dark, blue, red)
* Popup content type - allows you to choose between subcribe, login register or simple popup type
* Show once - PopUp will appears just once and won’t come up when you close it.
= Overlay =
* Type of overlay - Overlay type
* Overlay background color - Choose overlay background color
* Overlay opacity - Set overlay background opacity
* Overlay background image - Set overlay background image
* Overlay close clicking- Clicking on the overlay closes the popup
= Popup Styles =
* Container background type - Container background type (fill-color, image)
* Container background color - Popup container background color
* Container background image - Choose container background image
* Container opacity - Container opacity (active for fill-color type)
* Popup width - Popup container width
* Popup height - Popup container height
* Popup padding - Popup container padding
* Popup border radius - Popup container border radius
= "Open" page settings =
* "Open page" popup appear event - Set an event to which a popup will be opened
* Open delay - Set the time delay when the page loads
* User inactivity time - User inactivity time. Option for Inactivity time after
* Page scrolling value - Page scrolling progress(%). Option for On page scrolling event
= "Close" page settings =
* Outside viewport - Set top border for mouse cursor
* Page unfocus - User sets focus on another page or app in the system
= Custom openning event =
* Custom event type - define custom event type
* Selector - jQuery selector for custom event
= Advanced settings =
* Custom class - Popup custom class
== Changelog ==
= 1.0.0 =
* Initial release
= 1.0.1 =
* Hot fixes
= 1.0.2 =
* Hot fixes
= 1.1.0 =
* Add styles settings tab and new avaliable styles options
* Add new fullwidth popup layout type
* Add login form popup
* Add sign up form popup
* Add subscribe form popup
* Add custom opening event(click, hover)
* Hot fixes
= 1.1.1 =
* Hot fixes
= 1.1.2 =
* Hot fixes
= 1.1.3 =
* Fixes
= 1.1.4 =
* Fix popup style settings
* Upd: documentation
= 1.1.5 =
* Fixes
= 1.1.6 =
* Fixes
= 1.1.8 =
* Fixes