Difference between revisions of "Regroup Person-Hide Branches"
Robinrichm (talk | contribs) |
Robinrichm (talk | contribs) (renamed to Regroup Person-Hide Branches v18) |
||
Line 4: | Line 4: | ||
| mod_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. | | mod_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. | ||
| mod_validation = | | mod_validation = | ||
− | | mod_last_update = | + | | mod_last_update = 7 Jan 2020 |
− | | download_link = [[Media: | + | | download_link = [[Media:regroup_person-hide_branches_v12.0.0.18.zip|regroup_person-hide_branches_v12.0.0.18.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 = | + | | mod_url = ''this page'' |
− | | mod_contact = [http:// | + | | mod_contact = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] |
− | | mod_support = [http:// | + | | mod_support = [http://www.robinrichmond.comg/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums] |
− | | mod_version = v12.0.0. | + | | mod_version = v12.0.0.18 |
| min_TNG_ver = 10.1 | | min_TNG_ver = 10.1 | ||
| max_TNG_ver = at least 12.2 | | max_TNG_ver = at least 12.2 | ||
− | | TNG_file_list = getperson.php | + | | TNG_file_list = getperson.php<br>'''May Install''' rrshared_innermodmenu3.php, rrshared_modsettingsblocks3.php, rrshared_wikilogo.gif |
− | | related_mods = | + | | related_mods = The Regroup Person family of mods |
− | | notes = | + | | notes = This mod can be installed independently of other mods in the Regroup Person family. |
}} | }} | ||
== Purpose of the Mod == | == Purpose of the Mod == | ||
Line 30: | Line 31: | ||
The idea behind this mod's single option is that, even if you don't want users to see branch assignments, it make sense for a logged in user who has a branch restring to see who is in that branch. Showing the user's own branch name may at first seem redundant, but TNG lets branch-assigned users see any deceased person in the database, so users can't ordinarily tell whether a deceased person in in ''their'' branch. | The idea behind this mod's single option is that, even if you don't want users to see branch assignments, it make sense for a logged in user who has a branch restring to see who is in that branch. Showing the user's own branch name may at first seem redundant, but TNG lets branch-assigned users see any deceased person in the database, so users can't ordinarily tell whether a deceased person in in ''their'' branch. | ||
who is in their branch. | who is in their branch. | ||
− | |||
− | |||
==Compatibility With Other Mods== | ==Compatibility With Other Mods== | ||
Line 37: | Line 36: | ||
==Related Mods== | ==Related Mods== | ||
− | # [[ | + | This mod is in 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 in the family. |
− | # | + | <div class="mw-collapsible mw-customtoggle-rpfamily1 mw-customtoggle-rpfamily2" id='mw-customcollapsible-rpfamily1' style="text-decoration:underline;color:#0645ad;">[Show the family members]</div> |
+ | <div class='mw-collapsible mw-collapsible-content mw-collapsed toccolours' id='mw-customcollapsible-rpfamily2' style="border:thin solid grey;"> | ||
+ | <!-- BEGIN TOGGLED CONTENT --> | ||
+ | '''The "Regroup Person" family of mods: | ||
+ | # [[Regroup Person Profile]] - The daddy in the family (and my first mod). It rearranges the Person Profile, and adds some features (some optional) such as more easy-to-read recordIDs, siblings, and more-easy-to-read relative's data. | ||
+ | # [[Regroup Person-Branch Members]] - Makes each of the person's branch names a hyperlink to a list of branch members. | ||
+ | # [[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. | ||
+ | # [[Regroup Person-Hide Branches]] - ('''''this mod''''') Hides branch names from end-users. | ||
+ | # [[Regroup Person-Move Media]] - Moves the media files above the map | ||
+ | # [[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. | ||
+ | # [[Regroup Person-Parent Rel]] - Hides "natural" or "birth" relationships between the person and the parents. | ||
+ | # [[Regroup Person-Sources]] - Starts the display of source citations with just the Source ID, Title, and Author, and provides buttons so the user can display Source details and/or Citation details, for individual source citations and for all source citations. | ||
+ | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-rpfamily1 mw-customtoggle-rpfamily2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide the list of mods]</div> | ||
+ | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | ||
==Installation== | ==Installation== | ||
− | This mod | + | === 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 Mod 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, and whether that mod needs that particular file. 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 in uninstalled mods. | ||
+ | |||
+ | 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).<br>{{RobinInstallationBoilerplate}} | ||
== Visualizations == | == Visualizations == | ||
Line 89: | Line 109: | ||
|- | |- | ||
| [[Media:hide_branch_names_v12.0.0.4a.zip|12.0.0.4a]] | | [[Media:hide_branch_names_v12.0.0.4a.zip|12.0.0.4a]] | ||
+ | | 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. | ||
+ | '''Versions below are named Hide Branch Names''' | ||
+ | |||
+ | |- | ||
+ | | [[Media:regroup_person-hide_branches_v12.0.0.18.zip|v12.0.0.18.zip]] | ||
| 12.0+ | | 12.0+ | ||
| 15 May 2018 | | 15 May 2018 |
Revision as of 15:05, 7 January 2020
(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 | 7 Jan 2020 | |
Download link | regroup_person-hide_branches_v12.0.0.18.zip
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 | v12.0.0.18 | |
Min TNG V | 10.1 | |
Max TNG V | at least 12.2 | |
Files modified | getperson.php May Install rrshared_innermodmenu3.php, rrshared_modsettingsblocks3.php, rrshared_wikilogo.gif | |
Related Mods | 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.
- Administrators see all branch names assigned to all Individuals.
- Non-logged-in users and users without a branch assignment never see branch names.
- 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 assignments, it make sense for a logged in user who has a branch restring to see who is in that branch. Showing the user's own branch name may at first seem redundant, but TNG lets branch-assigned users see any deceased person in the database, so users can't ordinarily tell whether a deceased person in in their branch. who is in their branch.
Compatibility With Other Mods
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
This mod is in 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 in the family.
The "Regroup Person" family of mods:
- Regroup Person Profile - The daddy in the family (and my first mod). It rearranges the Person Profile, and adds some features (some optional) such as more easy-to-read recordIDs, siblings, and more-easy-to-read relative's data.
- Regroup Person-Branch Members - Makes each of the person's branch names a hyperlink to a list of branch members.
- 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.
- Regroup Person-Hide Branches - (this mod) Hides branch names from end-users.
- Regroup Person-Move Media - Moves the media files above the map
- 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.
- Regroup Person-Parent Rel - Hides "natural" or "birth" relationships between the person and the parents.
- Regroup Person-Sources - Starts the display of source citations with just the Source ID, Title, and Author, and provides buttons so the user can display Source details and/or Citation details, for individual source citations and for all source citations.
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 - Inner Mod Menus
- rrshared_modsettingsblocks3.php - 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, and whether that mod needs that particular file. 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 in uninstalled mods.
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).
[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
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. |
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) |
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 |
Condition 2 - The user is in the branch "Bacon"
|
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 |
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 |
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. |
Revision History
Mod Version | TNG Version | Date | Note |
---|---|---|---|
12.0.0.4a | 12.0+ | 15 May 2018 |
Versions below are named Hide Branch Names |
v12.0.0.18.zip | 12.0+ | 15 May 2018 | No functional changes; made compatible with TNGv12. |
10.0.0.4a | 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 |
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 |
---|---|---|---|---|---|
Robin Richmond's Genealogy Database (not installed) | Robin Richmond | Mod developer | 12.0.0.4a | 12.2 | 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 |