View source for Admin Places Geocode

{{construction
|notes=The article below describes a complete, tested mod.
This mod also has a new "beta" version:10.1.0.2 that can be downloaded here:
[[Media:admin_places_geocode_v10.1.0.2.zip|admin_places_geocode_v10.1.0.2.zip]]
<br>Here's what the new version does:

# Added filters that the user can select, to ignore some town names, based on PlaceLevels 
# DisplayModNames is now optional


I've been using the new version for a while, but
* It needs to be tested on other TNG sites, 
* I haven't completed the description below, and
* I haven't created the visualizations this article needs

In truth, I have over 40 new and updated mods in this state, and I'd appreciate whatever help that anyone can offer.
So it would be great if you could download the mod, test it, and let me know how it works for you.
And if you're up for it, screenshots from before the mod was installed and after (annotated or not) would be a great help.
Just email any updates to me. 
My email username is '''mail'', and my email domain is robinrichmond.com.

Thanks in advance.
Robin Richmond 19:01, 6 May 2017 (CDT)
}}

{{TNGmod
| mod_name        =  Admin Places Geocode
|  mod_summary     = Defines a new Placelevel for "Don't Geocode"; rounds new geocoordinates 6 decimal places; displays the Geocoding results and the kickoff form on the same web page.
| mod_validation  = 
| download_link   =  For {{Tv1010}}[[Media:admin_places_geocode_v10.1.0.1.zip|admin_places_geocode_v10.1.0.1.zip]]

| download_stats  =
| mod_author      = [[User:Robinrichm|Robin Richmond]]
| mod_url         = [http://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
| mod_contact     = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
| mod_support     = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
| mod_version     = 10.1.0.1
| min_TNG_ver     = 10.1
| max_TNG_ver     = 11.1
|   TNG_file_list   = admin_geocodeform.php, admin_geocode.php, admin_editplace.php, googlemaplib2.php, places_help.php, cust_text.php English 
| related_mods   = [[Blue Info Button]], [[Show Mod Names]], [[Admin Places List]]
| notes    =  
}}

{| style="margin-right:0.5 em;" align="right" 
| __TOC__

|}

== Purpose of the Mod ==
* Avoids situations where automatic geocoding regularly fails by adding filters that can be selected in the Admin >> Places >> Geocode kickoff form. See the visualization of the new help text (shown below) for descriptions of the filters. 
* Improves the geocoding workflow by displaying the geocoding results and the ''next'' kickoff form on the same web page. 
* Provides a way to mark Places that shouldn't be geocoded by adding a Placelevel value (-1) and labeling it as Don't Geocode".
* Eliminates extraneous detail in geocoordinates in three ways:
*# The Geocoding program rounds all new geocodes to at most six decimal places.
*# Geocodes defined through the Place Editor are rounded to at most six decimal places.
*# The Place Editor has a new "Round" button that rounds existing geocodes to six decimal places.

== Side Effects ==
In the distributed TNG code, admin_geocodeform.php displays the kickoff form, which invokes admin_geocode.php to do the geocoding.  After admin_geocode.php displays the results, it displays a link back to the kickoff form in admin_geocodeform.php. 
This mod moves the PHP code that does geocoding into admin_geocodeform.php so that the results can be displayed on the same web page as another kickoff form.  With this change, admin_geocode.php is no longer used at all.

== Mod Dependencies ==
* This mod depends on the [[Blue Info Button]] mod to define the style class that formats an information icon next to the Filters checkboxes on the kickoff form. It does not strictly require the [[Blue Info Button]] mod to be installed, but without that mod, the icon (shown in the visualizations below) would just look like a hyperlinked (i.e. underlined) lowercase i.

== Other Related Mods ==
* The [[Admin Places Search]] mod changes the Place Level column to show descriptive values ("Country", "State/Provice", etc) rather than raw numbers, and displays "Do Not Geocode" for the new value of -1 that is implemented by this mod.  But there is no dependency between the two mods.
* This mod saves data that can be used by the '''optional''' [[Show Mod Names]] utility mod, but it is ''not'' dependent on that mod.

== Compatibility with other Mods ==
This mod is compatible with [[Places Subject to Deletion]], [[Tree ID Mod]], and [[Place Name Format]], which also affect the Admin >> Places program.  Please let me know if you encounter any incompatibilities.

==Requirements==
* A working TNG installation.
* An installed current version of the [[Mod Manager]].
* You should backup files listed in the panel on the right.

==Installation==
# Remove and delete previous version of this mod.
# Backup the files updated by this mod.  They are listed in the panel at the upper right. 
# Download the .zip file, and extract its .cfg file to the mods folder.
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]].

== In the event of a problem ==
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].

== Visualization of this Mod ==
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
|-
| style="border:thin solid black;" | '''<span style="color: red">BEFORE:</span> The Admin >> Places >> Geocode Kickoff form, and the results page'''<br/>
Note that the "Reset" checkbox, which causes all "geoignore" flags in the selected tree to be reset, was introduced with TNGv11, but the mod also works for TNGv10.1, which does not have that checkbox.<br/>
[[Image:admin_places_geocode-before.png]]
|- 
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The initial kickoff form'''<br/>
[[Image:admin_places_geocode-after1.png]]
|- 
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Geocoding results, with the kickoff form on same page'''<br/>
[[Image:admin_places_geocode-after2.png]]
|}

{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
|-
| style="border:thin solid black;" | '''<span style="color: red">BEFORE:</span> The Admin >> Places Editor'''<br/>
(It may look a little odd with the map hidden)<br/>
[[Image:admin_places_geocode-before-edit.png]]
|- 
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The Admin >> Places Editor'''<br/>
[[Image:admin_places_geocode-after-edit.png]]
|}

{| border="2" cellspacing="0" cellpadding="2" class="wikitable"
|-
| '''<span style="color: red">AFTER:</span> New text in the Places help file'''<br/>
[[Image:admin_places_geocode-help.png]]
<br>This mod also adds text to the "Add New/Edit" section of the help file, but that text is not shown here.
|}

== Mod Change History ==
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
! Mod Version
! TNG Versions
! Date
! Note
|- 
| 10.1.0.1
| 10.1
| 19 Apr 2017
| New mod.
|}

== Sites using this mod ==
If you download and install this mod, please add your site to the table below.

{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
! URL
! User
! Note
! Mod-Version
! TNG-Version
! User-language
|-
| [http://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
| [[User:Robinrichm|Robin Richmond]]
| Mod developer
| v10.1.0.1
| 11.0.2
| English
|-
| [http://www.josephoranholtz.com/ Joseph Oran Holtz Genealogy Pages]
| [[User:Stores|Jim Holt]]
| Not a Public Site
| 10.1.0.1
| 11.1.0
| English
|-
|}

[[Category:Mods for TNG v10]]
[[Category:Mods for TNG v11]]
[[Category:admin_geocode.php mods]]
[[Category:admin_geocodeform.php mods]]
[[Category:admin_editplace.php mods]]
[[Category:googlemaplib2.php mods]]
[[Category:places_help.php mods]]