Difference between revisions of "Admin Branches"
Robinrichm (talk | contribs) |
Robinrichm (talk | contribs) |
||
Line 67: | Line 67: | ||
#** The Branch edit program (admin_editbranch.php) to display counts for the current branch, and | #** The Branch edit program (admin_editbranch.php) to display counts for the current branch, and | ||
#** rradminbranches_ajx.php to retrieve updated counts after admin_editbranch.php has modified a branch. | #** rradminbranches_ajx.php to retrieve updated counts after admin_editbranch.php has modified a branch. | ||
− | # The shared folder '''RR-shared_mod_includes_v12.0.0.2''', which contains files that support [ | + | # The shared folder '''RR-shared_mod_includes_v12.0.0.2''', which contains files that support [https://tng.lythgoes.net/wiki/index.php?title=Inner_Mod_Menus Inner Mod Menus] and [https://tng.lythgoes.net/wiki/index.php?title=Mod_Settings_Blocks Mod Settings Blocks]. |
#* '''rrshared_innermodmenu2.php''' | #* '''rrshared_innermodmenu2.php''' | ||
#* '''rrshared_modsettingsblocks2.php''' | #* '''rrshared_modsettingsblocks2.php''' |
Revision as of 22:06, 26 November 2019
Admin Branches | ||
---|---|---|
Summary | Modifies the Admin>>Branches search page to display counts of People and Families in the branch index, as well as count of People and Families records that have the branch. | |
Validation | ||
Mod Updated | 26 Nov 2019 | |
Download link | v12.0.0.4.zip
| |
Download stats | - | |
Author(s) | Robin Richmond | |
Homepage | this page | |
Mod Support | My Mod Support form or TNG Community Forums | |
Contact Developer | My Mod Support form | |
Latest Mod | 12.0.0.4 | |
Min TNG V | 11.0 | |
Max TNG V | 12.2 | |
Files modified | admin_branches.php, admin_editbranch.php, ajx_labels.php, English cust_text.php, admin_genconfig.php, admin_updateconfig.php;
Installs shared files: rrshared_innermodmenu2.php, rrshared_modsettingsblocks2.php, img/rrshared_wikilogo.gif | |
Related Mods | Branch Timestamps depends on this mod. | |
Notes |
Purpose of the Mod
To add information to the Admin>>Branches>>Search results table, and simplify (from the author's perspective) the Add/Remove/Delete functionality in the Edit screen.
- The Admin>>Branches>>Search page now:
- Has two new columns for the four branch rule parameters (with 2 values in each column):
- Flags the People and Families columns when the count of Branch Labels in People and Families records does not match the count of records in the BranchLinks table. Note that the counts are expected not to match for what I call "dummy branches" whose BranchID's are incorporated into other branches, but they are still flagged. (See the visualizations)
- Uses a Mod Parameter to determine whether to show counts in the People and Families columns, or just to indicate whether there are any People or Families in the branch. This feature was added because it can take too long to count the branch labels in very large TNG databases.
- Has a "Results Per Page" field that uses the TNG system parameter "maxsearchresults" as its default.
- Adds "Field Buttons" to the search string field and the Results Per Page field. (Field buttons are small buttons with one-letter labels that are attached to form fields, and that perform four common editing tasks: Clear a field, Restore the field's initial value, set a Default, or set an "All items" value. See the Field Buttons mod, which must installed for the field buttons to be visible.
- In the Branch Edit form:
- All action buttons are now directly on the screen, in fieldsets, rather than in pop-ups. (I found the cascading pop-up forms confusing.)
- There is now a "Show names" checkbox so that when branch labels are added or cleared, the names associated with each Person and Family record in the branch don't always have to be displayed.
Mod Options
There is just one option, which allows the branch counts in admin_branches.php to be omitted on sites with so many records that the branch counts take too long. That is, the option determines whether the program with display
- The number of records in each branch, or
- A flag that says that there are records in the branch.
The mod option is a custom TNG setting, defined and edited in the form at Admin>>Setup>>General Settings, in a new subform named Robin's Mod's. This subform takes advantage of a scheme that I call Mod Settings Blocks.
Compatibility
This mod is compatible with Add Name to PersonID, Tree ID Mod, TreeID-One Column, and Branch Timestamps. The current version of this mod is not compatible with Branches Sort mod. But the goal of Branches Sort mod, to sort related branches together in the Admin Branches Search results table, is only achieved if the related branches use the common BranchID at the very beginning of their BranchIDs. A Branch testing application that can focus on all groups of related branches is installed by the Branch Timestamps mod.
Related Mods
- Branch Timestamps is a companion mod to Admin Branches and depends on Admin Branches. Branch Timestamps
- Adds fields to the Branches table that record
- The last action (Add Labels, Clear Labels, Delete, or Edit) that was taken on the branch
- When that action occurred (hence the name "Branch Timestamps", and
- The number of People records and Families records affected by that operation.
- Adds columns to the Admin >> Branches >> Search results page,
- Creates a queueing mechanism that allows a TNG site administrator to "queue up" a set of Add Labels operations so that the administrator doesn't have to wait for each branch to finish before starting the next one, and
- Installs a "Timestamp Test App" that lets a TNG site administrator review the results of recent actions, run actions, and queue actions.
- Adds fields to the Branches table that record
- The optional mod Add Name To PersonID modifies several programs, including the Branch Search program and the Branch Editor to display the name of a branch "Starting Individual" as well as the personID.
- The optional Field Buttons mod implements small "Field Button" that are attached to the search string field and the new Result Per Page field in the Branches Search page. The field buttons serve as shortcuts to editing tasks such as "clear this field", and "restore the value that this field had when the page was loaded".
- Note that the Field Buttons mod is optional. If it is not installed, the field buttons will simply not appear.
- This mod saves information that can be used by the optional mod Show Mod Names. As with Field Buttons, Show Mod Names is completely optional. If it is not installed, its "Show Mods" button at the bottom of admin pages will simply not appear.
Installation
Files Installed
This mod has two mod subfolders:
- admin_branches_v12.0.0.4 - The subfolder that you expect to exist for any mod that installs files. It contains
- rradminbranches_ajx.php (ajx_branchcounts.php in the TNGv11 version of the mod)
This AJAX program is called by the Branch Editor (admin_editbranch.php) after an operation that changes the branch contents (i.e. the records the in the branch) so that the Branch Editor can display the branch counts without having to reload the page. It is also used by the Branch Timestamps mod, which is a companion mod to Admin Branches, and depends on Admin Branches. - rradminbranches_lib.php (branchcountslib.php in the TNGv11 version of the mod)
The functions in this PHP function library count records (People and Families) in a branch. It is used by- The Admin>>Branches>>Search program (admin_branches.php) to display the search results table,
- The Branch edit program (admin_editbranch.php) to display counts for the current branch, and
- rradminbranches_ajx.php to retrieve updated counts after admin_editbranch.php has modified a branch.
- rradminbranches_ajx.php (ajx_branchcounts.php in the TNGv11 version of the mod)
- The shared folder RR-shared_mod_includes_v12.0.0.2, which contains files that support Inner Mod Menus and Mod Settings Blocks.
- rrshared_innermodmenu2.php
- rrshared_modsettingsblocks2.php
- img/rrshared_wikilogo.gif
The shared folder is packaged with several mods, each of which may install some or all of its files. Once a file from this 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 generate any Mod Manager errors.
If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder, you need to make sure to copy the folder RR-shared_mod_includes_v12.0.0.2 (well, unless you are confident that it is already in your mods folder because it was part of another mod).
[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
- 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, Extract its .cfg file to the mods folder.
- Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.
Problems?
- Try using the Mod Manager Remove capability
- Contact me through My Mod Support form.
Visualizations
Admin>>Branches>>Search Before Installation |
Admin>>Branches>>Search After Installation
Significantly, a mod option can disable the counting of People and Families records, in which case the People and Families columns will just contain flag that indicates whether any People or Families records are in the branch. This feature is important for very large databases where it may take a long time to count the branch records. Features in the visualization above that are installed or enabled by other mods (outlined in brown):
|
Admin>>Branches>>Edit Before Installation
Note that the Branch Edit screen also performs operations on branches. This is the only way that the native TNG code can use the branch rules to create or remove branch labels.
|
Admin>>Branches>>Edit After Installation |
Admin>>Branches>>Search After Installation - The Inner Mod Menu
In admin_branches.php the Inner Mod Menu links to:
|
The Admin Branches Option - in a "Mod Settings Block"
The Mod Settings Block for Admin Branches (like most other Mod Settings Blocks) is at Admin>>Setup>>General Settings in a new subform named Robin's Mods. When Mod Settings Block are invoked from an Inner Mod Menu, the Admin>>Settings program automatically opens the subform and displays only the target Mod Settings Block, like this: |
Revision History
Mod Version | TNG Versions | Date | Note |
---|---|---|---|
12.0.0.4.zip | 12.0 - 12.2+ | 26Nov2019 | No Functional Changes
|
12.0.0.3.zip & 11.0.0.3.zip | 11.0 - 12.0+ | 24May2018 | Brought to TNGv12 specs; Change the filenames of the installed files to be more distinctive. |
11.0.0.2a.zip | 11.0 - 11.1.2 | 28Dec2017 | No visible changes, except when printing
|
11.0.0.2 | 11.0+ | 12Dec2017 | Changes:
|
11.0.0.1a | 11.0+ | 2Jun2017 | The new $summaryonly Query String parameter in ajx_labels.php is now implemented through this mod rather than through Branch Timestamps. As a result
|
11.0.0.1 | 11.0+ | 2Apr2017 | New mod in Beta status. |
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.4 | 12.0 | English |
Racine d'Alsace | J-Louis Valory | Public/Private - T17 customized | 12.0.0.3 | 12.0.2 | FR |
Cole / Tanner Family Tree | David Cole | Public/Private | see here | see here | English |