Admin Cemeteries Search
Version 9 of this mod is available for download, but is in a beta testing status. Most of this article's text and visualizations still describe version 8, though there is very little different in the major features of the mod. You can find revision notes in this article's Revision History. Note that this mod is compatible only with new versions of some optional mods, but if those mods are not installed, that incompatibilty is irrelevant. See Related Mods for details. Robin Richmond, 13 Sep 2019 |
The latest version of this mod uses the 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:
[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.8c
| |
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.8c & 12.0.0.9beta2 | |
Min TNG V | 12.0 | |
Max TNG V | at least 12.1 | |
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 mod version 9, the settings are in a new subform called Robin's Mods
- Default value for the country selection box. ("USA")
- A list of fieldnames that set the initial state of checkboxes that determine whether optional fields (maplink, notes) are searched.
- 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.
- 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
- 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.
- 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.
- 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
- 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, 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 Remove capability
- Contact me through My Mod Support form.
Visualizations
BEFORE: An unmodified Admin Cemeteries Search page from TNGv9 - v11. |
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 8 and above
(For TNGv11 and TNGv12)
Mod version 8 Overview
Legend:
|
Mod version 8 and above Location Selection Controls |
|
Burial Count Controls |
(In this screen clip, the blue numbers continue the numbering of new features from the earlier screen clip with numbers 1-14)
|
Two trees with the same Associated Place |
(The blue numbers continue the numbering of new features)
|
Field Buttons |
In the screen clip above, new feature 18 is the field buttons.
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.
|
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
- admin_cemeteries.php - The Admin Cemeteries Search page, which is the target of almost all of the changes
- genstyle.css - Style rules that define minimum widths for some result table columns
- 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).
- admintext.php English - Around 50 new strings
Files Installed
- 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.
- 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.9beta2 | 12.0+ | 13Sep2019 | The search form and results table are unchanged, though some labels and help text may be different.
|
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
|
Admin Cemeteries Search v11.0.0.8 | 11.0 - 11.1.1+ | 18 Sep 2017 | Numerous changes:
The controls are:
|
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 |