VicTheme Property Plugin User Documentation

Below is a selection of the user documentation that I prepared for the VicTheme Property Plugin for WordPress. It walks a user through installing and configuring the plugin for their WordPress site. The copy was written based on existing documentation and a review of customer support requests, with the goal of reducing the support load in the future. I also produced the screenshots found throughout.


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 set up 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

  • 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

Mac

    • 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
      Extract Mac

 

  • 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

Please check that all files are present, as shown below.
Extracted Files

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

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

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.

Agents

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.
New Agent

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.
Agent Attributes

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.
Manage Attributes

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.
Agent Attribute Edit

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.
Agent Fields

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.
Agent Profile

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.
Agent Config

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