====== geonav Plugin ======

---- plugin ----
description: Geographic wiki page navigation
author     : tom_c 
email      : tcafferty@glocalfocal.com 
type       : syntax,action
lastupdate : 2013-11-24
compatible : Binky
depends    : 
conflicts  : 
similar    : 
tags       : geo, maps, navigation, experimental

downloadurl: https://github.com/TomCafferty/plugin-geonav/zipball/master
bugtracker : https://github.com/TomCafferty/plugin-geonav/issues
sourcerepo : https://github.com/TomCafferty/plugin-geonav
donationurl:
---- 

===== Description =====

This plugin provides a way to navigate a section of your wiki based on geography. The designated pages would use a sidebar Google Earth map to drill down to a geographic area. Users can create or edit pages along the way. I see it as being used to document topics at various geographic levels.   

===== Installation =====

:!: **External requirements:** This plugin uses
  * Google Earth Plugin - this needs to be installed on the user's computer. Accessing the wiki page that uses it should ask the user to install it if it is not already installed. Google Earth can be found at [[http://www.google.com/earth/|Google Earth]] 
  * A supplied SQLite database in the /db folder
:!:  * A modified version of the [[template:starter:|template:starter:]] also included. If you are using a template called starter then either manually install geonav or backup your starter template.

  - Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  - Copy the supplied ''startermap'' template to your templates folder.
  - Create a sidebar page containing ''<geonav></geonav>''
  - In the Admin Configuration page set
     * template -> startermap
     * sidebar page name -> sidebar

===== Examples/Usage =====

To use the plugin create any page on any topic followed by :earth such as //topic//:earth. Go to that a page and use the map to focus down to lower geographic regions. 

:!: The page actually remains at the top level page. So selecting the //Edit this page// button goes to the top level page.  A //Go to Edit// button is provided to go to and either create or edit the page you are viewing.

See the plugin in action [[http://clean.glocalfocal.com|Clean.GlocalFocal.com]] FIXME. From the sitemap select Hunger:earth.

===== Syntax =====

The following syntax is placed in the sidebar page for the map.
<code>
~~NOCACHE~~
<geonav></geonav>
</code> 

===== Configuration and Settings =====

The plugin comes with a modified starter template. If you diff the two templates you can see the minor changes that were made to work better with this plugin. Then you should be able to make similar changes to your desired template. The changes were:
  - Key off the :earth in the page name to not use the sidebar if not present. This is the major change.
  - Widen the sidebar to enlarge the map.
  - Lessen the content width to compensate the wider sidebar

:!: The plugin displays the viewed page content within the <code>dokuwiki__content</code> div in main.php of the template. If you use a different <div id=...> for your content you need to modify the code in /js/getLocations.js to replace all occurrences of it with your content div id name.

===== Development =====

:!: The code uses Http GET requests to communicate between the client and the server when drilling down to exchange the location level and the associated page content.

=== Change Log ===

{{rss>https://github.com/TomCafferty/plugin-geonav/commits/master.atom date}}

=== Known Bugs and Issues ===

  - Some issues with plugins working on sub-pages.
  - Sometimes the Google Earth is slow to load.

=== ToDo/Wish List ===

I have nothing planed at this time. 

===== FAQ =====

None

===== Discussion =====