scripts/fckeditor2.6.6/editor/plugins/googlemaps/docs/install.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>GoogleMaps plugin</title>
   7 <link href="styles.css" rel="stylesheet" type="text/css">
   8 </head>
   9
  10 <body>
  11 <h1>Google Maps Plugin for FCKeditor</h1>
  12 <div id="languages"> Change your language
  13   <ul>
  14     <li><a href="install_es.html" lang="es"><img src="es.png" alt="Español" width="23" height="15" border="0"></a></li>
  15   </ul>
  16 </div>
  17 <h2>Introduction</h2>
  18 <p>This is a dialog-based plugin to handle insertion and modification of <a href="http://maps.google.com">Google
  19   Maps</a> in <a href="http://www.fckeditor.net">FCKeditor</a></p>
  20 <h3 id="contact">Author:</h3>
  21 <p><a href="mailto:amla70@gmail.com">Alfonso Mart&iacute;nez de Lizarrondo</a></p>
  22 <h3>Sponsored by:</h3>
  23 <p><a href="http://dynamical.biz">Dynamical.biz</a></p>
  24 <p><a href="http://www.uritec.net">Uritec</a></p>
  25 <p><a href="http://www.incontrolsolutions.com">InControl Solutions</a></p>
  26 <h3>Version history: </h3>
  27 <ol>
  28   <li>1.0: 25/08/2007. First version.</li>
  29   <li>1.1: 28/08/2007. Ups, didn't test 2.4.3</li>
  30   <li>1.2: 31/08/2007. New icon by Dynamical.biz. Use IMG instead of DIV as placeholder
  31     for the moment.</li>
  32   <li>1.3: 02/09/2007. Complete documentation in HTML for installation and users. </li>
  33   <li>1.4: 21/09/2007. Use the onload event to generate the maps (to avoid IE issues), and include the call to GUnload call. Automatically remove the toolbar icon if there is no proper Google Key </li>
  34   <li>1.5: 30/09/2007. Support for drawing polylines in the map.</li>
  35   <li>1.6: 24/10/2007. Support for multiple markers.</li>
  36   <li>1.7: 03/02/2008. Support for the new dialogs in FCKeditor 2.6.</li>
  37   <li>1.8: 02/05/2008. Support for Terrain view and remembering the selected map type. The preview in the editor now uses the static maps.</li>
  38   <li>1.9: 19/05/2008. It respects the values set for width and height (only assumes that they are pixel if they are numbers without any modifier)<br>
  39                                                                                         Optional configuration parameters: <a href="#WrapperClass">GoogleMaps_WrapperClass</a> and <a href="#PublicKey">GoogleMaps_PublicKey</a> (this code proposed by <a href="http://www.makerweb.it" target="_blank">Makerweb.it</a>) .</li>
  40   <li>1.95: 12/09/2008. The preview reflects the real type of the map. It shows also the markers.<br>
  41                                                                                                 Dutch translation added</li>
  42   <li>1.96: 14/09/2008. Preserve any previous onload handler.<br>
  43                                                                                                 French translation added</li>
  44   <li>1.97: 20/09/2008. Simplified the onload handler according to the advice by Hector Virgen. </li>
  45   <li>1.98:     15/02/2009.     Fixed some issues with the GoogleMaps_PublicKey setting<br>
  46                                                                                                 Chinese translation added<br>
  47                                                                                                 Norwegian translatioin added
  48         </li>
  49 </ol>
  50 <p><a href="http://martinezdelizarrondo.com/googlemaps/">Get the latest version and/or updated info</a> </p>
  51 <h3>Known bugs:</h3>
  52 <p>The 'Preview' command in FCKeditor won't work properly if there's a GoogleMap
  53   in the content. This seems related to the way the Google Maps API script loads
  54  and inserts its content. </p>
  55 <p>These threads in the API group point to the same problem:<br>
  56   <a href="http://groups.google.com/group/Google-Maps-API/browse_thread/thread/7849dfd612181b6c/1c3e5f7fb5fa3301">http://groups.google.com/group/Google-Maps-API/browse_thread/thread/7849dfd612181b6c/1c3e5f7fb5fa3301</a>  <br>
  57 <a href="http://groups.google.com/group/Google-Maps-API/browse_thread/thread/89ea5fa4e0a0ccb9/05c364940447891d">http://groups.google.com/group/Google-Maps-API/browse_thread/thread/89ea5fa4e0a0ccb9/05c364940447891d</a> </p>
  58 <p>A workaround for the problem could be to use the <a href="http://sourceforge.net/tracker/index.php?func=detail&amp;aid=1496110&amp;group_id=75348&amp;atid=737639">Server
  59 preview plugin</a> </p>
  60 <h2>Installation</h2>
  61 <h3>1. Copying the files</h3>
  62 <p>Extract the contents of the zip in you plugins directory, so it ends up like
  63     this<br>
  64     <img src="installation.png" alt="Screenshot of installation" width="311" height="346" longdesc="#install"></p>
  65 <pre id="install">
  66 editor\
  67         ...
  68         js\
  69         lang\
  70         plugins\
  71                 ...
  72                 googlemaps\
  73                         fckplugin.js
  74                         readme.html
  75                         dialog\
  76                         docs\
  77                         images\
  78                         lang\
  79                 ...
  80         skins\
  81 </pre>
  82 <h3>2. Adding it to FCKeditor</h3>
  83 <p>Now add in your <em>fckconfig.js</em> or custom js configuration
  84 file the following line:
  85 <code>FCKConfig.Plugins.Add( 'googlemaps', 'de,en,es,fr,it,nl,no,zh') ;</code>
  86 </p>
  87 <h3>3. Adding it to the toolbarset</h3>
  88 <p>Add the button <strong>'googlemaps'</strong> (lowercase) to your toolbarset:
  89 <code>FCKConfig.ToolbarSets[&quot;Basic&quot;] = [<br>
  90   ['Bold','Italic','-','OrderedList','UnorderedList','-','Link','Unlink',
  91   '-'<strong>,'googlemaps'</strong>,'-','About']<br>
  92 ] ;</code>
  93 </p>
  94 <h3 id="configure">4. Configure the plugin</h3>
  95 <p>The most important part is your GoogleMaps key. It must be set properly for
  96   the
  97   plugin to work, or Google will refuse to serve the maps data. <br>
  98   You must get one for each server where you want to use the plugin, just get
  99   the key for free here after agreeing to the Terms of Use of the GoogleMaps
 100   API: <a href="http://www.google.com/apis/maps/signup.html">http://www.google.com/apis/maps/signup.html</a><br>
 101   (Please don't ask questions about where you can use GoogleMaps or how to get
 102   key,
 103   those items aren't related to this plugin.)<br>
 104   For example the key for &quot;localhost&quot; is<br>
 105   <span class="key">ABQIAAAAlXu5Pw6DFAUgqM2wQn01gxT2yXp_ZAY8_ufC3CFXhHIE1NvwkxSy5hTGQdsosYD3dz6faZHVrO-02A</span></p>
 106 <p>Once you get the key, you must set it in the configuration file:
 107 <code>FCKConfig.GoogleMaps_Key = '<span class="key">ABQIAAAAlXu5Pw6DFAUgqM2wQn01gxT2yXp_ZAY8_ufC3CFXhHIE1NvwkxSy5hTGQdsosYD3dz6faZHVrO-02A</span>'
 108   ;</code>
 109 </p>
 110 <p>(remember to replace the key in green with your own one) </p>
 111 <p>Note: if you leave an empty string then the toolbar icon won't be shown (so you can easily use the same toolbar configuration as the current
 112 setup in FCKeditor doesn't allow to add/remove plugins/ToolbarIcons in a really easy way)</p>
 113 <p>There are several options that you can set to change the default values for
 114   a new map:</p>
 115 <ul>
 116   <li>FCKConfig.<strong>GoogleMaps_Width</strong> : The width of the map area</li>
 117   <li>FCKConfig.<strong>GoogleMaps_Height</strong> : The height of the map area</li>
 118   <li>FCKConfig.<strong>GoogleMaps_CenterLat</strong> : The latitude of the center</li>
 119   <li>FCKConfig.<strong>GoogleMaps_CenterLon</strong> :The longitude of the center</li>
 120   <li>FCKConfig.<strong>GoogleMaps_Zoom</strong> : The zoom level</li>
 121   <li>FCKConfig.<strong>GoogleMaps_MarkerText</strong> : The text for the marker</li>
 122         <li id="WrapperClass">FCKConfig.<strong>GoogleMaps_WrapperClass</strong> : The Google Maps automatically fills the width and height of the generated div,
 123         so if you want to add a little spacing and a border, you need to use a div around it. If this entry contains a non-empty value then such a div
 124         will be generated with this class.<br>
 125         Important: in the preview inside the editor, the class will be applied to an image, not a div!</li>
 126         <li id="PublicKey">FCKConfig.<strong>GoogleMaps_PublicKey</strong> : If you are using the editor in a different domain than the final
 127         location of the web, the maps won't work correctly by default. In this situation you must use this setting. First, set the GoogleMaps_Key
 128         to the key of the domain where FCKeditor will be run, and then you have two options:
 129         <ul>
 130                 <li>Set an emtpy value for GoogleMaps_PublicKey (FCKConfig.GoogleMaps_PublicKey = '';) this means that when the user wants to
 131                 create a map he must supply the key for the final domain. This is useful if you don't know beforehand all the domains where that
 132                 installation will be used. Of course, you must explain to your users how to get an API Key</li>
 133                 <li>Set the value of the final domain in GoogleMaps_PublicKey. For the user this means no troubles at all, everything works automatically.</li>
 134         </ul>
 135 </ul>
 136
 137 <p>All these values can be set in the <em>fckconfig.js</em> file, a custom js configuration
 138   file, or at the moment of the <a href="http://alfonsoml.blogspot.com/2008/02/adding-configuration-entries-when.html">creation of the FCKeditor instance using any
 139   language</a>.</p>
 140 <h3>5. Use it</h3>
 141 <p align="right">Now empty the cache of your browser and reload the editor, the new button
 142   <img src="../images/mapIcon.gif" alt="Insert GoogleMap" width="16" height="16"> should
 143   be <a href="users.html">ready to use</a>.</p>
 144 <h2>Final notes</h2>
 145 <p>If you find this plugin useful, consider making a donation so it can be further
 146 improved, any amount can help to keep the development running.</p>
 147 <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
 148 <input type="hidden" name="cmd" value="_s-xclick">
 149 <input type="image" src="https://www.paypal.com/en_US/i/btn/x-click-but04.gif" name="submit" alt="Make payments with PayPal - it's fast, free and secure!">
 150 <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1">
 151 <input type="hidden" name="encrypted" value="-----BEGIN PKCS7-----MIIH2QYJKoZIhvcNAQcEoIIHyjCCB8YCAQExggEwMIIBLAIBADCBlDCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20CAQAwDQYJKoZIhvcNAQEBBQAEgYAbYIYvNE50oNSFj8nHIeZ0/T5OzQfY8n+5fliwYQtSYuvHnix6+DAVVKVuRmpV4EnbzXNssyi+sdCZb+Sn7nBH7+KWP5+4L4NMIcA7OkXsoPz6qV/nBwUBnovch1hU7sqREOZJAUc42/SzvEQ5Hn+aMuGUVeLlp8BLlif2wmPkhDELMAkGBSsOAwIaBQAwggFVBgkqhkiG9w0BBwEwFAYIKoZIhvcNAwcECI9Erh51StqNgIIBMBptZf5Yd10wgcMUGRODhBxYbwKlGL8FUm5S+AftDhUnXUK6IzYorscKgaxI0ks1k+KnIO9QH7L9WwlQjSiDWXtcMjEkY7qMc99MpForo2gobt7U3OK3u00vNUm9krXwLN7S56hpvn9iyXuMi5V+4FbYe8pjn1OA/+tA7wOTgyGDhthQbLiQRQq9zWXiclYUjuhdMdeNfDHbpjeCiIoWb8AasDokSjgM8Xl0ls3nPEH4haiVTJ+uo2D28GfbDnjohaUq1A/ykweP3cBRMqYuXe6aqbciDA6NqRzrHQ7IjaXAMnLaGkV+1PjNWJi/TEAWeHD3p/JP1lAOX3vXW0tDQc0ylcJuy4khtoLjxg9/ZHFzSPfTh0ajUL1IzDremTfetBUelmiVsgZvycuWpIyUzLGgggOHMIIDgzCCAuygAwIBAgIBADANBgkqhkiG9w0BAQUFADCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20wHhcNMDQwMjEzMTAxMzE1WhcNMzUwMjEzMTAxMzE1WjCBjjELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQKEwtQYXlQYWwgSW5jLjETMBEGA1UECxQKbGl2ZV9jZXJ0czERMA8GA1UEAxQIbGl2ZV9hcGkxHDAaBgkqhkiG9w0BCQEWDXJlQHBheXBhbC5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMFHTt38RMxLXJyO2SmS+Ndl72T7oKJ4u4uw+6awntALWh03PewmIJuzbALScsTS4sZoS1fKciBGoh11gIfHzylvkdNe/hJl66/RGqrj5rFb08sAABNTzDTiqqNpJeBsYs/c2aiGozptX2RlnBktH+SUNpAajW724Nv2Wvhif6sFAgMBAAGjge4wgeswHQYDVR0OBBYEFJaffLvGbxe9WT9S1wob7BDWZJRrMIG7BgNVHSMEgbMwgbCAFJaffLvGbxe9WT9S1wob7BDWZJRroYGUpIGRMIGOMQswCQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExFjAUBgNVBAcTDU1vdW50YWluIFZpZXcxFDASBgNVBAoTC1BheVBhbCBJbmMuMRMwEQYDVQQLFApsaXZlX2NlcnRzMREwDwYDVQQDFAhsaXZlX2FwaTEcMBoGCSqGSIb3DQEJARYNcmVAcGF5cGFsLmNvbYIBADAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4GBAIFfOlaagFrl71+jq6OKidbWFSE+Q4FqROvdgIONth+8kSK//Y/4ihuE4Ymvzn5ceE3S/iBSQQMjyvb+s2TWbQYDwcp129OPIbD9epdr4tJOUNiSojw7BHwYRiPh58S1xGlFgHFXwrEBb3dgNbMUa+u4qectsMAXpVHnD9wIyfmHMYIBmjCCAZYCAQEwgZQwgY4xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzEUMBIGA1UEChMLUGF5UGFsIEluYy4xEzARBgNVBAsUCmxpdmVfY2VydHMxETAPBgNVBAMUCGxpdmVfYXBpMRwwGgYJKoZIhvcNAQkBFg1yZUBwYXlwYWwuY29tAgEAMAkGBSsOAwIaBQCgXTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0wNzA4MzEyMDU2NDhaMCMGCSqGSIb3DQEJBDEWBBQjaqRi8z31g3jdLrk+d0klj24zkjANBgkqhkiG9w0BAQEFAASBgFDK8nFr91urBOkipQBqjhhXY/tTNSVhFV0GsJSMQ3zdsgyMcZP5b4WohD5NLoPCibKL7nihgPd9AFCVyw6fLOg82F1MojGS2Gu6c6bGD2L827VCyg1WRm14svHTEwSnprvxBEbi91cBrQcNP5MZFDOuoucZg9uPGr/S8xzp0+Af-----END PKCS7-----
 152 ">
 153 </form>
 154 <p>If you need some special feature for this plugin, or if you need any other kind of plugin
 155 for FCKeditor then <a href="#contact">contact me</a> and we can discuss it</p>
 156 <h2>Disclaimers</h2>
 157 <p>FCKeditor is  &copy; FredCK.com</p>
 158 <p>Google, Google Maps and the Google Maps API are all properties of Google.</p>
 159 </body>
 160 </html>