Difference between revisions of "Census Plus International"

From TNG_Wiki
Jump to: navigation, search
(Sites using this mod)
(Revision History)
Line 206: Line 206:
 
! Date
 
! Date
 
! Contents
 
! Contents
 +
|-
 +
| v9.1.0.2
 +
| 22 Sep 2013
 +
| The following fixes were made in the update:
 +
* Fixed Interactive Import so that complete Location name is imported and not just the State
 +
*:  '''Note to those using TNG only''', you will need to update the  location in the Census Plus International mod created Census Events from  the Import from Ancestry
 +
* Fixed the Image hover message when Image URL is used
 
|-
 
|-
 
| v9.1.0.1  
 
| v9.1.0.1  

Revision as of 20:12, 22 September 2013

Caution The Census Plus International is an alternative to the Census Feature mod.

If you were previously using the Census Feature mod, then please use the Previous Census Feature users section below for instructions when installing this mod as a replacement.

Caution


Ambox notice.png Please read the Upgrading section below for instructions to upgrade from the Census Feature V9002 or v9212 to this mod.

The Census Plus FAQ contains answers to common questions.

TNG 9.1


Census Plus International
Summary Adds international census record data for Households on individual Info page
Validation
Mod Updated {{{mod_last_update}}}
Download link censusplus_v9.1.0.1.zip
Download stats View download statistics
Author(s) Janice Nation, Jeff Robison, and Ken Roy
Homepage Census Plus International
Mod Support TNG Forums
Contact Developer
Latest Mod 9.1.0.0 for TNG v9.1 and above
Min TNG V 9.1.0
Max TNG V 9.2.2
Files modified
Related Mods
Show/Hide Events can hide the events
Media - Census Plus International displays the Census Plus Transcript for user census Media collections
Family Edit Links Mod to quickly find the personID of family members
Person Custom Events relocates custom events below the Event Map.
Notes
This mod is an alternative to the Census Feature mod so you need to choose which one you install. They cannot both be on the system at the same time, since they both modify the tngtabs1.css files


Purpose of the mod

The Census Plus International mod allows you to display census transcript information for various countries on an individual page. It adds a Census Plus International menu to the TNG Admin screen which in turn allows an administrator to create, import, edit, search, find, update, or link international census records to individuals or a family.
Ancestry.com members can automatically import census records for the US Federal Census, UK Census, or Census of Canada.

The Census Plus International mod includes the following capabilities:

  • it uses the TNG Find Person and Advanced person search to find persons to be linked to the census transcript.
  • it uses TNG Name Order option to display Census Plus transcript on Individual Page
  • it adds a Person Preview to Census Plus Transcript Display provided by Jeff Robison
  • it allows you to Add census transcripts that cannot be imported, such as the Ireland, Scotland, Acadian, New France, and Lower Canada censuses
  • it can be used to add special census or other country census series that are not specifically defined
  • it allows the use of media collections or the use of alternate file names for your census image display
  • it allows the use of apostrophes in person and place names
  • it imports the actual census line numbers where available and allows the user to update them
  • it repeats the heading line as a table footer line for readability
  • it provides a new search capability modeled on the TNG people search
  • it adds several fields that better allow documenting your census source
  • it provides a script to copy the Census Feature tables if you were using it previously.

Script names and table names are different from the Census Feature mod, so there should be no collisions, although both mods cannot be installed at the same time since both include modifications to the TNG tngtabs1.css file to support a 7th tab.

Developer

This mod was developed by Janice Nation, Jeff Robison, and Ken Roy

V9.0.0.2 enhancements made by Janice and Ken to the original Census Feature mod by Gerald 'Jerry' Leehan were used along with parts of Jerry's original mod.

Credit for the mod also goes to Gerald 'Jerry' Leehan for the initial design and concept of the Census Feature mod and for the suggestions and testing provided by the alpha and beta testers:

  • Bryan Larson
  • Klaus Dieter Cook
  • Graham Chamberlain
  • Fred Feldman
  • Heather Fueurhelm
  • Roger Mitchell

Requirements

TNG version: 9.1.0
  • this mod requires jQuery, therefore it is only available for TNG 9.1 and above
  • 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
  • Census custom event type must be set to Accept.
    You can use personally created census event as long as the description contains census or the tag contains cens
  • for multi-language support to work, the Census Events must use either the CENS tag or contain census in the description
  • The Census custom event date can be a full date
  • two different census for the same year require two different census event types for linking
    for example the 1850 and 1860 US Federal Census and US Slave Schedule cannot be linked to the same census event
    the recommendation is to define a Slave Census event for the US Slave Schedule - note that the description must include the word census
  • Household number must be assigned for this mod to work
  • PersonID must be linked to the census entry for the person to be listed in the Census Plus transcript display
  • If you use a language other than English for TNG Admin, you need to
    • create the custom text entries in cust_text.php for your language
    • copy and translate the cp_text.php file from the English folder

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 with all its contents from the downloaded zip file into the mods folder or FTP the extracted files and folder with its contents 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.
  4. Note - if you're using the tng.php WordPress-TNG Plugin, you might need to "Update the TNG Variables" in the WordPress Admin pane for the TNG Plugin to get this to work correctly.
  5. Note - if you're using a different language than English for TNG Admin, you will need to copy the cp_text.php file from the languages/English or English-UTF8 folder to your language folder after installing the mod, before the buttons in the Mod Manager for the Census Plus International mod will work.

Previous Census Feature users

NOTE: If you previously ran the Census Feature mod do not follow the First Time Install steps on the Mod Manager screen, but use the following steps.

  1. Uninstall the Census Feature mod but do NOT drop the tables
  2. Install the Census Plus International mod
  3. Copy the Census Feature Tables
  4. Create the Census Plus Veterans Table (unless you previously were alpha testing the Census Feature v9003-alpha-7 release)
  5. Update the Census Plus Tables
  6. Update the Census Plus Summary Table
  7. Backup your Census Plus tables
  8. Check Table Integrity
    This step will update the new cp_data cplineno and the cp_link eventID fields and fix integrity issues within the Census Plus tables
  9. Skip the First Time Install steps

Note that Copying the Census veteran table to Census Plus veteran cp_veteran table will result in the following error:

Cannot execute query: CREATE TABLE cp_veteran LIKE cen_veteran;

The copy was left in place to support those who were alpha testing an update to the Census Feature mod that was never released.

First Time Post Install Actions

  1. Click the Create Census Plus Tables button shown on the mod manager screen to add the census plus tables if they do not exist.
  2. Click the Create Census and transcript button on the Mod Manager screen to create the census and transcriptsource folder if they do not already exist.

Upgrading

  • Census Plus International Upgrades: You should
  1. Create a backup of the Census Plus Tables before you remove the mod and do the upgrade
  2. Create a backup of the extensions/cp_settings.inc file that contains your Mod Manager Edit changes to the Census Plus International default options
  3. Remove (uninstall) the currently installed version of the mod but not the tables since they will contain your census data
  4. Download and extract the new version of the mod
  5. FTP the extracted .cfg file and the censusplus_v910n folder and all its contents to your TNG mods folder (or extract on site)
  6. Install the new version of the mod which should leave your tables and directories intact.
  7. Delete the previous version of the mod
    • Upgrading from the Census Feature v9.0.0.2 or v9.2.1.2 to this mod, you need to click the buttons in the Mod Manager screen for the Census Plus International mod to
    1. Copy the Census Feature tables
    2. Create the Census Plus Veteran table
    3. Update the Census Plus Tables
    4. Backup your Census Plus Tables
    5. Check Table Integrity
  8. Note - if you're using the tng.php WordPress-TNG Plugin, you might need to "Update the TNG Variables" in the WordPress Admin pane for the TNG Plugin to get this to work correctly.
  9. Create a backup of the Census Plus Tables after the upgrade before you make any changes
  10. Using the backup of the extensions/cp_settings.inc file Edit the Mod Manager option to set your preferred processing options.
  • 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.

Custom Text

This MOD contains custom text in both cust_text.php and a cp_text.php file in the English / English-UTF8 folders. A French version of the custom text will be provided in the future.

cust_text.php

The following custom text entries need to be created in your language, if you do not use English for TNG Admin

// Added for TNG Admin by the Census Plus International mod
$admtext['cenplus'] = 'Census Plus International';
$admtext['cpitems'] = 'Find | Add | Edit | Delete | Import | Update | Link IDs | Image';
$admtext['cpedit'] = 'Edit';
$admtext['cpbase'] = 'Census Plus Base';
$admtext['cpdata'] = 'Census Plus Data';
$admtext['cplink'] = 'Census Plus Links';
$admtext['cpsummary'] = 'Census Plus Summary';
$admtext['cpveteran'] = 'Census Plus Veteran';
$text['findcpperson'] = 'Find personID to be linked';


cp_text.php

Likewise if you do not use English for TNG Admin, you need to copy the English/cp_text.php file to your language folder and translate as appropriate.

Only the section of cp_text.php marked as Text that should be translated for public side of Census Plus International needs to be translated if you use English for your TNG Admin

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 so you do not lose the events on a GEDCOM import
  • The image file name in the census folder must be in the following format dbid=6743&iid=4241561-00594.jpg that matches the ancestryID column in the cp_base and cp_data database tables
  • 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.
  • for multi-language support to work, you must use either the CENS tag or the description must contain census
  • if you want to use Family Census event, then you
  • you cannot add more than 50 lines to a census transcript
    this restriction is imposed by PHP not allowing more than 1000 input fields
  • Household that are split within a Census Year must use the same household number and the Transcript ID must be sequential.
    Imported census will be sequential, so the restriction is related to manually added census transcripts.


Known Issues

  • Template 5 width in some cases, like the 1830 and 1840 transcripts with household summary counts will generated table entries that exceed the page content width
You will need to increase the width for maintable class to something like 1100 px

Revision History

Version Date Contents
v9.1.0.2 22 Sep 2013 The following fixes were made in the update:
  • Fixed Interactive Import so that complete Location name is imported and not just the State
    Note to those using TNG only, you will need to update the location in the Census Plus International mod created Census Events from the Import from Ancestry
  • Fixed the Image hover message when Image URL is used
v9.1.0.1 21 Sep 2013 The following fixes and enhancements were made in the update:
  • Changed to allow the Census Location to be updated in CP Update using the Town, County, State, and Country fields.
  • Added Roll to CP Display and Update
  • Changed Add to populate required fields with ?
  • Fixed the Ln display for the US 1850-1870 Census
  • changed the logic to set the Image link to the imageurl if it exists
  • fixed the CP Household Update so that the link to the Ancestry Images uses the Census Plus International option
  • standardize the Header displays for CP Display, Update, and Household Update
  • fixed the Image link for Ancestry images to open correctly in a separate window
  • fixed personlib.php hook in the cfg file to eliminate the conflict with the DoNotMap Custom Events mod
  • fixed the Selected option for TreeID to be set correctly when passed from previous script
  • added 1921 to the Census of Canada Add screen
  • fixed split household so that it displays correctly for Transcript IDs that are sequential
  • fixed to delete the census event when person is unlinked.
v9.1.0.0 15 Sep 2013 This is a new mod is an alternative to the previous Census Feature mod and provides the following enhancements
  • uses TNG Find Person dialog for linking TNG persons to Census Plus transcripts
  • uses TNG Name Order option to display Census Plus transcript on Individual Page
  • repeats the heading line as a table footer line for readability
  • adds the Person Preview to Census Plus Display
  • adds several new fields to the Census Plus base record to help better document sources
  • adds the 1890 Veteran Schedule
  • adds the 1790-1820 and updates the 1830-1840 household summaries
  • adds household summaries for the Lower Canada Census and allows you to select a household summary for other censuses
  • fixes the DOM Source import to handle apostrophes in names
  • fixes searches so they find a person whose name contains an apostrophe, like O'Regan
  • updates scripts to use options set by the user in Mod Manager Edit, such as controlling
    • whether 'United States' or 'USA' or nothing is added to US locations
    • whether 'Co.' or 'County' or nothing is added to the County in the location name
    • whether all members of a household are displayed whether linked or not
  • adds a Delete capability, to allow users to delete the imported entries they do not want
  • adds an Edit capability that allows users to delete lines within an imported transcript they do not want
  • adds the capability to use a TNG User Media collection or your own file name. See update imageurl
  • adds a single line census add capability
    • with several new census selections
    • with confirmation prompts for the Create New Transcript or Cancel
    • with a format selection in Add, Other Census that allows you to enter census not defined in the mod and control the row or line formatting
  • adds a new search capability that was cloned from the TNG Advance Search dialog to locate Census Plus transcripts

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 Plus International displays.


Census custom event

With the Census Plus International mod installed, the individual (getperson.php) page shows the Census Plus information for the Household for the Census custom event in the same name order that you specify for your TNG Admin >> Setup >> General Settings >> Names >> Name Order.

In other words, if you display names as First Name and Surname, that is the way the Census Plus row will be displayed.

Census Plus Display

Visitors can click the Image and Transcript links on the Census Plus transcript display to view the actual image. Images are displayed from your web site, if you have loaded the image to your census folder using the AncestryID file name or updated the imageurl to point to your image, including the use of showmedia.php links. Otherwise a link is created to Ancestry.com that allows those with a subscription access. The Transcript link shows the transcript information as imported or added by the TNG Administrator.
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

If you use the Census Plus Image tab and update the imageurl to use your TNG Census Media collection, the visitor can view the image using the TNG Image Viewer when a showmedia link is used which can also include information added using the TNG Image Map capability using the Tooltip mod.

Census Plus Image using Show Media
Census transcript

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

Census Plus Formatted Display

</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 Plus International mod shows six buttons to be used after installing the mod
  • Previously running Census Feature mod:
    • Copy Census Feature Tables
    • Create Census Plus Veterans Table (except Census Feature alpha testers who should skip this step)
    • Update Census Plus Tables
    • Backup Census Plus tables
    • Run Check Table Integrity
  • first time only:
    • Create Census Tables if they do not exist
    • Create the census and transcriptsource folders if the do not exist
After mod installing the mod
Utilities >> Back up, Restore & Optimize Table Data

The mod adds the following to the list of tables you can backup, optimize, or restore

  • Census Plus Base
  • Census Plus Data
  • Census Plus Link
  • Census Plus Summary
  • Census Plus Veteran tables .
With the mod installed
Admin

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

Census Plus International in Admin
Admin >> Census

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

Census Plus International screen with various tabs

</toggledisplay>

An Approach to Import

The procedure for using the Census Plus International mod for Importing DOM Source from Ancestry is as follows:

  1. select the View Record from the Ancestry Search results screen
  2. select the New Image viewer from the Ancestry search results screen, if there is a choice since they appear to default to the new viewer in a lot of cases now
  3. Expand the Index icon in the lower left corner of the screen
  4. right click on the index heading line
  5. choose the Select All option
  6. right click again on the screen
  7. choose the View Selection Source which launches a DOM Source window
  8. wait for the new window screen to be completely populated
  9. select File, Save Page As
  10. save the file using a name that makes sense to you, such as year_person_US_state_county_town.txt
  11. FTP the saved file to your tng/transcriptsource folder
  12. click the Refresh List button if you don't see the file
  13. if importing different than US, you must go back to the top of the screen and reselect the Series
  14. click the Interactive Viewer button

Note that if you are saving DOM Source from the interactive and standard (basic) viewer you should indicate in your .txt file name the source such as using _std or _int in the file name

See Census Plus International - Import 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 Census Plus 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 Census Plus Tables nor Delete the mod since you will want to re-install the mod after the upgrade.

In the event of a problem

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
Nation Study Janice Nation Repackaged and enhanced Census Feature mod 9.1.0.0 9.2.2 English
Our Roy and Boucher Family Ken Roy Repackaged and enhanced Census Feature mod 9.1.0.1 9.2.2 English,French
Robison and Blythe Genealogy Jeff Robison code contributor. Uses the Add dialog to add census entries. 9.1.0.0 9.2.2 English
Chamberlain and Eidenbenz Genealogy Graham Chamberlain alpha/beta tester. Census linked to Family Census events. Data managed in desktop application. 9.1.0.0 9.2.2 English,Dutch,French,German,Spanish
The Cook Family Pages Klaus Dieter Cook alpha tester. Uses Add, Other Census to enter Mexico census. Guest access login: guest pwd: guest 9.1.0.0 9.2.0 English,German,Spanish
Our Family Histories Bryan S. Larson alpha tester 9.1.0.0 9.2.2 English
Feldman Family History Fred Feldman beta tester. 9.1.0.0 9.2.2 English
Ancestral Stewart Family Tree Michael Stewart Public 9.1.0.0 9.2.2 English
Pimble One-Name Study Gerald A Cooke Not a Public Site. 9.1.0.0 9.1.0 English
Wilder Connections P. Beth Adams Not a Public Site. 9.1.0.0 9.2.2 English

TNG Modules Impacted

Click the Show Details link to see the list of TNG Modules changed.. <toggledisplay status="hide" showtext="[Show Details]" hidetext="[Hide Details]" linkstyle="font-size:smaller"> The following TNG Modules are modified, and should be backed up prior to installing this mod:

  • css/genstyle.css
  • css/tngtabs1.css
  • templates/template1/css/templatestyle.css
  • templates/template2/css/templatestyle.css
  • templates/template3/css/templatestyle.css
  • templates/template4/css/templatestyle.css
  • templates/template5/css/templatestyle.css
  • templates/template6/css/templatestyle.css
  • templates/template7/css/templatestyle.css
  • templates/template8/css/templatestyle.css
  • templates/template9/css/templatestyle.css
  • templates/template10/css/templatestyle.css
  • templates/template11/css/templatestyle.css
  • templates/template1/css/tngtabs1.css
  • templates/template2/css/tngtabs1.css
  • templates/template3/css/tngtabs1.css
  • templates/template4/css/tngtabs1.css
  • templates/template5/css/tngtabs1.css
  • templates/template6/css/tngtabs1.css
  • templates/template7/css/tngtabs1.css
  • templates/template8/css/tngtabs1.css
  • templates/template9/css/tngtabs1.css
  • templates/template10/css/tngtabs1.css
  • templates/template11/css/tngtabs1.css
  • personlib.php
  • admin_merge.php
  • admin_main.php
  • admin_leftbanner.php
  • languages/English/cust_text.php
  • languages/English-UTF8/cust_text.php
  • customconfig.php
  • admin_genconfig.php
  • admin_utilities.php
  • admin_backup.php
  • admin_optimize.php
  • admin_restore.php
  • deletelib.php
  • treelib.php

The following modules are added by this mod to provide options on how the mod behaves

  • extensions/cp_settings.inc

</toggledisplay>

Related Links

Census Plus International mod

Using_the_Census_Plus_Mod

Census Plus International - Options

Census Plus International - Find

Census Plus International - Add

Census Plus International - Edit

Census Plus International - Delete

Census Plus International - Import

Census Plus International - Update

Census Plus International - Link IDs

Census Plus International - Image

Census Plus International - Restore

Census Plus International - Styles

Census Plus International - SQL Reports

Census Plus International - Census Events

Census Plus considerations when using TNG only

Census Plus considerations when importing GEDCOM

Census Plus International and Family Census

Census Plus International - Source Citation

Media - Census Plus International mod