PGVWiki - User contributions [en]

GedFactAssistant module

2010-02-16T23:56:03Z

Nigelo: /* Sub-module: Census Assistant (Due for release, PGV ver. 4.3.0) */

A module intended to provide assisted data entry options in various parts of PGV. Each '''Assistant''' is designed as a separate sub-module. From PGV ver. 4.2.2 onwards the first sub-module '''Manage Media Links''' is available. The next sub-module '''Census Assistant''' should be released with PGV ver. 4.3.0.

== Installation ==

If you download the '''PhpGedView-all-x.x.x.zip''' package this module is included, and will be correctly installed as part of PhpGedView.

If you originally installed the '''PhpGedView-basic-x.x.x.zip''' package this module is '''not''' included, but can be downloaded from the same location. Look for '''PGV-Module-gedfact-assistant-x.x.x.zip''', ensuring that you use the same version level (x.x.x) for the module as your PGV installation.

To install the module copy the files to your server in the locations stored in the zip file. In summary:

GEDFact_assistant.php in the ''phpgedview/modules/'' folder

All others in ''phpgedview/modules/GEDFact_assistant/'' folder or its sub-folders:

:''phpgedview/modules/GEDFact_assistant/_MEDIA''

:''phpgedview/modules/GEDFact_assistant/css''

:''phpgedview/modules/GEDFact_assistant/languages''

As new sub-modules are added they will have their own sub-folders, such as:

:''phpgedview/modules/GEDFact_assistant/_CENS''

== Sub-module: Manage Media Links ''(PGV ver 4.2.2 and later)''==

===Purpose===
This gives a method of managing media links, especially where one media item should be linked to multiple individuals or families. It provides a single window where you can add, edit or delete links, as well as tools to help easily find the individuals or families you want to link to.

===How to use===
To start using this assistant you need to find and click on a '''Manage Links''' option. They can be found in a number of places, depending on your configuration:
#On the '''Manage Multimedia''' page, it is one of the options beside each media item.
#Anywhere a media item is displayed, click on its title to go to the '''View media details''' page. From there select 'Media Options' -- 'Edit' -- 'Manage links'.
#On the Multimedia List, click on '''View details''' beside the image thumbnail. As above, from there select 'Media Options' -- 'Edit' -- 'Manage links'.
#If you use the Lightbox module: on the Album tab select '''View details''' from the drop-down options under the media item thumbnail's title. As above, from there select 'Media Options' -- 'Edit' -- 'Manage links'.
 
Clicking on '''Manage links''' opens a window like this: 
[[File:links1.jpg|border]]
 
This shows:
* The image you are linking.

* Any existing links, with options to remove them or add new links ('''Navigate''').
* A section for adding new links using PGVs normal "Find" features.
* The option to preserve, or not, the CHAN (Last Change) record.
 
Clicking on '''Navigate''' adds a second window beside the first. 
[[File:links2.jpg|border]]
 
This is similar to the "Navigator pane" on Individual pages, and lists close family members - those most likely to be linked to the same image. This allows you to simply click on as many other names as you need to add them as new links, as shown in the next image:
 
[[File:links3.jpg|border]]
 
If the names you need are not displayed, there is either the "Search" window at the top of the "Navigator" window, or the Add Links options on the first window. If you make a mistake and need to remove a link, click on the red '''X'''.

Once all the links are in place, click '''Save''' to complete the process. The single media item will now be linked to all the individuals (or families, or sources) you chose.

== Sub-module: Census Assistant==
''(Due for release, PGV ver. 4.3.0)''

===Purpose===
This tool allows you to add all the details from any ''(currently only US or UK)'' census page to '''ALL''' the people listed on it (providing they exist in your GEDCOM file) in '''ONE''' process. It includes tools to help find the relevant individuals, and presents the results in an easy to read, formatted, shared-note, containing all of the key facts from the original census page.

Here is an example of the completed display:
[[File:Ca_final.jpg|center|border]]

===How to Use===
To add census data, start from any individual shown on the census page for the household, select Census['''CENS'''] from the '''Add new fact''' drop-down at the bottom of the page, then click '''Add'''. ''[Ideally you would start with the 'Head' of the household, but it is not essential]''

This will open a Census edit pop-up window 
[[File:Cens1.jpg|border]]
 
'''From here, the first steps are:''' 
# Enter the date of the census, either directly in the Date field, or by using the '''Census Date''' drop-down to select the census you are entering. This will automatically enter the correct date in the Date field.
# Enter any other details you require, such as Place, Address, or add a media item if you want one at this level.

'''Very important:''' Only enter data here that can be '''common''' to all the individuals on the census page / household. So do not enter Age for a single individual otherwise later in the process that age will be copied to all the other individuals.

'''Next add a Source Citation for this event''', by clicking on the '''Add a new Source Citation''' option and entering the appropriate details.

At this point there are two options for adding the Shared Note containing the census details:
# By clicking on '''Shared Note using Assistant''' within the Source details area. This will add the census details as a note to the Source record
# By clicking on '''Add a new Shared Note''' below the Source details area, then clicking on the '''Shared Note using Assistant''' in this area. This will add a shared note at the same level as the Source. ''[This is the option chosen for the finished example shown above here]''

Whichever you choose, '''Shared Note using Assistant''' opens the '''Census Assistant''' window, a large pop-up. It contains 6 areas of information, which are briefly described here. Detailed instructions for each area will follow below using these numbers as the key. You can see that much of the information already entered has been retained here, so no re-typing is required. 
[[File:Assistant.jpg|border]]
 
# Header information. This identifies the person you started the process from as the "Head"
# Summary Information input, where you will enter the key information from the census page related to the whole page.
# Person list and search. This presents the person from the header area ("1") plus their close relatives, and a Search option if required
# Census data input. This area will be populated later with the line entries for each individual shown on the census page
# Shared Note preview panel. This area will display the actual GEDCOM data that will be stored in the shared note record once you complete all steps.
# Preview, Save, and Help options

====Area 1 - Header information====

It is important to identify the correct person in this information. The name is used in the title of the shared note (area '''2'''), and will, if not edited later, be identified as the '''Head''' of the household on the individual details later (area '''4''').
If you need to change this person, select someone else from the list in area '''3''', and click on the small "head" icon beside their name. The screen will refresh, with that new person shown in area '''1'''. 
[[File:Area_1.jpg|border]]

====Area 2 - Summary information====

This is where you can enter information related to the whole census page.

The items "Country" and "Year" are '''mandatory''', but will generally be filled in automatically from the entries you made on the previous window. They can be changed here though if you want to. You must select the country of the census ''(currently only UK or USA are available)'', and the year of the census before any other data can be entered. These are also added in front of the text in the '''Title''' box to create the title of the shared note. The '''Title''' text can be manually edited here if you want.
 [[File:Area_2.jpg|border]] 
The fields, '''Reference''', '''Locality''', and '''Notes''' are also optional, and are simple text entry fields. You can add any appropriate text of your own or from the original census pages here, or leave blank if you prefer.

At this point you can click on '''Preview''' in area '''6''' to see how the inputs made so far will appear in the GEDCOM NOTE record, displayed in area '''5'''.

====Area 3 - Person List and Search====

This area is based on the '''Family Navigator''' pane shown on Individual pages of PGV. It lists close relatives of the person set as '''Head''' here (marked with a '''tick'''). It is designed to include those people most likely to be needed for this census record.
 [[File:Area_3.jpg|border]] 
Its use is very simple. Following the order of people listed on the original census page, click on each name in turn. As each name is clicked, their details will be transferred to the Data Input area '''4''', including any pieces of information that can be deduced automatically at this time.

Once all the required people have been added to area '''4''', the whole window will look like the example below.
 [[File:Assistant2.jpg|border]] 

====Area 4 - Census Data Input====
 [[File:Area_4.jpg]] 
''['''Note:''' on your screen you will see scroll bars, needed to view the full width or height of this area. This is necessary to accommodate large numbers of columns found in census pages in some years, and for large households, while still fitting a pop-up window on most screen sizes.]''

The next steps are to:

# Manually change any of the deduced information displayed (shown here in blue), such as age, marital condition ('''MC''') to match exactly the contents of the original census page
# Enter data in the remaining fields, copying them from the original page.

Other things to know about this area:

:* To know what each of the short header titles, such as '''FBP''' actually mean hover your mouse over them to read a '''tool tip''' brief explanation. These change according to the Country / Year census chosen in area '''2''', and will correspond to columns of data on the original census. The same '''tool tips''' are also available on the finished presentation in PGV.

:* Above the table is an '''Add/Insert Blank Row''' button. This is connected to the '''Add''' marker on the right of the area. While '''Add''' is marked, the button will add a new, blank row at the bottom of the list. If you click on any marker under the '''Ins''' field at the right, the same button will insert a row above the person chosen. These blank rows enable you to add information about people NOT recorded in your GEDCOM file, but present on the census page.

:* Click on the '''X''' to the right of any data row to delete that row from the list. You can put it back, or in another position by setting an '''Ins''' marker then clicking a name from area '''3''' again.

====Finishing====
When all the data in area '''4''' is as correct as you want it to be, click on '''Preview''' in area '''6''' for a final review of the output, which will look like this:
 [[File:Area_5.jpg]] 

If all is well:
:* Click on '''Save''' (area '''6''').
:* You will see another window, confirming the INDI numbers the event is about to be saved to, for information only.
:* Click on '''Paste the following ID into your editing fields to reference the newly created record N1'''.
:* You will now be back to the original Add Census window.
:* Make a final check that all entries are complete and correct.
:* Click on any of the '''Save''' buttons, then '''Close window''' to finalise the operation.

Unless you have '''auto accept changes''' set to '''Yes''' in your GEDCOM configuration, you will now need to accept these changes in PGV. Once that is complete ALL of the individuals added to area "4" will now have a CENS event much like the one shown at the start of this article.

File:Ca final.jpg

2010-02-16T23:51:34Z

Nigelo: uploaded a new version of "File:Ca final.jpg"

File:Area 5.jpg

2010-02-16T23:38:25Z

Nigelo:

File:Area 4.jpg

2010-02-16T23:14:25Z

Nigelo:

File:Assistant2.jpg

2010-02-16T22:46:55Z

Nigelo:

File:Area 3.jpg

2010-02-16T22:39:40Z

Nigelo:

File:Area 2.jpg

2010-02-16T22:32:05Z

Nigelo:

File:Area 1.jpg

2010-02-16T22:16:10Z

Nigelo:

File:Assistant.jpg

2010-02-16T22:04:47Z

Nigelo: uploaded a new version of "File:Assistant.jpg"

File:Cens1.jpg

2010-02-16T05:59:54Z

Nigelo:

File:Links3.jpg

2010-02-16T01:09:56Z

Nigelo:

File:Links2.jpg

2010-02-16T01:00:31Z

Nigelo:

File:Links1.jpg

2010-02-16T00:44:06Z

Nigelo:

Creating a Module

2009-10-15T22:17:30Z

Nigelo: /* /modules/your_module.php */

== Modules File Structure ==

modules (dir)
|
+--your_module (dir)
| |
| +--languages (dir)
| | +--ym_lang.en.php
| |
| +--images (dir)
| | +--icon.gif
| |
| +--your_module.php
| +--menu.php
| +--ym_privacy.php
| +--ym_functions.php
|
+--your_module.php

----

=== /modules/your_module.php ===
Copy the following code into your file and save it:

;<?php exit; ?>
[Module]
type = PGV_MOD_OO

As far as I can tell, this will tell PGV that your module is a PGV module.

----

=== /modules/your_module/menu.php ===
Replace instances of your_module with your module's name and ym with the initials for your module

<?php

//-- security check, only allow access from module.php. Include this code in each of your module files
if (strstr($_SERVER["SCRIPT_NAME"],"menu.php")) {
print "Now, why would you want to do that. You're not hacking are you?";
exit;
}

class your_module_ModuleMenu {
/**
* get the Your Module menu
* @return Menu the menu item
*/
function &getMenu() {
global $TEXT_DIRECTION, $PGV_IMAGE_DIR, $PGV_IMAGES, $GEDCOM, $pgv_lang;
global $PRIV_USER, $PRIV_PUBLIC;

include('ym_privacy.php');

if (!file_exists("modules/your_module.php")) return null;
if ($PRIV_USER<getUserAccessLevel()) return null;

if (!file_exists('modules/your_module/languages/ym_lang.en.php')) return null;

require_once 'modules/your_module/languages/ym_lang.en.php';
if ($TEXT_DIRECTION=="rtl") $ff="_rtl"; else $ff="";

//-- main menu item - this uses the icon as the Welcome Page menu
$menu = new Menu($pgv_lang["your_module"], "module.php?mod=your_module", "down");
if (!empty($PGV_IMAGES["gedcom"]["large"]))
$menu->addIcon($PGV_IMAGE_DIR."/".$PGV_IMAGES["gedcom"]["large"]);
$menu->addClass("menuitem$ff", "menuitem_hover$ff", "submenu$ff");

//'First Task' ddl menu item //this is the first sub menu option
if (getUserAccessLevel(getUserName())<= $SHOW_FIRST_OPTION)//set $SHOW_FIRST_OPTION is set in ym_privacy.php
{
$submenu= new Menu($pgv_lang["first_option"], "module.php?mod=your_module&action=firstop");
$submenu->addIcon('modules/your_module/images/icon.gif');
$submenu->addClass("submenuitem$ff", "submenuitem_hover$ff");
$menu->addSubmenu($submenu);
}
//Additional sub menu options can be added by repeating the code above

return $menu;
}
}
?>


[[Category:Developers Guide]]
[[Category:phpGedView]]

[[fr:Créer un module]]

Admin Menu

2008-12-16T23:05:17Z

Nigelo: /* Data and GEDCOM administration */

----
The Admin Menu is divided into four (4) categories.

==Title==

[[image:4_adminmenu_1.jpg|center|450px|thumb]]

The top section apart from providing a title indicates the current status of you configuration file. This file should not be write enabled for security reasons. [[Security of Config.php|Information on how this can be done can be found by following this link]].

==Informational==
[[image:4_adminmenu_2.jpg|center|450px|thumb]]
===README documentation===
Opens the README file provided with the version of phpGedView you are using.

::* [[Readme Version 4|README Documentation for Version 4]]

===Configuration help===
Will open all the help items for phpGedView in the current window.

===View Other sites using PhpGedView===
This menu item will take you to the phpGedVies web site where a list of sites using the software is available.

===PHP Information===
This wil provide you with information of the current status of PHP on your system.

===Version 4.0 Changes===
This option will open a document listing the changes of your current verion of phpGedView with previous versions.

==Data and GEDCOM administration==
[[image:4_adminmenu_3.jpg|450px|thumb|center]]

*'''Menu Items'''
**[[Manage GEDCOMs and edit privacy|Manage GEDCOMs and edit privacy]]
**[[Add an unlinked person|Add an unlinked person]]
**[[Add an unlinked source|Add an unlinked source]]
**[[Manage Media|Manage Media]] (This item is not displayed in PGV 4.1.6)
**[[Merge Records|Merge Records]]
** Cleanup Index Directory (PGV 4.1.6)
** Perform batch updates/edits on your GEDCOM (PGV 4.1.6)

Additional menu items will be displayed as they become appropriate
*'''Menu Items'''

**[[Accept / Reject Changes|Accept / Reject Changes]]

==Site administration==
[[image:4_adminmenu_4.jpg|centre|450px|thumb]]
*'''Menu Items'''
**[[Configuration|Configuration]]
**[[User Administration|User Administration]]
**[[FAQ List|FAQ List]]
**[[Configure supported Languages|Configure supported Languages]]
**[[Translator tools|Translator tools]]
**[[User Information Migration Tool|User Information Migration Tool]]
**[[Administrators Guide:Backup|Backup]]
**[[Add files and settings for a new language|Add files and settings for a new language]]
**[[View log files|View log files]]


[[Category:Administrators Guide]]
[[Category:phpGedView]]



[[en:Administration]]

File:4 adminmenu 3.jpg

2008-12-16T23:02:48Z

Nigelo: uploaded a new version of "Image:4 adminmenu 3.jpg"

File:Create-4.jpg

2007-07-29T21:30:43Z

Nigelo:

File:Create-3.jpg

2007-07-29T21:21:02Z

Nigelo:

File:Create-2.jpg

2007-07-29T21:11:53Z

Nigelo:

File:Create-1.jpg

2007-07-29T20:52:38Z

Nigelo:

File:OCCU FARM.gif

2007-02-25T23:15:02Z

Nigelo:

File:OCCU SERV.gif

2007-02-25T23:14:20Z

Nigelo: