Family Group Worksheet

Family Group Worksheet
Summary	Form for registered users to upload their related family groups.
Validation
Mod Updated	16 Mar 2021
Download link	version 12.0.0.69 TNG 12.0 TNG 13.0 TNG 14.0
Download stats	View Stats
Author(s)	Rick Bisbee
Homepage	A Bisbee Family History
Mod Support	Support for Family_Group_Worksheet
Contact Developer	Support for Family_Group_Worksheet
Latest Mod	12.0.0.69
Min TNG V	12.0
Max TNG V	14.0 and higher
Files modified	none
Related Mods	FGW_Tabs_Mod Personal_Table_Maintenance
Notes

Description

The form does not automatically enter data into the website's database -- the site administrator must merge the new data manually to prevent the risk of good data being overwritten by bad. The form is useful because it guides contributors to provide complete family information needed by the site researcher.

Please note that LDS information can be included using the setup screen.

Major Revision

FGW current version is a Mod Manager Mod implementation of the Family Group Worksheet and is compatible with TNGv12.0 and up. As previously noted, it installs in the TNG root to avoid problems with servers that prohibit scripts from running within a sub-directory. iFrames have been removed. All previous worksheet functionality remains.

If you are replacing an older version prior to v12 of FGW, be sure to update your page links.

Note that we are currently testing with PHP 7.4 and PHP 8.

Compatibility

Versions of Mod Manager previous to TNGv12 will not support this mod.

Mod Tested With TNG Versions

Ver	1200 all	1300	1400	Tested
12.0.0.69				PHP 5.6 - 8.2

*green: compatible   red: not compatible

See Multisite Testbed for information on how this mod is tested and managed.

Languages: Dutch, English, French, German, Italian and Spanish.

Revision History

Mod Version	TNG Version	Date	Contents
12.0.0.67	12.0	06 Feb 2023	Fixes path sent in emails to for contributor to get back to his worksheet.
12.0.0.67	12.0	30 Jan 2023	Fixes database connection for both MySQL and MariaDB Makes setup option to backup worksheets to TNG database the default. Sets default Identity prefixes - Person to I and Family to F. Can be changed in the fgw_setup on rare occasions someone uses different prefixes. updates URL ampersand to HTML entity in fgw.php, fgw_ajax.php, fgw_form.php, fgw_search.php, show_plain.php and js/fgw_lib.js updates URL ampersand to HTML entity in fgw.php, fgw_ajax.php, fgw_form.php, fgw_search.php, show_plain.php and js/fgw_lib.js
12.0.0.67	12.0	25 Jun 2021	Fixes an error preventing backing up the worksheet table with other TNG tables under certain circumstances. Updates fgw_userconfig.php file if carried over from previous version of FGW. Provides default prefixes I & F for personID and familyID. Fixes the English language support file -- missing some definitions. Fixes a syntax error in the fgw css file.
12.0.0.66	12.0	16 Mar 2021	Adds Norwegian language support compliments of Kåre Kjøllesdal
12.0.0.65	12.0	12 Mar 2021	Fixes location error in TNGv12. TNGv13 was unaffected. Fixes notice in the setup screen.
12.0.0.64	12.0	09 Mar 2021	Fixes path error to FGW image folder. Adds setup option to include FGW worksheet table in TNG backup utility. FGW user configuration file is now protected and must be removed manually upon mod uninstall so settings will not be lost when updating.
12.0.0.63	12.0	22 Feb 2021	Fixes worksheet date format to honor site preferences. Fixes bug in several language help files that prevented displaying them. Changes support folder name to reflect the mod series instead of each mod update within the series to reduce the effort required to update the mod. Current FGW series is v12.
12.0.0.62	12.0	14 Jan 2021	Updated worksheet receipt confirmation message to contain the correct URL http:/https: schema for the website.
12.0.0.61	12.0	12 Jan 2021	Updated to handle user-modified personID and familyID prefixes. Prefix modifications must be accounted for in the Setup page for the FGW tabs to pre-fill worksheets. See Setup.
12.0.0.60	12.0	09 Aug 2020	Implemented as a Mod Manager Mod Run from the TNG root (www.example.com/fgw.php) Eliminates server problems with iframes and running scripts from a subdirectory
12.1.0.59	12.0	Not released	Tested and rejected
12.1.0.58	12.0	Not released	Tested and rejected
12.1.0.57	12.0	28 Jul 2020	Removes obsolete error code that prevented creating a forms table Directs first time use to the setup page for admins
12.1.0.56	12.0	01 Jun 2020	Fixes missing security image on some servers Fixes redirect to login when restricting to members only
12.1.0.55	12.0	07 Apr 2020	Fixes white screen under certain conditions
12.1.0.54	12.0	10 Mar 2020	Fixes login.php file not found error Fixes other minor bugs
12.1.0.53	12.0	11 Sep 2019	Log now uses language of the site administrator, not the visitor. New setup *option* to suppress personal information from the FGW log. Worksheet declaration of consent for site to store collected information. Updated language support. In-processing (busy) spinner moved to bottom of the page.
12.1.0.52	12.0	09 Sep 2019	Mainly an upgrade to the FGW log. See Visitor log image below. Now shows geolocation of visitors. Shows names of visiting bots and crawlers (where known). Log lines gracefully degrade for readability on hand-held devices.
12.1.0.51	12.0	08 Sep 2019	TNG footer added to bottom of FGW pages. FGW security code value missing '='. [FIXED] FGW worksheet submissions checks were somewhat erratic. [FIXED] FGW print icon pushing worksheet to the left on some templates. [FIXED] FGW captcha image gets lost when switching languages on iPhone if not refreshed [PENDING - CAN'T DUPLICATE]
12.1.0.50	12.0	06 Sep 2019	The Worksheet would not scroll on iPad or iPhone. FIXED. Worksheet overflowed margins on some templates. FIXED. Bad pointer to login when user not registered. FIXED.
12.1.0.49	12.0	05 Sep 2019	Fixed bug preventing database table being created or removed
12.1.0.48	12.0	04 Sep 2019	Compatible with all TNG versions from v10.1 to present. Uses html iframes. Only one website link needed for admin access to all FGW resources. Added utility to update very old worksheet table (keeping existing worksheets) Added security to prevent script pages being opened from a URL. Fixed bug communicating with older sites/servers using PHP 5. Fixed bug locating config.php file when it resides in TNG root.
12.0.0.43	12.0	04 Aug 2019	Allows logged in admin to save empty worksheets for emailing to someone with request to complete it. Provides admin ability to add/edit a saved worksheet title using the admin area. Admin area provides a copyable link to insert in email with request to fill out a worksheet.
12.0.0.42	12.0	16 Apr 2019	Adds date updated to admin form (line 491) Fixes TNG version number at bottom of page (was default: 12.0.0)
12.0.0.41	12.0	22 Jun 2018	Provides full path name for font files to php image processing routines. In some installations the font will not be found without it. Some consider this to be a PHP bug.
12.0.0.40	12.0	22 Jun 2018	fixes bug in help file routine that prevented display
10.1.1.39	12.0	07 Jun 2018	Fixes fatal error when run under PHP 7.0+
12.0.0.37	12.0	18 Mar 2018	Fixes fatal error generated by the newest versions of MySQL/PHP Fixed code to accommodate TNG v12 updated jQuery library Directly inserted local js functions at bottom of fgw scripts
10.1.1.38	10.1	02 Jun 2018	Fixes fatal error generated by the newest versions of MySQL/PHP
10.1.1.34	10.110.1	20 Nov 2016	Fixed CSS borders around input fields Fixed fatal error preventing setup.php from displaying
10.1.1.33	10.1	13 Jun 2016	Added missing setup label to language files for option to use FGW captcha
10.1.1.32	10.1	21 Mar 2016	10.1 minor spelling errors fixed
10.1.1.31	10.1	20 Mar 2016	small change to start file to make it compatible with TNGv11.0
10.1.1.30	10.1	15 Nov 2015	adds link to Worksheet Management panel to view submitted data in plain text for copy & paste to desktop programs. fixes minor errors in language files.
10.1.1.29	10.1	25 Sep 2015	makes the fgw caption optional for those who might not have the GD image package installed removes bad file name from log view script
10.1.1.28	10.1	24 Sep 2015	fixes errors when creating or removing fgw forms table
10.1.1.27	10.1	19 Sep 2015	fixes error in generating worksheets for children fixes help screen crashes on some installations internationalizes some hard coded phrases updates Dutch language files and adds a help file adds Italian language support -- needs to be tweaked
10.1.1.26a	10.1	14 Sep 2015	fixes bug introduced in last version where config files in TNG root could not be accessed. No, Really! It's fixed.
10.1.1.25	10.1	14 Sep 2015	fixes bug preventing create/remove table ops refactors TNG compatibility interface fixes minor style issues
10.1.1.24	10.1	12 Sep 2015	fixes child worksheet propagation fixes admin recognition problem with older versions of TNG fixes jQuery conflict with litbox fixes minor translation errors fixes minor styling errors enhances functionality of worksheet ops shortens title to accommodate TNG templates adds title to form reorders location of parents relative to spouse enlarges input fields
10.1.1.10.123	10.1	09 Sep 2015	adds simple captcha to worksheet
10.1.1.22	10.1	06 Sep 2015	Initial release for this version of a compact Family Group Worksheet. usable with small devices more styling options ajax family updates eliminate leaving page no changes to data table backward compatible with previous versions of TNG and Family Group Worksheet

Visualization

The following screen captures shows how the form will appear with no language or styling customizations. It is perfectly usable out of the box. You should note that the FGW Admin links across the top of the worksheet only appear to an admin, or to an editor if you've given authority in the FGW setup. A normally logged in visitor would not see them.

Large screen

Small screen

Visitor log

Download and Installation

The download package contains a Mod Manager configuration file (cfg) and a mod support folder. Unzip the package and place the cfg file and the support folder in your mods directory. Navigate your browser to the Admin Mod Manager and install the FGW mod. To access the worksheet, navigate the browser to your website and fgw.php, for example like this: www.example.com/fgw.php.

Previous versions of FGW do not have to be removed. They will not interfere with each other, but at some point you can remove the fgw folder in your TNG root and just use the mod version. Make sure you point your links and FGW tabs mod to the new FGW URL.

If this is a first time installation of FGW and you are logged in as an administrator, you will be taken to the FGW setup page to create a new table for your saved worksheets. If you don't wish to use the default table name, change it at the top of the setup form, save it as a preference, then create the table at the bottom of the form.

If you already have a table from a previous FGW, make sure to save the correct table name and it will be shown as installed. You can continue to access all your worksheets as before.

Linking to the Worksheet

There are many locations on a TNG website where a link to the Family Group Worksheet may be placed. Because of the variety and modifications to TNG sites, it cannot be automated, but you can do it yourself. Refer to Add Links to TNG if you are not sure how to do it. The easiest way is to use TNG's menu hooks and your customconfig.php file. Custom Menu Hook.

Setting Functional and Styling Preferences

The setup page is where you specify the worksheet's behavior and colors. To get there from the worksheet, press the setup link just above the worksheet. These links are only available to logged in administrators and editors if the latter is permitted in the FGW setup. Editors, if authorized, will have access to everything except the setup page.

This is what you should see in your browser:

Options

You can experiment by changing the colors in each category and see which elements on the form are affected. Blue, yellow, red and green work well. If you get completely off track, hit the "Restore Defaults" button at the bottom of the setup page to start over again. A fast way to do your testing is to edit fgw_userconfig.php directly and look at the resulting form.

Colors are expressed either as predefined HTML colors -- red, blue, green -- or as CSS entities such as #990000 (shade of red). If you are not familiar with them, spend a few minutes with Google and research them.

Border styles are in standard CSS format: 1px solid red. To not show a border, set the 1 to 0, meaning that it will have no pixel width and therefore will not be visible.

Family Group Worksheet Options

Option	Type	What it does
Worksheet table	Text	This is the name you chose when you created a database table to store your worksheets. If you haven't yet created a table, it is the name that will be used.
User Log	Text	This is the name that will be used for the FGW activity log. Only a user's first appearance during the session is logged. Thereafter, we make a log entry every time he makes some kind of change to a worksheet.
Add Worksheet to TNG backup	Text	Select this option to include the worksheet table with other TNG table backups
Allow editors to manage worksheets	Checkbox	Normally only the admin has access to manage submitted worksheets. Checking this box allows anyone with editing privilege to manage them.
Display form only to logged in users	Checkbox	Checking this restricts access to logged in users. Unchecking it will make it available to all members of the general public, including spammers, to fill them out and submit them.
Always hide LDS events	Checkbox	If checked, LDS events will not be shown on the worksheet.
Use FGW captcha	Text	Select this option to show the FGW captcha at the bottom of the form. This captcha is not shown to or required by logged in administrators.
Do not log visitor IP information	Text	If you do not want, or are not permitted to keep IP information about your visitors, check this option.
Person ID Prefix	Text	This will default to TNG's I character, but if you've changed it, for example to the letter P to prefix a personID, enter the new prefix here.
Family ID Prefix	Text	This will default to TNG's F character, but if you've changed it, for example to the letter H to prefix a familyID, enter the new prefix here.
Trees	Text	Only trees listed will be allowed; if none are listed, all trees are permitted.
Bold data and labels	Checkbox	Checking this will make labels and data bold to better distinguish them against certain backgrounds.
Form heading color	Text	If a color is given it will override the template's page title color.
Form subheading color	Text	Choose the color for subheadings (e.g., Husband) on the form. If empty the template's default color is used.
Form background color	Text	Enter a color to change the worksheet's background color.
Form background image	Text	If you prefer, you can use an image as background.
Form border style	Text	Set/Change the style of the form's border. For example,1px dotted blue
Form label color	Text	Change the color of the Form's label text
Form text color	Text	Change the style of informational text on the form
Husband background color	Text	Add contrasting color background for the husband
Husband background image	Text	Use background image for the husband's section
Wife background color	Text	Add contrasting color background for the wife
Wife background image	Text	Use background image for the wife's section
Cell heading text color	Text	Color of the text in the field name label above formatted input field cells.
Cell heading background color	Text	Background for the field name label above each input field cell.
Cell border style	Text	Sets the style of the border around each formatted input cell
Input field background color	Text	Sets the background color of all text input fields
Input field text color	Text	Sets the text color for all text input
Notify message color	Text	Sets text color for notifications
Error message color	Text	Sets text color for error messages
Maximum user log lines	Text	Limits the size of the user log file
Alternate site email address	Text	Sets custom "From" email address for worksheet notifications to user
Alternate site/admin name	Text	Sets custom "From" name for worksheet notifications to user

Worksheet Management Panel

The administrator only needs the worksheet ID number (not the random key) to access it. The URL is fgw.php?id=6 to retrieve worksheet number 6. If you enter fgw.php?id=index, a page listing all the worksheets will be displayed, each accessible via a clickable link. There is no longer any need to create separate links for the listing or setup pages. They can all be reached by an administrator from the worksheet.

Anytime the site administrator views a submitted worksheet, it will have a worksheet management panel at the top showing the worksheet number and status: whether its data has been merged into the website and/or if it has been closed which means the original contributor can no longer come back and view or edit it, even using the worksheet id and key.

Underneath the title is a link to view the submitted data in plain text, allowing the administrator to copy and paste it into a desktop program, or print it directly from the browser.

The administrator or any editor, if that option is set, can change the status by checking the appropriate boxes and clicking the Update button below it. Family or husband and wife ID's are filled in from the submitted form. If persons or a family ID are not entered, the administrator can provide them after creating new TNG records. The advantage of coming back and saving them here is that worksheets can be searched by those ID numbers where it says "Get different worksheet."

You may search by worksheet id number, familyID or personID. The ID numbers must be correctly prefixed so the system will know what you are looking for; worksheet numbers do not have a prefix. If you hit the Find ID button without anything in the ID field, you will be taken to the list of worksheets to select one.

The final set of inputs are for navigating from worksheet to worksheet. This may be helpful if you are reviewing a series of sheets submitted together. The Navigation Filter can be set to limit the pool. For instance, if "pending" is selected, only a worksheet that has neither been merged nor closed will be returned when Next or Prev is pushed.

Invite Family Participation

An administrator can invite someone to submit their family information using the Family Group Worksheet. You can:

• Fill in data you already know and save the worksheet.
• When you save a worksheet no emails will be sent. You can fill in the submitter in the admin area before or after you've saved the worksheet if you want.
• Access the worksheet using just its id number.
• In the admin area edit the default title.
• Copy the link for the worksheet to share via email.
• Create an email that includes the worksheet link and your request to complete it.
• Those using a link containing the access key do not have to be registered on your website to access the worksheet, edit and submit it.

URL and Links

You only need one URL to access all the functionality of the Family Group Worksheet.

For purposes of illustration we will assume a TNG installation in the document root (public_html) of your site. In other words, your document root and TNG root are in the same location. Your main TNG installation is reached with a URL similar to this:

http://www.example.com

That brings up your home page because when a filename is not provided, index.php will be assumed.

Your What's New page is reached like this:

http://www.example.com/whatsnew.php

Your Family Group Worksheet will be installed by Mod Manager in your TNG root. Therefore, the URL everyone will require to reach it will be:

http://www.example.com/fgw.php
OR
https://www.example.com/fgw.php

Turning A URL Into A Link

A URL works in your browser's address bar. But, to provide links on your home page or in a menu you will first need to create them. Fortunately it is very simple. The HTML code pattern is:

<a href="URL">LinkName</a>

<a> is a link tag that contains the URL to the target and text for the normally underlined link. Clicking on it takes the visitor to the target page.

So the link for your Family Group Worksheet might look like this:

<a href="https://www.example.com/fgw.php">Submit Family</a>

It would result in a link that might look like this depending on your template's css styling: Submit Family

Languages

Because of the amount of translated text and for ease of maintenance, Family Group Worksheet uses its own separate language files in Dutch, English, French, German, Italian and Spanish, copied to TNG's languages folders. Many of them were translated, at least in part, using Google Translate by a person who does not necessarily understand them. Any improvement would be much appreciated. Send me your text files for additional languages and I will incorporate them.

At the moment the only help files we have are in English, Dutch and French. If help is not found in other languages, Family Group Worksheet defaults to an English version. As with the language files, your contribution of a help file in another supported languages will be appreciated and incorporated.

Credits

Family Group Worksheet was written by William Bisbee, Oct 2011 with invaluable contributions from:

Roger Mitchell, http://mfo.me.uk (Mitchell Family Online);

Douglas Couch, http://www.adkinshorton.net (Adkins - Horton Genealogy)

Graham Chamberlain, Chamberlain and Eidenbenz Genealogy -- provisional French, German and Spanish translations

Joop Giesendanner, http://www.oudheidkamer.info/genealogie/ (Oudheidkamer Oostzaan) -- Dutch translations

Bryan S. Larson, Our Family Histories -- addition of LDS fields

and the members of tngusers2

Disclaimer

There is no warranty. Use the script at your own risk. It has been tested in all the TNG template styles without any particular problems.

TNG Sites using this mod

If you download and install this mod, please add your TNG site to the table below so we will know if it is worth maintaining.

URL	User	Note	TNG-Version	Mod-Version	User-language
Treichel-Familie.de	Andreas Treichel	Public & Private	14.0.3	12​.0​.0​.69	DE, UK, FR, ES, PL
Parcell/Burris & Pesata/Rupp Genealogy	Laura Parcell	Public Site	v12.0	v12.1.0.53	EN, GE, CZ, PO
R G Strong Family Genealogy	Russell Strong	Public Site	v14.0.4	v12.0.0.69	EN, FR, DE, NL
Chamberlain & Eidenbenz Genealogy	Graham Chamberlain	Public site	v12.0.0	v12.0.0.36	EN, ES, NL, FR, DE
British 1820 Settlers to South Africa	Paul Tanner-Tremaine	Public site	v10.1.1	v10.1.1.30	EN
Van den Heuvel wereldwijd	Marco van den Heuvel	Public site	v10.1.1	v10.1.1.26a	EN, DU, GE, FR
Bisbee Family Connection	Rick Bisbee	Mod Developer	v10.1.2	v10.1.1.22	English
Brady Family Tree in Western Australia	Darryl Brady	Public site	v10.1.1	v10.1.1.33	EN, DE
Hooley Family Links	Rick Hooley	Public/Private	See Here	See Here	EN
Wyman Genealogy	John Wyman	Public Site	v11.0.0	v10.1.1.32	EN
Mitchell Families Online	Roger Mitchell	As usual from Rick, a very professional and useful add-on!	v10.1.2	v10.1.1.24	EN, SP, NL, D, SW
Gittens One-name Study	Cliff Gittens	This is a very handy add-on.	v10.1.2	v10.1.1.24	EN
Our Family History	Tor Lund	Public site	v14.0.2	12.0.0.69	NO, EN, DE
Kemp(e) Family History	Andrew Kemp	Very professional and useful add-on!	see User:Kempons	see User:Kempons	EN
MOTYER Family Genealogy	John Mark Motyer	Public site	See here	See here	EN
The Zausmer Forest	Joyaa Antares	Private Site	v10.1.3	v10.1.1.33	EN
the Runkle project	Steve Pritt	Public Site	v11.0.2	v10.1.1.33	EN
Bumbery-Wangler	Bob Bumbery	Public Site	v11.1.2	v10.1.1.34	English
Our Family History	John Hendee	Public Site	v12.0	v12.0.0.36	English
Nordic Ancestry	Mogens C. Fenger	Private Site	v12.0.1	v12.0.0.36	DA, EN
German Finnish Ancestry	John R. Schulte	Private Site	v12.0.1	v12.0.1	English
The Cole / Tanner Family Tree	David Cole	Public/Private	see here	see here	EN, DE, FR, ES, NL
Racine d'Alsace	J-Louis Valory	Public/Private - T17 customized	12.0.2	12.0.0.41	FR
Our Family Histories	Bryan S. Larson	Public - T8 customized	see here	see here	EN
MyMispoche (Mostly Jewish Genealogy)	Carlton Brooks	Public Site	v12.0.1	v12.0.1	English
LookingBackwards - All Our Relations	Ashleigh Mitchell	Public	v12.0.0.67	TNGv13.0.4	EN
Our Roots&Relatives	Kåre Kjøllesdal	Private Site	13.0.4	12.0.0.67	NO, EN
- Connections-Tree	Mansoor Ismail	Public Site(Password required for Admins)	v12.0.0.60	TNGv12.3	EN
Joseph Oran Holtz Genealogy Pages	Jim Holt	Private	See Here	See Here	EN
Your Roots are Showing	Harold Craswell	Public/Private	See Here	See Here	EN
Van Peer Project	Drew McClenaghan	Private Site. FGW modified to work with Admin Menu Link	14.3	12.0.0.67	EN
Genealogy of a Dutch East-Indies Family	Rob Severijns	Private	14.0	12.0.0.67	NL, EN
Coon White Family History	Alan Coon	Public/Private	12.0.0.67	13.1.2	EN
Kielakowie.com	Janusz Kielak	Public site	12.0.0.61	14.0.1	PL, EN, DE