Knowledge Base - Getting Started Guide

Plugin : Joomla content

Introduction

This plugin allows you to geocode any Joomla! article, without adding any other fields or any core files modifications. The geocoding process takes place during the article "save" process, based on an address written into the article.

Configration

Since we already have the plugin installed, let’s see how to configure it :

In the Joomla! back-end, navigate to the Plugin Manager and select the Geocode Factory Articles Plugin. You should be able to see the plugin successfully installed, like the following screenshot.

Geocode-Factory-articles-how-to-configure1

The next step is to select the plugin and enable it by clicking on the “Enable” icon. The plugin is now enabled and you can start its configuration and settings. The following parameters are the ones that you will need to set up from the Plugin interface:

Geocode-Factory-articles-how-to-configure2

 

  • Id of the used map : This is mandatory. Since Joomla 1.6, you can select the map from a dropdown list. Before this, you need to specify the ID of the Geocode Factory map to display on the Joomla! article. You can find the map id in the Geocode Factory component, map manager. All settings for the maps (map type, size, template, ...) are inherited from this chosen map. IMPORTANT: If the ID of the Geocode Factory is not specified, in your frontend Joomla! article you will see the following error message: 'There is no published map or bad map id.'
  • Show map : By selecting 'yes' the map will be shown in the Joomla article. This is useful if you want to display a map at the plugin code location within the article. If you select 'no', the plugin code will be simply removed. In both cases, the article can be shown as a marker on global Geocode Factory maps.
  • Map type :Set the type of the map (Geocode Factory map or static map) that you need to use in the Joomla article. 
    • Geocode Factory map, set it up on Geocode Factory component before use it in article. IMPORTANT : if you seen in Joomla article the following error message : "The map placeholder [map] is required, and not found in your map template..." then please be sure you have set a map template in the map manager.
    • Static map, will show an generated image for your Google map into the Joomla article. This can be very useful for loading performance, if you just need a map to illustrate the article.
  • Google server : you should use the Google server from your country. For examples google.it or google.co.uk. This can be useful for Geocoding in cases where the same address exists in multiples countries.
  • Map zoom : define the zoom level of the map as an integer value. A value between 12 and 15 will be just fine. You can already leave this blank or 0, and the default viewport will be calculated based on the Geocode Factory map ID.

After all parameters are set, please save it.

Plugin usage

After successfully finishing the article plugin configuration, from the Joomla! back-end article manager select the article (s) where you need that Geocode Factory Map to be shown and/or articles that need to be visible on the map and enter the following plugin code syntax into the text :

  • Code : {myjoom_gf xxx} code, where xxx is the address.
  • Sample: {myjoom_gf Houston, Texas, USA}

The position where this plugin placeholder is written is important, it will be replaced by the map if you selected the display map option. You can embed the code into an article {myjoom_gf ...}, and the map will follow the styles.

 

geocode-plugin-code-article-edition

At the moment the article is saved (or applied), the entered address is geocoded by the plugin, without any other intervention. Repeat this operation in each article in which you need a map. In each of them, only a single map will appear where {myjoom_gf xxx} is located in text of page. The map will show the positions according with each address, introduced separately in Joomla articles. Note : This can be done by editing article from back-end or front-end.

Now, you can create a markerset based on Joomla! articles and you will see any geocoded article on your map, at the right position.

Geocode-Factory-articles-how-to-configure3

Case study

Imagine a Joomla! site that displays tourist spots in a country. There will be a section named Spots, and 3 categories named : Zoos, Monuments and Sports. In each category you have several articles for each park. That will give you :

  • Spots / Zoos / Zoo 1
  • Spots / Zoos / Zoo 2
  • Spots / Zoos / Zoo n ...
  • Spots / Monuments / Monuments 1
  • Spots / Monuments / Monuments 2
  • Spots / Monuments / Monument n ...
  • Spots / Sports / Stadium 1
  • Spots / Sports / Stadium 2
  • Spots / Sports / Stadium n ...

Now, each article describe the place with several text, images and the famous {myjoom_gf xxx} where the xxx is replaced by the address of each park.

google-maps-in-joomla-article-geocode-01

When you save the article, the address is automaticaly Geocoded. The frontend result is :

google-maps-in-joomla-article-geocode-02

 

In Geocode Factory there are 2 maps :

  • Article map : basic map, without controls, map 200x200px
  • General map : main map, with several controls, like radius search, route planner, side list, 100% width ...

And 4 markersets :

  • General markerset : linked to "article map", with a basic icon, simple info bubble
  • Zoos, Monuments and Sports markersets  : 3 markersets linked with "main map", each markerset has its own icon (zoo, monument, sport), and detailled bubble, each is based on hes category.

On main page of site, there is the big general map, that contains all markers on the same map (zoos, ...), and a selector for each type, and when user go on different articles, he see the current map.

google-maps-in-joomla-article-geocode-03

This plugin allows you to geocode any joomla article during the saving process, based on a address writed into the article. Since we already have the plugin installed, let’s see how to configure:

1) Through the Joomla Administration Panel navigate to the Extensions/Plugin Manager and select the Geocode Factory Articles Plugin. You should be able to see the plugin successfully installed, like the following screenshot

Applies To

Geocode Factory 3