Welcome to the Ideal Store Locator Documentation! This comprehensive guide will help you get the most out of the Ideal Store Locator plugin for Joomla!™. Whether you're just getting started or looking to unlock advanced features, our documentation provides step-by-step instructions, helpful tips, and detailed explanations to ensure a smooth and efficient setup.
Getting Started:
Installation
- Select System → Install Panel → Extensions from the Adminstrator menu.
- Select the zip file and click on the Upload & Install button;
- Joomla will automatically install the plugin. Wait for the installation to complete.
- Once installed, you will see a success message confirming the installation.
- Enable the Plugin:
- After installation, navigate to System → Manage Panel → Plugins, then Search for Ideal Store Locator.
- Enable and Save;
Usage
In order to display a Store/Contact Locator add the following syntax to a content item (article):
Loads all contacts and sets the height for the map:
{istorelocator height=|600|}
Loads all contacts from category 1 and sets the height for the map:
{istorelocator height=|600| category=|1|}
Loads all contacts from category 1, 2 and 3 and sets the height for the map:
{istorelocator height=|600| category=|1,2,3|}
Ability to filter by city, state and/or country and ignore any search. Example Syntax:{istorelocator category=|78| filter_city=|Boston| filter_state=|MA| filter_country=|USA| zoom=|10| firstload-loadall=|1| firstload-limit=|9999| firstload-maxdistance=|123456| }
{istorelocator height=|600| source=|xml| file=|GreatBritain-Attractions.xml|}
set the source to XML and loads the XML file containing locations
{istorelocator height=|600| source=|csv| file=|Germany-CastleFortSchlossRuins.csv|}
Set the source type to CSV (Comma Separated Values) and load file with locations
{istorelocator height=|600| source=|kml| file=|example.kml|}
Set source type to KML (Google Earth) and loads file with locations
Plugin Options
On the Administrator Panel, navigate to System → Manage Panel → Plugins, then Search for Ideal Store Locator. There you'll find all plugin options like:
Under the "Basic" tab:
- Default location: The initial Map center in case the Auto detect Geo Location fails. Just the latitude and longitude will be used, so this address will not be displayed anywhere.
- Default zoom level;
- Scroll wheel zooming;
- MapType Control;
- Map Type: Roadmap (default and recommended), Satellite, Hybrid, Terrain;
- Navigation Control;
- Home Marker Icon: Defines an image to be used as the home icon for a Marker. Image Directory:
/plugins/system/istorelocator/assets/images/markers
- Directions Travel Mode; Default Driving
- Link To Google Maps: When enabled displays a Link to maps.google.com (prefilled with the from and to coordinates) in the direction container
Under the "Map Style" tab:
- As of version 3 of the Google Maps API custom styles can now be applied to maps. This allows you to pick a style that matches the theme of their website.
You can create your own style using the Google Styled Maps Wizard and copy the JSON code to this field OR use an existing map from snazzymaps.com
Under the "Search" tab:
- Position: Location to display the Search form (inside the map OR above it);
- Result Limit: Maximum number of results per search;
- Geolocate: Whether to display a Geolocate button, Geolocate on page load OR both;
- Geolocate button class: Customize the button class using Bootstrap button style (styling may change depending on your front-end template). Options for this template are displayed below, but this might change depending on your template:
- Unit System: The unit system to use when displaying distance. Metric will display in Kilometers and Imperial (English) will display in Miles;
- Max Distance List: Number separated by commas to build a list. Set to 0 to hide and add 123456 to display the "Anywhere" as the last option.
- Selected Max Distance: Select one of the values from the Max Distance List to display as the default value;
Under the "Location List" tab:
- Show route: Whether to hide or show directions button. Also set the Bootstrap button style (styling may change depending on your front-end template). Options are the same as the ones shown in the Geolocate Button Class.
- Show distance: Whether or not show the distance label and it's styling (styling may change depending on your front-end template). Options:Primary Info Success Warning Danger Default
- Source: There are a few options to load the locations: The best option is to load them using:
- Contact Enhanced Component (the best option in our opinion),
- XML (see example) (second best option in our opinion),
- CSV file (see example) (third best option in our opinion);
- KML (see example). KML is the file generated from Google Earth. It's easy to create a file using Google Earth, however it doesn't allow you to use all iStoreLocator features.
- File: The source file for the XML, KML or CSV file. Upload your files to /plugins/system/istorelocator/data/
- Show details: Whether or not show the details button and it's styling. If the source is Contact Enhanced, the details button will link to the Contact page. Styling may change depending on your front-end template.
- Image;
- Webpage;
- Skype;
- Facebook;
- Twitter;
- Miscellaneous (more info);
Under the "Filter Groups" tab:
Displays a list of tags (in checkboxes) which allow users to filter the locations by, displaying only locations that match the selected tags. If Marker Clusters option is enabled it will recalculate the markers in each cluster;
The source of the tags can be one of the following:
- Name
- Category Only available when using with Contact Enhanced Component
- Metakey Meta Keywords
- City
- State
- Country
- Postcode
- Tags Only available when using with Contact Enhanced Component
Under the "Language Editor" tab:
If your site is for one language only you can use the options under this tab to change the language strings for this plugin. Otherwise please use the Extensions -> Languages -> Overrides
OR translate in Transifex to your language;
Under the "Advanced" tab:
- Force Bootstrap: The script for this plugin is loaded after the page is rendered and in order to avoid incompatibility with other extensions and templates it doesn't load Bootstrap and jQuery by default. If your template or other extensions are not loading these two javascript libraries, than please enable this option and choose which module positions you want to force loading these files;
- Menu Item: Select the Menu Item(s) you want to force loading Bootstrap and jQuery;
- Load FontAwesome: Some icons like the Social media icons are loaded using FontAwesome. You can disable if your template is already loading it;
- Custom CSS: Allows you to add custom CSS rules;
- Custom Javascript: Allows you to add custom Javascript;