Business Directory Documentation (version 3.0 and higher)

Maybe you’d like to begin with the Quick Start Guide which lists common “I want to do…” scenarios with Business Directory?

We also have Video Tutorials available for some aspects of the plugin.

Old (pre-3.0) Documentation is available in case you need to reference it.

Table of Contents:

Getting Started
Installing Business Directory Initial Setup Quick Start Guide
The BD Customization Guide (file details, directory layout)

Business Directory Administration Panel

Business Directory Front End

Business Directory Premium Modules


Installing Business Directory

To install Business Directory from the WordPress.org repository, start by visiting your Plugins section of your WP admin panel:

Enter “Business Directory” into the search box, click on “Search Plugins”. This will bring up the Business Directory Plugin install screen.

Click on “Install Now”. WP will prompt you with “Are you sure?” Click OK. After the download is complete, click on “Activate Plugin”.

Business Directory is now installed and ready to configure.

Installing Premium Modules

When you purchase a module, you receive a download link. (Combo Packs are slightly different! See the note below) This will allow you to download a ZIP file. The ZIP you download is a full WP plugin. The installation instructions are inside of the plugin, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

NOTE: The Combo Packs are a ZIP file filled with plugins. You need to UNZIP the Combo Pack BEFORE trying the steps above!

Return to Table of Contents


Initial Setup

After installing Business Directory, you will see two new sections added to your WP Admin panel (usually on the lower left):

The Directory menu of the Admin Dashboard is where you perform basic operations with listings, such as creation, editing, deletion of listing, creation, editing, deletion of categories, or creation, editing or deletion of tags.

The Directory Admin menu is ONLY visible to administrators. It contains operations to manage the internal data of your directory, along with specific admin-level functions like Uninstall and Import.

Business Directory will install a short code on a page created by Business Directory during installation.  This page is important and should not be hidden, made private, or deleted.  It is the primary page that BD uses to display your directory on your site.

Getting Started

You will want to perform the following operations to configure your directory immediately:

  1. Configure your Form Fields to define what data your directory will contain
  2. Configure your categories to define what groups listings will fall under
  3. Configure Fee Plans and Payment Gateways (if you plan to sell listings)
  4. Import any initial listings via CSV, if desired
  5. Configure any miscellaneous settings, such as Registration, Regions, Ratings, or Maps

Return to Table of Contents



Admin Panel Overview

The Directory menu of the Admin Dashboard is where you perform basic operations with listings, such as creation, editing, deletion of listing, creation, editing, deletion of categories, or creation, editing or deletion of tags.

The Directory menu is visible to all users of your system WITH the following restrictions:

  • Non-admin users can only see the Directory and Add New Listing links
  • Non admin users cannot see the Categories or Tags links
  • Non-admin users can see only their listings. They cannot change the payment or featured status of their listings
  • Admin users can see all links
  • Admin users can see all listings and change any listing status

This feature allows users to edit their listings in bulk fashion if they need to. They can also edit their listings from the front end, in singular fashion.

The Directory Menu consists of the following operations:

The Directory Admin menu is ONLY visible to administrators. It contains operations to manage the internal data of your directory, along with specific admin-level functions like Uninstall and Import.

The Directory Admin Menu consists of the following operations:

Return to Table of Contents


Directory

The Directory section is where you can browse and filter your existing listings by various
criteria, such as Paid, Unpaid, Draft, Pending Upgrade and so on. It functions very much
like the standard WordPress pages or posts area, where some summary information about the
business listing is shown (Title/Category/Payment Status/Featured Status/Author) along with
a set of actions that can be performed on each listing.

To see the actions, you must hover your mouse over the listing to see all available links for
use.

Actions you can perform from here:

  • Edit the listing (Edit link)
  • Partially Edit the listing (Quick Edit link, mostly just the title, category, publish status, etc)
  • Delete the listing (Trash link)
  • Preview the listing (Preview link)
  • Upgrade/Downgrade the listing (Upgrade to Featured/Downgrade to Normal link)
  • Change payment status the listing (Paid/Not Paid link)

You can perform actions on multiple rows by selecting more than one listing, and then picking
the operation under “Bulk Actions” and then clicking “Apply”.

At the very top, you can also click “Add New Listing” to create a new business listing as well.

Return to Table of Contents


Directory Categories

The Directory Categories section is where you can create/edit/delete categories for your Business
Directory. It functions very much like the standard WordPress categories area with
a set of actions that can be performed on each listing.

To see the actions, you must hover your mouse over the listing to see all available links for
use.

NOTE: The categories used by Business Directory are NOT the same ones used by your
WordPress posts and pages. And similarly, ones you create here can’t see shared by your posts and
pages on the site. WordPress uses a “custom post type” to distinguish BD listings from WP pages,
so the categories don’t, and can’t ever, mix.

To create new categories in Business Directory, first go to the left side section of the Directory Categories page:

Next, you need to enter a category name (required) and determine whether this is a Top Level Category or a child category. If it’s a top level category, select “None” from the Parent drop down, otherwise pick the category under which this new category will belong.

After you have entered your data, click on “Add New Category” and your new category will be in the list.

To modify or update categories in Business Directory, look on the right side section for the list of existing categories.

Actions you can perform from here:

  • Edit the category (Edit link)
  • Partially Edit the category (Quick Edit link, mostly just the title and slug)
  • Delete the category (Delete link)
  • View the listings in that category (View link)

To move a category under another category (re-parent a category), do the following:

  • Select the category you wish to move
  • Click Quick Edit
  • Change the Parent category as appropriate
  • Save the category

To delete a category, click the Delete link after hovering over the desired category with your mouse. Confirm that you wish to delete it, and then select OK. The category will be deleted.

You can perform actions on multiple rows by selecting more than one listing, and then picking
the operation under “Bulk Actions” and then clicking “Apply”.

Return to Table of Contents


Add New Listing

This is the Admin-side form that allows admins or users (who are looking at their WP Dashboard)
a way to enter new listings into the system.

The form used is similar to the one for the Front End Submit Listing form, but with a much
simpler style. It looks very much like the Add New Page form for WordPress posts and pages,
with some notable exceptions.

The upper right area has BD-specific information under the “General Info” mini-tab regarding publish status, payment status
and featured status. They are viewable by everyone, but only editable by administrators.

The “Fee Details” and “Transactions” mini-tabs contain the PayPal, 2Checkout or Google Checkout
transaction information collected when payment was made. If no payment was made to an actual
payment processor, these tabs can be empty.

The Publish section is exactly like a WordPress post or page. The Status field indicates whether
a listing is in Draft or Pending Review state (prior to being published). Normally, you want a
listing to be fully public and published to be visible on your site. Clicking the Publish
button on a new listing will accomplish this for you.

The Directory Categories section allows you to select which categories this listing can belong
to. You may pick more than one category if you wish. The categories are listed by parent and
then children underneath (with a slight indentation)

The Directory Tags allows you to enter tags relating to this listing. The field uses “autocomplete”
logic, so as you type in the field, if BD finds a match to a previously entered tag, it will display
that as an option for you to click to add. You can add multiple tags (including new ones) by
typing them into the field. Or you can remove existing ones by clicking the “x” on the tag.

The main listing details are entered in the center of the screen. Title at the top, description next
in the large text field, and then the remaining fields underneath it.

Depending on which plugins you install, under the BD fields you may see additional sections (such as SEO
metadata editors). At the bottom, there is an “Author” field that can be changed to assign a
post to another user. This function is only available to administrators.

When you are done editing a listing, be sure to click either Publish or Save Draft to ensure that
you do not lose your changes.

Return to Table of Contents


Directory Tags

The Directory Tags section is where you can create/edit/delete Tags for your Business Directory. It functions very much like the standard WordPress Tags area with a set of actions that can be performed on each listing.

To see the actions, you must hover your mouse over the listing to see all available links for use.

NOTE: The Tags used by Business Directory are NOT the same ones used by your
WordPress posts and pages. And similarly, ones you create here can’t see shared by your posts and pages on the site. WordPress uses a “custom post type” to distinguish BD listings from WP pages, so the Tags don’t, and can’t ever, mix.

To create new Tags in Business Directory, first go to the left side section of the Directory Tags page:

Next, you need to enter a Tag name (required) and a slug (value used for the URL when a tag is selected). Slugs should not contain any spaces.

After you have entered your data, click on “Add New Tag” and your new Tag will be in the list.

To modify or update Tags in Business Directory, look on the right side section for the list of existing Tags.

Actions you can perform from here:

  • Edit the Tag (Edit link)
  • Partially Edit the Tag (Quick Edit link, mostly just the title and slug)
  • Delete the Tag (Delete link)
  • View the listings in that Tag (View link)

To delete a Tag, click the Delete link after hovering over the desired Tag with your mouse. Confirm that you wish to delete it, and then select OK. The Tag will be deleted.

You can perform actions on multiple rows by selecting more than one listing, and then picking the operation under “Bulk Actions” and then clicking “Apply”.

Return to Table of Contents


Manage Options

The Manage Options section is where all of the key Business Directory configuration options are entered, edited and maintained. You will spend some time learning about all of the options available, as BD is highly configurable and lots of options are available to control what you users can see and do.

The Manage Option section is comprised of the following “tabs” that are visible on the right once you click “Manage Options” from the Directory Admin menu.

Return to Table of Contents


General Tab

The General tab is used to configure overall settings for the Business Directory. The settings
are called out below.

Permalink Settings
These indicate what values will appear in various URLs used by Business Directory.

Directory Listings Slug: The slug used in the directory URL. This is the main directory URL. Must not contain spaces.
Categories Slug: The slug used in the category display URL, to which the category name will be appended. Example: http://site/wpbdm-category/manufacturing/ where “Manufacturing” is the category, and wpbdm-category is the category slug. Must not contain spaces. Avoid common terms which are already in use, like “category”
Tags Slug: The slug used in the tag display URL, to which the tag name will be appended. Example: http://site/wpbdm-tags/red/ where “Red” is the tag, and wpbdm-tags is the tag slug. Must not contain spaces. Avoid common terms which are already in use, like “tag(s)”

reCAPTCHA Settings
These are the settings for configuring reCAPTCHA that is used on the BD comment and submission forms

Use reCAPTCHA for contact forms: If checked, a captcha will appear on the contact form and will be required
Use reCAPTCHA for listing submits: If checked, a captcha will appear on the submit listing form and will be required
reCAPTCHA Public Key: The public key from http://recaptcha.com that you obtain for your domain
reCAPTCHA Private Key: The private key from http://recaptcha.com that you obtain for your domain

Directory Display Options
These settings control which buttons or links appear in your Directory at the top.

Show the “Submit listing” button: If checked, the Submit Listing button will appear on the Directory, Category and Listings pages
Show “Search listings”: If checked, the Search Box, Advanced Search Link and button will appear on the Directory, Category and Listings pages
Show the “View Listings” button: If checked, the View Listing button will appear on the Directory, Category and Detail pages
Show the “Directory” button: If checked, the Directory button will appear on the Category, Detail and Listings pages

Miscellaneous Settings
Hide tips for use and other information?: This controls the admin panel tips. Leave checked for additional info.
Give credit to plugin author?: Turn on or off the “Powered by Business Directory Plugin” link at the bottom of your site. Default is off.

Return to Table of Contents


Listings Tab

The Listings tab controls settings relating directly to Business Directory listings.

General Settings
Listing duration for no-fee sites (in days): The number of days a “free” listing is valid for. Use a value of “0” to keep a listing alive indefinitely or enter a number less than 10 years (3650 days).
Include listing contact form on listing pages?: If checked, the contact form is present at the bottom of the Detail view of listings
Include comment form on listing pages?: If checked, the comment form is present at the bottom of the Detail view of listings
Show listings under categories on main page? : If checked, on the main Directory page, you will see categories at the top, and then all listings underneath them. Leave unchecked if you only want categories shown on the main directory page.
Override email Blocking?: Turn this setting on if you are having trouble sending email from your Business Directory for contacts. Otherwise, leave unchecked.
Status of listings upon uninstalling plugin: When the plugin is uninstalled, your listings will remain as posts in the blog. This indicates their status.
Status of deleted listings: If you click the ‘Trash’ link, this is the status a post will receive immediately afterward. You can use this to prevent “deleted” listings from being permanently removed.

Listing email settings
Notify admin of new listings via email?: If checked, an email is sent to the admin when a new listing is made.
Send email confirmation to listing owner when listing is submitted?: If checked, the poster of a listing will receive an email confirming their listing was received and the state of it (Pending, Published)
Email confirmation message: The actual text of the confirmation message sent to the user.

Listing Renewal
Turn on listing renewal option?: If checked, a renewal email is sent a few days before the listing expires, reminding the user they need to renew it with you
Listing Renewal e-mail message: The text of the email sent above.

Post/Category Settings
Default new post status: Status of a listing immediately after it’s added to the system. Set to “Pending” if you want to review posts before publishing them (recommended to avoid spam or abusive language)
Edit post status: Status of a post immediately after a user edits it. Similar to New Post, set to “Pending” if you want to review things even after users edit, or set to “Publish” if you trust users after submission.
Order categories list by: The column used to sort listings.
Sort order for categories: Sort ascending (A->Z) or descending (Z->A)
Show category post count?: If checked, your Directory and Search results will show a count of listings in the categories. New directories may wish to uncheck this to make the site look less empty.
Hide empty categories?: If checked, any category without listings in it will not show up in the directory page or search results until a listing is posted there.
Show only parent categories in category list?: If checked, you can hide long lists of subcategories from the Submit Listing page and the Directory page
Order directory listings by: The sort column, similar to Order categories list above.
Sort directory listings by: The sort order, similar to Sort order for categories above.

Featured (Sticky) listing settings
Offer sticky listings?: If checked, your users can “upgrade” their listings (for an additional fee) to sticky/featured. Featured listings always sort at the top of search results, list views, and category pages.
Offer upgrades during submit process?: When checked, the users will be offered this step during the Submit Listing workflow process, toward the end, but before payment.
Sticky listing price: The price of a sticky listing. Will be used for all sticky listings across categories.
Sticky listing page description text: The text shown to the user about upgrading to sticky/featured listings.

Return to Table of Contents


Payment Tab

The Payments tab is where all payment gateways are configured within BD. Business Directory currently supports 3 payment gateway modules:

  1. Google Checkout (included in the Core Plugin)
  2. PayPal (when you buy the PayPal Premium module)
  3. 2Checkout (when you get the 2Checkout Premium module)

Others are being considered (such as Authorize.net) but they are not currently available. Less common payment gateways can be added by those who understand PHP and WordPress API programming and modeling the gateway off of the Google Checkout one in the plugin.

Configuring and installing all three existing gateways is covered below, including the additional payment settings you must make in order to fully activate payments on your site.

Installing Payment Gateways (2Checkout and PayPal)

The ZIP you download is a full WP plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

 

Configuring PayPal Gateway

PayPal can be configured quickly and easily after installing the PayPal Premium module by doing the following:

  1. Install PayPal Gateway module
  2. Go to Directory Admin->Manage Options
  3. Select the Payment tab
  4. At the top, enable Payments
  5. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  6. Change your currency, if applicable
  7. Scroll down to PayPal options
  8. Activate PayPal gateway option
  9. Enter your PayPal email address
  10. Save settings
  11. Create one or more Payment Plans
  12. You’re ready to test payments. Logout as Administrator and attempt to place a listing–verify that it goes through.
  13. IMPORTANT: Once you’re done testing, be sure to Uncheck Put gateways in test mode? so you can accept real payments.

Once correctly configured, your payment options and PayPal configuration will look like this (production mode):

payment-general

 

payment-paypal

Configuring 2Checkout Gateway

2Checkout can be configured quickly and easily after installing the 2Checkout Premium module by doing the following:

  1. Install 2Checkout Gateway module
  2. Go to Directory Admin->Manage Options
  3. Select the Payment tab
  4. At the top, enable Payments
  5. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  6. Change your currency, if applicable
  7. Scroll down to 2Checkout options
  8. Activate 2Checkout gateway option
  9. Enter your 2Checkout ID (you get this from your 2Checkout account information on their site)
  10. Save settings
  11. Create one or more Payment Plans
  12. You’re ready to test payments. Logout as Administrator and attempt to place a listing–verify that it goes through.
  13. IMPORTANT: Once you’re done testing, be sure to Uncheck Put gateways in test mode? so you can accept real payments.

Once correctly configured, your payment options and 2Checkout configuration will look like this (production mode):

payment-general

payment-2checkout

Configuring Google Checkout Gateway

Google Checkout can be configured quickly and easily by doing the following:

  1. Go to Directory Admin->Manage Options
  2. Select the Payment tab
  3. At the top, enable Payments
  4. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  5. Change your currency, if applicable
  6. Scroll down to Google Checkout options
  7. Activate Google Checkout gateway option
  8. Enter your Google Checkout ID (you get this from your Google Checkout account information on their site)
  9. Save settings
  10. Create one or more Payment Plans
  11. You’re ready to test payments. Logout as Administrator and attempt to place a listing–verify that it goes through.
  12. IMPORTANT: Once you’re done testing, be sure to Uncheck Put gateways in test mode? so you can accept real payments.

Once correctly configured, your payment options and Google Checkout configuration will look like this (production mode):

payment-general

payment-google

Creating a Payment Plan

You must have one or more payment plans to accept payments for your listings. Once one or more gateways above are active, do the following to create a payment plan:

  1. Go to Directory Admin->Manage Fees
  2. Verify that at the bottom of the screen, you see green checkmark(s) next to the gateway(s) you have activated above. If not, verify your steps in the proper gateway and retry this screen.
  3. Click on “Add Fee Plan”
  4. Enter the details of the plan–price, name, duration, etc.
  5. Save the plan
  6. Repeat 3-5 until you have all the desired plans available

In the end, you should have something that looks like this:

payment-manage
Return to Table of Contents


Registration Tab

The Registration tab is the place where settings regarding login usage are handled by Business Directory.
In general, Business Directory can participate in the login process setup by WordPress, but most of
the time, other plugins (e.g. Membership plugins) are used to enhance the access granted to members
for posts, categories, pages and even URLs on your site. BD is not designed to handle all of these use
cases, but we integrate well with popular membership plugins (e.g. eMember, s2Member) that DO support these
functions.

NOTE: To work correctly with BD, a membership plugin must be WordPress 3.0 API compliant AND
support custom post types. If it doesn’t do both of those, it will not work correctly with BD.

Registration Settings
Require login?: When checked, your users must have an active WordPress account to post listings
on your directory. If unchecked, anyone can post a listing to your site. If you are using a membership
plugin, you MUST have this option checked to properly integrate the plugins.

Return to Table of Contents


Image Tab

The Image tab is the place where you handle uploaded image sizes and behavior.

The images uploaded by Business Directory are stored in a distinct repository, separate from
WordPress’ media center that is used by your primary blog/site. The reason for this is simple:
you wouldn’t want your listings to lose their images if you shared an image from the site and
then deleted it later. Nor would you want an image uploaded by BD and later removed from the listing
to be accessed by some blog post for the same reasons. While storage requirements go up a little
bit with this decision, the separation of these repositories makes for a cleaner, safer site
where BD can change any image under its control at will, free from the worry it will break something
elsewhere.

NOTE: Any changes you make to the image settings, particularly with sizes, will only
affect NEWLY UPLOADED images, not previously uploaded ones. You can always make manual
changes by editing an image in any listing directly.

The following settings are controlled on this tab:

Image Settings
Allow images?: If checked, users are allowed to upload images to their listings, based upon either their fee plan restrictions (paid sites), or the restriction set for Number of free images below (free sites)
Max Image File Size (KB): The largest size of image to store for upload. Images larger than this size are automatically sized downward to this size to save on space.
Max image width: The widest image you allow on the site. This width is the “detail image” width, which is the width of the image as displayed by clicking on the thumbnail.
Max image height: The tallest image you allow on the site. This height is the “detail image” height, which is the width of the image as displayed by clicking on the thumbnail.
Thumbnail width: The width of the thumbnail used in the list view and gallery view of a listing. The height is computed automatically, maintaining the aspect ratio (width:height).
Turn on thickbox/lightbox?: Turns on the Lightbox feature, if not present in your theme or plugins. Uncheck if it conflicts with other elements or plugins installed on your site
Listings
Number of free images: The number of images allowed to be uploaded to a listing when no payments are accepted.
Use default picture for listings with no picture?: When checked, will display a “No Image” picture in the thumbnail position for a list view. Improves layout by keeping it consistently positioned.
Show Thumbnail on main listings page?: When checked, display the thumbnail on the list view.

Return to Table of Contents


Google Maps Tab

NOTE: This tab only displays if you have Google Maps Premium Module installed with Business Directory.

This tab configures the display settings relating to the use of Google Maps with Business Directory.

General Settings
Turn on Google Maps integration?: Activates the display of the maps on listings, categories and search results when checked. Must be on to use Google Maps.
Show listings map in categories?: When checked, a map will display when a category of listings is clicked, containing all listings visible in the category on the map.
Show listings map in “View Listings”?: When checked, a map will display when View listings is clicked, containing all listings visible in the list on the map.
Show listings map in search results?: When checked, a map will display with the search results, containing all listings visible in the search results on the map.
Display Map position (Applies only to category, “View Listings” and search results maps): Indicates where the map should be displayed: above or below all listings.
Appearance
Map Size: Two standard sizes (Portrait orientation, Landscape orientation) and a custom size for you to match your theme/site perfectly.
Custom map size width (px): The width of the map to use, applies only to the “Custom size” map size
Custom map size height (px): The height of the map to use, applies only to the “Custom size” map size
Map Type: The type of map to show–terrain, road, hybrid. Hybrid is a mix of terrain and road. Default is Road Map.
Animate markers: Use the “upside down drop markers” on the map to indicate specific location and “drop” them in place via animations. If unchecked, just the markers show.
Field Options

NOTE: You must map at least ONE of these fields in order for a marker to show on the map. The more fields you use, the more accurate the location can be.

Use this field as address: Specify which BD field (defined in Manage Form Fields) to map to the “Address” field used by Google Maps
Use this field as city: Specify which BD field (defined in Manage Form Fields) to map to the “City” field used by Google Maps
Use this field as state: Specify which BD field (defined in Manage Form Fields) to map to the “State” field used by Google Maps
Use this field as ZIP code: Specify which BD field (defined in Manage Form Fields) to map to the “ZIP/Postal Code” field used by Google Maps
Use this field as country: Specify which BD field (defined in Manage Form Fields) to map to the “Country” field used by Google Maps

Return to Table of Contents


Ratings Tab

NOTE: This tab only displays if you have Ratings Premium Module installed with Business Directory.

These settings affect the display of the star rating system (and the subsequent reviews) for your listings.

General Settings
Enable ratings: Must be checked to show and use ratings on your listings.
Ratings threshold: Minimum number of reviews before ratings are displayed on a listing
Allow unregistered users to post reviews?: When checked, anyone can post a rating/review for a listing. Users are tracked by IP address so they cannot post a review more than once. If unchecked, users must be registered on your site before a rating is allowed.
Require rating comment?: When checked, the user must provide more than just a star rating, they must also provide a comment about it as well.
Admin must approve reviews?: Turn this option on if you wish to review ratings before publicly displaying them. Useful if you are concerned about spammers or abusive users.
Display Settings
Display ratings in excerpt view: Show the star rating on the list (excerpt) view of listings when checked, hide it otherwise.

Return to Table of Contents


Regions Tab

NOTE: This tab only displays if you have Regions Premium Module installed with Business Directory.

These settings affect the Regions control module, in particular the Sidelist.
The Sidelist is a list of selected Regions shown in the main Business Directory pages. The Regions to show can be configured in the Manage Regions section.

General Settings
Regions Slug: When filtering to a particular region, this slug is used as the starting part of the URL after the directory page URL. Behaves similarly to the category, tag and directory slugs. Avoid using any common terms used elsewhere for page titles on this slug.
Show region selector open by default?: If checked, the Region Selector at the top of listing pages (directory, category, listings) is set to open. When unchecked, this is closed to a single line for better use of space on the page.
Regions Sidelist
Show Sidelist: Check to show the Sidelist, uncheck to hide the Sidelist.

Return to Table of Contents


ZIP Search Tab

NOTE: This tab only displays if you have ZIP Search Premium Module installed with Business Directory.

These settings affect the ZIP Search widget and how to perform the calculation of distance from a postal code to various listings.
There are also settings within the Widget itself.

General Settings
ZIP Code Field: Specify which BD field (defined in Manage Form Fields) to map to the “ZIP/Postal Code”
Units: Specify whether you want to use Miles or Kilometers for displaying/calculating distances from a particular postal code.

Return to Table of Contents


Reset Defaults Tab

Clicking on the button for this tab is optional and probably in most cases, not necessary. Use this option if you want to go back to the factory-default settings for Business Directory.

Please note that all of your custom settings will be lost if you do so. Use this option with care.

Return to Table of Contents


Manage Fees

This screen is where you handle the management of fee plans for Business Directory. A fee plan can be free (0.00) or not, and is associated to one or more categories. A fee plan only applies when you have the Directory in Paid Mode by turning on this setting under Manage Options, Payments tab.

NOTE: When you configure fee plans, if you have multiple fee plans that map to different categories and your users create a listing that is also in each of those categories, they will be charged the fees per each category they select. We are working to define a category fee workflow that allows greater control over it, but be aware of this limitation when building fee plans today.

To Add a New Fee plan

  1. Click the Add New Fee button at the top of Manage Fees screen
  2. Enter the data shown below
  3. Click “Add Fee” and the plan will be saved

Fee Plan Fields
Fee Label (required): The title of this fee plan. Make it something that tells your users kind of plan this is (Basic, Business, Fully Loaded, whatever)
Fee Amount (required): The cost of the plan. You can enter 0.00 here for a free plan to mix in with paid plans if you wish
Listing run in days (required): The time the listing will be active on your directory, you can choose a time in days or run a listing forever
Number of images allowed (required): The number of images they can upload with a listing
Apply to category (required): Which category this fee plan maps to. You must select either a number of categories to use or “All Categories” if you want to apply to everything

To Edit an existing Fee plan

  1. From the Manage Fees screen, hover over the plan you wish to edit
  2. Click the Edit link
  3. Edit the data noted above
  4. Click “Save Fee” and the plan will be saved

To Delete a Fee plan

  1. From the Manage Fees screen, hover over the plan you wish to remove
  2. Click the Delete link
  3. You will be asked to confirm the deletion on a new screen
  4. Click the Delete button to complete the process

Return to Table of Contents


Manage Form Fields

This screen is perhaps the first and most important screen of Business Directory. Here you manage all the fields you wish to display in the listings themselves. You can set the order of display, whether the fields are shown in the excerpt (list view), the listing (detail view), search form or any combination of the above. You also set field attributes like type (text, URL, etc) and whether a field is required/optional.

NOTE: Before you import ANY records, you should completely setup and configure ALL fields you plan to use in your directory. This will save you any headaches from data you missed during mapping.

You can preview the form at any time by clicking the “Preview Form” button at the top to see how your changes will look on the Submit Listing screen.

To Add a New Form Field

  1. Click the Add New Form Field button at the top of Manage Form Fields screen
  2. Enter the data shown below
  3. Click “Add Field” and the plan will be saved

Form Field Fields
Field Association (required): Select the WordPress field association for this field. These associations are as follows:

  • Post Title: Used by the Title field for your listings. Can only be used for one field in your set of fields
  • Post Content: Used by the Long Description field for your listings. Can only be used for one field in your set of fields
  • Post Category: Used by the Business Genre field (by default) for your listings. Can only be used for one field in your set of fields
  • Post Excerpt: Used by the Short Description field for your listings (for displaying in the list view). Can only be used for one field in your set of fields
  • Post Tags: Used by the Tags field for your listings. Can only be used for one field in your set of fields
  • Post Metadata: The type used by all other fields. Can represent any other type of field (e.g. URL, LinkedIn, Facebook, Email, etc). Can be used as many times as you want
  • Post Region: Only used by the Regions module. DO NOT create fields of your own using this type, they will be IGNORED by Business Directory

Most of the time, you will be using Post Metadata for your new fields.
Field Type (required): The type of control used to display and enter your field data. Select from:

  • Textfield: A basic one-line text field for text entry
  • Select list: A drop-down field with limited choices and a single selection option
  • URL field: A web link with additional configuration options
  • Textarea: A multi-line text entry control
  • Radio button: A set of exclusive choices presented in a bulleted list
  • Multiselect List: A listbox field with limited choices and multiple selection option (by using Ctrl or Shift clicking)
  • Checkbox: A set of non-exclusive choices presented in a bulleted list
  • Social Site (Facebook): Allows entry of a Facebook page to create a Like button pointing to that page
  • Social Site (Twitter): Allows entry of a Twitter handle (e.g. @handle) or a full URL to a Twitter account to create a Follow button on the profile
  • Social Site (LinkedIn): Allows the entry of a Business LinkedIn profile (only business profiles supported, personal ones do not work) SEE NOTE BELOW ABOUT USING THIS FIELD
  • Image Upload: A field that accepts a file upload (usually used for logos)

Most fields will probably be Textfields when you are building a standard listing form.

NOTE about LinkedIn:The LinkedIn field is particular about what you put in there. It’s not an URL of your profile. What needs to go into the LinkedIn form field of the listing is the company number assigned by LinkedIn.

Example: If you follow the link https://www.linkedin.com/company/1480

You will go to the company page for Apple, Inc and 1480 is the LinkedIn identifier for Apple. To add Apple’s page for LinkedIn, put 1480 into the LinkedIn form field of the listing and the button will appear, and let you “follow” the company. If you click it it will take you to the LinkedIn company page.

Field Label (required): The text label used with this field on the forms (can be hidden, see below)
Field description (optional): A description that can be displayed under or next to the field (depending on your theme) for additional info regarding how to use it

Field validation options
Field Validator: The type of validation to be performed on the field prior to submitting the data.

  • No validator: performs no validation on the field (default)
  • Email: Ensures the entered data conforms to a standard email address of the form [email protected]
  • URL: Ensures the data is a standard web URL of the form http(s)://site.ext/sub-url/
  • Whole Number: Ensures the entered data is a valid integer value
  • Decimal Number: Ensures the entered data is a valid floating point or integer value
  • Date: Ensures the entered data will parse as a date

Fields that fail validation will prevent the listing from being saved/submitted.
Is field required?: Whether this field must be always be filled in or not.

Field-specific settings
Field Options: (for Select lists, Radio buttons and Checkboxes) The list of options to choose from, using comma (,) separated list of options
Open link in a new window?: Used by URL Field only. Determines whether clicking on the link will open a new browser tab or not.
Use rel=”nofollow” when displaying the link?: Used by URL Field only. Adds the nofollow directive to the link to prevent web crawlers from following it

Field display options
Show this value in excerpt view?: When turned on, the field will show in the excerpt (list) view.
Show this value in listing view?: When turned on, the field will show in the listing (detail) view.
Include this field in the search form?: When turned on, include this field in the search form.
Hide this field’s label?: Allows you to turn off this particular field label on the forms if you don’t want it.

To Edit an existing Form Field

  1. From the Manage Form Fields screen, hover over the plan you wish to edit
  2. Click the Edit link
  3. Edit the data noted above
  4. Click “Save Fee” and the plan will be saved

To Delete a Form Field

  1. From the Manage Form Fields screen, hover over the plan you wish to remove
  2. Click the Delete link
  3. You will be asked to confirm the deletion on a new screen
  4. Click the Delete button to complete the process

Return to Table of Contents


Manage Regions

The Manage Regions screen can also be accessed by the menu here:

The Manage Regions area also has a collapsed pane that will allow you some “restore” operations if you get things in a bad state. When you click on the right of the Regions pane, you get this expanded area below:

Regions Settings

You can use these buttons to restore the default regions, the region form fields (if you accidentally delete them), or restore the default settings of the Regions Module.

 

Managing the Region Hierarchy

The Manage Regions screen is where all region configuration happens. Regions are configured as a hierarchy. You can make the hierarchy anything you like, we pre-configure it with the most common scenario, but you are free to use as much or as little as you like. The default is setup as follows:

Continent -> Country -> State

You can add counties, cities, villages, boroughs, whatever you like. And you can change the existing ones, if you don’t like our default setup. The important thing to understand is which regions are parents and which are children, and to make the association accordingly. Each level of the hierarchy is displayed with a dash in front of it. So top level regions have no dash, first level (country) regions have a single dash, second level (state) regions have two dashes, and so on.

As you add or delete regions, the Regions Module will automatically change the Form Fields to add or remove the level of the hierarchy you create. These fields will have default names associated to them, but you can change them to whatever you like. The names of the fields are not important to Regions Module.

The Manage Regions screen primarily uses a list of regions to work with (notice the top level region, Africa (a continent) has several counties (with single dashes) below it:

At the top of this list, you have various filters you can use to hide/show regions that you are interested in. Clicking Enabled will display all active regions (those that can be shown in the Region Selector, Search screen or Submit Listing screen), Disabled will show all inactive ones. On Sidelist will show all regions that have been added to the Sidelist, and Not on Sidelist does the opposite. Clicking All will return you to the master list of regions at any time.

To the left of the region list, you will find the Add Regions widget, where you can quickly add one or many regions at a time (under Add Multiple Regions). You can also specify the parent region of the region you are configuring:

To add a new region, simply type the name of the Region in the Name field, specify the parent region of it, and then click Add New Region. If you do not specify a parent, that region will become a top-level region. By default, top-level regions are Continents.

When you are working with regions, the operations you can perform on them are found when you hover the mouse over a particular region, like so:

The commands are as follows:

Show Sub Regions: Clicking this link will automatically filter the region list to show ONLY regions that are children of the region you clicked on. For example, if you clicked on Show Sub Regions for Africa, you would see the message shown below:

 

And a list of regions that are countries under Africa, such as Algeria, Angola, Benin and Botswana, among others.

Edit: This will allow you to change the region name, slug and description on a separate screen.

Quick Edit: Similar to edit, but allows for in-line editing of the region info above.

Delete: Removes the region from the hierarchy. WARNING: Any child regions will ALSO be deleted as well, so be careful of this operation.

Add Child: Clicking this will automatically change the Parent region of the Add Region widget to the left to the selected region and await for you to enter the new region name. You must click “Add New Region” to complete the addition of the child to the hierarchy.

Show/Hide: This will show or hide the region on the sidelist. See the section about Sidelists below for more information. If you attempt to add a region to the sidelist and it’s parent(s) are not on the sidelist, clicking “Show” will automatically add the parent regions as well. Similarly, hiding a parent region from the sidelist will also hide all of its children as well.

Enable/Disable: This will make a region active or inactive. Only active regions will show up in the Region Selector, the Advanced Search screen, and the Submit a Listing screen. A region must also be active to show on the side list.

Return to Table of Contents


All Listings

The Admin All Listings screen is the place where you will handle most of your listing management functions, including adding/editing/deleting listings, along with handling status changes and upgrades/downgrades.

The All Listings screen has several filters at the top with counts of listings in that status:

All (8) | Published (8) | Trash (50) | Paid (8) | Unpaid (0) | Pending Upgrade (0)

Clicking one of these statuses will filter the records in the list to only those that are in that particular state. For example, if you clicked Paid, you would only see the listings that were in a Paid state (in this example, that list would be empty)

At the top, there is also a button to add a new listing. Click this to begin the listing creation process from the admin side.

And each listing has additional options when you hover the pointer over the listing record itself, including:

  • Edit: Allows you to edit the listing, in a similar way to add a new listing
  • Quick Edit: Allows you to edit some basic information, such as the author, state, slug and title of the listing.
  • Trash: Will put the listing into the Trash status and remove it from public display
  • View: Allows you to see the listing from the admin side in “preview mode”
  • Mark as Paid/Unpaid: Allows you to change the payment status of a listing (paid or not)
  • Upgrade to Featured/Downgrade to Normal: Allows you to change the featured/sticky status of a listing

You can perform actions on multiple rows by selecting more than one listing, and then picking the operation under “Bulk Actions” and then clicking “Apply”.

Return to Table of Contents


Pending Upgrade

This is the All Listings screen, pre-filtered for the status “Pending Upgrade”. In this case, Pending Upgrade would be users who may have had payment issues with their featured/sticky listing after they decided to upgrade at a later time.

Return to Table of Contents


Pending Payment

This is the All Listings screen, pre-filtered for the status “Unpaid”. In this case, Unpaid would be users who may have had payment issues with their normal listing during the submit process.

Return to Table of Contents


CSV Import

NOTE: Before you import ANY records, you should completely setup and configure ALL form fields you plan to use in your directory. This will save you any headaches from data you missed during mapping.

NOTE: Be sure to use the “See Sample CSV File” button at the top to get started with a template CSV file.

CSV Imports are now supported in Business Directory 2.1 and higher.

To import ads via CSV, you must do the following:

  • Provide a CSV file that is of the correct format. After you configure your form fields, there is a sample CSV file that Busines Directory will create for you as a starting template. We highly recommend that you use this as the starting point to avoid column naming errors!.
  • If you want to import images within your ads as well, you must provide a separate ZIP file with all the images contained in it. The names of these images should be referenced in the “images” column of your CSV file. If you have multiple images for a single ad, you must separate them with the “Image Separator” character. (Semi-colon by default (;)). For example: image1.png;image2.gif;image3.jpg. Set the path to this file in the ZIP containing images file textbox.
    NOTE: The image file is often the reason for a failed import. Try to use the smallest size of image you think you will need, at most. Putting 100 2MB images into a ZIP file will only choke the uploader and cause timeouts during upload!
  • Decide how to handle categories for import. BD can do it two ways: Auto Create Categories or Generate error if Category not found. The Auto Create option is good for new installations where you have an existing set of categories you want to use. The Generate error option is good if you already manually setup your categories and want to make sure the import conforms to your existing structure. NOTE: BD can only handle single-level category creation on import (top level categories only). So if you want something more complex with children, you might want pre-define your categories and use the second option.
  • Imported ads can be assigned to a user by using the user_id column in the CSV file. The user_id must match a login name of an existing user in your WordPress site. If you want ads assigned to a particular user on import, you should check this box. Otherwise, leave it unchecked.
  • If you checked Assign to User, and an ad does not have a user_id defined in the CSV, you can assign it to a default user, such as admin. Select the user you wish to user as the default one. Only valid if you checked Assign to User in the step above.
  • Once you configure these options, you can try out your import and see if any errors will be generated by clicking “Test Import”. If all goes well on the test, you can perform the actual import by clicking “Import”, which will load the BD tables with the data you configured above.

HELPFUL HINTS with CSV Imports and Common Errors to Avoid

  • Your CSV file should be based on the sample CSV file that is created under Directory Admin->CSV Import. Generate that if you haven’t already.
  • Your CSV file must have every column from the sample file, named exactly the same. Don’t delete any of them
  • Your CSV file should have data in every column that is required. Optional columns/fields can be left blank, but should not be deleted
  • Dates must be in the expected format of the CSV import settings
  • Imports work best after you’ve completed all field configuration, so make sure you do that first (especially naming)

CSV Import Options
Here are the options you can configure for importing data.

Import Files
CSV File (required): Path to the CSV file you will use for import. We recommend keeping the overall import size under 5MB to avoid timeouts
ZIP file containing images: Path to the ZIP file that contains the referenced images in the CSV (optional, unless you used images, in which case it’s required)

CSV File Settings
Column Separator (required): What separator should be searched for between columns? Default is comma (,). Do not duplicate this separator in the other separator values!
Image Separator (required): What separator should be searched for to separate multiple images in the image column? Default is semi-colon (;). Do not duplicate this separator with the column separator!
Category Separator (required): What separator should be searched for to separate multiple categories in the category column? Default is semi-colon (;). Do not duplicate this separator with the column separator!

Import settings
Missing categories handling (required): Should BD be allowed to auto-create categories or instead, generate errors when a category is not found
Assign listings to a user?: If the user column does not contain a value for a listing, what user should be assigned instead? Default is admin
Default listing user: This user will be assigned to all listings if the username column is not present in the CSV file at all.

At the bottom, you can either click on “Test Import” or “Import”. We strongly recommend trying a Test Import before running a full import to see if you will encounter problems with your file(s) or settings first!

NOTE: Be sure to use the “See Sample CSV File” button at the top to get started with a template CSV file.

The bottom of the page also contains a helpful full grid showing you all fields in your configuration, whether they are required and/or multi-valued (like select lists, checkboxes and radio buttons) to help you understand any errors you may encounter.

Return to Table of Contents


Uninstall

This option is used when you are ready to completely remove Business Directory, including all data.

If you are certain you wish to uninstall the plugin, click the button at the bottom to proceed. Please note that all your data related to the plugin, your ads, images and everything else created by the plugin will be destroyed.

Return to Table of Contents



Frontend Overview

This section details how the Business Directory user interface (a.k.a Front End) is displayed to the end user. The front end consists of the following sub-pages:

Return to Table of Contents


Directory page

The Directory Page is the main entry point into the Business Directory itself. From here, you can search, view all listings, add a listing, or simply browse the directory by category.

Here is a sample picture of the directory (shown with optional modules enabled):

At the top, you see 3 buttons: Submit Listing, View Listings, Directory, along with a search field, search button and Advanced Search link.

  • Clicking on View Listings will take you to the List view page. This is where you can browse the listings by the sort order determined in the Manage Options area.
  • Clicking on a category name below the buttons Category view page for that category. You will see listings filtered for only that category.
  • You can enter keywords in the search field and click Search, which will look for titles and descriptions that match the keywords entered. Or clicking Advanced Search will take you to Search page where you can do more refined searches
  • Clicking the Submit Listing button will take you Submit Listing page, where you can enter the details to post a new listing.

These options can be shown or hidden, depending on the settings you have under the Listings tab of Manage Options.

You can also click on markers shown on the optional Google Map and these will take you directly to the listing at that location. You can also do some basic sorting if the ratings module is installed by clicking on the rating value/count links above the listings.

The “Displaying all listings” area is enabled when you have the Regions Module installed. This allows you to also filter the listings shown by location (city/state/province/etc).

Fields that are marked to display “In Excerpt” are fields that will show up for each listing here. Fields marked “In Listing” or have the option checked “Include this field in the search form?” will not show up on this page.

Return to Table of Contents


List view page

The List view page is similar to the Directory Page, except that the hierarchical list of categories are not displayed at the top. All other functions are present, based on the display settings noted in Directory page.

Listings that are “featured” will show up at the top of the list with a yellow highlight color (by default). This can be changed using custom CSS with BD, if desired.

Fields that are marked to display “In Excerpt” are fields that will show up for each listing here. Fields marked “In Listing” or have the option checked “Include this field in the search form?” will not show up on this page.

Return to Table of Contents


Category view page

The Category view page is similar to the Directory Page, except that the hierarchical list of categories are not displayed at the top AND the listings displayed are filtered for the selected category. The category name is also displayed as the title of the page above the listings. All other functions are present, based on the display settings noted in Directory page.

Listings that are “featured” will show up at the top of the list with a yellow highlight color (by default). This can be changed using custom CSS with BD, if desired.

Fields that are marked to display “In Excerpt” are fields that will show up for each listing here. Fields marked “In Listing” or have the option checked “Include this field in the search form?” have no effect on what displays on this page.

Return to Table of Contents


Detail view page

The Detail view page is the place where users can see all the information about a listing. Generally, this includes all images (if allowed) shown as thumbnails, social buttons, and the “primary” image shown in slightly larger size. In addition, you may also have comments, ratings and contact forms present for the listing to allow your users to interact with the business owner directly. Ratings will only be present if you have the Ratings module installed. The others are controlled under Manage Options, General tab.

Listings that are “featured” will also include a ‘Featured’ image that overlays the upper right corner of the listing.

You can see a sample detail page here:

Fields that are marked to display “In Listing” are fields that will show up for a single listing. Fields marked “In Excerpt” or have the option checked “Include this field in the search form?” have no effect on what displays on this page.

Return to Table of Contents


(Advanced) Search page

The Search aspect of Business Directory is broken into two parts:

  • The Search Field, located at the top of most pages in the directory with a Search button
  • The Advanced Search Page, which is opened when the user clicks on “Advanced Search” from those same pages

Search Field vs. Advanced Search
When the user enters a keyword into the Search Field and clicks search, Business Directory will attempt to match that keyword in the Title and Description fields (ONLY) in your listings. Any matches that are returned will display when you click search.

By contrast, the Advanced Search page has more options and when you enter data into any of the fields, the data will only be matched against that field. For example, if you enter a value in the Short Description field, no other field will be searched for that value.

Advanced Search is designed to allow finer grained control over what you search for. The Search field is a quick-and-dirty search mechanism to find the most common data in the two most heavily used fields. We avoid searching all fields for these keywords, as this would have a negative performance impact on directories with large listing counts.

Listings that are “featured” will show up in the list of results at the top and with a yellow highlight color (by default). This can be changed using custom CSS with BD, if desired.

Fields that have the option checked “Include this field in the search form?” are fields that will show up in the search form here. Fields marked “In Excerpt” or “In Listing” have no effect on what displays on this page.

Return to Table of Contents


Submit Listing page

When your users wish to enter a listing, here is the workflow they will follow to create a listing.

The workflow follows these general steps, depending on what settings are enabled for Business Directory. You must click “Continue” to move to the next step of the workflow. Not all steps will be present, depending on your settings.:

  • Step 1: Enter the ad details Enter the data of any of the fields that are labeled “In Listing” from Manage Form Fields. All fields marked “Required” must be filled in prior to clicking “Continue”, otherwise you will see error messages indicating the missing fields
  • Step 2: Upload Images (optional, depending on settings) Upload, delete or change the primary image of the listing on this step.
  • Step 3: Payment (optional, depending on settings) The fee plan and optional featured upgrade will display on a page for the user to select. Once their choice is made and they click continue, they will go to the configured Payment Gateway site (e.g. PayPal, 2Checkout) to complete payment.
  • Step 4: User completes payment (optional, depending on settings) The user completes payment using their account on the selected gateway. After payment, the site will return to your Business Directory and continue
  • Step 5: Confirmation A page will appear confirming that the listing was completed. Depending on the settings, the listing may require Admin approval and will not display immediately until the Administrator approves it

NOTE: New listings may be submitted and require administrator approval, based on the settings you configure under Manage Options, Listings tab. If your users can’t see their listings right away, this may be the reason.

NOTE: When you are logged in as Administrator, you will NOT see Step 4 at all. The listing will be marked as PAID for the selected plan you pick in Step 3 and you will jump to Step 5.

Fields that are marked to display “In Listing” are fields that will show up for data entry in Submit Listing. Fields marked “In Excerpt” or have the option checked “Include this field in the search form?” have no effect on what displays on this page.

Return to Table of Contents


Edit Listing page

This page is accessed when a user clicks the “Edit” button from the front end. The Edit button is only visible for listings owned by a user. The administrator can edit any listing from the front end, so all listings will show the Edit button when the administrator is viewing them.

The content and functionality of this page is essentially the same as the Submit Listing page, but with the data pre-populated by the listing that was selected when the “Edit” button was clicked.

The workflow follows the same set of steps as Submit Listing, depending on what settings are enabled for Business Directory. You must click “Continue” to move to the next step of the workflow. Not all steps will be present, depending on your settings. The general flow goes like this:

  • Step 1: Edit the ad details Change the data of any of the fields that are labeled “In Listing” from Manage Form Fields.
  • Step 2: Manage Images (optional, depending on settings) Upload, delete or change the primary image of the listing on this step.
  • Step 3: Confirmation A page will appear confirming that the listing was saved.

NOTE: Editing a listing may cause the listing to return to a state where the administrator may need to re-approve it, based on the settings you configure under Manage Options, Listings tab.

Return to Table of Contents



Premium Modules Overview

The Premiumm modules are optional add ons to the core Business Directory that significantly enhance the functionality for you and your users by adding useful features. Below, you can see a complete list of premium modules currently available for Business Directory:

Return to Table of Contents


PayPal Payment Gateway

Business Directory supports 3 payment gateway modules:

  1. Google Checkout (included in the Core Plugin)
  2. PayPal (when you buy the PayPal Premium module)
  3. 2Checkout (when you get the 2Checkout Premium module)

Others are being considered (such as Authorize.net) but they are not currently available. Less common payment gateways can be added by those who understand PHP and WordPress API programming and modeling the gateway off of the Google Checkout one in the plugin.

Installing Payment Gateways

The ZIP you download is a full WP plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

 

Configuring PayPal Gateway

PayPal can be configured quickly and easily after installing the PayPal Premium module by doing the following:

  1. Install PayPal Gateway module
  2. Go to Directory Admin->Manage Options
  3. Select the Payment tab
  4. At the top, enable Payments
  5. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  6. Change your currency, if applicable
  7. Scroll down to PayPal options
  8. Activate PayPal gateway option
  9. Enter your PayPal email address
  10. Save settings
  11. Create one or more Payment Plans
  12. You’re ready to test payments. Logout as Administrator and attempt to place a listing–verify that it goes through.
  13. IMPORTANT: Once you’re done testing, be sure to Uncheck Put gateways in test mode? so you can accept real payments.

Once correctly configured, your payment options and PayPal configuration will look like this (production mode):

payment-general

 

payment-paypal

Creating a Payment Plan

You must have one or more payment plans to accept payments for your listings. Once one or more gateways above are active, do the following to create a payment plan:

  1. Go to Directory Admin->Manage Fees
  2. Verify that at the bottom of the screen, you see green checkmark(s) next to the gateway(s) you have activated above. If not, verify your steps in the proper gateway and retry this screen.
  3. Click on “Add Fee Plan”
  4. Enter the details of the plan–price, name, duration, etc.
  5. Save the plan
  6. Repeat 3-5 until you have all the desired plans available

In the end, you should have something that looks like this:

payment-manage
Return to Table of Contents


2Checkout Payment Gateway

Business Directory supports 3 payment gateway modules:

  1. Google Checkout (included in the Core Plugin)
  2. PayPal (when you buy the PayPal Premium module)
  3. 2Checkout (when you get the 2Checkout Premium module)

Others are being considered (such as Authorize.net) but they are not currently available. Less common payment gateways can be added by those who understand PHP and WordPress API programming and modeling the gateway off of the Google Checkout one in the plugin.

Installing Payment Gateways

The ZIP you download is a full WP plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

 

Configuring 2Checkout Gateway

2Checkout can be configured quickly and easily after installing the 2Checkout Premium module by doing the following:

  1. Install 2Checkout Gateway module
  2. Go to Directory Admin->Manage Options
  3. Select the Payment tab
  4. At the top, enable Payments
  5. (Optional, but recommended) Put the payment gateways in test mode. Uncheck this when done testing!
  6. Change your currency, if applicable
  7. Scroll down to 2Checkout options
  8. Activate 2Checkout gateway option
  9. Enter your 2Checkout ID (you get this from your 2Checkout account information on their site)
  10. Save settings
  11. Create one or more Payment Plans
  12. You’re ready to test payments. Logout as Administrator and attempt to place a listing–verify that it goes through.
  13. IMPORTANT: Once you’re done testing, be sure to Uncheck Put gateways in test mode? so you can accept real payments.

Once correctly configured, your payment options and 2Checkout configuration will look like this (production mode):

payment-general

payment-2checkout

Creating a Payment Plan

You must have one or more payment plans to accept payments for your listings. Once one or more gateways above are active, do the following to create a payment plan:

  1. Go to Directory Admin->Manage Fees
  2. Verify that at the bottom of the screen, you see green checkmark(s) next to the gateway(s) you have activated above. If not, verify your steps in the proper gateway and retry this screen.
  3. Click on “Add Fee Plan”
  4. Enter the details of the plan–price, name, duration, etc.
  5. Save the plan
  6. Repeat 3-5 until you have all the desired plans available

In the end, you should have something that looks like this:

payment-manage
Return to Table of Contents


Ratings Module

The Ratings Module allows you to give your users a voice about the listings on your site. They can rate and comment on the listings, search by ratings and use the ratings to decide which businesses are the ones they’re looking for.

You get the ability to require comments with ratings (or not), and to define a threshold to display ratings information on list views and single views.

Installation

The files you download are in a ZIP that is a full plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

Administration

The ratings administration screen looks like this:

The settings are as follows:

Enable ratings: This activates the Ratings module and displays the ratings per the current settings. If you wish to temporarily disable ratings, you can uncheck this box and users will not be able to rate listings.

Ratings threshold: This is the minimum number of ratings that must be recorded before the “Ratings (average)” will display a star value. Default value is 0 (which displays all ratings immediately).

Allow unregistered users to post reviews?: This allows users who haven’t logged in to post a rating. The default is that a user must be registered and logged in to rate a listing. The user’s IP address is recorded to prevent multiple ratings from a single user.

Require rating comment?: If you enable this checkbox, the user must enter some text in their review section in addition to a star rating. If you leave it unchecked, the users can post ratings without further comments.

Admin must approve reviews?: Turning this option on requires that the admin must see and approve all ratings before they are displayed on the listing. Useful when you have spammers attacking your site.

Display ratings in excerpt view?: This setting controls whether the user sees the ratings in the list of businesses or not. By default, this is enabled. Users can always see the rating in the single listing view.

Here are some screenshots of the ratings module in action. First, the list-based (excerpt) view, with the average displayed:

And here is the rating at the top on the single listing display:

The rating comment form, before rating:

And after ratings have been submitted:

Return to Table of Contents


Regions Module

The Regions Module allows you users to filter listings based on location. You also get the ability to define the regions they can use to submit their listings, search, and edit. There is also a quick-region-set sidelist where the user can click on a region and automatically see listings filtered for that region.

Regions can be defined in a hierarchical fashion, for example: Continent->Country->State->County->City. You do not need to define all those levels if you don’t want to. By default, we pre-configure the Regions module with all Continents, the Countries of the world and the States of the United States. Additional regions and levels can be added easily to customize for your locale.

Installation

The files you download are in a ZIP that is a full plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

Regions Setup

To correctly configure Regions Module, you must do the follow activities:

  1. Create and associate your regions in a hierarchy
  2. Add regions to a side list (if you want the side list used)
  3. Change the field labels to match your hierarchy naming convention
  4. Decide where your fields will show up (Search Page, List View, Detail View)
  5. Change the order of display of fields

That’s it. The first step is the longest. We start you out with the Countries and Continents of the world as well as all states for the USA. The rest you will need to add or associate yourself.

The hierarchy definition does not need to match Continent->County->State->City. You can have any association you like, such as Middle Earth->Hobbiton->The Shire->Bilbo’s House if you like. The important part is to understand which are parent regions and which are child regions. We give you the most common use of Regions module pre-configured, but you are free to change that (including the labels of the fields) however you like.

Regions Fields

Installing Regions module automatically adds 4 new fields to your configuration under Directory Admin->Manage Form Fields. They are as follows:

  • City
  • State
  • Country
  • Continent

By default, the Continent is set to NOT display in any form (listing, detail or search), and Country, City and State are. You can configure this however you like in the Manage Form Fields section of Business Directory, including their output order. For example, if you only want to show City and State for US listings, you might have something that looks like this:

 

Any fields that are not in the listing, excerpt or search from this screen are not displayed in the Region Selector or in the Sidelist. That’s helpful if you want to display States, but not the Country, in the Sidelist. The above configuration will do exactly that–show only States and Cities on the sidelist.

IMPORTANT: You should NOT try to add fields to manage a region hierarchy here manually by adding fields. When you add levels to the hierarchy, you will automatically get fields added to the field list. Any region-type fields you add manually will be completely ignored by Regions Module. Define your hierarchy FIRST, and then change the labels of the fields generated by Regions to match how you defined it.

NOTE: If you accidentally delete a Regions field, don’t panic. You can get it back by visiting the Regions tab under Directory Admin->Manage Regions. At the top, click to expand the Regions pane and click on “Restore Regions Fields”. Shown below:

Regions Settings

Administration

The regions administration screen looks like this from Directory Admin->Manage Options, click on the Regions tab:

The settings are as follows:

Show Sidelist: This activates the sidelist option (see below), where any regions present on the sidelist are displayed as links next to listings. This makes it easy for users to “quick filter” listings by a particular region, instead of selecting one manually at the top of the listings screen. When this option is unchecked, no side list will appear on the View Listings or Directory screens in Business Directory.

In addition to the settings above, there is also a link for Manage Regions. The Manage Regions screen can also be accessed by the menu here:

The Manage Regions area also has a collapsed pane that will allow you some “restore” operations if you get things in a bad state. When you click on the right of the Regions pane, you get this expanded area below:

Regions Settings

You can use these buttons to restore the default regions, the region form fields (if you accidentally delete them), or restore the default settings of the Regions Module.

 

Managing the Region Hierarchy

The Manage Regions screen is where all region configuration happens. Regions are configured as a hierarchy. You can make the hierarchy anything you like, we pre-configure it with the most common scenario, but you are free to use as much or as little as you like. The default is setup as follows:

Continent -> Country -> State

You can add counties, cities, villages, boroughs, whatever you like. The important thing to understand is which regions are parents and which are children, and to make the association accordingly. Each level of the hierarchy is displayed with a dash in front of it. So top level regions have no dash, first level (country) regions have a single dash, second level (state) regions have two dashes, and so on.

As you add or delete regions, the Regions Module will automatically change the Form Fields to add or remove the level of the hierarchy you create. These fields will have default names associated to them, but you can change them to whatever you like. The names of the fields are not important to Regions Module.

The Manage Regions screen primarily uses a list of regions to work with (notice the top level region, Africa (a continent) has several counties (with single dashes) below it:

At the top of this list, you have various filters you can use to hide/show regions that you are interested in. Clicking Enabled will display all active regions (those that can be shown in the Region Selector, Search screen or Submit Listing screen), Disabled will show all inactive ones. On Sidelist will show all regions that have been added to the Sidelist, and Not on Sidelist does the opposite. Clicking All will return you to the master list of regions at any time.

To the left of the region list, you will find the Add Regions widget, where you can quickly add one or many regions at a time (under Add Multiple Regions). You can also specify the parent region of the region you are configuring:

To add a new region, simply type the name of the Region in the Name field, specify the parent region of it, and then click Add New Region. If you do not specify a parent, that region will become a top-level region. By default, top-level regions are Continents.

When you are working with regions, the operations you can perform on them are found when you hover the mouse over a particular region, like so:

The commands are as follows:

Show Sub Regions: Clicking this link will automatically filter the region list to show ONLY regions that are children of the region you clicked on. For example, if you clicked on Show Sub Regions for Africa, you would see the message shown below:

 

And a list of regions that are countries under Africa, such as Algeria, Angola, Benin and Botswana, among others.

Edit: This will allow you to change the region name, slug and description on a separate screen.

Quick Edit: Similar to edit, but allows for in-line editing of the region info above.

Delete: Removes the region from the hierarchy. WARNING: Any child regions will ALSO be deleted as well, so be careful of this operation.

Add Child: Clicking this will automatically change the Parent region of the Add Region widget to the left to the selected region and await for you to enter the new region name. You must click “Add New Region” to complete the addition of the child to the hierarchy.

Show/Hide: This will show or hide the region on the sidelist. See the section about Sidelists below for more information. If you attempt to add a region to the sidelist and it’s parent(s) are not on the sidelist, clicking “Show” will automatically add the parent regions as well. Similarly, hiding a parent region from the sidelist will also hide all of its children as well.

Enable/Disable: This will make a region active or inactive. Only active regions will show up in the Region Selector, the Advanced Search screen, and the Submit a Listing screen. A region must also be active to show on the side list.

 

How to Filter Listings By Regions

When you visit the Directory or View Listings pages, at the top, you will see the Region Selector (which by default will say “Displaying listings from All Regions” until you select something).

To the right of the region indicator is a drop-down button:

Clicking on it will open up the region selector:

When you start out, the first drop down will be the only one displayed. Clicking a region in it will create the control to select the next level (in this case, selecting “USA” caused the “State” drop down to appear. Selecting “Washington” caused the City drop down to appear.

When you have fully selected the desired region you wish to filter on, click “Set Filter” to set the region for filtering. Now, only listings from that region will be shown in View Listings and Directory, until you change it. In the above example, clicking “Set Filter” will cause only listings from Seattle, WA, USA to show up in the directory.

If you make a mistake or simply wish to see all listings, click “Clear Filter” and the drop downs will reset, allowing for a new selection.

 

The Sidelist and Quick Filters

The sidelist allows you to have “quick filters” setup for regions you know will be of interest to your users. The side list appears like this in your directory on the View Listings and the Directory page, to the right of your listings and just below the button panel/region selector area:

When you click on a region in the sidelist, this will quickly set the region to match the one in the sidelist. Sidelist regions can also have sub-regions showing as well, such as this for USA (before and after pics):

By clicking on the button, that will open the sub region list (States) for USA, allowing for further location filter refinement.

If you want a region on the sidelist, you must add it under the Manage Regions area of the admin dashboard of Directory Admin.
Return to Table of Contents


Google Maps Module

This module allows your businesses that list in Business Directory to have a Google Map for their address. You can map the address fields from any field you’ve added in the Manage Form Fields section. You can also choose the map type (satellite, hybrid, terrain, street view) and the size of the map, as well as markers to display.

The map can be displayed on any of the following views:

  • The Directory (and List) Page (showing all visible listings)
  • The Search Page (showing all listings in the results)
  • The Detail Page (showing the current listing’s map only)

Installation

The files you download are in a ZIP that is a full plugin. The installation instructions are inside of it, and here as well:

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

Administration

Google Maps admin screen looks like this:

The options are as follows:
General Settings–these settings control where you maps are allowed to show up in the directory

  • Turn on Google Maps Integration: Activates or deactivates the map displays on the listing views. Must be on to show the maps for the listing’s address fields. On by default.
  • Show listings map in categories?: Activates or deactivates the map displays on the category page. On by default.
  • Show listings map in View Listings?: Activates or deactivates the map displays on the Directory/List page. On by default.
  • Show listings map in search results?: Activates or deactivates the map displays on the Advanced Search page. On by default.
  • Display Map Position: Choices: Above All Listings or Below All Listings. Default is Above All Listings

Appearance–these settings control how your maps will appear in the directory

  • Map Size: The dimensions of the Google Map to display, either Large (400×600), Small (200×300) or Custom. Default is Large
  • Custom Map Size Width: The custom width of the Google Map to display. Only valid when Map Size “Custom” is selected
  • Custom Map Size Height: The custom height of the Google Map to display. Only valid when Map Size “Custom” is selected
  • Map Type: One of the following choices: Road Map, Satellite, Terrain or Hybrid. Road Map will display the labeled streets in a colored map. Satellite and Terrain will use the images from Google Earth. Hybrid overlays the two.
  • Animate markers? Turns on basic Google Map animations for the markers where the business is located.

Field Options–these are the mappings of where Google Maps will pull its address data from using your listing fields defined under Manage Form Fields. You can map up to 5 different fields to use. Google Maps requires at least one to be mapped.

  • Address: Which field in your list of form fields maps to the base address
  • City: Which field in your list of form fields maps to the city
  • State: Which field in your list of form fields maps to the state
  • Country: Which field in your list of form fields maps to the country
  • ZIP/Postal Code: Which field in your list of form fields maps to the postal code

Google Maps in action:

Once you’ve defined the map fields and activated the module, you should see this appear on a single listing view:

This particular display is with the “Large Map” and “Roadmap” settings on. The fields “Address”, “City” and “State” are used to map the location of Apple Computer here.
Return to Table of Contents


Featured Levels Module

The featured levels module allows you to customize the access of fields and features so that users have an incentive to upgrade their payment plans or their listings from regular to “featured” in order to gain access to these fields and features.

Why do I want to use this module?

Consider these two common examples:

  • Suppose you have 3 fee plans:  Basic, Regularand Premium, each with a different price.  You want to offer more to users, the more they pay for a listing, instead of just images and length of time the listing runs.  The Basic listings you want to have very basic features and a standard set of fields.  For the Regular, you’d like to include some contact information to display and for Premium, you’d like to allow access to show a Map as well as Facebook and Twitter links on their profile.
  • You want to have “sticky” or “featured” listings, but instead of just allowing the listing to show at the top of the search results and be in a different color (the standard “featured” listing behavior), you’d like to include access to Ratings in addition, to entice people to use the Featured listing feature of your site.  And include additional fields in the featured listings, making it more useful (e.g. a Logo field accessible only to Featured listings)

These are the common use cases of Featured Levels.  You can configure access based on the following:

  • Fee Plans
  • Featured levels

Fee Plan Based Configuration

Fee plans refer to the payment plans you create to get users to pay for listings.  For information about how to create them, please see the Manage Fees section.

Featured Levels allows you to associate certain fields and features to a fee plan, so that you can charge a low price for a plan with access to basic fields and a higher price for a plan with access to lots of fields and premium features like Maps or Ratings.

Featured Levels Based Configuration

Featured levels refers to the upgrade process from a regular listing to a “featured” one.  While the terminology might be confusing, featured listings have a few characteristics that make them attractive to users:

  • Featured listings sort at the top of all categories, search results and general lists of the Business Directory
  • Featured listings show up in a different color and style compared to other listings
  • Featured listings have a “featured listing” image on them in the detail view

With Featured Levels, you can create multiple levels of upgrades from Normal listings (either free, or purchased through a fee plan) allowing users to gain access to features by upgrading their listing for a fee.

Should I Use Fee Plans or Featured Levels or Both?

The answer depends on how you want your users to access the features.  Use this table to help you decide:

Free or Paid Listings? Pay Now/Pay Later Best Approach
Free Listings Pay Later (upgrade listing to get features) Featured Levels
Paid Listings Pay Later (upgrade listing to get (more) features) Featured Levels
Paid Listings Pay Now (buy features according to a plan up front) Fee based
Free Listings Totally free site This module doesn’t apply

If you’d prefer that users buy a listing with a plan and you differentiate the plans based on the features available, but not on things like listing expiration time or images, then the Fee Plan method is probably your best choice.

If you want users to have general access to most things (or have a free listing with options to have a paid upgrade later), and give special access to users after they upgrade a listing only, or you want to add more incentive to use the “Featured Listing” upgrade by adding something like access to Maps or Ratings (for only those Featured listings) then the Level based approach is your best choice.

You should NOT combine the two approaches.  Things get VERY confusing when you try to figure out how someone will see a particular feature, such as ratings, when you offer it both ways under certain circumstances.  Pick ONE approach and stick to it.  That’s our recommendation.

If you’re not sure, we recommend starting with the Fee based approach, as it’s more straight forward to understand and configure.

Configuring Featured Levels

  1. First, you need to enable the Featured Levels module.  Click Manage Restrictions on the Admin dashboard under Directory Admin.  Check the “Enable feature restrictions” checkbox to get started.
  2. With levels enabled, three tabs will appear.  Now you need to decide if you are going with a Level-based approach (for sticky upgrades from a regular/normal listing) or fee-based approach (for upfront listing purchases based on features).levels-tabs

Configuring Featured Levels (Fee-based Approach)

  1. First, you need to decide how many fee plans you want to offer and create those Fee plans.  For more on that, check the section on Manage Fees.  For our example, we’ll assume you created something like this:  plans-created
  2. Once you have the fee plans created, now you need to associate restrictions according to the fee plan. Click Manage Restrictions on the Admin dashboard under Directory Admin. You should see 3 tabs again–Premium Modules, Field Access, and Character Count Limits.
  3. To Manage Premium Module Restrictions (e.g. Ratings and Maps):
    • If you have Ratings and Maps installed, you can restrict access to these features under the Listing Fee section.  You should always give “cheaper” fee plans access to less features, and “more expensive” fee plans access to more features.  In addition, to keep things consistent for your users, you need to grant access to a feature to all more expensive plans once you grant it to a cheaper one.    IGNORE the Listing Level section in this case.  The section looks like this:levels-maps-fees
    • EXAMPLE: Suppose you have three fee plans:  Basic, Regular and Premium. Basic is the cheapest, Premium is the most expensive.  Suppose you also have Ratings and Maps installed AND you’d like to offer these only to those who purchase more expensive plans.  You would configure the Manage Restrictions/Premium Modules tab like this:
      • Basic: No access to Ratings/Maps (Under the Basic plan row: Allow Access unchecked for Ratings and Maps)
      • Regular: No access to Maps, but allow Ratings (Under the Regular plan row: Allow Access unchecked for Maps, but check it for Ratings)
      • Premium: Access to both Ratings/Maps (Under the Premium level row: Allow Access checked for Maps and Ratings)

      Notice that we’re granting MORE access as we have more expensive plans, but not removing it. (Premium has access to Regular’s features, Regular has access to Basic’s)

  4. To Manage Field Display Access (e.g. showing only certain fields at certain levels):
    • Click the Field Display Access tab
    • Under the “Fields by Listing Fee” section, select the fields you wish to display at each level. You should always give “cheaper” fee plans access to less fields, and “more expensive” fee plans access to more fields.  In addition, to keep things consistent for your users, you need to grant access to a field to all more expensive plans once you grant it to a cheaper one.  IGNORE the Fields by Listing Level section completely
    • EXAMPLE: Suppose you have three fee plans:  Basic, Regular and Premium. Basic is the cheapest, Premium is the most expensive. Suppose you also have added a Facebook and Twitter field AND you’d like to offer these only to those who buy the two most expensive plans. You would configure the Manage Restrictions/Field Display Access tab like this:
      • Basic: No access to Facebook or Twitter (Under the Basic plan row: Check all non-Facebook and Twitter fields)
      • Regular: No access to Facebook, but allow Twitter (Under the Regular plan row: Check all non-Facebook fields)
      • Premium: Access to both Facebook/Twitter (Under the Basic plan row: Check ALL fields)

      Notice that we’re granting MORE access as we have more expensive plans, but not removing it. (Premium has access to Regular’s fields, Regular has access to Basic’s).  The end state should look like this.  Note the restricted fields highlighted in Red:levels-fields-fees

  5. To Manage Character Counts and other Settings (e.g. limiting length of Long Description field and allowing link crawling of custom URL fields):
    • Click the Character Count tab
    • Under the “Listing Fee” section, set the description lengths you wish to enforce per level. 0 means “unlimited” and this is the default if you don’t want to have any limits at all. You should always give “cheaper” fee plans lower character counts, and “more expensive” fee plans the same or higher character counts.  IGNORE the Listing Level section completely here
    • EXAMPLE: Suppose you have three fee plans:  Basic, Regular and Premium. Basic is the cheapest, Premium is the most expensive. Suppose you want Premium listings to have unlimited character counts, Regular gets 750 characters and Basic only 200. You would configure the Manage Restrictions/Character Counts tab like this:
      • Basic: 200 characters (Under the Basic plan row: enter 200)
      • Regular: 750 characters (Under the Regular plan row: enter 750)
      • Premium: Unlimited (Under the Premium plan row: enter 0)

      Notice that we’re granting MORE access as we have more expensive plans, but not removing it. (Premium has more characters than Regular, Regular has more characters than Basic).  The end state should look like this:  levels-character-fees

    • You can also enable featured listings to have “nofollow” removed from the links they post in custom URL fields that are allowed in the listing.   To do this, under the Misc Settings section, check the box “Allow search engines to crawl links”.  This is a nice way to get users to upgrade to at least one featured listing level, just to get the backlink from your site to theirs. Leaving this option off will mean that all custom URL fields will have the “nofollow” attribute added to them. This setting does not affect the regular BD links, such as detail view links from the list view to the detail view of the directory. It only applies to custom URL fields you create in your Manage Form Fields area.

Configuring Featured Levels (Level-based Approach)

  1. First, you need to decide how many levels you want to offer for upgrades and configure those levels.
  2. Now click on Manage Featured Levels on the Admin dashboard under Directory Admin.  Business Directory will always have two levels:  Normal and Featured.  You can add additional ones, but you can’t delete these two.  You are allowed to rename them, as this is something that will show up to the user when they attempt to upgrade.
  3. Create any additional levels that you want to use.  For example, you could rename “Featured” to “Bronze” and then create additional “Silver” and “Gold” levels.  Each level should represent something meaningful to your users because you will be presenting upgrades based on these levels.  For our example, we created the following:  levels-created
  4. Once you have the levels created, now you need to associate restrictions according to the level. Click Manage Restrictions on the Admin dashboard under Directory Admin. You should see 3 tabs again–Premium Modules, Field Access, and Character Count Limits.
  5. To Manage Premium Module Restrictions (e.g. Ratings and Maps):
    • If you have Ratings and Maps installed, you can restrict access to these features under the Listing Level section.  You should always give “lower” levels access to less features, and “higher” levels access to more features.  In addition, to keep things consistent for your users, you need to grant access to a feature to all higher levels once you grant it to a lower level.    IGNORE the Listing Fee section in this case.  Here is the section you should be modifying:  levels-maps-featured
    • EXAMPLE: Suppose you have Normal + two featured levels: Normal, Silver, and Gold. Normal is the lowest, Gold is the highest. Suppose you also have Ratings and Maps installed AND you’d like to offer these only to those who upgrade to featured levels.You would configure the Manage Restrictions/Premium Modules tab like this:
      • Normal: No access to Ratings/Maps (Under the Normal level row: Allow Access unchecked for Ratings and Maps)
      • Silver: No access to Maps, but allow Ratings (Under the Silver level row: Allow Access unchecked for Maps, but check it for Ratings)
      • Gold: Access to both Ratings/Maps (Under the Gold level row: Allow Access checked for Maps and Ratings)

      Notice that we’re granting MORE access as we increase levels, but not removing it. (Gold has access to Silver’s features, Silver has access to Normal’s)

    • When you are done, be sure to click on Save Changes.
  6. To Manage Field Display Access (e.g. showing only certain fields at certain levels):
    • Click the Field Display Access tab
    • Under the “Fields by Listing Level” section, select the fields you wish to display at each level. You should always give “lower” levels access to less fields, and “higher” levels access to more fields. In addition, to keep things consistent for your users, you need to grant access to a field to all higher levels once you grant it to a lower level. IGNORE the Fields by Listing Fee section completely
    • EXAMPLE: Suppose you have Normal + two featured levels: Normal, Silver, and Gold. Normal is the lowest, Gold is the highest. Suppose you also have added a Facebook and Twitter field AND you’d like to offer these only to those who upgrade to featured levels. You would configure the Manage Restrictions/Field Display Access tab like this:
      • Normal: No access to Facebook or Twitter (Under the Normal level row: Check all non-Facebook and Twitter fields)
      • Silver: No access to Facebook, but allow Twitter (Under the Silver level row: Check all non-Facebook fields)
      • Gold: Access to both Facebook/Twitter (Under the Gold level row: Check ALL fields)

      Notice that we’re granting MORE access as we increase levels, but not removing it. (Gold has access to Silver’s fields, Silver has access to Normal’s)  The end state ought to look like this.  Note the restricted fields, highlighted in Red:  levels-fields-featured

    • When you are done, be sure to click on Save Changes.
  7. To Manage Character Counts and other Settings (e.g. limiting length of Long Description field and allowing link crawling of custom URL fields):
    • Click the Character Count tab
    • Under the “Listing Level” section, set the description lengths you wish to enforce per level. 0 means “unlimited” and this is the default if you don’t want to have any limits at all. You should always give “lower” levels lower character counts, and “higher” levels higher character counts (or the same). IGNORE the Listing Fee section completely here
    • EXAMPLE: Suppose you have Normal + two featured levels: Normal, Silver, and Gold. Normal is the lowest, Gold is the highest. Suppose you want Gold listings to have unlimited character counts, Silver gets 750 characters and Normal only 200. You would configure the Manage Restrictions/Character Counts tab like this:
      • Normal: 200 characters (Under the Normal level row: enter 200)
      • Silver: 750 characters (Under the Silver level row: enter 750)
      • Gold: Unlimited (Under the Gold level row: enter 0)

      Notice that we’re granting MORE access as we increase levels, but not removing it. (Gold has more characters than Silver, Silver has more characters than Normal).  The end state should look like this:  levels-character-featured

    • You can also enable featured listings to have “nofollow” removed from the links they post in custom URL fields that are allowed in the listing.   To do this, under the Misc Settings section, check the box “Allow search engines to crawl links”.  This is a nice way to get users to upgrade to at least one featured listing level, just to get the backlink from your site to theirs. Leaving this option off will mean that all custom URL fields will have the “nofollow” attribute added to them. This setting does not affect the regular BD links, such as detail view links from the list view to the detail view of the directory. It only applies to custom URL fields you create in your Manage Form Fields area.
    • When you are done, be sure to click on Save Changes.

Return to Table of Contents


ZIP Search Module

Installation

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

After installing the plugin, you will need to download and install the correct databases for the country(ies) you need to support.  Database installation requires these instructions.

Return to Table of Contents


File Upload Module

Installation

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

Purpose

File Uploads or Attachments allows you to give users the ability to upload certain kinds of documents on their listings.  This might be used to put a pricing guide, a restaurant menu or PO submission procedures for a business to help users when interacting with the business listing itself.  File Uploads supports a number of web-safe file types (PDF, TXT and standard image types).  The settings for attachments can be site-wide, fee plan specific, or used in conjunction with Featured Levels as well.  Listing attachments show up on listings as a series of links like so in the detail view of a listing:

attachments-display

Configuration

File Uploads/Attachments allows you to set site-wide attachment settings for all listings OR you can specify them per fee plan or even use Featured Levels.  Site-wide settings will be used if no other settings are found or changed.  This can be configured under the Directory Admin->Manage Options, Listings tab at the very bottom:

attachments-settings

Listing attachments must be enabled for any listing to use attachments, so ensure this is checked when the module is installed.

The Attachment Header text is the label used on a listing when outputting the attachment links.  Change this as desired.

The Maximum Size and the Allowed File Types allow you to control how big and what kinds of files you allow on your listings.

NOTEWe don’t support attaching MS Word or Excel files at this time because doing so would allow for an easy way for malicious users to spread macro viruses through your site and get you blacklisted on Google!

You can override these settings on Fee Plans if you wish:

attachments-fee-override

Check the “Override Defaults for this Fee” and then make whatever changes you want for this specific fee plan.  Featured Levels has similar settings as well if you have it installed.  Update the Fee plan when you’re done.

Administration of Attachments

From the admin-side, you can easily manage attachments on any listing.  When you edit the listing, on the lower right side, under the Categories (and possibly Regions, if you have that installed), you will see Listing Attachments in a widget:

attachments-listing-manage

Hovering your mouse over the attachment shown, you can Delete it if you wish by clicking on the red Delete link shown.  Clicking on the name of the attachment will display it for you in a window.  You can also add new ones.  Clicking Add Attachment opens this dialog:

attachments-add-attachment

Where you can upload the file as well as specify the text used to display on the link when the listing is shown to users.

Submitting a listing allows users to add the attachments at the same step as adding images in the listing:

 

Return to Table of Contents


Enhanced Categories Module

Installation

Upload the ZIP as a plugin via the MANUAL process. From the WordPress admin panel

  • Go to Plugins->Add New,
  • Click on the “Upload” link, and then click on Browse Now to locate the ZIP file you just downloaded.
  • Click OK once you find it on your local computer
  • Click the Install Now button to start the process.
  • After the installation completes, click the “Activate Plugin” link to turn on the module

Purpose

Enhanced Categories basically allows for two new behaviors in the plugin:  The ability to add images to the Directory Categories page, like so:

enh-categories-images

And the ability to have only parent categories show at the top:

enh-categories

With children showing underneath when clicked:

enh-categories-children

Configuration

Enhanced Categories adds two sets of options to configure.  The first is under the Directory Admin->Manage Options, Listings tab at the very bottom:

enh-categories-settings-listings

Here you can determine the behavior of categories on the Main Directory page.  Using “Parent + Child” means all categories will be displayed.  If you select “Parent Only Categories”, then the main directory will start with ONLY parent categories in it.  Selecting a parent category will display a secondary category screen with the children of ONLY that parent in it.  This is a useful option if you have a very complicated set of parent/child categories and showing them all at once is too much for users to sort through.

You can control the category column display using the “Number of Category Columns to Use”.  This option may have trouble with certain themes that try to aggressively manage the layout, so know that this works most, but not all, of the time.

You can control whether users are allowed to post in child categories only, or any category by checking the option “Only allow listings in child (leaf) categories”.

The other setting added is under the Directory Admin->Manage Options, Images tab at the very bottom:

enh-categories-settings-images

Here you can turn on the ability to display images and how large they should be.  The default is to leave this setting OFF, so if you’re not seeing images, be sure to check the “Display the Category List with Images” option.

 

Return to Table of Contents


Directory powered by Business Directory Plugin