Admin Places Search

From TNG_Wiki
Jump to navigation Jump to search
Admin Places Search
Summary Adds search options and results details to the Admin>>Places>>Search program
Validation
Mod Updated 5 Nov 2020
Download link 13.0.0.6c
TNG 13.0.4
13.0.0.6b
TNG 13.0
12.0.0.4b
TNG 12.0
See the Revision History for older versions
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 13.0.4.6c
Min TNG V 11.0
Max TNG V 13.0.4
Files modified
admin_places.php, admin_genconfig.php, admin_updateconfig.php, English places_help.php
Related Mods
Notes


Purpose of the Mod

Adds features to the Admin >> Places >> Search form and results list as follows:

  1. In the search form
    • Draws a fieldset border around the search form to help distinguish it from the action/pagination form.
    • Changes and adds some Search options:
      1. Adds a '+' button to expand the Search field
      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. Adds an information icon next to the Search field that pops up help text describing the changes to the Search field
      5. Changes the "Has Geocodes" option to radio buttons for "Geocodes: yes/no/either"
      6. Adds radio buttons for "Place Level: yes/no/either"
      7. Adds checkbox options to require a cemetery link or notes.
    • Adds some Display options:
      1. "Results Per Page", which overrides the system value ($maxsearchresults), but defaults to it.
      2. "Show Place Notes", which are displayed in a new column.
      3. "Show Cemetery Links", which are displayed as hyperlinks in a new column. When the Cemetery Links column is displayed, a table footnote describes that column.
      4. In TNGv13, "Show Modification Date". That is, the sortable modification date column added by TNG is not displayed by default.
  2. Displays the search parameters just above the results table.
  3. In the results table:
    • 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, optionally displays descriptive names such as "Location" and "City/Town". Handles mods that add placelevels.
    • Omits the Tree column if a tree was selected

Mod Options

The mod option is defined and edited in a Mod Settings Block in the form at Admin>>Setup>>General Settings, in the new subform Mod Settings  (or Robin's Mods in TNGv12). The mod has three options. Each of them has the ability to turn off one or more features of the mod and simplify the search form.

  1. Display Placelevel names as well as numbers: This option works even if most that increase the number of placelevels have been installed.
  2. Show Cemetery Options: Two of the new options on the search form are optional themselves. Both are checkboxes:
    • The search option "Has a cemetery link" and
    • The display option "Show cemetery links".
  3. Show the "Has Notes" option. This option does affects just the search option. It does not affect the "Show notes" option.

Compatibility

This mod is compatible with Admin Places Geocode, Places Subject to Deletion, and 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

  1. The Mod Settings Blocks mod packages this mod's options into what I call a "Mod Settings Block", which is a set of form fields that formatted and labeled so that it stands out among other options in an Admin>>Setting form. The Mod Settings Blocks is a prerequisite for this mod; it must be installed before this mod can be installed.
  2. The optional mod Inner Mod Menus displays an "Inner Mod Menu" in the TNG "inner menu" (just below the tab menu). The Inner Mod Menu that is defined by this mod is visible only if Inner Mod Menus mod is installed. Inner Mod Menus are visible only to TNG administrators; never to end-users. I highly recommend that you install the Inner Mod Menus mod because Inner Mod Menus provide links to handy information - particularly to the mod settings blocks for this mod's options.
  3. The Field Buttons mod activates little one-letter buttons that are attached to specific fields in the modified search form. These "Field Buttons" provide single-click execution of field editing tasks such as clearing the field, returning to the value the field had when the program was loaded, and selecting a default value. Field Buttons is not required; if it is not installed, the field buttons simply do no appear on the web page.
  4. This mod gathers data that can be used by the optional mod Show Mod Names, but there is no dependency on Show Mod Names
  5. The optional Admin Places Geocode mod defines 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.

Installation

In TNGv13, this mod includes a typical mod subfolder, with the same base name as the mod's .cfg file. The subfolder is atypical in that no files in it are installed to working TNG folders. However, it does contain critical files that contain the mod's language strings, which the mod does not add to standard cust_text.php files. Instead, the PHP code modified by this mod loads the language strings from files in the mod's languages/ subfolder. Read more about this technique.

[TNGv12 considerations]

In TNGv12 only, there is a second mod subfolder, which is shared by several mods. The folder RR-shared_mod_includes_v12.0.0.4 contains Include files that help to manage mod options in many of my mods:

  1. rrshared_modsettingsblocks4.php - Mod Settings Blocks
  2. img/rrshared_wikilogo.gif - An icon that links to a mod's TNG Wiki page from a Mod Settings Block

Each mod that contains the shared folder may install some or all of its shared files, depending on whether those files already exist. Once a file from the shared folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence or absence generate any Mod Manager errors.

If you unzip mod distribution files directly into your mods folder, then the presence of the shared subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder after you have unzipped the distribution file, then you need to make sure to copy the folder RR-shared_mod_includes_v12.0.0.4 (well, unless you are confident that it is already in your mods folder because it was part of another mod).

[Hide TNGv12 considerations]

[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 not perfectly up-to-date, but they are close.) 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
13.0.4.6c 13.0.4 09Jun2021
  1. In TNGv13.0.4, admin_places.php no longer displays the user who made the last change, so one target location had to be changed.
  2. Updated the help text.
13.0.0.6b 13-13.0.3 05Nov2020
  1. It wasn't suppressing the Tree column when the results include only one tree, and was not always displaying the treeName (though it would display the treeID)
  2. The "Show 'Has Notes'" mod option was affecting the 'Show Notes' display options, not just the 'Has Notes' search option.
  3. Styled the display of the Placelevel value to improve wrapping. Among other things, the value can now wrap on slashes.
  4. Fixed the document.ready function, which defines a number of style classes and attributes.
  5. Added Mod Manager logic to display a %note when the Mod Settings Block is not installed

v6a 18 Oct 2020

  1. Fixed a hard-coded table name in a SQL query
12.0.0.6 13 30Aug2020
  1. Modified one location to handle a new isset() function reference
  2. Always display the placelevel column and the placelevel number.
  3. Fixed use of the PlacesDisplayLevelName option. The name was always being displayed.
  4. Removed all code associated with the the sorting of results and the creation date field.
  5. Changed the new help file text to accommodate the code changes above.
  6. Uses the Mod Settings Blocks mod.
12.0.0.4b 12.0-12.3 26Feb2020
  • Added a missing %end:% and broken %replace:% in the .cfg file, as required by TNGv12.3
  • Uses version 4 of my shared mod libraries.
  • Fixed a bug that affected searches for missing placelevels
  • Changed the "Place level not set" checkbox into three radio buttons for "Placelevel: yes/no/either"
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 named 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.)
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 13.0.4.6c 13.0.4 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
The Cole / Tanner Family Tree David Cole Public/Private see here see here EN, DE, FR, ES, NL
Hooley Family Links Rick Hooley Public/Private See Here See Here EN