=== ImmoToolBox Connect ===
Contributors: zebrasoft
Donate link:
Tags: immotoolbox, realestate
Requires at least: 4.9
Tested up to: 4.9.8
Requires PHP: 7.0
Stable tag: 1.0.2
License: GPL3
License URI: https://www.gnu.org/licenses/gpl.html

ImmoToolBox Connect displays your properties from ImmoToolBox to your website made with WordPress.

== Description ==
_ImmoToolBox Connect_ displays your properties from ImmoToolBox to your website made with WordPress.

This plugin offers an out of the box solution, but can also be highly customized to fit your theme and requirements.

PS : You need an ImmoToolBox active account to use this plugin.

== Installation ==
1. Upload the plugin files to the `/wp-content/plugins/` directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress
3. On [ImmoToolBox](https://intranet.immotoolbox.com) go to your agency settings page and generate an API Key from _External Apps_ tab.
4. On WordPress go to _ITB Connect_ menu to setup the plugin using this key

== Frequently Asked Questions ==

= Any Question ? =

Ask-us!

== Changelog ==
= 1.0.2 =
* Twig Templates fix

= 1.0.1 =
* Translations fix

= 1.0 =
* First stable version of the plugin

== Upgrade Notice ==
= 1.0 =
* First stable version of the plugin

== Help ==
## Pages created automatically

When this plugin is installed, two pages are automatically created

### Property templage page
This page is used to display your properties' details.
By default only one is required but if your using a multilingual website you'll have to create of page for each language.
This page uses the `[itb_property]` filter

### Search results page
This page is used to display the search results when using a search engine.
This page uses the `[itb_searchresults]` filter (this filter uses the same parameters as the `[itb_listing]` filter)



## Custom pages

### Properties listing pages
You can add as many of this pages as you like using the filter `[itb_listing]` inside those pages.



## Custom filters
Using this filters inside your WordPress content (articles, pages, widgets, ...) displays the selected content.

### Properties listing `[itb_listing]`
As seen above, this filter can be customized.


**Filter by type :**
Possible values are 'sale' or 'rental'
ex: `[itb_listing type="sale"]`

**Filter by country code :**
You have to use two-letter country codes
ex: `[itb_listing country="US"]`

**Of course you can combine this settings :**
ex: `[itb_listing type="rental" country="US"]`

**Order the results**
Possible values : date, price, area
ex: `[itb_listing type="sale" order="price" direction="desc"][/itb_listing]`


### Slider of properties `[itb_carousel]`
This filter enable you to display properties inside another page with a slider

**8 properties for sale**
ex: `[itb_carousel type="sale" nbpp="8"]`

**Your properties marked as "selection" in ImmoToolBox**
ex: `[itb_carousel featured="1"]`


### Search engine `[itb_search]`

**An horizontal search engine**
ex: `[itb_search format="horizontal"]`


### Property details `[itb_property]`

This filter displays the details of the specified property. The property is either specified in the URL or directly inside the tag (`[itb_property id="123456"]`)


## Advanced custom html generation
All the html content of this filters are generated using [Twig](https://twig.symfony.com/) and can be totally customized.
By default the plugin will search for the files inside your theme directory (to avoid problems it's highly recommended to use a child theme)
The files must be located in the directory :
 `/wp-content/themes/YOU-THEME-child/itb-connect/partials/`