Difference between revisions of "Admin Cemeteries Search"
Robinrichm (talk | contribs) |
|||
(23 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{TNGmod | {{TNGmod | ||
− | | mod_name = Admin Cemeteries Search | + | | mod_name = Admin Cemeteries Search |
| mod_summary = Adds numerous controls to the Admin Cemeteries Search page to filter the search and include optional data in the results. | | mod_summary = Adds numerous controls to the Admin Cemeteries Search page to filter the search and include optional data in the results. | ||
| mod_validation = | | mod_validation = | ||
− | | mod_last_update = | + | | mod_last_update = 26 Feb 2020 |
− | | download_link = | + | | download_link = [[Media:admin_cemeteries_search_v12.0.0.9d.zip|v12.0.0.9d]]...not quite yet{{Tv120}} |
− | <div>[[ | + | <div style='size:90%'>See the [[#Revision_History|Revision History]] for older versions.)</div> |
| download_stats = | | download_stats = | ||
| mod_author = [[User:Robinrichm|Robin Richmond]] | | mod_author = [[User:Robinrichm|Robin Richmond]] | ||
Line 12: | Line 11: | ||
| mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] | | mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] | ||
| mod_support = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums] | | mod_support = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums] | ||
− | | mod_version = | + | | mod_version = 12.0.0.9d |
− | | min_TNG_ver = | + | | min_TNG_ver = 12.0 |
− | | max_TNG_ver = | + | | max_TNG_ver = 12.3 |
− | | TNG_file_list = admin_cemeteries.php, | + | | TNG_file_list = admin_cemeteries.php, admin_genconfig.php, admin_updateconfig.php, English cemetery_help.php; |
− | English cemetery_help | + | <br/>'''Installs''' rrcemeteriessearch_ajx.php, rrcemeteriessearch_lib.php;<br>'''May Install''' rrshared_modsettingsblocks4.php, rrshared_wikilogo.gif |
− | | related_mods = [[Cemetery Edit]], [[Field Buttons]] | + | | related_mods = [[Admin Cemetery Edit]], [[Admin Places Geocode]], [[Field Buttons]], [[Show Inner Mod Menus]] |
| notes = | | notes = | ||
}} | }} | ||
== Purpose of the Mod == | == Purpose of the Mod == | ||
− | This distinctly large and complex mod adds filtering, searching, and formatting options to the Admin >> Cemeteries >> Search page in | + | This distinctly large and complex mod adds filtering, searching, and formatting options to the Admin>>Cemeteries>>Search page that not only provide more search and display options, but also, in effect, produce what I hope are a variety of useful reports. |
{| style="margin-right:0.5 em;" align="right" ; "font-size:120%"; | {| style="margin-right:0.5 em;" align="right" ; "font-size:120%"; | ||
| __TOC__ | | __TOC__ | ||
|} | |} | ||
Among other things, it | Among other things, it | ||
− | * | + | * Lets the user control which fields are searched by the search string, |
− | * | + | * Reveals which database fields are being searched, |
− | * | + | * Provides a set of "smart" selection boxes for Country, State, County, and City that allow you focus your search on a location without having to specify the location in the search string. <span class="mw-collapsible mw-customtoggle-smart1 mw-customtoggle-smart2" id='mw-customcollapsible-smart1' style="text-decoration:underline;color:#0645ad;"> [Show details]</span> |
+ | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-smart2' style="margin-left:2em; border:thin solid grey;"> | ||
+ | They are "smart" in the sense that<ol> | ||
+ | <li>They are populated with values based on the selected value for the next-higher-level place component.</li> | ||
+ | <li>If the higher-level place component value has only one subordinate 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'' place component are populated based on that value.</li> | ||
+ | <li>When a state but no county has been selected, the both the County and City fields are populated. As a result, you can select a city without necessarily selecting its county first.</li> | ||
+ | <li>When a place component value is selected, that component is removed from the list of fields that are searched by the search string (#6).</li> | ||
+ | </ol> | ||
+ | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-smart1 mw-customtoggle-smart2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide details]</div> | ||
+ | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | ||
* Sorts the results table in several ways, | * Sorts the results table in several ways, | ||
− | * | + | * Can report the number of headstones tied to a cemetery, or the number of burial events at the places associated with the cemetery. |
− | * | + | ** Can also use either of these counts in the results sort. |
* Has location drop down boxes to allow the search to focus on a specific location | * Has location drop down boxes to allow the search to focus on a specific location | ||
− | + | * Has mod options that let you suppress some of the new search form controls. | |
+ | See the [[#Visualizations|Visualizations]] for details | ||
== Mod Options == | == Mod Options == | ||
− | + | * Default value for the country selection box. | |
− | + | * Two checkboxes for database fieldnames that can be searched. These selections set the initial state of checkboxes in the Search form. | |
− | + | * Three checkboxes for fields that can be added to the results table. These selections set the initial state of checkboxes in the Search form. | |
− | + | ** Note that one of the checkboxes (Geocodes) covers 3 fields. | |
− | + | * Two checkboxes that determine whether certain new controls are shown on the search form at all. | |
+ | The mod options are illustrated in a visualization below. | ||
+ | |||
+ | These mod options are custom TNG settings, defined and edited in the form at Admin>>Setup>>General Settings, in a new subform named '''Robin's Mod's'''. This subform takes advantage of a scheme that I call '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]'''. | ||
== Mod Conflicts == | == Mod Conflicts == | ||
− | I don't know of any conflicts. | + | I don't know of any conflicts (other than older versions of some [[#Related_Mods|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== | ==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. | # 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'' [[Show Inner Mod Menus]] mod installs a PHP Include file that this mod uses to generate its "Inner Mod Menu". Though [[Show Mod Menus]] is options, I highly recommend it, because I believe that to have the mod information a, particularly, the link to mod options, so handy is a great benefit to administrative users. |
− | # | + | # 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 Mod Names]] mod 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. | ||
+ | == 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). | ||
+ | |||
+ | == Installation == | ||
+ | === Files Installed === | ||
+ | This mod has two mod subfolders: | ||
+ | # '''admin_cemeteries_search_v12.0.0.9d''' - The subfolder that you expect to exist for any mod that installs files. It contains | ||
+ | ## rradmincemeterysearch_ajx.php - An AJAX program that reads place component 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 component. | ||
+ | ## 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.) | ||
+ | # The shared folder '''RR-shared_mod_includes_v12.0.0.4''', which contains files that support functionality that is implemented in many of my mods: | ||
+ | ## '''rrshared_modsettingsblocks4.php''' - [https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks] | ||
+ | ## '''img/rrshared_wikilogo.gif''' - An icon that links to a mod's TNG Wiki page from an Inner Mod Menu or Mod Settings Block | ||
+ | |||
+ | The shared folder is packaged with several mods, each of which may install some or all of its files. Once a file from this 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 generate any Mod Manager errors. | ||
+ | |||
+ | If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally ''copy'' mod subfolders to your mods folder, 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). | ||
{{RobinInstallationBoilerplate}} | {{RobinInstallationBoilerplate}} | ||
+ | |||
== Visualizations == | == Visualizations == | ||
+ | |||
{| border="1" cellspacing="1" cellpadding="2" class="wikitable" | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | ||
− | |<span style="color: red"> | + | |'''<span style="color: red"> The unmodified Admin Cemeteries Search page</span>''' |
|- | |- | ||
| [[Image:cemetery_admin_list-before.png]] | | [[Image:cemetery_admin_list-before.png]] | ||
|} | |} | ||
− | + | <span id='afterinstallation'></span> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| border="1" cellspacing="1" cellpadding="2" class="wikitable" | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
− | | '''<span style="color: red"> | + | |'''<span style="color: red">After Installation - Overview</span>''' |
− | <div class="mw-collapsible mw- | + | <!-- *** BEGIN DOUBLE DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-ai1 mw-customtoggle-ai2 mw-customtoggle-ai1a mw-customtoggle-ai2a" id='mw-customcollapsible-ai1a' style="text-decoration:underline;color:#0645ad; text-align:right;">[Show annotation]</div> |
− | <div class=' | + | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-ai2a' style="border:thin solid grey;"> |
− | Legend: | + | <!-- TOGGLED CONTENT --><div class="mw-customtoggle-ai1 mw-customtoggle-ai2 mw-customtoggle-ai1a mw-customtoggle-ai2a " style="text-decoration:underline;color:#0645ad;float:right;">[Hide annotation]</div> |
− | # | + | </div><!-- END DOUBLE DOUBLE TOGGLE --> |
− | + | <div>[[Image:admin_cemeteries_search8-after1b.jpg]]</div> | |
− | #* | + | <!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-ai1 mw-customtoggle-ai2 mw-customtoggle-ai1a mw-customtoggle-ai2a" id='mw-customcollapsible-ai1' style="text-decoration:underline;color:#0645ad; text-align:right;">[Show annotation]</div> |
− | # | + | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-ai2' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> |
− | #* They are populated with values based on the selected value for the next-higher-level | + | <!-- BUTTON AT THE top OF TOGGLED CONTENT --><div class="mw-customtoggle-ai1 mw-customtoggle-ai2 mw-customtoggle-ai1a mw-customtoggle-ai2a" style="text-decoration:underline;color:#0645ad;float:right;"> [Hide annotation]</div> |
− | #* If | + | '''Legend:''' |
− | #* When a state | + | # At the right end of the "innermenu" (just below the tab menu), the "Mod Information" label drops down an "Inner Mod Menu", which provides handy links to information about the mod, and, most particularly, a handy link to the mod options. See the '''[[#innermodmenu|Inner Mod Menu]]''' visualization below. |
+ | #* The Inner Mod Menu is visible only if the '''[[Show Inner Mod Menus]]''' mod is installed. (I highly recommend that you install [[Show Inner Mod Menus]] - I believe that the opportunity to use the Inner Mod Menu to pop up the mod options editor is just too good to pass up.) | ||
+ | # The new set of "Location" controls that are described in the Location Controls" subsection of this article.. Each place component (country, state, county, city) 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 place component. | ||
+ | #* If the higher-level place component value has only one subordinate 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'' place component are populated based on that value. | ||
+ | #* When a state but no county has been selected, the both the County and City fields are populated. 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). | #* When a place component value is selected, that component is removed from the list of fields that are searched by the search string (#6). | ||
− | # 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. | + | #: XYZZY'''if you to not find the Location selection boxes to be useful, you can hide them through a mod option. If you hide them, or if you not A mod option suppresses The Location selection boxes can # 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. |
# 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. | # 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. | ||
# 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. | # 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. | ||
# 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. | # 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. | ||
# 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. | # 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. | ||
− | # Checkboxes that determine whether certain columns are included in the search results. The default values of these boxes are determined by a Mod | + | # 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). |
# 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. | # 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. | ||
# 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|Sorting Results section of this article]] for more details. | # 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|Sorting Results section of this article]] for more details. | ||
# A drop-down selection list determines a second sort key order (after the count - if a count is selected). Again, see the [[#Sorting_Results|Sorting Results section of this article]] for more details. | # A drop-down selection list determines a second sort key order (after the count - if a count is selected). Again, see the [[#Sorting_Results|Sorting Results section of this article]] for more details. | ||
# The search parameters including the sort order, are listed just above the results table. | # The search parameters including the sort order, are listed just above the results table. | ||
− | # The new "Place" column displays the cemetery's Associated Placename, and is displayed only if the Associated Places checkbox (#8) is selected. | + | # The new "Place" column displays the cemetery's Associated Placename, and is displayed only if the Associated Places checkbox (#8) is selected. |
− | </div></div> | + | # The new "Notes" column is visible because the "Display...Notes" checkbox (#8) is checked. The FindAGrave Cemetery hyperlinks in the Notes column are a result of the [[FindAGrave Links]] mod. I do not enter a full FindAGrave hyperlink in the Cemetery Notes field. Instead, I just enter a FindAGrave cemetery number in the format "CRid=nnn", and the [[FindAGrave Links]] mod converts that string into a hyperlink to the correct FindAGrave cemetery page. |
− | |- | + | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-ai1 mw-customtoggle-ai2 mw-customtoggle-ai1a mw-customtoggle-ai2a" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide annotation]</div> |
− | |'''< | + | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> |
− | + | |} | |
− | + | ||
+ | <!-- ****************************** Location Controls ****************************--> | ||
+ | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | ||
+ | |'''<div style="color: red">Location Selection Controls</div>''' | ||
+ | [[Image:admin_cemeteries_search8-after2b-placenav.jpg]]<br> | ||
# 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. | # 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. | ||
# The Location selected by the Location controls is shown in the list of search parameters. | # The Location selected by the Location controls is shown in the list of search parameters. | ||
# 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. | # 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 ****************************--> | |
− | + | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | |
− | + | | '''<span style="color: red">Burial Count Controls</span>''' | |
− | * | ||
− | ** | ||
− | ** | ||
− | ** | ||
− | * | ||
− | * | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | '''<span style="color: red"> | ||
|- | |- | ||
| [[Image:admin_cemeteries_search-after4-burialcount.jpg]]<br> | | [[Image:admin_cemeteries_search-after4-burialcount.jpg]]<br> | ||
Line 140: | Line 156: | ||
# 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. | # 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. | ||
# (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. | # (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 **********************--> | ||
+ | {| border="1" cellspacing="1" cellpadding="2" class="wikitable" | ||
+ | |'''<span style="color: red">(a) Two trees with the same Associated Place and (b) The optional Geocodes column</span>''' | ||
|- | |- | ||
− | + | | [[Image:admin_cemeteries_search-after5-twotrees.jpg]] | |
− | |||
− | | [[Image: | ||
# The search string is "lake" | # The search string is "lake" | ||
− | # 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. | + | # 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. Though this is often a more useful way to sort than by cemetery name, I have to admit that the notation is no really familiar to most of us. |
# The Search and sort options show that the sort order will be country first. | # The Search and sort options show that the sort order will be country first. | ||
# 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. | # 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. | ||
Line 152: | Line 171: | ||
<li>The Geocodes column abbreviates both the column name and the data values. The superscript 1 refers to a footnote that explains the field contents.</li> | <li>The Geocodes column abbreviates both the column name and the data values. The superscript 1 refers to a footnote that explains the field contents.</li> | ||
<li>There are two significant aspects of the Associated Place data: | <li>There are two significant aspects of the Associated Place data: | ||
− | <ol type='a'><li>Because the Geocodes column is displayed, the | + | <ol type='a'><li>Because the Geocodes column is displayed, the Geocodes of the Associated Place are also displayed, with the same rounding as in the Geocodes column.</li> |
− | <li>In the second result, there are two values for the Tree and | + | <li>In the second result, there are two values for the Tree and Geocodes, because the Associated Place occurs in two trees. |
</ol></li> | </ol></li> | ||
<li>The footnote associated the the Geocodes column explains which values are in the column, and notes the rounding of the latitude and longitude values. | <li>The footnote associated the the Geocodes column explains which values are in the column, and notes the rounding of the latitude and longitude values. | ||
</ol> | </ol> | ||
− | |- | + | |} |
− | |'''<span style="color: red"> | + | |
− | + | <!-- ************************ Field Buttons **********************--> | |
− | + | {| border="3" cellspacing="1" cellpadding="2" class="wikitable" | |
+ | |'''<span style="color: red">Field Buttons</span>''' | ||
+ | <!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-fb1 mw-customtoggle-fb2" id='mw-customcollapsible-fb1'>See the [[Field Buttons]] Wiki article, or <span style="text-decoration:underline;color:#0645ad;">Open an annotated visualization here</span></div> | ||
+ | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-fb2' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> | ||
+ | <!-- BUTTON AT THE top OF TOGGLED CONTENT --><div class="mw-customtoggle-fb1 mw-customtoggle-fb2" style="text-decoration:underline;color:#0645ad;float:right;"> [Hide details]</div> | ||
+ | [[Image:admin_cemeteries_search-after6a-fieldbuttons.jpg]]<br> | ||
In the screen clip above, new feature 18 is the field buttons. | In the screen clip above, new feature 18 is the field buttons. | ||
* For the search string field: | * For the search string field: | ||
Line 169: | Line 193: | ||
** 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 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'. | ** The A button will assign a value that means "All Items". In this case, that value is 'all'. | ||
− | + | Buttons that would not change the current value are shaded out, as shown below.<br/> | |
− | + | [[Image:admin_cemeteries_search-after6b-fieldbuttons.jpg]]<br> | |
− | Buttons that would not change the value are shaded out, as shown below.<br/> | + | In this screen clip, a search has been done with no search string, and with 30 Results per page. As a result: |
− | [[Image: | ||
− | In this | ||
* For the search string field: | * For the search string field: | ||
** The X button is shaded out because there is no value to clear. | ** The X button is shaded out because there is no value to clear. | ||
Line 181: | Line 203: | ||
** 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 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'. | ** The A button is visible because the value is not 'all'. | ||
+ | '''Note that the [[Field Buttons]] mod must be installed for the field buttons to be visible''', but it is not required for the mod to work. | ||
+ | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-fb1 mw-customtoggle-fb2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide the Field Buttons visualization]</div> | ||
+ | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | ||
|} | |} | ||
− | == Sorting | + | <!-- ************************ Mod Settings Block **********************--> |
+ | {| border="3" cellspacing="1" cellpadding="2" class="wikitable" | ||
+ | |'''<span style="color: red">The Mod Options</span>''', in a '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Block]''' | ||
+ | The Mod Settings Block for Admin Cemeteries Search (like most other Mod Settings Blocks) is at '''Admin>>Setup>>General Settings''' in a new subform named '''Robin's Mods'''. | ||
+ | When Mod Settings Block are invoked from an Inner Mod Menu, the Admin>>Settings program automatically opens the subform and displays only the target Mod Settings Block, like this: | ||
+ | <div>[[Image:admin_cemeteries_search-after-modsettingsblock.jpg]]</div> | ||
+ | |} | ||
+ | |||
+ | <!-- ************************ Inner Mod Menu **********************--> | ||
+ | <span id='innermodmenu'></span> | ||
+ | {| border="3" cellspacing="1" cellpadding="2" class="wikitable" | ||
+ | |'''<span style="color: red">The Admin Cemeteries Inner Mod Menu</span>''' | ||
+ | The visibility of this Inner Mod Menu depends on the installation of the '''[[Show Inner Mod Menus]]''', but that mod is not required. Because Admin Cemeteries Search has mod options in a Mod Settings Block, the Inner Mod Menu contains a link labeled "Change Mod Options", and that link opens the Mod Settings Block above. | ||
+ | <div>[[Image:admin_cemeteries_search-after-innermodmenu.jpg]]</div> | ||
+ | |} | ||
+ | |||
+ | == Sorting == | ||
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. | 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. | ||
Line 192: | Line 233: | ||
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. | 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: | + | In all, there are nine possible sort orders: 3 options for the 'count' key (burial count, headstone count, none) multiplied by 3 options for the location sort key. |
− | |||
− | multiplied by | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Custom CSS == | == Custom CSS == | ||
I really hate to add style rules to genstyle.css because | I really hate to add style rules to genstyle.css because | ||
− | * Other mods | + | * Other mods add dozens (upon dozens) of style rules to genstyle.css, and |
− | * The rules added by mods are generally needed by only one or two programs, | + | * 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 | + | * Besides, the more rules there are in genstyle.css, the more likely it is that rules will collide. |
− | Consequently, you can override these style rules just as you would any other style rules in genstyle.css, that is ,either by | + | So, this mod adds an embedded stylesheet to admin_cemeteries.php, and uses Javascript to re-position it the DOM before the <link> tag that incorporates genstyle.css. |
− | * Placing new rules at the bottom of genstyle.css, | + | Consequently, you can override these style rules just as you would any other style rules in genstyle.css, that is, either by |
− | * Adding new rules to your template's mytngstyle.css | + | * Placing new rules at the bottom of genstyle.css, |
− | The style | + | * (generally preferably) Adding new rules to your template's mytngstyle.css, which is in your template's css folder. |
− | < | + | |
− | < | + | The embedded style sheet for this mod can be found by searching for the string <code><style</code>) in the mod's .cfg file. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
== Revision History == | == Revision History == | ||
Line 266: | Line 251: | ||
|- | |- | ||
! Mod Version !! TNG Version !! Date !! Note | ! Mod Version !! TNG Version !! Date !! Note | ||
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
+ | | [[Media:admin_cemeteries_search_v12.0.0.9d.zip|12.0.0.9d]] | ||
+ | | 12.0+ | ||
+ | | 26Feb2020 | ||
+ | | No functional changes, but the infrastructure changes should make it worthwhile to install this version. | ||
+ | * Moved to a standalone version of the Inner Mod Menu library, installed by its own mod. | ||
+ | * Moved the cust_text strings into a mod subfolder. | ||
+ | * Cleaned up some references to undefined variables and subscripts | ||
+ | |||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | [[Media:admin_cemeteries_search_v12.0.0.9b.zip|12.0.0.9b]] | ||
+ | | 12.0+ | ||
+ | | 26Feb2020 | ||
+ | | No functional changes. Not a critical update unless you use TNGv12.3. | ||
+ | * Inserted an %end:% tag, as required by TNGv12.3. Also uses v4 of my shared mod libraries. | ||
+ | |||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | [[Media:admin_cemeteries_search_v12.0.0.9.zip|12.0.0.9]] | ||
+ | | 12.0+ | ||
+ | | 13Sep2019 | ||
+ | | The search form and results table are unchanged, though some labels and help text may be different. | ||
+ | # Several bug fixes (see the revision history in the .cfg file) | ||
+ | # The mod's settings are in a '''[https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Block]''' at Admin>>Setup>>General Settings>>'''Robin's Mods]''' | ||
+ | # Added an '''[https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menu]''' to admin_cemeteries.php. | ||
+ | # If the '''[[Field Buttons]]''' mod is installed, it must be version 3+ | ||
+ | # Geocoordinates will be rounded only if version 4+ of '''[[Admin Places Geocode]]''' is installed. (Older versions shouldn't conflict with this mod. This mod simply won't find the geocoordinate rounding parameter from earlier versions.) | ||
+ | |||
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| [[Media:admin_cemeteries_search_v12.0.0.8c.zip|12.0.0.8c]] | | [[Media:admin_cemeteries_search_v12.0.0.8c.zip|12.0.0.8c]] | ||
| 12.0+ | | 12.0+ | ||
| 8 May 2018 | | 8 May 2018 | ||
| No functional changes; brought to TNGv12 specs | | No functional changes; brought to TNGv12 specs | ||
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| [[Media:admin_cemeteries_search_v12.0.0.8b.zip|12.0.0.8b]] | | [[Media:admin_cemeteries_search_v12.0.0.8b.zip|12.0.0.8b]] | ||
| 11.0 - 11.1.2+ | | 11.0 - 11.1.2+ | ||
Line 280: | Line 292: | ||
* Added a "don't print on printer" class to the tab menu and innermenu, and the Action and Select columns of the results table. | * 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. | * 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 | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
+ | | Admin Cemeteries '''Search''' v11.0.0.8 | ||
| 11.0 - 11.1.1+ | | 11.0 - 11.1.1+ | ||
| 18 Sep 2017 | | 18 Sep 2017 | ||
− | | | + | | <!-- *** BEGIN DOUBLE TOGGLE --><span class="mw-collapsible mw-customtoggle-v8a mw-customtoggle-v8b" id='mw-customcollapsible-v8a' style="text-decoration:underline;color:#0645ad;">[Show details]</span> |
− | <div class='mw-collapsible | + | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-v8b' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> |
+ | <div class="mw-customtoggle-v8a mw-customtoggle-v8b" style="text-decoration:underline;color:#0645ad;float:right;">[Hide details]</div> | ||
* Small changes | * Small changes | ||
*# Right-justifies the label column in the search form layout table. | *# Right-justifies the label column in the search form layout table. | ||
Line 308: | Line 322: | ||
*# And a value for the comparison. | *# 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. | * 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 | + | * A selection 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)' | * 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. | * 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. | ||
Line 315: | Line 329: | ||
*# Maplink - the hyperlink to the Cemetery map or photo image, which was searched by the pristine code, and | *# Maplink - the hyperlink to the Cemetery map or photo image, which was searched by the pristine code, and | ||
*# Notes, which were not searched by the pristine code | *# Notes, which were not searched by the pristine code | ||
− | </div> | + | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-v8a mw-customtoggle-v8b" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide details]</div> |
− | |- | + | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> |
− | | Admin Cemeteries List | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
+ | | Admin Cemeteries List [[Media:admin_cemeteries_list_v9.2.0.5.zip|v9.2.0.5]] | ||
| 9.2.0 - 11.0 | | 9.2.0 - 11.0 | ||
| 21 Mar 2016 | | 21 Mar 2016 | ||
− | | Converts new lines to <br> tags in the notes field; Depends on [[Show Mod Names|Show Mod | + | | Converts new lines to <br> tags in the notes field; Depends on [[Show Mod Names|Show Mod Names v2+]] Tested for TNGv11 |
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| Admin Cemeteries List 9.2.0.4 | | Admin Cemeteries List 9.2.0.4 | ||
| 9.2.0 - 10.1 | | 9.2.0 - 10.1 | ||
| 31 Dec 2014 | | 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. | | Updated for conformance with v10.1; Changed the Geocode column to round the values to 3 decimal places, and eliminate the keywords. | ||
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| Admin Cemeteries List v9.2.0.1 | | Admin Cemeteries List v9.2.0.1 | ||
| 9.2.0 - 10.0.0.1 | | 9.2.0 - 10.0.0.1 | ||
Line 343: | Line 359: | ||
| [[User:Robinrichm|Robin Richmond]] | | [[User:Robinrichm|Robin Richmond]] | ||
| Mod developer | | Mod developer | ||
− | | | + | | 12.0.0.9d |
− | | | + | | 12.3 |
| English | | English | ||
|- | |- | ||
Line 423: | Line 439: | ||
| 12.0.3 | | 12.0.3 | ||
| English | | English | ||
− | + | |- | |
+ | | [https://www.ourfamilyhistories.org Our Family Histories] | ||
+ | | [[User:Bsl20b50|Bryan S. Larson]] | ||
+ | | Public - T8 customized | ||
+ | | [[User:Bsl20b50|see here]] | ||
+ | | [[User:Bsl20b50|see here]] | ||
+ | | EN | ||
|} | |} | ||
[[Category:Mods for TNG v11]] | [[Category:Mods for TNG v11]] | ||
Line 432: | Line 454: | ||
[[Category:Adminlib.php mods]] | [[Category:Adminlib.php mods]] | ||
[[Category:Admin_cemeteries.php mods]] | [[Category:Admin_cemeteries.php mods]] | ||
− | |||
[[Category:genstyle.css mods]] | [[Category:genstyle.css mods]] |
Revision as of 09:06, 15 April 2020
Admin Cemeteries Search | ||
---|---|---|
Summary | Adds numerous controls to the Admin Cemeteries Search page to filter the search and include optional data in the results. | |
Validation | ||
Mod Updated | 26 Feb 2020 | |
Download link | v12.0.0.9d...not quite yet
See the Revision History for older versions.) | |
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.9d | |
Min TNG V | 12.0 | |
Max TNG V | 12.3 | |
Files modified | admin_cemeteries.php, admin_genconfig.php, admin_updateconfig.php, English cemetery_help.php;
Installs rrcemeteriessearch_ajx.php, rrcemeteriessearch_lib.php; May Install rrshared_modsettingsblocks4.php, rrshared_wikilogo.gif | |
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 that not only provide more search and display options, but also, in effect, produce what I hope are a variety of useful reports.
Among other things, it
- Lets the user control which fields are searched by the search string,
- Reveals which database fields are being searched,
- Provides a set of "smart" selection boxes for Country, State, County, and City that allow you focus your search on a location without having to specify the location in the search string. [Show details]
- They are populated with values based on the selected value for the next-higher-level place component.
- If the higher-level place component value has only one subordinate 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 place component are populated based on that value.
- When a state but no county has been selected, the both the County and City fields are populated. 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).
- Sorts the results table in several ways,
- Can report the number of headstones tied to a cemetery, or the number of burial events at the places associated with the cemetery.
- Can also use either of these counts in the results sort.
- Has location drop down boxes to allow the search to focus on a specific location
- Has mod options that let you suppress some of the new search form controls.
See the Visualizations for details
Mod Options
- Default value for the country selection box.
- Two checkboxes for database fieldnames that can be searched. These selections set the initial state of checkboxes in the Search form.
- Three checkboxes for fields that can be added to the results table. These selections set the initial state of checkboxes in the Search form.
- Note that one of the checkboxes (Geocodes) covers 3 fields.
- Two checkboxes that determine whether certain new controls are shown on the search form at all.
The mod options are illustrated in a visualization below.
These mod options are custom TNG settings, defined and edited in the form at Admin>>Setup>>General Settings, in a new subform named Robin's Mod's. This subform takes advantage of a scheme that I call Mod Settings Blocks.
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 Show Inner Mod Menus mod installs a PHP Include file that this mod uses to generate its "Inner Mod Menu". Though Show Mod Menus is options, I highly recommend it, because I believe that to have the mod information a, particularly, the link to mod options, so handy is a great benefit to administrative users.
- 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 Mod Names mod 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.
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).
Installation
Files Installed
This mod has two mod subfolders:
- admin_cemeteries_search_v12.0.0.9d - The subfolder that you expect to exist for any mod that installs files. It contains
- rradmincemeterysearch_ajx.php - An AJAX program that reads place component 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 component.
- 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.)
- The shared folder RR-shared_mod_includes_v12.0.0.4, which contains files that support functionality that is implemented in many of my mods:
- rrshared_modsettingsblocks4.php - Mod Settings Blocks
- img/rrshared_wikilogo.gif - An icon that links to a mod's TNG Wiki page from an Inner Mod Menu or Mod Settings Block
The shared folder is packaged with several mods, each of which may install some or all of its files. Once a file from this 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 generate any Mod Manager errors.
If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder, 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).
[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
The unmodified Admin Cemeteries Search page |
After Installation - Overview
[Show annotation]
[Hide annotation]
[Show annotation]
[Hide annotation]
Legend:
[Hide annotation]
|
Location Selection Controls
|
Field Buttons
See the Field Buttons Wiki article, or Open an annotated visualization here
[Hide details]
Buttons that would not change the current value are shaded out, as shown below.
Note that the Field Buttons mod must be installed for the field buttons to be visible, but it is not required for the mod to work. [Hide the Field Buttons visualization]
|
The Mod Options, in a Mod Settings Block
The Mod Settings Block for Admin Cemeteries Search (like most other Mod Settings Blocks) is at Admin>>Setup>>General Settings in a new subform named Robin's Mods. When Mod Settings Block are invoked from an Inner Mod Menu, the Admin>>Settings program automatically opens the subform and displays only the target Mod Settings Block, like this: |
The Admin Cemeteries Inner Mod Menu
The visibility of this Inner Mod Menu depends on the installation of the Show Inner Mod Menus, but that mod is not required. Because Admin Cemeteries Search has mod options in a Mod Settings Block, the Inner Mod Menu contains a link labeled "Change Mod Options", and that link opens the Mod Settings Block above. |
Sorting
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, none) multiplied by 3 options for the location sort key.
Custom CSS
I really hate to add style rules to genstyle.css because
- Other mods add dozens (upon dozens) of style rules to genstyle.css, and
- The rules added by mods are generally needed by only one or two programs.
- Besides, the more rules there are in genstyle.css, the more likely it is that rules will collide.
So, this mod adds an embedded stylesheet to admin_cemeteries.php, and uses Javascript to re-position it the DOM 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,
- (generally preferably) Adding new rules to your template's mytngstyle.css, which is 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.9d | 12.0+ | 26Feb2020 | No functional changes, but the infrastructure changes should make it worthwhile to install this version.
|
12.0.0.9b | 12.0+ | 26Feb2020 | No functional changes. Not a critical update unless you use TNGv12.3.
|
12.0.0.9 | 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 | [Show details]
[Hide details]
The controls are:
[Hide details]
|
Admin Cemeteries List v9.2.0.5 | 9.2.0 - 11.0 | 21 Mar 2016 | Converts new lines to <br> tags in the notes field; Depends on Show Mod Names 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.