Changes

Jump to navigation Jump to search

Admin Reports Search (view source)

Revision as of 19:05, 28 March 2020

5,104 bytes added ,  19:05, 28 March 2020
mod v4b - shared mods library v5 & IMM what's new message
Line 1: Line 1:  
{{TNGmod
 
{{TNGmod
−
| mod_name        = Admin Reports List
+
| mod_name        = Admin Reports Search (formerly Admin Reports List)
−
|  mod_summary    = Adds two columns to the administration report selection list, and adds a "New Report Name" field directly on the report selection list screen.
+
|  mod_summary    = Adds search features and results table columns to the Admin>>Reports>>Search page, and tweaks the Admin>>Reports>>Edit form so that it can both edit existing reports and add new reports.
 
| mod_validation  =  
 
| mod_validation  =  
−
| download_link  = For {{Tv111}}{{Tv1010}}[[Media:admin_reports_list_v10.1.0.2.zip|admin_reports_list_v10.1.0.2.zip]]
+
| mod_last_update = 15 Dec 2019
−
(See the History below for v9.2.2.1)
+
| download_link  = [[Media:admin_reports_search_v12.0.0.4b.zip|v12.0.0.4b.zip]]{{Tv120}}
 +
<div class='font-size:90%;'>See the [[#Revision_History|Revision History]] for older versions</div>
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
−
| mod_url        = [http://robinrichmond.com/family/ Robin Richmond's Genealogy Database]
+
| mod_url        = ''this page''
 
| mod_contact    = [http://robinrichmond.com/family/mod_support.php My Mod Support form]
 
| mod_contact    = [http://robinrichmond.com/family/mod_support.php My Mod Support form]
 
| mod_support    = [http://robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
 
| mod_support    = [http://robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
−
| mod_version    = 10.1.0.2
+
| mod_version    = 12.0.0.4b
−
| min_TNG_ver    = 10.1.0
+
| min_TNG_ver    = 9.2.2
−
| max_TNG_ver    = 11.1 (at least)
+
| max_TNG_ver    = 12.3
−
|  TNG_file_list  = admin_reports.php<br />English cust_text.php
+
|  TNG_file_list  = admin_reports.php, admin_editreport.php, admin_addreport.php, English cust_text.php
−
| related_mods  = [[Reports Action Queries]], [[Floating Report Editor]], [[Reports Rows and Columns]]
+
<br>'''May Install''' rrshared_innermodmenu3.php, rrshared_modsettingsblocks3.php, rrshared_wikilogo.gif
 +
| related_mods  = [[Reports Action Queries]], [[Reports-Floating Editor]], [[Reports-Floating Results]]
 
| notes    =   
 
| notes    =   
 
}}
 
}}
−
 
+
== Purpose of the Mod ==
 +
To improve the usability of the Admin>>Reports>>Search page.
 +
* Changes to the search form:
 +
*# The Add New tab invokes the (enhanced) Edit Report form instead of the (now defunct) New Report form.
 +
*# An Add New ''button'' goes one step further, and uses the Search string as the initial Report Name.
 +
*# A new 'Result per Page' field lets you specify a value that is different from the TNG System Variable
 +
*# [[Field Buttons]] have been added to the Search string and to the Results Per Page Field
 +
* Adds four columns to the results table to provide more information about each report:
 +
*# # of Display fields in the report definition,
 +
*# # of Criteria elements in the report definition,
 +
*# # of Sort fields in the report definition, and
 +
*# A 'Direct SQL' column that indicates ''whether'' the report contains a direct SQL statement, and that displays the entire SQL query when you hover over a 'Yes' in the 'Direct SQL' column
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 
|}
 
|}
−
== Purpose of the Mod ==
+
== Mod Conflicts ==
−
To improve the usability of the Admin Reports List by
+
No known incompatibilities.  This mod is compatible with [[Reports Action Queries]] which is the only other published mod that claims to modify the Admin>>Reports>>Search page, and with [[Reports-Floating Editor]], which is the only other published mod that claims to modify Admin>>Reports>>Edit.
−
* Adding four columns:
  −
*# # of display fields in the report definition,
  −
*# # of criteria elements in the report definition,
  −
*# # of sort fields in the report definition, and
  −
*# A Direct SQL column that indicated whether the report contains a direct SQL statement.
  −
* Adding a hover effect in the new Direct SQL column that display the report's SQL statement, and
  −
* Adding a "New Report Name" field so that a separate (and mostly duplicative) Add New Report screen is no longer needed.  The Create Report button defines the report name, gives default values to all other fields, and takes you directly to the Report Edit screen.
     −
== Compatibility with other Mods ==
+
== Dependencies ==
−
No known incompatibilities.  This mod is compatible with [[Reports Action Queries]], (as I write this) is the only other published mod that modifies admin_reports.php.
+
This mod saves data that ''can be used by'' the utility mod [[Show Mod Names]], but is ''not dependent on''[[Show Mod Names]].
−
 
  −
== Mod Dependencies ==
  −
This mod saves data that can be used by the [[Show Mod Names]] utility mod, but is ''not dependent on''[[Show Mod Names]]
   
There are no known dependencies on other mods.
 
There are no known dependencies on other mods.
    
== Related Mods ==
 
== Related Mods ==
 
I have written three other mods that affect reports:
 
I have written three other mods that affect reports:
−
* [[Reports Action Queries]], which allows SQL Action Queries to be run in the TNG Reports system. It affects the Reports List (admin_reports.php) and showreport.php.
+
* [[Reports-Floating Editor]] makes better use of large computer screens when reports are being edited (at Admin>>Reports>>Edit).  It allows the blocks of ''form'' fields that build the report to float side-by-side on the computer screen so that more of them can be seen at once. It also can unclutter the screen a bit by hiding either the report-building fields or the direct SQL field, since they can't really be used together. [[Reports-Floating Editor]] affects only the Report Editor, admin_editreport.php.
−
* [[Reports Rows and Columns]], which allows narrow reports to be wrapped into side-by-side report columns so that more data can be seen on the screen or printed page. It affects only showreport.php.
+
* [[Reports Action Queries]] allows SQL Action Queries to be run in the TNG Reports system. It affects the Admin>>Reports>>Search page (admin_reports.php) and showreport.php.
−
* [[Reports-Floating Editor]], which makes better use of large computer screens in the Report Editor.  It allows the blocks of ''form'' fields that build the report to float side-by-side on the computer screen so that more of them can be seen at once. It also can unclutter the screen a bit by hiding either the report-building fields or the direct SQL field, since they can't really be used together. [[Reports-Floating Editor]] affects only the Report Editor, admin_editreport.php.
+
* [[Reports-Floating Results]] allows narrow reports to wrap into side-by-side report columns so that more data can be seen on the screen or printed page. It affects only showreport.php.
 
    
 
    
−
==Requirements==
+
== Visualizations ==
−
* A working TNG installation.
  −
* An installed current version of the [[Mod Manager]].
  −
 
  −
==Automated Installation==
  −
# 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.
  −
# Download the .zip file. Upload and Extract to the mods folder.
  −
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]] to install.
  −
 
  −
== In the event of a problem ==
  −
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
  −
# Contact me through [http://robinrichmond.com/family/mod_support.php My Mod Support form].
  −
 
  −
== Visualization of this Mod ==
  −
 
   
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
−
| style="vertical-align:top;" | '''<span style="color: red">BEFORE</span> The unmodified Admin Reports selection screen'''
+
| style="vertical-align:top;" | '''<span style="color:brown">BEFORE</span> The unmodified Admin>>Reports>Search screen'''
−
[[Image:admin_reports_list-before.png|size:80%]]
+
[[Image:admin_reports_search-before.jpg]]
 
|-  
 
|-  
−
| style="border:thin solid black;" | <span style="color: red">'''AFTER mod v1'''</span> Highlighting the new Create Report form, and the two new columns.
+
| style="border:thin solid black;" | '''<span style="color:brown">AFTER</span> Highlighting the new elements in the form and the results table'''
−
[[Image:admin_reports_list-after.png|size:80%]]
+
* The new 'Add New' button is disabled, since there is no value in the 'Search For' field. (The 'Add New' ''button'' has no benefit over the 'Add New' ''tab'' unless there is a search string.
 +
* The new 'Results per page' field whose default value is the TNG system parameter (or the last value you specified for this field.
 +
* Four new columns in the results table.
 +
* The 'Search for' and 'Results per page' fields have attached "field buttons", most of which are shaded out. See the [[Field Buttons]] mod and a visualization below.
 +
* The red words "Update Query" in this screen shot are a glimpse of the [[Reports Action Queries]] mod.
 +
[[Image:admin_reports_list-after.jpg]]
 
|-  
 
|-  
−
| style="border:thin solid black;" | <span style="color: red">'''AFTER mod v2'''</span> Highlighting the the two additional columns.
+
| style="border:thin solid black;" | '''<span style="color:brown">AFTER</span> Showing pop-up SQL Code'''
−
[[Image:admin_reports_list-after-v2.png]]
+
* The SQL code pops up when you hover over a cell in the Direct SQL? column.
 +
* It pops up right above the information about the record it applies to.
 +
* The width of the SQL code block varies with the page width, but at some widths, the SQL code block might be cut off on the left. When that happens, just drag the right edge of the browser window to make it a little bigger or smaller.
 +
[[Image:admin_reports_search-after-sql.jpg]]
 
|-  
 
|-  
−
| style="border:thin solid black;" | <span style="color: red">'''AFTER mod v2'''</span> Showing the Direct SQL query
+
| style="border:thin solid black;" | '''<span style="color:brown">AFTER</span> Field Buttons'''<br>
−
[[Image:admin_reports_list-after-v2-hover.png]]
+
If you have not installed the [[Field Buttons]] mod, the field buttons will not appear at all (even when they would otherwise be shaded out). The [[Field Buttons]] mod is completely optional.
 +
* The 'Search for' field can have an 'X' button and/or an 'R' button.
 +
** The 'X' button is visible when there is a search string. You can click it to clear the search string value.
 +
** The 'R' button is visible if the search string value has changed since the screen was loaded. You can click it to restore the initial value.
 +
* The 'Results per page' field can have 'R' 'D', and/or 'A' buttons.
 +
** The 'R' button works the same way as it does with the 'Search for' field.
 +
** The 'D' button is visible when the 'Results per page' value different from the TNG system parameter 'Max Search Results'. You can click it to set that default value.
 +
** The 'A' button is visible when the 'Results per page' value is not 'all' (which, as you would expect, that all of the search matches should be displayed on one page). You can click on it to set the value 'all'.
 +
See the [[Field Buttons]] Wiki article for more information.<br>
 +
[[Image:admin_reports_search-after-fieldbuttons.jpg]]
 
|}
 
|}
   −
== Mod Change History ==
+
== Installation ==
 +
=== Files Installed ===
 +
This mod is packaged with a mod subfolder that is shared with several other mods. The shared folder '''RR-shared_mod_includes_v12.0.0.3''' contains files that help to manage mod options in many of my mods:
 +
## '''rrshared_innermodmenu3.php''' - [https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner&nbsp;Mod&nbsp;Menus]
 +
## '''rrshared_modsettingsblocks3.php''' - [https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]
 +
## '''img/rrshared_wikilogo.gif''' - An icon that links to a mod's TNG Wiki page from an Inner Mod Menu or Mod Settings Block
 +
 
 +
Each mod that contains the shared folder may install some or all of its shared files, depending on whether those files already exist. Once a file from the shared folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence or absence generate any Mod Manager errors.
 +
 
 +
If you unzip mod distribution files directly into your mods folder, then the presence of the shared subfolder and the installation of its files should be invisible to you.  But if you generally ''copy'' mod subfolders to your mods folder after you have unzipped the distribution file, then you need to make sure to copy the folder '''RR-shared_mod_includes_v12.0.0.3''' (well, unless you are confident that it is already in your mods folder because it was part of another mod).{{RobinInstallationBoilerplate}}
 +
 
 +
== Revision History ==
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
−
|-
+
! Mod Version !! TNG Version !! Date !! Note
−
! Mod Version
+
|- style="vertical-align:top;"  <!-- ############################################################## -->
−
! TNG Version
+
|[[Media:admin_reports_search_v12.0.0.4b.zip|12.0.0.4b]]
−
! Date
+
| 12.0 - 12.3
−
! Note
+
| 28Mar2020
−
|-  
+
| This is a very minor change, with no changes to the functionality of the Admin Reports search page. This version updates the mod to version 5 of my shared mod include files. It also displays a "What has changed" message for this mod in the Admin Reports Search Inner Mod Menu.
−
| 9.2.2.1 [[Media:admin_reports_list_v9.2.2.1.zip|download]]
+
 
−
| 9.2.2 - 10.1 (at least; I believe it works at least through TNGv11.1)
+
|- style="vertical-align:top;"  <!-- ############################################################## -->
−
| 17 Jan 2015
+
|[[Media:admin_reports_search_v12.0.0.4a.zip|12.0.0.4a]]
−
| Initial release.
+
| 12.0 - 12.2+
−
|-
+
| 15Dec2019
−
| 10.1.0.1
+
| No Functional Changes - Upgraded to version 3 of the shared mod libraries
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
|[[Media:admin_reports_search_v12.0.0.4.zip|12.0.0.4]]
 +
| 12.0 - 12.2+
 +
| 2Oct2019
 +
| Added field buttons and the inner mod menu
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| [[Media:admin_reports_search_v11.0.0.3.zip|11.0.0.3]], [[Media:admin_reports_search_v12.0.0.3.zip|12.0.0.3]]
 +
| 11.*, 12.0+
 +
| 13May2018
 +
| Restored the normal 'Add New' tab, removed the 'Add New' button from earlier versions, and brought a copy of the mod into compliance with TNGv12.
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| Admin Reports List 10.1.0.1
 
| 10.1-11.1 (at least; I believe that it should work for TNGv9 and TNGv10.0)
 
| 10.1-11.1 (at least; I believe that it should work for TNGv9 and TNGv10.0)
−
| 4 May 2017
+
| 4May2017
 
| Visible changes:
 
| Visible changes:
 
# Added 2 more display columns: The # of criteria elements, and the # of display fields,
 
# Added 2 more display columns: The # of criteria elements, and the # of display fields,
Line 99: Line 129:  
# Added (optional) Show Mod Names functionality
 
# Added (optional) Show Mod Names functionality
 
# Changed admin_addreport.php, which creates a new report, so that it redirects to the report editor rather than to back to the search page.  
 
# Changed admin_addreport.php, which creates a new report, so that it redirects to the report editor rather than to back to the search page.  
 +
|- style="vertical-align:top;"  <!-- ############################################################## -->
 +
| 9.2.2.1 [[Media:admin_reports_list_v9.2.2.1.zip|download]]
 +
| 9.2.2 - 10.1 (at least; I believe it works at least through TNGv11.1)
 +
| 17Jan2015
 +
| Initial release.
 
|}
 
|}
   Line 116: Line 151:  
| [[User:Robinrichm|Robin Richmond]]
 
| [[User:Robinrichm|Robin Richmond]]
 
| Mod developer
 
| Mod developer
−
| 9.2.2.1
+
| 12.0.0.3b
−
| 10.0.3
+
| 12.0
 
| English
 
| English
 
|-
 
|-
Line 134: Line 169:  
| Dutch, English
 
| Dutch, English
 
|}
 
|}
−
[[Category:Mods for TNG v9]]
   
[[Category:Mods for TNG v10]]
 
[[Category:Mods for TNG v10]]
 +
[[Category:Mods for TNG v11]]
 +
[[Category:Mods for TNG v12]]
 
[[Category:admin_reports.php mods]]
 
[[Category:admin_reports.php mods]]
−
[[Category:cust_text.php mods]]
+
[[Category:cust_text.php English mods]]
Robinrichm
'''Experienced'''
5,069

edits

Retrieved from "https://tng.lythgoes.net/wiki/index.php/Special:MobileDiff/43355...58885"

Navigation menu