Plugin Directory

Changeset 2930773


Ignore:
Timestamp:
06/26/2023 08:40:33 AM (3 years ago)
Author:
zebrasoft
Message:

Update README

Location:
immotoolbox-connect/tags/1.3.0
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • immotoolbox-connect/tags/1.3.0/readme.md

    r2930758 r2930773  
    3434== Changelog ==
    3535
    36 = 1.2 =
     36= 1.3 =
    3737* Handle PHP versions up to 8.2
    38 * New filter option to filter properties with price on request : `searchpriceprivate`
    39  
     38* New filter option for properties with price on request
     39
    4040= 1.2 =
    4141* Add handling of not found properties
     
    7474### Property details page
    7575This page is used to display your properties' details.
    76 By default only one is required but if your using a multilingual website you'll have to create of page for each language. 
     76By default only one is required but if your using a multilingual website you'll have to create of page for each language.
    7777This page uses the `[itb_property]` shortcode
    7878
    7979### Search results page
    80 This page is used to display the search results when using a search engine. 
     80This page is used to display the search results when using a search engine.
    8181This page uses the `[itb_searchresults]` shortcode (this shortcode uses the same parameters as the `[itb_listing]` shortcode)
    8282
    8383### Visitor selection page
    84 This page is used to display the properties added to his selection by the visitor. 
     84This page is used to display the properties added to his selection by the visitor.
    8585This page uses the `[itb_selection]` shortcode (this shortcode uses the same parameters as the `[itb_listing]` shortcode)
    8686
     
    9494
    9595#### Using the Gutenberg block :
    96 You can use the "ImmoToolBox Property Listing" block to add the listing inside a page. 
     96You can use the "ImmoToolBox Property Listing" block to add the listing inside a page.
    9797All the options of the listing are inside the Block Setting on the side bar.
    9898
    9999#### Using the manual shortcode `[itb_listing]`
    100 The Property Listing shortcode is `[itb_listing]`. 
     100The Property Listing shortcode is `[itb_listing]`.
    101101You can add it anywhere you want to add a listing inside a page.
    102102
    103103Here are the shortcode parameters :
    104104
    105 **Filter by type :** 
    106 Possible values are 'sale' or 'rental' 
     105**Filter by type :**
     106Possible values are 'sale' or 'rental'
    107107ex: `[itb_listing type="sale"]`
    108108
    109 **Filter by country code :** 
    110 You have to use two-letter country codes 
     109**Filter by country code :**
     110You have to use two-letter country codes
    111111ex: `[itb_listing country="US"]`
    112112
    113 **Of course you can combine this settings :** 
     113**Of course you can combine this settings :**
    114114ex: `[itb_listing type="rental" country="US"]`
    115115
     
    120120**Multi-lingual website**
    121121If your website is multi-lingual, for each language (except WordPress main language) you have to add the parameters :
    122  - property_page_id : the ID of the "Property details page" in the right language (you have to create this page)
    123  - selection_page_id : the ID of the "Visitor selection page" in the right language (you have to create this page)
     122- property_page_id : the ID of the "Property details page" in the right language (you have to create this page)
     123- selection_page_id : the ID of the "Visitor selection page" in the right language (you have to create this page)
    124124
    125125ex: `[itb_listing type="rental" country="US" property_page_id="123" selection_page_id="456"]`
     
    129129This shortcode enable you to display properties inside another page with a slider
    130130
    131 **8 properties for sale** 
     131**8 properties for sale**
    132132ex: `[itb_carousel type="sale" nbpp="8"]`
    133133
    134 **Your properties marked as "selection" in ImmoToolBox** 
     134**Your properties marked as "selection" in ImmoToolBox**
    135135ex: `[itb_carousel featured="1"]`
    136136
    137 **Multi-lingual website** 
     137**Multi-lingual website**
    138138See "Properties listing pages" information above
    139139
     
    141141
    142142#### Using the Gutenberg block :
    143 You can use the "ImmoToolBox Property Seach" block to add the search engine inside a page. 
     143You can use the "ImmoToolBox Property Seach" block to add the search engine inside a page.
    144144All the options of the search engine are inside the Block Setting on the side bar.
    145145
     
    147147The Property Search shortcode is `[itb_search]`.
    148148
    149 **An horizontal search engine** 
     149**An horizontal search engine**
    150150ex: `[itb_search format="horizontal"]`
    151151
    152152**Multi-lingual website**
    153153If your website is multi-lingual, for each language (except WordPress main language) you have to add the parameter "searchresults_page_id"
    154 Where the value of this parameter is the ID of a "Search results page" in the right language. 
     154Where the value of this parameter is the ID of a "Search results page" in the right language.
    155155ex: `[itb_search format="horizontal" searchresults_page_id="123"]`
    156156
     
    161161
    162162**Property not found**
    163 It's possible to specify a page ID to which the visitor should be redirected when the requested property is not found using the parameter `notfound_page_id`. 
     163It's possible to specify a page ID to which the visitor should be redirected when the requested property is not found using the parameter `notfound_page_id`.
    164164ex: `[itb_property notfound_page_id="123"]`
    165165
    166166## Advanced custom html generation
    167 All the html content of this Gutenberg blocks and shortcodes are generated using [Twig](https://twig.symfony.com/) and can be totally customized. 
     167All the html content of this Gutenberg blocks and shortcodes are generated using [Twig](https://twig.symfony.com/) and can be totally customized.
    168168By default the plugin will search for the files inside your theme directory (to avoid problems it's highly recommended to use a child theme)
    169 The files must be located in the directory : 
    170  `/wp-content/themes/YOU-THEME-child/itb-connect/partials/`
     169The files must be located in the directory :
     170`/wp-content/themes/YOU-THEME-child/itb-connect/partials/`
  • immotoolbox-connect/tags/1.3.0/readme.txt

    r2930758 r2930773  
    3434== Changelog ==
    3535
    36 = 1.2 =
     36= 1.3 =
    3737* Handle PHP versions up to 8.2
    38 * New filter option to filter properties with price on request : `searchpriceprivate`
     38* New filter option for properties with price on request
    3939
    4040= 1.2 =
     
    120120**Multi-lingual website**
    121121If your website is multi-lingual, for each language (except WordPress main language) you have to add the parameters :
    122  - property_page_id : the ID of the "Property details page" in the right language (you have to create this page)
    123  - selection_page_id : the ID of the "Visitor selection page" in the right language (you have to create this page)
     122- property_page_id : the ID of the "Property details page" in the right language (you have to create this page)
     123- selection_page_id : the ID of the "Visitor selection page" in the right language (you have to create this page)
    124124
    125125ex: `[itb_listing type="rental" country="US" property_page_id="123" selection_page_id="456"]`
     
    168168By default the plugin will search for the files inside your theme directory (to avoid problems it's highly recommended to use a child theme)
    169169The files must be located in the directory :
    170  `/wp-content/themes/YOU-THEME-child/itb-connect/partials/`
     170`/wp-content/themes/YOU-THEME-child/itb-connect/partials/`
Note: See TracChangeset for help on using the changeset viewer.