Difference between revisions of "Regroup Person-Branch Members"

From TNG_Wiki
Jump to navigation Jump to search
m (1 revision imported: import files changed since database backup for upgrade)
(22 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{TNGmod
 
{{TNGmod
 
| mod_name        =  Show Branch Members
 
| mod_name        =  Show Branch Members
|  mod_summary    = Turns branch names in the Person Profile into hyperlinks to a list of branch members. (STILL IN BETA TESTING)
+
|  mod_summary    = Turns branch names in the Person Profile into hyperlinks to a popup list of Branch members, using the same popup code as the Cemetery Edit program. Also adds information to the Branch Members popup, including (optionally) a list of Branch users.
 
| mod_validation  =  
 
| mod_validation  =  
| download_link  = For {{Tv1010}}<br />*** STILL IN BETA TESTING [[Media:show_branch_members_v10.1.0.1.zip|show_branch_members_v10.1.0.1.zip]]
+
| mod_last_update = 14 Jan 2018
 +
| download_link  = [[Media:show_branch_members_v10.1.0.3.zip|v10.1.0.3]]{{Tv110}}{{Tv1010}}
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
Line 9: Line 10:
 
| mod_contact    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
 
| mod_contact    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form]
 
| mod_support    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
 
| mod_support    = [http://www.robinrichmond.com/family/mod_support.php My Mod Support form] or [http://tng.community/ TNG Community Forums]
| mod_version    = 10.1.0.1
+
| mod_version    = 10.1.0.3
 
| min_TNG_ver    = 10.1
 
| min_TNG_ver    = 10.1
| max_TNG_ver    = 10.1.3
+
| max_TNG_ver    = at least 11.1.2
 
|  TNG_file_list  = getperson.php, ajx_showbranch.php, English cust_text.php
 
|  TNG_file_list  = getperson.php, ajx_showbranch.php, English cust_text.php
| related_mods  = [[Show Mod Names]] must be installed in order to display the mod name on the Person Profile. (see compatibility and dependencies on the left.)
+
| related_mods  = [[Hide Branch Names]]
 
| notes    =   
 
| notes    =   
 
}}
 
}}
 
+
== Purpose of the Mod ==
 +
This mod has two purposes:
 +
# 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
 +
# To add information to ajx_showbranch.php, which is used by the Branch editor and (now) the Person Profile to display Branch members.
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 
 
|}
 
|}
 +
New features of the Branch Members popup include:
 +
# 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.
 +
# To accommodate inaccessible records, it modifies the wording in the subheading and adds the count of inaccessible records
 +
# If any record are omitted from the lists, a new message says how many were omited.
 +
# It ignores $tree as an input querystring parameter, since $branch is sufficient to identify the tree and branch uniquely.
 +
# In the heading, it displays the tree to which the branch belongs, next to the branch name (unless the database has only one tree.)
 +
# The heading now has id='top', to be used as a hyperlink destination.
 +
# The word "Families" in the heading line with people and family counts is a hyperlink to the list of families.
 +
# Person names and family names are now in ordered lists.
 +
# Person names are now hyperlinked to the Person Profile rather than to the Person editor.
 +
# There is now a heading above the list of families, with a hyperlink to the top of the litbox.
 +
# Families are now hyperlined to the Family Profile rather than tp the family editor.
 +
# There is a list to the top of the litbox from the bottom.
 +
# A new querystring parameter $showusers controls whether the branch's users are listed.
 +
# 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.
  
== Purpose of the Mod ==
+
== Compatibility And Dependencies ==
To display all members (people and marriages) of a branch while on the Person Profile.
+
No known mod conflicts or strict dependencies, but do please let me know if you find any.
  
== Compatibility And Dependencies ==
+
== Related Mods ==
No known mod conflicts.<br/>
+
* [[Hide Branch Names]] limits list of Branch Names in the Person Profile to the the branch a user is restricted to, but still lists all Branches for administrators. (Thus not-logged-in users and users without a Branch restriction will not see any Branch names.) In any case [[Show Branch Names]] allows the user to display the members of the branches whose names ''are'' listed.
This mod depends on '''[[Show Mod Names]]''' to display the mod name at the bottom of the Person Profile page. This mod will work without [[Show Mod Names]]; it just won't display the mod name.  See [[Show Mod Names]] for more information.
+
* [[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 control whether the Branch Users are listed.
 +
* This mod saves information that [[Show Mod Names]] can report, but it is not dependent on [[Show Mod Names]]
  
==Requirements==
+
==Installation==
 +
===Requirements===
 
* A working TNG installation.
 
* A working TNG installation.
 
* An installed current version of the [[Mod Manager]].
 
* An installed current version of the [[Mod Manager]].
 
* You should backup files listed in the panel on the right.
 
* You should backup files listed in the panel on the right.
 
+
===Procedure===
==Automated Installation==
 
 
# Remove and delete previous version of this mod.
 
# 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.
 
# 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.
+
# Download the .zip file, and 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]].
 
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]].
 
+
===Problems?===
== In the event of a problem ==
 
 
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
 
# Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability
 
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].
 
# Contact me through [http://www.robinrichmond.com/family/mod_support.php My Mod Support form].
  
== Visualization of this Mod ==
+
== Visualizations ==
 
 
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
!<span style="color: red">''' BEFORE:'''</span> Note two branch names
+
! Person Profile <span style="color: red">''' BEFORE:'''</span> Note two branch names
 
|-
 
|-
 
| [[Image:show_branch_members-before.png]]
 
| [[Image:show_branch_members-before.png]]
 
|-  
 
|-  
! <span style="color: red">'''AFTER:'''</span>
+
! Person Profile <span style="color: red">'''AFTER:'''</span>
 
|-  
 
|-  
 
| The branch names are now hyperlinks, and clicking on one pops up the list of members.
 
| The branch names are now hyperlinks, and clicking on one pops up the list of members.
 
[[Image:show_branch_members-after.png]]
 
[[Image:show_branch_members-after.png]]
 
|-  
 
|-  
| Note that the highlighted heading has new wording. The pop-up box is generated by  ajx_showbranch.php, and the new wording will be used in in the pop-up box heading, and in a button name, when you are editing a branch.
+
| In the popup list created by ajx_showbranch.php:
 +
# The heading has new wording, and lists both the BranchID and the Branch name
 +
# 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.
 +
# 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.
 +
# The actual number of records in the branch is 783 + 880 + 308 = 1971
 +
# 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.
 +
# The Families headings is new, as are the links back to the top of the litbox.
 +
|-
 +
! Admin Branch Edit <span style="color: red">''' BEFORE:'''</span>
 +
|-
 +
| 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).<br/>
 +
[[Image:show_branch_members-before2.png]]
 +
|-
 +
! Admin Branch Edit <span style="color: red">'''AFTER:'''</span>
 +
|-
 +
| In the popup litbox:
 +
# The main heading text is different from the native code, but the same as in the box popped up the Person Profile.
 +
# 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.
 +
# Thus, in this case, the subheading just says "Members" rather than "Accessible Members", and the counts are larger.
 +
# 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.
 +
[[Image:show_branch_members-after2.png]]
 
|}
 
|}
 +
== Translations ==
 +
==== German / Deutsch ====
 +
<div class='mw-collapsible'>Click the button to the right to hide/show the translation.
 +
<div class='toccolours mw-collapsible-content'>
 +
$admtext['rrsbm-membersof'] = 'Personen dieses Zweiges';<br />
 +
$admtext['rrsbm-noaccessible'] = 'Geschützte Personen';<br />
 +
$admtext['rrsbm-accessible'] = 'Freigeschaltet';<br />
 +
$admtext['rrsbm-inaccessible'] = 'Es gibt ### geschützte (Lebend oder Privat) Personen im Zweig';<br />
 +
$admtext['rrsbm-nousers'] = 'Dem Zweig sind keine Nutzer zugewiesen';<br />
 +
$admtext['rrsbm-users'] = 'Nutzer, die den Zweig sehen können';<br />
 +
$admtext['rrsbm-inbranch'] = 'im Zweig';<br />
 +
$admtext['rrsbm-associated'] = 'Zugeordnete Person';<br />
 +
$admtext['rrsbm-norecord'] = 'Datensatz fehlt';<br />
 +
$admtext['rrsbm-noassociated'] = 'PersonID nicht zugeordnet';<br />
 +
</div>
  
== Mod Change History ==
+
== Revision History ==
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
Line 68: Line 123:
 
! Note
 
! Note
 
|-  
 
|-  
| 10.1.0.1
+
| 10.1.0.3
 +
| 10.1-11.1.2+
 +
| 14 Jan 2018
 +
| 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.
 +
|-
 +
| [[Media:show_branch_members_v10.1.0.1.zip|v10.1.0.1.zip]]
 
| 10.1-10.1.3
 
| 10.1-10.1.3
 
| 30 Nov 2015
 
| 30 Nov 2015
Line 79: Line 148:
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
 +
! User
 
! URL
 
! URL
! User
 
! Note
 
 
! Mod-Version
 
! Mod-Version
 
! TNG-Version
 
! TNG-Version
! User-language
+
! Note
 
|-
 
|-
| Not installed
 
 
| [[User:Robinrichm|Robin Richmond]]
 
| [[User:Robinrichm|Robin Richmond]]
 +
| [http://www.robinrichmond.com/family/search.php?mylastname=Richmond&myfirstname=Clarence&mybirthyear=1895 Robin Richmond's Genealogy Database]
 
| Mod developer
 
| Mod developer
| 10.0.0.1
 
 
| 10.1.3
 
| 10.1.3
 
| English
 
| English
 +
|-
 +
| [http://www.robinrichmond.com/family/search.php?mylastname=Richmond&myfirstname=Clarence&mybirthyear=1895 Robin Richmond's Genealogy Database]
 +
| [[User:Robinrichm|Robin Richmond]]
 +
| Mod developer
 +
| [[Media:show_branch_members_v10.1.0.1.zip|v10.1.0.1.zip]]
 +
| 10.1.3
 +
| English
 +
|-
 +
| [http://www.kmtrees.com Roots & Relatives Remembered]
 +
| [[User:Tngrlkrz|Ronald Krzmarzick]]
 +
| 10.1.0.3
 +
| 12.0.1
 +
| Modified
 +
| EN,DE,CS,ES
 +
|-
 +
| [https://www.martius-familie.de/ Martius family]
 +
| [[User:Hemar|Hendrik Martius]]
 +
| 10.1.0.3
 +
| 12.0.1
 +
| Use to inform living branch members on assigned users, e.g. corr. GDPR
 +
| DE, EN, FR, NL
 
|}
 
|}
  

Revision as of 13:15, 30 June 2018

Show Branch Members
Summary Turns branch names in the Person Profile into hyperlinks to a popup list of Branch members, using the same popup code as the Cemetery Edit program. Also adds information to the Branch Members popup, including (optionally) a list of Branch users.
Validation
Mod Updated 14 Jan 2018
Download link v10.1.0.3
TNG 11.0
TNG 10.1.0
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod 10.1.0.3
Min TNG V 10.1
Max TNG V at least 11.1.2
Files modified
getperson.php, ajx_showbranch.php, English cust_text.php
Related 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 record are omitted from the lists, a new message says how many were omited.
  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

  • Hide Branch Names limits list of Branch Names in the Person Profile to the the branch a user is restricted to, but still lists all Branches for administrators. (Thus not-logged-in users and users without a Branch restriction will not see any Branch names.) In any case Show Branch Names allows the user to display the members of the branches whose names are listed.
  • 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 control whether the Branch Users are listed.
  • This mod saves information that Show Mod Names can report, but it is not dependent on Show Mod Names

Installation

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, and 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.

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

Translations

German / Deutsch

Click the button to the right to hide/show the translation.

$admtext['rrsbm-membersof'] = 'Personen dieses Zweiges';
$admtext['rrsbm-noaccessible'] = 'Geschützte Personen';
$admtext['rrsbm-accessible'] = 'Freigeschaltet';
$admtext['rrsbm-inaccessible'] = 'Es gibt ### geschützte (Lebend oder Privat) Personen im Zweig';
$admtext['rrsbm-nousers'] = 'Dem Zweig sind keine Nutzer zugewiesen';
$admtext['rrsbm-users'] = 'Nutzer, die den Zweig sehen können';
$admtext['rrsbm-inbranch'] = 'im Zweig';
$admtext['rrsbm-associated'] = 'Zugeordnete Person';
$admtext['rrsbm-norecord'] = 'Datensatz fehlt';
$admtext['rrsbm-noassociated'] = 'PersonID nicht zugeordnet';

Revision History

Mod Version TNG Versions Date Note
10.1.0.3 10.1-11.1.2+ 14 Jan 2018 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.

Sites using this mod

If you download and install this mod, please add your site to the table below.

User URL Mod-Version TNG-Version Note
Robin Richmond Robin Richmond's Genealogy Database Mod developer 10.1.3 English
Robin Richmond's Genealogy Database Robin Richmond Mod developer v10.1.0.1.zip 10.1.3 English
Roots & Relatives Remembered Ronald Krzmarzick 10.1.0.3 12.0.1 Modified EN,DE,CS,ES
Martius family Hendrik Martius 10.1.0.3 12.0.1 Use to inform living branch members on assigned users, e.g. corr. GDPR DE, EN, FR, NL