RBestate Documentation

Version: 1.0.8 – Latest Update: March 1, 2017

General

We would like to thank you for purchasing RBestate! We are very pleased that you have chosen RBestate for your website, you will not be disappointed! Before you get started, please be sure to always search our Documentation and watch our Video Tutorials. RBestate can only be used with WordPress and we assume that you already have WordPress installed and ready to go. If you do not, please follow this link to see our section on WordPress to help you get started.

WordPress Information

To install this theme you must have a working version of WordPress already installed. If you need help installing WordPress, follow the instructions in WordPress Codex. Below are all the useful links for WordPress information.

  • WordPress Codex – General info about WordPress and how to install on your server.
  • First Steps With WordPress – General info about multiple topics about WordPress.
  • FAQ New To WordPress – The most popular FAQ’s regarding WordPress.

WordPress Installation

How To Install RBestate via WordPress

  • Step 1 – Navigate to Appearance > Themes.
  • Step 2 – Click Install Themes and click the Upload button.
  • Step 3 – Navigate the rbestate.zip file on your computer and click "Install Now"
  • Step 4 – Activate the newly installed theme by going to Appearance > Themes and clicking the Activate button.
  • Step 5 – Once you activate RBestate, you will be redirected to our Welcome Screen. You will then see a notification message to install the required plugin.
  • Step 6 – In the notification message, click the "Bing Install Plugin" button to go to the Plugins tab where you can install and activate the required & recommended plugins.
  • Step 7 – Simply click the Install button on each plugin to start installing them. After you’ve installed them, an Activate button will appear which you can click to start activating them.

Required Plugin: Advanced Custom Fields Pro

RBestate requires Advanced Custom Fields plugin to be installed and activated. Without it, the theme will not work properly.

ACF is the most popular custom fields plugin for WordPress. It allows you to add all kinds of custom fields to any post type. It is integrated into the RBestate theme so you can add your very own property fields.


IMPORTANT: Do not make any changes to any "Field Name", you can change "Field Label" and other values/settings, but DO NOT change "Field Name" for any of the default fields imported by you.

ACF Pro license key

RBestate includes the ACF Pro plugin for free. But as any other bundled premium plugin, we are not allowed to share the license key with you. You can read more about it here: http://www.advancedcustomfields.com/resources/including-acf-in-a-plugin-theme/

ACF Pro Update Method

Whenever we release a theme update we include the latest version of ACF Pro, and make adjustment in theme according to each update of the plugin.

You can’t update the premium plugin yourself. Please ignore the updates until we release a theme update. If you want to update ACF to the latest version by yourself, you can purchase a license of ACF Pro from: http://www.advancedcustomfields.com/pro/

With each update of the theme, if you are asked to update ACF PRO plugin, you can update the plugin and if that process fails you can try the following method.

​Please deactivate, uninstall and delete Advanced Custom Fields Pro plugin. When you will do that you will see a notification to install “Advanced Custom Fields Pro” plugin. If you do not see that please go to Appearance->Install Plugins.

You will see Advanced Custom Fields Pro plugin in the list, please install and activate the plugin and you will get the latest plugin with respect to our theme update.

Note: Please make sure when you try this method, you have parent RBestate theme active , if the child theme will be active the process will throw error. You can switch back to child them after updating the plugin.

ACF Pro Additional Fields

On top of the default fields you can add as many field groups/fields as you want.

If you want to create new fields or you want to create another field group for properties, you can do that easily. These custom property fields are visible on the single property page, property submit page and can also be used for your own custom property search.

Currently Supported Custom Field Types:

  • Text
  • Textarea
  • Number
  • Email
  • Url
  • Password
  • Wysiwyg Editor
  • oEmbed
  • Image
  • File
  • Gallery
  • Select
  • Checkbox
  • Radio Button
  • True / False
  • Post Object
  • Page Link
  • Relationship
  • Taxonomy
  • User
  • Google Map
  • Date Picker
  • Color Picker
  • Message
  • Tab
  • Repeater
  • Flexible Content

How To Create Additional Property Field Group

Once you have installed and activated the Advanced Custom Fields Pro plugin, go to Custom Fields on the left-hand side of your WordPress menu. First of all we have to create a so called "Field Group". There for click "Add New" next to the Field Group title, as shown in the screenshot below.

On the next screen under Location > Rules > Show this field group if set the post type to equal "Properties", as the screenshot below illustrates.

How To Add Additional Custom Property Fields

Simply click the blue "+Add Field" button and enter the field settings. The "Label" appears on the single property page under "Property Fields". "Name" is created automatically, but here you have to make a little change in name of the field.

Once you are finished creating all custom property fields, click “Publish”.

How to output custom fields anywhere in your theme: http://www.advancedcustomfields.com/resources/displaying-custom-field-values-in-your-theme/

Advanced Custom Fields Resources: http://www.advancedcustomfields.com/resources/

Required Plugin: Contact Form 7

RBestate supports contact plugin for you website contact page.

Contact Form 7 can manage multiple contact forms, plus you can customize the form and the mail contents flexibly with simple markup. The form supports Ajax-powered submitting, CAPTCHA, Akismet spam filtering and so on.


After you have installed and activated Contact Form 7 plugin you will see a new menu item named “Contact” on the left-hand side of your WordPress admin area. This plugin allows you to add contact forms anywhere on your site. Each form has its own shortcode, which you simply copy & paste wherever you need it.


 				
					<p>[text* contact_form_name placeholder "Name*"]</p>
					<p>[text* contact_form_subject placeholder "Subject*"]</p>
					<p>[email* contact_form_email placeholder "Email*"]</p>
					<p>[textarea* contact_form_message placeholder "How can we help you?"]</p>
					<p>[submit "Send Message"]</p>      					 
				

Required Plugin: Redux Framework

RBestate supports redux framework for you website theme option.

Redux is a simple, truly extensible and fully responsive options framework for WordPress themes and plugins. Built on the WordPress Settings API, Redux supports a multitude of field types as well as: custom error handling, custom fields & validation types, and import/export functionality.


Fields Types

  • Background
  • Border
  • Button Set
  • Checkbox / Multi-Check
  • Color (WordPress Native)
  • Color Gradient
  • Color RGBA
  • Date
  • Dimensions (Height/Width)
  • Divide (Divider)
  • Editor (WordPress Native)
  • Gallery (WordPress Native)
  • Image Select (Patterns/Presets)
  • Import/Export
  • Info (Header/Notice)
  • Link Color
  • Media (WordPress Native)
  • Multi-Text
  • Password
  • Radio (w/ WordPress Data)
  • Raw (HTML/PHP/MarkDown)
  • Section (Indent and Group Fields)
  • Select (Select/Multi-Select w/ Select2 & WordPress Data)
  • Select Image
  • Slider (Drag a Handle)
  • Slides (Multiple Images, Titles, and Descriptions)
  • Sortable (Drag/Drop Checkbox/Input Fields)
  • Sorter
  • Spacing (Margin/Padding/Absolute)
  • Spinner
  • Switch
  • Text
  • Textarea
  • Typography

Recommended Plugin: Breadcrumb NavXT

RBestate supports the most popular breadcrumb NavXT plugin

Breadcrumb NavXT, the successor to the popular WordPress plugin Breadcrumb Navigation XT, was written from the ground up to be better than its ancestor. This plugin generates locational breadcrumb trails for your WordPress powered blog or website. These breadcrumb trails are highly customizable to suit the needs of just about any website running WordPress. The Administrative interface makes setting options easy, while a direct class access is available for theme developers and more adventurous users.

Recommended Plugin: WP-Polls

RBestate supports the most popular WP-Polls plugin

WP-Polls is extremely customizable via templates and css styles and there are tons of options for you to choose to ensure that WP-Polls runs the way you wanted. It now supports multiple selection of answers.


General Usage (With Widget)

  • Go to WP-Admin -> Appearance -> Widgets.
  • You can add the Polls Widget by clicking on the 'Add' link besides it.
  • After adding, you can configure the Polls Widget by clicking on the 'Edit' link besides it.
  • Click 'Save Changes'.

Recommended Plugin: WP-PostRatings

RBestate supports the most popular WP-PostRatings plugin

A useful plugin that lets you add an AJAX rating system to any properties. You can choose from a range of rating images including regular 5 star images, bars, squares, thumbs up and down, numnbers and hearts. You can set the rating value for each rating option and also set who is allowed to submit a rating.

You can get your visitors to rate your posts on a scale of one to five. It provides a wealth of functions you can use to display the stats around your site.

Demo Content Import

This step is optional, but highly recommended, as it will help you understand how all the parts of the theme play together. You can build upon the demo content or simply copy-and-paste what what you need, and delete the demo files.

  • Step 1 – Navigate to Tools > Import.
  • Step 2 – Click on WordPress ( bottom of the list ).
  • Step 3 – A window should appear click the Install now button which is on bottom right.
  • Step 4 – Click Activate plugin & Run Importer. Then choose the rbestate_demo.xml file and click upload file and import Do not interrupt/cancel the import process
  • Step 5 – You can now either 1. import the author from the demo content, 2. create a new user or 3. assign posts to an existing user. To keep it simple use option 3 and assign the imported posts to an existing user. If you want to import free stock demo images make sure to check "Download and import file attachments".
  • Step 6 – Done! But you still need to set the Menu, Widget, Homepage.


  • Step 1 – Navigate to Appearance -> RB Estate > Import/Export.
  • Step 2 – Click import from file button.
  • Step 2 – Copy all content of rbestate_theme_option.json
  • Step 2 – Click Import Button.

Setting Up Home Page

Setting up your home page is the same as setting up any other regular pages, except that you need to specify in the settings which page will be your Main Home Page. RBestate includes three home Pages.

  • Step 1 – Navigate to Settings > Reading tab.
  • Step 2 – Select A Static Page option.
  • Step 3 – Choose the page you want as your home page from the Front Page dropdown list. (Home page - Banner , Home page - Slider , Home page - google map)
  • Step 4 – This is also the same spot you select the blog page as the Posts page.

Widgets

A WordPress Widget is a small block that performs a unique function. Widgets can then be added to widget-ready areas of the theme called widget sections. RBestate has some pre-made widget sections and also allows you to create an unlimited amount of custom widget sections. Widgets are a great way to further customize your site. Please see below for different articles that detail widgets and widget sections in RBestate.

It’s important to understand the difference between a widget and a widget section. Please see the below information to help understand the difference between the two.

Widget – A WordPress Widget is a small block that performs a unique function. RBestate includes several custom widgets such as the RBestate contact widget, RBestate Social widget, or the Recent properties widget. In addition, there are several default widgets that WordPress includes such as Recent Posts or Recent Comments. Widgets will always go inside a widget section.

Widget Sections – A Widget Section is a container that holds widgets. Widgets must go inside a widget section to be able to display on the site. It’s a great way to customize your site.


RBestate provides the following widgetized areas:

  • Blog Sidebar
  • Page Sidebar
  • Agents Sidebar
  • Properties Sidebar
  • Single Property Sidebar
  • Footer Column 2 Sidebar
  • Footer Column 3 Sidebar
  • Footer Column 4 Sidebar

Besides the default WordPress widgets RBestate offers the following real estate specific widgets:

  • Advanced Search Widget
  • Contact Widget
  • Social Widget
  • Feature Agents Widget
  • Feature Properties Widget
  • Latest Properties Widget
  • Related Articles Widget
  • Related Properties Widget

pages

In WordPress, you can write either posts or Pages. When you're writing a regular blog entry, you write a post. Posts, in a default setup, appear in reverse chronological order on your blog's home page. Pages are for content such as "About," "Contact," etc.

In general, Pages are very similar to Posts in that they both have Titles and Content and can use your WordPress Theme templates files to maintain a consistent look throughout your site.

You can select every page themplate for page and if you want use this page in menu.

  • Author
  • Blog
  • Compare
  • Contact
  • FAQ
  • Homepage - Banner
  • Homepage - Google Maps
  • Homepage - Slider
  • My Properties
  • Property Submit
  • Testimonial
  • User Profile
  • User Register
  • User change password
  • User login
  • User lost password
  • Wishlist
  • Widget search

User Registration

  • User register – Go to Page > Add New and select page template "User Register" under Page Attributes > Template and hit "Publish".
  • User login – Go to Page > Add New and select page template "User login" under Page Attributes > Template and hit "Publish".
  • User Profile – Go to Page > Add New and select page template "User Profile" under Page Attributes > Template and hit "Publish".
  • User change password – Go to Page > Add New and select page template "User change password" under Page Attributes > Template and hit "Publish".
  • User lost password – Go to Page > Add New and select page template "User lost password" under Page Attributes > Template and hit "Publish".
  • User Property Submit – Go to Page > Add New and select page template "Property Submit" under Page Attributes > Template and hit "Publish".
  • My Properties – Go to Page > Add New and select page template "My Properties" under Page Attributes > Template and hit "Publish".

Contact Page

Go to Page > Add New and select page template "Contact" under Page Attributes > Template and hit "Publish".

Scroll down until you see the contact box, there you will be able to customize the contact page. Please enter phone number, mobile number, fax number, email address, address, marker, map and social links.

Theme Options

The theme comes with an extensive Theme Options Panel. From the Theme options panel you will be able to set or change the color of the theme, layout, header style, social icons and a lot more. You should take the time to go through all of these options to ensure that you are getting the most out of the theme. Click RB Estate to access the Theme Options Panel.

  • General Settings
  • Styling Options
  • Slider - map - banner
  • Homepage Layout Manager
  • Top Bar Styling
  • Header Styling
  • Search Option
  • Currency Option
  • Menu Option
  • Parallax Option
  • Contact Informations
  • Social Media Options
  • Testimonial Setings
  • Gallery Option
  • Faq Option
  • Blog Option
  • Pagination Setings
  • Property Option
  • IDX Option
  • Latest properties
  • Feature properties
  • Front end Options
  • Sidebar Setings
  • Agent Setings
  • Page 404 Options
  • Page Loader
  • Footer Options
  • Import Options

Blog

Adding Posts

  • Step 1 – Navigate to Posts > Add New.
  • Step 2 – Start filling in the blanks: enter your post title in the upper field, and enter your post body content in the main post editing box below it.
  • Step 3 – As needed, select a category, add tags, post format, fill in the meta setings below the editor.
  • Step 4 – Upload a featured image for your Post.
  • Step 5 – Click publish button.

On the right hand-side of the “Edit Post” screen you can choose between the following post types:

  • Post Type: Standard – This is the default post type.
  • Post Type: Gallery – Add your content. Scroll down to "gallery image" and select the images you want to add to use for this gallery. Order via drag-and-drop.
  • Post Type: Video – Add your content. Scroll down to "video link", and paste in the Full Video URL.


Slider

  • Step 1 – Navigate to Slider > Add new slider.
  • Step 2 – Start filling in the blanks: enter your slider title in the upper field.
  • Step 3 – Upload a featured image for your slider.
  • Step 4 – Scroll down until you see the slider box, there you will be able to customize the slider. Please enter slider title, description, button text, button link and select one animation.

FAQ

  • Step 1 – Navigate to FAQ > Add new faq.
  • Step 2 – Start filling in the blanks: enter your faq title in the upper field, and enter your faq body content in the main post editing box below it.
  • Step 3 – Select category for faq

Testimonial

  • Step 1 – Navigate to Testimonial > Add new testimonial.
  • Step 2 – Start filling in the blanks: enter your post title in the upper field, and enter your post body content in the main post editing box below it.
  • Step 3 – Upload a featured image for your Post.
  • Step 4 – Scroll down until you see the testimonial box, there you will be able to customize the post. Please enter testimonial user name and company name.

Properties

Edit, view, delete custom taxonomies

From the Admin – Properties – Property location. Go with the mouse over the category name. From those options you can edit/delete/view. Do the same for all custom taxonomies available.


Add custom taxonomies

From the Admin – Properties – Property location. Add New Name, Slug, Description and select parent if necessary


Add property

For add new properties manuly you shoud goto Properties > Add new property



Registered users can be access this page from profile -> Add new property


MLS/IDX

To embed live real estate data from your MLS provider install and activate the dsIDXpress plugin

This plugin embeds actual MLS data into your site, not iframes, so you get maximum SEO benefits. All IDX pages and shortcodes are properly styled: IDX property listings, IDX property detail page and all IDX widgets.

Register your trial account on diversesolutions.com to get your activatio key. After installing and activating the plugin go to IDX > Activation and paste in the key from the registration.

To add IDX links to your site menu go to Appearance > Menus, open your main menu, expand the "Links" tab, enter your IDX page URL, such as www.yourcompany.com/idx/, a "Link Text" and click "Add To Menu".

dsIDXpress comes with three custom widgets. To add them to your IDX page go to Appearance > Widgets. There you will find the following IDX widgets:

  • IDX Areas
  • IDX Listings
  • IDX Search
  • IDX Single Listing

Child theme

What is a Child Theme?

A child theme is a theme that inherits the functionality of another theme, called the parent theme. Child themes allow you to modify, or add to the functionality of that parent theme. A child theme is the best, safest, and easiest way to modify an existing theme, whether you want to make a few tiny changes or extensive changes. Instead of modifying the theme files directly, you can create a child theme and override within.


Why use a Child Theme?

If you modify an existing theme and it is updated, your changes will be lost. With a child theme, you can update the parent theme (which might be important for security or functionality) and still keep your changes. It’s a great way to get started if you are just learning WordPress theme development.


Translate

You can translate RBestate WordPress theme in any language with POEdit. To use this module follow these steps:

  • Download and install POEdit.
  • With POedit open the file rbestate.pot located in languages folder.
  • Translate the file using poedit and save the file with the proper name (for example de_DE.po). If the file name is not right the translation will not work.
  • Upload the .po and . mo files in wp-content/themes/rbestate/languages/ folder. You should have now rbestate.po, rbestate.mo + your new language po and mo
  • Make sure you have nstalled WordPress in your language – http://codex.wordpress.org/Installing_WordPress_in_Your_Language
  • Go in Admin pannel – General Settings and you should see a dropdown with Languages. This is where you will find the languages available based on your file language name (step 4). Select your language and that should be all.