Admin Reports Floating Editor

From TNG_Wiki
Jump to navigation Jump to search
Admin Reports Floating Editor
Summary Modifies the layout of the report edit form at Admin>>Reports>>Edit.
Validation
Mod Updated 30 Oct 2021
Download link Admin Reports Floating Editor v13.0.0.6c
TNG 13.0
See the Revision History for older versions
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.6c
Min TNG V 12.0
Max TNG V 13.1
Files modified
admin_editreport.php
Related Mods
Notes

Purpose of the Mod

To improve the usability of the Report Editor by hiding blocks of fields as appropriate, and allowing blocks of fields to float side-by side on a wide screen.

In particular, the mod

  1. Recognizes whether there are report-builder elements or a SQL query, and hides the form fields that are not needed.
    • For reports generated by the report-builder features, the mod can save users a great deal of up-and-down scrolling on wide browser windows by allowing the Report Editor's three element-selection widgets - "Choose Fields to Display", "Choose Criteria", and "Choose Sort Fields" - to float side-by side.
    • For SQL queries, the SQL query textarea box is enlarged considerably
  2. Generates buttons that allow users to run the current query without exiting the editor.
    • The current query must be saved before it can be run. That's no big deal if you know that you have no more changes to make to the query. But if you expect to edit it more than once or twice before you get it working just the way want, it can be very handy to run the query from within the editor.
    • The query is executed (by showreport.php) in a pop-up window. As a result, you can see the report definition and the report at the same time.
      • Depending on how your windows are laid out on your screen, if you click on the editor window after displaying the pop-up report results, the results may be hidden behind the editor's browser window. But that's ok. You should be able to use alt-tab (on a PC) to bring the pop-up window back into focus, or you can just run the report again, in which case, the report will pop-up in front again.
    • Just in case a report happens to have a report-builder definition and a SQL statement, there are distict "Run the Report" buttons for each type of report.
      • (If you use the Reports Search page to execute a report that has with both types of report definitions buttons that execute the

Developer

This mod was developed by Robin Richmond.

Mod Options

None

Conflicts

No conflicts. No other published mods target the Report Editor.

Related Mods

Installation

{{{language}}}


[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 screen shots were taken from versions 5 and 6 of this mod. Version 7 changes the user interfaces a bit but does not change the fundamental (Admin Reports Floating{| border="1" cellspacing="1" cellpadding="2" class="wikitable" |- | BEFORE Requires considerable vertical scrolling | AFTER If the report has a SQL statement and no report-builder field values, the report-builder-fields are hidden. Note the message and button in the enlarged inset. |- | Floating report editor-before.png | style="vertical-align:top;" | Floating report editor-after-sql.png |- | colspan="2"| AFTER If the report has report-builder field values and no SQL statement, the SQL statement field is hidden. This visualization is on a screen wide enough for the three report-builder fieldsets to float side-by-side. Note the message and button in the enlarged inset. |- | colspan="2" | Floating report editor-after-builder.png |- | colspan="2" | AFTER If the report is empty or has report-builder field values AND a SQL statement. This visualization is on a screen only wide enough for two fieldsets to float side-by-side. A narrower screen would look like the BEFORE visualization. Note the message and button in the enlarged inset. |- | colspan="2" | Floating report editor-after-2x2.png |}

Issues

  • With Mozilla Firefox, at certain browser widths, and when all 4 fieldsets are displayed, the direct SQL entry field can float to the right and part of the way off the screen. This can be corrected by hiding the SQL field, or the report-builder fields, or by adjusting the width of the browser window.
  • When the save buttons land in awkward places, the display can usually be fixed by slight changes to the browser window width.

Language Strings

As noted above, this mod's language strings are defined, distributed and files in its mod subfolder rather than in its .cfg file. TNG programs affected by this mod then load language strings from those mod subfolder files rather than from cust_text.php files. This non-standard technique for handling language strings has several advantages, including that

  1. It loads language strings only into the pages that need them rather than into all TNG pages, and
  2. It simplifies the process of defining and editing translations.

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.


Revision History

Mod Version TNG Version Date Contents
Admin Reports Floating Editor v13.0.0.6c 13.0-13.1 30 Oct 2021 Upgraded to TNGv13.1, added Michel Kirsch's French translation, and made numerous user interface tweaks
Admin Reports Floating Editor v13.0.0.6a 13 22 Nov 2020 Upgraded to TNGv13; fixed a problem with the zip file
Reports-Floating Editor 12.0.0.6 12.0 - 12.0.2+ 21 Dec 2018 - In admin_reports.php, the Add New tab invokes admin_editreport.php

- admin_editreport.php now can start the record from scratch when it is not given a reportID.
- made compatible with TNGv12.

11.0.0.5p 10.1.0-11.1.2+ 07 Nov 2017 Removed the second line from the cust_text.php target location search string
11.0.0.5a 11.0.0+ 29 May 2017 New name; previously Floating Report Editor.
  • Wrapped "save as copy" checkbox in a no-word-wrap label element - thus both keeping it from wrapping, and allowing a click on the text to check the box
  • Added a "Run Report" button that does the the same as the "test" button in the search results table in admin_reports.php; that is, it launches showreport.php in a new window.
  • The [Show Mod Names]] mod is now optional

Sites using this mod

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

URL User Note Mod-Version TNG-Version User-language
Robin Richmond's Genealogy Database Robin Richmond Mod developer 13.0.0.6a 13 EN
Wortelboer Genealogy Bernard Wortelboer 11.0.0.4 11.0.0 NL,EN
DJCM.DK Claus Martinussen 11.0.0.4 11.0.0 DA,EN
On local site, for development Michel Kirsch Life is easier with this mod ! Waiting for a V14 version... V$14.1.0.6c-mk TNG 14.1.0 FR,EN,DE,NL
Martius family Hendrik Martius Half public 11.0.0.5p 12.0.1 DE,EN,FR,NL
Bastiaanssen Genealogy Jan Bastiaanssen Public / Private 13.0.0.6c 13.1.2 NL,EN,ES
Retrieved from "https://tng.lythgoes.net/wiki/index.php?title=Admin_Reports_Floating_Editor&oldid=89928"