-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreadme.txt
127 lines (89 loc) · 6.45 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
=== Recras WordPress plugin ===
Contributors: zanderz
Tags: recras, recreation, reservation, booking, voucher
Tested up to: 6.7
Stable tag: 6.3.2
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Easily integrate data from your Recras instance, such as packages and contact forms, into your own website.
== Description ==
With this plugin, you can easily integrate data from your [Recras](https://recras.nl/) instance, such as packages and contact forms, into your own website.
To get started, go to the Recras → Settings page and enter your Recras name. For example, if you log in to Recras at `https://mysite.recras.nl/` then your Recras name is `mysite`. That's all there is to it! You can now use widgets to retrieve data. All data is retrieved via a secured connection (HTTPS) to ensure data integrity. Other than the request parameters, no data is sent to the Recras servers.
This plugin consists of the following "widgets". To use them, you first need to set your Recras name (see paragraph above).
* Book processes
* Contact forms
* Packages
* Products
* Voucher info
Widgets can be added to your site in three ways. Using Gutenberg blocks (recommended), using the buttons in the "classic editor" (limited functionality), or by entering the shortcode manually (discouraged).
= Date picker for contact forms =
By default, date pickers in contact forms use the browser date picker. If you want to be able to style the date picker, we recommend to enable the date picker we have included with the plugin. You can enable this on the Recras → Settings page.
**Note**: this setting only applies to standalone contact forms, not to contact forms used in the old online booking of packages integration or in book processes.
= Styling =
No custom styling is applied by default, so it will integrate with your site easily. If you want to apply custom styling, see `css/style.css` for all available classes. Be sure to include these styles in your own theme, this stylesheet is not loaded by the plugin!
For styling the date picker, we refer you to the [Pikaday repository](https://github.com/Pikaday/Pikaday). Be sure to make any changes in your own theme or using WordPress' own Customizer.
= Cache =
All data from your Recras is cached for up to 24 hours. If you make important changes, such as increasing the price of a product, you can clear the cache to reflect those changes on your site immediately.
= Google Analytics integration =
You can enable basic Google Analytics integration for the booking of packages and voucher sales by checking "Enable Google Analytics integration?" on the Recras Settings page. This will only work if there is a global `ga` JavaScript object. This should almost always be the case, but if you find out it doesn't work, please contact us!
== Installation ==
**Easy installation (preferred)**
1. Install the plugin from the Plugins > Add New page in your WordPress installation.
**Self install**
1. Download the zip file containing the plugin and extract it somewhere to your hard drive
1. Upload the `recras-wordpress-plugin` folder to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress
**Using Composer**
1. Type `composer require recras/recras-wordpress-plugin` in your terminal
1. The plugin will automatically be installed in the `/wp-content/plugins/` directory by using Composer Installers
1. Activate the plugin through the 'Plugins' menu in WordPress
== Frequently Asked Questions ==
= Do you support Elementor, WPBakery/Visual Composer, Brizy, etc. ? =
Integrating a book process is possible through Elementor. There are many different page builders but Elementor is the most used one, so we chose to only build this widget for Elementor. Using shortcodes is still possible in all other builders, of course.
= Does the plugin support network installations? =
Yes it does. You can set different Recras names (all settings, for that matter) for each site.
= Can the plugin be installed as "must use plugin" ? =
No. "Must use" plugins don't appear in the update notifications nor show their update status on the plugins page (direct quote from the <a href="https://wordpress.org/support/article/must-use-plugins/">WordPress documentation</a>) which is reason enough for us not to support this.
== Screenshots ==
1. Example of a programme with the Twenty Fifteen theme
2. Example of package information, generated from Recras data
3. The Recras blocks in Gutenberg
== Changelog ==
= 6.3.2 =
* Hide "Package availability" widget when it's not available in your Recras instance
* "Package availability" widget: hide packages where availability API is disabled
= 6.3.1 =
* Fix console message
= 6.3.0 =
* The plugin now hides certain blocks/editor buttons, when they're not available in your Recras instance
* Plugin now requires WP 6.5 or higher
= 6.2.3 =
* Fix error in Elementor when book process cannot be found
= 6.2.2 =
* Update "Fix book process datepicker styling" styles to latest version
* Updated "Tested up to" version to 6.7
* If package in a contact form is required, don't add an empty option
= 6.2.1 =
* Fix warning with Elementor book process widget
* Update Dutch translation
= 6.2.0 =
* Added a book process widget for Elementor
* Improve error message when "id" is set, but empty
* Plugin now requires PHP 7.4 or higher
= 6.1 (highlights) =
* Various small fixes and improvements
* Removed script for very old browsers
= 6.0 (highlights) =
* Various small fixes
* Removed support for Composer Installers
= Older versions =
See [the full changelog](https://github.com/Recras/recras-wordpress-plugin/blob/master/changelog.md) for older versions.
== Upgrade Notice ==
See changelog. We use semantic versioning for the plugin.
== Support ==
We would appreciate it if you use [our GitHub page](https://github.com/Recras/recras-wordpress-plugin/issues) for bug reports, pull requests and general questions. If you do not have a GitHub account, you can use the Support forum on wordpress.org.
We only support the latest plugin of the plugin, on the latest version of WordPress (which you should always use anyway!) and only on [actively supported PHP branches](https://www.php.net/supported-versions.php).
== Credits ==
* Icons from [Dashicons](https://github.com/WordPress/dashicons) by WordPress, released under the GPLv2 licence.
* Date picker is [Pikaday](https://github.com/Pikaday/Pikaday), released under the BSD/MIT licence.
* Country list is by [umpirsky](https://github.com/umpirsky/country-list), released under the MIT licence.