Google Maps Simple Module User Guide

From Fishcakes Wiki

Jump to: navigation, search
Edit Menu

Image:Icon_Exponent_40px.png Google Maps Simple Module User Guide

User Guide for the Exponent Google Maps Simple Module developed by Fishcakes.
For development info about this module, see the Google Maps Simple Module development page.


Contents

About Google Maps Simple Module

This module will display Google Maps on an Exponent website using a Google Maps Link or an external KML File. The module folder is googlemapsimplemodule with sub-folders containing files as indicated below.

Note: All screenshots are from a site which uses the Fishcakes Revenge Exponent Theme. Actual page layout will vary with themes.

Using the Module

Add the Module to Page

  1. Use the Exponent Container Add a new module here button to add content to your page.
    image:Googlemapsimple_container_add.png
  2. The Module selector page will now load.
    image:Googlemapsimple_container_set.png
  3. Use the Module selector to select Google Maps Simple Module.
  4. Use the View selector to select either Default or List View.
  5. Set the Module Title or leave empty if you don't want a title to appear.
  6. Click the Use Existing Content link if you want to use content from an existing module.
  7. Use the Description field for your notes (this field is not displayed to end users).
  8. Click 'Save. Your module should now be added to the page.
    image:Googlemapsimple_edit_new_module.png

Module Configuration

  1. Click on the Configure this Module icon to load the Module Configuration page.
    image:Googlemapsimple_edit_configure.png
  2. Set the Google API Key for your domain or sub-domain. To get a key visit Get Google Maps API Key.
  3. Set the Google Country you want the maps to be generated from. See the Google Maps Country Domains section of this Wiki for more info.
  4. Click 'Save. Your module is now ready for maps to be added.
    Note: If you try to add a Map before you Configure the Module, you'll get an error message.
    image:Googlemapsimple_edit_configure_warning.png

Map Configuration

Create a Map

  1. Click on the Create New Map link to load the Map Setup page.
    image:Googlemapsimple_edit_map_top.png
  2. Either input your Google Map Link or click on the Browse button to upload a KML File.
    image:Googlemapsimple_edit_map_source.png
For more info about Google Map Links or KML Files see the Google Maps My Maps and KML Files section of this Wiki.

Set Map Size & Controls

These controls are for Google Map Link generated maps. If you use a KML File these settings will be ignored.

  1. Set your Map Width and Map Height.
    image:Googlemapsimple_edit_map_controls.png
  2. Tick the Width as % box if you want the Map to fill the width of the page, table or div which houses it.
  3. Select whether you want the Map Controls to appear on your map.
  4. Select weither you want the Map Markers to appear on your map.
For more info about Map Controllers see the Google Maps Control Widgets section of this Wiki.

Set Map Description

  1. Give a Title to your map, or if you don't want a title, leave this empty.
    image:Googlemapsimple_edit_map_notes.png
  2. Input the Body Text you want to appear with your map, or if you don't want and body text, leave empty.
  3. Input any Notes which you want to keep but don't want end users to see.
  4. Click 'Save. Your map should now appear on your page.
    image:Googlemapsimple_edit_default_view.png

Changing Map Order

Once you have added a few maps to your module, you can use the Move Up and Move Down links below each map to change the order in which they appear on the page.

image:Googlemapsimple_edit_rank.png

Module Views

Default view

  • File views/Default.tpl

Displays from 1 to X Google Maps on a single page. The Module Title is displayed if not empty. The Map is displayed with a Title and Summary text, though both will be ignored if left empty. Note: You should avoid displaying too many maps on a single page as this can cause problems for some users.

image:Googlemapsimple_default_view.png

List View

  • File views/List View.tpl

Displays links to 1 to X Google Maps on a single page. The Module Title is displayed if not empty. The Map is NOT displayed, but the Title and Summary text are displayed with links to the map which is displayed by View map. If the Title is empty, then it will be generated as Map + Module Map ID, e.g. Map 1.

image:Googlemapsimple_list_view.png

View map

  • File views/_viewgooglemapsimple.tpl

Displays a single Map. The Map is displayed with a Title and Summary text, though both will be ignored if left empty. A back button will return the user to the previous page (usually the List View, but whatever the last Exponent page the user was on before linking to the View map page.

image: Googlemapsimple_view_map.png

Edit Map view

  • File views/_form_editgooglemapsimple.tpl

Displays the Edit Map view for adding Maps to the Module.

image:Googlemapsimple edit map.png

Setting Up a Google Map or KML File

For detailed instructions on setting up a Map or KML file see Setting Up Google Maps My Maps and KML Files in the Google Maps category of this wiki.


Image:Icon Resources 20px.png Exponent CMS Resources

Official Exponent Resources


Unofficial Exponent Resources

MySQL Resources

PHP Resources


Personal tools