Difference between revisions of "Search Form Help mod"

From TNG_Wiki
Jump to: navigation, search
(Revision History)
Line 3: Line 3:
 
| mod_summary    = Provides a Help button on the 'Home', 'Search People' and 'Search Families' pages, that links to a new 'Search Help' file
 
| mod_summary    = Provides a Help button on the 'Home', 'Search People' and 'Search Families' pages, that links to a new 'Search Help' file
 
| mod_validation  = The mod is XHTML compliant.[[Image:Valid-xhtml10.png|44px]]
 
| mod_validation  = The mod is XHTML compliant.[[Image:Valid-xhtml10.png|44px]]
| download_link = [http://www.katiandgraham.com/genealogy/ccount/click.php?id=54 Search_form_help_V11.0.0.1a.zip]
+
| download_link = [[Media:Search_form_help_V11.0.0.2a.zip|Search_form_help_V11.0.0.2a.zip]]
 +
[[Media:Search_form_help_V11.0.0.3b.zip|Search_form_help_V11.0.0.3b.zip]]
 +
[[Media:Search_form_help_V11.0.0.3c.zip|Search_form_help_V11.0.0.3c.zip]]
 +
[http://www.katiandgraham.com/genealogy/ccount/click.php?id=54 Search_form_help_V11.0.0.1a.zip]
 
[http://www.katiandgraham.com/genealogy/ccount/click.php?id=55 Search_form_help_V11.0.0.2b.zip]
 
[http://www.katiandgraham.com/genealogy/ccount/click.php?id=55 Search_form_help_V11.0.0.2b.zip]
 
[http://www.katiandgraham.com/genealogy/ccount/click.php?id=56 Search_form_help_V11.0.0.2c.zip]{{Tv110}}
 
[http://www.katiandgraham.com/genealogy/ccount/click.php?id=56 Search_form_help_V11.0.0.2c.zip]{{Tv110}}
Line 17: Line 20:
 
| mod_support    = [http://www.katiandgraham.com/genealogy/mod_support.php My Mod Support]
 
| mod_support    = [http://www.katiandgraham.com/genealogy/mod_support.php My Mod Support]
 
| mod_contact    = [http://www.katiandgraham.com/genealogy/mod_support.php Contact Developer]
 
| mod_contact    = [http://www.katiandgraham.com/genealogy/mod_support.php Contact Developer]
| mod_version    = V11.0.0.1a or V11.0.0.2b or V11.0.0.2c for TNG11
+
| mod_version    = V11.0.0.2a or V11.0.0.3b or V11.0.0.3c for TNG11
 
| min_TNG_ver    = 8.0.0 using integrated Mod Manager<br />TNG 7.1.0 requires manual installation of Mod Manager
 
| min_TNG_ver    = 8.0.0 using integrated Mod Manager<br />TNG 7.1.0 requires manual installation of Mod Manager
 
| max_TNG_ver    = 11.0.0
 
| max_TNG_ver    = 11.0.0
Line 31: Line 34:
 
The mod is provided in three forms:
 
The mod is provided in three forms:
 
{{Tv100}}{{Tv110}}
 
{{Tv100}}{{Tv110}}
* A basic mod (v10.0.0.0a & v11.0.0.1a) adds a 'Help' button to the 'Search People' and 'Search Families' pages.
+
* A basic mod (v10.0.0.0a & v11.0.0.2a) adds a 'Help' button to the 'Search People' and 'Search Families' pages.
* A separate version (v10.0.0.1b & v11.0.0.2b) of the mod also adds a Help button or text link to each Template home page.
+
* A separate version (v10.0.0.1b & v11.0.0.3b) of the mod also adds a Help button or text link to each Template home page.
* A version (v10.0.0.1c & v11.0.0.2c) that provides a separate cfg file for each Template.
+
* A version (v10.0.0.1c & v11.0.0.3c) that provides a separate cfg file for each Template.
  
 
{{Tv90}} {{Tv80}}
 
{{Tv90}} {{Tv80}}
Line 124: Line 127:
 
! Date
 
! Date
 
! Description
 
! Description
 +
|-
 +
| V11.0.0.2a, V11.0.0.3b, V11.0.0.3c
 +
| 23 April 2016
 +
|
 +
*Further enhancement for WordPress compatibility provided by Roger Moffat
 
|-
 
|-
 
| V11.0.0.1a, V11.0.0.2b, V11.0.0.2c
 
| V11.0.0.1a, V11.0.0.2b, V11.0.0.2c

Revision as of 16:34, 23 April 2016

Search Form Help Mod
Summary Provides a Help button on the 'Home', 'Search People' and 'Search Families' pages, that links to a new 'Search Help' file
Validation The mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link Search_form_help_V11.0.0.2a.zip

Search_form_help_V11.0.0.3b.zip Search_form_help_V11.0.0.3c.zip Search_form_help_V11.0.0.1a.zip Search_form_help_V11.0.0.2b.zip Search_form_help_V11.0.0.2c.zip

TNG 11.0

Search_form_help_V10.0.0.0a.zip Search_form_help_V10.0.0.1b.zip Search_form_help_V10.0.0.1c.zip

TNG 10.0

Search_form_help_V9.0.0.3a.zip
Search_form_help_V9.0.0.2a.zip

TNG 9.0


Search_form_help_V9.0.0.1b.zip

TNG 9.0
TNG 8.0
Download stats See download statistics
Author(s) Graham Chamberlain
Config file by Graham Chamberlain
Homepage Search Form Help mod (This page)
Mod Support My Mod Support
Contact Developer Contact Developer
Latest Mod V11.0.0.2a or V11.0.0.3b or V11.0.0.3c for TNG11
Min TNG V 8.0.0 using integrated Mod Manager
TNG 7.1.0 requires manual installation of Mod Manager
Max TNG V 11.0.0
Files modified
searchform.php; famsearchform.php; index.php for templates 1-7, 9-11, 13-14; topmenu.php for templates 2, 4, 7, 8 and 12.
Related Mods
Notes
None


Purpose of Mod

The mod is provided in three forms:

TNG 10.0
TNG 11.0
  • A basic mod (v10.0.0.0a & v11.0.0.2a) adds a 'Help' button to the 'Search People' and 'Search Families' pages.
  • A separate version (v10.0.0.1b & v11.0.0.3b) of the mod also adds a Help button or text link to each Template home page.
  • A version (v10.0.0.1c & v11.0.0.3c) that provides a separate cfg file for each Template.


TNG 9.0
TNG 8.0
  • A basic mod (v9.0.0.1b) adds a 'Help' button to the 'Search People' and 'Search Families' pages.
  • A separate version (v9.0.0.2a)of the mod also adds a Help button or text link to each [TNG v9] Template home page.
  • A version (v9.0.0.3a) that provides a separate cfg file for each [TNG v9] Template.


Clicking on the button or text link displays a pop-up Help window with information relevant to search functionality.

Mod Developer

The Mod was developed by Graham Chamberlain with help from William (Rick) Bisbee, Bryan Larson and Roger Moffat.

Mod Manager config file provided by Graham Chamberlain.

Automated Installation

  1. Download the appropriate file for your TNG version from the download links in the mod summary area in the upper right.
  2. Extract the downloaded zip file to your 'mods folder.
  3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the appropriate source_title_display.cfg file.

The Help file 'search.help.php' is installed by default to the languages/English folder.

Manual Installation

The Help file 'search.help.php' is provided only in English and will be copied to the languages/English folder. The file contains a link to 'Google Translate'.

If you want to create a Help file in another language by modifying the default version, you will need to install the new file in the appropriate language folder where it will henceforth be automatically recognised when you are using its associated language.

NOTE that in the Help file, the first section describes some locations of the Search function links that refer to the website of the author. You may wish to edit the file so that the text refers to your site

Pre-install Edits

WordPress Users
[Thanks to Roger Moffat for this enhancement of the mod]
If you are using the WordPress plug-in, only v10.0.0.0a or v9.0.0.1b is suitable. You will need to go to your TNG file customconfig.php and add the following lines before the closing ?> tag:

// added for Search Help Button with WordPress<br />
// add the path to your TNG install - it MUST end with a trailing slash<br />
$helpfilepath = "http://PathToYourTNG/";%


'Plain' Template Users
If your installation has the capability of template switching but you use the 'plain' template, you can add the Help button to the Home page Search form by adding the following directive to the basic v9.0.0.1 configuration file:

%target:index.php%
%location:%      
<tr><td><input type="hidden" name="mybool" value="AND" /><input type="hidden" name="offset" value="0" /><input type="submit" name="search" value="<?php echo $text['mnusearch']; ?>" /></td></tr>
%end:%
%replace:%
<tr><td><input type="hidden" name="mybool" value="AND" /><input type="hidden" name="offset" value="0" /><input type="submit" name="search" value="<?php echo $text['mnusearch']; ?>" />
<?php
// the following says if the search.help.php file does not exist in the user's chosen language
// default to the one in the English folder
$helplink = file_exists("{$cms['tngpath']}$mylanguage/search.help.php")
?
"onclick=\"return openHelp('{$cms['tngpath']}$mylanguage/search.help.php');\""
:
"onclick=\"return openHelp('{$cms['tngpath']}languages/English/search.help.php');\""
?>
<?php
// display the Help button
echo "<script type=\"text/javascript\" src=\"{$cms['tngpath']}js/litbox.js\"></script>\n";
echo "<input type=\"button\" id=\"helpbtn\" class=\"small\" value=\"{$text['help']}\"   $helplink />";
?></tr></td>
%end:%


Help File Log
If you would like to monitor use of the Help file, add the following code to search.help.php immediately before the php closing tag, at the top of the file.

   $logfile = "search_help.log";
   $referer = empty( $_SERVER['HTTP_REFERER'] ) ? "" : " on {$_SERVER['HTTP_REFERER']} ";
   $newline = "Search Help accessed " . date("d M y H:i:s") . "$referer from {$_SERVER['REMOTE_ADDR']}
   ";
   file_put_contents( "search_help.log", $newline, FILE_APPEND | LOCK_EX );

NOTE that the closing quote and semi-colon for $newline should be on a separate line to ensure that the details for each access of the Help file are stored on a separate line on the log file.

The log file (search_help.log) will be created and maintained in the same folder as the Help file.

Revision History

Version Date Description
V11.0.0.2a, V11.0.0.3b, V11.0.0.3c 23 April 2016
  • Further enhancement for WordPress compatibility provided by Roger Moffat
V11.0.0.1a, V11.0.0.2b, V11.0.0.2c 4 April 2016
  • Better compatibility for WordPress users provided by Roger Moffat
V11.0.0.0a, V11.0.0.1b, V11.0.0.1c 20 Mar 2016
  • Updates for TNG v11
V10.0.0.1b 20 Feb 2014
  • Replacement for v10.0.0.0b (error in Template 12 mod)
V10.0.0.1c 20 Feb 2014
  • Replacement for v10.0.0.0c (cfg files missing for Templates 12-14)
V10.0.0.0a 14 Feb 2014
  • Upgrade of v9.0.0.1a [compatible for WordPress users].
V10.0.0.0b 14 Feb 2014
  • Upgrade of v9.0.0.2a
V10.0.0.0c 14 Feb 2014
  • Upgrade of v9.0.0.3a
V9.0.0.1b 18 Jan 2013
  • As v9.0.0.1a but with an amendment [thanks to Roger Moffat] of the Help file path to be compatible for WordPress users.
V9.0.0.3a 25 Jun 2012
  • As v9.0.0.2a but with separate cfg file for each Template.
V9.0.0.2a 25 June 2012
  • Also adds Help button or text link to each Template home page.
V9.0.0.1a 25 June 2012
  • Corrects error in %location for searchform.php in V8.1.0a.
V8.1.0a 30 November 2011
  • Same as V8.1.0 but has a revised Help file (search.help.php).
V8.1.0 26 November 2011
  • Introduction.

Visualization

To see the mod in action, go to

TNG User sites using this mod

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

URL User Note Mod-Version/TNG-Version User-language
Chamberlain & Eidenbenz Genealogy Graham Chamberlain Mod developer V11.0.0.1/11.0.0 EN, FR, DE, SP, NL
Roger's Genealogy Online Roger Moffat V9.0.0.1/9.1.0 EN
Clan Moffat Genealogy Online Roger Moffat V9.0.0.1/9.1.0 EN
Our Roy and Boucher Family Ken Roy Template 4 V9.0.0.1/9.1.0 EN, FR
Whittlesey-Whittelsey Family History Willis S Whittlesey III Public site V9.0.0.3/TNG V9.2.0 EN
Hooley Family Links Rick Hooley Public Site 10.0.0.0a/10.1.1 EN
Kemp(e) Family History Andrew Kemp Template 8 see User:Kempons EN
Moss Family Tree Chris Moss Template 5 10.0.0.1b/10.0.3 EN
MacomberKin Rev. Clinton Macomber Template 99 (rework of 11) 10.0.0.1c / TNG 10.0.3 EN
Quigley Doyle Family Tree Don Quigley Public Site (Revised search.help.php to reflect Married Names in Search Mod) 11.0.0.1b/11.0.0 EN
... ... ... ... ...