'''Experienced'''
5,069
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + + + − + − + Line 10:
Line 12: − + − + − + − + + + + − == Purpose of the Mod == − Tweaks the Admin >> Places >> Search form and results list as follows: Line 27:
Line 30: − # Adds an information icon next to the Search field that hyperlinks to the new text in the Places Help file. − + − + − # If the Display Mod Names mod has been installed, will display a button that can then display a list of (my) mods that affect this program. + + + + − == Parameters ==+ − # ShowPlaceLevelNumber:false - Whether to show the PlaceLevel number (0, 1, 2, etc.) in addition to the PlaceLevel description (Not Set, Address, Location, etc.) − + − + + + + − + − + − + − + + − ==Installation==+ − ===Requirements=== − − * An installed current version of the [[Mod Manager]]. − * You should backup files listed in the panel on the right. − + − # 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]]. − ===Problems?=== − # 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]. − + Line 110:
Line 109: − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + + + + + + + − + − + − + − + − + − + − + Line 170:
Line 191: − + Line 176:
Line 197: + + +
no edit summary
{{TNGmod
{{construction
|notes= This article is in transition from v3a to v4 of the Admin Places Search mod. Version 4 should be considered a Beta version. It does not change the way that Admin>>Places searches for and displays Places, but it introduces some help features and and handles the mod options differently. Revision notes for version 4 are in the [[#Revision_History|Revision History]] section of this article.}}{{TNGmod
| mod_name = Admin Places Search
| mod_name = Admin Places Search
| mod_summary = Adds search options and results details to the Admin>>Places>>Search program
| mod_summary = Adds search options and results details to the Admin>>Places>>Search program
| mod_validation =
| mod_validation =
| mod_last_update = 28 Dec 2017
| mod_last_update = 2 Oct 2019
| download_link = [[Media:admin_places_search_v11.0.0.3a.zip|11.0.0.3a]]{{Tv110}}
| download_link = [[Media:admin_places_search_v12.0.0.4b.zip|12.0.0.4b]]{{Tv120}}
| download_stats =
| download_stats =
| mod_author = [[User:Robinrichm|Robin Richmond]]
| mod_author = [[User:Robinrichm|Robin Richmond]]
| mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
| 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_support = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
| mod_version = 11.0.0.3a
| mod_version = 12.0.0.8
| min_TNG_ver = 11.0
| min_TNG_ver = 11.0
| max_TNG_ver = at least 11.1.2
| max_TNG_ver = 12.2
| TNG_file_list = admin_places.php, cust_text.php English
| TNG_file_list = admin_places.php, cust_text.php English. Installs shared files: rrinnermodmenu1.php, admin_genconfig.php, admin_updateconfig.php, rrsetup_modoptions1_include.php, img/rrmodadmin_wikilogo.png
| related_mods = [[Admin Places Geocode]]
<br>Installs shared files: rrinnermodmenu1_include.php, rrmodoptions1.php, img/rrmodadmin_wikilogo.png
| related_mods = [[Admin Places Geocode]], [[Admin Places Date]]
| notes =
| notes =
}}
}}
== Purpose of the Mod ==
Adds features to the '''Admin >> Places >> Search''' form and results list as follows:
{| style="margin-right:0.5 em;" align="right"
{| style="margin-right:0.5 em;" align="right"
| __TOC__
| __TOC__
|}
|}
# Adds 3 search options:
# Adds 3 search options:
## "Results Per Page", which overrides the system value ($maxresults)
## "Results Per Page", which overrides the system value ($maxresults)
## "Show Cemetery Links", which are displayed as an HTML entity in a new column. When the Cemetery Links column is displayed, a table footnote describes that column.
## "Show Cemetery Links", which are displayed as an HTML entity in a new column. When the Cemetery Links column is displayed, a table footnote describes that column.
# Allows the Regular Expression anchor characters ^ and $ to be placed at the beginning and/or the end of the search string. (See the visualizations for a specific example.)
# Allows the Regular Expression anchor characters ^ and $ to be placed at the beginning and/or the end of the search string. (See the visualizations for a specific example.)
# Adds a Placeholder text message in the Search field to note that the anchor characters can be used there.
# Adds a Placeholder text message in the Search field to note that the anchor characters can be used there.
# Draws a fieldset around the search form to help distinguish it from the action/pagination form.
# Draws a fieldset around the search form to help distinguish it from the action/pagination form.
# Displays the tree and searchstring parameters (if they have values) at the top of the results table.
# Displays the tree and searchstring parameters (if they have values) at the top of the results table.
# Rounds longitude and latitude values to the number of decimal digits supplied by a mod parameter (for display only)
# Rounds longitude and latitude values to the number of decimal digits supplied by a mod option defined by the optional [[Admin Places Geocode]] mod.
# In the Placelevel column, displays descriptive names such as Location, Town, and County rather. Will also display the numeric Placelevel value if directed by a mod parameter.
# In the Placelevel column, displays descriptive names such as Location and City/Town). Will also display the numeric Placelevel value if directed by a mod option.
# Omits the Tree column if a tree was selected
# Omits the Tree column if a tree was selected
# Adds text describing these changes to the Places Help file.
# Adds text describing these changes to the Places Help file.
# Adds an information icon next to the Search field that hyperlinks to new text in the Places Help file.
== Mod Options ==
All options are custom TNG settings, which are defined and edited in the form at Admin>>Setup>>General Settings, in the new subform '''Robin's Mods''', where the options for various mods are organized into '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]'''.
This mod has one option. The mod displays Place Level names (Not Set, Address, Location, City/Town, etc.) in the Place Level results column, where the native code just displays the Place Level number. The option is whether to show the Place Level number ''in addition to'' the Place Level description.
== Compatibility with other Mods ==
* In version 3 of the mod, this option is a "mod parameter", defined by the Mod Manager <code>%parameter</code> tag, and edited within the Mod Manager.
This mod is compatible with [[Admin Places Geocode]], [[Places Subject to Deletion]], and [[TreeID-One Column]], as well as with two mods, [[Google Maps - More Place Levels Mod]] and [[Google maps 15]] that add Placelevel definitions. It is '''not compatible with''' [[Tree ID Mod]], but [[TreeID-One Column]] accomplishes the same purpose as [[Tree ID Mod]]. [[TreeID-One Column]] just uses one column instead of two to display the Tree ID and Tree Name, and avoids a couple of mod conflicts.
* In version 4, this option is a custom TNG setting, defined and edited in the form at Admin>>Setup>>General Settings, in the new subform '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Robin's Mods]'''
== Compatibility ==
This mod is compatible with [[Admin Places Geocode]], [[Places Subject to Deletion]], and [[TreeID-One Column]], as well as with two mods, [[Google Maps - More Place Levels Mod]] and [[Google maps 15]] that add Placelevel definitions. It is '''not compatible with''' [[Tree ID Mod]], but '''is compatible with''' [[TreeID-One Column]], which accomplishes the same purpose as [[Tree ID Mod]]. [[TreeID-One Column]] just uses one column instead of two to display the Tree ID and Tree Name, and avoids a couple of mod conflicts.
== Related Mods ==
== Related Mods ==
* [[Admin Places Geocode]] defines the Placelevel value of -1 to mean "Do not Geocode". This mod defines the string "Do not Geocode" that is displayed when it sees a value of -1 for the Placelevel.
* '''[[Admin Places Geocode]]'''
* [[Admin Places Geocode]] also installs a system parameter that controls the number of decimal digits in Latitude and Longitude values. If that parameter is not present, then this mod rounds Latitude and Longitude to 5 decimal digits.
** Defines the Placelevel value of -1 to mean "Do not Geocode". This mod defines the string "Do not Geocode" that is displayed when it sees a value of -1 for the Placelevel.
* This mod uses the [[Field Buttons]] mod, which displays small controls next to some form fields. However, it does not require that [[Field Buttons]] be installed. If [[Field Buttons]] is not installed, then the buttons simply do not appear.
** Installs a mod option that controls the number of decimal digits in Latitude and Longitude values. If that option has been defined, then this mod rounds the Latitude and Longitude as they are read from the database, and as they are written to the database.
* This mod saves data that can be used by the '''optional''' [[Show Mod Names]] utility mod, but it is ''not'' dependent on that mod.
* '''[[Admin Places Date]]''' also affects ''Admin>>Places'', and coordinates with this mod in that when this mod adds field buttons to the form field it creates, it also adds field buttons for the "Creation Date" form field field that is added by [[Admin Places Date]] - well, ''if'' that field is present in the form when admin_places.php runs.
* This mod uses the '''[[Field Buttons]]''' mod to attach small 'field buttons' to several text fields, ''but it is not dependent on [[Field Buttons]]''. Field buttons are configurable (and generally one-character) buttons that are attached to HTML form fields, and that reduce the typing or mouse movements needed to perform several common editing tasks. This mod is not compatible with Field Buttons mod versions earlier than version 3.
* This mod saves data that can be used by the ''optional'' '''[[Show Mod Names]]''' utility mod.
* A working TNG installation.
===Procedure===
== Installation ==
== 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 ''[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}}
== Visualizations ==
== Visualizations ==
(These visualizations are from mod version 3a, but most of them also apply well to mod version 4. See update notes in the [[#Revision_History|Revision History]] section of this article.)
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
|-
|-
|}
|}
== Mod Change History ==
== Revision History ==
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
|-
! Mod Version
! Mod Version !! TNG Versions !! Date !! Note
! TNG Versions
|- style="vertical-align:top;" <!-- ############################################################## -->
! Date
| [[Media:admin_places_search_v12.0.0.4b.zip|12.0.0.4b]]
! Note
| 12.0 -12.2+
|-
| 2 Oct 2019
| 11.0.0.3a
| Changed the "Place level not set" checkbox to radio buttons for "Placelevel: yes/no/either"
*The new Inner Mod Menu now requires the shared subfolder RR-shared-innermodmenu_v12.0.0.1.
*The new Mod Settings Block in admin_genconfig.php requires the shared subfolder RR-shared_mod_settings_v12.0.0.1.
|- style="vertical-align:top;" <!-- ############################################################## -->
| [[Media:admin_places_search_v12.0.0.4.zip|12.0.0.4]] (beta)
| 12.0+
| 18Aug2019
| No significant changes to the search and display functionality.
* Visible Changes:
** An '''[https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menu]''' is now floated to the right end of the admin_places.php Inner Menu.
** The mod's parameter is now a TNG option, defined through '''Admin>>Setup>>General Settings''', in a new subform named '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]'''.
** The search form row that contains display options now starts with the label "Display Options".
** New help text that is triggered by an information icon next to the searchstring field.
* Internal Changes include:
** Improvements to the implementation of [[Field Buttons]] requires version 3 or higher of the '''[[Field Buttons]]'' mod. (Well, that is, if the optional [[Field Buttons]] mod is installed at all.)
** The implementation of the Latitude and Longitude rounding option requires version 4 of '''[[Admin Places Geocode]]]'''. (Again - if the optional [[Admin Places Geocode mod is installed at all.)
|- style="vertical-align:top;" <!-- ############################################################## -->
| [[Media:admin_places_search_v12.0.0.3a.zip|12.0.0.3a]]
| 12.0+
| 14Nov2018
| No functional changes; made compatible with TNGv12.
|- style="vertical-align:top;" <!-- ############################################################## -->
| [[Media:admin_places_search_v11.0.0.3a.zip|11.0.0.3a]]
| 11.0+
| 11.0+
| 28 Dec 2017
| 28Dec2017
| Visibly, added "field buttons". Technical changes include
| Visibly, added "field buttons". Technical changes include
* Removed the Geocode Decimal Digits mod parameter. The code now looks for the TNG system parameter $tngconfig['rrgeocodedecimals'] (installed by Admin Places Geocode)
* Removed the Geocode Decimal Digits mod parameter. The code now looks for the TNG system parameter $tngconfig['rrgeocodedecimals'] (installed by Admin Places Geocode)
* Added a "don't print on printer" class to the tab menu and innermenu, and the Action and Select columns of the results table.
* Added a "don't print on printer" class to the tab menu and innermenu, and the Action and Select columns of the results table.
* A number of the changes to HTML element attributes are now implemented through a (Document).ready function.
* A number of the changes to HTML element attributes are now implemented through a (Document).ready function.
|-
|- style="vertical-align:top;" <!-- ############################################################## -->
| 11.0.0.2a
| 11.0.0.2a
| 11.0+
| 11.0+
| 30 May 2017
| 30May2017
| Added the Insert Links function to the Place Notes so that URLs and and FindAGrave ID's are displayed as hyperlinks. First non-beta version
| Added the Insert Links function to the Place Notes so that URLs and and FindAGrave ID's are displayed as hyperlinks. First non-beta version
|-
|- style="vertical-align:top;" <!-- ############################################################## -->
| 11.0.0.2
| 11.0.0.2
| 11.0+
| 11.0+
| 26 May 2017
| 26May2017
| Now compatible with [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. Also added the two mod parameters.
| Now compatible with [[Google Maps - More Place Levels Mod]] and [[Google maps 15]]. Also added the two mod parameters.
|-
|- style="vertical-align:top;" <!-- ############################################################## -->
| 11.0.0.1
| 11.0.0.1
| 11.0+
| 11.0+
| 13 Apr 2017
| 13Apr2017
| New mod.
| New mod.
|}
|}
| [http://colegenealogy.dynu.net/ Cole / Tanner Family Tree]
| [http://colegenealogy.dynu.net/ Cole / Tanner Family Tree]
| [[User:dlcole|David Cole]]
| [[User:dlcole|David Cole]]
| Private Site
| Public/Private
| [[User:Dlcole|see here]]
| [[User:Dlcole|see here]]
| [[User:Dlcole|see here]]
| [[User:Dlcole|see here]]
|}
|}
[[Category:Mods for TNG v12]]
[[Category:Mods for TNG v11]]
[[Category:Mods for TNG v11]]
[[Category:admin_places.php mods]]
[[Category:admin_places.php mods]]
[[Category:cust_text.php English mods]]
[[Category:cust_text.php English mods]]
[[Category:admin_genconfig.php mods]]
[[Category:admin_updateconfig.php mods]]
