| Parameter |
Description |
Default |
| &site | planyo site ID | demo (= demo site) |
| &language | language of the user interface; currently supported languages: EN, FR, DE, IT, ES, PL, DK, FI, SE, IS, RO | EN (= English) |
| &extra_search_fields | comma-separated extra fields in the search box | none |
| &sort_fields | comma-separated sort fields; a single field will hide the sort dropdown box. Allowed values: name, price, prop_res_xxx (custom resource properties) | none |
| &default_mode | Choose the initial mode: 'search' to
allow clients to search for available dates or 'resource_list' to
display a list of all resources (in such case search must be
initiated by embedding an extra search box -- see last step of
integration in Planyo's admin panel), or 'upcoming_availability' to
show a quick view of upcoming availability. Choosing 'empty' will not display anything by default but will require you to either pass the resource ID to the module as parameter in the URL (resource_id) or add an external search box or calendar preview | resource_list |
| &resource_ordering | Sorting criterium for the listing of resources in the resource list view. This can be set to name (this is the default) which sorts by resource name, or one of prop_res_xxx (custom resource property defined in Planyo) | name |
| &js_framework | One of: 'jquery', 'jquery-noinclude'; Specify if jQuery should be included by this plugin (use the value 'jquery') or if your website already includes jQuery (use the value 'jquery-noinclude') | jquery |
| &seo_friendly | 'true' or 'false'; Choose whether the plugin in the resource list and resource details modes should be SEO friendly (information retrieved from the server when loading the page) or not (information retrieved using Javascript/AJAX). Choosing yes will add a slight delay to the loading time of the page but will let search engines index the resource names, descriptions and photos. | true |
| &use_login | 'true' or 'false'; Choose whether the plugin should use the login information from this modx site. If used, the reservation form items will be automatically prefilled with known values and subsequent reservations will use previously entered data. | false |
| &login_integration_code | If integration with modx login is switched on, you'll need to enter the login integration code which you'll find in advanced integration settings in the Planyo backend. | none |
| &attribute_string | Optional attribute string which can be used to add additional parameters to the planyo plugin | none |