.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ================== LumoNet Google Map ================== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Thomas Off :Changed: 2006-07-20T15:36:16 :Author: Thomas Off, LumoNet oHG :Info 2: :Info 3: :Info 4: .. _LumoNet-Google-Map: LumoNet Google Map ================== Extension Key: **lumophpinclude** Copyright 2006, Thomas Off, LumoNet oHG, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.com .. _Content: Content ------- **Introduction 1** **What does it do? 1** **Screenshots 2** **Usage 4** **Requirements 4** **Installation 4** **Configuration 4** **Known Bugs 7** **ToDo 8** **Changelog 9** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Adds a map from Google Maps to your website. This extension is based on PHP GoogleMapAPI (http://www.phpinsider.com/php/code/GoogleMapAPI/) by Monte Ohrt which was adapted and partly rewritten to make it more suitable for usage in this extension (e.g. quoting of JavaScript code snippets). **Features:** - Show locations created as tt\_address items - Control the size of the map as well as other behaviour (e.g. whether map controls are shown or not) - Templatable sidebar which lists the shown locations and can show them in detail once you click on them - Templatable info box with support for links and graphics - Set center point and default zoom level for the map .. _Screenshots: Screenshots ----------- **Sample frontend view:** |img-1| **Sample info box:** |img-2| **Backend: sheet „General“** |img-3| **Backend: sheet „Data“** |img-4| **Backend: sheet „Template“** |img-5| .. _Usage: Usage ----- .. _Requirements: Requirements ^^^^^^^^^^^^ tt\_address >= 1.04 typo3 >= 4.0 .. _Installation: Installation ^^^^^^^^^^^^ Install the plugin via Extension Manager. Go to http://www.google.com/apis/maps/ and sign up for your Google Maps API key for your website. Use the Constant Editor to set the new API key. Create a new page. Add a new content element „Google map“ to this page. Adjust the settings for your map (you can just leave off this step and see the results of the default values). Look at your new page in the frontend and play around with your map. .. _Configuration: Configuration ^^^^^^^^^^^^^ You can configure the plugin either „locally“, i.e. by using configuration options in the flexform, or „globally“ by TypoScript setup. The extension adds all supported TS fields and you can browse them via TypoScript object browser from the „Web > Template“ menu item. All configuration options with description and sample data are listed in the following table: .. ### BEGIN~OF~TABLE ### .. _google-api-key: google\_api\_key """""""""""""""" .. container:: table-row Property google\_api\_key Data type string Description The Google Maps API key for your website.If you don't have one yet, sign up on http://www.google.com/apis/maps/ for one. **Example:** :: plugin.tx_lumogooglemaps_pi1.google_api_key = YOUR_API_KEY Default .. _template-file: template\_file """""""""""""" .. container:: table-row Property template\_file Data type string Description Path to a template file for map, sidebar and info window; an example can be found in the sub-directory templates of the plugin. **Example:** :: plugin.tx_lumogooglemaps_pi1.template_file = fileadmin/templates/googlemaps.html Default EXT:lumogooglemaps/templates/template\_css.html .. _default-country: default\_country """""""""""""""" .. container:: table-row Property default\_country Data type string Description The default country for geocoding (i.e. conversion of an address into longitude and latitude); valid values are country names and codes as specified in ISO 3166 (country codes); this country code is used for addresses where no country has speciied within the tt\_address item **Example:** :: plugin.tx_lumogooglemaps_pi1.default_country = Germany Default Germany .. _pid-list: pid\_list """"""""" .. container:: table-row Property pid\_list Data type string Description The page id (pid), or list of pids of the folder(s), where your tt\_address items are stored in (also known as “Starting point”). If this value is not set, and the “Starting point” field in the map content-element is also empty, the current page is used.Accepts multiple pids comma separated! **Example:** :: # clear the value plugin.tx_lumogooglemaps_pi1.pid_list > # display tt_address items located in page 582 & 584 plugin.tx_lumogooglemaps_pi1.pid_list = 582,584 Default .. _recursive: recursive """"""""" .. container:: table-row Property recursive Data type string Description If this is given, the “pid\_list” is extended by the number of recursive levels. **Example:** :: plugin.tx_lumogooglemaps_pi1.recursive = 3 Default .. _map: map """ .. container:: table-row Property map Data type map configuration array Description Configuration array for the map;see below for available options Default .. _center: center """""" .. container:: table-row Property center Data type center configuration array Description Configuration array for the map center;see below for available options Default .. _marker: marker """""" .. container:: table-row Property marker Data type marker configuration array Description Configuration array for the marker icon;see below for available options Default .. _width: width """"" .. container:: table-row Property width Data type int+ Description Width of the image to be displayed **Example:** :: plugin.tx_lumogooglemaps_pi1.map.width = 400 Default 500 .. _height: height """""" .. container:: table-row Property height Data type int+ Description Height of the image to be displayed **Example:** :: plugin.tx_lumogooglemaps_pi1.map.height = 300 Default 500 .. _type: type """" .. container:: table-row Property type Data type string Description Which type of map shall be displayed when creating the map; possible values are: 'map', satellite', 'hybrid' (self explanatory) **Example:** plugin.tx\_lumogooglemaps\_pi1.map.type **=** satellite Default hybrid .. _type-controls: type\_controls """""""""""""" .. container:: table-row Property type\_controls Data type string Description Controls the way the type controls for switching between map, satellite and hybrid mode are shown; possible values are: 'show', hide' (self explanatory) **Example:** :: plugin.tx_lumogooglemaps_pi1.map.type_controls = hide Default show .. _nav-controls: nav\_controls """"""""""""" .. container:: table-row Property nav\_controls Data type string Description Controls the way the navigation controls (zoom slider and arrow signs for moving) are displayed; possible values are: 'none', 'small', 'large' (self explanatory) **Example:** :: plugin.tx_lumogooglemaps_pi1.map.nav_controls = small Default large .. _zoom: zoom """" .. container:: table-row Property zoom Data type string Description Default zoom level of the map; valid values are in range from 1 (which is 0.75m/px) to 18 (100 km/px) and 'auto' (which zooms the map so that all markers are visible at once) **Example:** :: plugin.tx_lumogooglemaps_pi1.map.zoom = 5 Default auto .. _Settings-for-the-marker: **Settings for the marker:** """""""""""""""""""""""""""" .. container:: table-row Property **Settings for the marker:** All these settings start with „marker.“ .. _longitude: longitude """"""""" .. container:: table-row Property longitude Data type string Description Longitude of the map's center point **Example:** plugin.tx\_lumogooglemaps\_pi1.center.longitude **=** **11.200362** Default 11.200362 .. _latitude: latitude """""""" .. container:: table-row Property latitude Data type string Description Latitude of the map's center point **Example:** plugin.tx\_lumogooglemaps\_pi1.center.latitude **=** **47.676643** Default 47.676643 .. _show: show """" .. container:: table-row Property show Data type int Description When the map\*s center point will be shown; valid values are:0: only show center if no marker is set 1: always show center **Example:** :: plugin.tx_lumogooglemaps_pi1.center.show = 0 Default 0 .. _Settings-for-the-marker: **Settings for the marker:** """""""""""""""""""""""""""" .. container:: table-row Property **Settings for the marker:** All these settings start with „marker.“ .. _icon: icon """" .. container:: table-row Property icon Data type string Description Path to the marker icon image file A sample marker icon and shadow is included in the 'template' directory of the extension **Example:** plugin.tx\_lumogooglemaps\_pi1.marker.icon **=** fileadmin/images/my\_marker\_icon.gif Default EXT:lumogooglemaps/templates/marker\_icon.png .. _shadow: shadow """""" .. container:: table-row Property shadow Data type string Description Path to the marker shadow image file **Example:** plugin.tx\_lumogooglemaps\_pi1.marker.shadow **=** fileadmin/images/my\_marker\_shadow.gif Default EXT:lumogooglemaps/templates/marker\_shadow.png .. _spot: spot """" .. container:: table-row Property spot Data type point configuration array Description Configuration options for the spot coordinates, i.e. the coordinates in the marker icon image where the spot (map point) should be set; see below for available options **Example:** plugin.tx\_lumogooglemaps\_pi1.marker.spot { x =6 y =20 } Default .. _info: info """" .. container:: table-row Property info Data type point configuration array Description Configuration options for the info box coordinates, i.e. the coordinates in the marker icon image where the info box should have its origin; see below for available options **Example:** plugin.tx\_lumogooglemaps\_pi1.marker.info{ x =5 y =1 } Default .. _Settings-for-marker-points-point-configuration-array-These: **Settings for marker points (point configuration array):** These """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row Property **Settings for marker points (point configuration array):** These settings are available in „map.spot“ and „map.info“ to determine the coordinates of the map spot and the info box in the marker icon. .. _x: x " .. container:: table-row Property x Data type int+ Description x coordinate of the point in the image; calculated from the image's top left point Default .. _y: y " .. container:: table-row Property y Data type int+ Description y coordinate of the point in the image; calculated from the image's top left point Default .. ###### END~OF~TABLE ###### .. _Known-Bugs: Known Bugs ---------- Currently it is not possible to show two maps on the same page Please report any other bugs (or suggestions for improvement) to the author of the extension. .. _ToDo: ToDo ---- - Implement more options from the API class - Add field to control whether a tt\_address item should be displayed in the map - Improve documentation - Add possibility to show more than one map on the same page - Add option to output JavaScript in page header - Add possibility to choose geocoding service to use .. _Changelog: Changelog --------- 2006-07-20 - Added option to set default zoom level for maps - Added option to set center point of maps - Improved geocoding using new Google Maps service - Added TS option to set default country for geocoding - Fixed dependencies from tt\_address 2006-05-01 Initial release. |img-6| LumoNet Google Map - 10 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.jpeg .. :align: left .. :border: 1 .. :height: 339 .. :id: Grafik1 .. :name: Grafik1 .. :width: 431 .. |img-2| image:: img-2.jpeg .. :align: left .. :border: 1 .. :height: 518 .. :id: Grafik2 .. :name: Grafik2 .. :width: 431 .. |img-3| image:: img-3.jpeg .. :align: left .. :border: 0 .. :height: 201 .. :id: Grafik3 .. :name: Grafik3 .. :width: 669 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 219 .. :id: Grafik4 .. :name: Grafik4 .. :width: 669 .. |img-5| image:: img-5.jpeg .. :align: left .. :border: 0 .. :height: 310 .. :id: Grafik5 .. :name: Grafik5 .. :width: 669 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102