Welocally Places Basic Plugin Guide
Welocally Places Plugin for wordpress is intended to help site authors link real places to their content quickly, and then help their readers find those places quickly. This document is intended to help the blog owner or wordpress developer install, configure and use the plugin. It is structured by the administrative and user components associated with the plugin.
PLEASE NOTE: This is software, we need your help to make the product, the documentation, and the community better. Here are some helpful links so that you can get involved.
- WordPress 2.8 or Greater
- jQuery 1.4.1 or Greater (included in WordPress)
Authoring Browser Support
End User Browser Support
These are the browsers we have tested for end user support, that is the people who come to your website and use welocally places. It will look different in different browsers but all of these browsers will see places and maps. Our most supported browsers are Chrome, Firefox and Safari.
Manual Plugin Installation
To install the Welocally Places plugin, the following are the general directions to follow. Remember: BACKUP – just in case.
- Read through the “readme” file thoroughly that accompanies a plugin.
- Upload the plugin to thewp-content/pluginsfolder in your WordPress directory online.
- Make any changes to templates or files as required by the Plugin instructions including adding Plugin template tags. (None known at this time)
- Activate the Plugin:
- Access the Plugin Panel in your Administration Panels
- Scroll down through the list of Plugins to find the newly installed Welocally Places Plugin (if not visible, start from the beginning to check to see if you followed the instructions properly and uploaded the file correctly).
- Click on theActivatelink to turn the Pluginon.
If you are upgrading and an install this manually make sure to re-activate the plugin, activation does important database updates.
Throughoutthe plugin there are basic components that are used in multiple places, for example the Map Info Box, is used in the same way in the Map Widget, The Category Map and in the Single Post info pages.
The Place Tag
The place tag is the foundation of welocally places and it is what allows the plugin to actually lookup and link the place to the post or page that you are authoring. Welocally places tags each have a unique ID that allows it to look up the information about that place and make a map. This tag looks something like this:
Places Map Widget
The Places Map Widget is a custom widget that is installed with the plugin. Every time you add a place to a post the Places Map widget will show it, as well as all the other places you have posted, on a single map. It can be used in any theme sidebar on the site. It will attempt to show related places to the category page or post that your user has navigated to, that is it automatically filters places on the map based on context.
It acts identically like the Category Tag Map by making a map with selectable markers and a list which can also be selected. When a user selects either a marker or a list item an infobox will pop up at the location of the selected item on the map.
Category Map Tag
The category map allows your users to filter the posts associated with specific categories on a single map, just like the Map Widget. This is helpful if you want to segment different places by type and show them to your readers on a page. making a directory? Just insert the tag “Shopping” or “Bars & Pubs” on a page and you have a simple map for a shopping guide of all the places you have written about.
For example; if you had a pizza blog you might assign The Ugly Duck Pizza with the “Thin Cust” and “Rustic Wood Oven” categories. When your reader was looking for the pizzas of the New York Style only the pizza restaurants that had thin crust pizzas would show as ordered markers, and it would link the places back to the posts where you wrote about them. When a user selects a specific post excerpt, an info box identifying that place on the map will appear.
Custom Post Types
Many wordpress themes such as SwagMag – WordPress Magazine/Review Theme use the concept of custom post types to manage an maintain posts. Welocally Places supports one or many custom post types, but you must use the post type name in the database for it to work
properly. Multiple custom post types are supported byt they must be comma delimitated no spaces.
You can configure the widget to use custom post types in the same way using the options.
Associating A Place to A Post
All place to post associations (aka “linking”) are done by either looking or generating place tags. To use an existing place the place search wizard is used which is a simple step based process that easily guides you through keyword search and geocoding. If a place does not exist you can easily add it.
Adding New Places – Add Place Meta Box
While there are are very many places in our database it is possible that a very cool place you want to use is not there. In that case please add it to the database. When you do try to use the real name of the place and the full address, if your not sure use the name most people call it. Pressing the tab key will take you to the next field.
Now you will want to enter the real address for the place you want to add. Its important to give as full an adress as you can because driving directions and the location is determined by this. If you dont give enough information you will see a message like this:
Once you have entered enough information the location of the new place will be geocoded for you, and you will be prompted to enter the optional fields for the place, Phone number and Website. While we dont require these fields we strongly recommend that you add them. If you can find them, it grows your site’s reputation as a local referrer to have as much rich information about the places you are writing about as possible.
Now you are ready to add the place, just press the “Add Place” button and it will be added to our database and will become searchable. You can then select the new tag for the place you created then copy and paste it into your post.
Options allow you to control the plugin, and we have created a custom option. We have a custom sidebar options tab, so in setting up welocally places just select the side tab item.
- Welocally Places General Options – (This page) Basic configuration for the mapbehaviorsof the plugin.
- About – Requirements status and the api server that is being used. Better not to play with this one unless we tell you to.
- Places Manager – A simple places manager that lets you see all your post places in on UI, you can also delete place posts if you want to.
Welocally Places General Options
General Map Options, Infobox Place Links
This option, if checked, will make the title of the place in the map infobox, or in the list selector a link back to the post in which it was placed.
Show Indexed Markers
When checked, this option will show up to 25 place markers on the map with letters indexed based on their order of results, and indexed markers for the select list. When not checked all the marker items on the map will have the same marker and the list will only have text.
Show Section Item Markers
The selection item list is the list of selectable boxes below a category tag map or
map widget map. It lists the places related to the markers shown related to the map.
The Places Manager is a simple way to see what posts are linked to places in one place. A full list of all linked places shows with an edit link to post
so it can be updated. If you wish to delete a post place just check and item and hit the delete button.
- Using the Place Tag – Each place has the tag you can use to insert it into your content, just copy and past in the post or page editor window.
- Search Filter – Will filter paginated results on any keyword in the name ie “Tailor”.
- Paginated Controls – Search results are paginated in 10 place increments, ordered by date added. Use these controls to browse results
- Editing Places – Editing places will update the information about that place everywhere.
- Deleting Places – Delete places from the place list.
Editing places will update the information about that place everywhere on your site. Use the dialog and save, then close the dialog. When you do the information in the place manager should be updated, and everywhere on the site that place is used will get updated as well.
Deleting places will remove the place from the database as well as the relationship between the place and the post. When you do this the tag is not removed so you will have to manually go back to post and remove the tag.
do not communicate with any other servers. If you experience an error and would like us to investigate it please contact us.