Regroup Person-Hide Branches

From TNG_Wiki
(Redirected from Hide Branch Names)
Jump to navigation Jump to search

(Formerly Hide Branch Names)

Hide Branch Names
Summary On the Person Profile, hides the person's branch names unless the user is an administrator or, if the user is assigned to a branch, that branch name can optionally be shown when the user views the Person Profile of someone in that branch.
Validation
Mod Updated 20 Sep 2020
Download link v13.0.0.19a.zip
TNG 13.0
v12.0.0.19.zip
TNG 12.0
See the Revision History for older versions
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 v13.0.0.19a
Min TNG V 10.1
Max TNG V 13
Files modified
getperson.php
Related Mods
Mod Settings Blocks, Inner Mod Menus, The Regroup Person family of mods
Notes
This mod can be installed independently of other mods in the Regroup Person family.


Purpose of the Mod

In the Person Profile, this mod limits the visibility of the branches to which an Individual is assigned.

  1. Administrators see all branch names assigned to all Individuals.
  2. Non-logged-in users and users without a branch assignment never see branch names.
  3. Depending on a mod option, users who are assigned to a branch may see their branch name when viewing someone in their branch.

Mod Options

The idea behind this mod's single option is that, even if you don't want users to see branch members, it make sense for a logged in user who has a branch restriction to see who is in that branch.

Other Mods

Compatibility

There are no apparent conflicts, but there are so many mods that affect the Person Profile that I haven't tested them all against this mod. Please contact me if you encounter any conflicts.

Related Mods

  1. The Mod Settings Blocks mod packages this mod's options into what I call a "Mod Settings Block", which is a set of form fields that formatted and labeled so that it stands out among other options in an Admin>>Setting form. The Mod Settings Blocks is a prerequisite for this mod; it must be installed before this mod can be installed.
  2. Admin Branches Show Users was spun off from this mod for TNGv13. When it has been installed, the branch members popup in the Person Profile will (optionally) also show branch-assigned users.
  3. The optional mod Inner Mod Menus displays an "Inner Mod Menu" in the TNG "inner menu" (just below the tab menu). The Inner Mod Menu that is defined by this mod is visible only if Inner Mod Menus mod is installed. Inner Mod Menus are visible only to TNG administrators; never to end-users. I highly recommend that you install the Inner Mod Menus mod because Inner Mod Menus provide links to handy information - particularly to the mod settings blocks for this mod's options.
  4. This mod gathers data that can be used by the optional mod Show Mod Names, but there is no dependency on Show Mod Names

This mod is compatible with, and part of, the "Regroup Person" family of mods.    [Show the family members]

[Hide details]

The "Regroup Person" family of mods, developed and supported by Robin Richmond, all affect the Person Profile. Each mods can be used by itself, though several of them are specifically intended to duplicate the functionality of other mods that don't happen to be compatible with Regroup Person Profile, the first and most complex member of the family.

  1. Regroup Person Profile - Rearranges the data in and spacing and formatting of the Person Profile. Also (optionally) adds siblings.
  2. Regroup Person-Branch Members - Turns each of the profiled person's branch names into a hyperlink that pops up a list of branch members. Options control whether anonymous visitors and/or logged-in users are allowed to see branch details.
  3. Regroup Person-Child2Parent - Hides the display of selected relationships (typically the most common relationships such as "natural" or "birth") between the profiled person and that person's parents and children.
  4. Regroup Person-Date Place - Adjusts the spacing used to display (1) Event dates, places, and values and/or (2) The name/birth/death/age data for the profiled person's relatives.
  5. Regroup Person-Family Indicators - Based on Jeff Robison's Family Indicators Mod, this mod adds flags (i.e. "indicators") next to the names of the profiled person's relatives. The flags provide information about and links to several aspects of those relatives' relatives, including popup profiles and ancestor or descendant charts.
  6. Regroup Person-Gender Before Birth - Simply moves the Gender "event" so that it appears above the Birth event.
  7. Regroup Person-Hide Branches - Hides branch names from anonymous visitors and/or logged-in users who are not assigned to the branch.
  8. Regroup Person-Move Media - Simply moves the media files above the event map.
  9. Regroup Person-No Living Data - Suppresses display of ANY data about a living or private person the user doesn't have rights to see. By default, TNG will show some data, plus spouses, parents, and children.
  10. Regroup Person-Remove Gender - Removes the Gender event (the sex) from the event tables, leaving the gender icon next to the name as the sole representation of the person's gender.
  11. Regroup Person-Sources - Allows some source and citation data to be hidden for brevity, and to be displayed as desired.
[Hide the list of Regroup Person mods]

Installation

Files Installed

In TNGv13, this mod includes a typical mod subfolder, with the same base name as the mod's .cfg file. The subfolder is atypical in that no files in it are installed to working TNG folders. However, it does contain critical files that contain the mod's language strings, which the mod does not add to standard cust_text.php files. Instead, the PHP code modified by this mod loads the language strings from files in the mod's languages/ subfolder. Read more 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

Before Installation:

Note the circled branch names, visible to anyone who can see the person's name. Even with the mod, they will continue to be visible to administrators.

Hide branch names-before.png
After Installation, with the mod's option set NOT to allow "branch-restricted" users to see their own branch(es)

The branch names are now invisible to all end users (i.e. all non-admins)

Hide branch names-after-none.png
After Installation, with the mod's option set TO ALLOW "branch-restricted" users to see their own branch(es)

(These conditions all assume that the user is not a site administrator.)

Condition 1 - The user is not in any of the person's branches

As with the example above, the user cannot see any of the branches

Hide branch names-after-none.png
Condition 2 - The user is in the branch "Bacon"


This user can see "Bacon", but not the other branch names

Hide branch names-after-bacon.png
Condition 3 - The user is in a "virtual branch" that includes two of the person's branches

The branches whose descriptions are "Kuykendall" and "Hutcheson" have the branch names "HK-Kuykendall" and "HK-Hutcheson", and the user is in the branch whose name is "HK". Thus, the user is effectively in both the "Kuykendall" and "Hutcheson" branches

Hide branch names-after-hk.png
FYI - With Regroup Person Profile installed

Regroup Person Profile is not interdependent with Hide Branch Names, but it does change the display of branch names significantly. Regroup Person Profile moves the tree and branch names and the edit date out of the event block, and into the Person Profile heading

Hide branch names-regroup person profile.png
FYI - Without FindAGrave Links

FindAGrave Links is also not interdependent with Hide Branch Names, but since I inadvertently took the screenshots above with FindAGrave Links installed, I though that it might be useful to describe the effect of that mod. FindAGrave Links converts the string GRid=nnn (as shown below) in comment and note fields to a hyperlinked reference to the appropriate FindAGrave memorial page (as shown in the screen clips above). That puts the FindAGrave page just one click away from the Person Profile, and reduces the need to copy the FindAGrave page's images and text to your TNG site.

Hide branch names-fag.png

Revision History

Mod Version TNG Version Date Note
v13.0.0.19a 13 20 Sep 2020
  • No TNGv13 syntax or functional changes
  • Uses the Mod Settings Blocks mod rather than shared files.
  • Added French translations by Katryne Chauvigné-Bourlaud
v12.0.0.19.zip 12.0-12.3 10 May 2020 No functional changes. This version's primary purpose is to set the mod's version number to 19 to show that all Regroup Person mods are in sync with Regroup Person Profile.
Technical changes include
  • Uses the new stand-alone mod Inner Mod Menus to display the mod's Inner Mod Menu. As a result, the visibility of the Inner Mod Menu is tied to the installation of the Inner Mod Menus mod.
  • Moved the language strings to a mod subfolder.
  • Added a link to the mod's options from a dummy mod parameter
  • Upgraded to version 4 of the shared Mod Settings Blockis libraries
  • Added "What has changed" text to the Inner Mod Menu (made possible by v5 of the Inner Mod Menu library)
v12.0.0.18.zip 12.0+ 15 May 2018
  • Renamed the mod to Regroup Person-Hide Branches and jumped to v18 for consistency with other Regroup Person mods.
  • Moved the mod option to a mod settings block
  • Added an inner mod menu, like the other Regroup Person mod
  • Fixed a problem with a dangling comma in the limited list of branches presented to users who are in one of the person's branches.
12.0.0.4a 12.0+ 15 May 2018 No functional changes; made compatible with TNGv12.

This mod version and all versions below are named Hide Branch Names

10.0.0.4 10.0.0-10.1.3 14 Feb 2016 - Uses Show Mod Names v2
10.0.0.4 10.0.0-10.1.3 6 Dec 2015 - Uses the mod name display functionality defined by Show Mod Names

- Reworked code to be compatible with Show Branch Members
- Avoids database calls, thus removing any need to deal with TNGv10.0 vs 10.1.

10.0.0.3 10.0.0-10.1.1 11 Jul 2015 - Followed Ken Roy's suggestion to use the code
($allow_edit && $allow_add && $allow_delete && !$assignedtree)
to determine whether the user is an administrator.
- Added the option to display matching branches to users who have a branch restriction.
- Put the word "Branches" in front of the branch names.
- Includes conditional code to allow a SQL statement to be executed in TNG v10.0 or v10.1
10.0.0.2 10.0.0-10.1 26 Feb 2015 v10.0.0.1 would hide branch names from non-administrators, but wouldn't display them for administrators.
10.0.0.1 10.0.0-10.1 26 Dec 2014 New mod; adapted from a incompletely documented, un-credited mod already in use.

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
Richmond's Genealogy Database (See a specific Person Profile) Robin Richmond Mod developer 12.0.0.19 12.3 English
DJCM.DK Claus Martinussen Public Site 12.0.0.4a 12.0.3 DA, EN
Brady Family Tree in Western Australia Darryl Brady Public site 10.0.0.4 10.1.1 EN, DE
Our Family Links Chuck Filteau Public site, modified Template 12 v10.0.0.3 v10.1.2 EN
Our Roy and Boucher Family Ken Roy Public site, modified Template 4
Installed without Show Mod Names
10.0.0.4a 11.1.0 EN
Martius family Hendrik Martius Half public 12.0.0.4a 12.0.1 DE, EN, FR, NL