Difference between revisions of "Regroup Person Profile"

From TNG_Wiki
Jump to navigation Jump to search
Line 7: Line 7:
 
| mod_last_update = 20 Jan 2019
 
| mod_last_update = 20 Jan 2019
 
| download_link  =  [[Media:regroup_person_profile_v12.0.0.17.zip|v12.0.0.17]]{{Tv120}}
 
| download_link  =  [[Media:regroup_person_profile_v12.0.0.17.zip|v12.0.0.17]]{{Tv120}}
<div>[[Media:regroup_person_profile_v12.0.0.17.zip|v12.0.0.17]]
 
 
| download_stats  =
 
| download_stats  =
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]
 
| mod_author      = [[User:Robinrichm|Robin Richmond]]

Revision as of 06:59, 17 September 2019

Construction This article is just beginning the transition to Version 18 of this mod. Version 18 is not yet available for downloading.

Robin Richmond, 17 Sep 2019

Construction


Ambox notice.png The latest version of this mod uses the guidelines for TNG v12+ cust_text.php files. If you are using TNGv12+, and any cust_text.php file in this mod is marked with a Bad Target error, you need to update your cust_text.php files before you can install this mod. [Show instructions]

If you upgraded to TNGv12+, and did not update your cust_text.php files as instructed in the upgrade readme script, then you must use the TNG Mod Manager to update them. To do so:

  1. Go to Mod Manager, and select its "Recommended Updates" tab.
    (If the "Recommended Updates" tab is not visible, then go to the Mod Manager Options tab, select "Display Settings", and turn on the "Recommended Updates" tab.)
  2. Click the "Update" button in the "Recommended Updates" tab.
    Installed mods do not interfere with the update, and if you already have (or think you may have) run this update, it will not hurt for you to run it again.

[See details in the TNGv12 Change Impacts Article][Hide the instructions]

TNG 14.0
TNG 13.0
TNG 12.0


Regroup Person Profile
Summary Moves things around on the Person Profile page (getperson.php), and compresses whitespace a bit.
Validation
Mod Updated 20 Jan 2019
Download link v12.0.0.17
TNG 12.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 12.0.0.17
Min TNG V 12.0
Max TNG V at least 12.0.3
Files modified
getperson.php, personlib.php, genlib.php, globallib.php, css/genstyle.css, English cust_text.php, Norwegian cust_text.php
Related Mods
The Regroup Person Profile family of mods
Notes


Purpose of the Mod

To rearrange the data in the person profile in a way that I find more readable, with less scrolling. Here's a partial list of changes:

  1. Just the most basic Person information is listed first, then parents, marriages, and "Other Personal Data".
    • Basic information includes Name, Birth, Death, Burial, Cause of Death (_DCAUSE), Alias (ALIA) and Race events, and (I think) LDS events.
  2. Subheadings have been added above parents, marriages, other personal data, the event map, and source citations. The parent and marriage headings include (on the right) the familyID, date of change, and links to the family group sheet, family, family chart, and family edit screen (as appropriate to the user's rights), and
  3. I've moved metadata to the heading, right below the person's name, next to the thumbnail photo. Metadata includes the personID, tree, and edit date.
    • All personIDs are displayed so that the "I" is displayed with an alternate font, distinguishing it from from a lower-case l or a 1.
  4. The Event Map is enlarged a bit, as I've eliminated the mostly-blank left-hand column. It can also be hidden and re-displayed.
  5. The Source box is also enlarged with the elimination of the mostly-blank left-hand column. New bolding of the Source titles improve readability a bit.
  6. In the print-friendly page format, I ignore the cell height for the Sources, figuring that, when you print the page, you want to see all of the sources.

See also the subheading Related Mods, some notes under Incompatible Mods, the Visualizations, and additional comments in the .cfg file itself. }}

Mod options

In mod versions before version 18, this mod has two Mod Parameters:

  1. A value that controls whitespace within the HTML data tables by adjusting HTML cellpadding attribute. The TNG default is cellpadding=4. This mod's default is cellpadding=2, but the padding of 4px can be restored (or increased) with this parameter.
  2. A flag that determines whether to display person ID's for each parent, spouse, and child.

In version 18 (not yet published), this mod has six custom TNG settings, which are defined and edited in the form at Admin>>Setup>>General Settings, in the new subform Robin's Mods, where the options for various mods are organized into Mod Settings Blocks.

  1. Spacing - Controls whether the Name/Birth/Death/Age data for relatives (parents, spouses, children, siblings) has "more" or "less" spacing. "More" means the data occupies 3 lines.
  2. SpacingControl - Whether there will be a spacing control at the right end of the Inner Menu that can change the spacing above.
  3. AgeFormat - 'Original': (75 years), or 'New': (Age 75) or (Living, Age 75)
  4. ShowRelativesIDs - Whether to show the PersonID of relatives.
  5. SiblingsBlock - Whether and where to display the person's siblings. (no / in the parents data block / in the person's primary data block). Note that, in the person's primary data block, "siblings" means "siblings of the person", and in the parents block, "siblings" means "all of the siblings (including the primary person)".
  6. SiblingsAtStart - The number of siblings to show before the rest are hidden behind a "show more" link. "0" means "always show them all"

Note that the "Spacing" and "SpacingControl" options coordinate with identically named options in Regroup Person-Date Place so that both values are the same, and only one spacing control is created on the Inner Menu. Javascript code in admin_genconfig.php keeps the options in sync.

Other Mods

Many, many mods affect the Person Profile. These notes cannot cover them all.

Related Mods

These mods in the "Regroup Person family" are all compatible, and all can be installed independently. Note that Regroup Person Profile and some of these mods have side effects in some other TNG programs.

  1. Regroup Person Profile - This mod
  2. Regroup Person-Date Place - Combines event date, place, and description into one table cell
  3. Regroup Person-Move Media - Moves the media files above the map
  4. 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.
  5. Regroup Person-Parent Rel - Hides "natural" or "birth" relationships between the person and the parents.
  6. 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..

Also, this mod generates information that can be used by Show Mod Names, but it does not depend on Show Mod Names.

Compatible Mods

This is not a complete list of compatible mods that affect the Person Profile.

Incompatible Mods

This may not be a complete list of incompatible mods. Please contact me if you run into any other conflicts.

Interdependencies

Installation

This mod uses the standard installation procedure, though it should be noted that this mod contains a mod subfolder that is shared with other mods whose options are organized as Mod Settings Blocks in Admin>>Setup forms. Because of this shared folder, as you unzip or copy the mod, you might get a warning noting that a file or folder already exists. You can just ignore that warning.

[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

Revision History to learn what is different about version 18.

1. BEFORE AND AFTER OVERVIEW

Click on the image below to see larger side-by-side non-annotated before and after images. Note that the media files have been clipped out because they haven't changed. But the personal and family data is now laid out differently, the Event Map is now slightly wider, and the Sources, by default, show only the titles, not the full citation information. (Note that Some of the changes shown in the visualizations are now implemented by other mods that were extracted from earlier versions of Regroup Person Profile). In particular, Regroup Person-Date Place now combines the date, place, and description for an event into one cell in the display table.)

Regroup person profile-both.png
2. BEFORE: The personal data section of the original version of the Personal Profile.

The red comments describe some of the changes that the mod will make.

Regroup person profile-before1.png
3. AFTER: The personal AND family data in the new format
  1. Personal meta-data has been moved to the heading.
  2. The white space between blocks of data is now occupied by headings and metadata.
  3. The words "wife" and "husband" are substituted for "spouse" in the Family block
  4. The indentation of data about children has been improved.
  5. This visualization does not show the Person ID's that are (optionally) placed after the names of parents, spouses, and children.)
Regroup person profile-after1.png
4. AFTER: The new Event Map

The map is wider than before because the mod has eliminated the colored left-hand column, and put the Event Map label in the whitespace above the map. It has also modified the layout of the first pin legend so it wastes less space, and so that it wraps more cleanly when the page is narrow enough to require wrapping. Also note the button outlined in red at the top right, which changes to "Show Event Map" when the Event Map is hidden.

Regroup person profile-after-map.png
5. AFTER: The new Sources block

Like the Event Map, the Sources block no longer uses the colored left-hand column, and its label (now "Source Citations") is in the whitespace above the sources. The Regroup Person-Sources mod adds substantial functionality to the Source Citations block. It can remove details from each Source Citation, and provides button and links that display Source and/or Citation details.

Regroup person-after-sources.png

Controlling White Space with Classes

Aside: Vertical whitespace can produce a feeling of "openness" in web pages and other media. But sometimes it unnecessarily reduces the amount of data that can be seen at once, and increases the need for users to do vertical scrolling. So I've been known to push back a bit - especially when whitespace is provided by <br> tags rather than style rules. To that end:

  1. This mod uses styles to decrease the whitespace between the HTML tables that define various sections of the Person Profile (basic personal data, parents, families, the event map, media items, etc.). This mod provides 1ex of whitespace in the bottom margin of each table. You can increase that whitespace with a style rule such as .datatable {margin-bottom:1em;} at the bottom of your genstyle.css or in your template's mytngstyle.css.
  2. This mod removes a hard break from the end of the TNG "innermenu". Whitespace below the innermenu can be restored by a style rule such as .pub-innermenu {margin-bottom:1em;} at the bottom of your genstyle.css or your template's mytngstyle.css.
    • The "innermenu" is a horizontal menu on most TNG pages that appears immediately below the "Tab menu". It usually has white text on a dark background, and its links are almost always separated by vertical bars. In the Person Profile, the innermenu looks something like this:
      Personal Information  |  Media  |  Notes  |  Source Citations  |  Event Map  |  All  |  PDF  
    • This change affects not just the Person Profile, but most TNG page headings. However, the .pub-innermenu style rule shown above will restore whitespace to all affected pages.

Modifying Style Rules

When you want to modify the effect of a style rule defined in the master TNG stylesheet, css/genstyle.css, you should not edit the existing rule. This is especially true for style rules added by a mod, but is also true of "native" styles. If you edit a mod-defined rule, you will break the mod's installed status, and, in either case, your change will likely be lost with any TNG upgrades. Instead, as indicated by the instructions above, you should define a new style rule for the same style class, focus on the style attribute you want to change, and place your new rule

  • At the very bottom of genstyle.css, or
  • In the stylesheet file mytngstyle.css in your template's css folder (which is empty in fresh TNG installations).

Note that your template's mytngstyle.css folder may be the safer of these two options, since it is easier to backup the entire mytngstyle.css file than to backup a set of rules inside genstyle.css. But, of course, if you use more than one template, the style rules that you put in a template's mytngstyle.css will need to be duplicated in the all of the other templates you use.

Formatting Person and Family IDs

In order to distinguish the leading "I" of a person ID from a "1" or a lower-case "l", this mod displays PersonIDs and FamilyIDs with style classes that change the font of the ID's.

Revision History

Mod Version TNG Version Date Note
12.0.0.17 12.0+ 24 Jul 2018 Fixed a typo that was preventing the marriage block displaying the words "Wife" or "Husband".
12.0.0.16p 12.0+ 24 Jul 2018 No functional changes; made compatible with TNGv12.
11.0.0.16p 11.0-11.1.2+ 28 Mar 2016 No functional changes. Removed the second line of the cust_text.php target location search strings.
11.0.0.16a 11.0-11.1 28 Mar 2016 Updated for TNGv11. Added Race to the set of events that I have moved from the Other Personal Events table to the main personal events table.
10.0.1.15a 10.0.1-10.1.3 10 Mar 2016 Fixed an old bug in location 33 that erased the event map if any notes were attached to the person rather than to an event.
10.0.1.15 10.0.1-10.1.3 20 Feb 2016 - Moves some Source Citations functionality to [[Regroup Person-Sources] to establish compatibility with Citation Master.
- Implemented Show Mod Names functionality.
- Fixed a bug that disabled the scrolling of citations.
- Eliminated a TNGv10.1 database function call in one target location.
10.0.1.14f 10.0.1-10.1.2 19 Jul 2015 - Followed more of Jeannette Wickham's suggestion and added name facts and events to the primary personal data block, instead of "Other Personal Data".
- Fixed two old bugs in my code that put some notes in narrow columns.
- Fixed another old bug that caused some event source citation links not to be enclosed in brackets.
- Added Norwegian translation of cust_text strings, courtesy of Ørjan K. Albriktsen.
- Moved code to accommodate the Public Access Control mod.
10.0.1.14 10.0.1-10.1.1 08 Jul 2015 Folded Regroup Person-Other IDs back into this mod. Followed Jeanette Wickham's suggestion to put cause of death plus secondary birth, death, and burial events in the data block at the top of the page instead of in the "Other Personal Data" block. Now works with Default Photo Preview. Improved code comments. Reintroduced some of the whitespace that I had eliminated by removing <br/> tags.
10.0.1.13 10.0.1-10.1 03 Jan 2015 Had to restore some trailing spaces to some lines of code, because I had mistakenly tested the mod with a beta version of Mod Manager that was deleting trailing spaces.
10.0.1.12 10.0.1-10.0.3 27 Dec 2014 Moved some functionality from this mod to five new mods whose names also begin with "Regroup Person".
10.0.1.11 10.0.1-10.0.3 10Aug2014 Modified the way Person and Family ID's are displayed, and added the capability of displaying Person ID's for parents and children.
10.0.1.10 10.0.1-10.0.2 23 Jun 2014 Fixed a bug that broke hyperlinks to husband or wife if the string "Family" is in the tree ID.
10.0.1.9 10.0.1-10.0.2 1 3May 2014 Now handles sub-event data entered in TNG, like Agency, Cause, Address, etc.
10.0.1.8 10.0.1-10.0.2 12May2014 Changed a hard break to a div to work better with Relationship Display Mod, and moved the changes in cust_text from the top of the file (where, I've learned, some people don't have the distribution comments) to the bottom of the file.
10.0.1.7 10.0.1-10.0.2 30Apr2014 Fixed to work with TNG v10.0.2 as well as v10.0.1
10.0.1.6 10.0.1 26Apr2014 Used classes more effectively and eliminated some side effects that could show up in other TNG modules.
10.0.1.4 10.0.1 21 Apr 2014 Accommodated the installation of Geocode Assist Mod and Wiki Integration. Displays the "I" in the Person ID in a font that distinguishes it from "l" and "1".
10.0.1.3 10.0.1 17 Apr 2014 Removed a couple of changes and changed a couple of others to improve compatibility with other mods - specifically Family Preview Mod and mods that tweak the Event Map Pins legend.
10.0.1.2 10.0.1 16 Apr 2014 Fixed bugs that (1)repeated marriage information for people with multiple marriages & (2) didn't always display the person id number and edit date. Also accommodated another mod.
10.0.1.0 10.0.1 15 Apr 2014 Initial release.

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 12.0.0.17 12.0.3 English
Turner mob family Genealogy Margaret Turner Public site 10.0.1.14d 10.1.1 EN
Stamboom Jongman Roel Jongman Public/Private site 10.1.0.15a 10.1.3 NL, DE, EN
The Road to Ethel Alicia Clemmons Public site 12.0.0.17 12.0.3 English