Search Show Branch

From TNG_Wiki
Jump to: navigation, search
Search Show Branch
Summary Displays each person's branches in a new search results column, under certain circumstances
Validation
Mod Updated 9 Mar 2018
Download link v11.0.0.3a
TNG 11.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 11.0.0.3a
Min TNG V 11
Max TNG V at least 11.1.2
Files modified
search.php, searchform.php
Related Mods
Notes


Purpose of the Mod

The branch(es) to which a person belongs are not obvious in search results. This mod adds a search results column for the branches. Each branch name is a hyperlink:

  • Administrators are linked to the Admin Branch edit program, which opens in a new window and displays a (small) message that says it is in a new window.
  • Non-administrators (including editors) are linked to the non-admin list of branch members, which is displayed by search.php.

The new branch column in search results is available only under certain conditions:

  1. When the user checks a checkbox on the Advanced Search page that says "Show Branches". The visibility of that checkbox is controlled by a mod parameter (see below).
  2. When the user adds a prefix to the last name. The prefix is defined as a mod parameter (see below). This way of activating the branch column in search results is intended to be used in pop-up searches. The prefix can be entered alone in the last name search field if the last name is not being used as a search key.

Also, while I had the hood open, so to speak, I also suppressed the Tree column when a tree has been selected.

Mod Parameters

  1. For searchform.php (the Advanced Search form), a parameter specifies when and whether the "Show Branches" checkbox is available. If the parameter value is 0, the checkbox will never be displayed. If it is 1, then only Administrators and Editors can see it, and if it is 2, then anyone can see it.
  2. For search.php (the Search results page), a parameter specifies the prefix that it looks for last name values. If the prefix is set to the empty string, this feature is disabled.

Compatibility with other Mods

This mod has been tested against all search.php and searchform.php mods listed in the TNG Wiki, with no conflcts. Version 3 had a conflict with Tree ID Mod, but, with Ken Roy's help, that that conflict has been resolved in version 3a of this mod, and version 4 of Tree ID Mod.

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Installation

Requirements

  • A working TNG installation.
  • An installed current version of the Mod Manager.
  • You should backup files listed in the panel on the right.

Automated Installation

  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.

In the event of a problem

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.

Visualizations

The search form After installation
Show search branch-after-form.jpg
The Results Page - After Installation
Show search branch-after-results.jpg
The Results Page - After Installation - Show the suppressed Tree column

(Note that this change is not related to the main purpose of this mod.)

Show search branch-after-notree.jpg

Mod Change History

Mod Version TNG Versions Date Note
11.0.0.3a 11+ 7 Mar 2018
  • The Admin Branch Edit program now opens in a new window, and displays a message saying that it is in a new window.
  • Resolved a conflict with Tree ID Mod.
  • Fixed a bug that prevented the Branch column from showing up after page 1 of the search results.
  • Successfully tested the mod against TNGv11.0, and thus changed the mod's full version number.
11.0.0.3 11+ 5 Mar 2018 Added a Show Branches checkbox to the Advanced Search form and a mod option to go with it.
11.1.0.2 11.+ 25 Aug 2017
  1. added $tngmodnames
  2. Now only shows branches if a specific string is entered.
  3. All branches are hyperlinked, not just the first.
11.1.0.1 11.1+ 25 Aug 2017 New mod.

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 11.1.0.2 11.1.2 English
Roots & Relatives Remembered Ron Krzmarzick public / private : with modifications 11.1.0.1 11.1.2 English