Difference between revisions of "Family Group Worksheet V10"

From TNG_Wiki
Jump to: navigation, search
(FGW Revision History)
(FGW Revision History)
Line 75: Line 75:
 
|- valign="top"
 
|- valign="top"
 
| 10.0.0.5 || 11 Apr 2014 ||
 
| 10.0.0.5 || 11 Apr 2014 ||
* Changed the FGW data storage format to prevent breaking MySQL  
+
* Changes the FGW data storage format to prevent breaking MySQL  
 
* Creates the FGW table with the correct collation sequence.
 
* Creates the FGW table with the correct collation sequence.
* Fixed table/column detection routines that were not working on some sites
+
* Fixes table/column detection routines that were not working on some sites
 
* Removed source of annoying warning messages that were showing up in status windows
 
* Removed source of annoying warning messages that were showing up in status windows
 
* Renamed certain FGW components to prevent clash with other mods/add-ons and breaking the FGW form
 
* Renamed certain FGW components to prevent clash with other mods/add-ons and breaking the FGW form
Line 99: Line 99:
 
|- valign="top"
 
|- valign="top"
 
|  || 26 Apr 2014||
 
|  || 26 Apr 2014||
* Fixed minor error in footer
+
* Fixes minor error in footer
 
|- valign="top"
 
|- valign="top"
 
|  || 26 Apr 2014 (a)||
 
|  || 26 Apr 2014 (a)||
* Replaced missing file from earlier package
+
* Replaces missing file from earlier package
* Fixed error in earlier package that prevented buttons from working on the Worksheet.
+
* Fixes error in earlier package that prevented buttons from working on the Worksheet.
 
|- valign="top"
 
|- valign="top"
 
|  || 27 Apr 2014 ||
 
|  || 27 Apr 2014 ||
Line 113: Line 113:
 
|- valign="top"
 
|- valign="top"
 
| 10.0.0.8  || 8 Jul 2014  ||
 
| 10.0.0.8  || 8 Jul 2014  ||
* Fixed bug associated with WordPress integrations where it would not generate a new worksheet for a child.
+
* Fixes bug associated with WordPress integrations where it would not generate a new worksheet for a child.
 
|}
 
|}
  

Revision as of 15:06, 8 July 2014

Family Group Worksheet V10
Summary Provides forms for visitors and invited guests to organize and submit family information for inclusion in the website.
Validation n/a
Mod Updated {{{mod_last_update}}}
Download link fgw_v10.0.0.8.zip
TNG 10.0
Download stats view statistics
Author(s) Rick Bisbee
Homepage Bisbee Family Connection
Mod Support Support for Family Group Worksheet V10
Contact Developer Rick Bisbee
Latest Mod 10.0.0.8
Min TNG V 10.0.0
Max TNG V Current
Files modified
none
Related Mods
Notes
Worksheet is self installing -- does not use Mod Manager


Introduction

Family Group Worksheet V10 adds a traditional genealogical family group sheet to a TNGv10 website. It differs from previous versions in that it stores worksheets on site and they can be retrieved by both the admin/editor and by the original submitter. Visitors can open an empty worksheet and fill in information about themselves and their families. They can generate a worksheet from a tab on a TNG personal or family group page, pre-filled with information from the page and ready for revision or addition.

New in version 4: the site administrator can allow his editors to process Family Group Worksheets that fall within their assigned trees. Naturally, the FGW setup page is reserved for admins only.

Invited Guests

The admin/editor can generate a family group worksheet, pre-fill it any way he likes, and mail a secure link to someone, say Uncle Harry, and ask him to click on the link and fill in whatever information he can about his family. Uncle Harry is not presumed to have computer skills beyond using email, and he is not required to have an account or log into the website to provide his own family history. This would be similar to mailing a family group sheet to a relative and asking them to mail it back.

When a worksheet is completed and saved, an email notification is sent to the site administrator. A copy is also sent to the submitter containing a secure link for him to re-access it if he wants to add or revise. The admin/editor has a small control panel at the top of each submitted worksheet to manipulate and determine its status.

You Should know

FGW V10 comes with support files for several languages -- Dutch, English, French, German and Spanish. Some of these files were developed using Google Translate. If a native speaker cares to submit files that are more idiomatic, we will be happy to replace them. There is a master help file in English -- others will be provided as/if they become available. There are also help links on the form for some of the data fields.

FGW V10 requires a new table in the TNG database that is created during setup. The default table name is fgw_forms. If you wish to name it something else, you can do so on the initial setup page. There are also Mod Manager files available to add worksheet tabs to personal and family group pages, and to modify TNG to include the new forms table in TNG backups.

Most of the features from previous versions of FGW remain.

Planned Upgrades

FGW V10 is designed to accommodate future upgrades to 1) add one-click merging of data into the TNG database, and 2) automatically create and attach a source-citation to each new fact, for example, "Unsourced information from Family Group Worksheet 216, submitted to this website by Uncle Harry, son of Jerry Smith, 4 July 2014."

FGW Revision History

Version Date Description
10.0.0.1 28 Mar 2014
  • Initial release of FGW V10
10.0.0.2 31 Mar 2014
  • Modified to accommodate i/net hosting services that have not yet installed MySQLi -- the improved version of MySQL used by FGW
10.0.0.3 4 Apr 2014
  • Fixed notification when leaving page without saving changes (IE)
  • Removed residual test mode settings that may have caused inconsequential warnings
  • Improved labels and added placeholders where needed
10.0.0.4 10 Apr 2014
  • Fixes (we hope) the problem some were having creating the forms table in the database
  • Adds setup functions to name, create, and delete the FGW forms table (admins only)
  • Adds option to allow TNG editors to administer FGW worksheets within their assigned trees
  • Provides Important Notices for configuration and processing results
  • Adds "smart" defaults for living flags based on dates of birth and death
10.0.0.5 11 Apr 2014
  • Changes the FGW data storage format to prevent breaking MySQL
  • Creates the FGW table with the correct collation sequence.
  • Fixes table/column detection routines that were not working on some sites
  • Removed source of annoying warning messages that were showing up in status windows
  • Renamed certain FGW components to prevent clash with other mods/add-ons and breaking the FGW form
  • In addition to restructuring the FGW data table, the database update routine converts the old data storage format to the new safe-store format
10.0.0.6 12 Apr 2014
13 Apr 2014
  • Cumulative fixes for data table creation and manipulation
  • Fixed Prev/Next paging for saved worksheets
  • Fixed worksheet deletion function
  • Synchronized English and English-UTF help files
  • Fixed dead Create Table and Drop Table buttons caused by some TNG templates
14 Apr 2014
  • Adds Norwegian language and help files (thanks to Tor Lund)
17 Apr 2014
  • The worksheet for a child opened in a new window causing browsers to block it as a popup. This revision opens the new worksheet in the current window, but warns first if data has not been saved.
18 Apr 2014
  • Update to Norwegian Language Files (Tor Lund)
26 Apr 2014
  • Fixes minor error in footer
26 Apr 2014 (a)
  • Replaces missing file from earlier package
  • Fixes error in earlier package that prevented buttons from working on the Worksheet.
27 Apr 2014 
  • Fixes some JavaScript incompatibilities with TNG-WordPress and TNG-Joomla! integrations.
  • Updates Dutch language files (courtesy of Edward van der Maarel)
10.0.0.7 27 May 2014 
  • Fixes worksheet so that data fields will not run off the page on some websites.
10.0.0.8 8 Jul 2014 
  • Fixes bug associated with WordPress integrations where it would not generate a new worksheet for a child.

Requirements

  • A working installation of TNGv10
  • PHP 5+

MySQLi

The development community is no longer supporting the MySQL Library. In fact most of the MySQL library functions have been deprecated and are replaced by MySQLi (improved MySQL). FGW uses the MySQLi interface, but if it is not present on your server, it reverts to MySQL. That means that during the transition, it should work well, whether your host provider has MySQLi installed yet or not.

Family Group Worksheet

Shown is in the default styling with LDS event fields displayed (configurable by the administrator.) If website has more than one family tree, a drop down selection menu is presented. If the user is an invited guest, the tree list and personID fields are disabled.

Ex001.png


Admin Control

Ex002.png


After the worksheet has been submitted the Admin can access it with just the ID number or by clicking on the link in the emailed notification. Anyone else must have the security key.

For admins, a control panel will display at the top of the form. If the visitor provides information on a person or family already in the database, but has not supplied the person or family ID, the admin can add them here. After merging the new information to the TNG database, he can mark it merged. If the submitter returns and updates his form, new notification will be sent to the admin, the merged status flag will be reset, and the worksheet will be considered active again. The admin can also mark the worksheet closed, in which case the visitor no longer has access to it. Finally, the admin can can use the control panel to delete the worksheet from the database.

The admin control section also allows navigating through the saved worksheets with an option to ignore those that have been merged and/or closed. You can search for other worksheets using worksheet ID (no prefix), family ID (prefix 'F') or person ID (prefix 'I'), or by clicking on the Search by ID button with no ID, you can display the entire selectable list of worksheets, showing their numbers, titles and status (merged, closed).

There is no separate help file for the setup page.

Please Note: While there is an automated merge capability planned for a future release, currently all merging of new information into the database must be done manually by the admin.

Installing FGW V10 (version 4+)

If you download and install FGW V10, please add your Website to the list of users at the bottom of this article. Future upgrades and maintenance will depend on how much it is being used. --Thanks.

  • Remove previous version of the fgw folder from your extensions folder.
  • Download the fgw_10 package from the TNGWiki.
  • Unzip and place the fgw folder inside your extensions folder.
  • Navigate to extensions/fgw/setup.php.
  • Enter the name of your existing forms table if you want to continue using it, or you want to remove (drop) it from the database. To create a new table, either keep the default name or enter one of your own choosing.
  • Select the other options you want and click on Save Preferences.
  • At the bottom of the setup page, next to the Create Table button, you will see the status of your preferred table; it either exists or does not exist. If the table already exists, look for a link below the button for you to update it if necessary. To Delete it click on Drop Table.
  • Warning! If you choose to create a table that already exists, it will delete all the existing records.
  • Click on Family Group Worksheet button.

Completely Uninstalling FGW V10 (version 4+)

  • Go to the FGW setup page and Drop the forms table (can also be used to remove older FGW tables if present)
  • Remove and discard the fgw folder from the extensions directory
  • Remove and discard the fgw_tabs mod (if installed)
  • Modify or remove the Personal Table Maintenance mod (if installed)

Administrator's Setup Page — Top

When you navigate to extensions/fgw/setup.php you will see a setup screen where you can create the worksheet forms table in the database and set your preferences. You can revert to the default settings at any time. Bookmark this page in your browser for easy access in the future. Also consider adding an admin-only link to one of your drop down menus (see below.)

Su-001.png


The top portion of the setup page is where you set the name for your FGW forms table. The default is fgw_forms, but if you want to select a different name, enter it here and save your preferences below. If you are using a table named in a previous version, change it here and save it.

You can check the box to allow anyone logged in as an editor to access the saved worksheets, provided they are associated with his assigned tree. If the editor has not assigned tree, he will be able to access all worksheets. Remember, only the admin can access this site-wide setup page.

Check the box to display forms for submission only to logged in users restricts public visitors from seeing any Family Group Worksheets. There is one exception, however: if a member of the public has been sent an email request for information, and they click on the included link, which contains both an ID and a form key number, they will have access to the specific form to edit and submit it. They will not be able to change the tree or any person IDs on the form.

The third check box at the top will hide LDS fields.

The other fields are used the customize the appearance of the worksheet.

Administrator's Setup Page — Bottom

Su-002.png



The bottom of the setup page has controls to save your preferences after you've changed them. There is also a control to restore the worksheet to its original default configuration.

NOTES:

  • If you are unable to save your configuration changes, make sure the user_config.php file has been granted write privileges.
  • The FGW table uses a MySQL trigger to create the form key and a time stamp when last updated. Be sure the MySQL account that TNG uses to open the database has the Super privilege set (use phpMyAdmin) or the trigger will not work and form keys will not be generated.

Finally, there are controls for creating or removing the FGW table from the TNG database. These controls work on the file name you've entered at the top and saved in your preferences.

If this is your first installation and you are happy to keep the default table name, just click on the Create Table button.

If you have installed a new version of FGW and want to keep your old table with all of its records, enter the name of your table at the top and save the preferences. The table is not modified in any way.

The status next to the Create Table button should tell you if the table exists or must be created. If it exists, there may also be a link telling you to update the structure. It will only appear if your table needs updating. Clicking on this link will safely update the table without harming any of the worksheet records you already have.

Be aware that the LDS viewability setting for the worksheet does not override your TNG setup. If you have LDS turned off for the website, you can not turn it on in the Family Group Worksheet. The same holds true for individual user settings.

Using on a site with the tng.php WordPress Plugin

If you are using the tng.php plugin to put TNG onto a page on your WordPress site, you'll need to add a rewrite rule to your site's .htaccess file to make the Worksheet open in a TNG window not a WordPress window. Add this to your .htaccess file BEFORE the block of lines written to that file by WordPress

# To get the Family Group Worksheet  to open in /tng/ not in /Genealogy/
RewriteEngine On
ReWriteRule ^genealogy/extensions/fgw(.*)$ tng/extensions/fgw$1 [R,L]

where

genealogy = the name of the WordPress page that TNG appears on
tng = the name of the folder that TNG is installed in on your site

Linking to the Worksheet

You will need to add a link to the worksheet (extensions/fgw/fgw.php) for users to access it. TNGv10 allows you to add links to the TNG drop down menus or to a custom menu you have created. To use this feature you must define your link in your customconfig.php file. In the following example, we add a worksheet link to the TNG *Find* menu.

$link_nr = 0; // first add-on link_nr must be zero 
$findmenulinks[$link_nr]['target'] = "extensions/fgw/index.php";
$findmenulinks[$link_nr]['sprite'] = "";
$findmenulinks[$link_nr]['icon'] = "extensions/fgw/img/families.gif";
$findmenulinks[$link_nr]['label_text'] = "Submit Family";
$findmenulinks[$link_nr]['admin'] = false;

FGW V10 will list existing worksheets with the following URL: extensions/fgw/fgw.php?id=index. To add an admin-only link to a custom menu that you have already defined and populated with other links:

$link_nr++; // subsequent add-on links must be incremented (++) 
$custommenulinks[$link_nr]['target'] = "extensions/fgw/fgw.php?id=index";
$custommenulinks[$link_nr]['sprite'] = "";
$custommenulinks[$link_nr]['icon'] = "extensions/fgw/img/families.gif";
$custommenulinks[$link_nr]['label_index'] = "ws_list";
$custommenulinks[$link_nr]['admin'] = true;

Notice in the last example we used a $cust_text.php definition for the link's label in support of multiple languages. Of course, you must provide that label yourself in your cust_text.php files for each language; for example, in English-UTF8/cust_text.php: $text['ws_list'] = 'FGW Index';

For greater detail about how to customize your drop down menus, see the TNGv10 Custom Menu Hook

FGW Tabs Mod

For those who would like to have a tab at the top of each personal and family page to open a Family Group Worksheet pre-populated with data from the source page, see the companion FGW Tabs Mod. There is no change to this mod from TNGv9, so if you already have it installed, there is no need to replace it.

Personal Table Maintenance Mod

Install the Personal Table Maintenance mod by Bart Degryse if you would like to have the FGW forms table included in those that are backed up using the TNG Admin backup utility. If you are already using this mod, add the FGW forms table name to your list of personal tables.

For those who use a third party backup utility such as MySQLDumper, the new table will automatically be included in your SQL backup files. These SQL files are also useful for downloading to a WAMPS site and restoring the database as an exact copy of what is on line.

Using a Captcha

The captcha was removed in version 4 as it was problematic and thought to be unnecessary. If you disagree, please let the developer know about it.

TNG Websites Using This Add-on

If you download and install this add-on, please add your TNG site to the table below to let us know if there is enough interest in it to warrant active maintenance.

URL Admin Note Mod-Version/TNG-Version User-language(s)
A Bisbee Family History Rick Bisbee Public site (FGW developer) 10.0.0.3/ TNG 10.0.1 EN
Mitchell Families Online Roger Mitchell Rick's continuing development of this add-on takes it from strength to strength! 10.0.0.6/ TNG 10.0.1 EN
Farnham & Paradise Ohana Barbara Farnham Paradise Login:tngguest/tngguest (Contains minor format modifications.) 10.0.0.6/ TNG 10.0.1 EN
Our Family History Tor Lund Public site 10.0.0.4/ TNG 10.0.1 EN, NO, DA, FR, DE
Wyman Family John Wyman Public site 10.0.0.6/ TNG 10.0.1 EN
British 1820 Settlers to South Africa Paul Tanner-Tremaine Public site 10.0.0.6/ TNG 10.0.1 EN
MOTYER Family Genealogy John Mark Motyer Public site 10.0.0.6/ TNG 10.0.1 EN, DE, RU
Van der Maarel and many other European and US families Edward van der Maarel Public site 10.0.0.6/ TNG 10.0.0 NL, EN
Gittens One-name Study Cliff Gittens Public site 10.0.0.7/ TNG 10.0.2 EN
Roni & Jerry's Genealogy and Family History Jerry Liebowitz Public site 10.0.0.7/ TNG 10.0.2 EN

Disclaimer

There is no warranty. Use the add-on at your own risk. It has been tested in many of the TNG template styles without any particular problems. If you experience difficulty or would just like to comment, please Contact us here