MediaWiki API result

This is the HTML representation of the JSON format. HTML is good for debugging, but is unsuitable for application use.

Specify the format parameter to change the output format. To see the non-HTML representation of the JSON format, set format=json.

See the complete documentation, or the API help for more information.

{
"batchcomplete": "",
"continue": {
"gapcontinue": "Relationship_Chart",
"continue": "gapcontinue||"
},
"warnings": {
"main": {
"*": "Subscribe to the mediawiki-api-announce mailing list at <https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce> for notice of API deprecations and breaking changes."
},
"revisions": {
"*": "Because \"rvslots\" was not specified, a legacy format has been used for the output. This format is deprecated, and in the future the new format will always be used."
}
},
"query": {
"pages": {
"1591": {
"pageid": 1591,
"ns": 0,
"title": "Readme Version 4",
"revisions": [
{
"contentformat": "text/x-wiki",
"contentmodel": "wikitext",
"*": "<pre>\n=======================================================\nPhpGedView\n\nVersion 4.0\nCopyright 2005 John Finlay and others\n\nThis and other information can be found online at\nhttp://www.PhpGedView.net\n\n# $Id: readme.txt,v 1.109.2.21 2005/11/03 18:43:16 yalnifj Exp $\n\n=======================================================\n\nCONTENTS\n 1. LICENSE\n 2. INTRODUCTION\n 3. SYSTEM REQUIREMENTS\n 4. QUICK INSTALL\n 5. INSTALLATION\n 6. UPGRADING\n 7. UPDATING GEDCOMS\n 8. THEMES\n 9. MULTIMEDIA OBJECTS\n 10. RSS FEED\n 11. DATABASE TABLE LAYOUT\n 12. MANUAL CONFIGURATION\n 13. SECURITY\n 14. LANGUAGES\n 15. NON-STANDARD GEDCOM CODES\n 16. LANGUAGE EXTENSION FILES\n 17. MIGRATING FROM SQL TO INDEX MODE AND VICE VERSA\n 18. POSTNUKE AND PHPNUKE INTEGRATION\n 19. BACKUP\n\n-------------------------------------------------------\nLICENSE\n\nPhpGedView: Genealogy Viewer\nCopyright (C) 2002 to 2004 John Finlay and Others\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 2 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nSee the file GPL.txt included with this software for more\ndetailed licensing information.\n\n-------------------------------------------------------\nINTRODUCTION\n\nPhpGedView is a revolutionary genealogy program which allows you to view \nand edit your genealogy on your website. PhpGedView has full editing \ncapabilities, full privacy functions, and supports multimedia like photos \nand document images. PhpGedView also simplifies the process of \ncollaborating with others working on your family lines. Your latest \ninformation is always on your web site and available for others to see. \nFor more information and to see working demos, visit \nhttp://www.PhpGedView.net/\n\nPhpGedView is Open Source software that has been produced by people from \nmany countries freely donating their time and talents to the project. All \nservice, support, and future development is dependent on the time \ndevelopers are willing to donate to the project, often at the expense of \nwork, recreation, and family. Beyond the few donations received from \nusers, developers receive no compensation for the time they spend working \non the project. There is also no outside source of revenue to support the \nproject.\n\n-------------------------------------------------------\nSYSTEM REQUIREMENTS\n\nPhpGedView requires a web server with at least PHP v4.3 and around 20MB of\nweb space. The default installations of PHP on most servers should provide\nyou with all of the PHP functionality you should need.\n\nTo use the reporting engine, PHP needs to be compiled with XML support. \nThis is compiled into PHP by default unless it is specifically disabled. \nSee http://us3.php.net/manual/en/ref.xml.php\n\nSome features of PhpGedView require the GD library and that PHP be compiled\nwith GD support. Most precompiled versions of PHP include GD support. If \nyou are compiling PHP yourself you will need to configure it with the \n --with-gd \noption. See http://us3.php.net/manual/en/ref.image.php\n\nThe advanced calendar features of PhpGedView for converting Gregorian dates \nto the Hebrew or Jewish calendars require that PHP be compiled with the\n --enable-calendar \nconfiguration option. See http://us2.php.net/manual/en/ref.calendar.php \nfor more information.\n\nFor GEDCOMs larger than 2MB, you will likely need to research different\nhosting options and find one that will accept a request to modify the\ndefault memory and time limits built into PHP. See the FAQ at\nhttp://www.phpgedview.net/faq.php for more information about large GEDCOMs.\n\n-------------------------------------------------------\nQUICK INSTALLATION\n\nFollow the instructions in this section to install PhpGedView if you are\nalready familiar with the program or are familiar with installing other PHP \nweb applications.\n\n 1. Upload the files to your web server.\n 2. Set Write permissions on config.php and the \"index\" directory. For \n optimal security, you should move the \"index\" directory to a location \n where it is not accessible from the Internet.\n 3. Point your browser to the directory where you uploaded your PhpGedView \n files (for example, http://www.yourserver.com/PhpGedView/).\n 4. Enter your configuration settings. If you moved the index directory, \n be sure to specify the correct location to it on this page. Save the \n configuration parameters.\n 5. Enter the default administrator user.\n 6. Login as this user and upload your GEDCOM file.\n 7. Save the GEDCOM configuration settings.\n 8. Import the GEDCOM.\n\nOptional Steps\n 9. If you want to use the language editing features you will need to set \n Write permissions for all of the files in the ./languages folder.\n10. If you want to upload media files using the Upload Media section of \n the Admin menu then you need to set Write permissions for your ./media \n and ./media/thumbs directories.\n11. If you want to edit your GEDCOM file online, the GEDCOM file must have\n Write permissions set for the PHP user.\n12. If you want to use the Backup feature of the Upgrade utility in \n PhpGedView you will need to either set Write permission on the \n PhpGedView folder itself or create a folder named \"backup\" with Write \n permissions. Write permissions for the PhpGedView folder can be \n removed as soon as the backup folder is in place and has the \n appropriate permissions.\n13. For security you should set the permissions back to Read-only when you \n are done editing or uploading files.\n\n-------------------------------------------------------\nINSTALLATION\n\nFollow these instructions if you are not familiar with PhpGedView or \ninstalling PHP applications.\n\n*A. Upload Program Files:\nTo install PhpGedView, unzip the compressed package and upload the files to \na directory on your web server. If you have limited space on your server, \nyou can save space in the following ways:\n1. Do not upload the \"docs\" folder.\n2. Delete the themes from the themes folder that you do not plan to use.\n3. Delete some of the language files that you do not want. English files \n are named configure_help.en.php, countries.en.php, facts.en.php, \n help_text.en.php and lang.en.php. French files, for example, are named \n with \".fr.\" in place of \".en.\". Hebrew files use \".he.\" in place of \n \".en.\", and so on. \n The English language files cannot be deleted. They are always loaded \n before the files for the selected language are loaded. This ensures \n that all language variables are defined, and that the English version \n will be used when a given variable is missing in the new language.\n4. Do not upload the \"places\" folder. This folder contains maps for some\n countries. It also contains text files containing state, county, and \n place names. Its purpose is to allow you to enter place names by \n picking them from lists. \n\nFor optimal security, you may want to move the \"index\" directory to a \ndifferent location outside of your Internet accessible space. You will \nspecify the location of this directory during the online configuration. \nSee the SECURITY section for more information.\n\n*B. Required File Permissions:\nPhpGedView requires that Read permissions be set for all files in the\nPhpGedView directory tree. Some hosts also require Execute permissions\n(chmod 755). PhpGedView requires full Write permissions on the index \ndirectory (chmod 777 under most hosting configurations). PhpGedView also \nrequires that Write permissions (chmod 777) be set temporarily for the \nconfig.php file.\n\nTo help with the setting of permissions a file called setpermissions.php \nhas been included with the project. This file will attempt to set 777 \npermissions to the config.php, ./index, and all of the files inside the \n./index directory. Because host settings vary on the ability of PHP \nprograms to set file permissions, you have to run this file manually.\n\nIf at any time you have trouble during configuration, check your \npermissions again.\n\nThere are some advanced features that require more Write permissions to be \nset. If you want to use the language editing features you will need to set \nWrite permissions for all of the files in the ./languages folder (chmod \n777). If you want to upload media files using the Upload Media section of \nthe Admin menu then you need to set Write permissions (chmod 777) for your \n./media and ./media/thumbs directories. If you want to edit your GEDCOM \nfile online, the GEDCOM file must have Write permissions set to the PHP \nuser (chmod 777).\n\n*C. Configuration:\nNext point your web browser to the PhpGedView folder\n(for example, http://www.yourserver.com/PhpGedView/) to automatically \nbegin the online configuration process. Information about each of the \nconfiguration options can be found online by clicking on the question mark \n(?) near each label.\n\nPhpGedView has support for importing your GEDCOMs into a PEAR:DB supported \ndatabase like MySQL or PostgreSQL. Currently, MySQL is the only fully tested \ndatabase. Using a database requires that an existing user, password, and database already\nexist.\n\nYou may reconfigure PhpGedView at any time by going to PhpGedView/admin.php \nand logging in as an administrator user and clicking on the \"Configuration\" \nlink.\n\n*D. Create Admin User\nAfter you click the Save button, you will be asked to create an \nadministrator user and login as this user. Then click on the link labelled \n\"Click here to continue\" where you will be taken to the \"Manage GEDCOMs\" \narea. In the \"Manage GEDCOMs\" area you can add GEDCOMs to your site, edit \nthe GEDCOM configuration, edit Privacy settings, and import the GEDCOM into \nthe data store.\n\n*E. Add GEDCOM file\nTo add GEDCOM files to the system, you can upload your GEDCOM file using \nthe \"Upload GEDCOM\" option from the Admin menu. All files uploaded using \nthe \"Upload GEDCOM\" page are saved in your index directory. You can also \nupload your GEDCOM manually using FTP or any other file upload method. \nMost hosts limit the size of files that can be uploaded from a web form for \nsecurity reasons, so you may be forced to use a manual method. You may \nalso upload your GEDCOM in ZIP format, either manually or using the \n\"Upload GEDCOM\" option. Make sure to enter the filename of the ZIP file. \nPhpGedView will automatically unpack the ZIP file and use the GEDCOM file \ninside it. Be sure to create the ZIP file to contain only one GEDCOM file.\n\n*F. Set GEDCOM Configuration Settings\nAfter uploading your GEDCOM, you will be asked to set the configuration\nparameters for it. There are too many parameters to list all of their \noptions in this document. Please use the online Help documentation to \nguide you through the configuration process.\n\n*G. Validate GEDCOM\nAfter you save the GEDCOM configuration PhpGedView will validate your \nGEDCOM and automatically fix any errors that it can. If any errors found \nin the GEDCOM require user input, you will be prompted to choose how to \nproceed. Again use the online Help ? for more information.\n\n*H. Import GEDCOM\nYou are almost done. This is the final step before you can begin viewing \nyour data. After validating the GEDCOM and fixing any errors, you will \nneed to import the GEDCOM into the data store. During the Import you will \nsee a lot of processing statistics printed on the screen. If the Import \ncompleted successfully you will see a blue \"Import Complete\" message. \nEverything is now set up and you can begin using PhpGedView with your \nGEDCOM.\n\n*I. Deleting GEDCOMs\nYou may delete GEDCOMs from your site from the \"Manage GEDCOMs\" area.\nDeleting a GEDCOM from the site will remove it from the database but will \nnot delete the original GEDCOM file that you imported. It will also not\ndelete any of the cache or privacy files related to this GEDCOM. These \nretained files, which are no longer required by PhpGedView, are all located \nin the \"index\" directory.\n\n*J. Reset config.php Permissions\nFor security you should set the permissions of config.php back to Read-only\n(chmod 755) when you have finished configuring for the first time. Write\npermissions will only need to be set for config.php when you use the\nAdmin->Configuration link. Everything else will be stored in the index\ndirectory.\n\n*K. Custom Themes\nYou can customize the look and feel of PhpGedView by modifying one of the\nprovided themes. See the THEMES section of this readme file for more\ninformation.\n\n*L. HTTP Compression\nPages generated by PhpGedView can be large and use up a lot of bandwidth.\nCompression of the data between the server and browser using GZip \ncompression can compress the bandwidth by up to 90% (usually 80% - 90% for \nPhpGedView that were tested) If your web server is Apache, configuring this \nis very easy. Add the following 2 lines to your php.ini file:\n php_flag zlib.output_compression On\n php_value zlib.output_compression_level 5\n\nIf you have no access to the php.ini file, create a blank file named \n.htaccess (including the dot) and add the lines to that file (or add them \nto an existing .htaccess file and upload the file to your PhpGedView \ndirectory.\n\nNote: If your host is using mod_gzip or an other compression method, using \nthis technique can cause problems. Compression will have no effect on \nbrowsers that do not support it. You can test the compression at\nhttp://leknor.com/code/gziped.php\n\nIf you need help or support visit http://www.PhpGedView.net/support.php\n\n-------------------------------------------------------\nUPGRADING\n\nUse the following steps to upgrade to v4.0. These steps assume that you \nare familiar with PhpGedView and have successfully installed it before.\n\nVersion 4.0 no longer includes support for index files. If you do not have \nPHP 5 with built-in SQLite support or a database account then you should not \nupgrade to PhpGedView 4.0. Maintenance releases will continue for the 3.3.x \nversion.\n\n**Note to SQLite users: Unfortunately SQLite does not support the ALTER TABLE\n SQL command. This means that we must first drop the tables and recrate\n them. It is highly reccomended that you run the backup before upgrading.\n\n1. Upload the new 4.0 files to your server replacing the old files with the \n\tnew files. Do not replace the config.php file or the index directory.\n2. Go to upgrade33-40.php in your browser.\n3. SQLite users will need to reimport their GEDCOM files.\n4. You can now use your upgraded site. One change with this version splits\n user's full names into first and last name fields. If you have users\n who only entered a single name then their first and last name will be the\n same and it will appear doubled on some screens. You may want to review \n your user list and check your user's names.\n5. If you are using a customized theme you will need to update your theme\n with new stylesheets and variables. An excellent tool that can help \n you to merge themes is the WinMerge project \n http://winmerge.sourceforge.net/\n \n-------------------------------------------------------\nUPDATING GEDCOMS\n\nWhen you change your genealogy data outside of PhpGedView, it is not \nnecessary to delete your GEDCOMs from PhpGedView and start over. Follow \nthese steps to update a GEDCOM that has already been imported:\n\n1. The first step is to replace your old GEDCOM on the site with your new\n GEDCOM. You can do this using FTP, or by going to the \"Upload GEDCOM\" \n page and uploading a new GEDCOM with the same filename as the old one. \n Please remember that file names are case sensitive.\n2. Re-import the GEDCOM file by going to \n Admin->Manage GEDCOMs->Import GEDCOM. The GEDCOM will be validated \n again before importing.\n3. The Import script will detect that the GEDCOM has already been imported \n and will ask if you want to replace the old data. Click the \"Yes\" \n button.\n4. You will again see the Import statistics and the Import Complete \n message at the bottom of the page when the Import is complete.\n\nIf you use a ZIP file to upload the GEDCOM, the only way to do it is by \neither using the \"Upload GEDCOM\" option, or the \"Add GEDCOM\" option. The \nGEDCOM file in the zipped file has to have exactly the same name as the \nalready existing GEDCOM. This way existing GEDCOM settings will be \npreserved.\n\n-------------------------------------------------------\nTHEMES\n\nPhpGedView uses a theme based architecture allowing you to have greater\nflexibility over the appearance of the site. The \"themes\" directory \ncontains the standard themes that come packaged with PhpGedView. You may \ncustomize any of these themes to your liking or create your own theme by \ncopying any of the standard themes to a new folder and modifying it. When \nyou configure PhpGedView, you should tell it to look in your new theme \ndirectory.\n\nA theme directory must contain at least the following 6 files:\n footer.html # PHP/HTML for the bottom of every page\n header.html # PHP/HTML for the top of every page\n print_footer.html # PHP/HTML for the bottom of every print preview page\n print_header.html # PHP/HTML for the top of every print preview page\n style.css # A CSS stylesheet containing all styles\n sublinks.html # PHP/HTML to print the links to other places\n theme.php # The PHP design variables that you may customize\n toplinks.html # PHP/HTML that appears just below the header.html\n\nFor a guide to building your own custom PhpGedView theme, go to:\nhttp://www.PhpGedView.net/styleguide.php\n\nIf you really like a theme that you have done and would like it included \nwith the project, you should send your theme files to the developers at\nyalnifj@users.sourceforge.net.\n\n-------------------------------------------------------\nMULTIMEDIA OBJECTS\n\nThe GEDCOM 5.5 standard supports multimedia files of all types. Currently\nPhpGedView supports multimedia objects only as external files. Multimedia\nembedded in the GEDCOM file itself will be ignored. To use the multimedia\nsupport in PhpGedView you must copy the multimedia files external to your\nGEDCOM to the \"media\" directory in the folder where you installed \nPhpGedView.\n\nIn choosing which picture to show on charts, PhpGedView will choose the \nfirst one with the _PRIM Y marker. If there are no _PRIM tags in your \nmedia object records then the first object found will be used. You can \ndisable all photos on charts for a particular person by setting _PRIM N on \nall media objects. Most genealogy programs will do this for you \nautomatically.\n\nYou can find all of the images referenced in your file by opening your \nGEDCOM in a text editor and looking for the OBJE or FILE tags.\n\nPhpGedView includes a \"media/thumbs\" directory where you can place \nthumbnails of your media files for display in lists and on other pages. \nPhpGedView allows you to create your own thumbnails so that you can \nmaintain artistic control over your media and to avoid the installation of \nother server side software. Make a copy your images and reduce them to an \nappropriate thumbnail size somewhere around 100px width and upload them to \nthe \"media/thumbs\" directory. Keep the filename the same as the original. \nThumbnails can be created for non-image media files as well. To do this \ncreate a thumbnail image in either gif, jpeg, png or bmp formats and name \nthem the same name as the media file including the file extension (even if \nthe media is a non image such as a PDF or an AVI file, name the thumbnail \nIMAGE with the PDF or AVI file extension).\n\nYou can configure PhpGedView to recognize subdirectories in your media \nfolder. The subdirectories must be the same names as the subdirectories in \nyour media file paths pointed to in your GEDCOM file. For example, if you \nhave the following media references in your GEDCOM file:\n C:\\Pictures\\Genealogy\\photo.jpg\n C:\\Pictures\\Scans\\scan1.jpg\n scan2.jpg\n\nWith the media depth set to 1 you need to set up your directory structure \nlike this:\n media/Genealogy/photo.jpg\n media/Scans/scan1.jpg\n media/scan2.jpg\n media/thumbs/Genealogy/photo.jpg\n media/thumbs/Scans/scan1.jpg\n media/thumbs/scan2.jpg\n\nWith the media depth set to 2 you need to set up your directory structure \nlike this:\n media/Pictures/Genealogy/photo.jpg\n media/Pictures/Scans/scan1.jpg\n media/scan2.jpg\n media/thumbs/Pictures/Genealogy/photo.jpg\n media/thumbs/Pictures/Scans/scan1.jpg\n media/thumbs/scan2.jpg\n\n-------------------------------------------------------\nRSS FEED\n\nPGV now includes an RSS feed. RSS is an XML format that allows other sites\nto get news and other data from your site. The language used is the \ndefault language of the site. The language of the feed can be set to any \nlanguage supported by PGV by changing the URL that your RSS aggregator uses \nfrom the default /phpGedView/rss.php to /phpGedView/rss.php?lang=english \n(or any language supported by PGV such as rss.php?lang=french). \n\nCurrently only the default site GEDCOM is supported for the feed info. \nOther options available in the RSS feed are the ability to specify the feed \ntype via the rssStyle parameter. The PGV default is \"RSS1.0\". Passing any \nsupported type including \"PIE0.1\", \"mbox\",\"RSS0.91\", \"RSS1.0\", \"RSS2.0\", \n\"OPML\", \"ATOM0.3\", \"HTML\", \"JS\" will change the feed type. \n\nFor example, calling /phpGedView/rss.php?rssStyle=HTML will create HTML \noutput suitable for inclusion in an other page via an iFrame. The JS \noption will output JavaScript that can be included in an other page without \nusing an iFrame. \n\nYou can also specify a module that you want to output (only 1) so that only \nthat module will be output. This is done via the module parameter. For \nexample, /phpGedView/rss.php?module=GEDCOMStats will only output the GEDCOM \nStats block. \n\nThese parameters can be chained so that\n/phpGedView/rss.php?lang=hebrew&module=GEDCOMStats&rssStyle=HTML \nwill output the GEDCOM Stats module in Hebrew in HTML.\n\n\n-------------------------------------------------------\nDATABASE TABLE LAYOUT\n\nPhpGedView uses a very simple database table layout because it operates\nprimarily on the GEDCOM data and only needs the database for search and\nretrieval. There are only a few tables in the database:\n pgv_blocks # Description of each user's Portal page\n pgv_dates # Stores decoded date information from GEDCOM records\n pgv_families # All the families in the GEDCOM\n pgv_favorites # Stores users favorites\n pgv_individuals # All the individuals in the GEDCOM\n pgv_messages # Messages to and from users\n pgv_names # Stores decoded name information from GEDCOM records\n pgv_news # Stores news items for the Index and Portal pages\n pgv_other # All other level 0 GEDCOM records (i.e., repositories, \n # media objects, notes, etc.)\n pgv_placelinks # Cross-reference between places and individuals and\n # families\n pgv_places # Place hierarchy\n pgv_sources # All the sources in the GEDCOM\n pgv_users # Table for user data (only exists if using default \n # mysql authentication module)\n\n\nThe tables are all very similar. They each have a field for the GEDCOM ID, \na field to tell which GEDCOM file the record was imported from, a few \nfields for things like quick retrieval of name information, and a field for\nthe raw GEDCOM record data.\n\nFollowing is a more detailed description of each table:\n pgv_individuals:\n i_id VARCHAR(255) # GEDCOM individual ID\n i_file INT # ID number of the GEDCOM file the record is from\n i_rin VARCHAR(30) # Individual's RIN number\n i_name VARCHAR(255) # Person's primary name taken from the first\n # 1 NAME line stored in GEDCOM name format\n i_isdead int(1) # Alive/dead status of individual\n # -1 = not calculated yet 0 = alive 1 = dead\n i_GEDCOM TEXT # Raw GEDCOM record for this individual\n i_letter VARCHAR(5) # First letter of the individual's surname\n i_surname VARCHAR(100) # Person's surname\n\n pgv_families:\n f_id VARCHAR(255) # GEDCOM family ID\n f_file INT # ID number of the GEDCOM file the record is from\n f_husb VARCHAR(255) # ID of the husband\n f_wife VARCHAR(255) # ID of the wife\n f_chil TEXT # List of children IDs, semi-colon (;) delimited\n f_GEDCOM TEXT # Raw GEDCOM record for this family\n f_numchil INT # Number of children in this family\n\n pgv_sources:\n s_id VARCHAR(255) # GEDCOM source ID\n s_file INT # ID number of the GEDCOM file the record is from\n s_name VARCHAR(255) # Abbreviated title of the source\n s_GEDCOM TEXT # Raw GEDCOM record for this source\n\n pgv_other:\n o_id VARCHAR(255) # GEDCOM record ID\n o_file INT # ID number of the GEDCOM file the record is from\n o_type VARCHAR(20) # Type of GEDCOM record\n # (REPO, ADDR, NOTE, OBJE, etc)\n o_GEDCOM TEXT # Raw GEDCOM record for this item\n\n pgv_names:\n n_gid VARCHAR(255) # Individual ID that this name corresponds to\n n_file INT # ID number of the GEDCOM file the record is from\n n_name VARCHAR(255) # Name in GEDCOM format,\n # with / / around the surname\n n_letter VARCHAR(5) # First letter of the surname\n n_surname VARCHAR(100) # Surname for this name record\n n_type VARCHAR(10) # Type of name,\n # P = primary, A = additional, C=calculated\n\n pgv_blocks:\n b_id INT(11) # Record ID\n b_username VARCHAR(100) # User name whom block belongs to\n b_location VARCHAR(30) # Location of the block. \n # Main column or right column\n b_order INT(11) # Position of the block within the column\n b_name VARCHAR(255) # Name of the block\n b_config TEXT # Configuration settings for this block\n\n pgv_favorites:\n fv_id INT(11) # Record ID\n fv_username VARCHAR(30) # User name whom the favorite belongs to\n fv_gid VARCHAR(10) # ID of the favorite\n fv_type VARCHAR(10) # Type of favorite (currently only INDI)\n fv_file VARCHAR(100) # File that this favorite belongs to\n fv_url VARCHAR(255) # The URL for this favorite if it is not one of \n # the basic types\n fv_title VARCHAR(255) # A title for URL based favorites\n fv_note TEXT # Optional descriptive information about this favorite\n\n pgv_messages:\n m_id INT(11) # Record ID\n m_from VARCHAR(255) # Name or email address of the sender\n m_to VARCHAR(30) # Destination user name\n m_subject VARCHAR(255) # Subject of the message\n m_body TEXT # Body text of the message\n m_created VARCHAR(255) # Time stamp when the message was created\n \n pgv_news:\n n_id INT(11) # Unique identifier\n n_username VARCHAR(100) # User name or GEDCOM the News item belongs to\n n_date INT(11) # Time stamp of last update\n n_title VARCHAR(255) # Title of the article\n n_text TEXT # Body text of the article\n\n pgv_places:\n p_id INT(11) # Unique identifier\n p_place VARCHAR(150) # Place name\n p_level INT(11) # Level of the place in the hierarchy,\n # 0 is the country or state\n p_parent_id INT(11) # ID of this item's parent place in the \n # hierarchy. A city's parent would be the \n # county it is in, a county's parent would be \n # a state or province, and a state or province\n # would have a country as parent.\n p_file INT # ID number of the GEDCOM file the record is from\n\n pgv_placelinks:\n pl_p_id INT(11) # Unique identifier\n pl_gid VARCHAR(30) # Family or individual ID referencing this place\n pl_file INT # ID number of the GEDCOM file the record is from\n\n pgv_users:\n u_username VARCHAR(30) # User name\n u_password VARCHAR(255) # Encrypted password\n u_fullname VARCHAR(255) # User's full name\n u_GEDCOMid TEXT # Serialized array representing the GEDCOM IDs\n # for this user\n u_rootid TEXT # Serialized array representing the root IDs \n # for this user\n u_canadmin ENUM('Y','N') # Is the user an admin or not\n u_canedit TEXT # Serialized array indicating the editing \n # privileges a user has for each GEDCOM\n u_email TEXT # Email addres\n u_verified VARCHAR(20) # User self verified\n u_verified_by_admin VARCHAR(20) # User has been verified by the admin\n u_language VARCHAR(50) # User's preferred language\n u_pwrequested VARCHAR(20) # User requested a new password\n u_reg_timestamp VARCHAR(50) # Registration timestamp\n u_reg_hashcode VARCHAR(255) # Self-registration hash key\n u_theme VARCHAR(50) # User's preferred theme\n u_loggedin ENUM('Y','N') # User's login status\n u_sessiontime INT(14) # User's last login time stamp\n u_contactmethod VARCHAR(20) # User's preferred method of contact\n u_visibleonline ENUM('Y','N') # Whether or not the user is visible in\n # the logged on users block\n u_editaccount ENUM('Y', 'N') # Whether or not the user can edit his\n # own account information\n u_defaulttab INT(10) # Default tab on the individual page\n # for this user\n u_comment VARCHAR(255) # Admin's comments on this user\n u_comment_exp VARCHAR(20) # Alert date for the admin, for instance \n # for temporary accounts.\n u_sync_gedcom VARCHAR(2) # If the user has a GEDCOM record ID, then \n # should some of the data for the user (name,\n # email) be synchronized with the GEDCOM data.\n u_relationship_privacy VARCHAR(2) # Should this user use relationship privacy\n u_max_relation_length INT # The maximum path that the user is allowed to see\n u_auto_accept VARCHAR(2) # Are changes made by this user automatically \n # accepted into the database\n\nThis table layout has received criticism from some for its simplicity, \nsize, and because it does not follow a genealogy model like GENTECH. \nWe admit that these tables can be hard to interface to because the code has \nto understand GEDCOM in order to get information out of them. We also \nadmit that storing the raw GEDCOM data could make the tables very large.\n\nFortunately the GEDCOM standard is not a very complex or large format; it \nonly requires 6 characters per line, which is very good compared to \nsomething like XML. However, there are some very compelling reasons why \nthis table structure was chosen:\n1. Simpler tables mean fewer and simpler database queries. This takes a\n large load off the database and makes the program run faster.\n2. Nothing is lost in the Import. Even though GEDCOM is a standard, each\n genealogy program interprets the standard a bit differently and adds \n its own tags. Creating a database model that conforms to all the \n GEDCOM outputs of different genealogy software programs would be very \n difficult.\n\n-------------------------------------------------------\nMANUAL CONFIGURATION\n\nAdvanced users who understand PHP may want to configure manually by editing \nthe configuration file config.php When you have finished editing \nconfig.php make sure that the variable $CONFIGURED=true; so that the \nprogram does not try to forward you to the configuration.php script when \nyou launch it for the first time.\n\nYou can manually add GEDCOMS to the system by adding them to the $GEDCOMS \narray in the index/GEDCOMs.php file. The GEDCOM array looks like this:\n $gedarray = array();\n $gedarray[\"GEDCOM\"] = \"surname.ged\";\n $gedarray[\"config\"] = \"./index/surname.ged_conf.php\";\n $gedarray[\"privacy\"] = \"./index/surname.ged_priv.php\";\n $gedarray[\"title\"] = \"Surname Genealogy\";\n $gedarray[\"path\"] = \"./surname.ged\";\n $GEDCOMS[\"surname.ged\"] = $gedarray;\n\"surname\" above could be anything, for example, \"johnson\" or \"private\". \nYou must pay attention to the case of what you enter. PhpGedView is case \nsensitive.\n\nEach GEDCOM will need a configuration file. You can copy the \nconfig_GEDCOM.php file which has all of the default values for each GEDCOM \nyou add manually. Then set the \"config\" item of the GEDCOMS array to point \nto the file you copied.\n\nEach GEDCOM also needs a Privacy file. Make a copy the privacy.php file \nfor each GEDCOM and set the \"privacy\" item of the GEDCOMS array to the \nlocation of the new privacy.php file.\n\n-------------------------------------------------------\nSECURITY\n\nEven though PhpGedView gives you the ability to hide the details of living\nindividuals, whenever you post the personal details of living individuals \non the Internet, you should first obtain the permission of EACH living \nperson you plan to include. There are many people who would not even want \ntheir name linked with their family history made public on the Internet and \ntheir wishes should be respected and honored. Most family history programs \nallow you to choose the people who are exported when you create your GEDCOM \nfile. The most secure option is to deselect all living people in your \ngenealogy program when you export your genealogical data to a GEDCOM file.\n\nIf you wish to protect your GEDCOM file itself from being downloaded over \nthe Internet you should place it outside the root directory of your web \nserver or virtual host and set the value of the $GEDCOM variable to point \nto that location. For example, if your home directory is something like\n\"/home/username\" and if the root directory for your web site is\n\"/home/username/public_html\" and you have installed PhpGedView in the\n\"public_html/PhpGedView\" directory then you would place your GEDCOM file in\nyour home directory at the same level as your \"public_html\" directory. You\nwould then set the file path to \"/home/username/GEDCOM.ged\" by editing the\nGEDCOM configuration.\n\nYou can also manually set the location by changing the \"path\" line in\nindex/GEDCOMs.php:\n $gedarray[\"path\"] = \"../../GEDCOM.ged\";\nor\n $gedarray[\"path\"] = \"/home/username/GEDCOM.ged\";\n\nSince your GEDCOM file resides in a directory outside of your web server's \nroot directory, your web server will not be able to fullfill requests to \ndownload it. However, PhpGedView will still be able to read and display \nits contents.\n\nIn the end it is YOUR responsibility to guarantee that there has been no\nviolation of an individual's privacy and YOU could be held liable should\nprivate information be made public on the web sites that you administer.\n\nFor more privacy options visit:\nhttp://www.PhpGedView.net/privacy.php\n\n-------------------------------------------------------\nLANGUAGES\n\nPhpGedView has built-in support for multiple languages. PHP does not \nsupport unicode (UTF-16). It does support UTF-8 and that is the \nrecommended character encoding for GEDCOMs with PhpGedView. If you have \ncharacters in your GEDCOM outside the standard ASCII alphabet, you should \nprobably use the UTF-8 encoding. There are many differences between UTF-8 \nand UTF-16, but anything that you can encode in UTF-16 you should be able \nto encode in UTF-8. It is also quite easy to convert from Unicode to \nUTF-8. Simply open your Unicode GEDCOM file in Windows Notepad and select \n\"File->Save As..\" from the menu and choose UTF-8 as the encoding option. \nYou shouldn't lose any of the characters in the translation.\n\nYou should check the Patches section of\nhttp://sourceforge.net/projects/PhpGedView to get the latest language \nfiles.\n\nDiscussion and questions about the multiple language features of PhpGedView\nincluding translations, should be posted in the Translations forum \navailable from the PhpGedView project page here:\nhttp://sourceforge.net/forum/forum.php?forum_id=294245\n\nTo translate PhpGedView into another language that is not currently \nsupported you must first login to PhpGedView as an administrator and go to \nthe Language Edit Utility by clicking on \"Admin-> Translator Tools\". At \nthe bottom of that page is an option to Add a new language. Choose your l\nanguage from the dropdown list and click on the \"Add new Language\" button. \nA popup window will appear that allows you to edit the default settings for \nyour language. Each of the settings has online help available by clicking \non the \"?\". You might want to look at the settings for some of the other \nlanguages on the edit language page to see how they are set up. When you \nhave finished editing the settings, click the Save button. This will \ncreate a new lang_settings.php file in the index directory. You will \nnotice that your language now appears in the supported languages list.\n\nNext create a copy of the \"configure_help.en.php\", \"facts.en.php\", \n\"help_text.en.php\", and \"lang.en.php\" files located in the \"./languages/\" \nand change the \"en\" part to match the two letter language code of your \nlanguage. \n\nThe \"facts\" file contains all of the translations for the various GEDCOM \ntags such as BIRT = Birth. The \"lang\" file contains all of the language \nvariables used throughout the site. The \"configure_help.en.php\" and\n\"help_text.en.php\" provide configuration and help instructions.\n\nYou can translate these files using the online Language File Edit utility.\nJust select your language from the drop-down list and then select the file \nyou want to edit and click the Edit button. Your file will be compared to \nthe English language file so that you can easily translate the files \nonline.\n\nYou can also translate these files manually by opening them in any text \neditor. If you manually edit the files, you must be sure to save them in \nthe UTF-8 character set. Some text editors like Windows Notepad add a \n3-byte Byte-Order-Mark (BOM) to files they save in UTF-8. PHP does not \nlike the BOM and it should be removed before testing the files in \nPhpGedView. PhpGedView's Translator Tools section has a utility program\nfor removing these BOMs.\n\nYou should obtain a flag file from http://w3f.com/gifs/index.html and size \nit to match the other flags in the images/flags directory.\n\nTo help maintain languages, a language change log is provided in the \nlanguages directory. This change log is named LANG_CHANGELOG.txt. All \nchanges to the English language files are recorded here.\n\nIf you make a new translation of PhpGedView or update another translation, \nand would like to contribute it to the community please post your language \nfiles and your index/lang_settings.php file to the Patches section of the \nSourceForge project site at http://www.sourceforge.net/projects/phpgedview\n\n-------------------------------------------------------\nNON-STANDARD GEDCOM CODES\n\nThe GEDCOM 5.5 standard has a defined set of codes. You can read the\nspecification online at http://www.PhpGedView.net/ged551-5.pdf Part of the\nstandard allows for genealogy software to define their own codes, and \nrequests that they begin with an \"_\" underscore. \n\nWhen PhpGedView comes across a tag that is not defined it will display an \nerror message. You can disable these error messages by setting \n$HIDE_GEDCOM_ERRORS=true; in the config.php file. PhpGedView can also be \ncustomized to work with these codes by adding them to the facts array in a \nnew language file named facts.en.extra.php. If you add it to the English \nfacts file you should also add it to the other facts language files you are \nusing on your site if you want other languages to translate the tag \ncorrectly.\n\nThe format of the facts file is a PHP associative array. Each tag requires \none line in the array. The following line defines the label \"Abbreviation\" \nfor the ABBR GEDCOM tag.\n $factarray[\"ABBR\"] = \"Abbreviation\";\n\nAs an example, if you use a genealogy program that generates the tag \n\"_ZZZZ\" you can customize PhpGedView to accept this code by adding the \nfollowing lines to the facts.en.extra.php file:\n <?php\n $factarray[\"_ZZZZ\"] = \"Tag Label goes here\";\n ?>\n\n-------------------------------------------------------\nLANGUAGE EXTENSION FILES\n\nLanguage extension files are custom PHP files that you can use to make your \nown language specific extensions to PhpGedView. To add a language file \nextension, create a new PHP file called lang.xx.extra.php replacing the \n\"xx\" with the code for the language you want to extend. These files are \nnot automatically included with the package so that when you upgrade, your \nextensions are not overwritten.\n\nIf this file exists for the language that is chosen, it is the very last \nthing that is loaded before the display starts. These files were designed \nto be language file extensions, but you could easily use them to make \nsettings changes based on the chosen language.\n\nWhat sort of things can you do with language extensions?\n - Customize any of the text that appears on the site,\n - Change configuration options based on language,\n - Change to a different GEDCOM when someone views your site in a different\n language.\n\nThe only settings that you should not override in this file are the Privacy\nsettings.\n\nIf, for example, you wanted to change the GEDCOM title when you changed the\nlanguage, you could change the title for each language by adding the \nfollowing line to your lang.xx.extra.php:\n $GEDCOMS[\"surname.ged\"][\"title\"] = \"Title in Chinese\";\n\nIn this file you could also change the text on the buttons:\n $pgv_lang[\"view\"]=\"Show\";\n\nWith this file you could also change the GEDCOM that is displayed when the \nlanguage is selected. Suppose you had a GEDCOM that was in German and one \nthat was in English. In the lang.de.extra.php file you could add the \nfollowing lines:\n if ($GEDCOM==\"english.ged\") {\n header(\"Location: $SCRIPT_NAME?$QUERY_STRING&ged=german.ged\");\n exit;\n }\n\nThese lines say that if we are using the German language files, but are \nusing the English GEDCOM, then we need to reload the page with the German \nGEDCOM. You need to reload the page so that the configuration settings for \nthe GEDCOM get loaded. This assumes that you have both \"english.ged\" and \n\"german.ged\" imported into the database and that the english.ged and the \ngerman.ged have the same people in them, just in a different language. \nThus I0001 in english.ged should refer to the same I0001 in german.ged.\n\n\n-------------------------------------------------------\nMIGRATING FROM DATABASE TO INDEX MODE AND VICE VERSA\n\nBasically it's possible to switch a PhpGedView installation from Index to \nDATABASE mode or vice-versa without losing any settings. The following \nsteps have to be made:\n\nDATABASE to Index\n--------------\n 1. Make sure you have all rights in the ./index/ folder on your web site \n and on the file ./config.php\n 2. Copy the file config.php to configsql.php (or any other name) to \n backup the old configuration. You may also use the Backup function \n from the Admin menu to backup all vital files before switching mode.\n 3. DO NOT remove any files from your index directory, as some of them \n (Privacy and GEDCOM settings) will also be used in Index mode.\n 4. In DATABASE mode, log in to PhpGedView with Admin rights.\n 5. Go to the Administration page and select the User Information \n Migration tool.\n 6. Choose the Export function.\n 7. User Migrate will try to create the following files:\n - authenticate.php - user accounts and settings\n - favorites.dat - user and GEDCOM favorites\n - blocks.dat - block layout of Welcome and MyGedView pages\n - news.dat - User and GEDCOM news\n - messages.dat - User messages\n If any of the files already exist in your index directory, you will be \n prompted to overwrite them. If there are problems creating the files, \n when, for instance, you don't have sufficient rights, you can always \n correct the problem and run the Export function again, as nothing \n irreversible has happened.\n 8. Check that the above files exist in your index directory.\n 9. Go to Admin, Configuration, change mode to Index and save the \n configuration.\n10. As all Index mode related files are already present, you should be \n able to use your web site in Index mode immediately.\n10. Import your GEDCOM files again to build the Index database. You don't \n need to change any GEDCOM settings, as they still exist in the index \n directory and will be used again.\n11. Test all settings and functions thoroughly before you remove your SQL\n database from your web site.\n\nIndex to DATABASE\n--------------\n 1. Make sure you have all rights in the ./index/ folder on your web site \n and on the file ./config.php\n 2. Copy the file config.php to configindex.php (or any other name) to \n backup the old configuration. You can also use the Backup function \n from the Admin menu to backup all vital files before switching mode.\n 3. DO NOT remove any files from your index directory, as all of them \n (Privacy and GEDCOM settings) will also be used in DATABASE mode, or \n will be used to migrate the information to DATABASE mode.\n 4. Connect to your SQL DBMS with your regular administration tool, and \n define a database, without any tables.\n 5. Create a user in your SQL-DBMS with the following rights on the \n database:\n SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER.\n 6. In PhpGedView, go to Admin, Configuration, and change mode to \n DATABASE, fill in the appropriate SQL-DBMS and database name, user and \n user password and save the configuration.\n 7. PhpGedView will ask you to create an admin user. Create one. This \n user will be overwritten later with the migrated information.\n 8. From the admin menu, choose the User Information Migration tool, then \n choose Import.\n 9. PhpGedview will now import all settings from Index mode to DATABASE \n mode.\n10. Go to Admin, Manage GEDCOMs and Edit Privacy, and then import all your \n GEDCOM files again. There is no need to change GEDCOM settings and \n Privacy settings, as all settings made in Index mode will be used.\n11. Test all settings and functions thoroughly before you remove Index \n related files (.\\index\\*.dat and .\\index\\authenticate.php) from your \n web site.\n\n-------------------------------------------------------\nPOSTNUKE AND PHPNUKE INTEGRATION\n\nPhpGedView can integrate with PostNuke and phpNuke so that your users do \nnot have to login twice.\n\nAfter you have PhpGedView up and running, you should follow the \ninstructions in the readme.txt file in the pgvnuke folder.\n\nThe files that make the integration magic happen were donated by Jim Carey.\n\n===========================================================\nBACKUP\n\nWith the Backup function in the administration menu, you can make a simple \nbackup of all important PhpGedview files. With this backup, it's possible \nto rebuild your PhpGedView site to the situation at backup time.\n\nThe backup can contain the following files, as selected on the Backup page:\n - config.php with all configuration settings of your installation\n - all GEDCOM files that were present in your installation\n - all GEDCOM options and privacy settings for the above files\n - counters, PhpGedView- and search-logfiles\n - user definitions and options (block definitions, favorites, messages \n and news)\n\nThe files will be gathered into a ZIP file, which can be downloaded by \nclicking the link on the page.\n\nNote: The database itself will not be included in the backup, since it can \nbe rebuilt using the files in the backup.\n\nNote: All pending changes (not approved or rejected yet by the \nadministrator) will be present in the GEDCOM files but can no longer be \nidentified as changes. If the database is rebuilt using the GEDCOMs, these \nchanges therefore can no longer be rejected.\n\nThe Backup function uses the PclZip library, which is written by Vincent \nBlavet and can be found at http://www.phpconcept.net/pclzip.\n</pre>\n\n\n[[Category:phpGedView]]\n[[Category:Administrators Guide]]"
}
]
},
"2899": {
"pageid": 2899,
"ns": 0,
"title": "Recent Changes block",
"revisions": [
{
"contentformat": "text/x-wiki",
"contentmodel": "wikitext",
"*": "The '''Recent Changes block''' will list all of the changes that have been made to the database in the last month. This block can help you stay current with the changes that have been made. Changes are detected automatically, using the CHAN tag defined in the GEDCOM Standard.\n\nThis block shows you the most recent changes to the GEDCOM as recorded by the CHAN GEDCOM tag.\n\n==Developer Info==\n\n; SVN Trunk Link\n: http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/phpGedView/blocks/recent_changes.php?view=markup\n\n[[Category:Blocks]]"
}
]
}
}
}
}