Married Name Display

From TNG_Wiki
Jump to navigation Jump to search
Married Name Display
Summary This mod adds a married woman's husbands surname to displays like 'Wilma Flintstone (nee Quartz)'.
Validation This mod is XHTML compliant.Valid-xhtml10.png
Mod Updated 19 Feb 2021
Download link For
TNG 15.0
TNG 14.0
TNG 13.0
v13.0.3.0
For
TNG 12.0
v12.1.0.2
Download stats none
Author(s) Larry Lewis
Homepage Jenolan's CESS
Mod Support TNG Community Forum
Contact Developer via TNG Forum
Latest Mod 13.0.3.0
Min TNG V 12.0.0
Max TNG V 15
Files modified
globallib.php
admin_people.php
languages/English/cust_text.php
languages/English-UTF8/cust_text.php
languages/German/cust_text.php
languages/German-UTF8/cust_text.php
languages/French/cust_text.php
languages/French-UTF8/cust_text.php
Related Mods
Notes

Introduction

This mod adds a married woman's husbands surname to displays like 'Wilma Flintstone (nee Quartz)'.
This mod is for use where traditionally the female assumes the male family name, it is not a design error, if your usage is not compatible do not install the mod

Developer

This mod was developed by Larry Lewis.

Requirements

  • A working TNG installation.
  • A backup of all affected files (see the list in the summary in the upper right corner of the page)
  • An installed current version of the Mod Manager.
  • Both English and English-UTF8 folders be on your site

Revision History

Mod Version TNG Versions Date Note
13.0.3.1 13.0 In progress
  • Added switch to not process a female without a husband
  • Added option to not process if female marriage type is excluded
  • Will not add the nee if the record does not have a surname
  • Mod source now with defaults set correctly
  • Added function to enable/disable mod per page (see instructions)
  • Added function to modify the display format per page (see instructions)
13.0.3.0 13.0 19 Feb 2021 Updated to TNG 13.0.3
12.1.0.2 12.0 1 Apr 2019 Added ability to modify search SQL. Handle case where maiden name is empty
12.1.0.1 12.0 19 Mar 2018 Internationalisation added thanks to Jürgen (German, French)
12.0.0.0 12.0 18 Mar 2018 Initial version of the mod.

Conflicts and Issues

No known conflicts.

Installation

  1. Uninstall and delete previous version of this mod (if installed)
  2. Download the appropriate zip file as shown in the mod summary in the upper right corner of the page.
  3. Extract the file from the downloaded zip file into the mods folder or FTP the extracted file to your mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  5. The order of the 'marriages' decides which male name to use, make sure that your marriages are ordered correctly by date
  6. *** Spouses can be sorted by marriage date in Admin:Import/Export: Secondary Processes: Sort Spouses ***

In the event of a problem

  • Try using the Mod Manager Remove capability.
  • Copy the backup of the affected files back to your TNG directory.
  • Retry installing mod.
  • Contact me via TNG Forum.

Uninstalling the mod

If you want to completely Remove (uninstall) this mod and any tables if created, you should

  1. click the Uninstall button to uninstall the mod
  2. click the Delete button to delete the config file from the mods folder.

Upgrade

  • Uninstall and eventually Delete the current Mod.
  • Proceed as for an installation with the new Mod.

Visualization

The following screen capture shows the change made by the mod:
Left

Standard Options

All of the following add additional conditions to retrieve the marriage status. You may choose which ones are active depending on your preferences. For example you may or may not like having a divorced female revert to their maiden name. You may enable/disable the options as you like.

Married Type

If you set the value to '1' for this option Married Name Display will not occur if the family 'Marriage Type' (field 'marrtype') has not been set to a non-empty value.

Married Date

If you set the value to '1' for this option Married Name Display will not occur if the family 'Married Date' (field 'marrdate') has not been set to a non-empty value.

Divorced (Date)

If you set the value to '1' for this option Married Name Display will not occur if the family 'Divorced Date' (field 'divdate') has been set to a non-empty value.

No Husband Switch

If you set the value to '1' for this option Married Name Display will not occur if the family has no 'Husband' set. This should not really be required as a single parent (female only) family should already work this way. This option added by request so it must apply in some instance and require handling.

Display Format

As opposed to the page by page option available in the advanced options, you may set the way Married Name Displays the maiden/married name globally with this optn.

There are five substitution parameters, see the mod option display. You may add literal characters to suit, see examples below. Please note that the @nee@ is used so that the value is as per language translation requirements.

Format String Display
@husband_last@ @open@@nee@ @female_last@@close@ Flintstone (nee Quartz)
@husband_last@ @open@Previously @female_last@@close@ Flintstone (Previously Quartz)
@open@@female_last@@close@ @husband_last@ (Quartz) Flintstone

Advanced Options

Caution You are able to enable/disable the display and change the formatting of the mod per page, this will require that you construct you own mod or modify TNG files directly (not recommended).

Please remember in your mod to check that married name display is active as shown in the example. 		Caution

Toggle Display

You can enable/disable mod processing my calling the function marriedNameDisplaySet() to turn on use 'true' to turn off use 'false' eg marriedNameDisplaySet( true ) to enable processing, calling with no argument will return the current setting.

If you need to turn off processing for a page do something like;

if( function_exists( 'marriedNameDisplaySet' ) )
{
    marriedNameDisplaySet( false );    ## Turn off Married name display
}

Disable married name in showmedia.php 

%target:showmedia.php%
%location:%
		$namestr = getName( $row );
%end:%
%insert:before%
		if( function_exists( 'marriedNameDisplaySet' ) )
		{
			marriedNameDisplaySet( false );    ## Turn off Married name display
		}
%end:%
%location:%
		$namestr = getName( $row );
%end:%
%insert:after%
		if( function_exists( 'marriedNameDisplaySet' ) )
		{
			marriedNameDisplaySet( true );    ## Turn on Married name display
		}
%end:%

Modify Display Format

You can change the format of the displayed string by calling marriedNameDisplayFormat() pass the required string format as the argument eg;

1marriedNameDisplayFormat( ' @open@@female_last@@close@ @husband_last@' )

If you need to restore the original format do something like;

1if( function_exists( 'marriedNameDisplayFormat' ) )
2{
3    $fmtString = marriedNameDisplayFormat();    ## Get current format
4    marriedNameDisplayFormat( ' @open@@female_last@@close@ @husband_last@' ); ## Set temporary format
5}
6// do whatever
7if( function_exists( 'marriedNameDisplayFormat' ) ) marriedNameDisplayFormat( $fmtString );  ## Restore format

non-Tradional Marriage

Caution This is a potentially dangerous process Caution

If you are unable to use the various switches to achieve the desired display and you are recording in the 'Married Type' unique information that will identify a union that should not have the Married Name Display handled then you may add the type(s) to the option as a comma separated list of types like;

Single type unmarried
Multiple types unmarried,not married,other

Languages

Translations for German and French text provided by Jürgen. If you want to use it with a different language, add the correct text (between double quotes) in the code below and add to your cust_text.php file in the appropriate language folder. 

// ********** START: Married Name Display language files
$text['nee'] = "nee";
// ********** END: Married Name Display language files

To have an additional translation added to the Mod please provide the localisation string and language to Larry.

Sites using this mod

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

URL User Note Mod-Version TNG-Version User-language
Jenolan's CESS Larry & Helen Lewis Mod developer 13.0.0.0 13.0 EN
Genealogy of the van Heerden Family Emile van Heerden Owner 12.0.0.0 12.0 EN
adupree.com A.Scott DuPree Owner 12.0.0.0 12.0.3 EN
www.vidunge.com Hans-Eric Holmqvist Owner 13.0.3.0 13.0 SV
Roots & Relatives Remembered Ron Krzmarzick changed to fname (bname) mname header only See here See here EN,DE,CS
Lathrope Family Genealogy S Sharpe Public 13.0.3.1 13.0.4 EN
Delvee Family Association Rob Roy Public 13.0.3.0
TNG 15.0.1
EN
The Sky Tree Nestor Holynskyj Public 13.0.3.0 13.1.1 EN
Retrieved from "https://tng.lythgoes.net/wiki/index.php?title=Married_Name_Display&oldid=98210"