Readme.txt
Révision datée du 5 décembre 2007 à 16:06 par Elliott1961 (discussion | contributions) (Nouvelle page : [phpgedview] / trunk / phpGedView / readme.txt (logo) View of /trunk/phpGedView/readme.txt Parent Directory Parent Directory | Revision Log Revision Log Revision 2091 - (download) (...)
[phpgedview] / trunk / phpGedView / readme.txt (logo) View of /trunk/phpGedView/readme.txt
Parent Directory Parent Directory | Revision Log Revision Log Revision 2091 - (download) (annotate) Tue Oct 30 16:19:34 2007 UTC (5 weeks ago) by yalnifj File size: 53404 byte(s)
setting svn:eol-style to native for the system being checked out on
1 ======================================================= 2 PhpGedView 3 4 Version 4.1 5 Copyright 2005 John Finlay and others 6 7 This and other information can be found online at 8 http://www.PhpGedView.net 9 10 The installation instructions can also be found in the wiki at: 11 http://wiki.phpgedview.net/en/index.php/Installation_Guide 12 13 # $Id$ 14 ======================================================= 15 16 CONTENTS 17 1. LICENSE 18 2. INTRODUCTION 19 3. SYSTEM REQUIREMENTS 20 4. QUICK INSTALL 21 5. INSTALLATION 22 6. UPGRADING 23 7. UPDATING GEDCOMS 24 8. THEMES 25 9. MULTIMEDIA OBJECTS 26 10. RSS FEED 27 11. DATABASE TABLE LAYOUT 28 12. MANUAL CONFIGURATION 29 13. SECURITY 30 14. LANGUAGES 31 15. NON-STANDARD GEDCOM CODES 32 16. LANGUAGE EXTENSION FILES 33 17. MIGRATING FROM SQL TO INDEX MODE AND VICE VERSA 34 18. POSTNUKE AND PHPNUKE INTEGRATION 35 19. BACKUP 36 37 ------------------------------------------------------- 38 LICENSE 39 40 PhpGedView: Genealogy Viewer 41 Copyright (C) 2002 to 2007 John Finlay and Others 42 43 This program is free software; you can redistribute it and/or modify 44 it under the terms of the GNU General Public License as published by 45 the Free Software Foundation; either version 2 of the License, or 46 (at your option) any later version. 47 48 This program is distributed in the hope that it will be useful, 49 but WITHOUT ANY WARRANTY; without even the implied warranty of 50 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 51 GNU General Public License for more details. 52 53 See the file GPL.txt included with this software for more 54 detailed licensing information. 55 56 ------------------------------------------------------- 57 INTRODUCTION 58 59 PhpGedView is a revolutionary genealogy program which allows you to view 60 and edit your genealogy on your website. PhpGedView has full editing 61 capabilities, full privacy functions, and supports multimedia like photos 62 and document images. PhpGedView also simplifies the process of 63 collaborating with others working on your family lines. Your latest 64 information is always on your web site and available for others to see. 65 For more information and to see working demos, visit 66 http://www.PhpGedView.net/ 67 68 PhpGedView is Open Source software that has been produced by people from 69 many countries freely donating their time and talents to the project. All 70 service, support, and future development is dependent on the time 71 developers are willing to donate to the project, often at the expense of 72 work, recreation, and family. Beyond the few donations received from 73 users, developers receive no compensation for the time they spend working 74 on the project. There is also no outside source of revenue to support the 75 project. 76 77 ------------------------------------------------------- 78 SYSTEM REQUIREMENTS 79 80 PhpGedView requires a web server with at least PHP v4.3 and around 20MB of 81 web space. The default installations of PHP on most servers should provide 82 you with all of the PHP functionality you should need. 83 84 Database 85 You will need at least 1 database and a username and password to access it. 86 PhpGedView primarily supports MySQL, but has also been tested and shown to 87 work with Postgresql, SQLite, and SQL-Server. The versions required for 88 each of these databases is outlined below: 89 MySQL 3.23+ 90 PostgresQL 8.0+ 91 SQLite available through PDO-SQLite which is included in PHP 5 92 MS SQL-Server 2003+ 93 94 Web space 95 At least 20MB of web space on the web server. You will need more than this 96 if you intend to store multimedia linked to individuals. 97 98 To use the reporting engine, PHP needs to be compiled with XML support. 99 This is compiled into PHP by default unless it is specifically disabled. 100 See http://us3.php.net/manual/en/ref.xml.php 101 102 Some features of PhpGedView require the GD library and that PHP be compiled 103 with GD support. Most precompiled versions of PHP include GD support. If 104 you are compiling PHP yourself you will need to configure it with the 105 --with-gd 106 option. See http://us3.php.net/manual/en/ref.image.php 107 108 The advanced calendar features of PhpGedView for converting Gregorian dates 109 to the Hebrew or Jewish calendars require that PHP be compiled with the 110 --enable-calendar 111 configuration option. See http://us2.php.net/manual/en/ref.calendar.php 112 for more information. 113 114 For GEDCOMs larger than 2MB, you will likely need to research different 115 hosting options and find one that will accept a request to modify the 116 default memory and time limits built into PHP. See the FAQ at 117 http://www.phpgedview.net/faq.php for more information about large GEDCOMs. 118 119 ------------------------------------------------------- 120 QUICK INSTALLATION 121 122 These instructions can also be found in the wiki at: 123 http://wiki.phpgedview.net/en/index.php/Installation_Guide 124 125 Follow the instructions in this section to install PhpGedView if you are 126 already familiar with the program or are familiar with installing other PHP 127 web applications. 128 129 1. Upload the files to your web server. 130 2. Set Write permissions on config.php and the "index" directory. For 131 optimal security, you should move the "index" directory to a location 132 where it is not accessible from the Internet. 133 3. Point your browser to the directory where you uploaded your PhpGedView 134 files (for example, http://www.yourserver.com/PhpGedView/). 135 4. Enter your configuration settings. If you moved the index directory, 136 be sure to specify the correct location to it on this page. Save the 137 configuration parameters. 138 5. Enter the default administrator user. 139 6. Login as this user and upload your GEDCOM file. 140 7. Save the GEDCOM configuration settings. 141 8. Import the GEDCOM. 142 143 Optional Steps 144 9. If you want to use the language editing features you will need to set 145 Write permissions for all of the files in the ./languages folder. 146 10. If you want to upload media files using the Upload Media section of 147 the Admin menu then you need to set Write permissions for your ./media 148 and ./media/thumbs directories. 149 11. If you want to edit your GEDCOM file online, the GEDCOM file must have 150 Write permissions set for the PHP user. 151 12. If you want to use the Backup feature of the Upgrade utility in 152 PhpGedView you will need to either set Write permission on the 153 PhpGedView folder itself or create a folder named "backup" with Write 154 permissions. Write permissions for the PhpGedView folder can be 155 removed as soon as the backup folder is in place and has the 156 appropriate permissions. 157 13. For security you should set the permissions back to Read-only when you 158 are done editing or uploading files. 159 160 ------------------------------------------------------- 161 INSTALLATION 162 163 These instructions can also be found in the wiki at: 164 http://wiki.phpgedview.net/en/index.php/Installation_Guide 165 166 Follow these instructions if you are not familiar with PhpGedView or 167 installing PHP applications. 168 169 *A. Upload Program Files: 170 To install PhpGedView, unzip the compressed package and upload the files to 171 a directory on your web server. If you have limited space on your server, 172 you can save space in the following ways: 173 1. Delete the themes from the themes folder that you do not plan to use. 174 2. Delete some of the language files that you do not want. English files 175 are named configure_help.en.php, countries.en.php, facts.en.php, 176 help_text.en.php and lang.en.php. French files, for example, are named 177 with ".fr." in place of ".en.". Hebrew files use ".he." in place of 178 ".en.", and so on. 179 The English language files cannot be deleted. They are always loaded 180 before the files for the selected language are loaded. This ensures 181 that all language variables are defined, and that the English version 182 will be used when a given variable is missing in the new language. 183 3. Do not upload the "places" folder. This folder contains maps for some 184 countries. It also contains text files containing state, county, and 185 place names. Its purpose is to allow you to enter place names by 186 picking them from lists. 187 188 For optimal security, you may want to move the "index" directory to a 189 different location outside of your Internet accessible space. You will 190 specify the location of this directory during the online configuration. 191 See the SECURITY section for more information. 192 193 *B. Required File Permissions: 194 PhpGedView requires that Read permissions be set for all files in the 195 PhpGedView directory tree. Some hosts also require Execute permissions 196 (chmod 755). PhpGedView requires full Write permissions on the index 197 directory (chmod 777 under most hosting configurations). PhpGedView also 198 requires that Write permissions (chmod 777) be set temporarily for the 199 config.php file. 200 201 To help with the setting of permissions a file called setpermissions.php 202 has been included with the project. This file will attempt to set 777 203 permissions to the config.php, ./index, and all of the files inside the 204 ./index directory. Because host settings vary on the ability of PHP 205 programs to set file permissions, you have to run this file manually. 206 207 If at any time you have trouble during configuration, check your 208 permissions again. 209 210 There are some advanced features that require more Write permissions to be 211 set. If you want to use the language editing features you will need to set 212 Write permissions for all of the files in the ./languages folder (chmod 213 777). If you want to upload media files using the Upload Media section of 214 the Admin menu then you need to set Write permissions (chmod 777) for your 215 ./media and ./media/thumbs directories. If you want to edit your GEDCOM 216 file online, the GEDCOM file must have Write permissions set to the PHP 217 user (chmod 777). 218 219 *C. Configuration: 220 Next point your web browser to the PhpGedView folder 221 (for example, http://www.yourserver.com/PhpGedView/) to automatically 222 begin the online configuration process. Information about each of the 223 configuration options can be found online by clicking on the question mark 224 (?) near each label. 225 226 PhpGedView has support for importing your GEDCOMs into a PEAR:DB supported 227 database like MySQL or PostgreSQL. Currently, MySQL is the only fully tested 228 database. Using a database requires that an existing user, password, and 229 database already exist. 230 231 You may reconfigure PhpGedView at any time by going to PhpGedView/admin.php 232 and logging in as an administrator user and clicking on the "Configuration" 233 link. 234 235 If you are having any problems setting up PhpGedView then you should run the 236 sanity_check file. To do this you should type sanity_check.php into your URL 237 (for example, http://www.yourserver.com/PhpGedView/sanity_check.php). If you are 238 not able to view that page then you most likely don't have either the sanity_check 239 file or you do not have PHP installed properly. 240 241 *D. Create Admin User 242 After you click the Save button, you will be asked to create an 243 administrator user and login as this user. Then click on the link labelled 244 "Click here to continue" where you will be taken to the "Manage GEDCOMs" 245 area. In the "Manage GEDCOMs" area you can add GEDCOMs to your site, edit 246 the GEDCOM configuration, edit Privacy settings, and import the GEDCOM into 247 the data store. 248 249 *E. Add GEDCOM file 250 To add GEDCOM files to the system, you can upload your GEDCOM file using 251 the "Upload GEDCOM" option from the Admin menu. All files uploaded using 252 the "Upload GEDCOM" page are saved in your index directory. You can also 253 upload your GEDCOM manually using FTP or any other file upload method. 254 Most hosts limit the size of files that can be uploaded from a web form for 255 security reasons, so you may be forced to use a manual method. You may 256 also upload your GEDCOM in ZIP format, either manually or using the 257 "Upload GEDCOM" option. Make sure to enter the filename of the ZIP file. 258 PhpGedView will automatically unpack the ZIP file and use the GEDCOM file 259 inside it. Be sure to create the ZIP file to contain only one GEDCOM file. 260 261 *F. Set GEDCOM Configuration Settings 262 After uploading your GEDCOM, you will be asked to set the configuration 263 parameters for it. There are too many parameters to list all of their 264 options in this document. Please use the online Help documentation to 265 guide you through the configuration process. 266 267 *G. Validate GEDCOM 268 After you save the GEDCOM configuration PhpGedView will validate your 269 GEDCOM and automatically fix any errors that it can. If any errors found 270 in the GEDCOM require user input, you will be prompted to choose how to 271 proceed. Again use the online Help ? for more information. 272 273 *H. Import GEDCOM 274 You are almost done. This is the final step before you can begin viewing 275 your data. After validating the GEDCOM and fixing any errors, you will 276 need to import the GEDCOM into the data store. During the Import you will 277 see a lot of processing statistics printed on the screen. If the Import 278 completed successfully you will see a blue "Import Complete" message. 279 Everything is now set up and you can begin using PhpGedView with your 280 GEDCOM. 281 282 *I. Deleting GEDCOMs 283 You may delete GEDCOMs from your site from the "Manage GEDCOMs" area. 284 Deleting a GEDCOM from the site will remove it from the database but will 285 not delete the original GEDCOM file that you imported. It will also not 286 delete any of the cache or privacy files related to this GEDCOM. These 287 retained files, which are no longer required by PhpGedView, are all located 288 in the "index" directory. 289 290 *J. Reset config.php Permissions 291 For security you should set the permissions of config.php back to Read-only 292 (chmod 755) when you have finished configuring for the first time. Write 293 permissions will only need to be set for config.php when you use the 294 Admin->Configuration link. Everything else will be stored in the index 295 directory. 296 297 *K. Custom Themes 298 You can customize the look and feel of PhpGedView by modifying one of the 299 provided themes. See the THEMES section of this readme file for more 300 information. 301 302 *L. HTTP Compression 303 Pages generated by PhpGedView can be large and use up a lot of bandwidth. 304 Compression of the data between the server and browser using GZip 305 compression can compress the bandwidth by up to 90% (usually 80% - 90% for 306 PhpGedView that were tested). Add the following 2 lines to your php.ini file: 307 zlib.output_compression On 308 zlib.output_compression_level 5 309 310 If you have no access to the php.ini file and you are using Apache, create a 311 blank file named .htaccess (including the dot) and add the following lines to 312 that file (or add them to an existing .htaccess file and upload the file to 313 your PhpGedView directory. 314 php_flag zlib.output_compression On 315 php_value zlib.output_compression_level 5 316 317 Some hosts do not allow adding this through .htaccess files, but they may 318 allow you to create a partial php.ini file in your phpGedView directory. To 319 this file you would add the same two lines from the php.ini file above: 320 zlib.output_compression On 321 zlib.output_compression_level 5 322 323 Note: If your host is using mod_gzip or an other compression method, using 324 this technique can cause problems. Compression will have no effect on 325 browsers that do not support it. You can test the compression at 326 http://leknor.com/code/gziped.php 327 328 If you need help or support visit http://www.PhpGedView.net/support.php 329 330 ------------------------------------------------------- 331 UPGRADING 332 333 UPGRADING 4.1 to 4.1.x 334 335 1. To upgrade from 4.1 to 4.1.1 or any other 4.1.x version, simply replace 336 the files on the server with the new files. 337 2. Some of the internal structures have changed, so you should also delete 338 your cache files. This can be done from the "Customize Welcome Page" link 339 or by manually deleting the files from the "index" directory. 340 341 342 UPGRADING 4.0.x to 4.1.x 343 344 Use the following steps to upgrade to v4.1. These steps assume that you 345 are familiar with PhpGedView and have successfully installed it before. 346 347 Version 4.x no longer includes support for index files. If you do not have 348 PHP 5 with built-in SQLite support or a database account then you should not 349 upgrade to PhpGedView 4.x. Maintenance releases will continue for the 3.3.x 350 version. 351 352 **Note to SQLite users: Unfortunately SQLite does not support the ALTER TABLE 353 SQL command. This means that we must first drop the tables and recrate 354 them. It is highly reccomended that you run the backup before upgrading. 355 356 1. Upload the new 4.1 files to your server replacing the old files with the 357 new files. Do not replace the config.php file or the index directory. 358 2. In order to create the data required for the new version, you will 359 have to re-import your GEDCOM. Please see the section on UPDATING 360 GEDCOMS below. 361 3. You can now use your upgraded site. 362 4. If you are using a customized theme you will need to update your theme 363 with new stylesheets and variables. An excellent tool that can help 364 you to merge themes is the WinMerge project 365 http://winmerge.sourceforge.net/ 366 367 ------------------------------------------------------- 368 UPDATING GEDCOMS 369 370 When you change your genealogy data outside of PhpGedView, it is not 371 necessary to delete your GEDCOMs from PhpGedView and start over. Follow 372 these steps to update a GEDCOM that has already been imported: 373 374 1. The first step is to replace your old GEDCOM on the site with your new 375 GEDCOM. You can do this using FTP, or by going to the "Upload GEDCOM" 376 page and uploading a new GEDCOM with the same filename as the old one. 377 Please remember that file names are case sensitive. 378 2. Re-import the GEDCOM file by going to 379 Admin->Manage GEDCOMs->Import GEDCOM. The GEDCOM will be validated 380 again before importing. 381 3. The Import script will detect that the GEDCOM has already been imported 382 and will ask if you want to replace the old data. Click the "Yes" 383 button. 384 4. You will again see the Import statistics and the Import Complete 385 message at the bottom of the page when the Import is complete. 386 387 If you use a ZIP file to upload the GEDCOM, the only way to do it is by 388 either using the "Upload GEDCOM" option, or the "Add GEDCOM" option. The 389 GEDCOM file in the zipped file has to have exactly the same name as the 390 already existing GEDCOM. This way existing GEDCOM settings will be 391 preserved. 392 393 ------------------------------------------------------- 394 THEMES 395 396 PhpGedView uses a theme based architecture allowing you to have greater 397 flexibility over the appearance of the site. The "themes" directory 398 contains the standard themes that come packaged with PhpGedView. You may 399 customize any of these themes to your liking or create your own theme by 400 copying any of the standard themes to a new folder and modifying it. When 401 you configure PhpGedView, you should tell it to look in your new theme 402 directory. 403 404 A theme directory must contain at least the following 6 files: 405 footer.html # PHP/HTML for the bottom of every page 406 header.html # PHP/HTML for the top of every page 407 print_footer.html # PHP/HTML for the bottom of every print preview page 408 print_header.html # PHP/HTML for the top of every print preview page 409 style.css # A CSS stylesheet containing all styles 410 sublinks.html # PHP/HTML to print the links to other places 411 theme.php # The PHP design variables that you may customize 412 toplinks.html # PHP/HTML that appears just below the header.html 413 414 For a guide to building your own custom PhpGedView theme, go to: 415 http://www.PhpGedView.net/styleguide.php 416 417 If you really like a theme that you have done and would like it included 418 with the project, you should send your theme files to the developers at 419 yalnifj@users.sourceforge.net. 420 421 ------------------------------------------------------- 422 MULTIMEDIA OBJECTS 423 424 The GEDCOM 5.5 standard supports multimedia files of all types. Currently 425 PhpGedView supports multimedia objects only as external files. Multimedia 426 embedded in the GEDCOM file itself will be ignored. To use the multimedia 427 support in PhpGedView you must copy the multimedia files external to your 428 GEDCOM to the "media" directory in the folder where you installed 429 PhpGedView. 430 431 In choosing which picture to show on charts, PhpGedView will choose the 432 first one with the _PRIM Y marker. If there are no _PRIM tags in your 433 media object records then the first object found will be used. You can 434 disable all photos on charts for a particular person by setting _PRIM N on 435 all media objects. Most genealogy programs will do this for you 436 automatically. 437 438 You can find all of the images referenced in your file by opening your 439 GEDCOM in a text editor and looking for the OBJE or FILE tags. 440 441 PhpGedView includes a "media/thumbs" directory where you can place 442 thumbnails of your media files for display in lists and on other pages. 443 PhpGedView allows you to create your own thumbnails so that you can 444 maintain artistic control over your media and to avoid the installation of 445 other server side software. Make a copy your images and reduce them to an 446 appropriate thumbnail size somewhere around 100px width and upload them to 447 the "media/thumbs" directory. Keep the filename the same as the original. 448 Thumbnails can be created for non-image media files as well. To do this 449 create a thumbnail image in either gif, jpeg, png or bmp formats and name 450 them the same name as the media file including the file extension (even if 451 the media is a non image such as a PDF or an AVI file, name the thumbnail 452 IMAGE with the PDF or AVI file extension). 453 454 There is an Image module that fully integrates with PGV and that will 455 automatically create thumbnails for you if you use it to upload your files. 456 It is not included with the main PhpGedView files because it requires 457 external libraries that not all hosts will have installed. You should be 458 able to get it to work by following the instructions included with it. 459 You can download the ImageModule from: 460 http://sourceforge.net/project/showfiles.php?group_id=55456&package_id=88140 461 462 You can configure PhpGedView to recognize subdirectories in your media 463 folder. The subdirectories must be the same names as the subdirectories in 464 your media file paths pointed to in your GEDCOM file. For example, if you 465 have the following media references in your GEDCOM file: 466 C:\Pictures\Genealogy\photo.jpg 467 C:\Pictures\Scans\scan1.jpg 468 scan2.jpg 469 470 With the media depth set to 1 you need to set up your directory structure 471 like this: 472 media/Genealogy/photo.jpg 473 media/Scans/scan1.jpg 474 media/scan2.jpg 475 media/thumbs/Genealogy/photo.jpg 476 media/thumbs/Scans/scan1.jpg 477 media/thumbs/scan2.jpg 478 479 With the media depth set to 2 you need to set up your directory structure 480 like this: 481 media/Pictures/Genealogy/photo.jpg 482 media/Pictures/Scans/scan1.jpg 483 media/scan2.jpg 484 media/thumbs/Pictures/Genealogy/photo.jpg 485 media/thumbs/Pictures/Scans/scan1.jpg 486 media/thumbs/scan2.jpg 487 488 ------------------------------------------------------- 489 RSS FEED 490 491 PGV now includes an RSS feed. RSS is an XML format that allows other sites 492 to get news and other data from your site. The language used is the 493 default language of the site. The language of the feed can be set to any 494 language supported by PGV by changing the URL that your RSS aggregator uses 495 from the default /phpGedView/rss.php to /phpGedView/rss.php?lang=english 496 (or any language supported by PGV such as rss.php?lang=french). 497 498 Currently only the default site GEDCOM is supported for the feed info. 499 Other options available in the RSS feed are the ability to specify the feed 500 type via the rssStyle parameter. The PGV default is "RSS1.0". Passing any 501 supported type including "PIE0.1", "mbox","RSS0.91", "RSS1.0", "RSS2.0", 502 "OPML", "ATOM0.3", "HTML", "JS" will change the feed type. 503 504 For example, calling /phpGedView/rss.php?rssStyle=HTML will create HTML 505 output suitable for inclusion in an other page via an iFrame. The JS 506 option will output JavaScript that can be included in an other page without 507 using an iFrame. 508 509 You can also specify a module that you want to output (only 1) so that only 510 that module will be output. This is done via the module parameter. For 511 example, /phpGedView/rss.php?module=gedcomStats will only output the GEDCOM 512 Stats block. 513 514 These parameters can be chained so that 515 /phpGedView/rss.php?lang=hebrew&module=gedcomStats&rssStyle=HTML 516 will output the GEDCOM Stats module in Hebrew in HTML. 517 518 519 ------------------------------------------------------- 520 DATABASE TABLE LAYOUT 521 522 PhpGedView uses a very simple database table layout because it operates 523 primarily on the GEDCOM data and only needs the database for search and 524 retrieval. There are only a few tables in the database: 525 pgv_blocks # Description of each user's Portal page 526 pgv_dates # Stores decoded date information from GEDCOM records 527 pgv_families # All the families in the GEDCOM 528 pgv_favorites # Stores users favorites 529 pgv_individuals # All the individuals in the GEDCOM 530 pgv_messages # Messages to and from users 531 pgv_names # Stores decoded name information from GEDCOM records 532 pgv_news # Stores news items for the Index and Portal pages 533 pgv_other # All other level 0 GEDCOM records (i.e., repositories, 534 # media objects, notes, etc.) 535 pgv_placelinks # Cross-reference between places and individuals and 536 # families 537 pgv_places # Place hierarchy 538 pgv_sources # All the sources in the GEDCOM 539 pgv_users # Table for user data (only exists if using default 540 # mysql authentication module) 541 542 543 The tables are all very similar. They each have a field for the GEDCOM ID, 544 a field to tell which GEDCOM file the record was imported from, a few 545 fields for things like quick retrieval of name information, and a field for 546 the raw GEDCOM record data. 547 548 Following is a more detailed description of each table: 549 pgv_individuals: 550 i_id VARCHAR(255) # GEDCOM individual ID 551 i_file INT # ID number of the GEDCOM file the record is from 552 i_rin VARCHAR(30) # Individual's RIN number 553 i_name VARCHAR(255) # Person's primary name taken from the first 554 # 1 NAME line stored in GEDCOM name format 555 i_isdead int(1) # Alive/dead status of individual 556 # -1 = not calculated yet 0 = alive 1 = dead 557 i_GEDCOM TEXT # Raw GEDCOM record for this individual 558 i_letter VARCHAR(5) # First letter of the individual's surname 559 i_surname VARCHAR(100) # Person's surname 560 561 pgv_families: 562 f_id VARCHAR(255) # GEDCOM family ID 563 f_file INT # ID number of the GEDCOM file the record is from 564 f_husb VARCHAR(255) # ID of the husband 565 f_wife VARCHAR(255) # ID of the wife 566 f_chil TEXT # List of children IDs, semi-colon (;) delimited 567 f_GEDCOM TEXT # Raw GEDCOM record for this family 568 f_numchil INT # Number of children in this family 569 570 pgv_sources: 571 s_id VARCHAR(255) # GEDCOM source ID 572 s_file INT # ID number of the GEDCOM file the record is from 573 s_name VARCHAR(255) # Abbreviated title of the source 574 s_GEDCOM TEXT # Raw GEDCOM record for this source 575 576 pgv_other: 577 o_id VARCHAR(255) # GEDCOM record ID 578 o_file INT # ID number of the GEDCOM file the record is from 579 o_type VARCHAR(20) # Type of GEDCOM record 580 # (REPO, ADDR, NOTE, OBJE, etc) 581 o_GEDCOM TEXT # Raw GEDCOM record for this item 582 583 pgv_names: 584 n_gid VARCHAR(255) # Individual ID that this name corresponds to 585 n_file INT # ID number of the GEDCOM file the record is from 586 n_name VARCHAR(255) # Name in GEDCOM format, 587 # with / / around the surname 588 n_letter VARCHAR(5) # First letter of the surname 589 n_surname VARCHAR(100) # Surname for this name record 590 n_type VARCHAR(10) # Type of name, 591 # P = primary, A = additional, C=calculated 592 593 pgv_dates: 594 d_day # The day of month for this date 595 d_month # The 3 letter abbreviation for month of year 596 d_mon # Integer 1-12 for the month of year 597 d_year # The year for this date 598 d_datestamp # This column is no longer used and will be deleted in 4.2 599 d_fact # The fact that this date was associated with 600 d_gid # The gedcom XREF ID where this fact and date were found 601 d_file # The gedcom file id where this fact was found 602 d_type # Used if this date uses an alternate calendar type 603 d_julianday1 # The julian day number for this day (or start of this month/year) 604 d_julianday2 # The julian day number for this day (or end of this month/year) 605 606 pgv_blocks: 607 b_id INT(11) # Record ID 608 b_username # User name whom block belongs to 609 VARCHAR(100)# 610 b_location VARCHAR(30) # Location of the block. 611 # Main column or right column 612 b_order INT(11) # Position of the block within the column 613 b_name VARCHAR(255) # Name of the block 614 b_config TEXT # Configuration settings for this block 615 616 pgv_favorites: 617 fv_id INT(11) # Record ID 618 fv_username # User name whom the favorite belongs to 619 VARCHAR(30) # 620 fv_gid VARCHAR(10) # ID of the favorite 621 fv_type VARCHAR(10) # Type of favorite (currently only INDI) 622 fv_file VARCHAR(100) # File that this favorite belongs to 623 fv_url VARCHAR(255) # The URL for this favorite if it is not one of 624 # the basic types 625 fv_title VARCHAR(255) # A title for URL based favorites 626 fv_note TEXT # Optional descriptive information about this favorite 627 628 pgv_messages: 629 m_id INT(11) # Record ID 630 m_from VARCHAR(255) # Name or email address of the sender 631 m_to VARCHAR(30) # Destination user name 632 m_subject VARCHAR(255) # Subject of the message 633 m_body TEXT # Body text of the message 634 m_created VARCHAR(255) # Time stamp when the message was created 635 636 pgv_news: 637 n_id INT(11) # Unique identifier 638 n_username VARCHAR(100)# User name or GEDCOM the News item belongs to 639 n_date INT(11) # Time stamp of last update 640 n_title VARCHAR(255) # Title of the article 641 n_text TEXT # Body text of the article 642 643 pgv_places: 644 p_id INT(11) # Unique identifier 645 p_place VARCHAR(150) # Place name 646 p_level INT(11) # Level of the place in the hierarchy, 647 # 0 is the country or state 648 p_parent_id INT(11) # ID of this item's parent place in the 649 # hierarchy. A city's parent would be the 650 # county it is in, a county's parent would be 651 # a state or province, and a state or province 652 # would have a country as parent. 653 p_file INT # ID number of the GEDCOM file the record is from 654 p_std_soundex # Standard soundex code for searching by place. 655 VARCHAR(255) # 656 p_dm_soundex # Daitch-Mokotoff soundex code for searching by 657 VARCHAR(255) # place. 658 659 pgv_placelinks: 660 pl_p_id INT(11) # Unique identifier 661 pl_gid VARCHAR(30) # Family or individual ID referencing this place 662 pl_file INT # ID number of the GEDCOM file the record is from 663 664 pgv_soundex: 665 sx_i_id VARCHAR(255) # Unique identifier (Individuals table) 666 sx_n_id VARCHAR(255) # Unique identifier (Names table) 667 sx_file INT # Unique identifier (GEDCOM file) 668 sx_fn_std_soundex # Standard first name soundex code. Used for 669 VARCHAR(255) # soundex searching. 670 sx_fn_dm_soundex # Soundex code for international first names. 671 VARCHAR(255) # This uses the Daitch-Mokotoff soundex method, 672 # which is better suited for them. 673 sx_ln_std_soundex # Standard last name soundex code. Used for 674 VARCHAR(255) # soundex searching. 675 sx_ln_dm_soundex # Soundex code for international last names. This 676 VARCHAR(255) # uses the Daitch-Mokotoff soundex method, which 677 # is better suited for them. 678 679 pgv_users: 680 u_username VARCHAR(30) # User name 681 u_password VARCHAR(255) # Encrypted password 682 u_fullname VARCHAR(255) # User's full name 683 u_GEDCOMid TEXT # Serialized array representing the GEDCOM IDs 684 # for this user 685 u_rootid TEXT # Serialized array representing the root IDs 686 # for this user 687 u_canadmin ENUM('Y','N') # Is the user an admin or not 688 u_canedit TEXT # Serialized array indicating the editing 689 # privileges a user has for each GEDCOM 690 u_email TEXT # Email addres 691 u_verified VARCHAR(20) # User self verified 692 u_verified_by_admin VARCHAR(20) # User has been verified by the admin 693 u_language VARCHAR(50) # User's preferred language 694 u_pwrequested VARCHAR(20) # User requested a new password 695 u_reg_timestamp VARCHAR(50) # Registration timestamp 696 u_reg_hashcode VARCHAR(255) # Self-registration hash key 697 u_theme VARCHAR(50) # User's preferred theme 698 u_loggedin ENUM('Y','N') # User's login status 699 u_sessiontime INT(14) # User's last login time stamp 700 u_contactmethod VARCHAR(20) # User's preferred method of contact 701 u_visibleonline ENUM('Y','N') # Whether or not the user is visible in 702 # the logged on users block 703 u_editaccount ENUM('Y', 'N') # Whether or not the user can edit his 704 # own account information 705 u_defaulttab INT(10) # Default tab on the individual page 706 # for this user 707 u_comment VARCHAR(255) # Admin's comments on this user 708 u_comment_exp VARCHAR(20) # Alert date for the admin, for instance 709 # for temporary accounts. 710 u_sync_gedcom VARCHAR(2) # If the user has a GEDCOM record ID, then 711 # should some of the data for the user (name, 712 # email) be synchronized with the GEDCOM data. 713 u_relationship_privacy VARCHAR(2) # Should this user use relationship privacy 714 u_max_relation_length INT # The maximum path that the user is allowed to see 715 u_auto_accept VARCHAR(2) # Are changes made by this user automatically 716 # accepted into the database 717 718 This table layout has received criticism from some for its simplicity, 719 size, and because it does not follow a genealogy model like GENTECH. 720 We admit that these tables can be hard to interface to because the code has 721 to understand GEDCOM in order to get information out of them. We also 722 admit that storing the raw GEDCOM data could make the tables very large. 723 724 Fortunately the GEDCOM standard is not a very complex or large format; it 725 only requires 6 characters per line, which is very good compared to 726 something like XML. However, there are some very compelling reasons why 727 this table structure was chosen: 728 1. Simpler tables mean fewer and simpler database queries. This takes a 729 large load off the database and makes the program run faster. 730 2. Nothing is lost in the Import. Even though GEDCOM is a standard, each 731 genealogy program interprets the standard a bit differently and adds 732 its own tags. Creating a database model that conforms to all the 733 GEDCOM outputs of different genealogy software programs would be very 734 difficult. 735 736 ------------------------------------------------------- 737 MANUAL CONFIGURATION 738 739 Advanced users who understand PHP may want to configure manually by editing 740 the configuration file config.php When you have finished editing 741 config.php make sure that the variable $CONFIGURED=true; so that the 742 program does not try to forward you to the configuration.php script when 743 you launch it for the first time. 744 745 You can manually add GEDCOMS to the system by adding them to the $GEDCOMS 746 array in the index/GEDCOMs.php file. The GEDCOM array looks like this: 747 $gedarray = array(); 748 $gedarray["GEDCOM"] = "surname.ged"; 749 $gedarray["config"] = "./index/surname.ged_conf.php"; 750 $gedarray["privacy"] = "./index/surname.ged_priv.php"; 751 $gedarray["title"] = "Surname Genealogy"; 752 $gedarray["path"] = "./surname.ged"; 753 $GEDCOMS["surname.ged"] = $gedarray; 754 "surname" above could be anything, for example, "johnson" or "private". 755 You must pay attention to the case of what you enter. PhpGedView is case 756 sensitive. 757 758 Each GEDCOM will need a configuration file. You can copy the 759 config_GEDCOM.php file which has all of the default values for each GEDCOM 760 you add manually. Then set the "config" item of the GEDCOMS array to point 761 to the file you copied. 762 763 Each GEDCOM also needs a Privacy file. Make a copy the privacy.php file 764 for each GEDCOM and set the "privacy" item of the GEDCOMS array to the 765 location of the new privacy.php file. 766 767 ------------------------------------------------------- 768 SECURITY 769 770 Even though PhpGedView gives you the ability to hide the details of living 771 individuals, whenever you post the personal details of living individuals 772 on the Internet, you should first obtain the permission of EACH living 773 person you plan to include. There are many people who would not even want 774 their name linked with their family history made public on the Internet and 775 their wishes should be respected and honored. Most family history programs 776 allow you to choose the people who are exported when you create your GEDCOM 777 file. The most secure option is to deselect all living people in your 778 genealogy program when you export your genealogical data to a GEDCOM file. 779 780 If you wish to protect your GEDCOM file itself from being downloaded over 781 the Internet you should place it outside the root directory of your web 782 server or virtual host and set the value of the $GEDCOM variable to point 783 to that location. For example, if your home directory is something like 784 "/home/username" and if the root directory for your web site is 785 "/home/username/public_html" and you have installed PhpGedView in the 786 "public_html/PhpGedView" directory then you would place your GEDCOM file in 787 your home directory at the same level as your "public_html" directory. You 788 would then set the file path to "/home/username/GEDCOM.ged" by editing the 789 GEDCOM configuration. 790 791 You can also manually set the location by changing the "path" line in 792 index/GEDCOMs.php: 793 $gedarray["path"] = "../../GEDCOM.ged"; 794 or 795 $gedarray["path"] = "/home/username/GEDCOM.ged"; 796 797 Since your GEDCOM file resides in a directory outside of your web server's 798 root directory, your web server will not be able to fullfill requests to 799 download it. However, PhpGedView will still be able to read and display 800 its contents. 801 802 In the end it is YOUR responsibility to guarantee that there has been no 803 violation of an individual's privacy and YOU could be held liable should 804 private information be made public on the web sites that you administer. 805 806 For more privacy options visit: 807 http://www.PhpGedView.net/privacy.php 808 809 ------------------------------------------------------- 810 LANGUAGES 811 812 PhpGedView has built-in support for multiple languages. PHP does not 813 support unicode (UTF-16). It does support UTF-8 and that is the 814 recommended character encoding for GEDCOMs with PhpGedView. If you have 815 characters in your GEDCOM outside the standard ASCII alphabet, you should 816 probably use the UTF-8 encoding. There are many differences between UTF-8 817 and UTF-16, but anything that you can encode in UTF-16 you should be able 818 to encode in UTF-8. It is also quite easy to convert from Unicode to 819 UTF-8. Simply open your Unicode GEDCOM file in Windows Notepad and select 820 "File->Save As.." from the menu and choose UTF-8 as the encoding option. 821 You shouldn't lose any of the characters in the translation. 822 823 You should check the Patches section of 824 http://sourceforge.net/projects/PhpGedView to get the latest language 825 files. 826 827 Discussion and questions about the multiple language features of PhpGedView 828 including translations, should be posted in the Translations forum 829 available from the PhpGedView project page here: 830 http://sourceforge.net/forum/forum.php?forum_id=294245 831 832 To translate PhpGedView into another language that is not currently 833 supported you must first login to PhpGedView as an administrator and go to 834 the Language Edit Utility by clicking on "Admin-> Translator Tools". At 835 the bottom of that page is an option to Add a new language. Choose your l 836 anguage from the dropdown list and click on the "Add new Language" button. 837 A popup window will appear that allows you to edit the default settings for 838 your language. Each of the settings has online help available by clicking 839 on the "?". You might want to look at the settings for some of the other 840 languages on the edit language page to see how they are set up. When you 841 have finished editing the settings, click the Save button. This will 842 create a new lang_settings.php file in the index directory. You will 843 notice that your language now appears in the supported languages list. 844 845 Next create a copy of the "configure_help.en.php", "facts.en.php", 846 "help_text.en.php", and "lang.en.php" files located in the "./languages/" 847 and change the "en" part to match the two letter language code of your 848 language. 849 850 The "facts" file contains all of the translations for the various GEDCOM 851 tags such as BIRT = Birth. The "lang" file contains all of the language 852 variables used throughout the site. The "configure_help.en.php" and 853 "help_text.en.php" provide configuration and help instructions. 854 855 You can translate these files using the online Language File Edit utility. 856 Just select your language from the drop-down list and then select the file 857 you want to edit and click the Edit button. Your file will be compared to 858 the English language file so that you can easily translate the files 859 online. 860 861 You can also translate these files manually by opening them in any text 862 editor. If you manually edit the files, you must be sure to save them in 863 the UTF-8 character set. Some text editors like Windows Notepad add a 864 3-byte Byte-Order-Mark (BOM) to files they save in UTF-8. PHP does not 865 like the BOM and it should be removed before testing the files in 866 PhpGedView. PhpGedView's Translator Tools section has a utility program 867 for removing these BOMs. 868 869 You should obtain a flag file from http://w3f.com/gifs/index.html and size 870 it to match the other flags in the images/flags directory. 871 872 To help maintain languages, a language change log is provided in the 873 languages directory. This change log is named LANG_CHANGELOG.txt. All 874 changes to the English language files are recorded here. 875 876 If you make a new translation of PhpGedView or update another translation, 877 and would like to contribute it to the community please post your language 878 files and your index/lang_settings.php file to the Patches section of the 879 SourceForge project site at http://www.sourceforge.net/projects/phpgedview 880 881 ------------------------------------------------------- 882 NON-STANDARD GEDCOM CODES 883 884 The GEDCOM 5.5 standard has a defined set of codes. You can read the 885 specification online at http://www.PhpGedView.net/ged551-5.pdf Part of the 886 standard allows for genealogy software to define their own codes, and 887 requests that they begin with an "_" underscore. 888 889 When PhpGedView comes across a tag that is not defined it will display an 890 error message. You can disable these error messages by setting 891 $HIDE_GEDCOM_ERRORS=true; in the gedcom configuration settings. PhpGedView can also be 892 customized to work with these codes by adding them to the facts array in a 893 new language file named extra.en.php. If you add it to the English 894 facts file you should also add it to the other facts language files you are 895 using on your site if you want other languages to translate the tag 896 correctly. 897 898 The format of the facts file is a PHP associative array. Each tag requires 899 one line in the array. The following line defines the label "Abbreviation" 900 for the ABBR GEDCOM tag. 901 $factarray["ABBR"] = "Abbreviation"; 902 903 As an example, if you use a genealogy program that generates the tag 904 "_ZZZZ" you can customize PhpGedView to accept this code by adding the 905 following lines to the extra.en.php file: 906 <?php 907 $factarray["_ZZZZ"] = "Tag Label goes here"; 908 ?> 909 910 ------------------------------------------------------- 911 LANGUAGE EXTENSION FILES 912 913 Language extension files are custom PHP files that you can use to make your 914 own language specific extensions to PhpGedView. To add a language file 915 extension, create a new PHP file called extra.xx.php replacing the 916 "xx" with the code for the language you want to extend. These files are 917 not automatically included with the package so that when you upgrade, your 918 extensions are not overwritten. 919 920 If this file exists for the language that is chosen, it is the very last 921 thing that is loaded before the display starts. These files were designed 922 to be language file extensions, but you could easily use them to make 923 settings changes based on the chosen language. 924 925 What sort of things can you do with language extensions? 926 - Customize any of the text that appears on the site, 927 - Change configuration options based on language, 928 - Change to a different GEDCOM when someone views your site in a different 929 language. 930 931 The only settings that you should not override in this file are the Privacy 932 settings. 933 934 If, for example, you wanted to change the GEDCOM title when you changed the 935 language, you could change the title for each language by adding the 936 following line to your extra.xx.php: 937 global $GEDCOMS; 938 $GEDCOMS["surname.ged"]["title"] = "Title in Chinese"; 939 940 In this file you could also change the text on the buttons: 941 $pgv_lang["view"]="Show"; 942 943 With this file you could also change the GEDCOM that is displayed when the 944 language is selected. Suppose you had a GEDCOM that was in German and one 945 that was in English. In the extra.de.php file you could add the 946 following lines: 947 global $GEDCOM; 948 if ($GEDCOM=="english.ged") { 949 header("Location: $SCRIPT_NAME?$QUERY_STRING&ged=german.ged"); 950 exit; 951 } 952 953 These lines say that if we are using the German language files, but are 954 using the English GEDCOM, then we need to reload the page with the German 955 GEDCOM. You need to reload the page so that the configuration settings for 956 the GEDCOM get loaded. This assumes that you have both "english.ged" and 957 "german.ged" imported into the database and that the english.ged and the 958 german.ged have the same people in them, just in a different language. 959 Thus I0001 in english.ged should refer to the same I0001 in german.ged. 960 961 962 ------------------------------------------------------- 963 MIGRATING FROM DATABASE TO INDEX MODE AND VICE VERSA 964 965 Older of versions of PhpGedView supported and internal "index" mode format 966 which allowed it to run without a database. Since version 4.0, index mode 967 has no longer been supported. If you are running an older version of PGV 968 in index mode then these instructions can help you to upgrade to a new version 969 of PGV which only supports databases. 970 971 Basically it's possible to switch a PhpGedView installation from Index to 972 DATABASE mode or vice-versa without losing any settings. The following 973 steps have to be made: 974 975 DATABASE to Index 976 -------------- 977 1. Make sure you have all rights in the ./index/ folder on your web site 978 and on the file ./config.php 979 2. Copy the file config.php to configsql.php (or any other name) to 980 backup the old configuration. You may also use the Backup function 981 from the Admin menu to backup all vital files before switching mode. 982 3. DO NOT remove any files from your index directory, as some of them 983 (Privacy and GEDCOM settings) will also be used in Index mode. 984 4. In DATABASE mode, log in to PhpGedView with Admin rights. 985 5. Go to the Administration page and select the User Information 986 Migration tool. 987 6. Choose the Export function. 988 7. User Migrate will try to create the following files: 989 - authenticate.php - user accounts and settings 990 - favorites.dat - user and GEDCOM favorites 991 - blocks.dat - block layout of Welcome and MyGedView pages 992 - news.dat - User and GEDCOM news 993 - messages.dat - User messages 994 If any of the files already exist in your index directory, you will be 995 prompted to overwrite them. If there are problems creating the files, 996 when, for instance, you don't have sufficient rights, you can always 997 correct the problem and run the Export function again, as nothing 998 irreversible has happened. 999 8. Check that the above files exist in your index directory. 1000 9. Go to Admin, Configuration, change mode to Index and save the 1001 configuration. 1002 10. As all Index mode related files are already present, you should be 1003 able to use your web site in Index mode immediately. 1004 10. Import your GEDCOM files again to build the Index database. You don't 1005 need to change any GEDCOM settings, as they still exist in the index 1006 directory and will be used again. 1007 11. Test all settings and functions thoroughly before you remove your SQL 1008 database from your web site. 1009 1010 Index to DATABASE 1011 -------------- 1012 1. Make sure you have all rights in the ./index/ folder on your web site 1013 and on the file ./config.php 1014 2. Copy the file config.php to configindex.php (or any other name) to 1015 backup the old configuration. You can also use the Backup function 1016 from the Admin menu to backup all vital files before switching mode. 1017 3. DO NOT remove any files from your index directory, as all of them 1018 (Privacy and GEDCOM settings) will also be used in DATABASE mode, or 1019 will be used to migrate the information to DATABASE mode. 1020 4. Connect to your SQL DBMS with your regular administration tool, and 1021 define a database, without any tables. 1022 5. Create a user in your SQL-DBMS with the following rights on the 1023 database: 1024 SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER. 1025 6. In PhpGedView, go to Admin, Configuration, and change mode to 1026 DATABASE, fill in the appropriate SQL-DBMS and database name, user and 1027 user password and save the configuration. 1028 7. PhpGedView will ask you to create an admin user. Create one. This 1029 user will be overwritten later with the migrated information. 1030 8. From the admin menu, choose the User Information Migration tool, then 1031 choose Import. 1032 9. PhpGedview will now import all settings from Index mode to DATABASE 1033 mode. 1034 10. Go to Admin, Manage GEDCOMs and Edit Privacy, and then import all your 1035 GEDCOM files again. There is no need to change GEDCOM settings and 1036 Privacy settings, as all settings made in Index mode will be used. 1037 11. Test all settings and functions thoroughly before you remove Index 1038 related files (.\index\*.dat and .\index\authenticate.php) from your 1039 web site. 1040 1041 ------------------------------------------------------- 1042 POSTNUKE AND PHPNUKE INTEGRATION 1043 1044 PhpGedView can integrate with PostNuke and phpNuke so that your users do 1045 not have to login twice. 1046 1047 After you have PhpGedView up and running, you should follow the 1048 instructions in the readme.txt file in the pgvnuke folder. 1049 1050 The files that make the integration magic happen were donated by Jim Carey. 1051 1052 =========================================================== 1053 BACKUP 1054 1055 With the Backup function in the administration menu, you can make a simple 1056 backup of all important PhpGedview files. With this backup, it's possible 1057 to rebuild your PhpGedView site to the situation at backup time. 1058 1059 The backup can contain the following files, as selected on the Backup page: 1060 - config.php with all configuration settings of your installation 1061 - all GEDCOM files that were present in your installation 1062 - all GEDCOM options and privacy settings for the above files 1063 - counters, PhpGedView- and search-logfiles 1064 - user definitions and options (block definitions, favorites, messages 1065 and news) 1066 1067 The files will be gathered into a ZIP file, which can be downloaded by 1068 clicking the link on the page. 1069 1070 Note: The database itself will not be included in the backup, since it can 1071 be rebuilt using the files in the backup. 1072 1073 Note: All pending changes (not approved or rejected yet by the 1074 administrator) will be present in the GEDCOM files but can no longer be 1075 identified as changes. If the database is rebuilt using the GEDCOMs, these 1076 changes therefore can no longer be rejected. 1077 1078 The Backup function uses the PclZip library, which is written by Vincent 1079 Blavet and can be found at http://www.phpconcept.net/pclzip.
Back to SourceForge.net
Powered by ViewVC 1.0.3 ViewVC and Help
