Search Show Branch

From TNG_Wiki
Jump to navigation Jump to 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

This TNG modification adds a search results column for the branches.

The branch(es) to which a person belongs are not obvious in search results. 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.

Developer

This mod was developed by Robin Richmond.

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.

Revision History

Mod Version TNG Version Date Contents
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.

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.

In the event of a problem

Uninstalling the mod

If you want to completely Remove (uninstall) this mod and all its tables, 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.

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.

Visualization

The following screen captures show the changes made by the mod:

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

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
Robin Richmond's Genealogy Database Robin Richmond Mod developer 11.1.0.2 11.1.2 EN