Difference between revisions of "Regroup Person-Sources"

From TNG_Wiki
Jump to navigation Jump to search
(fixed TNGmod template summary formatting)
(new user site / mode version)
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{V12_cust_text}}{{TNGmod
+
{{TNGmod
 
| mod_name        = Regroup Person-Sources
 
| mod_name        = Regroup Person-Sources
| mod_summary    = Controls the amount of Source and Citation Details displayed
+
| mod_summary    = Controls the amount of Source and Citation Details displayed in the Person Profile
 
| mod_validation  =  
 
| mod_validation  =  
| mod_last_update = 21 Jan 2019
+
| mod_last_update = 10 May 2020
| download_link  =  [[Media:regroup_person-sources_v12.0.0.17.zip|v12.0.0.17]]{{Tv120}}
+
| download_link  =  [[Media:regroup_person-sources_v13.0.0.19.zip|v13.0.0.19]]{{Tv130}}
 +
<div style='clear:both;'>[[Media:regroup_person-sources_v12.0.0.19.zip|v12.0.0.19]]{{Tv120}}</div>
 +
<div style='clear:both;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        = [http://www.robinrichmond.com/family/ Robin Richmond's Genealogy Database]
+
| mod_url        = ''this page''
 
| 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    = v12.0.0.17
+
| mod_version    = v13.0.0.19
 
| min_TNG_ver    = 12.0
 
| min_TNG_ver    = 12.0
| max_TNG_ver    = at least 12.0.3
+
| max_TNG_ver    = 13
|  TNG_file_list  = getperson.php, personlib.php, css/genstyle.css, English and Norwegian cust_text.php
+
|  TNG_file_list  = getperson.php, personlib.php
| related_mods  = [[Regroup Person Profile]] and other mods in the Regroup Person family.
+
| related_mods  = [[Regroup Person Profile]] and other mods in the Regroup Person* family.
 
| notes    =   
 
| notes    =   
 
}}
 
}}
 
== Purpose of the Mod ==
 
== Purpose of the Mod ==
Controls the amount of Source and Citation Details displayed in the Sources section of the Person Profile. It starts with just a list of source names. Buttons let you show all of the citation details and/or all of the source details. One-letter hyperlinks let you see or hide details for one source or one citation.
+
Controls the amount of Source Citation Details displayed in the Sources (really "Source Citations') section of the Person Profile. It starts with just a list of source names. Buttons let you show all of the citation details, source details, and/or citation images. One-letter hyperlinks let you see or hide details for source citation.
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
 
| __TOC__
 
| __TOC__
 
|}
 
|}
== Mod Parameters ==
+
== Mod Options ==
There is one mod parameter: $authorModParam.  Its update screen reads like this:
+
None
 
 
If you're getting your data via Gedcom from Ancestry.com's Family Tree Maker (FTM), a LOT of your source authors are inaccurately set to "Ancestry.com". This parameter tell the program how to deal with those Ancestry.com authors. Enter:
 
# To treat "Ancestry.com" like other authors; i.e. always display it,
 
# To treat it as a source detail; i.e. initially hidden,
 
# To ignore it. (The default)
 
  
 
== Other Mods ==
 
== Other Mods ==
==Regroup Person family==
+
=== Conflicts ===
These related mods all affect the Person Profile.
+
* This mod is not compatible with [[Citation Master]]. Please let me know of any other incompatibilities (or add them to this list).
# [[Regroup Person Profile] - Rearranges personal events, creates headings between blocks of data, several other tweaks.
 
# [[Regroup Person-Date Place]] - Combines event date, place, and description into one table cell
 
# [[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]] (this mod)- 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..
 
  
=== Dependencies ===
+
=== Related Mods ===
* [[Regroup Person Profile]] must be installed first.  This mod will show the status "Cannot Install" status unless [[Regroup Person Profile]] is installed.
+
<ol>
* This mod generates information that ''can be'' used by [[Show Mod Names]], but it does not depend on [[Show Mod Names]].
+
<li>{{RobinBoilerplate | text=msb}}</li>
 
+
<li>[[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.
=== Incompatible Mods ===
+
<li>{{RobinBoilerplate | text=imm}}</li>
This mod is not compatible with [[Citation Master]]. Please let me know of any other incompatibilities (or add them to this list).
+
<li>{{RobinBoilerplate | text=smn}}</li>
 +
</ol>
 +
{{RobinBoilerplate | text=regroup}}
  
 
==Installation==
 
==Installation==
This mod uses the standard installation procedure. {{RobinInstallationBoilerplate}}
+
=== Files Installed ===
 +
{{RobinBoilerplate | text=language}}
 +
{{RobinBoilerplate | text=install}}
  
 
== Visualizations ==
 
== Visualizations ==
{| border="1" cellspacing="1" cellpadding="2" class="wikitable"
+
{| border="3" cellspacing="1" cellpadding="2" class="wikitable"
 
|-
 
|-
! style="text-align:left;" | <span style="color: red">''' BEFORE:'''</span><br>
+
|<span style="color: red">''' BEFORE:'''</span><br>
[[Regroup Person Profile]] has removed the left-hand column that holds the label "Sources", and has put "Citation Sources" in a heading above the block.
 
 
|-
 
|-
 
| [[Image:regroup_person-source-before.png]]
 
| [[Image:regroup_person-source-before.png]]
 
|-  
 
|-  
! style="text-align:left;" | <span style="color: red">'''AFTER:'''</span><br>
+
! style="text-align:left;" | '''<span style="color: red">After Installation</span>, as the page loads'''
 +
# All of the Source Citations have been compressed to show only the Source ID, Title, and Author.
 +
# There are now three buttons above the Source Citations block. They control three elements of a Source Citation - the Source details, the Citation details, and a possible Citation image.
 +
# Not the three one-letter buttons next to the minimized Source Citation. "S", "C", and "I" toggle the display of that Source Citation's Source details, Citation details, and Image. If any of those components are missing (and all of them could be), the appropriate letter will be omitted.  See item 2 and 10 in this screen clip.
 
|-
 
|-
 
| [[Image:regroup_person-source-after.png]]
 
| [[Image:regroup_person-source-after.png]]
It is pure coincidence that the number of sources in this record fills the box without scrolling.  
+
|-
 +
| '''<span style="color: red">After Clicking the "Show Source Details" button</span>'''
 +
# Note that the "Show Source Details" button has been changed to say "Hide", but the three one-letter links have not changes. At this point, the "S" link would hide the corresponding Source Details, and the other two letters would open their data.
 
|-
 
|-
 
| [[Image:regroup_person-source-after-sources.png]]
 
| [[Image:regroup_person-source-after-sources.png]]
 +
|-
 +
| '''<span style="color: red">After Clicking the "Show Citation  Details" button</span>'''
 +
# Now, the Citations button said "Hide Citation Details", and the one-letter links have not changed.
 +
# Elements of the Citation details are labeled for clarity. "Citation" is a label for the whole citations section, and "Page" and "Text" are labels for those fields.
 
|-
 
|-
 
| [[Image:regroup_person-source-after-citations.png]]
 
| [[Image:regroup_person-source-after-citations.png]]
 +
|}
 +
 +
{| border="3" cellspacing="1" cellpadding="2" class="wikitable"
 +
| '''<span style="color: red">With [[Regroup Person Profile]] Installed</span>'''
 +
# Regroup person Profile changes the Person Profile layout so that the mostly-wasted dark band on the left is replaced by a "Source Citations" heading.
 +
# It moves the buttons to the right, and adds a very significant button labeled "Expand".  The "Expand" button eliminates the limit on the Source Citation box, so that you can see more of the data than you can without the "Expand" button.
 +
Yes, of course, it would be nice if Regroup Person-Sources offered the "Expand" button two, and I can coordiated the two mods so that they both generate a button and only one of the buttons is visible.  But, well, maybe later. (Feedback on my mods almost always persuades me to prioritize the issue I'm getting feedback about.)
 
|-
 
|-
| [[Image:regroup_person-source-after-both.png]]
+
| [[Image:regroup_person-source-after-rpp.png]]
When you first click on the TNG Print button, the Sources box show just the Source ID, Title, and Author.  But the pretty-print sources box is not constrained; it shows all of the information you select.
 
 
|}
 
|}
  
Line 74: Line 83:
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
 
! Mod Version !! TNG Version !! Date !! Note
 
! Mod Version !! TNG Version !! Date !! Note
|-  
+
|- style="vertical-align:top;"  <!-- ############################################# -->
 +
| [[Media:regroup_person-sources_v13.0.0.19.zip|v13.0.0.19]]
 +
| 13
 +
| 20Sep2019
 +
| No functional changes. Upgraded to TNGv13
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 +
| [[Media:regroup_person-sources_v12.0.0.19.zip|v12.0.0.19]]
 +
| 12.0+
 +
| 19Dec2019
 +
| No functional changes. This version's primary purpose is to bring the version numbers of all Regroup Person mods in sync with Regroup Person Profile.<br>Technical changes include
 +
* Added an Inner Mod Menu, whose visibility is tied to installation of the [[Inner Mod Menus]] mod.
 +
* Moved the language strings to a mod subfolder.
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 +
| [[Media:regroup_person-sources_v12.0.0.18c.zip|v12.0.0.18c]]
 +
| 12.0+
 +
| 19Dec2019
 +
|
 +
* Fixed a conflict with v18b Regroup Person Profile. The two v18c's work together.
 +
* Uses styling to replace the two <br> tags that separate source citations
 +
* Changed the "Show/Hide Images" functionality so that images can be viewed independently of citations
 +
* Added a single-letter link for Images.
 +
* The single-letter links within source citations are defined as language strings, instead of being derived from the initial letters of Source, Citation, and Image
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 +
| [[Media:regroup_person-sources_v12.0.0.18.zip|v12.0.0.18]]
 +
| 12.0+
 +
| 5May2019
 +
|
 +
* This mod is no longer dependent on Regroup Person Profile.
 +
* Fixed a bug that was not displaying the source author in most cases.
 +
* Improved some of the formatting details of citation details and defined language strings for some field labels.
 +
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 
| [[Media:regroup_person-sources_v12.0.0.16p.zip|v12.0.0.16p]]
 
| [[Media:regroup_person-sources_v12.0.0.16p.zip|v12.0.0.16p]]
 
| 12.0+
 
| 12.0+
| 24 Jul 2018
+
| 24Jul2018
 
| No functional changes; made compatible with TNGv12
 
| No functional changes; made compatible with TNGv12
|-  
+
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 
| [[Media:regroup_person-sources_v10.0.1.16p.zip|10.0.1.16p]]
 
| [[Media:regroup_person-sources_v10.0.1.16p.zip|10.0.1.16p]]
 
| 10.1.0-11.1.2+
 
| 10.1.0-11.1.2+
| 07 Nov 2017
+
| 07Nov2017
 
| Removed the second line from the cust_text.php target location search string
 
| Removed the second line from the cust_text.php target location search string
|-  
+
 
 +
|- style="vertical-align:top;"  <!-- ############################################# -->
 
| 10.0.1.15
 
| 10.0.1.15
 
| 10.0.1-10.1.3
 
| 10.0.1-10.1.3
| 20 Feb 2016
+
| 20Feb2016
 
| Initial release; separated this mod from the larger [[Regroup Person Profile]] mod to eliminate a conflict with that mod. Started with version 15 to be inline with [[Regroup Person Profile]] version numbers.
 
| Initial release; separated this mod from the larger [[Regroup Person Profile]] mod to eliminate a conflict with that mod. Started with version 15 to be inline with [[Regroup Person Profile]] version numbers.
 
|}
 
|}
Line 105: Line 150:
 
| [[User:Robinrichm|Robin Richmond]]
 
| [[User:Robinrichm|Robin Richmond]]
 
| Mod developer
 
| Mod developer
| 12.0.0.17
+
| 13.0.0.19
| 12.0.3
+
| 13
 
| English
 
| English
 +
|-
 +
| [http://jarocinscy.pl/drzewo/index.php Baza danych Rodziny Jarocińskich]
 +
| [[User:Mjaro|Michał Jarociński]]
 +
| non-public site
 +
| 13.0.0.19
 +
| 13.0.1, T7
 +
| PL, EN
 
|}
 
|}
  
[[Category:Mods for TNG v10]] [[Category:Mods for TNG v11]][[Category:Mods for TNG v12]] [[Category:getperson.php mods]] [[Category:personlib.php mods]] [[Category:genstyle.css mods]] [[Category:cust_text.php mods]]
+
[[Category:Mods for TNG v10]] [[Category:Mods for TNG v11]][[Category:Mods for TNG v12]][[Category:Mods for TNG v13]] [[Category:getperson.php mods]] [[Category:personlib.php mods]]

Revision as of 13:44, 26 October 2020

Regroup Person-Sources
Summary Controls the amount of Source and Citation Details displayed in the Person Profile
Validation
Mod Updated 10 May 2020
Download link v13.0.0.19
TNG 13.0
v12.0.0.19
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.19
Min TNG V 12.0
Max TNG V 13
Files modified
getperson.php, personlib.php
Related Mods
Regroup Person Profile and other mods in the Regroup Person* family.
Notes


Purpose of the Mod

Controls the amount of Source Citation Details displayed in the Sources (really "Source Citations') section of the Person Profile. It starts with just a list of source names. Buttons let you show all of the citation details, source details, and/or citation images. One-letter hyperlinks let you see or hide details for source citation.

Mod Options

None

Other Mods

Conflicts

  • This mod is not compatible with Citation Master. Please let me know of any other incompatibilities (or add them to this list).

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. 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. Inner Mod Menus used to be implemented by a standalone mod named Inner Mod Menus, but they are now a feature of the Mod Settings Blocks mod. "Inner Mod Menus" are drop-down menus in the standard TNG "InnerMenu" and are visible only to TNG site administrators. They provide information about mods that affect a given program and links to the mod's settings (in Mod Settings Blocks).
  4. The old Show Mod Names mod has been retired. Its functionality (now called "Mods Used" is now implemented by the Mod Settings Blocks mod.

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

[Hide details]

My "Regroup Person" family of mods all affect the Person Profile. All of them can be used independently of Regroup Person Profile, which was the the first and is the most complex member of the family.(I'll add that the reputation of the family has been stained by the fact that Regroup Person Profile is distinctly complex and is incompatible with an awkward number of other Person Profile mods. But, in truth, Regroup Person-Date Place is the only other member of the family that is similarly complex and invasive.)

  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 "birth", which would be assumed if it were not displayed) 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. (As you would expect, this mod is incompatible with Regroup Person-Remove Gender)
  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. (As you would expect, this mod is incompatible with Regroup Person-Gender Before Birth)
  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

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 Standard Installation Process]

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:
Regroup person-source-before.png
After Installation, as the page loads
  1. All of the Source Citations have been compressed to show only the Source ID, Title, and Author.
  2. There are now three buttons above the Source Citations block. They control three elements of a Source Citation - the Source details, the Citation details, and a possible Citation image.
  3. Not the three one-letter buttons next to the minimized Source Citation. "S", "C", and "I" toggle the display of that Source Citation's Source details, Citation details, and Image. If any of those components are missing (and all of them could be), the appropriate letter will be omitted. See item 2 and 10 in this screen clip.
Regroup person-source-after.png
After Clicking the "Show Source Details" button
  1. Note that the "Show Source Details" button has been changed to say "Hide", but the three one-letter links have not changes. At this point, the "S" link would hide the corresponding Source Details, and the other two letters would open their data.
Regroup person-source-after-sources.png
After Clicking the "Show Citation Details" button
  1. Now, the Citations button said "Hide Citation Details", and the one-letter links have not changed.
  2. Elements of the Citation details are labeled for clarity. "Citation" is a label for the whole citations section, and "Page" and "Text" are labels for those fields.
Regroup person-source-after-citations.png
With Regroup Person Profile Installed
  1. Regroup person Profile changes the Person Profile layout so that the mostly-wasted dark band on the left is replaced by a "Source Citations" heading.
  2. It moves the buttons to the right, and adds a very significant button labeled "Expand". The "Expand" button eliminates the limit on the Source Citation box, so that you can see more of the data than you can without the "Expand" button.

Yes, of course, it would be nice if Regroup Person-Sources offered the "Expand" button two, and I can coordiated the two mods so that they both generate a button and only one of the buttons is visible. But, well, maybe later. (Feedback on my mods almost always persuades me to prioritize the issue I'm getting feedback about.)

Regroup person-source-after-rpp.png

Revision History

Mod Version TNG Version Date Note
v13.0.0.19 13 20Sep2019 No functional changes. Upgraded to TNGv13
v12.0.0.19 12.0+ 19Dec2019 No functional changes. This version's primary purpose is to bring the version numbers of all Regroup Person mods in sync with Regroup Person Profile.
Technical changes include
  • Added an Inner Mod Menu, whose visibility is tied to installation of the Inner Mod Menus mod.
  • Moved the language strings to a mod subfolder.
v12.0.0.18c 12.0+ 19Dec2019
  • Fixed a conflict with v18b Regroup Person Profile. The two v18c's work together.
  • Uses styling to replace the two
    tags that separate source citations
  • Changed the "Show/Hide Images" functionality so that images can be viewed independently of citations
  • Added a single-letter link for Images.
  • The single-letter links within source citations are defined as language strings, instead of being derived from the initial letters of Source, Citation, and Image
v12.0.0.18 12.0+ 5May2019
  • This mod is no longer dependent on Regroup Person Profile.
  • Fixed a bug that was not displaying the source author in most cases.
  • Improved some of the formatting details of citation details and defined language strings for some field labels.
v12.0.0.16p 12.0+ 24Jul2018 No functional changes; made compatible with TNGv12
10.0.1.16p 10.1.0-11.1.2+ 07Nov2017 Removed the second line from the cust_text.php target location search string
10.0.1.15 10.0.1-10.1.3 20Feb2016 Initial release; separated this mod from the larger Regroup Person Profile mod to eliminate a conflict with that mod. Started with version 15 to be inline with Regroup Person Profile version numbers.

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 13.0.0.19 13 English
Baza danych Rodziny Jarocińskich Michał Jarociński non-public site 13.0.0.19 13.0.1, T7 PL, EN