Broad Search mod

Broad Search mod
Broad Search mod
Summary	Allows quick search for a name using nicknames, aliases, married names
Validation
Mod Updated	30 May 2023
	TNG 14.0.2
	TNG 13.0.1
	TNG 11.1
	TNG 12.0
Download stats	Statistics
Author(s)	Chris Moss
Homepage	Broad Search mod (This page)
Mod Support	TNG Community Forums
Contact Developer	TNG Community Forums
Latest Mod	14.0.2.4d
Min TNG V	11.1.0
Max TNG V	14.0+
Files modified	search.php; genlib.php; languages/English-UTF8/cust_text.php; languages/English/cust_text.php; languages/Dutch-UTF8/cust_text.php; languages/Dutch/cust_text.php; languages/German-UTF8/cust_text.php; languages/German/cust_text.php; languages/French-UTF8/cust_text.php; languages/French/cust_text.php; languages/Spanish-UTF8/cust_text.php; languages/Spanish/cust_text.php; index.php (all templates); topmenu.php (some templates); templatestyle.css (template 4),
Related Mods	Married Name in Search Mod (incompatible)
Notes	None

Purpose of the mod

This TNG modification allows quick search for a name using nicknames, aliases, married names.

Developer

This mod was developed by Chris Moss.

Requirements

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

Revision History

Mod Version	TNG Version	Date	Contents
14.0.2.4d	14	30 May 2023	Updated for TNG 14 & edit option fixes, tested with Expand Search mod -- Ron Krzmarzick
13.1.0.5	13.1	09 Sep 2021	Updated for TNG 13 including eliminating warnings, so more future-proof
13.1.0.4c	13.1	02 Oct 2020	Updated for TNG 13 -- Ron Krzmarzick
11.1.0.4c	11.1	19 Jul 2018	Template 7 top menu option didn't show. Thanks Gershon.
11.1.0.4b	11.1	09 Feb 2018	Corrections for bugs in search query
11.1.0.4a,	11.1	09 Feb 2018	Corrections for bugs in search query
11.1.0.4	11.1	27 Dec 2017	More efficient search, particularly first name or last name only
11.1.0.3	11.1	07 Nov 2017	Optimise search, use variable names for tables
11.1.0.2b	11.1	20 Jun 2017	Make XHTML 1.0 compliant and correct search for ids and searches with quotes
11.0.0.1e	11.0	20 Jun 2017	Make XHTML 1.0 compliant and correct search for ids and searches with quotes
11.1.0.2a	11.1	12 Jan 2017	Correct version number
11.1.0.2	11.1	11 Jan 2017	Adjust for TNG v11.1 and regularise tick boxes
11.0.0.1d	11.0	15 Dec 2016	Make searches in large databases efficient
11.0.0.1b	11.0	12 Dec 2016	Correct continuation search pages & syntax error in translations
11.0.0.1a	11.0	11 Dec 2016	Correct numbering for multiple solutions and minimise conflict with Married Name in Search Mod

Introduction

Broad Search mod adds an option button to the quick search which generalises the search to include:

the married name of women
nicknames
the contents of NAME events (can be changed)
the contents of ALIA events (can be changed)

This mod is an alternative to and generalisation of Married Name in Search Mod and is incompatible with it. So you need to decide which one to use and uninstall the other before installing this module.

An extra column marked "Other name" in the results indicates the alternative string that has been used in the search. Because nicknames and aliases can include both first and last names, in some cases the string can be duplicated in this column.

Customisation is provided for all templates. It is also possible to set up the broad search as the default.

Caution: in earlier versions with large databases (>10,000 individuals) this mod could increase MySQL execution time for searches that could lead to MySQL execution time quotas being exceeded but v4 largely solved this problem.

Installation

Uninstall and delete previous version of this mod (if installed)
Download the appropriate zip file as shown in the mod summary in the upper right corner of the page.
Extract the file from the downloaded zip file into the mods folder or FTP the extracted file to your mods folder.
Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.

Options

The behaviour of the mod can be changed in several ways by clicking on "Installed [Options]" then the "Edit options" button in the mod list.

If you use events other than NAME and ALIA to record alternative names (e.g. AKA) then you can substitute one or the other of these. Change the name in the one of the first two boxes and click the Update button corresponding to it.
If you want to make broad search the default method for quick searches, then you can set this up. In this case the box will appear with a tick but the user can untick it if the broad search is not wanted. You need to customise the particular template you are using. Templates vary, having a dropdown search box on pages other than the front page, but they may a menu on the front page or the top menu or both. You can choose which of these boxes are ticked.
1. To set the default for the dropdown menu, put "checked" in the box for the dropdown search menu (variable $checked0) and click the Update button.
2. To set the box on the front page, put "checked" in the box for the templateX/index.php file corresponding to your template and click the Update button.
3. If there is a topmenu for your template then put "checked" in the box for the templateX/topmenu.php file and click the Update button.

If you subsequently decide you don't want these set, then remove the "checked" entry and click the corresponding Update button(s).

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 us through the TNG Community Forums.

Uninstalling the mod

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

click the Uninstall button to uninstall the mod
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.

Conflicts and Issues

Caution This mod involves a number of changes to template files such as index.php which people often change more than any other file in the TNG system. It's possible that this will cause the Mod Manager to say the mod cannot be installed. If this is the case I'll try and help if you can send me a copy of the file concerned (such as templateX/index.php).

Note For the dropdown search, this mod assumes that the setting in 'Admin > General Settings > Site Design and Definition > Search link destination' is set to "Quick Search" not to "Advanced Search". Otherwise you will only be able to use this functionality from the front page.

The quick search will search all trees unless the "Default Tree" is set in 'Admin >> Configuration >> General Settings >> Site Design and Definition'.

Visualization

The following screen captures show the changes made by the mod:
The quick search box with the broad search box ticked.

Here is an example of a search for Elizabeth Sarah. Of the five results only one person was born with the surname Sarah. For the others it was a married name.

A search for "William Sarra" shows a change of name from Sarah to Sarra. One of these was defined using ALIA and the other NAME.

This search for "Lizzie" shows that the name was more common on the birth certificate than you might expect, and only once is a nickname.

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

Moss Family Tree

Chris Moss

Template 5

11.0.0

EN, FR, DE

Treichel-Familie.de

Andreas Treichel

Template 12, Public & Private

14.0.2.4d

TNG 14.0.6

DE,EN,FR,ES,PL

Familiegeschiedenis van der Horde

Wim van der Horde

Template 20, Private

13.1.0.4c

NL

Family tree of Marcin & Emilia Senderski

Marcin Senderski

Template 15; only home page is public

13.1.0.4c

13.0.4

EN,PL

Roots & Relatives Remembered

Public & Private

EN,DE,CS

Template 12

11.0.2

NL,EN

Our Roy and Boucher Family

Ken Roy

I no longer user this mod since it causes excessive MySQL utilization on my multi-tree sites. Will revert back to using the Married Name in Search Mod

n/a

11.1.1

FR,EN

Chamberlain & Eidenbenz Genealogy

Graham Chamberlain

Template 8 Modified to enable broad search in home-page custom search box

11.0.0.1d

11.0.2

EN,FR,DE,ES,NL

Ennever/Enever Family History

Barry Ennever

Customised template 4