Report Rows And Footer

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 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

• Is compatible with
  1. Bug Fix-Showreport PersonID
  2. Living Color Mod
  3. Public Access Control
  4. Reports Action Queries
• Is not compatible with
  1. Report Footer - But this mod provides equivalent functionality.
  2. 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.

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 does not install any files, but it does still have a mod subfolder, which contains the mod's language strings. That is, this mod's language strings are not defined in its .cfg file nor copied to cust_text.php files. As a result

• This mod's language strings are loaded only into the TNG programs that need them, not into all TNG programs, and
• It is easier to create, edit, test, and save translation for this mod than for mods that use standard cust_text.php strings.

This non-standard technique should be invisible to you unless you want to define a translation or override any of this mod's string values.
Read more about this technique, the simplified translation process, and the procedure for defining site-specific overrides to its language strings.

[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 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.

Fig.2 showreport.php AFTER 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.

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

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

Fig.5 showreport.php AFTER The "Side-by-Side Results tables" Options Multi-Column Options 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

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

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

Revision History

Mod Version	TNG Version	Date	Note
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:"
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 Generate multiple result tables that can float side-by-side if the screen is wide enough 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