-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
143 lines (90 loc) · 7.63 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
=== Shortcode Revolution ===
Contributors: prasunsen, wakeop
Tags: shortcodes, buttons, tabs, tables, carousel, grid, user profile
Requires at least: 4.2
Requires PHP: 7.0
Tested up to: 5.8
Stable tag: 0.4.2
License: GPLv2 or later
Shortcode everything. The low code / no code tool for WordPress developers, designers, and power users.
/***
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
***/
== Description ==
Shortcode Revolution is a tool that allows you to easily and reliably create various elements on your site. Dynamic elements with data, static design elements like buttons and tables, and so on. It's technically possible to create the shortcodes manually but it's much easier to use the shortcode generator from your Shortcode Revolution menu.
[See some live demos here.](https://blog.calendarscripts.info/shortcode-revolution-for-wordpress/ "Description and demos of the shortcodes")
= Available Shortcodes =
**Post and Comments Shortcodes**
This section allows you to generate shortcodes that dynamically list posts or comments based on search criteria. You can use the shortcodes in widgets or in your custom theme pages.
The posts shortcode lets you search posts by IDs, categories, types, tags or phrases and display them like:
- Default / regular - the posts will be listed with thumbnail, excerpt, publication time, etc. This design (and many of the other Shortcode Revolution templates) can be overridden as explained in the section "Overriding Shortcode Revolution Templates" at the end of this guide.
- List is a short unordered list with the post titles and links.
- Carousel creates a slider / carousel from the posts that respond to your criteria. We use our own custom slider code - no bloated ready sliders, so it's very light and simple.
The related posts shortcode finds and displays which are related to the current or selected post. You can give relation criteria like matching tags and/or categories. The display formats are the same as with the posts shortcode. This excellent shortcode can be added at the bottom of your single post template to always display related content without using yet another plugin.
The comments shortcode displays comments related to a post or just most recent / best comments. The display formats are default and carousel / slider.
**Popups / Modals**
This shortcode lets you create modal windows / lightboxes with any predefined content. It generates a button to click on which appears on the place of the shortcode so you can use it anywhere in your site. This makes it super easy to create lightboxes without writing code or using more plugins.
The modals can contain any kind of images and media, text, other shortcodes, and so on. If your modal contains anything other than plain unformtatted text make sure to insert it in Text mode of your rich text editor (when pasting it in posts, pages, etc).
**Columns & Grids**
These shortcodes let you create modern cross-browser compatible and responsive content that flows in columns or a grid.
The newspaper-like option creates content that automatically flows in multiple columns.
The grid option is more precise in the way that your content flows on the page. You choose exactly what goes into each cell of the grid - the content does not low through the cells / columns. The grid option can also use your custom template.
**Tabs**
The tabs shortcode lets you create tabbed content where the tabs do not reload the whole page. Very easy, light and responsive.
**Buttons**
With this shortcode you can create your own design for buttons - colors, size, style, fonts, and so on. Currently buttons support only URL action (going to another page). Calling custom JS functions is coming soon.
**Tables**
The tables shortcode gives you a super easy way to turn an Excel (CSV) sheet into a HTML table. The data is loaded on the fly so you don't need to recreate the shortcode when the file contents change.
**Flashcards**
This shortcode creates nice interactive flashcards. Mostly used in education and educational games, flashcards typically ask a question and reveal the answer when clicked on them. The flashcards in Shortcode Revolution are just visual elements and do not (yet!) fire any back-end action when flipped.
**Data Shortcodes**
The data shortcodes are used to dynamically pull data from your WordPress database.
We currently support user data shortcode. This shortcode allows you pull data for the currently logged in user, a predefined user, or an user defined by an URL parameter. The shortcode can return data for a specific field of the user profile or use meta, or return the whole user data in a string with variables. In the latter case this is given to you as enclosed content of the shortcode and you can fully modify it before placing it anywhere in your site.
**Custom Shortcodes**
This is an easy way to create predefined pieces of content which you can save and use anywhere. Editing the shortcode in the generator will automatically reflect all occurrences of this shortcode in your site.
**Overriding Shortcode Revolution Templates**
Some of the default designs of the shortcodes - currently for posts, comments, and grid shortcodes - can be overridden with your own versions. To do this create a folder called "shortcode-revolution" inside your WP theme folder. Copy the associated view file from our plugin to that folder and make your changes there. The plugin will use your version and your changes will not be lost when you apply updates to the plugin.
For example if you want to override the carousel for posts, copy the file views/posts-carousel.html.php and make changes to the cop
### Features ###
* Shortcode generator which allows you visually to prepare your shortcodes.
* Shortcodes for posts and commments.
* Shortcodes for popups and modals (lightboxes).
* Columns and grids.
* Buttons and tabs.
* Tables from a CSV.
* Flashcards.
* Data shortcodes pulling data from user profile.
* Open source code that allows customization.
* Localization-ready .pot template file available.
* PHP 6, PHP 7, PHP 8 Compatible.
### Attention WordPress Network (Multi Site) Users ###
When activating the plugin do it as site admin and not as network admin.
== Installation ==
Nothing special here, just the regular WordPress plugin installation as shown [here](https://www.wpbeginner.com/beginners-guide/step-by-step-guide-to-install-a-wordpress-plugin-for-beginners/ "How to install a WordPress plugin").
== Frequently Asked Questions ==
None yet, please ask in the forum
== Screenshots ==
1. Get shortcodes for posts
2. Shortcodes for tabbed content
3. Easily create buttons with different designs
4. Pull data from user's profile
5. Front-end view of posts shortcode in "carousel" mode.
== Changelog ==
= Version 0.4.2 =
1. Added documentation for data shortcodes.
2. Fixed usses with improper except in the loop of the post related shortcodes.
= Version 0.4 =
1. Cleanup of new lines and wpautop() from the grid / columns shortcode and the generator.
2. Fixed issues with backslashes and new lines in the flascards shortcode.
3. Improved the layout of the posts carousel / slider.
= Version 0.3.6 =
- First public release