forked from brandid/social-proof-slider
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.txt
executable file
·205 lines (159 loc) · 10.3 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
=== Social Proof (Testimonial) Slider ===
Contributors: alexmustin
Author: brandiD
Author URI: https://buildmybrandid.com/product/social-proof-testimonial-slider/
Tags: awards, carousel, content slider, custom post type, features, feedback, jquery, portfolio, responsive, reviews, quotes, sidebar, slider, slideshow, social, testimonial, video, vimeo, widget, youtube
Requires at least: 4.5
Tested up to: 5.6.1
Stable tag: 2.2.1
Version: 2.2.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Showcase your expertise with an easy-to-customize responsive carousel slider of your featured testimonials.
== Description ==
Seeing is believing. And one of the strongest ways to communicate your expertise is with a visual portfolio of bona fides scrolling along your website. With each click, a slide appears sharing testimonials, logos of awards, reviews, sites you've appeared in or been featured on, or links to your guest posts on popular blogs. It's a quick, seamless way to communicate your online authority, credibility, and skill set through social proof. And it's easy to populate, update, and customize on your WordPress site. As the Social Proof Slider scrolls, your authority grows.
== Installation ==
This section describes how to install the plugin and get it working.
1. Upload the plugin files to the `/wp-content/plugins/sp-testimonial-slider` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. Start by adding a new testimonial -- go to the new Testimonials menu option and select 'Add New.'
4. To use the widget in a sidebar, go to Appearance->Widgets and drag a copy of the 'Social Proof Slider' widget to your desired sidebar.
5. To configure Shortcode display settings, use the Settings->Social Proof Slider screen. For widgets, you will see the settings panel for each Social Proof Slider widget individually.
6. Easily embed responsive YouTube or Vimeo videos! Enter your video code into the "Testimonial Text" field in the following format: `https://www.youtube.com/watch?v=abcde123456` or `https://vimeo.com/12345678` and the rest is done automatically! *Note:* It is recommended to disable the "Auto-play" feature when embedding videos.
== Development ==
To compile the plugin code on your local development environment, you will need to have `Node.js` and `npm` installed.
Follow these steps:
1. Fork the plugin repo into your own GitHub account, then clone it to a folder on your computer.
2. Open the Terminal and navigate to the plugin directory.
3. Install the dependencies by typing: `npm install`
4. Run Webpack: `npx webpack`
5. You should see the project compile - you're ready to develop!
== Frequently Asked Questions ==
= Can I use the Social Proof Slider with the Block Editor? =
Yes! We've added Block Editor support to the plugin - just search for 'SP Testimonials Slider' or find it under the 'Common Blocks' category in the list of Blocks.
Alternatively, you can use a Shortcode block to display the Social Proof Slider - use the following shortcode: `social-proof-slider`
= Can I filter testimonials by category? =
Yes! We've added the ability to create Categories and assign them to your testimonials. In the Block, there is a setting to Filter Posts. Use the Category slug in the block/shortcode/widget settings to hide or show only testimonials assigned to that category.
= How do I create a slider without using the Custom Post Type? =
You can easily create a new slider on any page by using shortcodes. You will need to wrap each testimonial item in a shortcode: `[spslider-item]Your Testimonial Text Here[/spslider-item]`. Then you will need to wrap ALL your testimonial items with the manual slider shortcode:
```
[spslider-manual]
[spslider-item]Your Testimonial Text Here[/spslider-item]
[spslider-item]Your Testimonial Text Here[/spslider-item]
[spslider-item]Your Testimonial Text Here[/spslider-item]
[/spslider-manual]
```
Please see the Screenshots for an example.
= How do I report a bug or request a feature? =
Please open an Issue on the GitHub project:
https://github.com/brandid/social-proof-slider/issues
= Something Else? =
Please use our Support Forum if you need help:
https://buildmybrandid.com/forum/support/plugins/social-proof-testimonial-slider/
== Screenshots ==
1. Social Proof Testimonials Slider
2. SP Slider Block
3. SP Slider Block Settings
4. Entering Testimonial Content
5. Shortcode Settings
6. Widget Settings
7. Display Testimonials in a Widget
8. Use the Customizer for a Live Preview of Widgets
9. Embed Videos into Testimonial Content
10. Video Testimonials
11. For Manual sliders, use shortcode: `spslider-item` to wrap each testimonial, then use `spslider-manual` to wrap them all
12. A Manual Slider created with shortcodes
13. Limit Testimonials by Category
== Changelog ==
= 2.2.1 - (Feb 16, 2021) =
* Update: Compatible with WordPress 5.6.1
* Fix: Updates Block code to replace older deprecated functions.
= 2.2.0 - (Nov 12, 2019) =
* Added: New SP Slider Block: Easily place a 'SP Testimonials Slider' block anywhere on your page and visually configure its display settings in real-time using the Block Editor.
* Update: Compatible with WordPress 5.3
= 2.1.2 - (Aug 9, 2019) =
* Added: Categories to the testimonials CPT
* Added: The ability to only show testimonials in a category
* Update: Compatible with WordPress 5.2.2
= 2.1.1 - (May 15, 2019) =
* Update: Compatible with WordPress 5.2
= 2.1.0 - (Feb 21, 2019) =
* Added: Manual Slider Shortcodes: Create a new slider inline, by using shortcodes. A great way to show different testimonials per page. Uses your Shortcode Slider settings.
* Fix: Compatible with WordPress 5.1
= 2.0.13 - (Jan 21, 2019) =
* Fix: Testimonial Text output: line breaks now display as expected
= 2.0.12 - (Dec 27, 2018) =
* Fix: Compatible with WordPress 5.0.2
* Fix: Removed the link to create a new testimonial for users who are not logged in
* Fix: Settings Page: Featured Image Border settings now only show when "Show Image Border" is enabled
* Fix: Settings Page: Featured Image Border Radius and Featured Image Border Padding settings now accept '0' as a value
= 2.0.11 - (Jul 6, 2018) =
* Fix: CSS update to ensure Dots appear correctly on mobile
= 2.0.10 - (Jun 28, 2018) =
* Fix: Shortcode sliders now correctly read the setting for "Smart Quotes" under Settings > Social Proof Slider
= 2.0.9 - (Jun 11, 2018) =
* Fix: Adds check for SlickJS init, to prevent plugin conflicts
= 2.0.8 - (May 2, 2018) =
* Added: New "Image Border" option -- Adds a Border around the Featured Image
* Added: New "Border Color" option -- Set the color of the Image Border
* Added: New "Border Thickness" option -- Set the thickness of the Image Border
* Added: New "Border Padding" option -- Set the amount of padding between the Image and the Border
* Fix: Color picker labels are no longer hidden by default
* Fix: Color picker in Widgets now triggers a change update
= 2.0.7 - (Jan 25, 2018) =
* Updated: Made the "Auto-Height" option easier to understand. Now choose between: "Variable Height" or "Fixed Height".
* Fix: Compatible with WordPress 4.9.2
= 2.0.6 - (Nov 7, 2017) =
* Added: New "Auto-Height" option -- An option to set if the testimonials area will dynamically adjust to the height of each testimonial. When disabled the testimonials area will stay fixed at the tallest testimonial height.
* Added: New "Vertical Align" options -- How to vertically align the testimonials if the "Auto-Height" option is disabled.
* Added: New "Padding Override" options -- Manually set the spacing between the testimonials items, without having to edit any of your theme CSS code. Includes: content area padding top/bottom, featured image margin top/bottom, text padding top/bottom, quote margin bottom, dots margin top.
* Fix: Updated version of Slick JS from 1.6.0 to 1.8.1 -- now using CDN for the JS and CSS files
* Fix: Updated styling to visually distinguish sub-options
= 2.0.5 - (Jun 14, 2017) =
* Fix: Compatible with WordPress 4.8
= 2.0.4 - (Mar 27, 2017) =
* Fix: Removed some testing output text that was mistakenly left in place
* Fix: Removed a "undefined index" PHP warning
* Fix: Simplified the calls to the testimonials database
= 2.0.3 - (Mar 23, 2017) =
* Added: New "Image" column added to the Testimonials admin screen
* Fix: Widgets -- CSS background-color now gets set to "transparent" when no color is chosen
* Fix: Shortcode -- now properly does "Sort by: random" when selected
= 2.0.2 - (Mar 19, 2017) =
* Fix: Removed "undefined index" PHP warnings
* Fix: Genesis Theme compatibility: no more duplicate IDs for widget containers
* Fix: Removed CSS top-padding on testimonial text, when not showing featured images
= 2.0.1 - (Mar 11, 2017) =
* Fix: Incorrect PHP opening tag, which caused code to display inside Widget Settings, on some installs
* Fix: Added Shortcode Instructions to Shortcode Settings page
= 2.0.0 =
* Update: Completely refactored all code - now follows the recommended WordPress coding and documentation standards.
* Update: This slider uses Slick Carousel - http://kenwheeler.github.io/slick/
* Update: All text input fields are now HTML-compatible. Add photos, logos or videos to your testimonials!
* Fix: Allow transparent background color
* Fix: Hide "Author Name" and "Author Title" if fields are empty
* New Option: Auto-play
* New Option: Auto-play - Display time
* New Option: Animation style ("fade", "slide")
* New Option: Add smart quotes around testimonial text
* New Option: Text alignment ("left", "center", "right")
* New Option: Show prev/next arrows
* New Option: Show navigation dots
* New Option: Navigation dots color
* New Feature: Insert images into any field
* New Feature: Auto-Embed YouTube or Vimeo videos
= 1.1.1 =
* Adds option to show or hide Featured Images
= 1.1 =
* Adds option to Include/Exclude testimonials by ID
= 1.0 =
* First release. Hello, World!
== Upgrade Notice ==
= 2.0.1 =
Fixed an incorrect tag, so now you won't see a wall of PHP code in each Widget's Settings panel. Also added the Shortcode instructions to the Shortcode Settings screen.
= 2.0.0 =
The Social Proof Slider has a major update! To avoid any loss of data, first backup your site and deactivate the Social Proof Slider plugin before upgrading.
= 1.1.1 =
Update to the latest copy of Social Proof Slider for new features!
= 1.0 =
Easily display your testimonials with Social Proof (Testimonial) Slider!