Smartstaff, administrator
4,478
edits
Changes
KML
,no edit summary
__NOTOC__
''KML'' stands for ''Keyhole Markup Language'' and is a file format used to display geographic data in Earth browsers such as Google Earth, Google Maps and Google Maps for Mobile. KML was developed for use with Google Earth, which was originally named Keyhole Earth Viewer. KML uses a tag-based structure with nested elements and attributes and is based on the [[XML]] standard. It contains boundary coordinates and placemark information for multiple zones.
There are three ways KML features can be used with SmartSimple.
# [[KML#Uploading_a_KML_File_to_an_XML_Field|Upload a KML file to an [[Custom Field Type: Special - XML Data|XML field]]# [[KML#Enabling KML on Custom Fields|Enable KML on a custom field]]# [[KML#Storing Public KML Files to System Variables|Use a [[System Variable]] to store a link to a public KML file]]
==Uploading a KML File to an XML Field==
* Create a [[Custom Field Type: Special - XML Data|Special - XML Data]] custom field.
* Set the ''Enable KML'' and ''Show Upload Button'' settings.
[[Image:ExampleUploadKMLFile.png|link=|500px]]
The field on a {{UTA}} record will display an Upload button, from which you can select a downloaded file in *.kml format.
[[Image:AttachKMLFile.png|link=|250px]]
Once the *.kml file is opened, the field's ''Open'' button will open a Google Map window with the KML overlay you have uploaded.
[[Image:KMLBikeShelterExampleSmall.png|link=|300px]]
==Enabling KML on Custom Fields==
* [[Custom Field Type: Lookup - ICD Code|Lookup - ICD Code]]
* [[Custom Field Type: Special - XML Data|Special - XML Data]]
To do so, edit the custom field and, under General Options, select the "Enable KML" option:<br />
[[Image:EnableKML.png|link=|120px]]
Fields that contain ''SmartSimple KML Variables'' will display as a "View Map" button in [[view mode]]:
{|
! align="center"|[[Image:KMLFieldEditMode.png|link=|300px]]
! [[Image:KMLFieldViewMode.png|link=|300px]]
|-
!Field in Edit Mode
!Field in View Mode
|-
|}
In this case, California will be highlighted on the Google Map, and census information will be available.
[[Image:CaliforniaMap.png|link=|700px]]
''SmartSimple KML Variables'' currently supported are:
* @geo.us.states, for U.S. States
* @geo.us.counties, for U.S. counties and
* @geo.ca.provinces, for Canadian provinces.
===SmartSimple KML Variable Syntax===
{|border="1"
|To highlight only two U.S. counties
|@geo.us.counties.Washington-Ferry@,@geo.us.counties.North Dakota-Renville@<br />or<br />@geo.us.counties.Washington-Ferry,North Dakota-Renville@<br />(both return the same map overlays)
|-
|To only show Washington State
|@geo.us.states.washington@
|-
|To show all U.S. counties
|@geo.us.counties.*@
|-
|To show all Canadian provinces
|@geo.ca.provinces.*@
|}
==Storing Public KML Files to System Variables==
You can add public *.kml and *.kmz files as "System Map Overlays" to every map generated by a KML-enabled field:
*Create a [[System Variable]] whose ''Name'' begins with the characters "KML-"
*The System Variable ''Value'' will be the URL leading to the KML file on the Internet.
[[Image:ExamplePublicKML.png|link=|500px]]<br />
*All such System Variables will be displayed as selectable overlays on the left-hand side of Google Maps opened with KML-enabled custom fields.
*The label of the selectable overlay will the characters in the System Variable ''Name'' to the right of the "KML-" characters. So a System Variable named "KML-Bicycle Shelters" will be labeled "Bicycle Shelters" on the Google Map.
[[Image:KMLBikeShelterExample.png|link=|500px]]<br />
See [[System Variables]] page for additional information.
[[Category:Glossary]][[Category:Geocoding]][[Category:XML]]