Difference between revisions of "Headstones Report"

From TNG_Wiki
Jump to: navigation, search
(Revision History)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{construction
 
|notes=This mod is in a beta testing state. I've been using it for a while, but
 
* It needs to be tested on other TNG sites,
 
* I haven't completed the description below, and
 
* I haven't created the visualizations this article needs
 
 
In truth, I have over 40 new and updated mods in this state, and I'd appreciate whatever help that anyone can offer.
 
So it would be great if you could download the mod, test it, and let me know how it works for you.
 
And if you're up for it, screenshots from before the mod was installed and after (annotated or not) would be a great help.
 
You're welcome to insert in the article, or just email them to me.
 
My email username is '''mail'', and my email domain is robinrichmond.com.
 
 
Thanks in advance.
 
Robin Richmond 19:45, 2 April 2017 (CDT)
 
}}
 
 
{{TNGmod
 
{{TNGmod
 
| mod_name        =  Headstones Report
 
| mod_name        =  Headstones Report
|  mod_summary    =  Updates the list of cemeteries in the end-user Cemetery report, and in the showmap.php, which is called from the end-user Cemetery Report as well as from the places detail report.
+
|  mod_summary    =  Updates the list of cemeteries in the end-user Cemeteries and Headstones report and in the Cemetery Detailed report.
 
| mod_validation  =  
 
| mod_validation  =  
| download_link  = For {{Tv110}}[[Media:headstones_report_v11.0.0.1.zip|headstones_report_v11.0.0.1.zip]]  
+
| mod_last_update = 15 May 2018
 
+
| download_link  = <div>[[Media:headstones_report_v12.0.0.2.zip|v12.0.0.2.zip]]{{Tv120}}</div>
 +
<div>[[Media:headstones_report_v11.0.0.2.zip|v11.0.0.2]]{{Tv110}}</div>
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
Line 25: 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    = v11.0.0.1
+
| mod_version    = v11.0.0.2 & v12.0.0.2
 
| min_TNG_ver    = 11.0
 
| min_TNG_ver    = 11.0
| max_TNG_ver    = 11.0.2
+
| max_TNG_ver    = at least 12.0
 
|  TNG_file_list  = headstones.php, showmap.php, cust_text.php English, Dutch, & Norwegian
 
|  TNG_file_list  = headstones.php, showmap.php, cust_text.php English, Dutch, & Norwegian
 
| related_mods  = [[Show Mod Names]]
 
| related_mods  = [[Show Mod Names]]
 
| notes    =   
 
| notes    =   
 
}}
 
}}
 
+
== Purpose of the Mod ==
 +
This mod
 +
# Adds a tree column (when appropriate) to the Headstone Photos tables in headstones.php and showmap.php,
 +
# Can hide the Headstone Photos table from either or both programs, and
 +
# In the list of Cemeteries in headstones.php, it
 +
#* Adds the number of burials in the cemetery, and
 +
#* Allows more cemetery names to be displayed on one page.
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 +
|}
 +
More specifically:
  
|}
+
Both programs typically are invoked through a Cemetery Search screen that does not specify a tree, and can thus display results from more than one tree.  But the Headstone Photos tables in both programs omit any mention of the Tree that a person and photo belong to.  The mod adds a tree column, if the database has more than one tree and no tree has been selected.
 +
 
 +
Identical Headstone Photos tables are presented by both headstones.php and showmap.php, even though the end-user Cemetery search process runs headstones.php links directly to showmap.php.  That is, the end-user Cemetery search process starts with:
 +
# cemeteries.php, which
 +
#* Lets the user ''select'' a location (so really, it's not a "search" at all), and links
 +
# headstones.php, which
 +
#* Displays a paginated list of cemeteries, with only 5 cemeteries per page, because it
 +
#* Displays the cemetery's Headstones Photos table ''within'' the list of cemeteries.
 +
#* And then it lets the user select a cemetery, at which point, it calls
 +
# showmap.php, which
 +
#* Displays a map,
 +
#* Displays the Headstone Photos table for that cemetery (again), and
 +
#* Displays the All Burials table for that cemetery.
 +
(FWIW, showmap.php can also be called directly from the admin Cemetery search process, and from other places in TNG where a Cemetery is listed.)
 +
 
 +
Also, the native TNG code displays the headings for the Headstone Photos table for each cemetery, even if that cemetery does not have any headstone photos.
 +
 
 +
And, on TNG sites that do not track Headstone photos (or at least do not track many of them), the redundant display of the Headstone Photos table is even more problematic.
  
== Purpose of the Mod ==
+
So, this mod
Affects the list of cemeteries in headstones.php, and the Headstone Photos Table in headstones.php and showmap.php. In both programs, it
+
*# Does not display the Headstone Photos table headings unless a cemetery actually has headstone photos,
* Provides a mod parameter to control the display of the Headstone Photos table.
+
*# Offers a mod parameter for headstones.php that controls whether (and how) to display the Headstone Photos table,
In headstones.php, it:
+
*# Offers a mod parameter for showmap.php that controls whether (and how) to display the Headstones Photos table, and
*Formats the list of cemeteries differently,
+
*# Offers a mod parameter for headstones.php that controls how many cemeteries are to be displayed on one page (assuming that, if a site does have many headstone photos, the headstone photos tables don't take up much space, and it can display more than 5 cemeteries per page).
*Adds the burial count (and possibly a show/hide Headstones button) for each cemetery,
 
*Removes Headstone Photos column headings if there are no photos to display.</li>
 
*Displays "a to b of c items" before the page navigation widgets for both Cemeteries and Headstones.
 
*Provides a mod parameter to change the number of Cemeteries displayed on the page.
 
  
This mod is primarily, but not exclusively, for sites that don't track headstones<br />
+
In addition, this mod repositions the "a to b of c items" message for both Cemeteries and Headstones so that the screen layout is more like most other TNG programs that display such a message.
  
== Parameters ==
+
==Mod Parameters==
 
* In headstones.php - $headstonesButtonControl provides options that let you
 
* In headstones.php - $headstonesButtonControl provides options that let you
 
*# Never display the headstones table.
 
*# Never display the headstones table.
Line 60: Line 67:
  
 
# In showmap.php - $headstonesTableParam does the same thing for showmap.php that the $headstonesButtonControl parameter does for headstones.php.
 
# In showmap.php - $headstonesTableParam does the same thing for showmap.php that the $headstonesButtonControl parameter does for headstones.php.
 
== Mod Dependencies ==
 
This mod saves data that can be used by the [[Show Mod Names]] utility mod, but is ''not dependent on'' that mod.  I know of no dependencies on other mods.
 
  
 
== Compatibility with other Mods ==
 
== Compatibility with other Mods ==
 
No known incompatibilities, but ''please'' let me know if you encounter any.
 
No known incompatibilities, but ''please'' let me know if you encounter any.
  
==Requirements==
+
== Related Mods ==
 +
# The [[Burials-More Details]] mod makes several changes to the All Burials table in showmods.php, and, in a sense, coordinates with this mod, but they are not at all dependent on each other.
 +
* This mod saves data that can be used by the [[Show Mod Names]] utility mod, but is ''not dependent on'' that mod.
 +
 
 +
==Installation==
 +
===Requirements===
 
* A working TNG installation.
 
* A working TNG installation.
 
* An installed current version of the [[Mod Manager]].
 
* An installed current version of the [[Mod Manager]].
 
* You should backup files listed in the panel on the right.
 
* You should backup files listed in the panel on the right.
  
==Installation==
+
===Procedure===
 
# Remove and delete previous version of this mod.
 
# 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.  
 
# Backup the files updated by this mod.  They are listed in the panel at the upper right.  
Line 78: Line 87:
 
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]].
 
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]].
  
== In the event of a problem ==
+
===Problems?===
 
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
 
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
 
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].
 
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].
  
== Visualization of this Mod ==
+
== Visualizations ==
 
 
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
! <style="text-align:left;"> | XXX <span style="color: red">''' BEFORE:'''</span> XXX
+
| '''<span style='color:red;'>BEFORE:</span> The list of Cemeteries and Headstone Photos table in headstones.php'''<br>
|-
+
[[Image:headstones_report-before1.jpg]]
| [[Image:XXX-file_name_prefix-XXX-before.png]]
 
|-
 
! <style="text-align:left;"> | XXX <span style="color: red">'''AFTER:'''</span>
 
|-
 
| XXX
 
[[Image:XXX-file_name_prefix-after.png]]
 
 
|-  
 
|-  
| Note that ... XXX
+
| '''<span style='color:red;'>BEFORE:</span> The Headstone Photos table in showmap.php'''<br>
 +
[[Image:headstones_report-before2-showmap.jpg]]
 
|-
 
|-
! <style="text-align:left;"> | XXX <span style="color: red">''' BEFORE:'''</span>
+
| '''<span style='color:red;'>AFTER:</span> The list of Cemeteries and Headstone Photos tables in headstones.php'''<br>
 +
[[Image:headstones_report-after1.jpg]]
 
|-
 
|-
| XXX Note that...
+
| '''<span style='color:red;'>AFTER:</span> The Headstone Photos table in showmap.php'''<br>
[[Image:XXX-file_name_prefix-XXX-before2.png]]
+
[[Image:headstones_report-after2-showmap.jpg]]
|}
 
  
== Mod Change History ==
+
== Revision History ==
 +
*** The latest version of the mod is at the top of this table ***
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
+
! Mod Version !! TNG Version !! Date !! Note
! Mod Version
+
|-
! TNG Versions
+
| [[Media:headstones_report_v12.0.0.2.zip|12.0.0.2]]
! Date
+
| 12.0+
! Note
+
| 15 May 2018
 +
| No functional changes; made compatible with TNGv12.
 +
|-
 +
| 11.0.0.2
 +
| 11.0-11.1.2+
 +
| 21 Dec 2017
 +
| Added the tree information to the Headstones table in both programs, and removed the 100% width from the table in showmap.php. Other technical changes.
 
|-  
 
|-  
 
| 11.0.0.1
 
| 11.0.0.1
| 11.1.1
+
| 11.0-11.1+
 
| 2 Apr 2017
 
| 2 Apr 2017
 
| New mod.
 
| New mod.
Line 134: Line 144:
 
| v11.0.0.1
 
| v11.0.0.1
 
| 11.1.
 
| 11.1.
 +
| English
 +
|-
 +
| [http://www.kks-fam.net/ KK's Family History]
 +
| [[User:Kin_Khronicler|Kathy Kult]]
 +
| Public
 +
| v11.0.0.1
 +
| 11.1.1
 
| English
 
| English
 
|}
 
|}
  
 +
[[Category:Mods for TNG v12]]
 
[[Category:Mods for TNG v11]]
 
[[Category:Mods for TNG v11]]
 
[[Category:headstones.php mods]]
 
[[Category:headstones.php mods]]
 
[[Category:showmap.php mods]]
 
[[Category:showmap.php mods]]
 
[[Category:cust_text.php English mods]]
 
[[Category:cust_text.php English mods]]

Latest revision as of 18:22, 5 June 2018

Headstones Report
Summary Updates the list of cemeteries in the end-user Cemeteries and Headstones report and in the Cemetery Detailed report.
Validation
Mod Updated 15 May 2018
Download link
v12.0.0.2.zip
TNG 12.0
v11.0.0.2
TNG 11.0
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod v11.0.0.2 & v12.0.0.2
Min TNG V 11.0
Max TNG V at least 12.0
Files modified
headstones.php, showmap.php, cust_text.php English, Dutch, & Norwegian
Related Mods
Notes


Purpose of the Mod

This mod

  1. Adds a tree column (when appropriate) to the Headstone Photos tables in headstones.php and showmap.php,
  2. Can hide the Headstone Photos table from either or both programs, and
  3. In the list of Cemeteries in headstones.php, it
    • Adds the number of burials in the cemetery, and
    • Allows more cemetery names to be displayed on one page.

More specifically:

Both programs typically are invoked through a Cemetery Search screen that does not specify a tree, and can thus display results from more than one tree. But the Headstone Photos tables in both programs omit any mention of the Tree that a person and photo belong to. The mod adds a tree column, if the database has more than one tree and no tree has been selected.

Identical Headstone Photos tables are presented by both headstones.php and showmap.php, even though the end-user Cemetery search process runs headstones.php links directly to showmap.php. That is, the end-user Cemetery search process starts with:

  1. cemeteries.php, which
    • Lets the user select a location (so really, it's not a "search" at all), and links
  2. headstones.php, which
    • Displays a paginated list of cemeteries, with only 5 cemeteries per page, because it
    • Displays the cemetery's Headstones Photos table within the list of cemeteries.
    • And then it lets the user select a cemetery, at which point, it calls
  3. showmap.php, which
    • Displays a map,
    • Displays the Headstone Photos table for that cemetery (again), and
    • Displays the All Burials table for that cemetery.

(FWIW, showmap.php can also be called directly from the admin Cemetery search process, and from other places in TNG where a Cemetery is listed.)

Also, the native TNG code displays the headings for the Headstone Photos table for each cemetery, even if that cemetery does not have any headstone photos.

And, on TNG sites that do not track Headstone photos (or at least do not track many of them), the redundant display of the Headstone Photos table is even more problematic.

So, this mod

    1. Does not display the Headstone Photos table headings unless a cemetery actually has headstone photos,
    2. Offers a mod parameter for headstones.php that controls whether (and how) to display the Headstone Photos table,
    3. Offers a mod parameter for showmap.php that controls whether (and how) to display the Headstones Photos table, and
    4. Offers a mod parameter for headstones.php that controls how many cemeteries are to be displayed on one page (assuming that, if a site does have many headstone photos, the headstone photos tables don't take up much space, and it can display more than 5 cemeteries per page).

In addition, this mod repositions the "a to b of c items" message for both Cemeteries and Headstones so that the screen layout is more like most other TNG programs that display such a message.

Mod Parameters

  • In headstones.php - $headstonesButtonControl provides options that let you
    1. Never display the headstones table.
    2. Hide it behind a button.
    3. Show it, with a button that would hide it.
    4. Always show it, without a button
  • Also in headstones.php - $cemeteriesPerPage determines how many cemeteries will be listed on one screen (one web page). The "pristine" TNG code only provides for 5 cemeteries, but that value is driven by the likelihood that each cemetery will include headstone listings. If you don't track (or don't display) headstone records, then you can raise that value considerably.
  1. In showmap.php - $headstonesTableParam does the same thing for showmap.php that the $headstonesButtonControl parameter does for headstones.php.

Compatibility with other Mods

No known incompatibilities, but please let me know if you encounter any.

Related Mods

  1. The Burials-More Details mod makes several changes to the All Burials table in showmods.php, and, in a sense, coordinates with this mod, but they are not at all dependent on each other.
  • This mod saves data that can be used by the Show Mod Names utility mod, but is not dependent on that mod.

Installation

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, and 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.

Visualizations

BEFORE: The list of Cemeteries and Headstone Photos table in headstones.php

Headstones report-before1.jpg

BEFORE: The Headstone Photos table in showmap.php

Headstones report-before2-showmap.jpg

AFTER: The list of Cemeteries and Headstone Photos tables in headstones.php

Headstones report-after1.jpg

AFTER: The Headstone Photos table in showmap.php

Headstones report-after2-showmap.jpg

Revision History

      • The latest version of the mod is at the top of this table ***
Mod Version TNG Version Date Note
12.0.0.2 12.0+ 15 May 2018 No functional changes; made compatible with TNGv12.
11.0.0.2 11.0-11.1.2+ 21 Dec 2017 Added the tree information to the Headstones table in both programs, and removed the 100% width from the table in showmap.php. Other technical changes.
11.0.0.1 11.0-11.1+ 2 Apr 2017 New mod.

Sites using this mod

If you download and install this mod, please add your site to the table below.

URL User Note Mod-Version TNG-Version User-language
Robin Richmond's Genealogy Database Robin Richmond Mod developer v11.0.0.1 11.1. English
KK's Family History Kathy Kult Public v11.0.0.1 11.1.1 English