Installation

Thanks for purchasing the VicTheme Property plugin!

This guide will cover installing and configuring the plugin on your WordPress site. Once we're finished, your site will be setup with our collection of demo properties and you'll be ready to start adding locations of your own.

Let's begin with installing the plugin.

Download and Extract Files

After downloading the plugin from the marketplace where you purchased it, you'll need to extract the individual plugin files from the main archive. If given the option when downloading, please choose to save the file, rather than open it.

See the instructions below for either Windows or Mac. If any errors or corruption are reported while extracting the files, please download a fresh copy of the plugin and try again.

Windows Operating System

  • Open File Explorer by clicking the icon that looks like a folder in the task bar at the bottom of the screen
  • Navigate to Downloads by selecting it from the left side panel
  • Double-click the compressed folder named victheme_property-4.x-1.3.10.zip
  • Select Extract from the top menu bar
  • Press Extract all and follow the instructions
    Extract Windows.png

Mac OSX Operating System

  • Open Finder by clicking the smiley face icon on the left side of the Dock at the bottom of the screen
  • Navigate to Downloads by selecting it from the left side panel
    macextract.png
  • Double-click the compressed folder named victheme_property-4.x-1.3.10.zip and confirm that a new folder with the same name has been created
  • Open the new folder by double-clicking it and please check that all files are present, as shown below.
extractedfiles.png

Next, we'll need to visit the WordPress admin dashboard to install the plugins.

Install Plugins

If you are not familiar with adding new plugins to your Wordpress site, please take a moment to review the official documentation.

Use the Upload Plugin button to select and install each of the component plugins. To find the plugin files, navigate to the Downloads folder, then to the new folder that was extracted in the previous step. Please start with victheme_core, which is the core plugin required to use any part of the VicTheme Property suite.

After each installation, select the link to activate the plugin. You can also return to the plugin manager later to activate or deactivate plugins.

Plugin-Upload.png

For a complete installation, install each of the following:

  • victheme_core
  • victheme_property
  • victheme_property_data
  • victheme_agents
  • victheme_maps

Post Install

Once this is complete, you'll see new options in the left panel of your Wordpress dashboard corresponding to the new plugins. Take a look at the Properties, Agents, VicTheme Core, and Maps sections to familiarize yourself with the interfaces.

To load the default property types and generate example posts, select Populate Data from the Properties submenu.

Generate-Data.png

Then press the first Generate button to load the default property types, fields, and attributes. Be aware that this will remove any existing data. The second Generate button will create example property posts which demonstrate the features of the plugin, and serve as templates that can be copied and customized.

Next, let's look at the first steps to getting our new VicTheme Property plugin configured.

Configuration

The VicTheme Property plugin allows you to create two types of objects, agents and properties. Each property belongs to an agent, so it makes sense to create and configure agents first.

Property Agents User

Any WordPress user can be assigned as an agent, though they will only have a limited profile. To take full advantage of the agent profile features, create a new agent according to the directions below. After that, we'll look at configuring Agent Fields and Agent Attributes.

When the VicTheme Property plugin is fully installed, an Agents link will appear in the left panel of the WordPress admin dashboard. Click it, then select Add New Agent.

newagent.png

Next, you'll see the new user creation page, with additional fields for agent specific information. Fill any information that should appear on the agent's profile page. Only a name and email address are required, however. By default, the new agent's Role will be set to Property Agents, and this should not be changed. The other available roles are provided by WordPress and are not compatible with all features of the VicTheme Property plugin.

Agent Attributes

An agent attribute is a custom piece of information that can be added to an agent profile. To create a new agent attribute, press the Add New Attribute button on the Attributes submenu.

agentattributes.png

Fill in the forms as follows to complete attribute creation.

  • Settings

    • Name is the internal label given to the attribute, which will not show up on published pages, but should be considered mandatory for organizational purposes
    • Slug is how the name used in URLs, and using the default is just fine
  • Display

    • Display Label is the label that will be used for the attribute on published pages
    • Show Icon and Show Label control whether the icon and label appear when the attribute is shown
  • Icon

    • Use the Family drop down to select a set of icons, such as the 'Property Icons' family that comes with the VicTheme Property plugin
    • Select an icon from the icon picker
    • Under the Settings, Styling, and Border, control the appearance of the icon on the page
  • Metabox

    • Element is the kind of input used to assign attribute values to agents, like checkboxes, radio buttons, or text input
    • As we'll explore in a moment, most element types require selecting the orange Manage buton from the attribute submenu after saving the attribute, in order to define the available subattributes
    • Since a text field has no predefined options, there's no need to manage text field properties after creation
    • Metabox Title and Metabox Description are used to control the information shown when entering data into an attribute, but they are not shown on published pages
  • Search

    These options control how attributes are used by the agent listing search sidebar. Themes which provide this feature are available from VicTheme, but it is not available in every theme.

    • Search Label is the label displayed above a search box for a given attribute
    • Placeholder sets the text which appears in the search box before a user begins inputting text
    • Searchable selects whether this attribute appears in the search sidebar at all

Press the Save button to complete attribute creation. If using an element type other than text field, press the orange Manage button on the attributes submenu to configure the subattributes.

manageattribute.png

Fill in at least the Name box, and press the blue Add New button to save the subattribute.

Once all desired subattributes have been added, the new attribute can be seen when adding or editing an agent. For example, after selecting Add New Agent, you'll see any agent attributes listed at the bottom of the page as shown below.

agentattributeedit.png

Agent Fields

Fields contain basic information about an agent. This includes their name, photo, and the other options available when creating a new agent. Any enabled fields which have data for a given agent will be displayed on the agent's profile page.

To manage agent fields, select the Fields submenu under Agents.

agentfields.png

From this page, several operations are available for the fields shown.

  • To change the order in which fields appear, drag and drop one to a different place in the list
  • Use the check box in the Enable column to choose whether a field is shown at all
  • Use the check boxes in the Visibility column to select which elements appear when a given field is displayed
  • Press the Edit button in the Settings column to change the name, label, and other aspects of a field
  • Where available, use the orange button to manage field options

To see the effects of any changes, navigate to an agent profile from the Agents page.

agentprofile.png

Agent Configuration

The final options for agents are available by selecting Configuration under Agents. These forms control the appearance and behavior of various elements of agent pages.

agentconfig.png

Most of the changes we can make here are technical in nature and the default values should be appropriate for most users. To take advantage of Contact Form 7 integration, however, we will need to visit this page and select the blue Save button at the bottom of the page. This is required even if the desired form is already selected.

Below is a brief description of each section for reference. For more complete information, please see our Themer Documentation.

  • Main Loop Configuration - Options affecting the loop which generates the agent listing page
  • Media Sizes - Sizing and cropping of various types of images associated with agents
  • Agents Profile Page - Choose between default WordPress template styling or the styling of a specific page to be applied to agent profile pages
  • Agents Listing Page - Like above, but for the single property display page
  • Maps Element - Extensive options to control the behavior and appearance of maps displayed on agent pages
  • Contact Form 7 - Choose which contact form is displayed on agent pages

Properties

A Property object contains all of the information and photos associated with a given piece of real estate in the VicTheme Property Plugin. Like agents, properties have both Property Fields and Property Attributes. However, properties also have Property Types, which are customizable categories with various features.

Property Attributes

Property attributes are custom pieces of information about a property, and they work in the same way as agent attributes. The biggest difference is that the VicTheme Property plugin comes with a number of property attributes already configured for common needs. These can be edited or deleted as needed. See the section on agent attributes above for help.

propertyattributes.png

Property Fields

Like agent fields, property fields contain the basic information needed about a property. They are configured in the same way as agent fields, so reference that section above, if needed.

propertyfields.png

Property Types

Types are the different categories of real estate assets that properties fit into. For example, we may have houses, apartments, and offices.

Essentially, a property type defines which attributes and fields are applicable to a certain category of properties. If 'Pets Allowed' is one of our attributes, we may only want to apply it to houses and apartments, but not to offices.

Enter the property types submenu to create and configure types.

propertytypes.png

Creating or editing a type works like creating or editing an attribute. The Settings and Icon sections should be mostly familiar, but there are a few sections which are new.

newpropertytype.png
  • Settings

    • Choosing a Parent causes the new type to be a subtype of the parent for organizational purposes both on admin screens and when filtering by property type on published pages

For example, let's say we've created two types, Office and Warehouse, which both have the type Commercial as a parent. We'll then see the two child types after selecting the parent when filtering properties.

  • Attributes/Fields

    • Check the box under Name to enable a given attribute or field for this property type
    • Under Settings, choose which elements of an attribute or field will be displayed on pages for properties of this type
  • Maps

    • Maps Icon selects the icon that will appear with the map widget for this type

Property Configuration

Like agent configuration, we have a few more options available here that control the overall appearance and behavior of all properties on our site. Select Configuration in the Properties submenu to see these options.

propertyconfig.png

As with agent configuration, most of the changes we can make here are technical in nature and the default values should be appropriate for most users. To take advantage of Contact Form 7 integration, however, we will need to visit this page and select the blue Save button at the bottom of the page. This is required even if the desired form is already selected.

Below is a brief description of each section for reference. For more complete information, please see our Themer Documentation.

  • Media Sizes - Sizing and cropping of various types of images associated with properties
  • Post Type - How property pages are handled as WordPress posts
  • Teasers Element - Controls for the appearance and behavior of the property teaser element
  • Property Archive Page - Choose between default WordPress template styling or the styling of a specific page to be applied to the property archive page
  • Property Single Page - Like above, but for the single property display page
  • Maps Element - Extensive options to control the behavior and appearance of maps displayed on property pages
  • Contact Form 7 - Choose which contact form is displayed on property pages

Working With Properties

Now that we've covered all aspects of configuring agents and properties, we're prepared to add a new property to our site. To do this, select Add New from the Property menu.

addnewproperty.png

Each property is essentially a WordPress page with additional features. Begin by specifying the title of the property and adding a description of it in the editor box. On the right hand side of the window, there's also an area to select the agent who is responsible for the property.

setagent.png

Below the editor window, select the property's type, then proceed to configure the fields and attributes for the property. Fields and attributes which are left blank will simply not appear on the published property page.

propertyinfo.png

Otherwise, this page works in the same way as the WordPress posts display. From here, you can edit, delete, or explore the properties currently saved on the site.

Wrapping Up

And that's it. We've covered all of the basic features of the VicTheme Property plugin. The only thing left to do is finish adding your agents and properties to the system and publish the properties on your site!

If you need any help, please contact us by submitting a ticket at our support page.