Admin Places Search

Admin Places Search
Summary	Adds search options and results details to the Admin>>Places>>Search program
Validation
Mod Updated	17 Nov 2023
Download link	14.0.0.6g TNG 14.0 See the Revision History for older versions
Download stats
Author(s)	Robin Richmond
Homepage	Robin's Roots
Mod Support	My Mod Support form
Contact Developer	My Mod Support form
Latest Mod	14.0.0.6g
Min TNG V	11.0
Max TNG V	14
Files modified	admin_places.php, admin_genconfig.php, admin_updateconfig.php, English places_help.php
Related Mods	Mod Settings Blocks(required), Admin Places Geocode
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

Mod settings are defined and edited in a Mod Settings Block at Admin>>Setup>>General Settings, in the new subform 'Mod Settings .

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. Mod Settings Blocks is a prerequisite for this mod; it must be installed before this mod can be installed.
2. 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.

language

This mod does not install any files, but it does still have a mod subfolder, which contains the mod's language strings. That is, this mod's language strings are not defined in its .cfg file nor copied to cust_text.php files. As a result

• This mod's language strings are loaded only into the TNG programs that need them, not into all TNG programs, and
• It is easier to create, edit, test, and save translation for this mod than for mods that use standard cust_text.php strings.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

languageonly

This mod does not install any files, but it does still have a mod subfolder, which contains the mod's language strings. That is, this mod's language strings are not defined in its .cfg file nor copied to cust_text.php files. As a result

• This mod's language strings are loaded only into the TNG programs that need them, not into all TNG programs, and
• It is easier to create, edit, test, and save translation for this mod than for mods that use standard cust_text.php strings.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

languagesubsection

The Mod Subfolder

This mod does not install any files, but it does still have a mod subfolder, which contains the mod's language strings. That is, this mod's language strings are not defined in its .cfg file nor copied to cust_text.php files. As a result

• This mod's language strings are loaded only into the TNG programs that need them, not into all TNG programs, and
• It is easier to create, edit, test, and save translation for this mod than for mods that use standard cust_text.php strings.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

languageandfilessubsection

Language Strings

This mod's language strings are defined, distributed and files in its mod subfolder rather than in its .cfg file. TNG programs affected by this mod then load language strings from those mod subfolder files rather than from cust_text.php files. This non-standard technique for handling language strings has several advantages, including that

1. It loads language strings only into the pages that need them rather than into all TNG pages, and
2. It simplifies the process of defining and editing translations.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

installdetails

Standard Installation Process

[See 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]

Installation

Files Modified

• admin_places.php, as described above
• admin_genconfig.php, where the mod options are edited
• admin_updateconfig.php, the action script for admin_genconfig.php, and
• places_help.php

The Mod Subfolder

This mod does not install any files, but it does still have a mod subfolder, which contains the mod's language strings. That is, this mod's language strings are not defined in its .cfg file nor copied to cust_text.php files. As a result

• This mod's language strings are loaded only into the TNG programs that need them, not into all TNG programs, and
• It is easier to create, edit, test, and save translation for this mod than for mods that use standard cust_text.php strings.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

Standard Installation Process

[See 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.

AFTER: Search results without a search string, highlighting some of the new features 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.

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

AFTER: The help text added by this mod

AFTER: Field Buttons 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 Buttons 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. 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
14.0.0.6g	rraps	17Nov2023	The search string now supports the regular expression anchor characters '^' and '$',The option to search for "Placelevel not set" is now 'Placelevel: yes/no/either'. Display options in the search form are now "Results per page", ShowPlace notes, Show links to cemeteries. Search parameters are shown above the search results. In the results table: The Place Level column shows descriptions, whether Placelevel numbers are displayed,PlaceLevel, Latitude, Longitude, and Tree columns are displayed differently, The "geoignore" field is included when displaying places without a lat or long value. This mod works with the mods that add Place Levels for Google Maps, thanks to changes made by Ken Roy.
14.0.0.6f	rraps	10Feb2023	Upgrade for TNGv14
13.0.0.6d	13.1	30Oct2021	Updated the mod for TNGv13.1, and incorporated the changes made by mod v13.0.4.6c so one mod version can handle TNGv13.* 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. Updated the help text.
13.0.4.6c	13.0.4	09Jun2021	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. Updated the help text.
13.0.0.6b	13-13.0.3	05Nov2020	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) The "Show 'Has Notes'" mod option was affecting the 'Show Notes' display options, not just the 'Has Notes' search option. Styled the display of the Placelevel value to improve wrapping. Among other things, the value can now wrap on slashes. Fixed the document.ready function, which defines a number of style classes and attributes. Added Mod Manager logic to display a %note when the Mod Settings Block is not installed v6a 18 Oct 2020 Fixed a hard-coded table name in a SQL query
14.0.0.6f	13	30Aug2020	Modified one location to handle a new isset() function reference Always display the placelevel column and the placelevel number. Fixed use of the PlacesDisplayLevelName option. The name was always being displayed. Removed all code associated with the the sorting of results and the creation date field. Changed the new help file text to accommodate the code changes above. 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
Sample Page on Robin's Roots userid/pw: a/a	Robin Richmond	Mod developer	14.0.0.6g	rraps	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