Difference between revisions of "Census Feature"

From TNG_Wiki
Jump to navigation Jump to search
Line 315: Line 315:
 
| [[User:wsw9183|Willis S Whittlesey III]]
 
| [[User:wsw9183|Willis S Whittlesey III]]
 
| Public Site
 
| Public Site
 +
| V9.0.0.0
 +
| TNG V9.2.0
 +
| EN
 +
|-
 +
| [http://genealogy.stewart-clan.com/getperson.php?personID=I000157&tree=tree1 Ancestral Stewart Family Tree]
 +
| [[User:Ecks|Michael Stewart]]
 +
| Testing Mod
 
| V9.0.0.0
 
| V9.0.0.0
 
| TNG V9.2.0
 
| TNG V9.2.0

Revision as of 11:27, 28 March 2013

Ambox notice.png The Census Feature mod currently only supports US Federal Census.
Please read the section on Requirements, known issues, and restrictions.

The Census Feature FAQ contains answers to common questions.

TNG 9.0


Census Feature
Summary Adds census record data for Households on individual Info page
Validation
Mod Updated {{{mod_last_update}}}
Download link censusmod_v9.0.0.0.zip
Download stats View download statistics
Author(s) Gerald 'Jerry' Leehan
Homepage Census Feature
Mod Support TNG Forums
Contact Developer
Latest Mod 9.0.0.0 for TNG v9
Min TNG V 9.0.0
Max TNG V 9.2.0
Files modified
Related Mods
Notes
Note that the mod zip file is 9MB because of the help images.


Purpose of the mod

This mod provides administrators with the ability to create census records and transcripts and store them in new tables that can be searched and displayed in TNG. It also creates a directory for census images.
The mod creates a display in the 'Census' tag on each census individual's TNG Info page that shows key fields from the census record for each member of the household. Transcripts of the census page containing the individual are created and linked to the census item.
Tools automate the linking of individual census records to people in the database using search techniques that consider alternate spellings and maiden and married names.
When census individuals cannot be located in the existing TNG People table, the administrator is given the option of automatically adding them along with any relationships that can be deduced from the census household data.
Ancestry.com members can automatically import census records.

Developer

This mod was developed by Gerald 'Jerry' Leehan with very significant contributions from Ken Roy.

Requirements

  • A working TNG installation.
  • A backup of all affected files (see the list in the summary in the upper right corner of the page)
  • An installed current version of the Mod Manager (is already included in TNG v9)
  • All templates/templateN folders be on your site
  • Both English and English-UTF8 folders be on your site
  • The CENS custom event type must be set to Accept.
    You must use the standard CENS - Census event and not a personally created census event
  • The CENS custom event date must be entered as YYYY only.

Installation

  1. Download the appropriate zip file as shown in the summary in the upper right corner of the page.
  2. Extract the files and folder from the downloaded zip file into the mods folder or FTP the extracted files and folder 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 mod.

First Time Post Install Actions

  1. Click the Create Reqd Tables if they do not exist button shown on the mod manager screen to add the census tables if they do not exist.
    This button will only create these tables if they do not already exist in your database.
  2. Click the Create Census directory if it doesn't exist button on the Mod Manager screen to create the census folder if it does not already exist.
  3. Click the Load initial Alternate Spelling Dictionary to load a dictionary of common alternate spellings used to improve searches.
    You can optionally, skip step 3 and create the Alternate Spelling table as you Assign IDs on new transcripts

Upgrading

  • Strategy: The MOD is still at its release version, but during future upgrades you should uninstall the old version of the mod but not the tables since they will contain your census data. The upgrade install procedures will leave your tables and directories intact.
  • TNG release upgrades: It is not necessary to remove (uninstall) the mod prior to installing the TNG upgrade. You will likely need to do a Clean up after the upgrade and then re-install the mod.

Other Languages

This MOD currently only supports English language and has extensive 'help' files containing images with English depicted on screens. Since the TNG Help screens are in the English language folder, if you run your site as UTF-8 then you need to keep both the English and English-UTF8 folders. I do not anticipate a huge demand for the mod in other languages, contact me if you have needs in this area.

Restrictions

  • If you import a GEDCOM as a way of supporting your web site, you must define the Census events (or facts) in your desktop genealogy program and only use the year for the date.
  • The CENS custom event type must be set to Accept.
    You must use the standard CENS - Census event and not a personally created census event
  • The CENS custom event date must be entered as YYYY only and not the census enumeration date.
  • The image file name in the census folder must be in the following format dbid=6743&iid=4241561-00594.jpg that matches the transcript_file column in the cen_data database table
  • The household number must be the same for all members in a household.
    If a family crosses images, where the Head of household is at the bottom of one page, and part of the family is at the top of the next page, you must enter the same household number for both transcript sources when assigning household numbers.

Known Issues

The following are known issues with this mod:

  • Currently only supports US Federal Census on Import from Ancestry.com
    You can manually create an entry for the 1861 Census of England, but not for any other country
    Creation and importation of census from other countries and territories is planned for future release.
  • There is currently no easy way to delete a census imports
    You should be able to delete them in phpMyAdmin using the transheadID in the cen_transhead, cen_data, and cen_link tables
  • Template 9 uses hard-coded widths and in some cases, like the look4assignupdate.php the generated table will exceed the page content width
  • You cannot edit entries for the 1840 US Census and add the summary counts for persons in the household
  • There is a problem with the Import from Ancestry if user corrections were made
    When a person submits a correction to a Census record on Ancestry there is additional text added to the line for that particular person.
    Currently the mod does not process this text and so information is not imported correctly
  • Currently the Add / Update scripts truncate some of the data input
    There are likely other issues with manually adding census information
  • There is an issue with importing US Census Dom Source when using Ancestry.co.uk
    where the Census Year is not found
    Since your are accessing US Census from the UK site, you should be able to login to Ancestry.com to get the correct DOM Source
  • The Census Thumbnail image was not copied from the mods/censusmod folder to the img/ folder
    Manually copy the censusthumb.jpg from the mods/censusmod folder to the img/ folder
  • There is a problem with the Import from Ancestry if the capture was done in AncestryLibrary.com at a public library
    The Census Year is not found
    The DOM source file does not contain all the same rows of data as a transcript captured at home so the keys for importing the data are off

Feature List

  • Four new tables and two new directories are added to TNG to facilitate storage, manipulation, and display of Census data and images.
    (Note that if you are already using a census folder for a Census media collection for example, it will co-exist with this mod).
  • Records can be linked to individuals in the main TNG People table... see ADMIN tools
  • Information from the Census tables will display in the Census Description box of each individual in the census
    • Each individual in the household will be shown
      • Key census fields displayed
      • Links to each individual
      • Focus individual is highlighted
    • Links to full transcripts and to actual image data are provided
      • Image link will find images stored in the Census folder or look for them on Ancestry.com if they are not on site
      • The transcript display
        • Shows all individuals and all fields contained on each census page
        • Shows header data for the page... e.g. Township, City, State, Enumeration District, Page...
        • Links to preceding and succeeding transcripts if they exist and to the full image
        • Is editable by those with administrator privileges
  • A Census section is added to the TNG Administration Index page with tabs for key census administration procedures:
    • View
    • Add
    • Edit
    • Import from Ancestry
    • Update Transcript
    • Assign IDs
    • Image
  • Extensive pictorial 'Help' tutorials are provided for each Census Administration tab.
  • The census table can be optimized, backed up or restored just like any other table.
  • The census table's structure will be backup up together with all other tables. Note that restoring such backup after explicitly deleting the table and uninstalling the mod will restore the census table. So you should probably make a new table structure backup before uninstalling the mod.

Visualization of this mod

The following images show the visual effects of installing the mod.

Site Visitor

Visitors to your site will see the Census transcripts.


Census custom event

With the mod installed and census transcripts added the individual info page shows a transcript for the Household for the Census custom event

Census transcript display

Visitors can click the Image and Transcript links on the Census transcript to view the actual image, if you have loaded the image to your census folder using the correct file name, or from Ancestry.com if you did not load the image and they have a subscription that allows them access, and the additional formatted transcript information. Click the Hide Details link below the images to hide the screen captures for the census Image and Transcript. <toggledisplay status="show" showtext="[Show Details]" hidetext="[Hide Details]" linkstyle="font-size:smaller">

Census image

The visitor can click the Image link on the Census image on Ancestry.com if they have a paid subscription that allows access.

Census Image on Ancestry
Census transcript

The visitor can click the Transcript link on the Census display on the Individual page to get a formatted transcript display.

Census transcript formatted

</toggledisplay>

TNG Admin

The TNG Administrator will see the following changes in the admin side. Click the Hide Details link below the images to hide the Admin screen captures. <toggledisplay status="show" showtext="[Show Details]" hidetext="[Hide Details]" linkstyle="font-size:smaller">

Mod Manager screen for the Census Feature mod shows three buttons to be used after installing the mod for the first time only:
  • Create Census Tables if they do not exist
  • Create the census and transcriptsource folders if the do not exist
  • Load initial Alternate Spelling Dictionary
    Optionally, you can skip the load of the provided Alternate Spelling table and create your own Alternate Spelling Dictionary as you add Census Transcript records
After mod is installed first time only
Utilities >> Back up, Restore & Optimize Table Data

The mod adds the Alternate Spelling, Census Data, Census Link, and Transcript Heading tables to the list of tables you can optimize, backup or restore.

With the mod installed
Admin

The mod adds a Census link in the left frame and button in the main frame of the TNG Admin screen.

Census option added to Admin
Admin >> Census

The mod adds a Census screen with View, Add, Edit, Import from Ancestry, Update Transcript, Assign IDs, and Image tabs

Census screen with various tabs

</toggledisplay>

An Approach to Using

If you have a paid subscription to Ancestry.com, you can find the Census images and save the transcripts so they can be processed by this mod. The following is an approach used.

  • Save the image to your census folder with a file name that uses part of the URL for the dbid= and iid=, for example
    dbid=6224&iid=4639366_00188
  • save the census image with a file name that allows you to find the image
  • save the transcript file with the same name but with a .txt extension
  • copy the transcript file to the TNG transcriptsource directory
  • copy the image file using the dbid= and iid= name to the census directory

Note: If you maintain your genealogy master database in a desktop program, the Census events (CENS) should be created in your desktop database using the census year only for the event.

See Using the Census Feature Mod for additional details.

Uninstalling the mod

If you want to completely Remove (uninstall) this mod and all its tables, you should

  1. click the Drop 3 Census Mod Tables button in the Mod Manager status screen for the mod to delete the census table before you
  2. click the Remove button to uninstall the mod and then
  3. click the Delete button to delete the config file from the mods folder.

If you are uninstalling the mod prior to an upgrade, you should only click the Remove button to uninstall the mod. You should not Drop 3 Census Mod Tables nor Delete the mod since you will want to re-install the mod after the upgrade.

In the event of a problem

  • Try using the Mod Manager Remove capability
  • Contact me through the TNG forum.
  • Contact me through the Contact Developer link in the Mod Summary in the upper right hand corner of this page
  • Copy the backup of the affected files back to your TNG directory


Revision History

Version Release Date Contents
v9.0.0.0 5 December 2012 Initial generally available release of the Census Feature mod


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
Families of NW Pennsylvania Gerald 'Jerry' Leehan Mod Developer V9.0.0.0 TNG 9.0.2 EN
Our Roy and Boucher Family Ken Roy Tested the mod for Jerry V9.0.0.0 TNG 9.1.2 EN, FR
Our Family Histories Bryan S. Larson Tested the mod for Jerry V9.0.0.0 TNG 9.1.2 EN
AppeltHaus Genealogy Lawrence Appelt Not a Public Site. V9.0.0.0 TNG 9.2.0 EN
Pimble One-Name Study Gerald A Cooke Not a Public Site. V9.0.0.0 9.1.0 EN
The Dutton's of Vermont Darrin Dutton Sample Page V9.0.0.0 TNG 9.1.2 EN
Conjunctions Rosina Lippi sample page (still tinkering) V9.0.0.1 TNG V9.1.0 EN, DE
Whittlesey-Whittelsey Family History Willis S Whittlesey III Public Site V9.0.0.0 TNG V9.2.0 EN
Ancestral Stewart Family Tree Michael Stewart Testing Mod V9.0.0.0 TNG V9.2.0 EN

TNG Modules Impacted

The following TNG Modules are modified, and should be backed up prior to installing this mod:

  • customconfig.php
  • admin_backup.php
  • admin_optimize.php
  • admin_restore.php
  • admin_utilities.php
  • admin_genconfig.php
  • tabledefs.php -- should there be a change here?
  • admin_merge.php
  • getperson.php
  • personlib.php
  • admin_leftbanner.php
  • admin_main.php
  • treelib.php
  • css/genstyle.css
  • templates/templateN/css/templatestyle.css
  • your languages cust_text.php file(s)

The following modules are added by this mod to create and delete the Census tables:

  • usemakecensustables.php
  • dropcensustables.php