Admin Cemeteries Search

From TNG_Wiki
Jump to: navigation, search
Construction This article is in transition from version 8 or the mod to version 9. Most of this article's text and visualizations still describe version 8, though the new version made only small changes to the major features of the mod. You can find revision notes in this article's Revision History.

Robin Richmond, 18 Sep 2019

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 Cemeteries Search (formerly Admin Cemeteries List)
Summary Adds numerous controls to the Admin Cemeteries Search page to filter the search and include optional data in the results.
Validation
Mod Updated 13 Sep 2019
Download link v12.0.0.9
TNG 12.0
Download stats
Author(s) Robin Richmond
Homepage This page
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod 12.0.0.9
Min TNG V 12.0
Max TNG V at least 12.2
Files modified
admin_cemeteries.php, adminlib.php, css/genstyle.css, English cemetery_help.php, English cust_text.php;
Installs rrcemeteriessearch_ajx.php, rrcemeteriessearch_lib.php;
May Install rrinnermodmenu1.php, rrshared_modsettings1_include.php, rrshared_wikilogo.png
Related Mods
Notes


Purpose of the Mod

This distinctly large and complex mod adds filtering, searching, and formatting options to the Admin >> Cemeteries >> Search page in order to produce what amounts to a variety of what I hope are a variety of useful reports.

Among other things, it

  • Uses checkboxes to control whether selected result table columns are displayed,
  • Can filter results through hierarchical drop-down location boxes,
  • Can filter results according to the number of headstones tied to a cemetery, or the number of burial events at the places associated with the cemetery.
  • Sorts the results table in several ways,
  • Controls which fields are searched by the search string,
  • Reveals which database fields are being searched,
  • Has location drop down boxes to allow the search to focus on a specific location

See the Visualizations for details

Mod Options

This mod's options used to be defined as Mod Parameters, but they are now TNG settings, at Admin>>Setup>>General Settings, in a new subform named Robin's Mods

  1. Default value for the country selection box. ("USA")
  2. A list of fieldnames that set the initial state of checkboxes that determine whether optional fields (maplink, notes) are searched.
  3. A list of fieldnames that set the initial state of checkboxes that control whether optional data (notes, burials, headstones, geocodes] are displayed in the results table.
  4. A list of names that determine whether certain controls are shown on the search form at all.

See the Visualizations for specifics.

Mod Conflicts

I don't know of any conflicts (other than older versions of some Related Mods. As far as I know, this mod and its companion mod, Cemetery Edit, are the only published mods that affect the Cemeteries administration programs.

Related Mods

  1. My Cemetery Edit mod is closely related, and I recommend it as a companion to this mod. Still, these two mods are independent of each other. Cemetery Edit modifies the Cemetery Edit screen extensively, whereas this mod focuses on the Admin Cemeteries Search.
  2. The optional Field Buttons mod installs a Javascript library that this mod uses to add small "Field Buttons" buttons that serve as editing shortcuts in HTML forms.
    • If Field Buttons IS installed, then it must be version 3 or higher.
    • If Field Buttons IS NOT installed, then the little Field Buttons are simply not displayed.
  3. The optional Show Mods Names mods will display information about mods that have affected the running program. (Note that this is different from the Mod Manager Analyzer, which list the mods that modify a specific file.
    • If Show Mod Names IS installed, then it must be version 5 or higher.
    • If Show Mod Names IS NOT installed, then nothing bad will happen; the mod information will simply not be available.

Installation

This mod uses the standard installation procedure, though it should be noted that this mod contains mod subfolders that are shared with other mods that implement [[Inner Mod Menus] and organize their mod settings into Mod Settings Blocks at Admin >> Setup >> General Settings >> Robin's Mods. Because of the shared folders, 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

BEFORE: An unmodified Admin Cemeteries Search page from TNGv9 - v11.
Cemetery admin list-before.png

Mod version 5 (TNGv9)

(Version 9.2.0.5 still appears to work in TNGv11.1.1. It can can be downloaded from the Revision History section below.)

Mod Version 5

With the optional Associated Place column, I can now tell at a glance that the first two cemeteries on the page are not fully configured with an Associated Place.
Also note the new "Results per page" field and "Hide notes" checkbox. In each browser session, the Results per page value is initialized to the system-wide "Max Search Results" parameter from the General Settings/Miscellaneous screen. The value you enter only affects this screen, and is retained in a session cookie like the search string. Since cemetery notes can be fairly verbose, and can wind up scrunching the other fields, the user can use the "Hide Notes" checkbox (also retained in a session cookie) to suppress the Notes column.

Cemetery admin list-after1.png
Mod version 5/span> without the Notes column.
Cemetery admin list-after2.png

Mod version 8 and above

(For TNGv11 and TNGv12)

Mod version 8 Overview
Admin cemeteries search8-after1b.jpg

Legend:

  1. Two new links in the inner menu
    • A drop-down menu that links to this Wiki article's description of the mod parameters, and to the Mod Parameter editor in Mod Manager.
    • A link to this visualization in this Wiki article.
  2. A new set of "Location" controls. Each place component (country, state, etc) has a smart selection box. They are "smart" in the sense that
    • They are populated with values based on the selected value for the next-higher-level jurisdiction.
    • If there is only one possible value - for instance, if Manning County is the only county in Idaho in this site's Cemeteries table - then that value is automatically selected, and the possible values for the next jurisdiction are populated based on that value.
    • When a state has been selected but no county has been selected, the County field is populated with that state's counties, and the Cities field is populated with all cities and their county. As a result, you can select a city without necessarily selecting its county first.
    • When a place component value is selected, that component is removed from the list of fields that are searched by the search string (#6).
  3. The search string has HTML placeholder text that tells you about characters that have special meaning to the search field (see a visualization below). The string also has "field buttons" (see the Field Buttons mod and a visualization below). The 'X' button clears the field.
  4. An information icon is a link to the portion of the Cemeteries help page that describes the changes to the Cemeteries search form - particularly the controls that follow the information icon.
  5. A dynamic list of the fields that are searched by the search key. When you select place component values (Country, state, etc.) from the drop-down menus, those fields are removed from this list.
  6. These two checkboxes indicate whether the corresponding fields are searched. The default values for the two checkboxes are controlled by a Mod Parameter. The field "maplink" - the URL of a cemetery map - is included because the native TNG code always searched it.
  7. The Results Per Page field, which defaults to the system-wide "Max Search Results" parameter value at the beginning of a browser session, and its attached field buttons.
  8. Checkboxes that determine whether certain columns are included in the search results. The default values of these boxes are determined by a Mod Option. Note that the "Notes" checkbox here controls whether the Notes are in the results table, whereas the "notes" checkbox just above (#6) determines whether the Notes field is searched. In the visualization, the Geocodes will be omitted, and the Associated Places and Notes will be included in the table. (A visualization below explains why "Associated Places" is plural).
  9. Two checkboxes determine whether the results will show the number of burials at a cemetery and/or the number of headstone photos associated with the cemetery. When either checkbox is selected, an additional set of controls appears next to them. Those additional controls are shown in another visualization below.
  10. If either of the counts (#9) is selected, you can sort the results by one of the counts (but not both). See the Sorting Results section of this article for more details.
  11. A drop-down selection list determines a second sort key order (after the count - if a count is selected). Again, see the Sorting Results section of this article for more details.
  12. The search parameters including the sort order, are listed just above the results table.
  13. The new "Place" column displays the cemetery's Associated Placename, and is displayed only if the Associated Places checkbox (#8) is selected. If the Geocodes checkbox (also #8) is selected, the geocodes for the Associate Place are displayed, too. The FindAGrave Cemetery hyperlinks in the Notes column are a result of the FindAGrave Links mod. I do not enter a full hyperlink in the Cemetery Notes field. Instead, I just enter a FindAGrame cemetery number in the format "CRid=nnn", and the FindAGrave Links mod converts "CRid=nnn" into a hyperlink to the correct FindAGrave cemetery page.
Mod version 8 and above Location Selection Controls
Admin cemeteries search8-after2b-placenav.jpg
  1. When a state is selected, but not a county, the City field becomes City and County, so you can select cities without having to select a county first. In this case, I have selected cemeteries in Washington County that are not in a city.
  2. The Location selected by the Location controls is shown in the list of search parameters.
  3. There would ordinarily be a "Location" column between the Cemetery column and the Associated Place column. But, given the selected location, all of the cemeteries in the results table have the same location. Since the location is now shown as a search parameter just above the results table, the Location column is omitted.
Burial Count Controls
Admin cemeteries search-after4-burialcount.jpg

(In this screen clip, the blue numbers continue the numbering of new features from the earlier screen clip with numbers 1-14)

  1. In the location controls, the state of Iowa has been selected.
  2. The "Count burials" checkbox has been checked,
  3. (Blue number 15) Controls that set a criterion on the counts are visible because the "Count burials" checkbox was checked. There are three controls:
    • The checkbox that activates the criterion
    • The comparison operator, where "less than" has been selected, and
    • The value to which the count is compared, which has been set to 10. This is a number field that allows the user to use little arrows to increment or decrement the count.
  4. The Sort by Burial count checkbox has been activated by marking the Count Burials checkbox, and is selected.
  5. The "ASCending/DESCending" sort selection control has been set to "DESCending" for the Burial Count sort.
  6. The search and sort criteria just above the results table show the The Burial count is shown in a column titled "Bur". That column is the first data column in the table because the Burial count is the primary sort field. If the Sort By Burial Count checkbox were not checked, the Burial Count column would be far to the right.
  7. (Blue number 16) Because a partial location has been selected (Iowa, USA), the location column is called "Sub-location" and does not show the full location of the cemetery, but only the portion of the location that is within the selected location. Since the location search criterion is shown just above the results table, users can easily determine the full location if they forget the selected location.
Two trees with the same Associated Place
Admin cemeteries search8-after5-twotrees.jpg
  1. The search string is "lake"
  2. The sort order "Country, State, County, City, Cemetery Name (as opposed to the first option, "Cemetery Name, City, County...) causes the location names to be expressed with Country first.
  3. The Search and sort options show that the sort order will be country first.
  4. Because the Location is the primary sort key, it is the first data column in the results table. Also, the country (USA) has already been selected, so it is not needed in the Location column, which shows location names with the state first, to be consistent with the sort order.

(The blue numbers continue the numbering of new features)

  1. The Geocodes column abbreviates both the column name and the data values. The superscript 1 refers to a footnote that explains the field contents.
  2. There are two significant aspects of the Associated Place data:
    1. Because the Geocodes column is displayed, the geocodes of the Associated Place are displayed, with the same rounding as in the Geocodes column.
    2. In the second result, there are two values for the Tree and geocodes, because the Associated Place occurs in two trees.
  3. The footnote associated the the Geocodes column explains which values are in the column, and notes the rounding of the latitude and longitude values.
Field Buttons
Admin cemeteries search8-after6a-fieldbuttons.jpg

In the screen clip above, new feature 18 is the 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, as above, 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 cemeteries search8-afterb-fieldbuttons.jpg
In this screenclip, a search has been done with no search string, and with 30 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, as above, is shaded out because we just loaded the page.
    • The D button is shaded out because the the field already has the default value (the value of the TNG system parameter "Max Search Results").
    • The A button is visible because the value is not 'all'.

Sorting Results

The search form provides several ways to sort the query results. The native code always sorts the results by Cemetery name, and then City, County, State, and Country. As it turns out, however, the City, County, State, Country sequence that we use to express a location is not really a very good sort key. In almost all cases, when we want to sort burial placenames, we'd rather group the countries first, and then then states, counties, cities, and cemeteries. Therefore, an option to sort by Country, state, county, city, Cemetery has been added.

A third option is to sort by the Associated Place, in which, unlike Cemeteries, has the burial place name, the city, county, state, and country, all in one field.

The three location-related sort options are in a drop-down selection box.

When the user elects to include cemetery burial counts or headstone counts in the search results, either one of those counts (but not both) can also be a sort key, and is always the primary key.

In all, there are nine possible sort orders:

  • 3 options for the 'count' key: burial count, headstone count, or none

multiplied by

  • 3 options for the location sort key.

Files Modified

  1. admin_cemeteries.php - The Admin Cemeteries Search page, which is the target of almost all of the changes
  2. genstyle.css - Style rules that define minimum widths for some result table columns
  3. cemetery_help.php English - Modified fairly extensively to describe the new search form, to describe the meaning of TNG "Cemeteries" vs Burial Places. The help file also now links to two Wiki articles (including this one).
  4. admintext.php English - Around 50 new strings

Files Installed

  1. rradmincemeterysearch_ajx.php - An AJAX program that reads place jurisdiction values (i.e. a set of states, counties, or cities) that are appropriate for the selection that a user has made in a higher-level jurisdiction.
  2. rradmincemeterysearch_lib.php - A function library used by admin_cemeteries.php and the AJAX program listed just above. It actually has only one function, which is used by admin_cemeteries.php to populate the location drop-down boxes as the page is loaded, and by AJAX OnChange functions that invoke rradmincemeterysearch_ajx.php to populate lower-ordered location drop-down boxes when a selection is made in a higher-ordered location drop-down box. (See comments within rradmincemeterysearch_ajx.php for more details.)

Also, in mod version 9, files that are shared with other mods are (or really might be) installed from shared subfolders.

  • From the "Inner Mod Menus" library, in the mods subfolder RR-shared_innermodmenu_v12.0.0.1:
    • rrinnermodmenu1.php, a PHP Include file that defines functions used to flag new tabs, and to install Inner Mod Menus, ** img/rrshared_wikilogo.png, a Wiki icon that, in Inner Mod Menus, serves as a link to a mod's Wiki article.
  • From the "Mod Settings Blocks" library, in the mods subfolder RR-shared_mod_settings_v12.0.0.1.
    • rrshared_modsettings1_include.php, a PHP Include file that organizes mod options into what I call a Mod Setting Block, most particularly in Admin >> Setup >> General Settings >> Robin' Mods.

These two shared "libraries" are shared among mods that that create Inner Mod Menus or Mod Settings Blocks. That is, their subfolds are distributed with and can be installed by mutiple mods. The Mod Manager feature called Protected Files allows files to be shared among mods. Protected files are actually installed by the mod that is installed first on a given TNG site. When other mods that contain protected files are installed, the Mod Manager sees that the files have already been installed, and does not overwrite them. In addition, protected files are not deleted when mods that contain them are un-installed.

Custom CSS

I really hate to add style rules to genstyle.css because

  • Other mods may already have added dozens of style rules to genstyle.css, and
  • The rules added by mods are generally needed by only one or two programs.

So, this mod adds an embedded stylesheet to admin_cemeteries.php, and then re-positions it before the <link> tag that incorporates genstyle.css. Consequently, you can override these style rules just as you would any other style rules in genstyle.css, that is, either by

  • Placing new rules at the bottom of genstyle.css, or
  • Adding new rules to your template's mytngstyle.css (in your template's css folder)

The embedded style sheet for this mod can be found by searching for the string <style/>) in the mod's .cfg file.

Revision History

Mod Version TNG Version Date Note
12.0.0.9 12.0+ 13Sep2019 The search form and results table are unchanged, though some labels and help text may be different.
  1. Several bug fixes (see the revision history in the .cfg file)
  2. This mod's settings are in a new subform at Admin>>Setup>>General Settings>>Robin's Mods
  3. A new drop-down menu that I call the Inner Mod Menu (which drops down from the label "Mod Information") links to information about this (and possibly other) mods, and sits at the right end of the Inner Menu of admin_cemeteries.php.
  4. If the Field Buttons mod is installed, it must be version 3.
  5. Geocoordinates will be rounded only if version 4 of Admin Places Geocodes is installed. (Older versions shouldn't conflict with this mod. This mod simply won't find the geocoordinate rounding parameter from earlier versions.)
  6. The PHP and image files that support Inner Mod Menus and Mod Setting Blocks are shared among numerous mods. (See [#Files_Installed|Files Installed]] above). As a result, this mod's zip file contains three subfolders, two of which may already have been copied to your mod folder structure by other mods that share those folders. So, when you unzip or copy this mod, you may get warnings about overwriting existing files or folders. You can ignore those warning (and either overwrite the files or not).
12.0.0.8c 12.0+ 8 May 2018 No functional changes; brought to TNGv12 specs
12.0.0.8b 11.0 - 11.1.2+ 10 Feb 2017 No visible changes
  • All hyperlinks to the TNG Wiki use https
  • Removed a debugging statement that had been left in the code.
  • Added a "don't print on printer" class to the tab menu and innermenu, and the Action and Select columns of the results table.
  • Also no longer uses the external spreadsheet robinmods.css. Instead, the "don't print on printer" class is defined in an embedded stylesheet.
Admin Cemeteries Search v11.0.0.8 11.0 - 11.1.1+ 18 Sep 2017 Numerous changes:
  • Small changes
    1. Right-justifies the label column in the search form layout table.
    2. Applies a style class (rrnoprinter) to some elements on the Admin Cemeteries Search page so that they do not print.
    3. Removes dependencies on the DisplayModNames and Blue Info Button mods.ppl
  • The big change... added numerous controls to the search form to
    1. Enable new results table columns,
    2. Filter results in new ways,
    3. Sort the results table,
    4. Reveal which database fields are searched by the text search, and
    5. Control which fields are searched by the search string.

The controls are:

  • 3 checkboxes enable or disable 3 optional columns in the results table. The default checkbox status for each of the 3 checkboxes is controlled by a Mod Parameter
    1. Cemetery Notes (new)
    2. Associated Place (new) - Note that, in databases with more than one tree (and where the trees have separate Places lists), identical places in different tree can all be associated with one cemetery.
    3. Geocodes (which is displayed by the Pristine code).
  • 2 checkboxes enable burial counts and headstone counts, which are displayed in the same column.
  • 3 fields in the search table define a new filter on the results table that uses the new burial count and headstone count. These options are visible only if the Burials or Headstones count are enabled. They let the user specify things like "Omit cemeteries where the burial count < 10". The 3 fields are
    1. A checkbox that actives the filter,
    2. A <select> box of comparison operators,
    3. And a value for the comparison.
  • 2 checkboxes allow the results to be sorted by burial OR headstone counts. (The SQL code just can't handle sorting by both.) The checkboxes that enable sorting by burial count OR headstone count are always visible, but are disabled if the corresponding count checkbox is not checked.
  • A seleclooption box allows the user to sort the results by the Cemetery name, Cemetery location, or associated Burial Place (in combination with the Burial or Headstone count)
  • 2 controls specify whether the two sorting options are ascending or descending. These two controls are hyperlinks that toggle the displayed hyperlink text between '(ASC)' and '(DESC)'
  • 4 "smart" selection boxes focus the search by specifying values for Country, State, County, and City. They are "smart" in the sense that if Country=USA, then the States box only offers States in the USA, and if State=Iowa, then the County box only offers counties in Iowa, etc.
  • A control that is not a form field dynamically displays the list of fields that are searched by the text search. As country, state, county, and/or city values are selected by the location controls, those fields are removed from the list.
  • 2 checkboxes in the list of fields searched by the text search string controls whether two fields are searched:
    1. Maplink - the hyperlink to the Cemetery map or photo image, which was searched by the pristine code, and
    2. Notes, which were not searched by the pristine code
Admin Cemeteries List 9.2.0.5 download 9.2.0 - 11.0 21 Mar 2016 Converts new lines to <br> tags in the notes field; Depends on [[Show Mod Names|Show Mod Name v2+]; Tested for TNGv11
Admin Cemeteries List 9.2.0.4 9.2.0 - 10.1 31 Dec 2014 Updated for conformance with v10.1; Changed the Geocode column to round the values to 3 decimal places, and eliminate the keywords.
Admin Cemeteries List v9.2.0.1 9.2.0 - 10.0.0.1 08 May 2014 Initial release.

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.8b 11.1.2 English
MOTYER Family Genealogy John Mark Motyer Public site see here see here EN, DE, RU
Total Family History Scott Bennett Private Site (For right now) 9.2.0.1 TNG 10.0.1 EN
Mitchell Families Online Roger Mitchell Very useful mod 9.2.0.1 10.0.3 EN
The Dutton's of Vermont Darrin Dutton 9.2.0.4 10.1.0 EN
Brady Family Tree in Western Australia Darryl Brady Public site 9.2.0.4 10.1.1 EN, DE
R G Strong Family Genealogy Russell Strong Public site 12.0.0.8c 12.0.1 EN, DE, FR, NL
Wortelboer Genealogy Bernard Wortelboer Public site 9.2.0.5 11.0.0 NL, EN
Brabantse Genealogie Rob van Rij Public Site 9.2.0.5 11.0.1 EN,FR,NL
Woking Family Tree Project Pete Smee Public/Private v12.0.0.8c v12.1 English
Cole / Tanner Family Tree David Cole Public/Private see here see here English
Journeys in Genealogy Patrick Thrush Public WordPress/TNG bundle 10.0.0.8 12.0.3 English
Our Family Histories Bryan S. Larson Public - T8 customized see here see here EN