=== SoldPress ===
Contributors: Sanskript
Donate link: http://sanskript.com/
Tags: crea, rets, idx, ddf,Data Distribution Facility
Requires at least: 3.0.1
Tested up to: 3.5.1
Stable tag: 0.9
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

SoldPress is a WordPress plugin to enable CREA's members to easily intergate MLS® listing content on WordPress Sites.

== Description ==

[SoldPress](http://www.sanskript.com/products/soldpress) is a WordPress plugin to enable members of The Canadian Real Estate Assoiciation to easily intergate MLS® listing content on their WordPress Sites. It helps ensure that listing content that is displayed is accurate, up to date, and uses CREA's trademarks correctly.

SoldPress is designed to connect directly to CREA's Data Distribution Facility API without the need to integrate with Third Party Vendors. The Plugin is **free** to use and comes with a basic templating engine.

It is highly *recommended* that you use a persistent cache plugin to minimize API calls.

You may register for a data feed a http://tools.realtorlink.ca. An email containing user name and password is sent to the email address submitted as Technical Contact.

Your site is required to comply with CREA [Data Distribution Policy and Rules](http://www.realtorlink.ca/portal/server.pt/document/3400226/data_distribution_facility_policy_and_rules_updated_april_30%2C_2012).

**Copyright**

MLS®, REALTOR®, and the associated logos are trademarks of The Canadian Real Estate Association

CREA is the owner of the REALTOR® and MLS® trademarks: “REALTOR®, REALTORS®, and the REALTOR® logo are certification marks that are owned by REALTOR® Canada Inc. and licensed exclusively to The Canadian Real Estate Association (CREA). These certification marks identify real estate professionals who aremembers of CREA and who must abide by CREA’s By‐Laws, Rules, and the REALTOR® Code. The MLS® trademark and the MLS® logo are owned by CREA and identify the quality ofservices provided by real estate professionals who aremembers of CREA.

== Documentation ==

SoldPress uses Shortcode syntax to intergrate listing content on your WordPress site.

`[soldpress-listing listingkey="11937198" template="template.html"]`


**Listing Key**

There are two methods to specify a Listing Key.

* Option A : Specifiy Listing Key in the Shortcode.

	`[soldpress-listing listingkey="11937198" template="template.html"]`

* Option B : Specify Listing Key in QueryString

	`?ListingKey=11937198`

*The QueryString ListingKey paramerter superseeds the Shortcode.*


**Templates**

SoldPress uses a basic template enginge to render html output. A SoldPress template is a text file that contains variables, which get replaced with values when the template is evaluated. The template engine is based on heredoc syntax.

The general syntax is `${$rets['ListPrice']}`. 

A comprehensive list of variable names and descriptions can be found at in the [Data Distribution Facility Documentation](http://crea.ca/data-distribution-facility-documentation).


The default template location is wp-content/plugins/soldpress/template/

= Contact Us =

* Support (http://support.sanskript.com)
* Facebook (http://facebook.com/sanskript)
* Twitter (http://twitter.com/sanskript)
* Web Site (http://www.sanskript.com)

= CREA =

* [Data Distribution Facility Documentation] (http://crea.ca/data-distribution-facility-documentation)

== Installation ==

1. Install SoldPress either via the WordPress.org plugin directory, or by uploading the files to your server.
1. Click the Settings -> Soldpress. You need to add your authentication credentials.
1. Click the "Test Connection" to verify the Connection.

**You are required to register for a data feed a http://tools.realtorlink.ca. An email containing user name and password is sent to the email address submitted as Technical Contact.**


= Sample Data Feed Default Credentials =

A sample service is available which provides a wide variety of sample data. A small set of property, office and agent is available from this service.


* Username 		: CXLHfDVrziCfvwgCuL8nUahC
* Password		: mFqMsCSPdnb5WO1gpEEtDCHH
* Url			: http://sample.data.crea.ca/Login.svc/Login
* Template Location 	: wp-content/plugins/soldpress/template/


== Frequently Asked Questions ==

= Where do I get authentication credentials? =

An email containing user name and password is sent to the email address submitted as Technical Contact when data feeds are registered in http://tools.realtorlink.ca.  The owner of the data feed can view credentials when editing the feed on the Data Feeds page.

== Screenshots ==

1. Sample - Basic Template File.
2. Sample - No Template File


== Changelog ==

= 0.9 RC =
* Release Candiate.

== Upgrade Notice ==

= 0.9 RC =
* Release Candiate