Installation of Moxie Maps 2.5.2

There are 4 parts of the installation process:
	Installing and Configuring of the Moxie Zip Search Field Type into Mosets Tree
	Installing and Configuring of the Moxie Zip Search Module
	Installing the MoxieMaps template for Mosets Tree
	Installing the Savant2 plugins for Mosets Tree

Before installing any of the Moxie Maps 2.5.1 package, please verify that you have obtained a Google Maps API Key (http://code.google.com/apis/maps/signup.html),
and entered it into your Mosets Tree configuration on the Features tab. In addition, please set Show Map to Yes on the Features tab. 
You'll then need to use the "Locate Listings in Map" link in Mosets Tree (bottom left) to Geocode your listings based on their address information.
Once you have done this and verified that the maps show properly on a listing detail page, proceed with the installation of Moxie Maps 2.5.

STEP 1:

	Log into the backend of your Joomla site i.e., http://yoursite.com/administrator.
	Select Mosets Tree from the Components menu.
	Click the Custom Fields link in the bottom left corner of the page.
	Click the "Manage field types" link above the custom fields list.
	Click the "Add" button in the top right corner.
	Using the "Upload Package File" process, click the Browse button.
	Navigate to the "mFieldType_MoxieZipSearch-2.5.xml" file on your computer and select it.
	Click the "Upload File & Install/Update" button.
	
	You should see a "Field type installation successful." message.
	
	Now, click the "Back to custom fields" link.
	Click the "Moxie Zip Search" link at the bottom of the list.
	Set "Published" to "Yes"
	Set "Show in details view" to "No"
	Set "Show in summary view" to "Yes"
	Set "Advanced Searchable" to "Yes"
	Set "Hidden Field" to "Yes"

	Select the Parameters in the right column to your choosing.
	These parameters affect how the search fields are presented on the Advanced Search page:
		Search Type
			Nearest Listings - This option will not restrict the search by a user specified radius. It will return all listings sorted by distance from the searched Zip/Post code.
			
			Radius Search - This option presents the user with a Radius select box where they can choose a maximum distance from the center of the searched Zip/Post code to search within.
			
		Distance Unit - Select whether to use Miles or Kilometers in the Radius select box
		
		Radius Values - Enter the values for the Radius Select box. Separate values by a comma.
		
		Show Country List - Determines if a country list is shown to the user. When selecting a country, the Zip/Post code geocoding is influenced by the country selected.
		
		Default Country - Enter a country code i.e., US to use for the default country to use when searching.
		
	Be sure to click the Save button when done.
	
	
STEP 2:

	While in the Mosets Tree component, click the "Templates" link in the bottom left corner.
	Click the "New" button in the top right corner.
	Click the "Browse" button and navigate to the "MoxieMapsTemplate.zip" file on your computer.
	Click the "Upload File & Install/Update" button.
	
	You should see a "Template installation successful." message.
	
	Select the radio button next to the "Moxie" template.
	Click the "Default" button in the top right to make this template the default template.
	

STEP 3:
	
	Install the mod_moxie_zipsearch module using the Joomla Install/Uninstall function in the Extensions menu.
	Configure the module in the Module Manager.
	Many of the options are the same as set previously but only affect the Module when set here.
	Make sure to Publish the module.

STEP 4:

	You'll need to add the Savant2_Plugin_ahrefprintmoxie.php file to the "components/com_mtree/Savant2" directory.
	You'll need to add the Savant2_Plugin_moxiedistance.php file to the "components/com_mtree/Savant2" directory.
	You'll need to add the Savant2_Plugin_moxiemaps.php file to the "components/com_mtree/Savant2" directory.
	You can not use the Joomla installer to do this but must use a FTP client or some other means i.e., ssh, file manager, joomla based file manager, etc.
	

NEW OPTIONS:
	Version 2.5.1 includes new options configurable within the templates that determine how the map and markers will be shown:

	The map can be added to any Mosets Tree template that shows one or more listings with the following code format:
	$this->plugin("moxiemaps", $this, 'width', 'height', 'show', floatMap, cluster);
	
	The parameters included in this line are detailed below:
	
	moxiemaps - name of the plugin, don't change
	$this - passes listings to the plugin, don't change
	width - width of the map. You can use either values as percentages '100%' or in pixels i.e., '400px'
	height - height of the map. You can use either values as percentages '100%' or in pixels i.e., '400px'
	show - You can now choose to show:
		'page' - Listings on Page - this is the default. If you are showing 10 listings per page, you'll have 10 listings on the map
		'all' - All Listings in the directory
		'category' - All Listings in this category. Only works in the sub_listings.tpl.php template file.
		'featuredincategory' - All Featured Listings in this category. Only works in the sub_listings.tpl.php template file.
		'featured' - All Featured Listings in the directory
	floatMap - true/false - indicates if the map should float or scroll as the page scrolls
	cluster - true/false - turn the cluster function on/off for the markers
	
	Sample code:
		echo $this->plugin("moxiemaps", $this, '100%', '500px', 'all', false, true);
		Map would be 100% wide, 500px tall, showing all listings in the director, not floated, and using the cluster feature


This completes the installation and configuration of Moxie Maps 2.5.

2010-01-20 17:40  samlewis

	* READ_ME.txt,
	  components/com_mtree/templates/Moxie/templateDetails.xml: Updated
	  version number

2010-01-20 17:36  samlewis

	* components/com_mtree/templates/Moxie/page_index.tpl.php: Fixed
	  issue where the "add listings in root" parameter was not working
	  properly

2010-01-20 17:35  samlewis

	* components/com_mtree/Savant2/Savant2_Plugin_moxiemaps.php: Added
	  css classes to the infowindow and elements to allow the
	  infowindow to be styled via css
	  Fixed Directions script that was not included properly

2010-01-15 18:56  samlewis

	* components/com_mtree/Savant2/Savant2_Plugin_moxiemaps.php: Fixed
	  bud where directions function was not getting included properly
	  rendering the Get Directions button useless.

2010-01-15 13:52  samlewis

	* READ_ME.txt:

2010-01-14 01:10  samlewis

	* READ_ME.txt:

2010-01-14 01:03  

	* READ_ME.txt:

2010-01-14 00:54  

	* READ_ME.txt:

2010-01-14 00:50  

	* READ_ME.txt:

2010-01-14 00:07  samlewis

	* components/com_mtree/Savant2/Savant2_Plugin_moxiemaps.php: Added
	  check for existing image when building infowindow

2010-01-13 23:43  samlewis

	* components/com_mtree/Savant2/Savant2_Plugin_moxiemaps.php: Fixed
	  some minor php issues which caused an issue on PHP version 5.2.8

2010-01-11 17:06  samlewis

	* READ_ME.txt:

2010-01-11 16:59  samlewis

	* .:

2010-01-08 19:50  samlewis

	* READ_ME.txt:

2010-01-08 19:30  samlewis

	* READ ME.txt, READ_ME.txt: Renamed READ ME.txt to READ_ME.txt

2010-01-08 16:51  samlewis

	* READ ME.txt:

2010-01-08 16:46  samlewis

	* READ ME.txt:

2010-01-08 16:31  samlewis

	* READ ME.txt: Updated Read me file for 2.5.1 release

2010-01-08 16:29  samlewis

	* modules/mod_moxie_zipsearch/mod_moxie_zipsearch.php,
	  modules/mod_moxie_zipsearch/mod_moxie_zipsearch.xml,
	  modules/mod_moxie_zipsearch/tmpl/default.php: Added ability to
	  search by keyword in the link_name field in the module along with
	  the zip code/city.
	  This can be turned on/off in the module configuration

2010-01-08 16:14  samlewis

	* ., components, components/com_mtree,
	  components/com_mtree/Savant2, components/com_mtree/templates,
	  language, language/en-GB, modules:

2010-01-08 01:13  samlewis

	* language, languages:

2010-01-08 00:58  samlewis

	* READ ME.txt,
	  components/com_mtree/Savant2/Savant2_Plugin_moxiemaps.php,
	  components/com_mtree/templates/Moxie/page_advSearchResults.tpl.php,
	  components/com_mtree/templates/Moxie/page_index.tpl.php,
	  components/com_mtree/templates/Moxie/page_listAlpha.tpl.php,
	  components/com_mtree/templates/Moxie/page_listListings.tpl.php,
	  components/com_mtree/templates/Moxie/page_listing.tpl.php,
	  components/com_mtree/templates/Moxie/page_ownerListing.tpl.php,
	  components/com_mtree/templates/Moxie/page_usersFavourites.tpl.php,
	  components/com_mtree/templates/Moxie/sub_listings.tpl.php,
	  components/com_mtree/templates/Moxie/sub_map.tpl.php,
	  components/com_mtree/templates/Moxie/template.css,
	  components/com_mtree/templates/Moxie/templateDetails.xml: Moved
	  map generation and related javascript functions to a Savant2
	  plugin to clean up templates and avoid duplication of code.
	  The map can be added to any Mosets Tree template that shows one
	  or more listings with the following code format:
	  $this->plugin("moxiemaps", $this, 'width', 'height', 'show',
	  floatMap, cluster);
	  
	  The parameters included in this line are detailed below:
	  
	  moxiemaps - name of the plugin, don't change
	  $this - passes listings to the plugin, don't change
	  width - width of the map. You can use either values as
	  percentages '100%' or in pixels i.e., '400px'
	  height - height of the map. You can use either values as
	  percentages '100%' or in pixels i.e., '400px'
	  show - You can now choose to show:
	  'page' - Listings on Page - this is the default. If you are
	  showing 10 listings per page, you'll have 10 listings on the map
	  'all' - All Listings in the directory
	  'category' - All Listings in this category. Only works in the
	  sub_listings.tpl.php template file.
	  'featuredincategory' - All Featured Listings in this category.
	  Only works in the sub_listings.tpl.php template file.
	  'featured' - All Featured Listings in the directory
	  floatMap - true/false - indicates if the map should float or
	  scroll as the page scrolls
	  cluster - true/false - turn the cluster function on/off for the
	  markers
	  
	  Sample code:
	  <?php echo $this->plugin("moxiemaps", $this, '100%', '500px',
	  'all', false, true);?>
	  Map would be 100% wide, 500px tall, showing all listings in the
	  director, not floated, and using the cluster feature

2010-01-08 00:17  samlewis

	* components/com_mtree/Savant2/Savant2_Plugin_moxiedistance.php,
	  components/com_mtree/templates/Moxie/sub_listingSummary.tpl.php:
	  Moved the "distance away" function to a Savant2 plugin to keep
	  templates cleaner.
	  This function calculates the listings distance from the center of
	  the searched zip code/city.

2010-01-08 00:14  samlewis

	* components/com_mtree/templates/Moxie/sub_mapinfowindow.tpl.php:
	  Added infowindows to the map markers. These are configurable to
	  include/or not the listing image, description, and/or address.
	  This is set in the template configuration window. In addition, we
	  take advantage of the Zoom infowindow option to show a much more
	  detailed view of the listing. This view can be fully customized
	  using the new sub_mapinfowindow.tpl.php file.

2010-01-08 00:11  samlewis

	* components/com_mtree/templates/Moxie/markerclusterer_packed.js:
	  Added clustering option to maps - This allows showing many more
	  markers on the map with less performance implications and less
	  visual distraction. Multiple markers are detected and combined
	  into a single "Cluster" marker with a number indicating the
	  number of markers in the near vicinity. Clicking a cluster marker
	  zooms the map and shows the "clustered" markers.

2010-01-08 00:07  samlewis

	* mFieldType_MoxieZipSearch-2.5.xml: Updated
	  mFieldType_MoxieZipSearch to version 2.5.1

2010-01-08 00:07  samlewis

	* mFieldType_MoxieZipSearch-2.5.1.xml: When searching by zip
	  code/city, the distance is used as the first sort parameter and
	  now the second sort parameter is based on the settings in Mosets
	  Tree configuration->Search->Primary ordering
	  
	  Removed JError::raiseError when zip code can't be geocoded. Force
	  no results instead.

2010-01-07 23:47  samlewis

	* components/com_mtree/templates/Moxie/sub_map.tpl.php: Added a
	  "Did you mean?" feature to the driving directions function. This
	  should help users choose appropriate address information if they
	  supply arbitrary data initially.

2010-01-07 23:42  samlewis

	* READ ME.txt, mFieldType_MoxieZipSearch-2.5.xml: Moved field type
	  file and read me to root of directory

2010-01-07 23:41  samlewis

	* components/READ ME.txt,
	  components/mFieldType_MoxieZipSearch-2.5.xml: Moved field type
	  file and read me to root of directory

2010-01-07 23:27  samlewis

	* components, components/READ ME.txt, components/com_mtree,
	  components/com_mtree/Savant2,
	  components/com_mtree/Savant2/Savant2_Plugin_ahrefprintmoxie.php,
	  components/com_mtree/templates,
	  components/com_mtree/templates/Moxie,
	  components/com_mtree/templates/Moxie/index.html,
	  components/com_mtree/templates/Moxie/mooFloater.js,
	  components/com_mtree/templates/Moxie/page_advSearchResults.tpl.php,
	  components/com_mtree/templates/Moxie/page_index.tpl.php,
	  components/com_mtree/templates/Moxie/page_listAlpha.tpl.php,
	  components/com_mtree/templates/Moxie/page_listListings.tpl.php,
	  components/com_mtree/templates/Moxie/page_listing.tpl.php,
	  components/com_mtree/templates/Moxie/page_ownerListing.tpl.php,
	  components/com_mtree/templates/Moxie/page_print.tpl.php,
	  components/com_mtree/templates/Moxie/page_usersFavourites.tpl.php,
	  components/com_mtree/templates/Moxie/sub_listingDetails.tpl.php,
	  components/com_mtree/templates/Moxie/sub_listingSummary.tpl.php,
	  components/com_mtree/templates/Moxie/sub_listings.tpl.php,
	  components/com_mtree/templates/Moxie/sub_map.tpl.php,
	  components/com_mtree/templates/Moxie/template.css,
	  components/com_mtree/templates/Moxie/templateDetails.xml,
	  components/mFieldType_MoxieZipSearch-2.5.xml, languages,
	  languages/en-GB, languages/en-GB/en-GB.mod_moxie_zipsearch.ini,
	  modules, modules/mod_moxie_zipsearch,
	  modules/mod_moxie_zipsearch/helper.php,
	  modules/mod_moxie_zipsearch/index.html,
	  modules/mod_moxie_zipsearch/mod_moxie_zipsearch.php,
	  modules/mod_moxie_zipsearch/mod_moxie_zipsearch.xml,
	  modules/mod_moxie_zipsearch/tmpl,
	  modules/mod_moxie_zipsearch/tmpl/default.php,
	  modules/mod_moxie_zipsearch/tmpl/index.html: Commit of version
	  2.5 of Moxie Maps

2010-01-07 23:22  samlewis

	* .: