Regroup Person-Branch Members

From TNG_Wiki
Jump to: navigation, search
Regroup Person-Branch Members
Summary Turns branch names in the Person Profile into hyperlinks to a popup list of Branch members, as in the Branch editor. Users assigned to the branch may also be displayed.
Validation
Mod Updated 10 Mar 2020
Download link v12.0.0.19
TNG 12.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 this page
Latest Mod 12.0.0.19
Min TNG V 10.1
Max TNG V 12.3
Files modified
getperson.php, ajx_showbranch.php, admin_editbranch.php, English cust_text.php
Related Mods
Inner Mod Menus, Hide Branch Names, Admin Branches, other Regroup Person* mods
Notes


Purpose of the Mod

This mod has two purposes:

  1. To convert the branch names displayed in the Person Profile into hyperlinks that pop up a box that displays all users who are restricted to that branch, and all members (people and marriages) of the branch, and
  2. To add information to ajx_showbranch.php, which is used by the Branch editor and (now) the Person Profile to display Branch members.

New features of the Branch Members popup include:

  1. Since it now can be called from an end-user program (the Person Profile), the lists of people and families must make sure that the current user is allowed to see these people and families. If some records are restricted from being seen by the user, the restricted records are completely omitted from the lists.
  2. To accommodate inaccessible records, it modifies the wording in the subheading and adds the count of inaccessible records
  3. If any records are omitted from the lists because they are inaccessible by the user, a new message says how many were ommited.
  4. It ignores $tree as an input querystring parameter, since $branch is sufficient to identify the tree and branch uniquely.
  5. In the heading, it displays the tree to which the branch belongs, next to the branch name (unless the database has only one tree.)
  6. The heading now has id='top', to be used as a hyperlink destination.
  7. The word "Families" in the heading line with people and family counts is a hyperlink to the list of families.
  8. Person names and family names are now in ordered lists.
  9. Person names are now hyperlinked to the Person Profile rather than to the Person editor.
  10. There is now a heading above the list of families, with a hyperlink to the top of the litbox.
  11. Families are now hyperlined to the Family Profile rather than tp the family editor.
  12. There is a list to the top of the litbox from the bottom.
  13. A new querystring parameter $showusers controls whether the branch's users are listed.
  14. In the new list of users
    • The "realname" field from the users is the value that identifies each user
    • If the user has an email address, the realname is displayed as a mailto: hyperlink.
    • If the user has an associated person, that person's ID and name are displayed as a hyperlink to the person profile.

Compatibility And Dependencies

No known mod conflicts or strict dependencies, but do please let me know if you find any.

Related Mods

  • Admin Branches changes the wording of the button that displays Branch members from "Show people with this tree/branch" to "Show Branch Members", and adds a checkbox that controls whether the Branch Users are listed.
  • Show Mod Names, which displays information saved by this mod. But Show Mod Names is not required.
  • The "Regroup Person" family of mods that were written by Robin Richmond and that affect the Person Profile. All of these mods can be installed independently of the other mods in the family.
[Show the family members]

The "Regroup Person" family of mods:

  1. Regroup Person Profile - The daddy in the family (and my first mod). It rearranges the data in the Person Profile, and adds features (some optional) such as siblings. more easy-to-read recordIDs relative's data, and the ability to control the formatting of dates and places.
  2. Regroup Person-Branch Members (this mod) - Makes each of the profiled person's branch names a hyperlink to a list of branch members, and, in some cases, to a list of branch members.
  3. Regroup Person-Date Place - Combines event date, place, and description into one table cell, and coordinates with Regroup Person Profile to share an Inner Menu button that affects white space in the Person Profile.
  4. Regroup Person-Family Indicators - Based on Jeff Robison's Family Indicators mod, this mod adds flags to parents & spouses that (1) pop-up a preview of both parents and that link to an ancestor chart, and adds flags to children and spouses that list the number of marriages that person had, and that link to a descendant chart.
  5. Regroup Person-Hide Branches - Hides branch names from end-users.
  6. Regroup Person-Move Media - Moves the media files above the map
  7. Regroup Person-No Living Data - Suppresses display of ANY data about a living or private person the user doesn't have rights to. By default, TNG will show some data, plus spouses, parents, and children.
  8. Regroup Person-Parent Rel - Hides "natural" or "birth" relationships between the person and the parents.
  9. Regroup Person-Sources - Allows source and citation data to be hidden for brevity, but displayed as desired.
[Hide the list of mods]

Installation

This mod is packaged with the typical mod subfolder that has the same name as the mod's base filename. It contains the mod's language strings, in files under the subfolder languages/. That is, this mod does not copy its language strings into cust_text.php files. Instead, the Person Profile reads the language strings directly from the file in the mod subfolder. See notes about this technique
[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

Person Profile BEFORE: Note two branch names
Show branch members-before.png
Person Profile AFTER:
The branch names are now hyperlinks, and clicking on one pops up the list of members.

Show branch members-after.png

In the popup list created by ajx_showbranch.php:
  1. The heading has new wording, and lists both the BranchID and the Branch name
  2. There is a list of users assigned to this branch, because the Person Profile always sets the "show users" flag when calling ajx_showbranch.php.
  3. Consideration of inaccessible (Living or Private) records is new. The count is non-zero because the current user is either branch-restricted, or not logged in.
  4. The actual number of records in the branch is 783 + 880 + 308 = 1971
  5. The word "Families" next to the count of Families is a hyperlink down to the Families heading shown in the second section of the screen clip.
  6. The Families headings is new, as are the links back to the top of the litbox.
Admin Branch Edit BEFORE:
When you click on the button shown, the members of the branch are listed in the pop-up box. Note that the button and the pop-up box heading are identical, and that they refer to "people" rather than "members" (which include families).

Show branch members-before2.png

Admin Branch Edit AFTER:
In the popup litbox:
  1. The main heading text is different from the native code, but the same as in the box popped up the Person Profile.
  2. By definition, the Branch members list generated by the Admin Branch Edit program will not have any inaccessible records, because it must be run by an administrator.
  3. Thus, in this case, the subheading just says "Members" rather than "Accessible Members", and the counts are larger.
  4. The "native" Admin Branch Edit program does not have a way to set the flag that causes the popup to display users of the branch. A new checkbox created through the Admin Branches controls that flag.

Show branch members-after2.png

Revision History

Mod Version TNG Versions Date Note
v12.0.0.19 12.0-12.3 10May2020 Renamed the mod to Regroup Person-Branch Members and jumped to v19 to be consistent with other mods in the Regroup Person family. No other meaningful functional changes
  • Added an Inner Mod Menu.
  • Moved the cust_text strings into a mod subfolder.
  • Cleaned up references to undefined variables and subscripts
10.1.0.3 10.1-11.1.2+ 14 Jan 2018 This and earlier versions of the mod are named Show Branch Members

In the Branch Members litbox popup used by the Branch editor, and now by the Person Profile,

  • Added more information to the heading
  • Made the people and families lists ordered lists
  • Added a Families heading, a link to the Families heading from the top heading, and links to the top from the Families heading and the bottom of the page.
  • The code now uses the correct gedcom field in the Users table to determine whether there is a default genealogy record for the user.
10.1.0.2 10.1-11.1.2+ 4 May 2017 Now makes sure that a branch-restricted user has an associated user before trying to display the associated user, and makes sure that the associated user exists.
v10.1.0.1.zip 10.1-10.1.3 30 Nov 2015 New mod.

TNG User 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
Richmond's Genealogy Database
(See a specific Person Profile)
Robin Richmond Mod developer 12.0.0.19 12.3 English
Roots & Relatives Remembered Ronald Krzmarzick Public & Private See Here See Here EN,DE,CS,ES
Martius family Hendrik Martius Use to inform living branch members on assigned users, e.g. corr. GDPR 10.1.0.3 12.0.1 DE, EN, FR, NL