Reports-Floating Results

From TNG_Wiki
Jump to: navigation, search

In TNGv12 and beyond, this mod uses the new guidelines for TNG v12+ cust_text.php files
If you are using TNGv12+, and any cust_text.php file in this mod is marked with a Bad Target error, you need to update your cust_text.php files before you can install this mod. [Show instructions]

If you upgraded to TNGv12+, and did not update your cust_text.php files as instructed in the upgrade readme script, then you must use the TNG Mod Manager to update them. To do so:

  1. Go to Mod Manager, and select its "Recommended Updates" tab.
    (If the "Recommended Updates" tab is not visible, then go to the Mod Manager Options tab, select "Display Settings", and turn on the "Recommended Updates" tab.)
  2. Click the "Update" button in the "Recommended Updates" tab.
    Installed mods do not interfere with the update, and if you already have (or think you may have) run this update, it will not hurt for you to run it again.

[See details in the TNGv12 Change Impacts Article][Hide the instructions]


Reports-Floating results
Summary Adds additional run-time options for reports. For details see revision history.
Validation
Mod Updated 25 Oct 2018
Download link v12.0.0.2
TNG 12.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 v12.0.0.2
Min TNG V 12.0
Max TNG V at least 12.0.2
Files modified
showreport.php, cust_text.php English
Related Mods
Notes


Purpose of the Mod

To provide flexibility in the display of TNG reports, 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. Indents the report description and SQL code for readability.
  2. Doesn't print the report "Description" label if there is no description.
  3. Omits the buttons, form fields, and the page navigation widget from the pretty-print display.
  4. Moves the "Matches i to j of n" message next to the page navigation buttons like most TNG search results.

Mod Parameters

All four Mod Parameter determine whether end-users (i.e. non-administrators) see certain options. All options are always available to site administrators. Mod Parameter 2-4 deal with new options, so it may be useful to review at least the first 4 Visualizations below before reading about the 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 hide them from end-users.
  3. $displayWrapOneTableOption (true). Even if the $showSideBySideOptions parameter is (true), the site administrator may want to hide option 4 (Wrap one table on each printed page), largely because it doesn't work in all browsers.
  4. $repeatrateParam (25). The option to repeat headings every so many lines can also be hidden from end users - in most circumstances. The "Repeat Headings" option is critical for the "Wrap one table on each printed page) option to work well, so is is always displayed if the user selection the "Wrap one table on each printed page) option.

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.
  • Reports-Floating Editor is similar in that is allows objects on the screen to float side-by-side on wider screens, but Reports-Floating Editor affects only the report editor, whereas this mod affects only showreport.php, which runs reports and shows results.
  • 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. [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

  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

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
v12.0.0.2 12.0 - 12.0.2+ 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 v11.0.0.1 11.1.1 English