Admin Places Search

From TNG_Wiki
Jump to: navigation, search
Construction 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. The text of this article describes version 3a. Revision notes for version 4, along with Beta test considerations, are in the Revision History section of this article. Construction


In TNGv12 and beyond, this mod uses the new guidelines for TNG v12+ cust_text.php files
If you are using TNGv12+, and any cust_text.php file in this mod is marked with a Bad Target error, you need to update your cust_text.php files before you can install this mod. [Show instructions]

If you upgraded to TNGv12+, and did not update your cust_text.php files as instructed in the upgrade readme script, then you must use the TNG Mod Manager to update them. To do so:

  1. Go to Mod Manager, and select its "Recommended Updates" tab.
    (If the "Recommended Updates" tab is not visible, then go to the Mod Manager Options tab, select "Display Settings", and turn on the "Recommended Updates" tab.)
  2. Click the "Update" button in the "Recommended Updates" tab.
    Installed mods do not interfere with the update, and if you already have (or think you may have) run this update, it will not hurt for you to run it again.

[See details in the TNGv12 Change Impacts Article][Hide the instructions]


Admin Places Search
Summary Adds search options and results details to the Admin>>Places>>Search program
Validation
Mod Updated 19 Aug 2019
Download link 12.0.0.4(beta)
TNG 12.0
12.0.0.3a
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 12.0.0.3a
Min TNG V 12.0
Max TNG V at least 12.0.2
Files modified
admin_places.php, cust_text.php English. Installs shared files: rrinnermodmenu1_php.php, rrinnermodmenu1_cssjs.php, rrsetup_modoptions1_cssjs.php, img/rrmodadmin_wikilogo.png
Related Mods
Notes
Because this mod shares a mods subfolder with other mods, when you unzip the mod's zip file or move the files to the mods folder, you may get a "Folder already exists" warning, which you should ignore. (See notes on How These New Features are Implemented.)


Purpose of the Mod

Adds features to 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 a Placeholder text message in the Search field to note that the anchor characters can be used there.
  4. Draws a fieldset around the search form to help distinguish it from the action/pagination form.
  5. Displays the tree and searchstring parameters (if they have values) at the top of the results table.
  6. Rounds longitude and latitude values to the number of decimal digits supplied by a mod option defined by the optional Admin Places Geocode mod.
  7. 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.
  8. Omits the Tree column if a tree was selected
  9. Adds text describing these changes to the Places Help file.
  10. Adds an information icon next to the Search field that hyperlinks to new text in the Places Help file.

Mod Options

  1. Whether to show the PlaceLevel number (0, 1, 2, etc.) in addition to the PlaceLevel description (Not Set, Address, Location, City/Town, etc.)

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

  • 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.
    • 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.
  • Admin Places Date also affects Admin>>Places, but does not specifically interact with Admin Places Search.
  • The Field Buttons mod must be installed for the "Field Buttons" (small editing-shortcut controls next to some form fields) defined by this mod to be visible. The Field Buttons mod is not required, however. But, if it is installed, this mod requires [[Field Buttons] version 3 or higher.
  • This mod saves data that can be used by the optional Show Mod Names utility mod.
  • (In version 4 of this mod, Admin Places Geocode and Admin Places Date are included in the new Inner Mod Menu for admin_places.php.)

Installation

This mod uses the standard installation procedure, though it should be noted that this mod contains a mod subfolder that is shared with other mods that implement the "Inner Mod Menu" and that put their options in Admin >> Setup >> General Settings >> Robin's Mods. As a result, 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

(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 section of this article.)

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'.

Revision History

Mod Version TNG Versions Date Note
12.0.0.4 (beta) 12.0+ 18Aug2019 No significant changes to the search and display functionality.
  • Visible Changes:
    • An 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 titled "Robin's Mods.
    • 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.)
  • Beta Considerations
    • I'm committed to implementation of the new Inner Mod Menu in my Admin mods. But I am happy to consider feedback (via My Mod Support form) on whether some TNG administrators would prefer that I implement a mod option that would hide the menu on their sites. Note that the Inner Mod Menu can appear only on Admin programs; never on end-user programs.
12.0.0.3a 12.0+ 14Nov2018 No functional changes; made compatible with TNGv12.
11.0.0.3a 11.0+ 28Dec2017 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+ 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
11.0.0.2 11.0+ 26May2017 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+ 13Apr2017 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