Difference between revisions of "Admin Places Search"

From TNG_Wiki
Jump to: navigation, search
(Sites using this mod)
(Added new mod templates, and boilerplate how to update cust_text.php to TNGv12 specs)
Line 1: Line 1:
 +
{{RobinV12_cust_text_update}}
 
{{TNGmod
 
{{TNGmod
 
| mod_name        =  Admin Places Search
 
| mod_name        =  Admin Places Search
Line 49: Line 50:
 
* This mod saves data that can be used by the '''optional''' [[Show Mod Names]] utility mod, but it is ''not'' dependent on that mod.
 
* 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==
+
{{RobinInstallationBoilerplate}}
===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===
 
# 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].
 
 
 
 
== Visualizations ==
 
== Visualizations ==
  

Revision as of 22:59, 8 October 2018

Template:RobinV12 cust text update

Admin Places Search
Summary Adds search options and results details to the Admin>>Places>>Search program
Validation
Mod Updated 28 Dec 2017
Download link 11.0.0.3a
TNG 11.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 11.0.0.3a
Min TNG V 11.0
Max TNG V at least 11.1.2
Files modified
admin_places.php, cust_text.php English
Related Mods
Notes


Purpose of the Mod

Tweaks the Admin >> Places >> Search form and results list as follows:

  1. Adds 3 search options:
    1. "Results Per Page", which overrides the system value ($maxresults)
    2. "Show Place Notes", which are displayed in a new column.
    3. "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.
  2. 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.)
  3. Adds an information icon next to the Search field that hyperlinks to the new text in the Places Help file.
  4. Adds a Placeholder text message in the Search field to note that the anchor characters can be used there.
  5. Draws a fieldset around the search form to help distinguish it from the action/pagination form.
  6. Displays the tree and searchstring parameters (if they have values) at the top of the results table.
  7. Rounds longitude and latitude values to the number of decimal digits supplied by a mod parameter (for display only)
  8. 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.
  9. Omits the Tree column if a tree was selected
  10. 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.
  11. Adds text describing these changes to the Places Help file.

Parameters

  1. ShowPlaceLevelNumber:false - Whether to show the PlaceLevel number (0, 1, 2, etc.) in addition to the PlaceLevel description (Not Set, Address, Location, etc.)

Compatibility with other Mods

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.

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 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.
  • 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.
  • This mod saves data that can be used by the optional Show Mod Names utility mod, but it is not dependent on that mod.


[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 Pristine Admin >> Places screen, with the system variable $maxresults (Results per page) set to 30.
Note that
  • The three checkboxes immediately below the search string are implemented by the Pristine TNG code and
  • The Place Level of -1 (meaning "Don't geocode") for the Placename "(none)" is implemented by the Admin Places Geocode mod.
    Admin places search-before.png
AFTER: Search results without a search string, highlighting some of the new features

Admin places search-after1.png

  • In the Place Level column where you see the descriptive names rather than numbers, the text value "Don't Geocode" is supplied by this mod to support the internal value -1 that is implemented by the Admin Places Geocode mod,
  • This mod rounds the display of Latitude and Longitude (to the precision specified by a mod parameter), but the Admin Places Geocode mod adds features that round the stored Latitude and Longitude.
AFTER: Results for the search string "cemetery", with the "Show notes" and "Show Cemetery Links" options selected.

Admin places search-after2.png

AFTER: When the "Missing Latitude or Longitude" option is selected.

Admin places search-after3.png

AFTER: The help text added by this mod

Admin places search-help.png

AFTER: Field Buttons

Admin places search-fieldbuttons1.jpg

  • For the search string field:
    • The X button will clear the search string value.
    • The R button will restore the field to the value it had when the page was loaded.
  • For the Results per page field:
    • The R button will restore the field to the value it had when the page was loaded.
    • The D button will assign a default value to the field. In this case, the default value is the TNG system parameter "Max Search Results".
    • The A button will assign a value that means "All Items". In this case, that value is 'all'.

Field buttons are described further in the Field Button mod article. The Field Buttons mod is necessary to make the field buttons visible.

Buttons that would not change the value are shaded out, as shown below.
Admin places search8-fieldbuttons2.jpg
In this screen clip, a search has been done with no search string, and with 35 Results per page. As a result:

  • For the search string field:
    • The X button is shaded out because there is no value to clear.
    • The R button is shaded out because we just loaded the page, and the field value is still in its initial state.
  • For the Results per page field:
    • The R button is shaded out because we just loaded the page.
    • The D button is shaded out because the the field does not have the the default value (the value of the TNG system parameter "Max Search Results").
    • The A button is visible because the value is not 'all'.

Mod Change History

Mod Version TNG Versions Date Note
11.0.0.3a 11.0+ 28 Dec 2017 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)
  • 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.
11.0.0.2a 11.0+ 30 May 2017 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
11.0.0.2 11.0+ 26 May 2017 Now compatible with Google Maps - More Place Levels Mod and Google maps 15. Also added the two mod parameters.
11.0.0.1 11.0+ 13 Apr 2017 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 11.0.0.3a 11.1.1 English
Our Roy and Boucher Family Ken Roy Modified to display correct Place Level description to support Google Maps - More Place Levels Mod and Google maps 15. 11.0.0.1 11.1.1 English, French
Cole / Tanner Family Tree David Cole Public/Private see here see here English