View source for Relationship to Site Owner Mod

{{TNGmod
| mod_name        = Relationship to Site Owner
| mod_summary     = Adds a line to the getperson.php page if the person displayed is related to a single, predefined person - typically this would be the Site Owner - in the database.
| mod_validation = XHTML compliant.[[Image:Valid-xhtml10.png|44px]]
| download_link   = [http://lisaandroger.com/downloads/download-info/tng-11-0-relationship-to-site-owner-mod/ TNG 12.0.0.6 Relationship to Site Owner Mod] for {{Tv130}}{{Tv120}}<br /><hr  />[http://lisaandroger.com/download/3561/?version=11-0-0-2 TNG 11.0.0.2 Relationship to Site Owner Mod] for {{Tv110}}<br /><hr  />[http://lisaandroger.com/downloads/download-info/tng-10-1-relationship-to-site-owner-mod/ TNG 10.1.0 Relationship to Site Owner Mod] for {{tv1010}}<br /><hr  />[http://lisaandroger.com/downloads/download-info/tng-10-0-relationship-to-site-owner-mod/ TNG 10.0.0 Relationship to Site Owner Mod]<br /> for {{tv100}}<br /><hr  /> [http://lisaandroger.com/downloads/download-info/tng-9-2-2-relationship-to-site-owner-mod/ TNG 9.2.2 Relationship to Site Owner Mod] for {{Tv922}}<hr  />[http://lisaandroger.com/downloads/download-info/tng-9-1-relationship-to-site-owner-mod/ TNG 9.1.x Relationship to Site Owner Mod] for {{Tv91}}
<br />
| mod_author      = Roger Moffat - based on relationship.php by Darrin Lythgoe as part of TNG
| mod_url         = [[Relationship to Site Owner Mod]] (This page)
| mod_support     = [http://tng.community/ TNG Community Forums]
| mod_version     = v12.0.0.6 for TNG V12.x and TNG V13.x<br />v10.1.0.0 for TNG V10.1.x and TNG V11.x.x<br />v10.0.0.0 for TNG V10.0.x<br /> v9.2.2.0 for TNG V9.2.2<br />v9.1.0.1 for TNG V9.1
| use_mod_manager = Yes
| min_TNG_ver     = 9.1.0
| max_TNG_ver     = 13.0.0
| TNG_file_list   = getperson.php<br/>genlib.php<br>languages/English/cust_text.php<br>languages/English-UTF8/cust_text.php
| related_mods    = [[Relationship Display Mod]] by Jeff Robison
| notes           = 
}} 

{|align=right


|__TOC__
|} 

== Purpose of the Mod ==
This Mod adds a line near the top of getperson.php that indicates the relationship of the person on the page to a single, predefined individual - usually the TNG Site Owner - in the database. If there is no relationship that is also listed.

It uses JQuery to load the line after getperson.php has been loaded, so that the sometimes intensive calculations behind the relationship do not slow down the loading of getperson.php.

It does not load this line if the page is being viewed by a bot, so not letting the server get bogged down by a fast moving web bot.

It allows for configuration of:
* the single individual in the TNG Database to calculate relationships from
* a list of bots for which the line is not shown.
* how many relationships to calculate if the person and the Site Owner are related in more than one way. This is a separate setting from what is in TNG Admin for Relationships.

== Developer ==

This Mod was developed by Roger Moffat. The relationships are calculated using a stripped down version of relationship.php - part of TNG by Darrin Lythgoe.

== Downloads ==
For TNG 9 up to TNG 9.2.1
Download the .cfg file from:
* [http://lisaandroger.com/downloads/download-info/tng-9-1-relationship-to-site-owner-mod/ TNG 9.1 Relationship to Site Owner Mod]

For TNG 9.2.2 
Download the .cfg file from:
* [http://lisaandroger.com/downloads/download-info/tng-9-2-2-relationship-to-site-owner-mod/ TNG 9.2.2 Relationship to Site Owner Mod]

For TNG 10.0.0 up to TNG 10.0.3
Download the .cfg file from:
* [http://lisaandroger.com/downloads/download-info/tng-10-0-relationship-to-site-owner-mod/ TNG 10.0.0 Relationship to Site Owner Mod]

For TNG 10.1.0 up to
Download the .cfg file from:
* [http://lisaandroger.com/downloads/download-info/tng-10-1-relationship-to-site-owner-mod/ TNG 10.1.0 Relationship to Site Owner Mod]

For TNG 11.0.0 up to
Download the .cfg file from:
* [http://lisaandroger.com/download/3561/?version=11-0-0-2 TNG 11.0.0 Relationship to Site Owner Mod]

For TNG 12.0.0 up to
Download the .cfg file from:
* [http://lisaandroger.com/downloads/download-info/tng-11-0-relationship-to-site-owner-mod/ TNG 12.0.0 Relationship to Site Owner Mod]

==Revision History==

{| border="1" cellspacing="5" cellpadding="2" width="75%" class="wikitable"
|-
! Version
! Date
! Description
|-
| V12.0.0.6
| 29 October 2020
| 
*Updated include ability to store settings outside the .cfg file so that they survive across Mod updates. Thanks to [[User:KenRoy|Ken Roy]] for this change that allows the settings for primary person ID and treeID to persist across updates to the Mod
|-
| V12.0.0.5
| 26 October 2020
| 
*Updated to latest relationship.php to correctly calculate more distant relationship
|-
| V12.0.0.4
| 23 October 2020
| 
*Updated to include Czech, Dutch, and German translations
|-
| V12.0.0.3
| 3 October 2020
| 
*Updated for TNG 12+ Mod Manager syntax
|-
| V11.0.0.2
| 15 October 2018
| 
*Fix to show half cousins
|-
| V11.0.0.1
| June 2016
| 
*Minor changes for TNG 11
|-
| V10.1.0.1
| 30 August 2015
| 
*Minor tweak to encode the & symbol so the Mod passes validation.
|-
| V10.1.0.0
| 13 February 2015
| 
*Change required for TNG 10.1.0 changing from mysql_ queries to mysqli_ queries.
|-
| V10.0.0.0
| 6 February 2014
| 
*Change required for TNG 10.0.0. Also now includes a "not related to" statement if there is no relationship.
|-
| V9.2.2.0
| 8 Aug 2013
| 
*Change required for TNG 9.2.2.
|-
| V9.1.0.1
| 24 May 2013
| 
*Page load problem when switching language fixed - thanks Jeff Robison for the heads up.
|-
| V9.1.0.0
| 10 March 2013
| 
*Relationship calculated AFTER the page has loaded
*Configurable list of bots so the relationship won't' calculate when a bot is accessing the page.
*Parameters to set the Tree and PersonID to calculate the relationship from.
|}

== Automated Installation ==
# Download the mod from the link above. Extract the .cfg file and then upload it to the '''mods''' folder on your site.
# Follow the normal automated installation for Mod Manager, as shown in the example [[Mod Manager - Installing Config Files]] to install.
# Once installed, you need to click on the Edit button beside the Mod in Mod Manager to set the PersonID and Tree for the person relationships are calculated from. (See screen shot below). The Edit screen for the Mod allows you to set:

:: ID of the person to base calculations from. Defaults to (I1)
:: Tree the base person to base is in. Defaults to (tree1)
:: List of "bots" excluded. Defaults to (google, yahoo, baidu, msnbot)
:: Maximum number of relationships to show. A similar but separate setting is found in TNG Admin -> Setup -> Chart Settings -> Relationship -> Initial Relationships. Defaults to (5)

== In the event of a problem ==
* Try using the [[Mod_Manager_-_Installing_Config_Files#Remove_Mod_Steps|Mod Manager Remove]] capability

== Custom Text Additions == 

'''Note:''' The config file includes the English, Czech, Dutch and German languages. Specifically English, English-UTF8, Czech-UTF8, Dutch, Dutch-UTF8, German, German-UTF8. If you support other languages you can either:
# modify the config file to add the custom text for those other languages or
# manually add the following custom text to each of your other languages with appropriate translations. e.g. if your site uses '''Spanish-UTF8''' you'd add the translations to your languages/'''Spanish-UTF8'''/cust_text.php file

<syntaxhighlight lang="php" enclose="div">

// For Relationship to SiteOwner line on getperson.php
$text['siteowner'] = $dbowner . " (the owner of this site)";
$text['clicktoviewrelationship'] = "Click to View Relationship";
$text['within'] = " within ";
$text['isnotrelatedto'] = " is not related to ";

</syntaxhighlight>

and then provide the appropriate translations.

Note that the Mod's .cfg file is saved as UTF-8 (no BOM), so if your site is running latin1/Windows collation, then you will need to open the .cfg file in a Text Editor and save it as Windows/Latin1 (or something similar) before uploading it to your site. This is to preserve any accented characters you might be using. This is also the reason that the Mod supports Dutch and German both Latin1 and UTF-8, but not Czech (Latin1) - there are no accented characters in the Dutch and German (and of course English) translations, but there are accented characters in the Czech translations.

== Visualization of this mod ==

==== On getperson.php page ====
If there is a relationship, it is described:
{|
|
|[[File:RelationshipToSiteOwner.png|right]]
|}
----
If there is no relationship, that is stated:
{|
|
|[[File: NotRelatedWithinxxxGenerations.png |right]]
|}
----

====Admin Configuration Options====
===TNG 9 & 10.0.x===
The configuration options from within Mod Manager to change the person from whom relationships are calculated, how many relationships to calculate if there's more than one between the 2 people, and the list of bots from which the line is hidden
{|
|
|[[File:RelationshipToSiteOwnerConfiguration.png|right]]
|}

===TNG 10.1.x, 11.x, 12.x, & 13.x===
The configuration options from within Mod Manager to change the person from whom relationships are calculated, how many relationships to calculate if there's more than one between the 2 people, and the list of bots from which the line is hidden
{|
|
|[[File:RelationshipToSiteOwner_10.1.png|right]]
|}

== TNG User sites using this mod ==
Please add TNG sites that you have found that utilize this modification
{| border="0" cellspacing="1" cellpadding="2" class="wikitable"
|-
! URL
! User
! Note
! Mod-Version/TNG-Version
! User-language
|-
| [http://lisaandroger.com/genealogy/getperson.php?personID=I16&tree=Roger Roger's Genealogy Online]
| [[User:TheKiwi|Roger Moffat]]
| Mod developer (Public site)
|V12.0.0.3/TNG 13.0.0
|English
|-
| [http://legacygazette.com Legacy Gazette: My Roots - My Legacy]
| [[User:Mylegacy|Melissa Watson Padilla]]
| 
| 9.1.0.0/TNG 9.2.1
| EN
|-
| [http://teresa-goatham.me.uk/genealogy/home.php Teresa's Tree]
| [[User:Teresa|Teresa Goatham]]
| Public site
| 9.1.0.1/TNG 9.2.1
| EN
|-
| [http://www.maarelweb.nl/stamboom/surnames100.php/ Van der Maarel Genealogy]
| [[User:Edward|Edward van der Maarel]]
| 
| 10.0.0.0/TNG 10.0
| EN, NL
|-
| [http://www.overtonmedia.com/tng Steve's Family Tree]
| [[User:Steve Overton|Steve Overton]]
| Private site
| v10.0.0.0/TNG 10.0.0
| EN
|-
| [http://williamsfamilytree.co.uk The Williams Family Tree]
| [[User:RottenSod|Phil Williams]]
| Public Site
| v10.0.0.0/TNG 10.0.3
| English
|-
| [https://genealogywings.com/ MOTYER Family Genealogy]
| [[User:JMM|John Mark Motyer]]
| Public site
| [[User:JMM|see here]]
| EN, DE, RU
|-
| [https://www.gambrillfamilytree.com/ Gambrill Family Tree]
| [[User:bobbyfamilytree|Bobby Gambrill]]
| Public site
| v10.1.0 / TNG 12.0
| EN
|-
| [http://justalittleleaf.co.uk Genealogy of the Weir and Drain Families]
| [[User:BeverleyStimpson|Beverley Stimpson]]
| Public Site
| 11.0.0.1        
| EN
|-
| [http://theroadtoethel.com/genealogy/index.php The Road to Ethel]
| Alicia Clemmons
| Public site
| TNG v. 12.0.3
| EN
|-
| [https://www.schuster-pippersteiner.at/genealogie/ Schuster-Pippersteiner]
| [[User:pipsi|Ingrid Schuster]]
| Public site
| V12.0.0.4/TNG 13.0.0
| DE, CS, EN
|-
|}
[[Category:Mods for TNG v9]]
[[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:genlib.php mods]]