diff options
Diffstat (limited to 'plugins/leaflet/README.md')
| -rw-r--r-- | plugins/leaflet/README.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/plugins/leaflet/README.md b/plugins/leaflet/README.md new file mode 100644 index 0000000..7cda4f6 --- /dev/null +++ b/plugins/leaflet/README.md @@ -0,0 +1,65 @@ +ckeditor-leaflet
+================
+<strong>OVERVIEW</strong>:<br>
+This CKEditor <a href="http://ckeditor.com/addon/leaflet">Leaflet Maps</a> plugin has three workhorse files:
+<ul>
+ <li><a href="https://github.com/ranelpadon/ckeditor-leaflet/blob/master/plugin.js">Plugin Core</a>: Defines the plugin and attaches the plugin to the CKEditor toolbar.</li>
+ <li><a href="https://github.com/ranelpadon/ckeditor-leaflet/blob/master/dialogs/leaflet.js">Dialog Script</a>: Displays the map options when creating and editing existing maps.</li>
+ <li><a href="https://github.com/ranelpadon/ckeditor-leaflet/blob/master/scripts/mapParser.html">Map Renderer</a>: Parses the map options via URL and renders the map accordingly.</li>
+</ul>
+
+This plugin utilizes the following technologies/libraries: <br>
+<ul>
+ <li><a href="http://docs.ckeditor.com/#!/api/CKEDITOR.plugins.widget">CKEditor's Widget API</a></li>
+ <li><a href="https://developers.google.com/maps/documentation/javascript/places-autocomplete">Google's Places Library/Type-Ahead Search</a></li>
+ <li><a href="https://developers.google.com/maps/documentation/geocoding/">Google's Geocoding API</a></li>
+ <li><a href="http://leafletjs.com/">Leaflet JS</a></li>
+ <li><a href="https://github.com/leaflet-extras/leaflet-providers">Leaflet - Tile Providers</a></li>
+ <li><a href="https://github.com/Norkart/Leaflet-MiniMap">Leaflet - MiniMap</a></li>
+</ul>
+
+<strong>LIVE DEMO PAGE</strong>:
+<br>Demo page could be found here: http://ranelpadon.github.io/ckeditor-leaflet/index.html
+
+<strong>INSTALLATION</strong>:
+<br>Kindly refer to <a href="https://github.com/ranelpadon/ckeditor-leaflet/blob/master/Installation%20Guide.txt">Installation Guide</a>
+
+<strong>HOW TO USE</strong>:
+<br>Kindly refer to <a href="https://github.com/ranelpadon/ckeditor-leaflet/blob/master/Creating%20and%20Editing%20Leaflet%20Maps.txt">How to Create and Edit Leaflet Maps</a>
+
+<strong>ROAD MAP</strong> (Planned stuff to do):<br><ul>
+<li>Option to show the cursor's map coordinates and scale bar.</li>
+<li>Marker could be dragged and its dragged position must be saved.</li>
+<li>State of the panned map's view must be saved.</li>
+<li>Responsive behavior (for mobile pages).
+<li>Ability to add map caption/annotation
+<li>Display the map preview in the Dialog window.</li>
+<li>Handle multiple markers.</li>
+<li>Add and delete markers.</li>
+<li>Has option to add Panoromio (panoramio.com) layer.</li>
+<li>Add other tile providers.</li>
+<li>R&D other Leaflet plugins that might be useful.</li>
+</ul>
+
+<strong>LICENSE and CREDITS</strong>:<br>
+
+License: <a href="https://www.gnu.org/licenses/lgpl.html">LGPL v3</a> applies.<br>
+Copyright 2014 by Engr. Ranel O. Padon<br>
+ranel.padon@gmail.com<br>
+
+Plugin's icon is a property of <a href="http://simpleicon.com/">simpleicon</a>.
+As indicated in their website, use of their icon is allowed as long as it includes proper credit and backlink.
+
+Thanks to CKEditor, Leaflet, and other great open-source softwares and their unsung developers.<br>
+
+Special thanks also to the insights, guidance, and collaborative support of our <a href="http://travel.cnn.com">CNN Travel</a> team:<br>
+Senior Web Development Manager:<br>
+Brent A. Deverman<br>
+
+Senior Software Engineer:<br>
+Adrian Christopher B. Cruz<br>
+
+Senior QA Analyst:<br>
+Jonathan A. Jacinto<br>
+
+=======================================================
|
