Difference between revisions of "Admin Places Geocode"

From TNG_Wiki
Jump to navigation Jump to search
(removed download link since zip file not uploaded and fixed categories)
(44 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
{{construction
 
−
|notes=This mod is in a beta testing state. I've been using it 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. You're welcome to insert in the article, or just email them to me. My email address is in mod .cfg file.
 
−
 
−
Thanks in advance.
 
−
Robin Richmond 13:37, 24 January 2017 (CST)
 
−
}
 
−
}}
 
 
{{TNGmod
 
{{TNGmod
 
| mod_name        =  Admin Places Geocode
 
| mod_name        =  Admin Places Geocode
−
|  mod_summary    = Creates a new Placelevel of -1 for "Don't Geocode".  In the places editor & Places>>Geocode tab, watches for that new Placelevel value, and rounds all geocoordinates to 6 decimal places. Adds a Place Editor button to round existing geocoordinates. Displays Geocoding results right on the Places>>Geocode form.
+
|  mod_summary    = Creates a new Placelevel of -1 for "Don't Geocode." Establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps. Provides a filter to limit the Geocoding to selected Mediatypes and to ignore certain problematic placename components.
 
| mod_validation  =  
 
| mod_validation  =  
−
| download_link  = <!-- For {{Tv1010}}[[Media:admin_places_geocode_v10.1.0.1.zip|admin_places_geocode_v10.1.0.1.zip]] -->
+
| mod_last_update = 30 Sep 2019
−
 
+
| download_link  = [[Media:admin_places_geocode_v12.0.0.4.zip|v12.0.0.4.zip]]{{Tv120}}
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
−
| mod_url        = [http://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
+
| mod_url        = [https://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
−
| mod_contact    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
+
| mod_contact    = [https://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_support    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
−
| mod_version    = v10.1.0.1
+
| mod_version    = v12.0.0.4
−
| min_TNG_ver    = 1010
+
| min_TNG_ver    = 10.1
−
| max_TNG_ver    = 11.0.2
+
| max_TNG_ver    = 12.2
−
|  TNG_file_list  = admin_editplace.php, googlemaplib2.php, cust_text.php English  
+
|  TNG_file_list  = admin_geocodeform.php, admin_geocode.php, admin_editplace.php, googlemaplib2.php, places_help.php, cust_text.php English, admin_genconfig.php, admin_updateconfig.php
−
| related_mods  = [[Show Mod Names]]
+
<br>Installs shared files: rrinnermodmenu1_include.php, rrmodoptions1.php, img/rrmodadmin_wikilogo.png
 +
| related_mods  = [[Admin Places Search]]
 
| notes    =   
 
| notes    =   
 
}}
 
}}
−
 
+
== Purpose of the Mod ==
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 +
|}
 +
<ol><li>Creates a new Placelevel of -1 for "Don't Geocode"</li>
 +
<li>Defines a TNG system parameter that establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps,</li>
 +
<li>In the Admin>>Places>>Geocode 'batch' Geoding program:
 +
<ol type='a'>
 +
  <li>You can limit the Geocoding to selected Mediatypes,
 +
  <li>Geocoding results are displayed right on the Geocode form, and</li>
 +
  <li>New filters can ignore certain problematic placename components.</li>
 +
</ol></li>
 +
<li>In Admin>>Places>>Search Geocodes are rounded automatically for display.</li>
 +
<li>a new "Round" button that rounds existing geocodes to six decimal places.
 +
</ol>
 +
  
−
|}
+
== 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.
  
−
== Purpose of the Mod ==
+
== Compatibility ==
−
Creates a new Placelevel of -1 for "Don't Geocode".  In the places editor & Places>>Geocode tab, watches for that new Placelevel value, and rounds all geocoordinates to 6 decimal places. Adds a Place Editor button to round existing geocoordinates. Displays Geocoding results right on the Places>>Geocode form.
+
This mod is compatible with [[Places Subject to Deletion]], [[Tree ID Mod]], [[Admin Places Search]], [[TreeID-One Column]], [[Placename Format]], [[Google Maps - More Place Levels Mod]], and [[Google maps 15]], all of which also affect Admin>>Places.
  
−
== Compatibility And Dependencies ==
+
The [[Geocode Assist Mod]] v10.0.0.2 will suppress the Geocode Globe is the place level is set to -1 (Do not Geocode). 
−
This mod depends on my [[Show Mod Names]] utility mod. There are no other known mod conflicts or strict dependencies.
+
: If you import your data, this value may not be preserved across an import.  See the [[Geocode_Assist_Mod#Do_not_Geocode|Do Not Geocode]] section in the Geocode Assist Mod on how to preserve the value across an import.  
  
−
==Requirements==
+
== Related Mods ==
−
* A working TNG installation.
+
* The [[Admin Places Search]] mod changes the Place Level column to show descriptive values ("Country", "State/Province", 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.
−
* An installed current version of the [[Mod Manager]].
+
* This mod saves data that can be used by the '''optional''' [[Show Mod Names]] utility mod, but it is ''not'' dependent on that mod.
−
* You should backup files listed in the panel on the right.
 
  
−
==Installation==
+
== Installation ==
−
# Remove and delete previous version of this mod.
+
This mod uses the standard installation procedure, though it should be noted that this mod contains two mod subfolders that are shared with other mods that implement ''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]''' Admin>>Setup forms, and '''[https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner_Mod_Menus]'''. Because of the shared subfolders, as you unzip or copy the mod, you might get a warning noting that a folder already exists.  You can just ignore that warning.<br>{{RobinInstallationBoilerplate}}
−
# 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 ==
+
== Visualizations ==
−
XXXstart-of-first-tableXXX
 
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
−
! <style="text-align:left;"> | XXXPage Title or nameXXX <span style="color: red">''' BEFORE:'''</span>
+
| 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:XXXfile_name_prefix-XXX-before.png]]
+
[[Image:admin_places_geocode-before.png]]
 
|-  
 
|-  
−
! <style="text-align:left;"> | XXXPage Title or nameXXX <span style="color: red">'''AFTER:'''</span>
+
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The initial kickoff form'''<br/>
 +
[[Image:admin_places_geocode-after1.png]]
 
|-  
 
|-  
−
| XXXBrief text about the changessXXX
+
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> Geocoding results, with the kickoff form on same page'''<br/>
−
[[Image:XXXfile_name_prefixXXX-after.png]]
+
[[Image:admin_places_geocode-after2.png]]
−
<br>XXXmore-text-about-the-changes XXX
+
|}
 +
 
 +
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
−
! <style="text-align:left;"> | XXXPage Title or nameXXX <span style="color: red">''' After:'''</span> XXXsome-action-that-got-us-to-this-particular-screenshotXXX
+
| 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/>
−
| XXXBriefTextXXX
+
[[Image:admin_places_geocode-before-edit.png]]
−
[[Image:XXXfilenameXXX.png]]
+
|-  
−
<br>XXXMoreTextIfCalledForXXX
+
| style="border:thin solid black;" | '''<span style="color: red">AFTER:</span> The Admin >> Places Editor'''<br/>
 +
[[Image:admin_places_geocode-after-edit.png]]
 
|}
 
|}
−
XXXend-of-first-tableXXX
 
  
−
XXXstart-of-second-tableXXX
 
 
{| border="2" cellspacing="0" cellpadding="2" class="wikitable"
 
{| border="2" cellspacing="0" cellpadding="2" class="wikitable"
 
|-
 
|-
−
| style="vertical-align:top;" | <span style="color: red">''' BEFORE:'''</span>
+
| '''<span style="color: red">AFTER:</span> New text in the Places help file'''<br/>
−
| [[Image:XXXfile_name_prefix-XXX-before.png]]
+
[[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.
−
| style="vertical-align:top;" | <span style="color: red">'''AFTER'''</span><br/>XXXbrief noteXXX
 
−
| [[Image:XXXfile_name_prefixXXX-after.png]]
 
−
|-
 
−
| style="vertical-align:top;" |  <span style="color: red">'''AFTER'''</span><br/>XXXbrief noteXXX
 
−
| [[Image:XXXfilenameXXX.png]]
 
−
|-
 
−
! colspan="2" style="text-align:left;" | <span style="font-weight:normal"><span style="color: red">'''AFTER:'''</span> Add New form after a language folder has been selected</span>
 
−
|-
 
−
| colspan="2" | [[Image:XXXfilenameXXX.png]]
 
 
|}
 
|}
−
XXXend-of-second-tableXXX
 
−
 
  
−
== Mod Change History ==
+
== Revision History ==
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
−
|-
+
! Mod Version !! TNG Version !! Date !! Note
−
! Mod Version
+
|- style="vertical-align:top;"  <!-- ############################################################## -->
−
! TNG Versions
+
| [[Media:admin_places_geocode_v12.0.0.4.zip|12.0.0.4]]
−
! Date
+
| 12.0 - 12.2+
−
! Note
+
| 30 Sep 2019
−
|-  
+
| The Mod option at Admin>>Setup>>General Settings>Miscellaneous now use an include file that is shared with other mods.
−
| v10.1.0.1
+
|- style="vertical-align:top;"  <!-- ############################################################## -->
−
| 1010
+
| [[Media:admin_places_geocode_v12.0.0.3a.zip|12.0.0.3a]]
−
| 1/24/2017
+
| 12.0+
 +
| 14Nov2018
 +
| Small improvements: Better error checking; deals with trailing spaces, displays the placename before trying to geocode it so that the log will more clearly show where the process crashed.
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| [[Media:admin_places_geocode_v12.0.0.3.zip|12.0.0.3]]
 +
| 12.0+
 +
| 4May2018
 +
| No functional changes; made compatible with TNGv12.
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| [[Media:admin_places_geocode_v12.0.0.3.zip|12.0.0.3]]
 +
| 12.0+
 +
| 4May2018
 +
| No functional changes; made compatible with TNGv12.
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| [[Media:admin_places_geocode_v10.1.0.3.zip|10.1.0.3]]
 +
| 10.1
 +
| 10Nov2017
 +
| Defines a TNG system parameter that establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps. Provides new filters can ignore certain problematic placename components.
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| 10.1.0.1
 +
| 10.1
 +
| 19Apr2017
 
| New mod.
 
| New mod.
 
|}
 
|}
Line 128: Line 134:
 
| [[User:Robinrichm|Robin Richmond]]
 
| [[User:Robinrichm|Robin Richmond]]
 
| Mod developer
 
| Mod developer
−
| v10.1.0.1
+
| v12.0.0.3
−
| 11.0.2
+
| 12.0
 +
| English
 +
|-
 +
| [http://www.josephoranholtz.com/ Joseph Oran Holtz Genealogy Pages]
 +
| [[User:Stores|Jim Holt]]
 +
| Not a Public Site
 +
| 10.1.0.3
 +
| 11.1.2
 +
| English
 +
|-
 +
| [https://www.royandboucher.com/ Our Roy and Boucher Family]
 +
| [[User:KenRoy|Ken Roy]]
 +
|
 +
| 10.1.0.2 beta
 +
| 11.1.1
 +
| English
 +
|-
 +
| [http://colegenealogy.dynu.net/ Cole / Tanner Family Tree]
 +
| [[User:dlcole|David Cole]]
 +
| Public/Private
 +
| [[User:Dlcole|see here]]
 +
| [[User:Dlcole|see here]]
 
| English
 
| English
 +
|-
 +
| [https://finnholbek.dk/index.php/ Skeel, Schaffalitzky. Find navne i Danmarks Adels Aarbog]
 +
| [[User:Fholbek|Finn Holbek]]
 +
| public & private
 +
| 12.1
 +
| DA,EN,DE,CS,ES - etc.
 +
| Danish
 +
|-
 +
| [https://www.ourfamilyhistories.org Our Family Histories]
 +
| [[User:Bsl20b50|Bryan S. Larson]]
 +
| Public - T8 customized
 +
| [[User:Bsl20b50|see here]]
 +
| [[User:Bsl20b50|see here]]
 +
| EN
 
|}
 
|}
−
 
 
[[Category:Mods for TNG v10]]
 
[[Category:Mods for TNG v10]]
 
[[Category:Mods for TNG v11]]
 
[[Category:Mods for TNG v11]]
 +
[[Category:Mods for TNG v12]]
 +
[[Category:admin_geocode.php mods]]
 +
[[Category:admin_geocodeform.php mods]]
 
[[Category:admin_editplace.php mods]]
 
[[Category:admin_editplace.php mods]]
 
[[Category:googlemaplib2.php mods]]
 
[[Category:googlemaplib2.php mods]]
 +
[[Category:places_help.php mods]]
 +
[[Category:admin_genconfig.php mods]]
 +
[[Category:admin_updateconfig.php mods]]

Revision as of 12:53, 5 February 2020

Admin Places Geocode
Summary Creates a new Placelevel of -1 for "Don't Geocode." Establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps. Provides a filter to limit the Geocoding to selected Mediatypes and to ignore certain problematic placename components.
Validation
Mod Updated 30 Sep 2019
Download link v12.0.0.4.zip
TNG 12.0
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod v12.0.0.4
Min TNG V 10.1
Max TNG V 12.2
Files modified
admin_geocodeform.php, admin_geocode.php, admin_editplace.php, googlemaplib2.php, places_help.php, cust_text.php English, admin_genconfig.php, admin_updateconfig.php
Installs shared files: rrinnermodmenu1_include.php, rrmodoptions1.php, img/rrmodadmin_wikilogo.png
Related Mods
Admin Places Search
Notes


Purpose of the Mod

  1. Creates a new Placelevel of -1 for "Don't Geocode"
  2. Defines a TNG system parameter that establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps,
  3. In the Admin>>Places>>Geocode 'batch' Geoding program:
    1. You can limit the Geocoding to selected Mediatypes,
    2. Geocoding results are displayed right on the Geocode form, and
    3. New filters can ignore certain problematic placename components.
  4. In Admin>>Places>>Search Geocodes are rounded automatically for display.
  5. 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.

Compatibility

This mod is compatible with Places Subject to Deletion, Tree ID Mod, Admin Places Search, TreeID-One Column, Placename Format, Google Maps - More Place Levels Mod, and Google maps 15, all of which also affect Admin>>Places.

The Geocode Assist Mod v10.0.0.2 will suppress the Geocode Globe is the place level is set to -1 (Do not Geocode).

If you import your data, this value may not be preserved across an import. See the Do Not Geocode section in the Geocode Assist Mod on how to preserve the value across an import.

Related Mods

  • The Admin Places Search mod changes the Place Level column to show descriptive values ("Country", "State/Province", 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.

Installation

This mod uses the standard installation procedure, though it should be noted that this mod contains two mod subfolders that are shared with other mods that implement Mod Settings Blocks' Admin>>Setup forms, and Inner_Mod_Menus. Because of the shared subfolders, as you unzip or copy the mod, you might get a warning noting that a folder already exists. You can just ignore that warning.
[Show Installation Details]

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Procedure

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

Problems?

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.
[Hide Details]


Visualizations

BEFORE: The Admin >> Places >> Geocode Kickoff form, and the results page

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.
Admin places geocode-before.png

AFTER: The initial kickoff form

Admin places geocode-after1.png

AFTER: Geocoding results, with the kickoff form on same page

Admin places geocode-after2.png

BEFORE: The Admin >> Places Editor

(It may look a little odd with the map hidden)
Admin places geocode-before-edit.png

AFTER: The Admin >> Places Editor

Admin places geocode-after-edit.png

AFTER: New text in the Places help file

Admin places geocode-help.png
This mod also adds text to the "Add New/Edit" section of the help file, but that text is not shown here.

Revision History

Mod Version TNG Version Date Note
12.0.0.4 12.0 - 12.2+ 30 Sep 2019 The Mod option at Admin>>Setup>>General Settings>Miscellaneous now use an include file that is shared with other mods.
12.0.0.3a 12.0+ 14Nov2018 Small improvements: Better error checking; deals with trailing spaces, displays the placename before trying to geocode it so that the log will more clearly show where the process crashed.
12.0.0.3 12.0+ 4May2018 No functional changes; made compatible with TNGv12.
12.0.0.3 12.0+ 4May2018 No functional changes; made compatible with TNGv12.
10.1.0.3 10.1 10Nov2017 Defines a TNG system parameter that establishes the number of desired decimal digits in Geocodes and rounds all Geocodes calculated from maps. Provides new filters can ignore certain problematic placename components.
10.1.0.1 10.1 19Apr2017 New mod.

Sites using this mod

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

URL User Note Mod-Version TNG-Version User-language
Robin Richmond's Genealogy Database Robin Richmond Mod developer v12.0.0.3 12.0 English
Joseph Oran Holtz Genealogy Pages Jim Holt Not a Public Site 10.1.0.3 11.1.2 English
Our Roy and Boucher Family Ken Roy 10.1.0.2 beta 11.1.1 English
Cole / Tanner Family Tree David Cole Public/Private see here see here English
Skeel, Schaffalitzky. Find navne i Danmarks Adels Aarbog Finn Holbek public & private 12.1 DA,EN,DE,CS,ES - etc. Danish
Our Family Histories Bryan S. Larson Public - T8 customized see here see here EN
Retrieved from "https://tng.lythgoes.net/wiki/index.php?title=Admin_Places_Geocode&oldid=58335"