Difference between revisions of "Report Rows And Footer"

From TNG_Wiki
Jump to navigation Jump to search
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
 
+
{{construction | notes=This article is being updated to accommodate the latest version this mod, Report Rows and Footer v13.0.0.3. (If you still see this message after March 28 or so, '''please let me know'''.<br>Robin Richmond 25 Mar 2020}}  
−
{{construction
 
−
|notes=This mod is in a beta testing state. I've been using it for a while, in TNGv11.1, 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 anyone can offer.
 
−
So, it would be great if you could download the mod 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 edit the Wiki article, or just email them to me.
 
−
My email username is '''mail'', and my email domain is robinrichmond.com.
 
−
 
 
−
Thanks in advance.
 
−
[[User:Rmcrae|Rmcrae]] ([[User talk:Rmcrae|talk]]) 18:21, 15 May 2017 (CDT)
 
−
}}
 
 
{{TNGmod
 
{{TNGmod
−
| mod_name        =  Reports Rows And Columns
+
| mod_name        =  Reports Rows And Footer
−
|  mod_summary    = Adds run-time options for reports to control the number of data rows displayed on a page and provide for multiple side-by-side HTML tables for narrow reports. Also does just a little reformatting.  
+
|  mod_summary    = Adds a "results per page" field to the Show Report page, provides for a report footer (in TNGv13), and allows more rows from narrow reports to be displayed by showing two results tables side-by-side.
 
| mod_validation  =  
 
| mod_validation  =  
−
| download_link  =  For {{Tv110}}  
+
| mod_last_update = 25 Mar 2021
−
<br />
+
| download_link  =  [[Media:report_rows_and_footer_v13.0.0.3.zip|Report Rows And Footer v13.0.0.3]]{{Tv130}}
−
[[Media:reports_rows_and_columns_v11.0.0.1.zip|reports_rows_and_columns_v11.0.0.1.zip]]
+
<div style='clear:both;'>[[Media:reports_floating_results_v12.0.0.2.zip|Reports-Floating Results v12.0.0.2]]{{Tv120}}
 +
<div style='clear:both;font-size=90%;'>See the [[#Revision_History|Revision History]] for more details</div>
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
−
| mod_url        = [http://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
+
| mod_url        = [https://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
−
| mod_contact    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
+
| mod_contact    = [https://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    = [https://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
−
| mod_version    = 11.0.0.1
+
| mod_version    = v13.0.0.3
−
| min_TNG_ver    = 11.0.0
+
| min_TNG_ver    = 12.0
−
| max_TNG_ver    = at least 11.1
+
| max_TNG_ver    = at least 13.0.3
 
|  TNG_file_list  = showreport.php,  cust_text.php English  
 
|  TNG_file_list  = showreport.php,  cust_text.php English  
 
| related_mods  =  
 
| related_mods  =  
 
| notes    =   
 
| notes    =   
 
}}
 
}}
−
 
+
== Purpose of the Mod ==
 +
To provide flexibility in the display of TNG reports, this mod allows the report description to define report footer, and adds run-time options for reports to
 +
# Control the number of result rows displayed on a page, and
 +
# Allow for multiple side-by-side HTML tables, so that more data from narrow reports can be shown on the screen.
 +
The report display program also now
 +
# No longer displays the label "Description" in front of the description.
 +
# Initially displays a snippet of the SQL statement, with a "more..." link.
 +
# Moves the "Matches i to j of n" message ''next to'' the page navigation buttons like most TNG search results.
 +
# Omits the buttons, form fields, page navigation, and SQL statement from the format-for-printing page.
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 
|}
 
|}
 +
'''Defining a Footer'''
 +
In TNGv13, if you define an HTML element with id='thisReportFooter' in the report description, that element will be displayed as a report footer.
  
−
== Purpose of the Mod ==
+
== Mod Parameters ==
−
Adds run-time options for reports to control the number of data rows displayed on a page and provide for multiple side-by-side HTML tables for narrow reports. Also does just a little reformatting.
+
There are three classic mod parameters.
−
# This program has been modified by the Reports Rows And Columns mod to:
+
# $displayCSVLink (true) determines whether to show the CSV Download load link to end-users. This mod effectively implements the functionality of the [[CSV Reports for Admin only]] mod, which conflicts with this mod.
−
# - Provide a "Results per page" parameter that defaults to the system setting.
+
# $showSideBySideOptions (true). The options that control side-by-side report tables can be a bit confusing, and they only work for fairly narrow tables. As a result, some TNG administrators may want to
−
# - Provide a "Columns" parameter that allows narrow reports to be wrapped into multiple tables
+
# $repeatrateParam (25). Provides the default value for the run-time option "Repeat headings every nnn rows:". A value of zero simply means "Do not dispay extra headings".
−
# - Indent the report description and SQL code for readability.
 
−
# - Don't print the report description label if there is no description.
 
−
# - Omit the buttons and form fields from the pretty-print display.
 
  
−
== Parameters ==
+
== Compatibility ==
 +
Among the published mods that change showreport.php, this mod
 +
* Is compatible with
 +
*# [[Bug Fix-Showreport PersonID]]
 +
*# [[Living Color Mod]]
 +
*# [[Public Access Control]]
 +
*# [[Reports Action Queries]]
 +
* Is not compatible with
 +
*# [[Report Footer]] - But this mod provides equivalent functionality.
 +
*# [[CSV Reports for Admin only]]. However, when the first Mod Parameter described above is set to False, this mod implements the functionality of [[CSV Reports for Admin only]] - that is, it hides the CSV download link from non-admins.
  
−
== Compatibility with other Mods ==
+
== Related Mods ==
−
No known incompatibilities, but ''please'' let me know if you encounter any.
+
* This mod uses "Field Buttons", which are visible only if the '''''optional''''' [[Field Buttons]] mod is installed.
 +
* This mod saves data that ''can'' be used by the [[Show Mod Names]] utility mod, but is '''not dependent on'''' [[Show Mod Names]].
  
−
== Mod Dependencies ==
+
== Installation ==
−
This mod saves data that can be used by the [[Show Mod Names]] utility mod, but is ''not dependent on'' [[Show Mod Names]].
+
This mod uses the standard installation procedure.
−
There are no other strict dependencies on other mods.
+
{{RobinBoilerplate | text=language}}
 +
{{RobinBoilerplate | text=install}}
  
−
==Requirements==
+
== Visualizations ==
−
* A working TNG installation.
+
'''These visualizations apply to the 'Reports-Floating Results' in TNGv12.'''
−
* An installed current version of the [[Mod Manager]].
+
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
−
* You should backup files listed in the panel on the right.
+
|-
 +
| style="border:thin solid black;vertical-align:top;" | Fig.1 '''showreport.php <span style="color:
 +
red"> BEFORE</span>'''
 +
# The report description indentation and wrapping are a little odd
 +
# There is a big gap between the report description and the SQL statement
 +
# The SQL statement wraps differently from the report description
 +
# The entire SQL statement is probably not always needed
 +
# The "Matches i to j of n" message is not adjacent to the page navigation buttons like it is in most TNG pages.
 +
[[Image:reports-floating_results-before1.jpg]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" | Fig.2 ''' showreport.php <span style="color: red"> AFTER</span>'''
 +
# The description and SQL query now wrap with indentation, and only part of the SQL code is show, with a like to show more.
 +
# There is a new "Results per page" field, with field buttons (see the [[Field Buttons]] mod)
 +
# A "Side-by-Side Results Tables" button provides options to place two or more (relatively narrow) results tables side-by-side.
 +
# There is a new option to "Repeat headings every" so many lines.  For long tables, it is sometimes useful to redisplay the table headings so that the headings are always visible.  
 +
# * The "Matches i to j of n" message ''is'' now adjacent to the page navigation buttons like it is in most TNG pages.
 +
[[Image:reports-floating_results-after2.jpg]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" | Fig.3 '''showreport.php <span style="color: red"> AFTER</span>''', focusing on the SQL code<br/>
 +
[[Image:reports_rows_and_columns-after-sql.png]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" | Fig.4 '''showreport.php <span style="color: red"> AFTER </span> ''' This screen clip combines TNG's "Pretty-print" mode and the Print Preview function in a web browser to illustrate that
 +
# The "Comma-delimited CSV file" button is suppressed in "Pretty-print" mode,
 +
# The page navigation buttons are now suppressed in "Pretty-print" mode,
 +
# If the Web page requires more than one printed page, the column headings are now repeated on each printed page.
 +
[[Image:reports-floating_results-after3-pages.png]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" | Fig.5 '''showreport.php <span style="color: red"> AFTER </span>''' The "Side-by-Side Results tables" Options Multi-Column Options<br/>
 +
# In the 'Single Result table' box (Option 1), the "Results per page" option is exactly the same field as the "Results per page" option on the simpler screen.
 +
# There is a "Fewer Options" button to get back to the simpler screen without the side-by-side options.
 +
# In the "Floating side-by-side tables" box (Option 2 and 3), there are two ways to specify how many result rows appear in each table when you have side-by-side tables.
 +
#* Option 2 takes the "Results per page" option from the simpler screen, and divides that many results into the number of side-by-side results tables that you want.
 +
#* Option 3 presumes that you wan the as you
 +
[[Image:reports-floating_results-fig5.jpg]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" |
 +
Sometimes it is better to generate results tables that float, using options . Other times it is better to use HTML <columns> tag to squeeze down the report columns a bit, forcing the results to be formatted into side-by-side results tables. See the visualizations below for a description of the differences between the options that "Allow the result tables to float" and that <i>"Force</i> side-by-side results tables.
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" |'''showreport.php <span style="color: red"> AFTER </span>Two results tables ''floating'' side-by-side'''<br/>
 +
If 'A' (i.e. 'all') were selected for the number of results per page, the
 +
[[Image:reports-floating_results-after5-2col.png]]
 +
|-
 +
| style="border:thin solid black;vertical-align:top;" | '''showreport.php The "Force side-by-side results tables" option <span style="color: red"> AFTER:</span>'''<br/>
 +
[[Image:reports-floating_results-after6-repeat.png]]
 +
|}
  
−
==Installation==
+
== Revision History ==
−
# Remove and delete previous version of this mod.
+
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
−
# Backup the files updated by this mod. They are listed in the panel at the upper right.  
+
! Mod Version !! TNG Version !! Date !! Note
−
# Download the .zip file, and extract its .cfg file to the mods folder.
+
|- style="vertical-align:top;"
−
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]].
+
| [[Media:report_rows_and_footer_v13.0.0.3.zip|Report Rows And Footer v13.0.0.3]]
 +
| 13.0 - 13.0.3
 +
| 25 Mar 2021
 +
|
 +
# Made compatible with TNGv3
 +
# Added the ability to define a footer.
 +
# Removed some side-by-side table options that browsers no longer support.
 +
# Removed the label "Description:"
  
−
== In the event of a problem ==
+
|- style="vertical-align:top;"
−
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
+
|[Media:reports_floating_results_v12.0.0.2.zip|Reports-Floating Results v12.0.0.2]]{
−
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].
+
| 12.0 - 12.3
 +
| 11-Dec-2018
 +
|
 +
Made compatible with TNGv12<br>
 +
Adds run-time options for reports to
 +
<ol style='margin-top:0;margin-bottom:0l'>
 +
<li>Generate multiple result tables that can float side-by-side if the screen is wide enough
 +
<li>Control the number of rows in each table</li>
 +
</ol>
  
−
== Visualizations ==
+
|- style="vertical-align:top;"
−
none yet
+
| [[Media:reports-floating_results_v11.0.0.2.zip|11.0.0.2]]
−
 
+
| 11.0+
−
== Mod Change History ==
+
| 15-May-2017
−
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
+
|
−
|-
+
: - Removed the second line from the cust_text.php target location search string
−
! Mod Version
+
: - Implemented Field Buttons for the Rows Per Page fields
−
! TNG Versions
+
: - Added several options to format and display tables
−
! Date
+
: - Changed the prompts for the new display parameters
−
! Note
 
 
|-  
 
|-  
−
| 11.0.0
+
| 11.0.0.1
−
| 11.0.0 and up
+
| 11.0+
 
| 15-May-2017
 
| 15-May-2017
 
| New mod.
 
| New mod.
Line 104: Line 166:
 
| [[User:Robinrichm|Robin Richmond]]
 
| [[User:Robinrichm|Robin Richmond]]
 
| Mod developer
 
| Mod developer
−
| reports_rows_and_columns_v11.0.0.1
+
| v12.0.0.2
−
| 11.1
+
| 12.3
 
| English
 
| English
 
|}
 
|}
  
−
 
+
[[Category:Mods for TNG v13]]
 +
[[Category:Mods for TNG v12]]
 
[[Category:Mods for TNG v11]]
 
[[Category:Mods for TNG v11]]
 
[[Category:showreport.php mods ]]
 
[[Category:showreport.php mods ]]
 
[[Category:Cust text.php English mods]]
 
[[Category:Cust text.php English mods]]

Latest revision as of 10:51, 25 March 2021

Construction This article is being updated to accommodate the latest version this mod, Report Rows and Footer v13.0.0.3. (If you still see this message after March 28 or so, please let me know.
Robin Richmond 25 Mar 2020 		Construction


Reports Rows And Footer
Summary Adds a "results per page" field to the Show Report page, provides for a report footer (in TNGv13), and allows more rows from narrow reports to be displayed by showing two results tables side-by-side.
Validation
Mod Updated 25 Mar 2021
Download link Report Rows And Footer v13.0.0.3
TNG 13.0
Reports-Floating Results v12.0.0.2
TNG 12.0
See the Revision History for more details
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 v13.0.0.3
Min TNG V 12.0
Max TNG V at least 13.0.3
Files modified
showreport.php, cust_text.php English
Related Mods
Notes


Purpose of the Mod

To provide flexibility in the display of TNG reports, this mod allows the report description to define report footer, and adds run-time options for reports to

  1. Control the number of result rows displayed on a page, and
  2. Allow for multiple side-by-side HTML tables, so that more data from narrow reports can be shown on the screen.

The report display program also now

  1. No longer displays the label "Description" in front of the description.
  2. Initially displays a snippet of the SQL statement, with a "more..." link.
  3. Moves the "Matches i to j of n" message next to the page navigation buttons like most TNG search results.
  4. Omits the buttons, form fields, page navigation, and SQL statement from the format-for-printing page.

Defining a Footer In TNGv13, if you define an HTML element with id='thisReportFooter' in the report description, that element will be displayed as a report footer.

Mod Parameters

There are three classic mod parameters.

  1. $displayCSVLink (true) determines whether to show the CSV Download load link to end-users. This mod effectively implements the functionality of the CSV Reports for Admin only mod, which conflicts with this mod.
  2. $showSideBySideOptions (true). The options that control side-by-side report tables can be a bit confusing, and they only work for fairly narrow tables. As a result, some TNG administrators may want to
  3. $repeatrateParam (25). Provides the default value for the run-time option "Repeat headings every nnn rows:". A value of zero simply means "Do not dispay extra headings".

Compatibility

Among the published mods that change showreport.php, this mod

Related Mods

  • This mod uses "Field Buttons", which are visible only if the optional Field Buttons mod is installed.
  • This mod saves data that can be used by the Show Mod Names utility mod, but is not dependent on' Show Mod Names.

Installation

This mod uses the standard installation procedure.

This mod includes a typical mod subfolder, with the same base name as the mod's .cfg file. The subfolder is atypical in that no files in it are installed to working TNG folders. However, it does contain critical files that contain the mod's language strings, which the mod does not add to standard cust_text.php files. Instead, the PHP code modified by this mod loads the language strings from files in the mod's languages/ subfolder. Read more about this technique.

[Show Standard Installation Process]

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Procedure

  1. Remove and delete previous version of this mod.
  2. Backup the files updated by this mod. They are listed in the panel at the upper right.
  3. Download the .zip file, Extract its .cfg file to the mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

Problems?

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.
[Hide Details]

Visualizations

These visualizations apply to the 'Reports-Floating Results' in TNGv12.

Fig.1 showreport.php BEFORE
  1. The report description indentation and wrapping are a little odd
  2. There is a big gap between the report description and the SQL statement
  3. The SQL statement wraps differently from the report description
  4. The entire SQL statement is probably not always needed
  5. The "Matches i to j of n" message is not adjacent to the page navigation buttons like it is in most TNG pages.

Reports-floating results-before1.jpg

Fig.2 showreport.php AFTER
  1. The description and SQL query now wrap with indentation, and only part of the SQL code is show, with a like to show more.
  2. There is a new "Results per page" field, with field buttons (see the Field Buttons mod)
  3. A "Side-by-Side Results Tables" button provides options to place two or more (relatively narrow) results tables side-by-side.
  4. There is a new option to "Repeat headings every" so many lines. For long tables, it is sometimes useful to redisplay the table headings so that the headings are always visible.
  5. * The "Matches i to j of n" message is now adjacent to the page navigation buttons like it is in most TNG pages.

Reports-floating results-after2.jpg

Fig.3 showreport.php AFTER, focusing on the SQL code

Reports rows and columns-after-sql.png

Fig.4 showreport.php AFTER This screen clip combines TNG's "Pretty-print" mode and the Print Preview function in a web browser to illustrate that
  1. The "Comma-delimited CSV file" button is suppressed in "Pretty-print" mode,
  2. The page navigation buttons are now suppressed in "Pretty-print" mode,
  3. If the Web page requires more than one printed page, the column headings are now repeated on each printed page.

Reports-floating results-after3-pages.png

Fig.5 showreport.php AFTER The "Side-by-Side Results tables" Options Multi-Column Options
  1. In the 'Single Result table' box (Option 1), the "Results per page" option is exactly the same field as the "Results per page" option on the simpler screen.
  2. There is a "Fewer Options" button to get back to the simpler screen without the side-by-side options.
  3. In the "Floating side-by-side tables" box (Option 2 and 3), there are two ways to specify how many result rows appear in each table when you have side-by-side tables.
    • Option 2 takes the "Results per page" option from the simpler screen, and divides that many results into the number of side-by-side results tables that you want.
    • Option 3 presumes that you wan the as you

Reports-floating results-fig5.jpg

Sometimes it is better to generate results tables that float, using options . Other times it is better to use HTML <columns> tag to squeeze down the report columns a bit, forcing the results to be formatted into side-by-side results tables. See the visualizations below for a description of the differences between the options that "Allow the result tables to float" and that "Force side-by-side results tables.

showreport.php AFTER Two results tables floating side-by-side

If 'A' (i.e. 'all') were selected for the number of results per page, the Reports-floating results-after5-2col.png

showreport.php The "Force side-by-side results tables" option AFTER:

Reports-floating results-after6-repeat.png

Revision History

Mod Version TNG Version Date Note
Report Rows And Footer v13.0.0.3 13.0 - 13.0.3 25 Mar 2021
  1. Made compatible with TNGv3
  2. Added the ability to define a footer.
  3. Removed some side-by-side table options that browsers no longer support.
  4. Removed the label "Description:"
Reports-Floating Results v12.0.0.2]]{ 12.0 - 12.3 11-Dec-2018

Made compatible with TNGv12
Adds run-time options for reports to

  1. Generate multiple result tables that can float side-by-side if the screen is wide enough
  2. Control the number of rows in each table
11.0.0.2 11.0+ 15-May-2017
- Removed the second line from the cust_text.php target location search string
- Implemented Field Buttons for the Rows Per Page fields
- Added several options to format and display tables
- Changed the prompts for the new display parameters
11.0.0.1 11.0+ 15-May-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 v12.0.0.2 12.3 English
Retrieved from "https://tng.lythgoes.net/wiki/index.php?title=Report_Rows_And_Footer&oldid=66567"