IBR Plugin Documentation

######
Contents

More…

revision #1 dated 30.01.2014

Itembridge Realtor Plugin

User Guide
Support
Do you need support? Just click!
Folow us on Behance
Folow us on Envato
Folow us on Twitter
Folow us on Facebook

### Installation

##### Upload the plugin on the server

Unpack zip-file ibr.zip to the "/wp-content/plugins/" directory

Upload zip-file with the plugin here: “wp-admin/plugin-install.php?tab=upload". You need to enter the FTP login here.

Heads up! Important: you should have "777" access settings for the wp-content folder before this plugin intallation. Otherwise the plugin won't be installed.

### Activation

##### Activate the plugin on the “Plugins" page (wp-admin/plugins.php)

After plugin activation the following pages will appear:

- Properties - the list of properties with search field

The page of a particular offer view. Here you can find the ID of a particular property for its usage in shortcodes and widgets.

- Agents - the list of agents with search field

The page of a particular agent view. Here you can find the ID of a particular agent for its usage in shortcodes and widgets.

### Regeneration of the internal links

Once you activate the theme, you should regenerate your links. To do that, you have to follow these steps:

- Go to the page Settings> Permalinks (wp-admin/options-permalink.php)
- Reset the settings to "Default"
- Save changes
- Set parameters as it was before the reset (Post name is recommended)
- Save changes

### Settings

Most of the settings are located on the page Settings > Itembridge Realtor (wp-admin/options-general.php?page=ibr_options).

#### Home Page Map Settings

This option allows us to configurate the scale and the center of the map (position marker) on the home page. To change the map scale click on "+" and "-". If you want to change the map center – move the marker.

#### Currency Settings

Here you can change the sign of the currency ($, €); the position of the sign ('before' or 'after the decimals); and allow or disallow the space between the decimals and currency sign.

Also there are separators, which you can customize to your needs

#### Phone Mask Number Settings

This option gives an opportunity to customize the phone number mask.

N - is a number placeholder. Using this placeholder, you can set the phone mask due to your needs

For example: (NNN) NNN-NNNN will give you this mask (123) 456-7890. Note! There is also a test option, where you can see your mask.

#### Area Unit Settings

This option allows you to change the area unit settings for the property. By default there is 'm' (meters) unit. You can change it into whatever area unit you want (foots, yards, km).

### Home page Map Filter Settings

This option has three states:

- Homepage filter closed by default - by default it is disabled (on the home page the filter of the offers will be hidden in the bottom right corner).
- Homepage filter position - Center of Right position of the filter
- Disable map for mobile phones - Enable or disable the map for mobile phones (for devices with a width less than 768 pixels map will not be shown).

### Compare Settings

Our theme has an option of comparing property. To manage it, firstly, you should set up it in the "Setting>Itembridge Realtor" in the field 'Compare Settings

There you will see the tips (as on the screenshot).

You can check the tips you need.

##### How the compare works?

To add the property to the compare, you should go to one of the property, and click on Add to compare (see the screenshot).

Do the same to another property

After adding the second property to the compare you'll see the Go to compare page and Remove from compare (see the screeenshot).

The compare page will look like this:

If you remove one of the property in the compare page, you will be redirected to the remained property

### Homepage Tabs Settings

There are four types of tabs you can add to the home page (the title of the tab is optional):

- Map & filter
- Agents - Agents can be specified by the ID separated by commas. If you don't specify anything, all agents will be displayed.
- Properties - You can specify the ID of the property separating them by commas. If you do not specify anything, all property will be displayed. There are two styles of its output: single offer (if it is not specified by ID, it will be displayed as the last added offer) and the carousel
- Slider - You can specify the ID of the slides separating them by commas. If you do not specify anything, all slides will be displayed. There are two styles of its output: Content (the slides, that you add in your dashboard), and Properties (it will dispay the property)

And this is how it looks:

For more information, you can go to the description of the post types Agents, Property, Slides

### Property Types Settings

You can indicate the name and the color of the marker on the map which is used for these property.

These types will be available during creation/editing the property.

You can add, delete and edit previously added types.

### Price Label Types Settings

These labels will be available when you create/edit the offers.

You can add, delete and edit previously added labels

### Property Sets Settings

This option allows you to create your own sets of property and dispay it.

This theme allows you to create 4 sets of property

To create a set, you have to follow these steps:

- In the Setting>Itembridge Realtor add a new set (type the label of the set)
- When the set appeared, you can specify the count of items, that will be displayed (e.g. 4,5,6)
- Then you should go to the property and edit it. In the footer of the settings, you'll find these states (see the screenshot), and choose the set you need.
- Do the same for other property.
- To display it, we have to use the shortcode `[properties]`. For example: `[properties set="recent"]`
You can change the title, using the option 'title', e.g.: `[properties set="recent" title="Not Recent Title"]`
- Also you can use the carousel to display the property; with the option `style="carousel"`. For example: `[properties set="featured" title="Features" style="carousel"]`

### Agents sets settings

This setting has the save work as the property set.

To add the agents to the set, you should edit their profiles in Users->All Users in the footer of the settings.

### Property and Agents Reviews Settings

In this theme everyone can leave the review on any property or agent.

In the Setting>Itembridge Realtor you can find the settings on this.

You can enable or disable the reviews, using these settings and aslo use the AJAX pagenation, and the reviews per page.

On this screenshots, you can see the default messages for property and agent reviews.

### Post Types

#### Property

For the property, all usual fields are available (title, description, ...).

The features image are uploaded in the "Featured Image" set. You should upload the image in "Upload Images". The image, marked with checkbox, will be used as the features one.

To add more images, you should click on "Add Media" (above the descripton), select all the files you need and upload.

This theme allows you to manage the order of the images. To change them you should go to Add Media>Media Library>Uploaded to this post and move the images as you want

If the properties are created by an agent, it has no 'Agent' field, and the offer is assigned to him automatically.

You can specify the location of the offer by moving the marker on the map, or by typing the address in the auto-complete.

The price is specified in the format 1023.10 or 1023

The price is optional, if there is no price, it will show only the selected label

Selected suffix for the order will be displayed everywhere after the price.

To the attributes of the offer you can specify the name and activity

It is important to follow the correct format of the filling.

#### Agents

Manager can make any user an agent, assigning him an appropriate role.

Agent has the right to add/edit/delete only his own offers.

All standard fields that are inherent to users in WordPress (First Name, Last Name, Password, Email, ...) are available for agents.

Additional fields:

- Phone numbers
- Avatar uploading
- Links to social networks

#### Slides

Slides have the same structure as the Wordpress field (title, description, ...)

Image is uploaded in "Featured Image"

Video. For the best support of different browsers video should be uploaded in all three formats (mp4, ogg, webM). If you upload at least one video, it will be used as the main slide; the image will be ignored. You can mute the video in the settings

You can hide additional information (title, description, ...), it will show a clean slide

Type of the slide. Depending on the selected type, it opens or hides certain fields.

##### Content

- Buttons.You can add an unlimited number of buttons that will be displayed in the slide content. You can specify the text, link and the style (painted or gray) of the buttons.

- ##### Properties

  - The link of the slide (will be used when you click the slide title)
  - The inscription to the price
  - Price
  - Currency

### Send newsletters

Newsletters sending page is located on tab "Send Newsletters"

1. You can select the subscribers, to whom you'll send the newsletters, from the list.
2. The subject of the newsletter is indicated.
3. The message itself is indicated.
4. Also, you can select content from a list that will be added to the message (posts or property).

### Widgets

Can be found here: Appearence > Widgets (wp-admin/widgets.php)

#### IBR Properties Filter

Filter of property; it is shown only on the page of property.

The title of the widget.

#### IBR Enquire Property

Form for sending a message to an agent that is responsible for the property. It is displayed only on a page of a separate property.

The title of the widget.

#### IBR Agent Info

An information about the agent who is responsible for the property. It is displayed only on a page of a separate property.

The title of the widget.

#### IBR Agents Widget

List of the agents.

- The title of the widget.
- ID of the agents that will be displayed. If you do not specify anything, it will show the last 5 agents.
- The number of the agents that will be displayed.

#### IBR Properties Widget

List of property

- The title of the widget.
- ID of the property, that will be displayed. If you do not specify anything, it will show the last 5 property.
- The number of property that will be displayed.

#### IBR Subscribe

A widget for subscribing to the newsletters sending.

- The title of the widget.
- The text of the widget. It will be displayed above the Subscription Form.

#### Properties

Parameters:

ids – the IDs of the properties that will be displayed; separated by commas.If you do not specify anything, they will be displayed as the latest offers.

count – the number of the offers that will be displayed. 6 is by default.

title – the title of the shortcode.

style – offers output style. If you specify a "carousel", it will be displayed as a carousel, otherwise, it will be displayed as a standard output with small images.

class – CSS classes, which will be added to the output shortcode.

`[properties title="Our best properies" ids="156, 1785, 655" style="carousel"]`

#### Agents

Parameters:

ids – the IDs of the agents that will be displayed; separated by commas. If you do not specify anything, it will show the last agents.

count – the number of agents that will be displayed. 6 is by default.

title – the title of the shortcode.

class – CSS classes, which will be added to the output shortcode.

`[agents count="9" title="Our recent agents" class="our-agents light"]`

### Social Network Share

Our theme allows you to manage the social network share on your site. Plugin AddThis Social Bookmarking Widget is supported on our theme

After installing the plugin, go to Settings>AddThis Share Click on "Advanced" option and choose Show AddThis on... on "pages"

In "Basic" option, you can choose what sharing tool you like

### Property, Agents Info printing

To have this option on your site, you should install the plugin WP-Print (Download).

### Add to Favourites

Agents have an oportunity to add the property to their favourites

You can find your saved property in the Dashboard (Admin Panel)

Here you see the list of properties, or agents. You can also remove them from favourites

### Ratings

There is an opportunity to leave a review to the property or agents with rating table

To add the rating statements, you should go to Setting>Itembridge Realtor in the Property/Agents review settings

After adding all rating statements, we go to the property

Here we see that this property has no reviews. We'll add the first review with ratings to this property

After adding the review, you'll see the avarage rating of the property.

Also there is an opportunity to filter the property by the "Rating" on the "Map filter"

### Log in via Social Networks

Our theme supports plugins Social Login and Social Login for Wordpress that allow you and all your customer to login via Social Networks

Download "Social Login" plugin

Download "Social Login for Wordpress" plugin