PGVWiki - User contributions [en]

PGVWiki talk:Namespace

2010-06-16T13:14:50Z

Momse: /* genealogy */

==Page types (Namespaces)==
At [[PGVWiki:Namespace]] I explain a little about page types, which are called namespaces in Mediawiki lingo. I would like comment especially on PGVWiki vs. PGV Wiki. Which name is going to be "correct"? I have been using PGVWiki. But now I see the installation is called PGV Wiki. And the logo is split. Maybe I should take a hint? [[User:Tom Haws|Tom Haws]] 07:50, 24 November 2005 (EST)

:In line with the naming conventions used by Mediawiki [[User:Tom Haws|Tom]]is right and that the namespace should be PGVWiki (with a capital W). The default configuration made during installation (using the space), has been changed removing the space so automatic pages will now show PGVWiki without the space. The logo that we are currently using is open for development and the community selecting an appropriate icon. I personally feel that an icon based on the Mediawiki icon of the blue [[ ]] brackets and an image of a tree would look very good. It would also show the wiki's roots (after all we are about family histories). I am not sure you even need the name but if the name is used it should be '''PGVWiki'''. --[[User:Laurie|Laurie]] 08:13, 24 November 2005 (EST)

: (edit conflict) The only rational reason I can think of for why it would have to be PGVWiki instead of PGV Wiki is if we wanted to plan for and be harmonized with a possible pgvwiki domain name someday. [[User:Tom Haws|Tom Haws]] 08:15, 24 November 2005 (EST)

::Thanks, Laurie. Those sound like great plans! If a page is a page ''about PGVWiki'' instead of ''about phpGedView'', it should be prefixed with PGVWiki: This helps us keep a clear mental distinction between the audiences and purposes for our pages. I was also thinking that the pages with no prefix might ought to be called something special like "articles" to distiguish them from all the rest of the stuff behind the curtain. [[User:Tom Haws|Tom Haws]] 08:20, 24 November 2005 (EST)

==Suggested Naming Conventions==
Submitted by --[[User:Laurie|Laurie]] 08:59, 24 November 2005 (EST) 
[[PGVWiki talk:Community Portal|Discussion on this topic has been moved to here]] 
PGVWiki has at this time four (4) areas (shown in sidebar)
:*phpgedview
:*genealogy
:*site help
:*pgvwiki community

===phpgedview===
At present this menu area has a number of sub sections defined. They are
:*Main Page
:*Installation Guide
:*User Guide
:*Administrator Guide
:*How To
:*FAQ

All pages created in these sections should have the phpGedView logo at the top with a line underneath. This shows that these pages are directly linked to phpGedView.

The main page for each of these sections (and any others that are created) will be called the same as the menu name. All sub pages under the sections top page will be named:- SectionName:PageName (please note that there are no spaces before and after the colon).

===genealogy===
All pages created in this section will be start be in the format Genealogy:PageName (please note that there are no spaces before and after the colon).

===site help===
All pages created in this section will be start be in the format Help:PageName (please note that there are no spaces before and after the colon).
===pgvwiki community===
All pages created in this section will be start be in the format PGVWiki:PageName (please note that there are no spaces before and after the colon).

Configuration - Display and Layout - Layout

2010-06-15T14:10:52Z

Momse: /* Surname List Style */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
==Display and Layout - Layout==
====Pedigree Generations====
[[Image:4_layout_1.jpg|left]]
 
Set the default number of generations to display on Pedigree charts.

====Maximum Pedigree Generations====
[[Image:4_layout_2.jpg|left]]
 
Set the maximum number of generations to display on Pedigree charts.

====Maximum Descendancy Generations====
[[Image:4_layout_3.jpg|left]]
 
Set the maximum number of generations to display on Descendancy chart

====Default Pedigree Chart Layout====
[[Image:4_layout_4.jpg|left]]
 
This option indicates whether the Pedigree chart should be generated in landscape or portrait mode.

====Place Levels To show In Person Boxes====
[[Image:4_layout_5.jpg|left]]
 
This sets how much of the place information is shown in the person boxes on charts.

Setting the value to 9 will guarantee to show all place levels. Setting the value to 0 will hide places completely. Setting the value to 1 will show the first level, setting it to 2 will show the first two levels, etc.

====Zoom Boxes on Charts====
[[Image:4_layout_6.jpg|left]]
 
Allows a user to zoom boxes on charts to get more information.

Set to Disabled to disable this feature. Set to On Mouse Over to zoom boxes when the user mouses over the icon in the box. Set to On Mouse Click to zoom boxes when the user clicks on the icon in the box.

====Popup Links on Charts====
[[Image:4_layout_7.jpg|left]]
 
Allows the user to select links to other charts and close relatives of the person.

Set to Disabled to disable this feature. Set to On Mouse Over to popup the links when the user mouses over the icon in the box. Set to On Mouse Click to popup the links when the user clicks on the icon in the box.

====Default Tab to Show on Individual Page====
[[Image:4_layout_8.jpg|left]]
 
This option allows you to choose which tab opens automatically on the Individual page when that page is accessed.

This sets $GEDCOM_DEFAULT_TAB in xxx.GED_conf.php.

====Automatically Expand Sources====
[[Image:4_layout_9.jpg|left]]
 
This option controls whether or not to automatically display content of a Source record on the Individual page.

====Show Events Of Close Relatives On Individual Page====
[[Image:4_layout_10.jpg|left]]
 
Births, marriages, and deaths of relatives are important events in one's life. This option controls whether or not to show these events on the Personal facts and details tab on the Individual page.

The events affected by this option are:

::* Death of spouse
::* Birth and death of children
::* Death of parents
::* Birth and death of siblings
::* Death of grand-parents
::* Birth and death of parents' siblings

====Postal Code Position====
[[Image:4_layout_11.jpg|left]]
 
Different countries use different ways to write the address. This option will enable you to place the postal code either before or after the city name.

====Maximum Number of Surnames====

====Maximum Number of Family Names====

====Surname List Style====

====<del>Break Up Long Lists By The First Letter</del>====

[[Image:4_layout_12.jpg|left]]
 
For very long Individual and Family lists, set this to Yes to split the list into pages by the first letter of their last name.

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

Configuration - Display and Layout - Hide and Show

2010-06-15T14:03:32Z

Momse: /* Show Fact Icons */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
==Display and Layout - Hide and Show==
====Upcoming Events Block Day Limit====
[[Image:4_hide_show_1.jpg|left]]
 
Enter the maximum number of days to show in Upcoming Events blocks. This number cannot be greater than 30. If you enter a larger value, 30 will be used.

The value you enter here determines how far ahead PhpGedView looks when searching for upcoming events. The results of this search, done once daily, are copied into a temporary file.

No Upcoming Events blocks on Index or Portal pages can request more days than this value. The larger you make this, the longer it will take to build the daily database extract, and the longer it will take to display the block, even when you request to display a number of days less than this setting.

====Show Empty Boxes On Pedigree Charts====
[[Image:4_hide_show_2.jpg|left]]
 
This option controls whether or not to show empty boxes on Pedigree charts.

====Allow Users To See Raw GEDCOM Records====
[[Image:4_hide_show_3.jpg|left]]
 
Setting this to Yes will place links on individuals, sources, and families to let users bring up another window containing the raw data taken right out of the GEDCOM file.

====Hide GEDCOM Errors====
[[Image:4_hide_show_4.jpg|left]]
 
Setting this to Yes will hide error messages produced by PhpGedView when it doesn't understand a tag in your GEDCOM file. PhpGedView makes every effort to conform to the GEDCOM 5.5.1 standard, but many genealogy software programs include their own custom tags. See the readme.txt file for more information.

====Add Spaces Where Notes Were Wrapped====
[[Image:4_hide_show_5.jpg|left]]
 
Some genealogy programs wrap notes at word boundaries while others wrap notes anywhere. This can cause PhpGedView to run words together. Setting this to Yes will add a space between words where they are wrapped in the original GEDCOM.

====Show Fact Icons====

====Favorites Icon====
[[Image:4_hide_show_6.jpg|left]]
 
Change this to point to the icon you want to display in peoples' favorites menu when they bookmark your site.

====Show Hit Counters====
[[Image:4_hide_show_7.jpg|left]]
 
Show hit counters on Portal and Individual pages.

====Show Spider Tagline====

====Show Execution Statistics====
[[Image:4_hide_show_8.jpg|left]]
 
Show runtime statistics and database queries at the bottom of every page.

====Show GEDCOM Record Last Change Date on Lists====

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

Configuration - Contact Information

2010-06-15T13:58:35Z

Momse: /* PhpGedView Reply Address */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
====PhpGedView Reply Address====

====Genealogy Contact====
[[Image:4_contact_1.jpg|left]]
 
The person to contact about the genealogical data on this site.

====Contact Method====
[[Image:4_contact_2.jpg|left]]
 
The method to be used to contact the Genealogy contact about genealogy questions.

{{Contact methods}}

====Support Contact====
[[Image:4_contact_3.jpg|left]]
 
The person to be contacted about technical questions or errors encountered on your site

====Support Method====
[[Image:4_contact_4.jpg|left]]
 
The method to be used to contact the Support contact about technical questions.

{{Contact methods}}

{{known_problems|Version 4.1|* The ''PhpGedView sends emails with no storage'' option is mis-labeled and is shown as the ''Mailto link'' option. The ''Mailto link'' option does not exist anymore}}

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

GEDCOM Tags

2010-06-15T09:20:08Z

Momse: /* PEDI */

''This page is currently undergoing changes and each tag is being moved to it's own article. This will help with linking to those terms from other articles etc. Those tags which have already had an article created have a strike through them.''

For those of you who want to know more about the nitty-gritty of GEDCOM files or who would like to be able to read and edit them in your favorite word processor, here are the tags supported by the GEDCOM 5.5 standard.

<strike>
==ABBR==
{ABBREVIATION} A short name of a title, description, or name.

==ADDR==
{ADDRESS} The contemporary place, usually required for postal purposes, of an individual, a submitter of information, a repository, a business, a school, or a company.

==ADR1==
{ADDRESS1} The first line of an address.

==ADR2==
{ADDRESS2} The second line of an address.

==ADOP==
{ADOPTION} Pertaining to creation of a child-parent relationship that does not exist biologically.

==AFN==
{AFN} A unique permanent record file number of an individual record stored in Ancestral File.

==AGE==
{AGE} The age of the individual at the time an event occurred, or the age listed in the document.

==AGNC==
{AGENCY} The institution or individual having authority and/or responsibility to manage or govern.

==ALIA==
{ALIAS} An indicator to link different record descriptions of a person who may be the same person.

==ANCE==
{ANCESTORS} Pertaining to forbearers of an individual.

==ANCI==
{ANCES_INTEREST} Indicates an interest in additional research for ancestors of this individual. (See also DESI)

==ANUL==
{ANNULMENT} Declaring a marriage void from the beginning (never existed).

==ASSO==
{ASSOCIATES} An indicator to link friends, neighbors, relatives, or associates of an individual.

==AUTH==
{AUTHOR} The name of the individual who created or compiled information.
</strike>

==BAPL==
{BAPTISM-LDS} The event of baptism performed at age eight or later by priesthood authority of the LDS Church. (See also BAPM, next)

==BAPM==
{BAPTISM} The event of baptism (not LDS), performed in infancy or later. (See also BAPL, above, and CHR, page 73.)

==BARM==
{BAR_MITZVAH} The ceremonial event held when a Jewish boy reaches age 13.

==BASM==
{BAS_MITZVAH} The ceremonial event held when a Jewish girl reaches age 12, also known as "Bat Mitzvah."

<strike>
==BIRT==
{BIRTH} The event of entering into life.</strike>

==BLES==
{BLESSING} A religious event of bestowing divine care or intercession. Sometimes given in connection with a naming ceremony.

==BLOB==
{BINARY_OBJECT} A grouping of data used as input to a multimedia system that processes binary data to represent images, sound, and video.

'''deleted in GEDCOM 5.5.1'''

<strike>
==BURI==
{BURIAL} The event of the proper disposing of the mortal remains of a deceased person.<strike>

==CALN==
{CALL_NUMBER} The number used by a repository to identify the specific items in its collections.

==CAST==
{CASTE} The name of an individual's rank or status in society, based on racial or religious differences, or differences in wealth, inherited rank, profession, occupation, etc.

==CAUS==
{CAUSE} A description of the cause of the associated event or fact, such as the cause of death.

==CENS==
{CENSUS} The event of the periodic count of the population for a designated locality, such as a national or state Census.

==CHAN==
{CHANGE} Indicates a change, correction, or modification. Typically used in connection with a DATE to specify when a change in information occurred.

==CHAR==
{CHARACTER} An indicator of the character set used in writing this automated information.

==CHIL==
{CHILD} The natural, adopted, or sealed (LDS) child of a father and a mother.

==CHR==
{CHRISTENING} The religious event (not LDS) of baptizing and/or naming a child.

==CHRA==
{ADULT_CHRISTENING} The religious event (not LDS) of baptizing and/or naming an adult person.

==CITY==
{CITY} A lower level jurisdictional unit. Normally an incorporated municipal unit.

==CONC==
{CONCATENATION} An indicator that additional data belongs to the superior value. The information from the CONC value is to be connected to the value of the superior preceding line without a space and without a carriage return and/or new line character. Values that are split for a CONC tag must always be split at a non-space. If the value is split on a space the space will be lost when concatenation takes place. This is because of the treatment that spaces get as a GEDCOM delimiter, many GEDCOM values are trimmed of trailing spaces and some systems look for the first non-space starting after the tag to determine the beginning of the value.

==CONF==
{CONFIRMATION} The religious event (not LDS) of conferring the gift of the Holy Ghost and, among protestants, full church membership.

==CONL==
{CONFIRMATION_L} The religious event by which a person receives membership in the LDS Church.

==CONT==
{CONTINUED} An indicator that additional data belongs to the superior value. The information from the CONT value is to be connected to the value of the superior preceding line with a carriage return and/or new line character. Leading spaces could be important to the formatting of the resultant text. When importing values from CONT lines the reader should assume only one delimiter character following the CONT tag. Assume that the rest of the leading spaces are to be a part of the value.

==COPR==
{COPYRIGHT} A statement that accompanies data to protect it from unlawful duplication and distribution.

==CORP==
{CORPORATE} A name of an institution, agency, corporation, or company.

<strike>
==CREM==
{CREMATION} Disposal of the remains of a person's body by fire.</strike>

==CTRY==
{COUNTRY} The name or code of the country.

==DATA==
{DATA} Pertaining to stored automated information.

==DATE==
{DATE} The time of an event in a calendar format.

<strike>

==DEAT==
{DEATH} The event when mortal life terminates.</strike>

==DESC==
{DESCENDANTS} Pertaining to offspring of an individual.

==DESI==
{DESCENDANT_INT} Indicates an interest in research to identify additional descendants of this individual. (See also ANCI)

==DEST==
{DESTINATION} A system receiving data.

<strike>
==DIV==
{DIVORCE} An event of dissolving a marriage through civil action.

==DIVF==
{DIVORCE_FILED} An event of filing for a divorce by a spouse.</strike>

==DSCR==
{PHY_DESCRIPTION} The physical characteristics of a person, place, or thing.

<strike>

==EDUC==
{EDUCATION} Indicator of a level of education attained.</strike>

<strike>
==EMAIL==
{EMAIL} An electronic address that can be used for contact such as an email address.

'''new in GEDCOM 5.5.1'''</strike>

==EMIG==
{EMIGRATION} An event of leaving one's homeland with the intent of residing elsewhere.

==ENDL==
{ENDOWMENT} A religious event where an endowment ordinance for an individual was performed by priesthood authority in an LDS temple.

<strike>
==ENGA==
{ENGAGEMENT} An event of recording or announcing an agreement between two people to become married.</strike>

==EVEN==
{EVENT} A noteworthy happening related to an individual, a group, or an organization.

<strike>
==FAM==
{FAMILY} Identifies a legal, common law, or other customary relationship of man and woman and their children, if any, or a family created by virtue of the birth of a child to its biological father and mother.</strike>

==FAMC==
{FAMILY_CHILD} Identifies the family in which an individual appears as a child.

==FAMF==
{FAMILY_FILE} Pertaining to, or the name of, a family file. Names stored in a file that are assigned to a family for doing temple ordinance work.

==FAMS==
{FAMILY_SPOUSE} Identifies the family in which an individual appears as a spouse.

<strike>
==FAX==
{FAX} A FAX telephone number appropriate for sending data facsimiles.

'''new in GEDCOM 5.5.1'''</strike>

==FCOM==
{FIRST_COMMUNION} A religious rite, the first act of sharing in the Lord's supper as part of church worship.

==FILE==
{FILE} An information storage place that is ordered and arranged for preservation and reference.

==FONE==
{PHONETIC} A phonetic variation of a superior text string.

'''new in GEDCOM 5.5.1'''

==FORM==
{FORMAT} An assigned name given to a consistent format in which information can be conveyed.

==GEDC==
{GEDCOM} Information about the use of GEDCOM in a transmission.

==GIVN==
{GIVEN_NAME} A given or earned name used for official identification of a person.

<strike>
==GRAD==
{GRADUATION} An event of awarding educational diplomas or degrees to individuals.</strike>

==HEAD==
{HEADER} Identifies information pertaining to an entire GEDCOM transmission.

==HUSB==
{HUSBAND} An individual in the family role of a married man or father.

==IDNO==
{IDENT_NUMBER} A number assigned to identify a person within some significant external system.

==IMMI==
{IMMIGRATION} An event of entering into a new locality with the intent of residing there.

<strike>
==INDI==
{INDIVIDUAL} A person.</strike>

==INFL==
{TempleReady} Indicates if an INFANT - data is "Y" (or "N"??)

==LANG==
{LANGUAGE} The name of the language used in a communication or transmission of information.

==LATI==
{LATITUDE} A value indicating a coordinate position on a line, plane, or space.

'''new in Gedcom 5.5.1'''

==LEGA==
{LEGATEE} A role of an individual acting as a person receiving a bequest or legal devise.

==LONG==
{LONGITUDE} A value indicating a coordinate position on a line, plane, or space.

'''new in Gedcom 5.5.1'''

==MAP==
{MAP} Pertains to a representation of measurements usually presented in a graphical form.

'''new in Gedcom 5.5.1'''

<strike>
==MARB==
{MARRIAGE_BANN} An event of an official public notice given that two people intend to marry.

==MARC==
{MARR_CONTRACT} An event of recording a formal agreement of marriage, including the prenuptial agreement in which marriage partners reach agreement about the property rights of one or both, securing property to their children.

==MARL==
{MARR_LICENSE} An event of obtaining a legal license to marry.</strike>

<strike>
==MARR==
{MARRIAGE} A legal, common-law, or customary event of creating a family unit of a man and a woman as husband and wife.</strike>

<strike>
==MARS==
{MARR_SETTLEMENT} An event of creating an agreement between two people contemplating marriage, at which time they agree to release or modify property rights that would otherwise arise from the marriage.</strike>

==MEDI==
{MEDIA} Identifies information about the media or having to do with the medium in which information is stored.

==NAME==
{NAME} A word or combination of words used to help identify an individual, title, or other item. More than one NAME line should be used for people who were known by multiple names.

==NATI==
{NATIONALITY} The national heritage of an individual.

==NATU==
{NATURALIZATION} The event of obtaining citizenship.

<strike>
==NCHI==
{CHILDREN_COUNT} The number of children that this person is known to be the parent of (all marriages) when subordinate to an individual, or that belong to this family when subordinate to a FAM_RECORD.</strike>

==NICK==
{NICKNAME} A descriptive or familiar that is used instead of, or in addition to, one's proper name.

<strike>
==NMR==
{MARRIAGE_COUNT} The number of times this person has participated in a family as a spouse or parent.</stike>

<strike>
==NOTE==
{NOTE} Additional information provided by the submitter for understanding the enclosing data.</strike>

==NPFX==
{NAME_PREFIX} Text which appears on a name line before the given and surname parts of a name. i.e. (Lt. Cmndr.) Joseph /Allen/ jr.

==NSFX==
{NAME_SUFFIX} Text which appears on a name line after or behind the given and surname parts of a name. i.e. Lt. Cmndr. Joseph /Allen/ (jr.) In this example jr. is considered as the name suffix portion.

==OBJE==
{OBJECT} Pertaining to a grouping of attributes used in describing something. Usually referring to the data required to represent a multimedia object, such an audio recording, a photograph of a person, or an image of a document.

<strike>
==OCCU==
{OCCUPATION} The type of work or profession of an individual.</strike>

==ORDI==
{ORDINANCE} Pertaining to a religious ordinance in general.

==ORDN==
{ORDINATION} A religious event of receiving authority to act in religious matters.

==PAGE==
{PAGE} A number or description to identify where information can be found in a referenced work.

==PEDI==
{PEDIGREE} Information pertaining to an individual to parent lineage chart.

<strike>

==PHON==
{PHONE} A unique number assigned to access a specific telephone.</strike>

<strike>
==PLAC==
{PLACE} A jurisdictional name to identify the place or location of an event.</strike>

==POST==
{POSTAL_CODE} A code used by a postal service to identify an area to facilitate mail handling.

==PROB==
{PROBATE} An event of judicial determination of the validity of a will. May indicate several related court activities over several dates.

==PROP==
{PROPERTY} Pertaining to possessions such as real estate or other property of interest.

==PUBL==
{PUBLICATION} Refers to when and/or were a work was published or created.

==QUAY==
{QUALITY_OF_DATA} An assessment of the certainty of the evidence to support the conclusion drawn from evidence. Values: [0|1|2|3]

==REFN==
{REFERENCE} A description or number used to identify an item for filing, storage, or other reference purposes.

==RELA==
{RELATIONSHIP} A relationship value between the indicated contexts.

==RELI==
{RELIGION} A religious denomination to which a person is affiliated or for which a record applies.

==REPO==
{REPOSITORY} An institution or person that has the specified item as part of their collection(s).

<strike>
==RESI==
{RESIDENCE} The act of dwelling at an address for a period of time.</strike>

<strike>
==RESN==
{RESTRICTION} A processing indicator signifying access to information has been denied or otherwise restricted.</strike>

<strike>
==RETI==
{RETIREMENT} An event of exiting an occupational relationship with an employer after a qualifying time period.</strike>

==RFN==
{REC_FILE_NUMBER} A permanent number assigned to a record that uniquely identifies it within a known file.

==RIN==
{REC_ID_NUMBER} A number assigned to a record by an originating automated system that can be used by a receiving system to report results pertaining to that record.

==ROLE==
{ROLE} A name given to a role played by an individual in connection with an event.

==ROMN==
{ROMANIZED} A romanized variation of a superior text string.

'''new in GEDCOM 5.5.1'''

==SEX==
{SEX} Indicates the sex of an individual--male or female.
That is when you go back in time you cannot always clearly identify the sex of the individual. If there is a doubt, to be sure you must always look for three or even four other references, but never less than two, why two because the reference you are looking at could well have come from the one you are looking at

==SLGC==
{SEALING_CHILD} A religious event pertaining to the sealing of a child to his or her parents in an LDS temple ceremony.

==SLGS==
{SEALING_SPOUSE} A religious event pertaining to the sealing of a husband and wife in an LDS temple ceremony.

==SOUR==
{SOURCE} The initial or original material from which information was obtained.

==SPFX==
{SURN_PREFIX} A name piece used as a non-indexing pre-part of a surname.

==SSN==
{SOC_SEC_NUMBER} A number assigned by the United States Social Security Administration. Used for tax identification purposes.

==STAE==
{STATE} A geographical division of a larger jurisdictional area, such as a State within the United States of America.

==STAT==
{STATUS} An assessment of the state or condition of something.

<strike>
==SUBM==
{SUBMITTER} An individual or organization who contributes genealogical data to a file or transfers it to someone else.

==SUBN==
{SUBMISSION} Pertains to a collection of data issued for processing.</strike>

==SURN==
{SURNAME} A family name passed on or used by members of a family.

==TEMP==
{TEMPLE} The name or code that represents the name OF a temple of the LDS Church.

==TEXT==
{TEXT} The exact wording found in an original source document.

<strike>
==TIME==
{TIME} A time value in a 24-hour clock format, including hours, minutes, and optional seconds, separated by a colon (:). Fractions of seconds are shown in decimal notation.</strike>

==TITL==
{TITLE} A description of a specific writing or other work, such as the title of a book when used in a source context, or a formal designation used by an individual in connection with positions of royalty or other social status, such as Grand Duke.

<strike>
==TRLR==
{TRAILER} At level 0, specifies the end of a GEDCOM transmission.</strike>

<strike>

==TYPE==
{TYPE} A further qualification to the meaning of the associated superior tag. The value does not have any computer processing reliability. It is more in the form of a short one or two word note that should be displayed any time the associated data is displayed.</strike>

==VERS==
{VERSION} Indicates which version of a product, item, or publication is being used or referenced.

==WIFE==
{WIFE} An individual in the role as a mother and/or married woman.

==WILL==
{WILL} A legal document treated as an event, by which a person disposes of his or her estate, to take effect after death. The event date is the date the will was signed while the person was alive. (See also PROBate)

<strike>
==WWW==
{WEB} World Wide Web home page.

'''new in GEDCOM 5.5.1'''</strike>

[[Category:Genealogy]]
[[Category:GEDCOM]]
[[Category:GEDCOM tags]]

PGVWiki:Language requests

2010-06-12T11:58:02Z

Momse: /* Current requests */

==Language Requests==
===Latest requests===
===Current requests===

===Older requests===

User talk:Tom Haws/Archive001

2010-06-09T13:04:17Z

Momse: /* --Laurie 09:36, 21 November 2005 (EST) */

==Preliminaries/Day One==
Tom,

I have not yet figured out the email part of mediawiki. I am also having some server problems this morning. Of all mornings things seem to have gone wrong at home. Never had this problem before. Decided to turn a few services off on my server until I put in some more memory after the weekend.

I can see that you have put in a few things this morning (my time) I have had to reboot twice so sorry. I will monitor it over the next couple of hours as I have to go away for the next couple of days.

Quick tutor on the messageing system might be good.

Laurie

==Feedback==

Had already given myself profile of [[user:laurie|laurie]] but autologins are hard to beat. Well I had a look at your user profile and I am a bit scared about putting mine up there now - run of the mill newbie with little to no idea. Thanks for letting me do this it has been a good learning experience for me so far and hopefully will continue. I told you I had done a bit of work on the wiki to get it going - If time permits today I will do a few more screen captures for the user guide and shove them in.

What are first impressions. How is the speed.

--[[User:192.168.26.1|192.168.26.1]] 10:06, 18 November 2005 (EST)

==Annoymous Editing==

As you can see from my last message to you I have taken your advice and am letting anyone edit.--[[User:Laurie|Laurie]] 10:08, 18 November 2005 (EST)

==Sidebar==

I am the only one who can edit the sidebar for the site. Is there anything else you think should be placed over there--[[User:Laurie|Laurie]] 10:32, 18 November 2005 (EST)

:Not at this time. I will think about it. Maybe I will come up with suggestions for trimming it down if I can think of anything dispensable. [[User:Tom Haws|Tom Haws]] 10:39, 18 November 2005 (EST)

==--[[User:Laurie|Laurie]] 09:36, 21 November 2005 (EST)==
Hi Tom,

Have given you sysop status so you can delete pages etc and edit sidebar.

I had someone make some changes over the weekend in the menus which broke the links - I have fixed it up but it did show me that some people are watching the site. Still working on the Language stuff.

==--[[User:Laurie|Laurie]] 09:40, 23 November 2005 (EST)--==
Just looking at your edits on what people can do on main page. We are starting to duplicate things. Please have a look in the help area as there are already articles on how to edit etc. Need also to talk on your namespacing. I have sent you an email

==site layout==
I have little idea of what "name space" means ... the whole structure seems so fluid and changing, it's hard to keep up.

[[User:Dxradio|Dxradio]] 07:18, 24 November 2005 (EST)

==left hand column==
left hand navigation column has "Atricles"

obviously I can't edit that.

Also the link for "Community portal" just seems to re-direct into its own re-direct ... thereby displaying no useful content.

[[User:Dxradio|Dxradio]] 09:54, 24 November 2005 (EST)

Installation Guide v4.1.x/Archive 1

2010-06-09T08:02:06Z

Momse: /* Apache */

== Page Contents ==

Being new to PGV, When I go to the Installation page I expect to get straight to the point and see details of what is needed to get PGV installed and running.

I probably only expect to see headings such as the ones below. I think the Intro and general text about what PGV is and what what it's used for are better placed outside the installation guide - for example they could go into the Main_Page or a page linked it.

I can make these changes myself, but it will need some pretty big edits so I wanted to see what people thought.

===PhpGedView Prerequisits===
The following headings briefly describe what the software is and where to get it.
====Web Server====
=====Apache=====

=====Others=====
====PHP====
====MySQL====
===Optional Prerequisits===
====GD Library====

===Installation===
The following headings have details about how to install each of the components listed above for several OS's
===Linux===
====Debian====
====Other====
===Windows===

===Post-Installation Configuration===
This sections deals with all post-installation configurations that are common to all/most OS's.
====OS Specific Configurations====
This section has details of any OS specific configurations.
====Windows====
====Linux====
====Other====

== Some comment ==

I agree that this page needs a cleanup (along with the readme file). It's supposed to be an Installation Guide, not a Reference. Let's keep it simple and link to more information if needed.
* I believe there are tools for doing wiki-to-text conversions. It might e worth maintaining documentation online and simply doing wiki-to-text conversions at release time. --[[User:Nathanhaigh|Nathanhaigh]] 06:35, 5 October 2007 (EST)
<ol>
<li>The info about the versions is really important only to those who upgrade, and should be merged with the upgrade chapter (most of Chapter 2). It's safe to assume that new users are going to install the newest version available.</li>
<li>Instead of Beginners vs. Intermediate (Advanced, More Advanced etc.), let's have a Quick Install.</li>
<li>Things you need + xxx Preparation = Requirements / Prerequisites. "Optional Prerequisites" sounds like oxymoron to me :)</li>
* Yes it is a bit! Oh well, you got my meaning! --[[User:Nathanhaigh|Nathanhaigh]] 06:35, 5 October 2007 (EST)
<li>Some information in Chapter 3, like themes or languages, would make a great Configuration chapter. The rest, like database tables or non-standard codes, doesn't belong there.</li>
<li>Chapter 4 belongs to Developers Guide.</li>
<li>Licensing info usually comes last.</li>
</ol>
To sum up, I would have: short introduction, quick install, requirements, installation, upgrade, post-install tasks / configuration, and license. I don't think that division by OS is necessary, all you need to know is how to copy files and change their permissions under your OS, and you probably already know that. I would do without OS-specific (and other) screenshots, too - just to make it short and sweet.
--[[User:Cathy|Cathy]] 04:26, 5 October 2007 (EST)
* In essense, it needs to e concise and deliver what you expect from an Installation guide; otherwise people just won't get past the first couple of paragraphs. I'll make a start tomorrow by doing some shuffling and reorganising into the above mentioned headings. Thanks for your input. --[[User:Nathanhaigh|Nathanhaigh]] 06:35, 5 October 2007 (EST)

Code cleanup

2010-06-07T17:08:14Z

Momse: /* PHP */

This article is intended to provide up-to-date information about '''code cleanup''' issues, progress and which developers are working on particular areas. This article has arisen out of at least one thread on the [https://sourceforge.net/forum/forum.php?forum_id=185165 Open Discussion forum]:
* https://sourceforge.net/forum/message.php?msg_id=4744150

== Article Organisation ==

* Please try to help keep this article from exploding in length by providing suitable links to other web resources/information. Also, for possible discussions, use the [[Talk:Code cleanup|discussion]] page.

* Also, try to use links to relevant directories/files in the [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/ development branch] of the [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/ SVN repo] as this is where most of this work will be done before merging it to the [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/ trunk].

== Consolidating/Separating Programming Languages ==

Separating the code of several programming languages is advantageous for clean, easy to follow code with minimal redundancy. This make it easier to maintain, modularise and for new developers to get involved as it will be another step closer to pure [[MVC]].

=== HTML ===

One way (please add others if you know them) to separate out HTML (View in [[MVC]]) from the PHP application code is by using a [[w:Web template system|template engine]]. The application code does not concern itself with how the data is to be displayed as this is the job of the template. Thus programmers can concentrate on the code and templates can be designed independently to provide different views to the end user - easier for theming/skinning. A good thing in any programming.

Cons for template engines in general:
* An external dependency - We'd simply add the library to the vendor_branch and include it with PGV. This would allow us to easily update the library when new releases are made by the vendor. Possibly using some sort of check to see if the user has a more up-to-date version.
* Could there be a speed impact?
** I just made a quick speed test with "[http://httpd.apache.org/docs/2.0/programs/ab.html ab]" (the content is a table with list of INDIs from a PDO db or declared array (to check DB overhead)) ("ab -n 100 -c 1", average of 3 tests):
{| class="wikitable"
|-
! Test
! Requests/sec
|-
|PHP + Smarty + DB
|11.22
|-
|PHP + print() + DB
|11.39
|-
|PHP + Smarty + array()
|11.98
|-
|PHP + print() + array()
|12.31
|-
|Pure HTML (generated file)
|911.68
|-
|}
I think that using PHP's [http://www.php.net/manual/en/language.oop5.php OO] abilities gives a huge overhead already and adding a template engine would not increase the request times significantly. --[[User:Korbendallas1976|Korbendallas1976]] 00:52, 2 February 2008 (EST)
* ...

Below is a table for people with any knowledge of template engines to add pros/cons. Our aim is to try to find a possible solution to separating out the view aspect of [[MVC]], one of which could be a template engine.

Suggestions to moving to a template engine such as [[w:Smarty|Smarty]]. Please add other options below and we can collate pro's and con's for them. There is an open [https://sourceforge.net/tracker/index.php?func=detail&aid=1234551&group_id=55456&atid=477082 RFE for a Template System] that contains some arguments. A [https://sourceforge.net/search/?group_id=55456&words=Smarty&type_of_search=forums&limit=100 search for Smarty in the forums] will show some arguments related to this.

{| class="wikitable" style="text-align:center;"
|-
! Option
! Website(s)
! Pros
! Cons
|-
| [[w:Smarty|Smarty]]
| style="text-align:left" |

* http://www.smarty.net/whyuse.php
| style="text-align:left" |

compiles to PHP, caching, functions, plugins
| style="text-align:left" |

[https://sourceforge.net/forum/message.php?msg_id=3352922 John's Comment #1], [https://sourceforge.net/forum/message.php?msg_id=4636705 #2],
[https://sourceforge.net/forum/message.php?msg_id=3354129 #3],

|-
|}

[http://www.whenpenguinsattack.com/2006/07/19/php-template-engine-roundup/ Here] is a list of 25 template engines for PHP.

Apart from the links to John's comments this seems to be moving to a discussion about 'which' template engine should be used. I have no experience of any, but feel we should first decide whether a template engine is necessary / useful or not, before thinking about which one. Can anyone help explain their virtues? John has described their pitfalls pretty well.

=== JavaScript ===

Needs to be gleamed out of various output methods and HTML files into <tt>.js</tt> files which are then used in the HTML header section where they belong.

=== SQL ===

A collection of lots of SQL statements (like those for creating the tables) belong in their own <tt>.SQL</tt> files to separate languages (like HTML from PHP). It is also advisable to group all - or most - other SQL in a single file that provides functions to call from the outside - for easier debugging. This should be part of the Model anyway.

== Getting MVC Right ==

A great example that badly needs it is the whole import process (I would love to see the ability to develop a command-line import tool).

=== Model ===

Defines an API through which the data of the software can be accessed. This defines everything, from the relations to types, ranges and meta-data. How this data is then stored is the sole concern of the Model, as long as it is uniformly accessible through the API (it can be stored in a DB, a text-file, XML - you name it). Parsers and serialisers thus belong in the Model. If done correctly, we should be able to create unit tests for the API which can be run frequently to ensure the smooth, "bug free", stable running of this part of PGV.

I am not sure about having two storages for the model as is currently the case in PGV (DB and the Gedcom file) because this introduces a whole lot of sync trouble (which one is to be trusted if they are not in sync?). Since the DB is of course a whole lot faster than parsing the Gedcom every time, maybe they should only be synced when the gedcom is im-/exported. - '''Can someone clarify how the GEDCOM file and DB are used and synced etc during the use of PGV?'''

: (Answer: Data is stored at gedcom level 0 record level. Hence all updates replace one level 0 record with a new version. After each update to the database (following the acceptance of an change), the old record is located in the disk-based file, and replaced with a new record. If the sync-gedcom-file option is turned off, then this action does not occur. The gedcom obtained from the download option will be different to the contents of the file on disc; line endings, record order, header contents, etc. Also, failed file updates are ignored, so the DB copy should always be regarded as the master copy. This process requires that the full file is loaded into memory (plus a second post-edit copy), which can blow the PHP memory limits for large gedcoms.)
:: My question would then be, why is this required? Is it because it's a relic of when PGV used flat file indicies? Couldn't it all be done in a database, then when someone wants to export a GEDCOM (or any other plugable format for that matter), they click a button and the contents of the database are set to the browser for download in the requested format?

Using classes is not the same thing as OO. OO requires other important concepts such as abstraction and data-hiding. Classes should have a clear well defined function and behavior that forms part of an API for which Unit tests can be written.

==== Classes ====

As I see it, we should have classes that represent the data all inheriting from a GEDCOM base class. These "data classes" are simple representations of the data (i.e. they don't need to know that the data has come from a GEDCOM file or some other place entirely) with simple getters/setters for that data. There would be other classes dealing with IO from different file formats, storage backends etc. It would be the responsibility of the "IO classes" to know the structure of the file format, DB backend etc and create the "data classes" from that data or visa versa.

Here is a list of websites I found dealing with a GEDCOM model:
* http://freepages.history.rootsweb.com/~mitchellsharp/
* http://www.softwarerenovation.com/igenie/
* http://freepages.history.rootsweb.com/~mitchellsharp/gdmref/gdmref-01.pdf

; Comments
: I have just performed a global search for the string INDI and counted those files where the string appeared to be used in the context of the GEDCOM file format. Ignoring language files I came to a rough estimate of 67 files where a detailed knowledge of the GEDCOM file format is embedded. One could argue that data abstraction is even more important than MVC. For a newcomer to the code this is also an issue that makes the code difficult to understand. A typical example (from person_class) is:
$famlink = get_sub_record(1, "1 FAMC @".$family->getXref()."@", $this->gedrec);
$ft = preg_match("/2 PEDI (.*)/", $famlink, $fmatch);
Presumably at some stage in the future, whether in 1, 2, 5 or 10 years time an improved GEDCOM format will appear (GEDCOM XML is already specced). Is this area of data abstraction for the GEDCOM format one that should be treated as a priority in the Code Cleanup? Conveniently of course what you end up with is a good chunk of what is known as the Model in the latest Three Letter Acronym.

=== View ===

Describes a "View" of the Model, that is, a particular way of looking at it, as for example, the source-code-view or the UML-view (in the case of code). The view does not concern itself with anything else, e.g. security, just with how to represent the data. Views are exchangeable (i.e. pluggable), and get their data from the Model, so as soon as you change something in one view, the other views of the same data change accordingly. Themes and a little bit more for that matter, belong in the View.

We should remove all presentation and layout from the HTML and put it in CSS.

; Comments
: Any construct of any complexity should have a comment at its end to help match the end to the beginning. Examples:
} // if edit allowed
</div>
: DOM elements should begin and end in the same function or even the same set of braces. Hard to change a set of table rows/cells to a set of divs when the the parts and the tags between them are printed from a utility function.

=== Controller ===

<tt>*_ctrl.php</tt> in the [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/includes/controllers/ controllers] folder should not be concerned with the printing/displaying of content. The ''controller'' in MVC is intended to glue the ''model'' and ''view'' parts together and provides all the programming logic behind the app, like security, user management, file management and the like.

=== Unit Tests ===

Unit tests are short (or not so short) scripts that sets up appropriate objects required for the test, and systematically checks that the return value from a method is what was expected i.e. correct. Different method arguments should be used, particularly for boundary conditions to ensure that as many routes through the code are covered (e.g. both sides of an ''if'' statement are tested).

A proper unit test framework will run the required test suite(s) and summarise the results as the number of passed tests along with details of those that failed. We are currently, using [[SimpleTest]] as our testing framework as it is both PHP4 and 5 compliant and has the ability to test web interfaces. However, the current lack of correct abstraction of objects has hindered the development of simple unit tests.

==== Test First Development ====

The tests are written first i.e. before the code itself. While this seems counterintuitive, it helps focus the mind on developing a suitable API and allows you to have a good test suite from the start. For example, the pseudocode of a single unit test may look like this:
$test->assertsTrue( $dog->canBark() )

All this does is to ensure the <code>canBark()</code> method of the $dog object returns ''true''. We know that a ''dog'' can bark, so we expect this test to pass. It doesn't matter how the method actually works, we simply want to know if the API works as expected given the relevant input to the various methods - thus we can write the unit tests and design an API at the same time. This also helps us to think about whether the method internals are hidden to the programmer using the classes via the API (a good thing). If for some reason, it returns ''false'' then this test fill fail and we fill be provided details about the failure so we can fix the method.

What this means, is we can write tests first, and then write the method code and refine it until the test passes. In the absence of any other information we might come up with the following code for <code>canBark()</code>:
function canBark() {
return true;
}

If however, we know a dog could be ''mute'' and thus cannot ''bark'' like a normal dog, we might write a test (thus defining an API at the same time) like:
$test->assertsTrue( $dog->canBark() );
$dog->setMute(true);
$test->assertsFalse( $dog->canBark() );

First, we are saying a dog can bark by default. Then we use <code>setMute(true)</code> to say the dog can no longer ''bark''. These tests now check that <code>canBark()</code> returns the correct values but also tests (indirectly) if the <code>isMute(true)</code> method correctly sets the dog to being a ''mute''. Now, we rewrite our methods until the tests pass:
function canBark() {
if ( isMute() ) {
return false;
}
return true;
}

function setMute($value) {
$this->mute = $value;
}

function isMute() {
return $this->mute;
}

While there may be other ways to write the code, and still have the tests pass, what we have done by writing the tests first, is to start creating the API while the implementation is hidden (as it should be). Thus, we may go away and totally rewrite the code underlying the API, but as long as the tests continue to pass, we don't really mind about the implementation.

==== Running Tests ====

Unit tests are run frequently to ensure any code changes do not have any adverse affect on the outcome of the tests. Thus ensuring new bugs are not introduced. Where bugs are found, we first write a unit test that exposes the bug while testing for the correct outcome. Then we go away trying to fix the code until the test passes but also ensuring that other tests don't start to fail. Once we achieve this, we have fixed the bug, and have included a test to ensure it doesn't raise it's ugly head again. Thus, over time, a test suite will fully stress test the code (proving that the code does what we say it does) and give confidence that we are as bug free as possible while ensuring that development time doesn't go into fixing bugs that reappear down the line.

== GEDCOM Parser ==

There are two locations in the code where a GEDCOM file is parsed (--GEDCOM functions-- in [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/includes/functions.php?view=log functions.php] and in [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/includes/functions_import.php?view=log functions_import.php]). This process is very complicated and thus error-prone because it uses RegExes for the parsing. This should be done by a using [[w:Lexer|lexer]], which are used in compilers. [http://pear.php.net PEAR] has classes for parser- and lexer-building which is all that's needed. I'm sure lexers can handle international character issues as well.

== Modules to Plugins ==

The current approach does not define enough hooks to make PGV really customizable. The very existence of remedy code in the general code-base for the most common modules like [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/individual.php?revision=2459&view=markup#l_521 googlemap] or [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/individual.php?revision=2459&view=markup#l_232 lightbox] (in [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/individual.php?view=log individual.php]) is witness to this. The ultimate goal is for plugin writers to not have to touch or modify any code of the 'core' - preventing them from breaking anything and allowing the core developers to change the underlying functionality without breaking any of their plugins' code. That is, the mod does not have to be re-inserted into every new release. For that hooks need to be defined for every little function call in PGV, every section of the output, in effect - for everything. Look at [http://wordpress.org WP] or [http://gallery.menalto.com G2] for examples.
'''We need to compile a list of all possible locations in the code for hooks.'''
It does require some effort on the part of the developers, though, for defining a sensible API that is reasonably stable over long periods of releases (again Unit tests can help ensure it remains stable).
:* Sorry for being dim-witted....but, could you explain what you mean by a hook? --[[User:Nathanhaigh|Nath]] | [[User talk:Nathan_Watson-Haigh|Talk]] 23:27, 1 February 2008 (EST)
:** See the - rather short - [[w:Hooking|article]] in wikipedia. In Programming a hook is generally a specific place in the code where plugins can 'hook' in. For this the plugin programmers define functions and register them with the software for specific hooks. The hokee keeps a list of hooks and functions that are registered for them and makes sure to call the right functions when that place in the code is reached. If there is more than one plugin registered for a hook they get called sequentially (in the order they registered). By using the hook plugins are then able to be notified of something or change something. For that purpose it gets called with the information that is relevant and can decide what to do. For example when a user gets created, plugins can get notified, or before and after the template is rendered into HTML - thus giving plugins the ability to change the output. In WP, for example, there is a hook that gets passed every blog entry before output. It is used also by the core for some modifications to the final output - like HTML-specialchars, NL2BR-ing or linkifying.

== General Organisation ==

General organization: Files ending in <tt>.php</tt> should be files that need to be executed directly in the browser, like <tt>index.php</tt> or <tt>individual.php</tt>. These - and only these - should reside in '/'. Every other file that is included by the main files should reside in a logically named subfolder (<tt>includes</tt> for example) and have an ending of <tt>.inc</tt>, class files by convention have the ending of <tt>.class</tt>; thus preventing them from being executed and accessed directly. Files that logically belong together should be placed in the same subfolder; all files comprising the back-end (admin functions) should be in a folder named something like <tt>admin</tt> or <tt>pgv-admin</tt>. This makes it clearly visible to anyone what function can be found where and also which part of the HTML output comes from where.

; Comments
: I agree with many of the conventions mentioned, but ask that the files retain the .php extension. If the webserver does not recognize the file type, it will do one of two things:
# serve it as plain text. This would allow hackers who know the file layout to read our settings
# serve it as a binary file. This prompts visitors to download the file. Once on their local machine, it is readable by any text editor.
Instead, I suggest two levels of extensions, based on the function of the file. As an example, the filename gedparser.class.php clearly shows that it contains a class used to parse GEDCOM.

: Followup: Since PGV is an open-source project, anyone can go to phpgedview.net, download the source and then know our file layout, and '''even''': The contents of those files.
: And because of that you put all the relevant settings in a file appropriately named config, which is the only file that needs to be protected - which is why it is mostly a .php file that displays nothing. The thing that you do not want, is that people are able to execute all those files directly, which is a greater security risk than them reading them. And by making all files have a .php ending you just allowed them to. Because then all you need is one file that does not rigorously check if it was executed or included and you have a much bigger security risk than you would have, had the user just seen the source code (which he can get anyway). Now the attacker can pass variables, try to set options etc.

== SVN ==

Lots more line breaks. SVN can't merge two unrelated changes when they are both in different parts of the same mile long line of code.

== PHP ==

Do we drop support for PHP4 and go with PHP5?

We should use PHP's multibyte and internationalisation libraries instead of wasting time on our own slow/broken version.

== DBMS ==

Store everything in the database. This means everything. It includes all the stuff we currently store in files. We need a data model that models the data, not one that models gedcom files. This will mean dropping support for synchronised gedcom files (which would be a good thing in itself).

Images (inc thumbnails) can easily be stored in a BLOB together with some basic file info/meta-data.

- I don't think we should require people to store images in the database as hosts generally give more space to the filesystem than they do to the db. Also, FTP can be used to upload images to the filesystem. --[[User:Ljm|Ljm]] 09:25, 2 February 2008 (EST)

== Miscellaneous ==

* Replace print_XXX() with print XXX() to prevent this sort of construct:

ob_start();
print_list_person(...);
$indi=ob_get_contents();
ob_end_clean();

== Stakeholders ==

Here is a list of possible stakeholders outside the PGV dev team, that should probably be consulted about their experiences with PGV code.

; Drupal Integration
: http://drupal.org/project/phpgedview

; Joomla Integration
: http://joomlacode.org/gf/project/phpgedview/

== Road Map Questions ==

Things that need to be considered/decided for the development of a road map are things like:

* When do we move to support PHP5 and drop PHP4 support? With PGV 4.2?
** If we move to support only PHP5, do we use this opportunity to make changes that will not be backward compatible?
* Should a branch be made (from the current dev branch or trunk) where changes can be made which will not be backward compatible and devs that want to make major changes can?
* Others? I'm sure, please add them here.
* I think PGV 4.2 could be the bells&whistles version of the GEDCOM-based 4.X line. The new PGV "5" does not need to be backward compatible, so migrating is easier (GEDCOM export/import and some DB scripts to recover data from the "old" 4.X installations).
:* I like this idea: PGV 5.x for supporting PHP5 only and PGV 4.x for the last version supporting PHP4. So how much development effort are people going to put into the 4.2 branch and how do people see this fitting in with starting a 5.1 branch for more of a rewrite or big code cleanup (whichever is easier)? --[[User:Nathanhaigh|Nath]] | [[User talk:Nathan_Watson-Haigh|Talk]] 22:07, 31 January 2008 (EST)

== Road Map ==

{{main|5.x Roadmap}}

I propose the following as a overview of a possible roadmap (not complete). It might be good for us to team up and have a detailed look at specific items (getting further input from appropriate devs) and make a short report (in the form of a wiki page) to the rest of the devs. Please add specific taks you'd like to be looked into in detail.

=== SVN ===

# We might want to make a temp branch where we can commit code/script examples etc that demonstrate a particular feature, benchmark, test etc

=== Backend Review ===

# Review the DB structure
#* Does it satisfy our current needs?
#* Does it satisfy our future needs?
#* Do we need a redesign? If so, can we use any of the UML diagrams from as a basis or in their entirity:
#**http://freepages.history.rootsweb.com/~mitchellsharp/
#** http://www.softwarerenovation.com/igenie/
#** http://freepages.history.rootsweb.com/~mitchellsharp/gdmref/gdmref-01.pdf

=== API to Backend ===

# Are we only ever likely to want to use a DB backend? i.e. Do we need to think about having an API to a generic backend which allows us to change the backend with a simple configuration change?
#* If so, can our data classes be uncoupled from from a specific backend?
#* How could/is this be done? Is this done by extending the data classes to tie them to a backend somehow - I'm a bit confused how the model is tied to a backend.
# One option might be something like: '''E'''a'''s'''y '''P'''HP '''D'''ata '''O'''bjects [http://www.ezpdo.net EZPDO].

=== Data Classes/API ===

# How many current classes are sufficiently uncoupled from the backend, IO and business logic (e.g. privacy) to be used with little effort?
# How much current code can be used as is?
# How much current code could be used with a small amount of code change?
# How much current code would need redesigning?
# We should aim to come up with a suitable API '''before''' writing the code for the classes. This will allow us to really think how a programmer ''should'' use our classes and allow us to write unit tests before the code i.e. [[w:Test-driven_development|test driven development]].

=== Important PGV Features to Consider ===

# [[i18n]] - internationalisation
#* Support for [[RTL]] langauges
#* [[UTF-8]] Support
#* PEAR Packages:
#** [http://pear.php.net/package/Translation2/ Translation2]
#** [http://pear.php.net/package/I18Nv2/ I18Nv2]

== Interested Developers ==

If you're interested in helping out with things detailed on this page, please add your name with a link to your PGVWiki user page below. Please also included relevant contact details and a brief overview of your skills on your user page so others know how you might be able to help.

'''Could you now sort yourself under all heading you think you will be able to make the most contributions towards or are most interested in helping out (add new headings you you think it necessary).'''

* [[User:fisharebest|fisharebest]]

* [[User:Nigelo|kiwi_pgv]]

* [[User:windmillway|windmillway]]

* [[User:(Tee)derDoc|Vitus]]

* [[User:bderrly|bderrly]]

=== DB Backend ===

* [[User:Nathan Watson-Haigh|Nathan Watson-Haigh]]

=== MVC ===

==== Model ====

* [[User:Nathan Watson-Haigh|Nathan Watson-Haigh]]

==== View ====

==== Controller ====

=== Testing ===

==== Unit Testing ====

* [[User:Nathan Watson-Haigh|Nathan Watson-Haigh]]

[[Category:Developer resources]]

Model-View-Controller Architecture

2010-06-07T17:03:06Z

Momse: /* View */

Note: This document is out of date and an updated description of the [[PhpGedView]] [[Architecture]] can be found on the [[Architecture]] page.

[[PhpGedView]] attempts to follow the '''Model-View-Controller (MVC) architecture'''. The goal of an [[w:Model-view-controller|MVC]] architecture is to separate the data model, the business logic, and the user interface from each other. This means that you don't have business logic in the presentation or your data model and that your presentation can operate completely independent of the underlying data model.

__TOC__

{| class="wikitable" style="text-align:center"
|+ Illustration of the architecture stack, showing the different PhpGedView layers that make up the MVC components
|-
| colspan = 2 | Presentation (HTML, CSS, JavaScript, PDF)
| rowspan = 2 | View
|-
| colspan = 2 | HTML Generation
|-
| colspan = 2 | Privacy Filters
| rowspan = 2 | Controller
|-
| colspan = 2 | PhpGedView Functions
|-
| colspan = 2 | Record Cache
| rowspan = 3 | Model
|-
| Index Files
| PEAR SQL Database
|-
| colspan = 2 | GEDCOM 5.5
|}

The data model is built up around the GEDCOM 5.5 specification. The controller consists of an API written in PHP that allows access to the data model, privacy filtering, and generation of the user interface (UI). The UI delivered in the view layer is sent to the browser as HTML, CSS, and JavaScript.

==Data Model==

The foundation of the data model is the [http://www.phpgedview.net/ged551-5.pdf GEDCOM 5.5 specification]. Diagrams of the GEDOCM 5.5 data model can be seen at:

* http://homepages.rootsweb.com/~pmcbride/gedcom/55model1.gif
* http://homepages.rootsweb.com/~pmcbride/gedcom/55model2.gif

[[image:SQL_DB_Model.gif|250px|thumb|The database model]]

The GEDCOM specification defines several records such as [[INDI]], [[FAM]], and [[SOUR]] which reside at level 0 in the file. These level 0 records are parsed from the Gedcom file into PHP array structures. These array structures are then indexed in a serialized index file (PhpGedView <= vX.Y.Z), or in SQL database tables (PhpGedView >= vX.Y.Z). One of the fields in these arrays keeps a copy of the original Gedcom record as it was parsed from the file. This allows for the greatest compatibility and ensures that no data is lost during the Gedcom file import. To further improve performance, an in-memory record cache layer is used to reduce the number of database queries. In fact, the record cache is simply the unserialized version of the index files. So in index mode, everything is running on the cache, while in SQL database mode, the cache is built-up as the scripts run.

The SQL database model is composed of five main tables: [[pgv_individuals]], [[pgv_families]], [[pgv_sources]], [[pgv_other]], and [[pgv_users]]. The [[pgv_individual]] table holds information for level 0 [[INDI]] records. The [[pgv_families]] table holds information about level 0 [[FAM]] Gedcom records. The [[pgv_sources]] table stores information parsed from level 0 [[SOUR]] records and the [[pgv_other]] table catches all other level 0 records (eg. [[NOTE]], [[REPO]], and [[OBJE]]) that are not stored in the other tables. The [[pgv_users]] table contains all of the information about PGV users and is not parsed from the Gedcom file.

==Controller==

The controller layer provides an [[w:API|API]] through which you can access the data from the Gedcom. A JavaDoc style reference of this API can be found online at http://www.phpgedview.net/devdocs/api/.

Before any data is sent to the UI, it must first pass through privacy checks. These privacy checks determine what the user at the UI can access based on privacy settings established by the site administrator.

==View==

The User Interface is sent out to a client browser in rich dynamic HTML. One of the goals of the PhpGedView project is to try and give the user more information on the screen at a time, so that they can get at more data without losing their current context and without many clicks.

We make the UI even more interesting through CSS which allows themes to be defined. Through the themes, site administrators can completely change the look and feel of the site without modifying the code.

===User Levels===

The following table show the different user levels in the PGV system and what they have access to:

{| class="wikitable"
|-
! User Level
! Description
|-
| Public visitor
| This is a public visitor that has not authenticated by entering a username and password. Default privacy settings do not give them access to the data of living people. They cannot edit data.
|-
| User
| This is an authenticated user. They will have access to the MyGedView portal and can view private data depending on privacy settings.
|-
| Editor
| This is an authenticated user who has been given editing privileges. They will be able to edit anything that they can see. Their changes will still need to be accepted by a user with higher access privileges.
|-
| Acceptor
| This is an authenticated user who has edit privileges, but who can also accept or undo changes into the database.
|-
| Gedcom Admin
| This is a user who can accept changes and also administer Gedcom configuration and privacy settings.
|-
| Site Admin
| This user can do and see anything on any Gedcom in the site and can create new users.
|}

===Editing===

There are currently two methods of online editing. The first is through HTML forms at the UI layer. The second is through Web Services at the control layer. Any changes to the data are made at the bottom GEDCOM layer of the architecture stack in the actual Gedcom file. They remain at this level until they are reviewed and accepted by another user. When changes are accepted they bubble up into the database and index file layers.

== To Merge in with rest of article ==

PGV is a document centric architecture. The documents are GEDCOM records. The only reason we need a DB at all is so that we can quickly lookup and search for the GEDCOM records. So our objects are representations of GEDCOM records, not of the DB.

The PGV architecture consists of a stack of layers. Each layer should communicate with the layers "near" it. The application layers (from lowest to highest) are:
1. GEDCOM
2. DB
3. CACHE
4. PRIVACY
5. OBJECTS
6. HTML GENERATION

1. GEDCOM layer is the lowest level and all data is stored in the GEDCOM format.

2. The DB Layer provides a fast convenient way to index the GEDCOM and look up the records. It breaks them up into level 0 records and indexes various portions of them. Originally we didn't have a DB layer. In fact the very first version of PGV only had the levels 1, 4, and 6 and worked directly with the GEDCOM file. For performance on large files we added the DB and originally had an "index" mode which was able to look up the GEDCOM records from PHP indexes. Index mode was eventually dropped because it doesn't scale and it doesn't allow for the complicated searching that we do now. Index mode also didn't move well into allowing online editing. The DB layer functions are encapsulated in the functions_db.php file.

3. The CACHE layer provides an in memory cache of records that are pulled from the database. This reduces the number of calls to the DB. (The DB is the greatest bottleneck). The cache is stored in global variables such as $indilist, $famlist, $sourcelist, etc. The find_* methods in functions_db.php first check the cache before going to the DB.

4. The PRIVACY layer provides the API to make sure that the user has sufficient privileges to view/edit the data. This api is provided by the functions_privacy.php file. There has been much debate over the position of this layer in the stack. In the future it will probably be moved down between the DB and CACHE layers. It is here because user's wanted to be able to see statistical information of how many records are hidden.

5. The OBJECT layer provides convenience methods for working with GEDCOM. It also automatically privatizes the data. So when you create a new Person you give it a GEDCOM document:
//-- lookup the person's record from the cache or the DB
$indirec = find_person_record("I1");
//-- create an instance of Person object from the record
$person = new Person($indirec);

Now we also don't want to be creating Person objects all of the time, so we also store them in the cache. To access them from the cache or create them we have implemented a factory pattern using the static getInstance() methods on the various classes:
$person = Person::getInstance("I1");

Person class extends a more generic GedcomRecord class. So you can ask it for an object of any level 0 GEDCOM record and it will return an instance of the appropriate class for that type.

$repo = GedcomRecord::getInstance("R1");
$person = GedcomRecord::getInstance("I1");
$source = GedcomRecord::getInstance("S1");
// etc.

6. HTML/Presenation Generation. All other pages should operate at this level and work with the OBJECT level just below it. Some pages may go down to level 2 for searching or other DB related stuff. Now there is a *LOT* of legacy code which works with the APIs at the lower layers. They haven't been updated because they work the way they are.

[[Category:Developer resources]]

XML Report Templates

2010-06-07T17:00:09Z

Momse: /* PGVRRepeatTag */

=Tags=
==PGVReport==
The root node that starts a PGV report template.
*'''access''' - The PGV user access level for this report. This corresponds to the options available for privacy settings. Possible values are: PGV_PUBLIC, PGV_USER, and PGV_NONE.
*'''icon''' - The PGV icon to use in the menus for this reports as defined by the theme.php file.

==PGVRTitle==
The title of this report. The title will appear in the list menu items.

==PGVRDescription==
A textual description of this report.

==PGVRInput==
Setup an input variable for the UI which will make the user input available as a variable later in the report. Attribute Description
*'''name''' - The name of the variable.
*'''lookup''' - Tells the UI that the value for this input can be looked up from a list. Possible values are: INDI, FAM, SOUR, PLAC, and DATE.
*'''type''' - Tells the UI generator what type of input this is. This allows you to specify whether you want a textbox input or a checkbox or a select drop-down list.
*'''default''' - The default value that should be filled into the field.
*'''options''' - For an input of type "select" this allows you to set which options are available to select from in the drop-down list. The options should be entering in a comma seperated list (ie. NAME,BIRT).

==PGVRStyle==
Setup an text style that text elements may reference to set the font style used when they are rendered. This is very similar to class stylesheets in HTML. The fonts that are available to you are the 12 fonts that come standard with Adobe Acrobat and the LucidaSans font included with the project. Note that to avoid including the font in the PDF report, the LucidaSans font will be interchanged with Arial for reports that do not contain any special characters. For reports that do contain special characters, only the LucidaSans font can be used.
*'''name''' The name you will use to reference this style.
*'''font''' The name of the font that should be used.
*'''size''' The size of the font in pt.
*'''style''' Bold or Italicize the font, (not available with the LucidaSans font). Appropriate values are: B, and I

==PGVRDoc==
This is the main tag that signals the start of the report document.
*'''pageSize''' The size of paper for this report. Possible values are: A3, A4, A5, Letter, Legal
*'''orientation''' Whether this report should print portrait or landscape (P or L)
*'''margin''' The size of the margins in pt.

==PGVRvar==
Lookup and return the value of the given variable. The variable can be one of the many internal PGV variables, one of the user input variables, or a variable set with PGVRSetVar
*'''var''' The name of the variable to lookup

==PGVRvarLetter==
This is the same as the PGVRvar tag, except that it only returns the first letter of the variable.
*'''var''' The name of the variable to lookup

==PGVRSetVar==
Set an internal variable that can be used in this report. Variable can be referenced using the PGVRvar tag, or in an attribute value by prepending a $ in front of the variable name (ie. id="$pid")
*'''name''' The name of the variable to set
*'''value''' The value to set the variable.

==PGVRif==
Setup a condition where the children of this node will only be processed if the value of the condition attribute evaluates to true.
*'''condition''' The condition that must be met in order to process the children nodes.

The following syntax applies to the '''condition''' construct:
#The whole condition is delimited by double quotes '''" "'''
#A literal string value is delimited by single quotes '''' ''''
#A variable can be referenced by name preceded by a '''$'''
#A Gedcom tag element can be referenced preceded by a '''@'''
#Valid comparisons are '''==''' or '''!='''

==PGVRHeader==
Setup a header that will be placed at the top of every page.

==PGVRBody==
Start the main body of the document. The body will create new pages as content flows over the current page.

==PGVRFooter==
Setup a footer that will be placed at the bottom of every page.

==PGVRPageHeader==
Setup a header that will be printed at the top of the page whenever the body flows onto a new page. The PGVRPageHeader will be printed underneath the PGVRHeader. This is allows you to have a custom header for different people or families as information flows onto succeeding pages.

==PGVRFootnote==
This sets up a footnote in the document. Each unique footnote is numbered and that number is printed with a link to the footnote text, which is printed whenever the PGVRFootnoteTexts tag appears.

==PGVRFootnoteTexts==
Print all of the footnotes setup while processing the document.

==PGVRCell==
The PGVRCell is the most basic text block that can be used in a report. It differs from the PGVRTextBox in that it can only have one style of text. Because of this you will often see PGVRTextBox used more often than PGVRCell. Text in a PGVRCell will wrap to the width of the cell.
*'''width''' The width of this cell. Setting the width to 0 will make it the width from the current location to the right margin.
*'''height''' The starting height of this cell. If the text wraps the height will automatically be adjusted.
*'''align''' The text alignment of the text in this box. Options are "left", "right", "center", and "justify".
*'''style''' The name of the PGVRStyle that should be used to render the text.
*'''border''' Whether or not a border should be printed around this box. 0 = no border, 1 = border. Default is 0.
*'''fill''' The color to fill the background of this cell.

==PGVRTextBox==
The PGVRTextBox is very similar to PGVRCell except that it may have PGVRText children which may each have their own style.
*'''width''' The width of this box. Setting the width to 0 will make it the width from the current location to the right margin.
*'''height''' The starting height of this box. If the text wraps the height will automatically be adjusted.
*'''newline''' After this box is finished rendering, should the next section of text start immediately after the this box or should it start on a new line under this box. 0 = no new line, 1 = force new line. Default is 0.
*'''left''' Position the left corner of this box on the page. The default is the current position.
*'''top''' Position the top corner of this box on the page. the default is the current position.
*'''border''' Whether or not a border should be printed around this box. 0 = no border, 1 = border. Default is 0.
*'''fill''' The color to fill the background of this cell.

==PGVRText==
The PGVRText element must come inside a PGVRTextBox element and will render the text at the current document position according to the given style.
*'''style''' The name of the PGVRStyle that should be used to render the text.

==PGVRList==
Iterate through a list of level 0 records. The child elements contained in the PGVRList tag will be repeated for ever record in the list. The list can be filtered through the filter attributes. Any number of filters can be applied. With each iteration, the gedcom context is changes to the next record in the list.
*'''filter1''' Filter the list by the given expression. Filters are given in the form GEDCOMTAG EXPR VALUE, where GEDCOMTAG may be any valid tag, for example BIRT:PLAC. EXPR must be one of the following CONTAINS, GTE, LTE, or EQUALS. CONTAINS filters are usually faster than the other filters. VALUE may be any variable or literal string.
*'''filter2''' Filter the list again by the given expression
*'''filter3''' Filter the list yet again by the given expression
*'''sortby''' The Gedcom tag to sort on (ie. NAME, BIRT, or DEAT)

==PGVRRelatives==
Find all persons who are related to a given individual. With each iteration, the gedcom context is changed to the next record in the list.
Attributes:
*'''id''' The gedcom XREF id of the record to use as the context for children tags. A variable (ie $pid) or a reference tag (ie @FAMS, @SOUR) may be used for the id.
*'''group''' The group of relative to find. Acceptable values are:spouse-family, direct-ancestors, ancestors, descendants, all
*'''sortby''' Possible values are none, NAME, ID, generation,
*'''maxgen''' The Maximum number of generations to return. A value of * will return all.
*'''showempty''' If true, empty records will be returned for all ancestors not in the gedcom file. This is used for Ahnentafel charts.

==PGVRGedcom==
Set the current gedcom record context. All children tags will be referenced around the gedcom record selected using the "id" attribute"
*'''id''' The gedcom XREF id of the record to use as the context for children tags. A variable (ie $pid) or a reference tag (ie @FAMS, @SOUR) may be used for the id.

==PGVRRepeatTag==
Iterate across all of the Gedcom tags in the given in the "tag" attribute that are found in the current Gedcom context. With each iteration the current gedcom context is changes to the next matching tag's subrecord.
*'''tag''' The gedcom subordinate tag to

==PGVRFacts==
Iterate across all of the level +1 subrecords in the current gedcom context. This is useful for iterating through all of the facts in an individual or family record. The tags that will be iterated across can be filtered using the "ignore" attribute. It is often desirable to print the family with spouse facts along with the person facts. The "families" attribute allows you to turn this behavior on or off.
*'''ignore''' A comma seperated list of tags that should be ignored when iterating through this record.
*'''families''' Whether or not to look up family with spouse (FAMS) events when iterating through a person context. Options are 0 = don't include events from family records, 1 = include events from family records. Default = 0.

==PGVRGetPersonName==
Get the name of the person whose XREF id is given in the "id" attribute.
*'''id''' The Gedcom XREF id for the person to lookup. Leave this attribute empty if you want to use the name from the current gedcom record context.
*'''truncate''' Some reports may need to truncate long names so that they fit better in the reports. Use this attribute to specify the maximum character width that a name be printed. This will cause the processor to abbreviate multiple given names.

==PGVRGedcomValue==
Get the value of a Gedcom tag.
*'''tag''' The GEDCOM tag you wish to capture the data from. You can specify descendant tags by seperating them with colons (:). For example, a person's birthdate would be "BIRT:DATE". The birth place would be "BIRT:PLAC".
*'''level''' The level in the GEDCOM hierarchy this tag will be found. Entering DATE in the tag and level=2 will pull up the date that the event in the current contect occured.
*'''truncate''' Limits the number of characters printed to the screen.

==PGVRLine==
Draw a line on the page.
*'''x1''' The horizontal starting position.
*'''y1''' The vertical starting position.
*'''x2''' The horizontal ending position.
*'''y2''' The vertical ending position.

==PGVRImage==
Place an image on the page.
*'''file''' Currently the only supported value is @FILE
*'''left''' The vertical starting position.
*'''top''' The horizontal ending position.
*'''width''' The width to set the image.
*'''height''' The height to set the image.

==PGVRHighlightedImage==
Place the primary object image on the page. This would be the same image that is shown on the PGV charts.
*'''left''' The vertical starting position.
*'''top''' The horizontal ending position.
*'''width''' The width to set the image.
*'''height''' The height to set the image.

==PGVRNow==
Print the current date according to the selected language rules.
==PGVRPageNum==
Print the current page number.
==PGVRTotalPages==
Print the total number of pages in the resulting document.
==PGVRListTotal==
Print the totals found in the filtered PGVRList.
==br==
Print a new line break.


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

Inside info

2010-06-07T16:50:43Z

Momse: /* Manual configuration */

=Inside Information=

==Database tables v4.0 and 4.1==

PhpGedView uses a very simple database table layout because it operates primarily on the GEDCOM data and only needs the database for search and retrieval. There are 17 tables in the v4.0 database, '''20 in the 4.1 database''', and this note assumes use of the “pgv_” prefix for each table name:

{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
|-
| pgv_blocks || Description of each user's Portal page
|-
| pgv_dates || Stores decoded date information from GEDCOM records
|-
| pgv_families || All the families in the GEDCOM
|-
| pgv_favorites || Stores users favorites
|-
| pgv_individuals || All the individuals in the GEDCOM
|-
| pgv_media ||
|-
| pgv_media_mapping ||
|-
| pgv_messages || Messages to and from users
|-
| pgv_names || Stores decoded name information from GEDCOM records
|-
| pgv_news || Stores news items for the Index and Portal pages
|-
| pgv_placelinks || Cross-reference between places and individuals and families
|-
| pgv_places || Place hierarchy
|-
| pgv_remotelinks ||
|-
| pgv_other || All other level 0 GEDCOM records (i.e., repositories, media objects, notes, etc.)
|-
| pgv_sources || All the sources in the GEDCOM
|-
| pgv_users || Table for user data (only exists if using default MySQL authentication module)
|-
| pgv_next_id ||
|}

The tables are all very similar. They each have a field for the GEDCOM ID, a field to tell which GEDCOM file the record was imported from, a few fields for things like quick retrieval of name information, and a field for the raw GEDCOM record data.

'''In v4.1, three additional tables have been added -'''

{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
|-
| pgv_mutex || (information required here)
|-
| pgv_other || --
|-
| pgv_soundex || --
|}

Following is a more detailed description of each table in 4.0:

{| class="wikitable" style="margin: 2em auto 2em auto" table border="1"
<center>pgv_blocks</center>
|-
| b_id INT(11) || Record ID
|-
| b_username VARCHAR(100) || User name whom block belongs to
|-
| b_location VARCHAR(30) || Location of the block - main column or right column
|-
| b_order INT(11) || Position of the block within the column
|-
| b_name VARCHAR(255) || Name of the block
|-
| b_config TEXT || Configuration settings for this block
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_dates</center>
|-
| d_day INT(11) || The day of month for this date
|-
| d_month VARCHAR(5) || The 3 letter abbreviation for month of year
|-
| d_mon INT(11) || Integer 1-12 for the month of year
|-
| d_year INT(11) || The year for this date
|-
| d_datestamp INT(11) || A date stamp of the form YYYYMMDD used for simple comparisons
|-
| d_fact VARCHAR(10) || The fact that this date was associated with
|-
| d_gid VARCHAR(255) || The GEDCOM XREF ID where this fact and date were found
|-
| d_file INT(11) || The GEDCOM file id where this fact was found
|-
| d_type VARCHAR(13) || Used if this date uses an alternate calendar type
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_families</center>
|-
| f_id VARCHAR(255) || GEDCOM family ID
|-
| f_file INT || ID number of the GEDCOM file the record is from
|-
| f_husb VARCHAR(255) || ID of the husband
|-
| f_wife VARCHAR(255) || ID of the wife
|-
| f_chil TEXT || List of children IDs, semi-colon (;) delimited
|-
| f_GEDCOM TEXT || Raw GEDCOM record for this family
|-
| f_numchil INT || Number of children in this family
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_favorites</center>
|-
| fv_id INT(11) || Record ID
|-
| fv_username VARCHAR(30) || User name whom the favorite belongs to
|-
| fv_gid VARCHAR(10) || ID of the favorite
|-
| fv_type VARCHAR(10) || Type of favorite (currently only INDI)
|-
| fv_file VARCHAR(100) || File that this favorite belongs to
|-
| fv_url VARCHAR(255) || The URL for this favorite if it is not one of the basic types
|-
| fv_title VARCHAR(255) || A title for URL based favorites
|-
| fv_note TEXT || Optional descriptive information about this favorite
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_individuals</center>
|-
| i_id VARCHAR(255) || GEDCOM individual ID
|-
| i_file INT || ID number of the GEDCOM file the record is from
|-
| i_rin VARCHAR(30) || Individual's RIN number
|-
| i_name VARCHAR(255) || Person's primary name taken from the first 1 NAME line stored in GEDCOM name format
|-
| i_isdead INT(1) || Alive/dead status of individual -1:not calculated 0:alive 1:dead
|-
| i_GEDCOM TEXT || Raw GEDCOM record for this individual
|-
| i_letter VARCHAR(5) || First letter of the individual's surname
|-
| i_surname VARCHAR(100) || Person's surname
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_media</center>
|-
| m_id INT(11) || Media ID
|-
| m_media VARCHAR(15) || Media reference number
|-
| m_ext VARCHAR(6) || File type eg jpg
|-
| m_titl VARCHAR(255) || Media title
|-
| m_file (VARCHAR(255) || File name eg media/picname.jpg
|-
| m_gedfile INT(11) ||
|-
| m_gedrec TEXT || Raw GEDCOM record for this media
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_media_mapping</center>
|-
| mm_id INT(11) || Media ID
|-
| mm_media VARCHAR(15) || Media reference number
|-
| mm_gid VARCHAR(15) || Connected to individual Ixxx
|-
| mm_order INT(11) || Sequence
|-
| mm_gedfile INT(11) || Belongs to which gedfile
|-
| mm_gedrec TEXT || Raw GEDCOM record for this media
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_messages</center>
|-
| m_id INT(11) || Record ID
|-
| m_from VARCHAR(255) || Name or email address of the sender
|-
| m_to VARCHAR(30) || Destination user name
|-
| m_subject VARCHAR(255) || Subject of the message
|-
| m_body TEXT || Body text of the message
|-
| m_created VARCHAR(255) || Time stamp when the message was created
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_names</center>
|-
| n_gid VARCHAR(255) || Individual ID that this name corresponds to
|-
| n_file INT(11) || ID number of the GEDCOM file the record is from
|-
| n_name VARCHAR(255) || Name in GEDCOM format, with / / around the surname
|-
| n_letter VARCHAR(5) || First letter of the surname
|-
| n_surname VARCHAR(100) || Surname for this name record
|-
| n_type VARCHAR(10) || Type of name, P=primary, A=additional, C=calculated
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_news</center>
|-
| n_id INT(11) || Unique identifier
|-
| n_username VARCHAR(100) || User name or GEDCOM the News item belongs to
|-
| n_date INT(11) || Time stamp of last update
|-
| n_title VARCHAR(255) || Title of the article
|-
| n_text TEXT || Body text of the article
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_next_id</center>
|-
| ni_id INT(11) ||
|-
| ni_type VARCHAR(30) ||
|-
| ni_gedfile INT(11) ||
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_other</center>
|-
| o_id VARCHAR(255) || GEDCOM record ID
|-
| o_file INT(11) || ID number of the GEDCOM file the record is from
|-
| o_type VARCHAR(20) || Type of GEDCOM record (REPO, ADDR, NOTE, OBJE, etc)
|-
| o_GEDCOM TEXT || Raw GEDCOM record for this item
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_placelinks</center>
|-
| pl_p_id INT(11) || Unique identifier
|-
| pl_gid VARCHAR(30) || Family or individual ID referencing this place
|-
| pl_file INT(11) || ID number of the GEDCOM file the record is from
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_places</center>
|-
| p_id INT(11) || Unique identifier
|-
| p_place VARCHAR(150) || Place name
|-
| p_level INT(11) || Level of the place in the hierarchy, 0 is the country or state
|-
| p_parent_id INT(11) || ID of this item's parent place in the hierarchy. A city's parent would be the county it is in, a county's parent would be a state or province, and a state or province would have a country as parent.
|-
| p_file INT(11) || ID number of the GEDCOM file the record is from
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_remotelinks</center>
|-
| r_gid VARCHAR(255) ||
|-
| r_linkid VARCHAR(255) ||
|-
| r_file INT(11) ||
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_sources</center>
|-
| s_id VARCHAR(255) || GEDCOM source ID
|-
| s_file INT(11) || ID number of the GEDCOM file the record is from
|-
| s_name VARCHAR(255) || Abbreviated title of the source
|-
| s_GEDCOM TEXT || Raw GEDCOM record for this source
|}
{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_users</center>
|-
| u_username VARCHAR(30) || User name
|-
| u_password VARCHAR(255) || Encrypted password
|-
| u_fullname VARCHAR(255) || User's full name
|-
| u_GEDCOMid TEXT || Serialized array representing the GEDCOM IDs for this user
|-
| u_rootid TEXT || Serialized array representing the root IDs for this user
|-
| u_canadmin ENUM('Y','N') || Is the user an admin or not?
|-
| u_canedit TEXT || Serialized array indicating the editing privileges a user has for each GEDCOM
|-
| u_email TEXT || Email address
|-
| u_verified VARCHAR(20) || User self verified
|-
| u_verified_by_admin VARCHAR(20) || User has been verified by the admin
|-
| u_language VARCHAR(50) || User's preferred language
|-
| u_pwrequested VARCHAR(20) || User requested a new password
|-
| u_reg_timestamp VARCHAR(50) || Registration timestamp
|-
| u_reg_hashcode VARCHAR(255) || Self-registration hash key
|-
| u_theme VARCHAR(50) || User's preferred theme
|-
| u_loggedin ENUM('Y','N') || User's login status
|-
| u_sessiontime INT(14) || User's last login time stamp
|-
| u_contactmethod VARCHAR(20) || User's preferred method of contact
|-
| u_visibleonline ENUM('Y','N') || Whether or not the user is visible in the logged on users block
|-
| u_editaccount ENUM('Y', 'N') || Whether or not the user can edit his own account information
|-
| u_defaulttab INT(10) || Default tab on the individual page for this user
|-
| u_comment VARCHAR(255) || Admin's comments on this user
|-
| u_comment_exp VARCHAR(20) || Alert date for the admin, for instance for temporary accounts.
|-
| u_sync_gedcom VARCHAR(2) || If the user has a GEDCOM record ID, then should some of the data for the user (name, email) be synchronized with the GEDCOM data.
|-
| u_relationship_privacy VARCHAR(2) || Should this user use relationship privacy
|-
| u_max_relation_length INT || The maximum path that the user is allowed to see
|-
| u_auto_accept VARCHAR(2) || Are changes made by this user automatically accepted into the database
|}

'''The 3 extra tables in 4.1 are:'''

{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_mutex</center>
|-
| mx_id INT(11) || Unique identifier
|-
| mx_name VARCHAR(255) ||
|-
| mx_thread VARCHAR(255) ||
|-
| mx_time INT(11) ||
|}

{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_other</center>
|-
| o_id INT(11) || GEDCOM record ID
|-
| o_file INT(11) || ID number of the GEDCOM file the record is from
|-
| o_type VARCHAR(20) || Type of GEDCOM record
|-
| o_gedcom LONGTEXT || Raw GEDCOM record for this item
|}

{| class="wikitable" style="margin: 1em auto 1em auto" table border="1"
<center>pgv_soundex</center>
|-
| sx_i_id VARCHAR(255) || Unique identifier (Individuals table)
|-
| sx_n_id VARCHAR(255) || Unique identifier (Names table)
|-
| sx_file INT(11) || Unique identifier (GEDCOM file)
|-
| sx_fn_std_code TEXT || Standard first name soundex code. Used for soundex searching
|-
| sx_fn_dm_code TEXT || Soundex code for international first names
|-
| sx_ln_std_code TEXT || Standard last name soundex code. Used for soundex searching
|-
| sx_ln_dm_code TEXT || Soundex code for international last names. This uses the Daitch-Mokotoff soundex method, which is better suited for them.
|}

This table layout has received criticism from some for its simplicity, size, and because it does not follow a genealogy model like GENTECH. We admit that these tables can be hard to interface to because the code has to understand GEDCOM in order to get information out of them. We also admit that storing the raw GEDCOM data could make the tables very large.

Fortunately the GEDCOM standard is not a very complex or large format; it only requires 6 characters per line, which is very good compared to something like XML. However, there are some very compelling reasons why this table structure was chosen:

* Simpler tables mean fewer and simpler database queries. This takes a large load off the database and makes the program run faster.

* Nothing is lost in the Import. Even though GEDCOM is a standard, each genealogy program interprets the standard a bit differently and adds its own tags. Creating a database model that conforms to all the GEDCOM outputs of different genealogy software programs would be very difficult.

==Manual configuration==

Advanced users who understand PHP may want to configure manually by editing the configuration file config.php When you have finished editing config.php make sure that the variable $CONFIGURED=true; so that the program does not try to forward you to the configuration.php script when you launch it for the first time.

You can manually add GEDCOMS to the system by adding them to the $GEDCOMS array in the index/GEDCOMs.php file. The GEDCOM array looks like this:
$gedarray = array();
$gedarray["GEDCOM"] = "surname.ged";
$gedarray["config"] = "./index/surname.ged_conf.php";
$gedarray["privacy"] = "./index/surname.ged_priv.php";
$gedarray["title"] = "Surname Genealogy";
$gedarray["path"] = "./surname.ged";
$GEDCOMS["surname.ged"] = $gedarray;

"surname" above could be anything, for example, "johnson" or "private". You must pay attention to the case of what you enter. PhpGedView is case sensitive.

Each GEDCOM will need a configuration file. You can copy the config_gedcom.php file which has all of the default values for each GEDCOM you add manually. Then set the "config" item of the GEDCOMs array to point to the file you copied.

Each GEDCOM also needs a privacy file. Make a copy the privacy.php file for each GEDCOM and set the "privacy" item of the GEDCOMs array to the location of the new privacy.php file.

==Non-standard GEDCOM codes==

The GEDCOM 5.5 standard has a defined set of codes. (This used read - You can read the specification online at http://www.phpGedView.net/ged551-5.pdf but the link seems to be broken) Part of the standard allows for genealogy software to define their own codes, and requests that they begin with an "_" underscore.

When PhpGedView comes across a tag that is not defined it will display an error message. You can disable these error messages by setting $HIDE_GEDCOM_ERRORS=true in the config_gedcom.php file. PhpGedView can also be customized to work with these codes by adding them to the facts array in a new language file named facts.en.extra.php. If you add it to the English facts file you should also add it to the other facts language files you are using on your site if you want other languages to translate the tag correctly.

The format of the facts file is a PHP associative array. Each tag requires one line in the array. The following line defines the label "Abbreviation" for the ABBR GEDCOM tag.
$factarray["ABBR"] = "Abbreviation";

As an example, if you use a genealogy program that generates the tag "_ZZZZ" you can customize PhpGedView to accept this code by adding the following lines to the facts.en.extra.php file:
<?php
$factarray["_ZZZZ"] = "Tag Label goes here";
?>
You can disable these error messages in the config.php file by setting $HIDE_GEDCOM_ERRORS=true.

==Backup==

Note: If you want to use the Backup feature of the Upgrade utility in PhpGedView you will need to either set Write permission on the "phpgedview" folder itself or create a folder named "backup" with Write permissions. Write permissions for the "phpgedview" folder can be removed as soon as the backup folder is in place and has the appropriate permissions.

With the Backup function in the administration menu, you can make a simple backup of all important PhpGedView files. With this backup, it's possible to rebuild your PhpGedView site to the situation at backup time.

The backup can contain the following files, as selected on the Backup page:
- config.php with all configuration settings of your installation
- all GEDCOM files that were present in your installation
- all GEDCOM options and privacy settings for the above files
- counters, PhpGedView- and search-logfiles
- user definitions and options (block definitions, favorites, messages and news)

The files will be gathered into a ZIP file, which can be downloaded by clicking the link on the page.

Note: The database itself will not be included in the backup, since it can be rebuilt using the files in the backup.

Note: All pending changes (not approved or rejected yet by the administrator) will be present in the GEDCOM files but can no longer be identified as changes. If the database is rebuilt using the GEDCOMs, these changes therefore can no longer be rejected.

Note: If you have installed your index folder outside of the root directory of your web server, the references to some of the files in the zip will include directory paths of the form "../". Some zip utilities (for example Windows XP/Vista's native zip capability in Windows Explorer) can't handle this style of file path. You may need to get a tool that correctly handles these paths. WinRAR is one tool that does.

The Backup function uses the PclZip library, which is written by Vincent Blavet and can be found at http://www.phpconcept.net/pclzip.

==PostNuke and PHPNuke integration==

PhpGedView can integrate with PostNuke and phpNuke so that your users do not have to login twice.

After you have PhpGedView up and running, you should follow the instructions in the readme.txt file in the "pgvnuke" folder.

The files that make the integration magic happen were donated by Jim Carey.

[[Category:Developers Guide]]

Help:How to Register

2010-06-07T12:32:43Z

Momse: /* Editing options */

='''Registering'''=

To register for the site, just click on the "Create an account or login" link at the top of the screen. This will be at the top right of your screen.

You just need to provide a Username and a Password. The username can be anything you like providing it hasn't already been allocated and is appropriate (See [[Help:Username]])

To login, you have to have cookies enabled on your computer. Also if you check the box that says "Remember my password across sessions", this will simplify the login process for you from that computer.

You don't have to login to read the PGVWiki, but you do have to log in to edit articles.

Nevertheless, creating an account is quick, free and non-intrusive, and it's generally considered a good idea to do so, for a variety of reasons.

=='''User Name'''==
If you create an account, you can pick a Username. Edits you make while logged in will be assigned to that name. That means you get full credit for your contributions in the page history. You can also view all your contributions by clicking the "My contributions" link, which is only visible when you are logged in.

You will have your own user page where you can write a bit about yourself. You can use this page to maintain a list of the articles you have contributed.

You will have a permanent user talk page you can use to communicate with other users. You will be notified whenever someone writes a message on your talk page. If you choose to give an e-mail address, other users will be able to contact you by e-mail. This feature is anonymous; the user who emails you will not know your e-mail address.

=='''Reputation'''==
You don't need to reveal your real identity, but having an account gives you a fixed identity that other users will recognize. It's also easier to communicate and collaborate with an editor if we know who you are.

Sites such as this may get vandalized or spammed - hence the need to register to be able to edit and create pages. Information sources need to be verified and having a username will distinguish you as a reliable contributor and source.

=='''Editing options'''==
There are many features of the MediaWiki software (which powers PGVWiki) that are only available to registered users. For example, one of these features is being able to mark edits as minor.

Minor edits can be filtered from the list of "Recent changes". Marking edits which are not minor as such is considered very rude, so only mark an edit as minor if only a small change, such as a grammar correction has been made.

One very important feature which active contributors will likely use a lot are Watchlists. You will get a new link "Watch this page" on every page you view. If you click that link, a page will be added to your watchlist. This list is basically a filtered view of the "Recent changes" page which only shows changes recently made to items in your watchlist. This way you can keep track of pages you work on without having to follow all changes.

Also, you must be logged in if you want to upload images.

=='''Setting user preferences'''==
Aside from these features, you can customize the way MediaWiki behaves in detail by altering your preferences. There you can change the following display settings:

* Under math: how mathematical formulae are displayed.
* Under files: how large image thumbnails are displayed

And various editing preferences:
* How you sign your name
* How large the editing box should be
* How pages should be displayed in recent changes
* ... and others (they're pretty self-explanatory).

Place data

2010-06-07T11:59:06Z

Momse: /* Place hierarchy */

===Place hierarchy===
Place data (Gedcom tag PLAC) are entered in many places in the program; all events and facts have place locations. The standard prescrition for entering the place is to use a hierarchical entry: ''City, County, State/Province, Country'', comma separated, in this order. The main goal of this convention is to uniquely specify the place, allowing one to locate it on the map and distinguish from other similarly sounding locations. The program makes use of this convention, manages and displays the place hierarchy, allows one to display
the locations using Google Maps etc. Such a convention is an ideal, but the reality often does not conform to this simple rule.
:* Big cities are often their own states or counties (as opposed to seats of some bigger regions). This results in silly repetition: '''London, London, England'''. Saint Petersbug is a city that lies in North West Russia and is a capital of Leningrad province (oblast), but belongs to neither. Brooklyn is a city and a county, and '''Brooklyn, New York''' sounds right, while '''Brooklyn, Brooklyn, New York''' does not convey the actual hierarchy.
:* On the oposite end, little villages are often identified by additiona level(s) of hierarchy - municipality (Parish, Gemeinde, Gmina), as there can be villages of the same name in the same province.
:* The States or Provinces are usually, but not always, standard, next level is more ambiguous; for example in the USA the second level are Counties or Parishes (depending on the state). Countries are unambiguous, except where they are not, for example, should England or United Kingdom be positioned as Country in the place hierarchy?
:* Historical data often does not match current hierarchy. Cities split and merge, administrative divisions change, countries invade others and places belong to different Countries. This leaves a researcher with a dillema: should I use old (but now obsolete) hierarchy or modern?
:* Coordinates: very recent developments (GPS and mapping effors) allow one to easily locate coordinates of virtually any place. This gives a unique identification of any location and is independent of the place hierarchy. Plate tectonics will change it eventually, but coordinates are more stable now than political designations. PGV has a Google Maps tool that uses both place hierarchy and coordinates (in a separate database table) to display all locations for individual.

The PGV administrator of a webpage can select a specific convention. It is more important to use a convention uniformly than to select one convention above the other. Below are suggested rules that can be modified for each installation, and which should act as a template:

# Use place hierarchy, i.e. always list information in a hierarchical manner, from most detailed to most general. Always include Country. Each lower level entity should be part of higher level.
# Use the ''City, County, State/Province, Country'' convention as a guideline only. You can reasonably expect to locate Country and possibly State or province, and those can rely on position (in the comma separated list) only. Spell out intemediate level names, i.e. use '''Queens County''' not Queens, '''Acadia Parish''' not Acadia etc.
# Use as many place levels as necessary, but do not skip levels ('''Saint Petersburg, Russia'''; '''Brooklyn, New York, USA'''; '''Crowley, Acadia Parish, Louisiana, USA'''; '''Kleiniesiel, Stadland Gemeide, Wesermarsch Kreis, Niedersachsen, Deutschland''', etc. Skipped level means that the level is unknown, and needs to be filled; it is indicated by adding extra commas in the hierachy.
# Always add coordinates, if possible. There are several good webpages to help locate coordinated of any locality. If you are using Goole Map module, this is the place to enter the coordinate data.
# Use modern hierarchy in the PLAC field, and list the original location data (and possibly variants) in Notes. This helps the program to maintain uniform location names, but retains original information.

There are several aids in entering the place data. Always use the little globe icon (Find Place) by on the entry form: the place could have been used before. Other aids are described below.

===Edit Place in Split mode - NO===

[[image:place_hierarchy_12.jpg]] 

When entering data in relation to places you will be provided with the following dialog entry box. In this case the hierarchy has been created with the separation of items using a comma (,). The list indicated has the format of City,County,State/Province,Country. If at a later stage "Edit Place in Split Mode" is turned on this information would be automatically split into the appropriate areas.

If in this field the following information was entered:-

:::Big Maternity Ward, New York

The data entered actually has the form:-

::*City:- Big Maternity Ward
::*County:- New York
::*State:-
::*Country:-

Whilst there is nothing incorrect with this entry some consideration to format needs to be given before entering too much data.

===Edit Place in Split mode - YES===
The key difference between the two images shown is the addition of a small + symbol.

[[image:place_hierarchy_13.jpg]] 

clicking on this symbol will expand the options available for data entry

[[image:place_hierarchy_3.jpg]] 

If this is a new entry all fields will be blank. If you are editing an existing entry the fields will be shown.

[[image:place_hierarchy_6.jpg]] 

You then choose the country from the menu item. Once selected it will then show a graphic for the country selected.

If you are aware of the state you can then type the data into the state or click on the country map which will bring up the state/province map. You can then select the state or province by clicking on the appropriate one.

[[image:place_hierarchy_4.jpg]] 

You can then click on the state/province map and it will display a list of counties available or alternatively you can type the county into the system if you are aware of it.

[[image:place_hierarchy_5.jpg]] 

finally you type in the city name.

[[Fr: Informations de lieux]]

==Related Pages==

[[Users Guide:Place Hierarchy List|Hierarchical Place List]],
[[GEDCOM Configuration - Edit Options#Split Places in Edit Mode|Administrators Guide]]

[[Category:Users Guide]]
[[Category:PhpGedView]]

User:Nathan Watson-Haigh

2010-06-07T11:28:49Z

Momse: /* I am learning Japanese */

__NOTOC__
{| cellpadding="10" cellspacing="8" style="width: 100%; background-color: #C0C0C0; border: 1px solid #1234aa; vertical-align: top;"
|-
| style="width: 68%; background-color: #EFF8FF; border: 1px solid #8888aa; border-right-width:4px; border-bottom-width:4px; vertical-align: top;" rowspan="2" |

<div style="font-family: Trebuchet MS, sans-serif; text-align: justify;">''
'' '''Welcome!''' '' to my User page. [[User:Nathan Watson-Haigh|Nathan Watson-Haigh]] is a bioinformatics PostDoc at the University of Sheffield. See here for more details: http://www.bioinf.shef.ac.uk/wiki/index.php/Nathan_Haigh
{{-}}
</div>

| style="width: 30%; background-color: #EFF8FF; border: 1px solid #8888aa; border-right-width:4px; border-bottom-width:4px; vertical-align: top; height: 10px;" |

<center>
<div style="float: center; margin: 1px; padding: 7px; background: #F9F9F9; border: 1px solid #999999; width: 220px;">[[Image:NathanHaigh.jpg|220px|Dr. Nathan S. Watson-Haigh]] '''Nathan S Watson-Haigh'''</div>
</center>

|-
| style="width: 30%; background-color: #EFF8FF; border: 1px solid #8888aa; border-right-width:4px; border-bottom-width:4px; vertical-align: top;" |

<div style="font-family: Trebuchet MS, sans-serif; text-align: left;">
{{User en|LGT=yes}}
{{-}}
====I am learning Japanese====
I've really only just started, and won't be able to converse for quite some time! :)
</div>

|-
| style="background-color: #EFF8FF; border: 1px solid #8888aa; border-right-width:4px; border-bottom-width:4px;" colspan="2" |

<div style="font-family: Trebuchet MS, sans-serif; text-align: justify;">

===My Contributions===
I have only recently (Early Oct 2007) got involved with PhpGedView and my contributions are thus far limited to:
* [[Special:Contributions/Nathanhaigh|My PGVWiki edits]]
* Helping to get a testing framework in place using [[SimpleTest]]
</div>


{{DEFAULTSORT:Nathan Watson-Haigh}}
[[Category:Developer]]

FAQ:Installing PhpGedView

2010-06-07T11:19:13Z

Momse: /* How can I find out if I have PHP on my website, or if I can run php files? */

='''Questions about installing PhpGedView'''=

==How can I reduce the size of the PhpGedView source upload?==
You can upload all the PhpGedView source files if you want, but as you gain experience, you might want to remove files you never use prior to uploading them to the web server. This could reduce the size of the upload from around 31MB to around 8MB.

* In the “work/themes” folder, delete the themes that you do not plan to use. Retain at least “standard” theme.

* Delete the language files that you do not want. English files are named configure_help.en.php, countries.en.php, facts.en.php, help_text.en.php and lang.en.php. French files, for example, are named with ".fr." in place of ".en.

(The English language files must not be deleted. They are always loaded before the files for the selected language are loaded. This ensures that all language variables are defined, and that the English version will be used when a given variable is missing in the new language.)

* Do not upload the "places" folder. This folder contains maps for some countries. It also contains text files containing state, county, and place names. Its purpose is to allow you to enter place names by picking them from lists.

* Go to images/flags and delete the flags from countries other than your own, or the one(s) you want to keep.

* Check the "modules" folder - it may contain more add-ons than you require. The "extra" folder in the Googlemap module can also be left out for now. If in doubt about what they are or what they do, open the appropriate read-me files and check.

==How can I find out if I have PHP on my website, or if I can run php files?==

First check the features and support documentation for your website host. Often website hosts offer a variety of hosting packages depending which facilities you want.

If your host doesn't provide this information then you can find out yourself by creating a new text document called test.php and copy the following lines of code into it:

<?php phpinfo() ?>

Upload this new test.php file to your site and point your browser to it. If you have php on your site, you will see a webpage detailing the version of php plus lots of other information - that means that PhpGedView should work. If you don't have php installed then you will see a message similar to the following.

Sorry, no php.

If you are the host server hardware administrator and need to install php then you can download it at http://www.php.net.

==What version of PHP is required to run PhpGedView?==

PhpGedView requires at least PHP version 4.3.x. Some people are successful at running PhpGedView on PHP v4.2.x but it is not supported by the development team.

To use the reporting engine, PHP needs to be compiled with XML support. This is compiled into PHP by default unless it is specifically disabled. See http://us3.php.net/manual/en/ref.xml.php

Some features of PhpGedView require the GD library and that PHP be compiled with GD support. Most precompiled versions of PHP include GD support. If you are compiling PHP yourself you will need to configure it with the --with-gd option. See http://us3.php.net/manual/en/ref.image.php

The advanced calendar features of PhpGedView for converting Gregorian dates to the Hebrew or Jewish calendars require that PHP be compiled with the --enable-calendar configuration option. See the following website for more information: http://us2.php.net/manual/en/ref.calendar.php

==Should I use Index Files or a Database?==

PhpGedView prior to Version 4, comes with two options for storing data, databases (like MySQL) and Index files. From Version 4 you can only use a Database.

From the visitor perspective the sites operate in exactly the same way. The Index Files are generated to speed up access of your data. The Database mode imports your gedcom into a database.

Now, the answer to the question, "which one is right for me." The real answer is one of personal preference. Version 4 of PhpGedView has some significant improvements over the previous versions but there are some compelling reasons why one might want to use one an earlier versions with the ability to use index files:

* If you have a large gedcom file (>5MB) then you should MySQL (or another supported database) for speed and system performance issues. The response time of the standard version seems to increase as the gedcom gets larger.
* If you don't have a MySQL database on your site or have to pay extra for it then use the Index files.
* You can always switch to a database and a later version of PhpGedView if you choose to use index modes to start with.

==What file permissions need to be set?==

All files need read permissions. The following files need write permissions:
config.php

The following directory and its contents will need write permissions:
./index/

If you want to use the language editing features you will need to set write permissions for all of the files in the ./languages folder

If you want to upload media files using the upload media section of the admin menu then you need to set write permissions for your ./media and ./media/thumbs directory

If you want to edit your gedcom file online, the gedcom file must have write permissions set for the PHP user.

Refer to the Installation section of readme.txt for more information.

The method to set write permissions varies depending on your server configuration. If you have a Windows server, you may not need to do anything at all. If you use FTP to connect to your server, then you should look for a "permissions" or a "chmod" command. The "chmod" command takes a series of three numbers something like 755. The three numbers tell what permissions are for the file's owner, the file's group, and everyone. So the setting 755 breaks down like this: Owner = 7, Group = 5, Everyone = 5. The following table tells what each number means

7 Read, Write, Execute 
6 Read, Write 
5 Read, Execute 
4 Read 
3 Write, Execute 
2 Write 
1 Execute 
0 no access 

So the setting 755 would say that for this file, the owner can read, write, and execute the file, the group can read and execute, and everyone can read and execute.

You should first try setting the permissions using "chmod 755". If that doesn't work, that means that the webserver is not setup to run and the files owner and you should try "chmod 775". If that doesn't work, then the webserver is not in the file's group. At this point you can try to change the group (this often requires administrative rights on the server) or you can try "chmod 777". This would give everyone access to the file.

==PhpGedView fails when building indexes or importing large GEDCOM files?==
There are two problems that could cause this when working with large GEDCOM files (>2MB): insufficient memory and insufficient time.

===Insufficient memory===
In order to get the information from the GEDCOM file, the file has to be opened and read into memory. PHP has a default memory limit of 8MB. This is a protection from rogue scripts trying to take all of a machine's resources and disabling it. Depending on your PHP version/configuration and if you are importing a large gedcom you should probably double this amount especially while importing or indexing.

A good rule of thumb would be to allocate 4x the size of your gedcom file, though this could be higher. Generally, a 4MB gedcom shouldn't need more than 16MB in PHP. However an 8MB gedcom could require up to 32MB. One user's actual 11MB gedcom file required about 150 Mb.

'''memory_limit is not supported on Windows of PHP (e.g. there is no memory limit there)'''

====Edit php.ini====
The easiest option for increasing memory is to edit php.ini. However, this is only usually possible if you are the server administrator. To change the amount of memory allocated to PHP, edit the php.ini file (most likely located in /etc/php.ini on Unix) and change the following line:

memory_limit = 8M

to

memory_limit = 16M

After editing the php.ini file you need to restart your webserver.

====Edit PhpGedView source files====
If you do not have access to edit the php.ini file, you can also edit the PhpGedView directory "include/functions.php" file and the "importgedcom.php" files and add as the second line in both files: ini_set("memory_limit", "16M")

====Workaround====
As an alternate to increasing memory, first try skipping the cleanup options on Step #3. If that doesn't work try to [[FAQ: Questions about Installing PhpGedView#Can I build the indexes on my Home computer and then upload them?|do the GEDCOM importing/indexing on your home computer]] or split your one large GEDCOM into several smaller GEDCOMs.

===Insufficient time===
Another problem that can occur, especially on Windows machines, is the time limit can run out. PHP has a default time limit of 30 seconds for script execution. Again this is a security measure to prevent rogue scripts and hackers from stalling a machine. You will usually get an error message if you exceed the time limit. You can change the time limit by editing the time limit parameter in the gedcom configuration.

It should never take more than 10 minutes. After you have built the indexes or imported into the database, you should restore this time limit to 30 seconds to prevent someone from trying to get a 40 generation pedigree chart and stalling your server for 10 minutes.

==Can I build the indexes on my Home computer and then upload them?==

Yes. This can be helpful for large gedcoms where building an index can take a very long time. You have two options to be able to do this. First you can use the PHPLauncher to run PhpGedView and build your indexes and configuration files. Just copy the index directory from the PHPLauncher and upload it to the PhpGedView directory on your webserver.

You can also download and use PHP to create the indexes. Follow these steps:

*Download and install PHP.
*Download and install PhpGedView as if you were installing it on your site.
*Open a command prompt and go to the PhpGedView directory.
*Run the command: C:\PHP\php -q buildindex.php (This will build the indexes on your local computer.)
*When it is done upload the indilist.ind, famlist.ind, and sourcelist.ind to from the PhpGedView/index/ directory on your local computer to the PhpGedView/index/ directory on your server. PhpGedView on the server will automatically recognize the new indexes and use them.

==I imported married names in the import step. Why do they do not display?==

You have to set "Show married names on Individual list" to Yes. To do this go to: 
Admin > Manage GEDCOMs and edit Privacy > Configuration file > Edit > Display and Layout > Names >

==I setup PhpGedView but the charts are empty and/or I get some errors?==

This usually means that your GEDCOM import did not complete properly. You should try to import the GEDCOM again by logging in as an administrator and going to the Admin page and then the Manage Gedcoms area. Then click on the import link next to the GEDCOM you need to import. If you are asked to cleanup your Gedcom, you should click the "Cleanup" button. If you are asked to empty the dataset click the "Yes" button.

As your Gedcom is imported, your will see a progress bar telling you what percentage of your Gedcom has been imported, as well as a progress bar showing the percentage of the time limit used. When the importing is finished you should see several statistical messages and links off to the right that will take you to some of the other pages.

If you do not get this information or if you get errors then you should look at some of the other FAQ's on this page for more information on how to proceed from here. If your question is not answered here, then you should post a message in the help forums.


[[Category:PhpGedView|Installing PhpGedView]]
[[Category:FAQ]]



[[fr: FAQ: Questions sur l'installation de phpGedView]]

Upgrade or revert with SmartSVN and sitecopy

2010-06-07T11:05:08Z

Momse: /* SmartSVN */

{{stub}}''This article needs an introductory paragraph that introduces the concepts to be discussed and needs to put the article in context. It is not clear to someone what SmartSVN or site copy is - maybe link to a [[SmartSVN]] (or the wikipedia [[w:SmartSVN|SmartSVN]] article) and [[sitecopy]] articles that provide some details.''

Grrr! I just spent two hours finishing what I started, and the Wiki not only "lost session data" but it #$%&$%^$% disabled the copy paste functions in my browser! If anyone else wants to continue where I '''started''', go for it! Otherwise, I'll try again some other day.

When I want to change the version of PhpGedView I’m running, I merely
* select the version I want
* wait a few minutes
* type a simple command
* wait less than a minute

It really is that simple—and the setup to make it possible is not difficult either.

== Details of the procedure ==

(I have Mac OS 10.3.9, with SmartSVN Foundation 3.0.4 and sitecopy 0.16.0 installed.)
# Launch SmartSVN
# Select (click on) the top level directory
# Menu: Modify -> Update...
# Click "Revision" and enter the number you want (if you want the bleeding-edge latest, just leave it on HEAD)
# Click OK
SmartSVN will download each file in that revision that is different from what you already have. Download time will be proportional to the number and size of files. From 2228 to 2291 (approx. 4.1.3 to 4.2) took about one minute, forty seconds and changed 39 files.

When it is done
# Open a Terminal
# Type <tt>sitecopy --update PGV</tt>

Like SmartSVN, sitecopy will upload only the files that are different. Took 41.7 seconds for the same 39 files.

== Initial setup ==

=== SmartSVN ===

=== sitecopy ===

Configuration - Web Site and META Tag Settings

2010-06-07T10:50:33Z

Momse: /* Enable RSS */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
{{stub}}
====Main Website URL====
[[Image:4_webmeta_1.jpg|left]]
 
Each PhpGedView page includes a link to your main Home page. The appearance of this link is controlled by the theme being used. You enter the actual URL to your Home site here.

====Main Website Text====
[[Image:4_webmeta_2.jpg|left]]
 
The legend used to identify the link to your main Home page.

====Author Meta Tag====
[[Image:4_webmeta_3.jpg|left]]
 
The value to place in the Author meta tag in the HTML page header. Leave this field empty to use the full name of the Genealogy contact.

This sets $META_AUTHOR in xxx.GED_conf.php.

====Publisher Meta Tag====
[[Image:4_webmeta_4.jpg|left]]
 
The value to place in the Publisher meta tag in the HTML page header. Leave this field empty to use the full name of the Genealogy contact.

This sets $META_PUBLISHER in xxx.GED_conf.php.

====Copyright Meta Tag====
[[Image:4_webmeta_5.jpg|left]]
 
The value to place in the Copyright meta tag in the HTML page header. Leave this field empty to use the full name of the Genealogy contact.

This sets $META_COPYRIGHT in xxx.GED_conf.php.

====Description Meta Tag====
[[Image:4_webmeta_6.jpg|left]]
 
The value to place in the Description meta tag in the HTML page header. Leave this field empty to use the title of the currently active database.

This sets $META_DESCRIPTION in xxx.GED_conf.php.

====Page-topic Meta Tag====
[[Image:4_webmeta_7.jpg|left]]
 
The value to place in the Page-topic meta tag in the HTML page header. Leave this field empty to use the title of the currently active database.

This sets $META_PAGE_TOPIC in xxx.GED_conf.php.

====Audience Meta Tag====
[[Image:4_webmeta_8.jpg|left]]
 
The value to place in the Audience meta tag in the HTML page header

This sets $META_AUDIENCE in xxx.GED_conf.php.

====Page-type Meta Tag====

====Robots Meta Tag====
[[Image:4_webmeta_9.jpg|left]]
 
The value to place in the Robots meta tag in the HTML page header. Some robots or web crawlers ignore this value.

This sets $META_ROBOTS in xxx.GED_conf.php.

====How Often should Crawlers Revist Meta Tag====
[[Image:4_webmeta_10.jpg|left]]
 
The value to place in the Revisit meta tag in the HTML page header. Some web crawlers ignore this value.

This sets $META_REVISIT in xxx.GED_conf.php.

====Keywords Meta Tag====
[[Image:4_webmeta_11.jpg|left]]
 
The value to place in the Keywords meta tag in the HTML page header. Some search engines will use the Keywords meta tag to help index your page.

The Most Common Surnames list that appears in the GEDCOM Statistics block on your Welcome page can also be added to anything you enter here.

This sets $META_KEYWORDS in xxx.GED_conf.php.

====Add Most Common Surnames To Keywords Meta Field====
[[Image:4_webmeta_12.jpg|left]]
 
With this option set to Yes the surnames from the Most Common Surnames list will be added to the Keywords meta field. This can help search engines better find your site.

This sets $META_SURNAME_KEYWORDS in xxx.GED_conf.php.

====Add To Title Header Tag====
[[Image:4_webmeta_13.jpg|left]]
 
Anything on this line will be added to the TITLE tag in the HTML page header after the regular page title and before the PhpGedView credit.

This sets $META_TITLE in xxx.GED_conf.php.

====Enable RSS====

====RSS Format====
[[Image:4_webmeta_14.jpg|left]]
 
The format of RSS to be used as the default RSS feed format for the site. The numeric suffixes do not indicate version, they identify formats. For example, RSS 2.0 is not newer than RSS 1.0, but a different format. Feed readers should be able to read any format. There is currently no difference between ATOM and ATOM 0.3. Both use the ATOM 0.3 draft specification.

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

Configuration - Edit Options

2010-06-07T10:45:24Z

Momse: /* Surname Tradition */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

__TOC__
{{stub}}
====Enable Online Editing====
[[Image:4_edit_1.jpg|left]]
 
This option enables online editing features for this database so that users with Edit privileges may update data online.

====Synchronize Edits Into GEDCOM File====

====Individual Add Facts====
[[Image:4_edit_2.jpg|left]]
 
This is the list of GEDCOM facts that your users can add to individuals. You can modify this list by removing or adding fact names, even custom ones, as necessary. Fact names that appear in this list must not also appear in the Unique Individual Facts list.

====Unique Individual Facts====
[[Image:4_edit_3.jpg|left]]
 
This is the list of GEDCOM facts that your users can only add once to individuals. For example, if BIRT is in this list, users will not be able to add more than one BIRT record to an individual. Fact names that appear in this list must not also appear in the Individual Add Facts list.

====Quick Individual Facts====

====Family Add Facts====
[[Image:4_edit_4.jpg|left]]
 
This is the list of GEDCOM facts that your users can add to families. You can modify this list by removing or adding fact names, even custom ones, as necessary. Fact names that appear in this list must not also appear in the Unique Family Facts list.

====Unique Family Facts====
[[Image:4_edit_5.jpg|left]]
 
This is the list of GEDCOM facts that your users can only add once to families. For example, if MARR is in this list, users will not be able to add more than one MARR record to a family. Fact names that appear in this list must not also appear in the Family Add Facts list.

====Quick Family Facts====

====Source Add Facts====
[[Image:4_edit_6.jpg|left]]
 
This is the list of GEDCOM facts that your users can add to sources. You can modify this list by removing or adding fact names, even custom ones, as necessary. Fact names that appear in this list must not also appear in the Unique Source Facts list.

====Unique Source Facts====
[[Image:4_edit_7.jpg|left]]
 
This is the list of GEDCOM facts that your users can only add once to sources. For example, if TITL is in this list, users will not be able to add more than one TITL record to a source. Fact names that appear in this list must not also appear in the Source Add Facts list.

====Quick Source Facts====

====Repository Add Facts====

====Unique Repository Facts====

====Quick Repository Facts====

====Autoclose Edit Window====
[[Image:4_edit_9.jpg|left]]
 
This option controls wether or not to automatically close the Edit window after a successful update.

====Split Places in Edit Mode====
[[Image:4_edit_10.jpg|left]]
 
Set this to Yes to split each place name by commas into subfields for easier editing. Example :

:1. Default mode
::Place: Half Moon Bay, San Mateo, California, USA

:2. Split mode
::Country: USA
::State: California
::County: San Mateo
::City: Half Moon Bay

It is also possible to place maps within the Place Heirachy. Instructions on how to do this can be found [[Users Guide:Place data|here]].

See Also:-
[[Users Guide:Place data|Entering Place Data]], [[Users Guide:Place Hierarchy List|Place Hierarchy List]]

====Use Quick Update Form====
[[Image:4_edit_11.jpg|left]]
 
This option allows logged in users to submit changes through the Quick Update form.

This sets $USE_QUICK_UPDATE in xxx.GED_conf.php

====Show Privacy Fields on Quick Update Form====
[[Image:4_edit_12.jpg|left]]
 
This option allows you to turn on or off the privacy fields on the Quick Update form. Privacy fields allow a user who is adding information through the form to override the default privacy for the fact they are entering.

This sets $SHOW_QUICK_RESN in xxx.GED_conf.php.

====Facts To Show on Quick Update====
[[Image:4_edit_13.jpg|left]]
 
This is a comma separated list of GEDCOM fact tags that will be shown on the Quick Update form. Only the facts in this list will be shown on the form or made available for selection in the area where you add new facts on the form.

====Facts To Always Show On Quick Update====
[[Image:4_edit_14.jpg|left]]
 
This is a comma separated list of GEDCOM fact tags that will always be shown on the Quick Update form whether or not they already exist in the individual's record. For example, if BIRT is in the list, fields for birth date and birth place will always be shown on the form.

====Facts For Families To Show On Quick Update====
[[Image:4_edit_15.jpg|left]]
 
This is a comma separated list of GEDCOM fact tags that will be shown on the Family tabs of the Quick Update form. Only the facts in this list will be shown on the form or made available for selection in the area where you add new facts on the form.

====Facts For Families To Always Show on Quick Update====
[[Image:4_edit_16.jpg|left]]
 
This is a comma separated list of GEDCOM fact tags that will always be shown on the Family tabs of the Quick Update form whether or not they already exist in the individual's record. For example, if MARR is in the list, then fields for marriage date and marriage place will always be shown on the form.

====Surname Tradition====

====Advanced Name Facts====

====Advanced Place Name Facts====
[[Category:Administrators Guide]]
[[Category:phpGedView]]

Configuration - Display and Layout - Names

2010-06-07T10:38:53Z

Momse: /* Show age of parents next to child's Birthdate */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

{{stub}}

This article needs a suitable introductory paragraph.

==Show Birth and Death Details on Pedigree and Descendancy Charts==
[[Image:4_names_1.jpg|left]]
 
This option controls whether or not to show the Birth and Death details of an individual by default.

==Abbreviate Chart Labels==
[[Image:4_names_2.jpg|left]]
 
This option controls whether or not to abbreviate labels like "Birth" on charts with just the first letter like "B".

==Show age of parents next to child's Birthdate==
[[Image:4_names_3.jpg|left]]
 
This option controls whether or not to show age of father and mother next to child's birthdate on charts.

==Show LDS ordinance codes in chart boxes==
[[Image:4_names_4.jpg|left]]
 
Setting this option to Yes will show status codes for LDS ordinances in chart boxes.

::* B - Baptism
::* E - Endowed
::* S - Sealed to spouse
::* P - Sealed to parents

A person who has all of the ordinances done will have BESP printed after their name. Missing ordinances are indicated by _ in place of the corresponding letter code. For example, BE__ indicates missing S and P ordinances.

This sets $SHOW_LDS_AT_GLANCE in xxx.GED_priv.php.

==Other facts To Show in Charts==
[[Image:4_names_5.jpg|left]]
 
This should be a comma or space separated list of facts, in addition to Birth and Death, that you want to appear in chart boxes such as the Pedigree chart. This list requires you to use fact tags as defined in the GEDCOM 5.5.1 Standard. For example, if you wanted the occupation to show up in the box, you would add "OCCU" to this field.

This sets $CHART_BOX_TAGS in xxx.GED_conf.php.

==Show Married Names On Individual List==
[[Image:4_names_6.jpg|left]]
 
This option will show the married names of females on the Individual list. To use this option you can calculate the married names when you import the GEDCOM file (once only) or enter married names by hand. Calculation works only for the simplest case of wife using husband's name without declension or other modification.

This sets $SHOW_MARRIED_NAMES in xxx.GED_conf.php.

==Underline Names in Quotes==
[[Image:4_names_7.jpg|left]]
 

Many programs will place the preferred given name in "quotes" in the GEDCOM. The usual convention for this is to underline the preferred given name. Enabling this option will convert any names surrounded by quotes to with a CSS class of "starredname".

For example, if the name in the GEDCOM were 1 NAME Gustave "Jean Paul" Charles /Wilson/ enabling this option would change the part of the name enclosed in quotes to Jean Paul for printing purposes. Depending on other settings, the browser would then display that name as Gustave Jean Paul Charles Wilson or Wilson, Gustave Jean Paul Charles

This sets $UNDERLINE_NAME_QUOTES in xxx.GED_conf.php.

==Show ID numbers Next to Names==
[[Image:4_names_8.jpg|left]]
 
This option controls whether or not to show ID numbers in parentheses after person names on charts.

==Get Display Name From Gedcom==
By default PhpGedView uses the name stored in the indexes to get a person's name. With some GEDCOM formats and languages, the sortable name stored in the indexes does not get displayed properly and the best way to get the correct display name is from the GEDCOM.

Spanish names are a good example of this. A Spanish name can take the form (Given Names) (Father's Surname) (Mother's Surname). Using the Indexes for sorting and display, the name would display like this: (Given Names) (Mother's Surname) (Father's Surname), which is incorrect. Going back to the GEDCOM for the name will return the correct name. However, retrieving the name from the GEDCOM will slow the program down.

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

Preparing a PhpGedView Release

2010-06-06T18:55:11Z

Momse: /* Announce the release */

This article documents the process of making a new PhpGedView release. Currently [[User:John Finlay|John Finlay]] and [[User:Greg Roach|Greg Roach]] are responsible for preparing new PhpGedView releases.

==Preparatory Tasks==
# At least one week before the release date, freeze the language files.
## Post to the developers forum asking that no more changes be made to language variables before the release date.
## Post to the translators forum asking translators to submit any pending changes before the release date.

==Packaging the Files==
# Identify the trunk/branch of phpGedView that you intend to release.
# Ensure the version number is correct in session.php (PGV_VERSION and PGV_VERSION_RELEASE).
# Ensure the version number is correct in build.xml (pgv.version).
# If any new modules have been added since the last release, you will need to add definitions for these in build.xml.
# If the database schema has changed (i.e. changes to includes/db_schema/*.php), then update the sqlite database file used by the democd application.
# Create a tag for the release in the tags directory of the SVN repository.
# Check out a working-copy of both the tagged directory and the distribution directory from the repository.
# If these two working copies are not in the same parent directory, update the "dist.dir" value in build.xml to the actual location of the distribution directory.
# Download the [http://ant.apache.org Apache Ant] build tool. To configure it, simply define the environment variable ANT_HOME as the location of the Ant root directory.
# Run Ant from the phpGedView directory using the appropriate command line for your operating system.
## "%ANT_HOME%\bin\ant"
## $ANT_HOME/bin/ant
# Ant takes approximately 5 minutes to run, and will generate all the required zip archives in the distribution directory.
## PhpGedView-all-Version
## PhpGedView-basic-Version
## PGV-Demo-Version
## PGV-Languages-Version
## PGV-Places-Version
## PGV-Themes-Version
## PGV-Modules-All-Version
## PGV-Module-XXX-Version (for each module XXX)

== Release the Files on SourceForge ==
Refer to the [https://sourceforge.net/apps/trac/sourceforge/wiki/Release%20files%20for%20download SourceForge release documentation] for information on how to create a release on SourceForge
# Upload the files using the [https://sourceforge.net/project/admin/explorer.php?group_id=55456 Web Upload Page]
# Set the basic package to be the default by clicking on it, and clicking the "select all platforms" option

== Update the Bugs Tracker on SourceForge ==
# The [https://sourceforge.net/tracker/admin/?group_id=55456&atid=634867&add_group=1 bugs tracker "group"] is used to record the PhpGedView version. Rename the latest version from, say "4.2.3 (svn)" to "4.2.3" and create "4.2.4 (svn)". Thus all outstanding bugs in the current SVN will be listed under the release.

== Update the PhpGedView Website ==
# Update the [http://www.phpgedview.net/ PhpGedView.net] website. The simplest way is to directly edit the website files using SSH. Refer to the sourceforge documentation for information on how to access the website files.

== Announce the release ==
It is usually a good idea to wait a day or two just in case there is something wrong with the package.
# Send out the release announcement to:
## the mailing lists
## the sourceforge users monitoring the release package
## Post a message in one of the sourceforge forums
## Add a News item on the SourceForge project page

== PGVWiki Tasks ==

After a new release is made, changes need to be made to some PGVWiki articles. Bug fix releases (e.g. {{latest stable series}}) require only a few changes to be made to existing templates and articles, whereas, minor releases (e.g. 4.x) and major releases (e.g. a version bump from 4.x to 5.x) will require a little more work.

; For Bug Fix Releases

:# Simply update [[Template:Latest version {{latest stable series}}]] to reflect the release date and version for the new release.

; For Minor Releases

:# Copy the contents of [[Template:Latest version {{latest stable series}}]] to the equivalent page for the new release e.g. [[Template:Latest version 4.2.x]] and update the release date and version of the new release.
:# Update [[Template:Latest stable series]] to indicate the latest stable series has incremented.
:# Update [[Template:Latest development]] to indicate the version number of the new development branch.
:# Update all references/links on this page from 4.2.x to 4.3.x

; For All Releases

:# Update file sizes of the new downloads on the [[Download v{{latest stable series}}]] and update any references/links required for the new release (in particular the '''patch download''', which patches from the previous version to the current version).
:# Ensure the following article exists ([[{{latest version|series={{latest stable series}}}}]]) with a redirect to [[PhpGedView v{{latest version|series={{latest stable series}}}}]]
:# Simply copy the contents of [[PhpGedView v4.1.3]] (or similar) to [[PhpGedView v{{latest version|series={{latest stable series}}}}]], changing any contents as needed.
:# Update the [[News]] section on the main page to show details of the new release.
:# Ensure the date pages for the new release ({{latest version|release date=1|series={{latest stable series}}}}) exist and appropriate content is added using information from a previous release as a template e.g. [[16 November]] and [[2007]]

== Wikipedia Tasks ==

The following [[w:Wikipedia|Wikipedia]] articles contain information about PhpGedView and thus need to be checked and updated after a release is made:

* The [[w:PhpGedView|PhpGedView]] article
* The [[w:Comparison_of_genealogy_software|Comparison of genealogy software]] article

[[Category:Developer_resources]]
[[Category:SVN]]

Remote Link Individuals Across Websites And Databases

2010-06-06T18:32:53Z

Momse: /* 4.0 beta */

==What is a Remote Linking?==
Remote linking is a way of connecting people together across multiple GEDCOM databases or PhpGedView websites. Imagine if you find your great-great-grandfather on someone else's website, instead of copying the data and merging it into your GEDCOM, just create a link to him from your site. Then when data is updated on the remote site, it will automatically be reflected on your site. With this we can create a "web of genealogy" where our family trees become interconnected at common points.

This same remote linking can be applied to multiple GEDCOMS loaded on the same PhpGedView site.

=='''How to add a remote link'''==

As of version 4.0, PhpGedView supports linking individuals across multiple websites and databases. This means that you can link a person on your site to his father whose data you found on another site. Instead of duplicating data, you are now linking to it.

The most common application of this linking would be to separate data from a husband and a wife into 3 different databases: one for the father's side, one for the mother's side, and one for their children and descendants. This would allow for different privacy settings and configurations for each of the three databases, but still allow the data to be shared between them.

For information on the technical details of how remote linking works under the hood you can read more at [[How Remote Linking Works]]

==Getting Started with Remote Linking==

Before you start, you must know if you are linking to a remote database or if you are linking databases in the same site.

==Linking to a remote site==

In order to link to a remote site you need to know the following information:

*The URL to the web services description file (WSDL) for the remote site. In a PhpGedView site, the URL to a WSDL file will look like this http://www.remotesite.com/phpGedView/genservice.php?wsdl

*If the site is hosting multiple databases, then you need to know database id for the person you are interested in. For PhpGedView websites, this is the name of the GEDCOM file that was uploaded by the administrator.

*The ID for the person you are linking to (eg. I100)

With this information in hand, you can now create a remote link. Follow these steps:

*Login to your site as a user with editing privileges
*Navigate to the person on your site that you are linking the remote person to
*Click on the Close Relatives tab
*Scroll to the bottom of the page and select the "Link Remote Person" option. This will open a new window where you can enter the information you found about the remote person. This new window looks something like this:
[[Image:addremote.png]]
*Choose the type of relationship that you will be creating with this link. If the remote person is the father of the local person, then you would select Father from the drop-down menu.
*Select the option for "Different Site"
*If you are linking a person on a site you have already used before, you can select that site from the drop-down list of known sites. Otherwise enter the URL and database ID as shown in the image above.
*Finally enter the ID of the person and click the "Add Link" button.

==Linking databases on the same site==

To setup a link between two people in different genealogical databases on the same site, you need to know:

*The ID of the person you are linking to (eg. I100)
*and the database id where the data for that person is located. For PhpGedView websites, this is the name of the GEDCOM file that was uploaded by the administrator (eg. surname.ged).

With this information you can now create a link between the two individuals on your site. Follow these steps:

*Login to your site as a user with editing privileges
*Navigate to the person on your site that is the same as the person on the remote site. You will have to create this INDI in your own GEDCOM if it does not already exist.
*Click on the Close Relatives tab
*Scroll to the bottom of the page and select the "Link Remote Person" option. This will open a new window where you can enter the information you found about the remote person. This new window looks something like this:
[[Image:addlocal.png]]
*For now, the only "Relationship to current person" option is "Same as current" which will already be selected. If it isn't, select it.
*Select the option for "Same Site"
*Select the genealogical database ID from the provided list
*Finally enter the ID of the person and click the "Add Link" button.

==Accept the changes==

After the links are created they still need to be accepted just like all other changes. Once the changes are accepted you will be able to go the local person where you created the link and see the new information that was downloaded from the other genealogical database.

==Versions and bugs==
===Bugs===
As of 4.1.6, the import code is apparently not reliable. You must have full access to your GEDCOM and you should make sure that there are no pending changes in it.

===4.0 beta===
Remote link creates "phantom" families, with an apparent duplication of parentage. This is a known problem with the beta.
====Mother and father linked====
Because the program doesn't recognize that the father and mother are supposed to be married locally, it shows the remote family twice, once as a step family for the father and once as the step family for the mother.

You should merge the two families that establish the relationships to the remote mother and father. Go to the Admin page and select the "Merge records" link and enter the two family numbers.

===3.3.8 and earlier===
This feature is not available in versions 3.3.8 and earlier.

[[Category:How To]]
[[Category:PhpGedView]]

[[fr:Comment mettre en relation automatique des sites PhpGedView de personnes différentes]]

SimpleTest

2010-06-06T18:18:11Z

Momse: /* Writing Tests for PhpGedView */

{{stub}}
{{Infobox Feature
| name = SimpleTest
| image = [[Image:Simpletest-logo.png]]
| lead contact = [[User:Nathanhaigh|Nathan S. Watson-Haigh]]
| dev codebase = v1.0.1beta2
}}
'''SimpleTest''' is an opensource PHP unit test, mock objects and web test framework developed by a [http://www.simpletest.org/en/ third party]. Users of JUnit will be familiar with most of the interface. JWebUnit style functionality is more complete now. It has support for SSL, frames, proxies, basic authentication and the standard HTML controls. The idea is that common but fiddly PHP tasks, such as logging into a site, can be tested easily.

SimpleTest is available as a [[module]] in PhpGedView (currently only in the development branch).

== Test Organisation ==

You should familiarise yourself with [http://www.simpletest.org/en/overview.html how to write tests] before continuing.

; <code>modules/testing/unittests/</code>
: This directory is intended for unit testing files for individual classes.

; <code>modules/testing/testgroups/</code>
: This directory is intended for writing test groups. This allow for the logical organisation and running of a set of unit tests.

; <code>modules/testing/webtests/</code>
: This directory is intended for test files that test the PhpGedView web interface.

== Writing Tests for PhpGedView ==

== External Links ==

; Official website
: http://www.simpletest.org

; SourceForge
: http://www.simpletest.org

; Documentation
: http://www.simpletest.org/en/overview.html

; SimpleTest API
: http://simpletest.org/api/

[[Category:Developer_resources]]
[[Category:Modules]]

Proper use of sources

2010-06-06T18:13:41Z

Momse: /* How to Structure Sources */

Time and effort should always be made in order to make [[proper use of sources]]. Every little bit of information gleamed from somewhere (a [[source]]) in order to help you reconstruct your family tree should be documented i.e. every bit of information should cite a source record, whether this be published data in birth, marriage and death certificates, census data or the fragile memory of your great-grandmother, or even your own first-hand knowledge. Having these sources available and citing them for each bit of information your record will help others verify your work, find sources that support your conjecture, and help you in 12 months time when you come to work on a distant branch of your tree and think "how do I know Miss Jane Unknown married Mr John Doe".

[[PGV]] follows the [[GEDCOM]] standards for storing sources and citations to those sources and as such, there is quite a rigid way in which the data is entered. However, if you are in a hurry, it is ''always'' better to add a short note (in the Note field) to a piece of information then add the "formal" source data later, than to skip it entirely in a hope to do it at a later date.

== Source and Source Citation ==

PGV adopts GEDCOM convention of separating a source ([[SOUR]]) record (describing in some detail the actual source), from the source citation. Source is separate record in the table of sources. Source Citation, attached to individual event, fact or person, is a reference to this record, with possible specific details (like page in the book, quote from the source, etc.) This structure lends itself easily to sources like books that may have many facts, and the citation specifies page(s) from the book, and appears to be overkill if grandmother's story is a source. However, the last can also be treated as a single source (especially useful if it is recorded), and different facts quoted from it. Even a one-page birth certificate can be a source for birth date, christening date, given name, parents names and ages, witnesses (possibly a family member), etc.

=== Source ===

Source record can be created where a source citation is called for ("Add a Source Citation"): the form allows one to reference an existing source or to create a new one. Source record has the following fields (with Gedcom tags for reference):

; Title ([[TITL]])
: Title of the source (book, publication title; document name, or any other descriptive title)

; Abbreviation ([[ABBR]])
: Short title (useful only if the title is very long)
; Author ([[AUTH]])
: Name of person, institution or other entity that created the document or supplied the information.
; Publication ([[PUBL]])
: Information on where and when the source was created. For published sources the publisher name, place and year of publication is customary, for unpublished sources - where and when (and how) the source was created.
; Repository ([[REPO]])
: Reference to a place, where original document is located. It can be somebody's home, a library, archive. In case of a book, any location likely to be accessible is OK. This is important to other researchers, who might need to reach original document. The Repository records are separate from the sources, as one repository can store many sources.
; Call Number ([[CALN]])
: Formal call number for a source in a repository (useful for large repositories)
; Text ([[TEXT]])
: Can include relevant text from the original source
You can also include
;Media ([[OBJE]])
: References to a multimedia object, document, photo, etc. - see [[#Sources and Multimedia|Sources and Multimedia]].
;Associated Events
: Those are reverse links to events that can be associated with this source. (The forward links are created when you quote the sources, i.e. create a [[#Source Citation|Source Citation]] associated with an event. The original Gedcom standards suggests an comma-delimited list of events, PGV allows you to enter the events separately. The Event description include:
:*Event (e.g Birth, Death, Burial etc.)
:*Date of the Event
:*Place of the event or region encompassing all events in the source
:*Agency

After creating a source you will be directed back to the Citation screen, where you can complete creating a citation. Pleae note, in PGV 4.1 the source will not be visible (even as change) nor accessible untill the changes are approved.

''See also'':
* '''[[Adding a Source|A tutorial on creating a new Source]]'''
* A formal Gedcom description of the [[SOURCE RECORD|Source Record]]

=== Source Citation ===
Source citation can be attached to almost anything: an individual, a family, and any fact or event, using "Add a Source Citation". As a rule of thumb, always add citation to a specific event or fact. Citations from 'general' sources , or sources not related to recorded events / facts can be attached to the individual or family. If the Source has already been created, you can enter the source ID or use the book icon to search for it. Alternatively, you can create a new source - see above.

; Source (ID)
: Reference to existing or newly created source. Use ''search'' or ''create'' icons to find a source or to create a new one.
; Citation Details ([[PAGE]])
: Details, where in the Source can one find the specifically cited information. It can be page number (in a book), edition, issue and page (in a periodical), etc.
; Text ([[TEXT]])
: Quote (or multiple quotes) from the source, apropriate to this citation.
; Date of entry in original source ([[DATE]])
: Used if source has multiple entries with different dates
; Quality of Data ([[QUAY]])
: One can desribe the quality (reliability) of the data here. Frequently used convention is numerical 3 = Direct and primary evidence; 2 = Secondary evidence; 1 = Questionable reliability data; 0 = Unreliable source or estimation.
;Media ([[OBJE]])
: References to a multimedia object, document, photo, etc. - see [[#Sources and Multimedia|Sources and Multimedia]].

== Sources and Multimedia ==
You can add a source to a Media Object (quoting a source of this media), and you can add media to a Source (illustrating the source) and to a Source Citation (illustrating the citation). Source records usually describe an external source, which can be a physical (paper) document. However, with the use of Multimedia tab, an electronic form of the whole source can be included. For example a story, memoir, book, if exists in electronic form, can be included here (as pdf, html etc), provided copyright is respected.

Media can be attached both to Source and to Source Citation. As a general rule, media attached to Source should pertain to the whole source, those attached to Citation should relate to the specific citation. If the Source is a single document (e.g. a certificate), and the Media is a scan of this document, the media reference can be added in three places: to the event, to event source citation, or the source itself. It will be displayed differently in each case - direcly on the Personal Facts and Details screen, on the same screen when the source is expanded, or with source only.

== How to Structure Sources ==
As the number of sources grows, their maintenance may become a problem. Gedcom standard does not provide for any structure of sources, as they are thought of as published records, books etc, one for many citations. With the use of electronic media the number of individual sources can easily grow into thousands. Additional filters on the Source page in PGV would probably help in managing the sources collection.

Recent discussion in the PGV community revealed a solution that may be worth recommending. It involves creating an virtual ''book'' source of the same type, but not necessarily related sources. For example "Census" can be a single source. "All Email Communications" can be another. In the Source Citation one would provide the [[PAGE]] tag (''Citation details'') specifying where in the Source can you look for information - year and place for Census data, date stamp / sender for email etc. A collection of documents (accessible on a webpage) can be another Source, with document name / page as ''Citation details''. Of course it is also possible to treat each document as Source and the webpage location as repository.

== Gedcom view of sources ==

When looking at the various entries, remember that PGV uses pointers to separate GEDCOM records.

For example, <code>2 SOUR @S123@</code> means that the source for the 1-level fact (birth, death, adoption, etc) is described in record <code>0 @S123@ SOUR</code>. The citation details (page, notes, text) are found in 3 and 4-level entries after the <code>2 SOUR</code> entry that points to the main source for this fact.

The reason for this odd structure is that you can have many events that use the same basic source, with only citation details varying. For example, many people use a family bible as a source.

The zero-level record tells you "how to find the material". It gives details about the source title, the publisher, its condition, and where it is located. In the case of a microfilm or microfiche, you'd record the "where to find the film or fiche" in the zero-level record.

The n-level <code>SOUR</code> reference records "where to find the information once you've located the source material". This would be a page number in a book, an entry number in a register of births, a frame number in a film or microfiche, etc.

This structure is carried even further. The zero-level <code>SOUR</code> record contains a <code>1 REPO @Rnn@</code> entry. This points to a repository, library, or somebody's home. The repository (usually a library, a church office, or a public records office [Standesamt]) contains many different items of source material.

I keep a number of source items at my house, so my house is a repository. The family bible, which records births, deaths, and marriages from 1825 to 1900 is a source at this repository. Entries in this bible are used as n-level <code>SOUR</code> references in my GEDCOM. A privately published book, produced by a well-known American genealogist in 1908, is another source at this same repository. Entries in this book are used as n-level <code>SOUR </code>references in my GEDCOM.

Don't forget that you can have multiple n-level <code>SOUR</code> references, each pointing to a different zero-level <code>SOUR</code>, but all attached to the same (n-1)-level fact.
--Gerry Kroll

== See Also==

* [[Evaluating Evidence Article]]
* A formal Gedcom description of the [[SOURCE CITATION|Source Citation]]

== External Links ==
[http://www.phpgedview.net/ged551-5.pdf GEDCOM 5.5.1 (draft) standard] pages 27 and 39-40.

[[Category:Users Guide]]
[[Category:PhpGedView]]



[[fr:Utilisation des sources]]

PunBB module

2010-06-06T18:10:26Z

Momse: /* PunBB Codebase Versions */

{{stub}}
{{Infobox Feature
| name = [[PunBB module]]
| image = [[Image:PunBB_logo.png]]
| lead contact = [[User:Nathanhaigh|Nathan S. Watson-Haigh]]
| codebase = [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/phpGedView/modules/punbb/ v1.2.12]
| dev codebase = [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/modules/punbb/ v1.2.16]
}}
'''PunBB''' is a fast and lightweight PHP-powered discussion board developed by a [http://punbb.org/ third-party]. It is released under the [[w:GNU General Public License|GNU General Public License]]. Its primary goals are to be faster, smaller and less graphically intensive as compared to other discussion boards. PunBB has fewer features than many other discussion boards, but is generally faster and outputs smaller, semantically correct XHTML-compliant pages.

PunBB has been incorporated into [[PhpGedView]] as a [[module]] and is available for separate [[download]] and [[How_to_install_PunBB_Forum|installation]] if you choose not to install all of PhpGedView.

== PunBB Codebase Versions ==

=== Trunk ===

The trunk carries the PunBB v1.2.12 codebase.

=== Development Branch ===

The [http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/ phpGedView-4.2] development branch carries the PunBB v1.2.16 codebase.

== Developer Information ==

A [[vendor branch]] directory exists for PunBB ([http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/vendor_branches/punbb/ punbb]) which is used to keep our own copy of the PunBB development efforts. For each new [http://dev.punbb.org/browser/tags PunBB release] the following procedure should be used to update the PunBB codebase in the PGV SVN repository:

=== Codebase Update Procedure ===

Updating the code base of any vendor code should be done in the development branch. This allows the developers to asses the check the changes for any bugs before it is merged into the trunk.

* Obtain a PunBB release by downloading the zip archive of the next release from http://dev.punbb.org/browser/tags/
* Unzip it into a local directory
* Move the contents of the upload directory into it's parent dir:
cd <unzipped punbb dir>
mv upload/* ./
rm -rf upload
* Using the [http://subversion.tigris.org/tools_contrib.html#svn_load_dirs_pl svn_load_dirs.pl] script provided by subversion, load the code into the punbb [[vendor branch]] directory and create a tag so the release can be easily referenced. '''NOTE:''' substitute ''<new_version>'' for the version of the punbb code being loaded and ''<unzipped punbb dir>'' with your local dir unzipped from above.
<nowiki>perl svn_load_dirs.pl https://phpgedview.svn.sourceforge.net/svnroot/phpgedview -t vendor_tags/punbb-<new_version> vendor_branches/punbb <unzipped punbb dir></nowiki>
* You can now delete the <unzipped punbb dir> as it's contents are now stored in the SVN repository
* Move to the punbb module directory in the development branch in your working copy:
cd branches/phpGedView-4.2/modules/punbb
* Do a dry run of an svn merge between the tagged version that the current code is based on and the latest code just loaded into the vendor_branch. '''NOTE:''' substitute ''<old_version>'' for the punbb version on which the current punbb code is based.
<nowiki>svn merge --dry-run https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/vendor_tags/punbb-<old_version> https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/vendor_branches/punbb</nowiki>
* If the proposed changes seem fine, then run a proper merge by dropping the <tt>--dry-run</tt> switch:
<nowiki>svn merge https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/vendor_tags/punbb-<old_version></nowiki>
* Alternatively, you could merge single files or directories using a similar approach.
* At this point there are likely to be conflicts due to changed being made to the same bit of code by the PGV team as well as the vendor - these need to be resolved.

[[Category:PunBB Module]]

Delete an individual

2010-06-06T18:01:51Z

Momse: /* Delete */

== Delete ==

Before deleting a person it is reccommended that you accept/reject any pending changes. Deleting a person will also remove any links from them to the rest of your family tree. This means if you delete a person in the middle of your tree, you could end up with two unlinked trees.[[Image:editname.jpg|right]]
# To delete a person from your family tree:
## Click on the name of the person you want to delete. This will take you to the person's individual page.
## Under the edit menu for this person, you will see an option to "Delete this individual"
## You will be asked to confirm the deletion of this person.
# To finalize the deletion of this person you will need to accept the changes.

== Remove ==
[[Image:ChangeFamily.png|right]]
You can also remove an individual from a family without deleting the person's record. In "Options for family" select Edit family and Change Family Members. A new screen will open with opptions to Remove or Change for each existing family member. "Remove" removes the individual link to this family only, it does not erase the individual record.

[[Category:How To|Delete an individual]]
[[Category:Users Guide|Delete an individual]]
[[fr:Supprimer un individu]]

Modules

2010-06-04T08:10:35Z

Momse: /* PHPSysInfo */

{{stub}}
[[PhpGedView]] is capable of utilising '''modules''' to extend and enhance its features by way of third-party code. Information about [[Developers_Guide:Creating_a_Module|creating a module]] is available for those who wish to develop them.

Some modules may come with the PhpGedView package you download. To install other modules, download the module's files and place them in the ''modules'' folder in your PGV folder. Usually these files will be organized as a single php file and a folder of additional files. Generally this is all that is necessary, but check for a specific 'readme' or similar file in the set of module files.

==FCKEditor==
A module that allows the use of the [http://www.fckeditor.net FCKeditor] for entering and editing news items and other HTML-based blocks on the Welcome and My Portal pages in a WYSIWYG window.

==GoogleMap==
{{main|Google Map module}}
The module shows a map with geographical information about the Individual events. There is an additional tab shown on the page for every individual, a map derived from Google Maps, and a table of the events being mapped on this page.

Each map marker may be clicked to show data attached to that particular place. If more than one event took place at the marker location, the additional events are shown with tabs.

==PHPSysInfo==

==Message Forum==
{{main|PunBB module|How to install PunBB Forum}}
An interface module to the [http://en.wikipedia.org/wiki/Punbb PunBB] application, a simple Bulletin Board that can be used as a discussion forum in PhpGedView

==Research Assistant==
{{main|Research Assistant module}}
The Research Assistant allows users to create and manage research tasks and associate them with '''individuals''' or '''families''' Research tasks can be assigned to different researchers and organized into folders. The Research assistant has also tools to show missing information and the most probable places to look for it.

==Sitemap==
This module generates Sitemap files for use by search engines such as Google.

==Slideshow==
==GVExport==
{{main|GVExport module}}
The GVExport module is an interface module to the [http://en.wikipedia.org/wiki/Graphwiz GraphViz] application. After installing the application and the module, you can create many additional family diagrams that can be viewed and saved as a graphics file (e.g. png).

==Gallery 2==
{{main|Gallery2 module}}
The Gallery 2 module provides integration with Gallery, an open source web based photo album organizer. Gallery 2 source is not included with PGV, you need to download it from the offical [http://gallery.menalto.com/ Gallery] site.

==Lightbox==
{{main|Lightbox module}}
A display module using the [http://en.wikipedia.org/wiki/Lightbox_(JavaScript) Lightbox] script, a fancy display of the media associated with Individuals and Families, including an album and a slideshow.

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

== Internal Links ==

* [[:Category:Modules|List of current modules]]
* [[Developers_Guide:Creating_a_Module|Creating a PhpGedView module]]

[[Category:PhpGedView]]

[[Category:Modules]]

[[fr:Modules]]
[[da:modul]]

Standards For Sound Genealogical Research

2010-05-30T12:05:26Z

Momse: /* Standards For Sound Genealogical Research */

This article is a reproduction of information found on the National Genealogical Society's web site. It aims to provide guidance on how best to conduct and record information found through genealogical research.

==Standards For Sound Genealogical Research==
''Recommended by the National Genealogical Society''

Remembering always that they are engaged in a quest for truth, family history researchers consistently:
*Record the source for each item of information they collect.
*Test every hypothesis or theory against credible evidence, and reject those that are not supported by evidence.
*Seek original records, or reproduced images of them where there is reasonable assurance they have not been altered, as the basis for their research conclusions.
*Use compilations, communications, and published works, whether paper or electronic, primarily for their value as guides to locating the original records.
*State something as a fact only when it is supported by convincing evidence, and identify the evidence when communicating the fact to others.
*Limit with words like “probable” or “possible” any statement that is based on less than convincing evidence, and state the reasons for concluding that it is probable or possible.
*Avoid misleading other researchers by either intentionally or carelessly distributing or publishing inaccurate information.
*State carefully and honestly the results of their own research, and acknowledge all use of other researchers’ work.
*Recognize the collegial nature of genealogical research by making their work available to others through publication, or by placing copies in appropriate libraries or repositories, and by welcoming critical comment.
*Consider with open minds new evidence or the comments of others on their work and the conclusions they have reached.

== External Links ==
* [http://www.ngsgenealogy.org/cs/standards_for_sound_genealogical_research National Genealogical Society - Standards For Sound Genealogical Research]

[[Category:Genealogy|Standards For Sound Genealogical Research]]

Special:Badtitle/NS100:Contents

2010-05-30T11:54:47Z

Momse: /* Articles */

__NOTOC__
<table width="95%" valign="top" cellspacing="4" cellpadding="6" >
<tr bgcolor="#ADB7C9">
<td colspan="2" align="right">
__NOTOC__
<h1>Genealogy</h1></td>
</tr>
<tr valign="top">
<td width="50%" rowspan="2" bgcolor="#E0E6E0" valign="top">
==Articles==

*[[Evaluating Evidence Article| Evaluating Evidence: Barbara Krasner-Khait asks Elizabeth Shown Mills about the best practices for high-quality research]]
*[[Standards For Sound Genealogical Research|Standards For Sound Genealogical Research]]

</td>
<td valign="top" bgcolor="#D5E7E9">
[[image:Genstsign1.gif|right]]
</td>
</tr>
<tr>
<td align="top" valign="top" bgcolor="#D5DCE1">

==Resources and Links==
* [http://en.wikipedia.org/wiki/Genealogy Genealogy article in Wikipedia]
* [http://www.CyndisList.com Cyndi's List of Genealogy Sites on the Internet]
* [http://www.archives.gov/genealogy/ National Archives (NARA) Resources for Genealogist and Family Historians]
</td>
</tr>

<tr>
<td valign="top" bgcolor="#D5E7E9">

</td>
<td valign="top" bgcolor="#D3D7D9">

</td>
</tr>
</table>


[[Category:Genealogy|Contents]]

Manage Gedcoms

2010-05-30T11:44:12Z

Momse: /* Download (Gedcom) */

:''Also known as:'' '''Current GEDCOMs'''

:''Reached via:'' [[Admin Menu]]

All Gedcom management - adding, importing, downloading is done on the page called "'''Manage GEDCOMS and edit Prvacy'''" accessible from the Administrator's MyGedView Portal.

Due to historical reasons, user data is kept in two places, as two copies of the same data: in PhpGedView 'native' format in the database, and in the Gedcom format, in a file. This chapter explains the various operations on those two datasets.
==Gedcom and Family Tree==

PhpGedView deals with managing genealogical information packaged in datasets. The single dataset contains data on people and events, and has a consistent set of ID's. PhpGedView can manage multiple datasets or "Gedcoms", as they are called throughout the program and in this Wiki.

In this section we will use '''Gedcom''' to indicate the user dataset in the file form (e.g ''MyTree.ged'') and '''Family Tree''' to indicate the user dataset in PhpGedView native database form (e.g. ''My Family''). In the rest of the Wiki, Gedcom is used synonymously with Family Tree.

As with most programs, PHPGedView operates on the data in its native format (with few exceptions). The standard exchange operations between native and external format are called Import and Export:
* '''Import''' - transfers the user dataset from a Gedcom file to the database, converting it to the native format. It will overwrite the existing Family Tree or create a new one.
*'''Export''' - transfers the user dataset to a Gedcom file.

The Gedcom file containing the user dataset can reside on the server (in a location known to PHPGedView) or on the user computer, where it is archived, and where it possibly has been created. We have therefore a third operation, to transfer the file between those two locations:
* '''Copy''' - transfers the user dataset in form of a Gedcom file between the PHPGedView server and user computer.

If the Family Tree containing the particular user dataset does not exist yet, one uses the Create functionality:
*'''Create''' - creates a new Family tree in PhPGedView, and allows the user to set its options adn configuration parameters.

==Three-step Operation==

Creating a new Family Tree is generally a three-step operation:
# Copying a previously created Gedcom file to the server.
# Creating a Family Tree in PhpGedView, giving it a name and other configuration parameters.
# Importing the Gedcom file to populate the Family Tree with data.

If some of the steps are already completed, you can skip them and perform only the steps that are needed.

:* To create a new Family Tree without an existing Gedcom file (step 2 only with hidden step 3), use the ''[[#Create a New Gedcom|Create a New Gedcom]]'' functionality.
:* To create a new Family Tree with an existing Gedcom file (steps 1, 2 and 3) use the ''[[#Upload Gedcom|Upload Gedcom]]'' option.
:* To create a new Family Tree using the Gedcom already copied to the server, (steps 2 and 3) use the ''[[#Add Gedcom|Add Gedcom]]'' functionality.
:* To replace existing data in the Family Tree with an updated Gedcom, use ''[[#Upload Replacement|Upload Replacement]]'' (steps 1 and 3).
:* To replace existing data in the Family Tree with a Gedcom aleady on the server, use the ''[[#Import (Gedcom)|Import]]'' option (step 3).
:* To transfer file to the server, you can use ftp or other file transfer method (step 1).

===Copy Files===
You can copy files using ftp protocol, which has clients for every operating system, or by any other means. The details of file transfer are beyond the scope of this manual, you can read a short [[Upload GEDCOM file to server|tutorial]] on ftp transfer. If file size is a problem, you can transfer a zipped Gedcom file, the system will automatically recognize it and unzip it on arrival.

This separate transfer step is optional, you can upload and import Gedcom using PhpGedView functionality.

Please note that the '''Backup''' functionality acessible from the Admin menu does the Copy operation from server to the user computer (with additional options), but does not Export the Gedcom.

===Create a Family Tree===
Some of the functions (''Add Gedcom'', ''Upload Gedcom'', ''create a new Gedcom'') will lead you to the Gedcom configuration screen. At this point enter only the data identifying the Gedcom file (if any) and the Gedcom title, and leave the rest of parameters as default. You can return to this screen later.

;Path and name of GEDCOM on server
:Enter the Gedcom file name (with extension) here, if the file is already copied. You can enter only the file name, without a path - the system assume the location of your Index directory. If the file is not on the server, us the Upload Path field.

;Upload path
: If you the Gedcom is still on your computer, enter the path or click the "browse' button to locate the file on your machine. The file will be copied in the next step.

;Gedcom title
: Give your Gedcom a short descriptive title

;Save Configuration
:Press the Save Configuration button to proceed to the next step.

===Import Gedcom===
{{main|Import GEDCOM}}
In this step the Gedcom is checked, verified for validity, searched for the elusive BOM, and finally imported. The Family Tree data are cleared from the database, and replaced with the data in the imported Gedcom file. Only the Gedcom data are replacesd, common information (like users, common place data for Goole maps etc.) are not touched. You will be presented with several options and questions as you proceed trough the import process.

Import can take quite a long time, depending on the size of the file and selected options, so be patient. If you encounter the PHP time limit, the program will give you the option to continue the process.

This step is always performed, even if you do not have a prepared Gedcom file in which case a skeleton file is created and imported automatically.

==Gedcom management options==

[[Image:Current_Gedcoms.jpg|frame|center|Manage GEDCOMs and edit Privacy screen]]

===Add Gedcom===
''Add Gedcom = Create + Import''. Assumes that the Gedcom file (the Family Tree in Gedcom format) already exists on the server. '''Add Gedcom''' functionality creates a new Family Tree in PhpGedView and imports an existing file to populate the data.

===Upload Gedcom===
''Upload Gedcom = Copy + Create + Import''. This is a "three-in-one" function that allows you to skip theseparate copy step; it will (1) copy the Gedcom file from your computer to the server, (2) create a new Family Tree in PhpGedView and (3) import the freshly uploaded file to populate the data.

===Create a New Gedcom===
''Create a New Gedcom = Create''. This function creates a new Family Tree in PhpGedView and populates it with exactly one person, allowing you to start a new tree without importing any previously prepared files.

===Upload Replacement===
''Upload Replacement = Copy + Import''. Same as ''Upload Gedcom'', but applies to an existing Family Tree. Will replace the data for this Gedcom with the new file. Note that the replacement file must have exactly the same name as the original one.

===Import (Gedcom)===
''Import (Gedcom) = Import''. Applies to an existing Family Tree. Import will replace the user dataset in native format with the one supplied in the file. An option exists to not replace the file links. During Import the file is Gedcom file is verified, and additional data are written to it. The original Gedcom file is saved with the '.bak' extension.

===Export (Gedcom)===
''Export = Export''. This functionality will convert the user dataset from native format to the Gedcom file format, and save the file in the PHPGedView server location. It will not copy it to the (home) computer.

===Download (Gedcom)===

''Download = Export + Copy''. It will create an new Gedcom file from your Family Tree data and allow you to import it to your computer.

===Delete (Gedcom)===
Deletes the Family Tree. The corresponding Gedcom file is retained on the server and you can restore the Family Tree by importing it (use the ''Add Gedcom'' functionality).

===Check (Gedcom)===
{{main|TBD}}
You can verify the Gedcom for conformance with the Gedcom 5.5.1 standard. In general, PGV is very relaxed in enforcing the standard; it can accept and display Gedcom files created in other programs using different versions of the standard, or non-standard procedures. The Check Gedcom functionality can be used to verify the Gedcom for non-conformance, but very rarely the errors and warnings shown will cause any problems in importing the file.

===Check if Gedcom files are downloadable===
The Installation Guide suggests putting your Gedcom files in a directory not accessible to the webserver, to prevent surreptitious downloading your file and bypassing privacy. This functionality will check, if this is the case.

===Edit Configuration File===
{{main|Configuration File}}
Here you are returned to the Gedcom configuration screen, where you can edit the display, editing, privacy and other parameters for this Family Tree.

===Edit Privacy File===
{{main|Privacy File}}
This function opens the Gedcom Privacy configuration screen, where you can edit the detailed privacy settigns for this Family Tree.

===Default Gedcom===
Select the default Family Tree that will be shown on the webpage.

===SearchLog files===

===ChangeLog files===

PGVWiki talk:Community Portal

2010-05-16T17:25:31Z

Momse: /* Suggested Naming Conventions */

{{todo|Major}}

__FORCETOC__

=Suggested Naming Conventions=
A Place for Discussion around this topic

==phpgedview==

:This sounds good. You are saying that phpGedView will point directly to these pages? The best way to accomplish the header you mention is is via a template inserted into each such page. For example, I have done so at [[Installation Guide]]. [[User:Tom Haws|Tom Haws]] 09:22, 24 November 2005 (EST)

* '''Question''' Is there a compelling reason to make a clean logical split between these sections? Possibly could we keep all the phpGedView articles free of prefixes since that is what this wiki is about in the first place? Under this scenario, I envision a lot of blurring of boundaries. Instead, it might be better to think of those 6 pages as simple jumping off places. ??? [[User:Tom Haws|Tom Haws]] 09:22, 24 November 2005 (EST)

::'''Answer:'''Yes. Look at all the pages I have created under this premise, especially in the [[Administrators Guide|Administrators Guide]] (What you can not see from the ip address is all the graphics that go with this). It also lets you see where you are in that area very quickly. I can see links from the Administrators Guide to the Users Guide etc so I see this as being very important if we are to do a good documentation process.

:::Installation, User, and Admin are clean enough. But where I foresee continual muddling is in How to, FAQ, and Main Page. Suppose you are writing on (or from) [[Installation:Error messages]] for an error message that is an installation issue, and the answer is in FAQ, Main Page or How to. Is there any intuitive way to remember as you are writing off the cuff that you should write [[FAQ:Permissions]] instead of just [[Permissions]]? Maybe what you are proposing is right, but I want to understand that it is going to be easy to write for off the cuff. Let's try another, and tell me if I understand: I am writing for [[Installation: Fatal error: Call to undefined function: session_set_cookie_params]] and I want to refer to [[PHP session support]]. Should that be [[Administration:PHP session support]], [[Installation:PHP session support]], or neither? Now Error: might be a good namespace. I just don't know. I tend to think let's keep it as simple as possible. I'm having a hard time envisioning it. I sure wish we had that example of a successful documentation wiki. I want to avoid every possible obstacle to success. [[User:Tom Haws|Tom Haws]] 15:47, 24 November 2005 (EST)

==genealogy==

* '''Agree''' This is a subject not strictly about phpGedView, so it should be in a [[PGVWiki:Namespace]]. [[User:Tom Haws|Tom Haws]] 09:24, 24 November 2005 (EST)

==site help==

* '''Agree''' Not about phpGedView. Needs a namespace. See [[PGVWiki:Look outward, not inward]]. [[User:Tom Haws|Tom Haws]] 09:29, 24 November 2005 (EST)

==pgvwiki community==

* '''Agree''' Would it be okay to have shortcut namespaces for redirects only, such as [[PW:LOIN]] for [[PGVWiki:Look outward, not inward]] and [[PW:Portal]] (perhaps) for [[PGVWiki:Community Portal]]? Just to save typing. [[User:Tom Haws|Tom Haws]] 09:32, 24 November 2005 (EST)
::I see no problems with the creation of shortcut pages that will take you to correctly titled pages. --[[User:218.214.34.19|218.214.34.19]] 11:10, 24 November 2005 (EST)
::Sorry not logged --[[User:Laurie|Laurie]] 11:21, 24 November 2005 (EST)

=Languages=
Have moved the material from here to [[PGVWiki:Translations|here]]
--[[User:Laurie|Laurie Lewis]] 13:20, 1 December 2005 (EST)

=Shortcuts=
A place for discussion
==--[[User:Laurie|Laurie]] 11:49, 24 November 2005 (EST)--==
[[User:Tom Haws|Tom]] has suggested the use of shortcuts to make typing easier. The shortcut pages will have redirects to the correctly named pages. I see no issues with this. sorry for losing your original post Tom. Any other thoughs?

PGVWiki:Languages

2010-05-16T17:21:30Z

Momse: /* Languages */

[[image:128px-Globe_of_letters.png|right]]
==Languages==
===Currently Supported Languages at PGVWiki===
PGVWiki currently supports the following languages:

# Danish (da) : Added 5 December, 2005:LGT: [[User:Lordrebus]]
# English (en) : Added 17 November, 2005::LGT:[[User:Laurie]]

===Language Requests===
[[PGVWiki:Language requests|Requests for the installation of additional languages should be made here]]. These requests can only be made on the English page. (Make sure you provide a link to yourself so we can inform you when it has been done). A list of all the supported languages is available below.

===Languages Available for Installation===
Below are languages supported by MediaWiki (as of this version anyway). Not all languages are automatically added, if you need one, you need to make a request for it.

<pre>
'aa' => 'Afar' #Afar
'ab' => 'Abkhazian' #Abkhazian - FIXME
'af' => 'Afrikaans' #Afrikaans
'ak' => 'Akana' #Akan
'an' => 'Aragon&eacutes', # Aragonese
'als' => 'Alemannisch'# Alemannic
'am' => # Amharic
'ar' => # Arabic
'arc' => # Aramaic
'as' => # Assamese
'ast' => 'Asturianu', # Asturian, See BUG []
'av' => # Avar
'ay' => 'Aymar' #Aymara
'az' => 'Azrbaycan' #Azerbaijani
'ba' => # Bashkir
'be' => # Belarusian or Byelarussian
'bg' => # Bulgarian
'bh' => # Bihara
'bi' => 'Bislama' #Bislama
'bn' => ' - (Bangla)' #Bengali
'bm' => 'Bambara',
'bo' => 'Bod skad' #Tibetan
'br' => 'Brezhoneg' #Breton
'bs' => 'Bosanski' #Bosnian
'ca' => 'Catal&agrave' #Catalan
'ce' => # Chechen
'ch' => 'Chamoru' #Chamorro
'cho' => 'Choctaw',
'chr' => # Cherokee
'chy' => 'Tsets&ecirchest&acirchese' #Cheyenne
'co' => 'Corsu' #Corsican
'cr' => 'Nehiyaw' #Cree
'cs' => 'esky' #Czech
'csb' => 'Kasz&eumlbscziej' #Cassubian - FIXME
'cv' => ' - (va)' #Chuvash
'cy' => 'Cymraeg' #Welsh
'da' => 'Dansk' #Danish
'de' => 'Deutsch' #German
'dk' => 'Dansk'# 'da' is correct for the language.
'dv' => 'Dhivehi' #Dhivehi
'dz' => 'Dzongkha' #Bhutani
'ee' => 'Eve' #Eve
*'el' => # Greek
'en' => 'English' #English
'eo' => 'Esperanto' #Esperanto
'es' => 'Espa&ntildeol' #Spanish
'et' => 'Eesti' #Estonian
'eu' => 'Euskara' #Basque
'fa' => # Persian
'ff' => 'Fulfulde' #Fulfulde
'fi' => 'Suomi' #Finnish
'fj' => 'Na Vosa Vakaviti' #Fijian
'fo' => 'F&oslashroyskt' #Faroese
'fr' => 'Fran&ccedilais' #French
'fy' => 'Frysk' #Frisian
'ga' => 'Gaeilge' #Irish
'gd' => 'G&agraveidhlig' #Scots Gaelic
'gl' => 'Galego' #Gallegan
'gn' => 'Ava&ntildee\# Guarani
'gu' => # Gujarati
'gv' => 'Gaelg' #Manx
'ha' => # Hausa
'haw' => 'Hawai`i' #Hawaiian
'he' => # Hebrew
'hi' => # Hindi
'ho' => 'Hiri Motu',
'hr' => 'Hrvatski' #Croatian
'ht' => 'Haitian' #Haitian (FIXME!)
'hu' => 'Magyar' #Hungarian
'hy' => # Armenian
'hz' => 'Otsiherero' #Herero
'ia' => 'Interlingua' #Interlingua (IALA)
'id' => 'Bahasa Indonesia' #Indonesian
'ie' => 'Interlingue' #Interlingue (Occidental)
'ig' => 'Igbo' #Igbo
'ii' => 'Yi' #Sichuan Yi (FIXME!)
'ik' => 'I&ntildeupiak' #Inupiak
'io' => 'Ido' #Ido
'is' => '&Iacuteslenska' #Icelandic, according to Jeedo@irc
'it' => 'Italiano' #Italian
'iu' => # Inuktitut
'ja' => # Japanese
'jv' => 'Bahasa Jawa' #Javanese
'ka' => # Georgian
'kg' => 'Kongo' #Kongo (FIXME!)
'ki' => 'Kikuyu' #Kikuyu (FIXME!)
'kj' => 'Kuanyama' #Kuanyama (FIXME!)
'kk' => # Kazakh
'kl' => 'Kalaallisut' #Greenlandic
'km' => # Cambodian
'kn' => # Kannada
'ko' => # Korean
'kr' => 'Kanuri',
'ks' => ' - ()' #Kashmiri
'ku' => 'Kurd&icirc' #Kurdish
'kv' => 'Komi',
'kw' => 'Kernewek' #Cornish
'ky' => 'Krgzca' #Kirghiz
'la' => 'Latina' #Latin
'lb' => 'L&eumltzebuergesch' #Luxemburguish
'lg' => 'Luganda' #Ganda
'li' => 'Limburgs' #Limburgian
'ln' => 'Lingala' #Lingala
'lo' => 'Pha xa lao' #Laotian
'lt' => 'Lietuvi' #Lithuanian
'lv' => 'Latvie&scaronu' #Latvian
'mg' => 'Malagasy' #Malagasy - FIXME
'mh' => 'Ebon' #Marshallese
'mi' => 'Mori' #Maori
'mk' => # Macedonian
'ml' => # Malayalam
'mn' => # Mongoloian
'mo' => 'Moldoveana' #Moldovan
'mr' => # Marathi
'ms' => 'Bahasa Melayu' #Malay
'mt' => 'bil-Malti' #Maltese
'mus' => 'Muscogee',
'my' => 'Myanmasa' #Burmese
'na' => 'Ekakair Naoero' #Nauruan
'nb' => 'Norsk (bokm&aringl)' #Norwegian (Bokmal)
'nah' => 'Nahuatl',
'nds' => 'Plattd&uuml&uumltsch' #Low German or Low Saxon
'ne' => # Nepali
'ng' => 'Ndonga',
'nl' => 'Nederlands' #Dutch
'nb' => 'Norsk' #Norwegian [currently using old 'no' code]
'ne' => # Nepali
'nn' => 'Norsk (nynorsk)' #(Norwegian) Nynorsk
'no' => 'Norsk' #Norwegian
'nv' => 'Din&eacute bizaad' #Navajo
'ny' => 'Chi-Chewa' #Chichewa
'oc' => 'Occitan' #Occitan
'om' => 'Oromoo'# Oromo
'or' => 'Oriya' #Oriya - FIXME
'pa' => ' / / ' #Punjabi
'pi' => # Pali
'pl' => 'Polski' #Polish
'ps' => # Pashto
'pt' => 'Portugu&ecircs' #Portuguese
'qu' => 'Runa Simi' #Quechua
'rm' => 'Rumantsch' #Raeto-Romance
'rn' => 'Kirundi' #Kirundi
'ro' => 'Rom&acircn' #Romanian
'roa-rup' => 'Armneashti'# Aromanian
'ru' => # Russian
'rw' => 'Kinyarwanda',
'sa' => # Sanskrit
'sc' => 'Sardu' #Sardinian
'scn' => 'Sicilianu'# Sicilian
'sd' => # Sindhi
'se' => 'S&aacutemegiella' #(Northern) Sami
'sg'=> 'Sangro',
'sh'=> ' (Srbskohrvatski)'## Serbocroatian -- Obsolete
'si' => 'Simhala' #Sinhalese
'simple' => 'Simple English',
'sk' => 'Slovenina' #Slovak
'sl' => 'Sloven&scaronina' #Slovenian
'sm' => 'Gagana Samoa' #Samoan
'sn' => 'chiShona' #Shona
'so' => 'Soomaaliga' #Somali
'sq' => 'Shqip' #Albanian
'sr' => ' / Srpski' #Serbian
'ss' => 'SiSwati' #Swati
'st' => 'seSotho' #(Southern) Sotho
'su' => 'Bahasa Sunda' #Sundanese
'sv' => 'Svenska' #Swedish
'sw' => 'Kiswahili' #Swahili
'ta' => # Tamil
'te' => # Telugu
'tg' => # Tajik
'th' => # Thai
'ti' => 'Tigrinya' #Tigrinya - FIXME
'tk' => ' / ' #Turkmen
'tl' => 'Tagalog' #Tagalog (Filipino)
'tlh' => 'tlhIngan-Hol' #Klingon - no interlanguage links allowed
'tn' => 'Setswana' #Setswana
'to' => 'Tonga' #Tonga - FIXME
'tokipona' => 'Toki Pona', # Toki Pona
'tp' => 'Toki Pona' #Toki Pona - non-standard language code
'tpi' => 'Tok Pisin' #Tok Pisin
'tr' => 'T&uumlrk&ccedile' #Turkish
'ts' => 'Xitsonga' #Tsonga
'tt' => 'Tatar' #Tatar
'tum' => 'chiTumbuka', # Tumbuka
'tw' => 'Twi' #Twi -- FIXME
'ty' => 'Reo M`ohi' #Tahitian
'ug' => 'Oyghurque' #Uyghur
'uk' => # Ukrainian
'ur' => # Urdu
'uz' => # Uzbek
've' => 'Venda' #Venda
'vi' => 'Ting Vit' #Vietnamese
'vo' => 'Volap&uumlk' #VolapÃ¼k
'wa' => 'Walon' #Walloon
'wo' => 'Wollof' #Wolof
'xh' => 'isiXhosa' #Xhosan
'yi' => # Yiddish
'yo' => 'Yor&ugraveb&aacute' #Yoruba
'za' => '(Cuengh)' #Zhuang
'zh' => # (Zhng WÃ©n) - Chinese
'zh-cfr' => # Min-nan
'zh-cn' => '()' #Simplified
'zh-tw' => '()' #Traditional
'zu' => 'isiZulu' #Zulu
</pre>

==Related pages==

[[PGVWiki:Translations|PGVWiki:Translations]]

PGVWiki:Categorisation

2010-05-16T17:19:35Z

Momse: /* Links to categories */

For detailed technical information on how to use categories, see Wikipedia's [[w:Help:Category|Help:Category]].

==Approaches to Category Navigation==

Categories are utilised in two ways by users of the PGVWiki site in order to find articles of interest and relavence. These approaches have to be considered when formulating and expanding the hierarchy of categories.

===Top-Down Approach===

A user can browse the top-level of the categories hierarchy via the [[:Category:Contents]] page. The user then [[w:Drill_down|drills-down]] towards categories of increasing specificity by clicking the links within the subcategory section of the category page. This way the user can navigate towards articles of relavence.

===Bottom-Up Approach===

A user may have already found an article of relavence and wishes to find similar or a broader range of articles. The user can click on a category link at the bottom of the page to find articles within the same category. Following a similar link at the bottom of a category page will allow you to view the parent category in order to located more broadly categorised articles.

==How to categorise an article==

Categorising an article is simply performed by editing it, and including one or more category declarations. For instance, to add the ''[[Blocks]]'' article to the "PhpGedView" category, you would edit the article and enter <tt><nowiki>[[Category:PhpGedView]]</nowiki></tt> at the bottom, but ''before'' any [[w:Interlanguage links|interlanguage links]]. The appeal of categories is that they update themselves automatically, and you don't have to edit the category to add an article to it.

When adding an article to a category, or creating categories, one should be careful to use the correct categories and subcategories. Horizontal categorisation (below), refers to placing an article in the correct category while vertical categorisation refers to placing an article in the correct ''sub''category.

When assigning an article into categories, try to be thorough in a "horizontal" sense. You might need to poke around the [[:Category:Contents|category hierarchy]] a bit to find the right place. Try searching for articles similar to the article you are categorising to get ideas or to find the most appropriate place.

In the "vertical" dimension, placing articles only in the most specific categories they reasonably fit in. Thus, if an article relates to a Chart type in PhpGedView then it could be categorised under [[:Category:Charts]] but not [[:Category:PhpGedView]] since [[:Category:Charts]] is a subcategory of [[:Category:PhpGedView]]. It is expected that the user should be able navigate the categorise hierarchy to find related articles using one of the above [[#Approaches to Category Navigation|approaches]].

==When creating categories . . .==

===Look before you leap===
Before creating a category, look to see if one already exists. The best way to do this is to first add the category to your article but preview before saving. When previewing a page, scroll right to the ''very bottom of the browser window'' to see the categories. If the category appears in blue, the category already exists. If it is in red, then you will be creating a new category. Check the capitalisation of the category name. For any red categories, you should look for categories with similar names before creating a new category. One way to do this is to think of the parent category for the new category. Search for it and then look at the subcategories in the parent. You may find that a category already exists that is similar to the one you are thinking about creating.

Before creating a new category, familiarise yourself with all the guidelines on this page, and related pages. Categories are deleted, merged and renamed at the PGVWiki Admin's discretion, particularly if over-categorisation occurs.

Note that, although "uncreated" categories ''will'' correctly list articles that have been assigned to them, the category page itself does not exist until it is manually created. The easiest way to create the category page is to follow the red category link from your article and create a new category page with a parent category and a category description as explained in the next section.

==How to create subcategories==
Subcategories may be created by putting <nowiki>[[Category:</nowiki>''parent_category_name''<nowiki>]]</nowiki> onto the page that you would like to make into a subcategory. This may seem counterintuitive, because you edit the subcategory page rather than the parent category page.

Let's say that you wanted to make the category called '''Roses''' into a ''subcategory'' of the category called '''Flowers'''.

: Step 1 - Go to the page called <nowiki>[[Category:Roses]]</nowiki>, and click '''edit this page'''.
: Step 2 - Place the text '''<nowiki>[[Category:Flowers]]</nowiki>''' within the body of the <nowiki>[[Category:Roses]]</nowiki> article, and save.
: Finished! '''Roses''' is now a subcategory of '''Flowers''', and <nowiki>[[Category:Roses]]</nowiki> will be visible on <nowiki>[[Category:Flowers]]</nowiki>.

==Links to categories==
You can create a link to a category page without adding the page to that category by using a colon before the word Category. Example: <tt><nowiki>[[:Category:Charts]]</nowiki></tt> appears as [[:Category:Charts]].

==Category sorting==
===Pipe tricks and sort keys===
Contrary to some expectations, text after a pipe ("<tt>|</tt>") in a category link is not used in place of the category text. Rather, this text is used as the [[w:sort key|sort key]] on the category page itself. However, again contrary to expectations, that sort text is '''not''' displayed. For example, <nowiki>[[Category:User|Nathan Watson-Haigh]]</nowiki> used in the [[User:Nathan Watson-Haigh|user page of Nathan Watson-Haigh]] will make the "User:Nathan Watson-Haigh" page list under N rather than U in the category.

===Setting a default sort key===
The default sort key of a page for categories can be changed using the <code><nowiki>{{DEFAULTSORT}}</nowiki></code> [[w:Magic word|magic word]]. For instance, on [[User:Nathan Watson-Haigh]], <code><nowiki>{{DEFAULTSORT:Nathan Watson-Haigh}}</nowiki></code> would cause <code><nowiki>[[Category:User]]</nowiki></code> to be equivalent to <code><nowiki>[[Category:User|Nathan Watson-Haigh]]</nowiki></code>, not <code><nowiki>[[Category:User|User:Nathan Watson-Haigh]]</nowiki></code>. This is especially useful when the article belongs in many categories. If more than one default sort key magic word is present on a page, the last occurrence is the one used. The <code><nowiki>{{DEFAULTSORT}}</nowiki></code> magic word affects all categories that the article is in, regardless of the position of the magic word relative to the category. It does not just affect subsequent categories. The default sort key can be overridden for individual categories applied to an article by manually applying a sort key.

An easy way of overriding the magic word and using the current article name as the sort key is to use the <code><nowiki>{{PAGENAME}}</nowiki></code> template after the pipe, e.g. <code><nowiki>[[CATEGORY:User|{{PAGENAME}}]]</nowiki></code>. Using this template will cause the article to appear in the position appropriate to its full article name if the article is moved.

[[Category:PGVWiki]]

PGVWiki:Namespace

2010-05-16T17:16:57Z

Momse: /* Help: */

[[image:Policy.png|right]]__TOC__
The MediaWiki software powering PGVWiki provides several '''namespaces'''. A namespace is a "zone" that contains specific types or groupings of wiki content. It is generally shown by the use of a prefix before the title of a page.

When creating pages of content, consideration should be given to the use of the appropriate '''namespace''' for the page. The '''namespaces''' used in PGVWiki are shown below in bold. Prior to creating pages users should also read [[PGVWiki:Categorisation]] to further understand how pages can be grouped together.

==PGVWiki Namespaces==

Namespaces are configured into the PGVWiki installation so that pages within a registered namespace can receive special treatment. There is nothing to stop you creating an article such as <nowiki>[[SomeDummyNameSpace:Article_Name]]</nowiki>, however, because "SomeDummyNameSpace" is not a registered namespace it does not receive any special treatment - therefore, this is not encouraged and article doing this will be moved.

===main namespace===
: The zone for the actual documentation of PhpGedView. It contains no prefix, and pages in this namespace are created simply by creating <nowiki>[[links]]</nowiki>.

===PGVWiki:===
: This namespace is the namespace for pages pertaining to the wiki itself. These pages deal with the policies, guidelines and issues pertaining to the running, maintenance and growth of PGVWiki.

===User:===
: This namespace is set aside for personalized pages pertaining to the PGVWiki contributors. This may include personal presentations, scratch pages, rough drafts, and archives of content. It is ''not'' intended for use as personal webspace (see [[PGVWiki:What PGVWiki is not|What PGVWiki is not]]).

===Genealogy:===
: This namespace contains pages related to the topic of Genealogy that may assist users of PhpGedView.

===Help:===
: This namespace is for pages that provide guidance for using MediaWiki (the software behind the PGVWiki). It is not to be used in page titles related to PGVWiki or PhpGedView.

===Image:===
: This namespace is created for [[Help:Image description page|image description page]]s that provide information concerning images.

===Special:===
: This namespace consisting solely of pages that are dynamically created by the MediaWiki software on demand (i.e. [[Special:Recentchanges|recent changes]]). These pages can be linked using the usual method, except when parameters are required (then the full URL must be used).

===Template:===
: This namespace is used to create customizable sections of text that can be included in multiple articles. The are included using the <nowiki>{{template}}</nowiki> markup (see [[Help:Template|Template]]s).

===MediaWiki:===
: This namespace is used to contain text clippings that allow customization of the wiki's user interface. Pages in this namespace may only be edited by the [http://wiki.phpgedview.net/en/index.php?title=Special%3AListusers&username=&group=sysop&limit=50 PGVWiki admin team].

===Category:===
: This namespace contains all the various [[Help:Category|categories]] into which articles can be grouped.

==Talk namespaces==
Each namespace (except for Special:) also has an associated '''Talk:''' namespace linked to it. These pages are set aside for discussion of the articles as necessary. Examples of the most frequently used Talk namespaces are:

* Talk:
* PGVWiki talk:
* User talk:
* Image talk:

[[Category:PGVWiki|Namespace]]

PGVWiki:Site guidelines

2010-05-16T17:15:37Z

Momse: /* PhpGedView documentation */

[[image:Policy.png|right]]
==PhpGedView documentation==
In order to provide a consistent documentation status for the whole of the community using phpGedView the English site’s documentation will be considered to be the “core source” for the documentation.

The documentation source for phpGedView has been divided into 5 areas

*Administrators guide
*Installation guide
*Users guide
*FAQ
*How to

All PhpGedView documentation translations should be based on the English version. Improvements and changes to the documentation can be initiated in any language group, but as they are updated for that language group, the English version MUST be similarly updated. In this way other language groups can monitor and be informed of the changes and appropriate changes can be made in their documentation. Whilst this is in some ways prescriptive it enables enhancements in the phpGedView documentation to benefit the whole of the community.

[[PGVWiki:Translations#Language "Go-Tos" (LGTs)|LGTs (Language Go Tos)]] should monitor these areas for changes.

Users who change documentation in their language group (other than English) who are able to translate into English are asked to do so to assist LGTs in keeping the core version up to date.

==Languages==
This is dealt with [[PGVWiki:Languages|here]]

==Translations==
This is dealt with [[PGVWIki:Translations|here]]

Installing PhpGedView for Development

2010-05-16T17:11:55Z

Momse: /* Setting up a virtual directory */

== Setup ==
Make sure that you have followed the instructions in the following documents before continuing:
* [[Installing PHP on Windows]]
* [[Installing Eclipse on Windows]]
* [[Installing MySQL on Windows]]

== Setting up a virtual directory ==
When developing, it is very convenient to be able to test immediately the code that you are developing. The easiest way to enable this is to setup a virtual directory which points to the location where you checked out the PhpGedView project files.

=== Setting up a virtual directory in IIS ===
# Open the Internet Information Services manager
## Control Panel->Administrative Service->Internet Information Services
# Expand the sites until you get to the ''Default Web Site''. You should see something similar to the following image:[[Image:Clipboard02.png]]
# Right-click on the ''Default Web Site'' option and select the ''New->Virtual Directory'' option from the context menu. This will open the Virtual Directory Creation Wizard. Click ''Next'' to get started.
# In the Alias field, enter the name you want to use to access your PhpGedView installation. ''PGV'' is a good choice. This will allow you to access your site using a url like http://localhost/PGV/
# In the Directory field, browse to your project directory in your Eclipse workspace.
## To find where you Eclipse workspace is located, in Eclipse choose the File->Switch Workspace menu option. The window that pops up will show you the path to your Eclipse workspace.
# On the ''Access Permissions'' screen make sure that the Read, Run Scripts, Execute, and Write options are checked. Click Finish.
# Add index.php to the default documents list
## Right-click on the new Virtual Directory and select "Properties" from the context menu
## Switch to the "Documents" tab and add "index.php" to the list of default documents.
# Next you will need to set the proper file permissions for the index directory. The index directory is a directory that must be writable by the application where it will store configuration files.
## In a windows explorer window, browse to your workspace folder.
## Right-click on the ''index'' directory and select properties. Then select the ''Security'' tab.
## Give the ''Users'' group or the ''Everyone'' group full control
# Repeat the permissions steps for the ''config.php'' file and the ''media'' directory
# You may now begin configuring PGV by opening a browser and going to the URL http://localhost/PGV/ This will bring up the main PGV configuration screen.
# If you get any errors saying ''Permission denied opening stream FILE_PATH'' where FILE_PATH is the path to a file, then you will need to set some more permissions. This is strange setting in the way that your computer has been configured. Follow these steps to get around it:
## Right click on the ''includes'' directory, select properties, and go to the security tab.
## Make sure that the ''Users'' group or ''Everyone'' group has read and execute permissions
## Then click the ''Advanced'' button.
## Check the option ''Replace permission entries...'' and click Ok.
## For every permission denied error, repeat the steps above on the containing folder. You will likely need to do this for the following directories: languages, themes, webservice, includes/SOAP, includes/db
## When you have no more errors then you can continue configuring

=== Setting up a virtual directory in Apache 2 ===
# Open the httpd.conf file for your Apache web server
# Scroll to the bottom of the file and add the following block of code (changing the relevent paths of course). Then restart the server.
Alias /pgv "C:/phpGedView/workspace/future/"
<Directory "C:/phpGedView/workspace/future/">
Options Indexes FollowSymLinks MultiViews ExecCGI
AllowOverride All
Order allow,deny
Allow from all
</Directory>

You will also need to find the line as follows:

'''DirectoryIndex index.html index.html.var'''

add index.php to the end of the line so that it looks like this:

'''DirectoryIndex index.html index.html.var index.php'''

== Configuring PhpGedView ==
# Copy config.dist to config.php
# Open the URL http://localhost/PGV/ in a web browser
# In the Database Username field enter the username ''root'' (unless you specified a different user for MySQL)
# Leave the password field blank (unless you specified a password when configuring MySQL)
# Leave all of the other options as their default settings and click the ''Save configuration button''
# Next you will be asked to create an administrative user for your PGV site. Fill in all of the fields and click the ''add user'' button. Click on the Manage Gedcoms link.
# You will now be asked to either create a new GEDCOM or Upload one.
# You can download a [http://www.phpgedview.net/devdocs/presidents.ged GEDCOM of the presidents of the United States] and upload it into your site using the ''Upload GEDCOM'' link.
## You can also get a [http://www.phpgedview.net/devdocs/media.zip ZIP file] of some of the media included in that presidents GEDCOM.
## In the ''Upload path'' option, select the ''Browse'' button and choose the GEDCOM file that you want to upload.
## Fill in an Optional title from your GEDCOM and change any of the desired settings. Then click the ''Save configuration'' button. The defaults are fine for most options.
# You can also start from scratch and enter your own data by selecting the ''Create a New GEDCOM'' link.
## In the ''Path and name...'' field, enter a file name for your GEDCOM with a ''.ged'' extension (e.g. test.ged or myfamily.ged).
## Fill in an Optional title for your GEDCOM and change any of the desired settings. Then click the ''Save configuration'' button. The defaults are fine for most options.
# After you have uploaded or created a gedcom file, you will be taken to the page to import the GEDCOM file into the database. Keep pressing the ''Continue'' button until you get a page saying that the import was complete.
# On the right-hand side of the page you will see several links. Click on the link to go to the pedigree chart to begin seeing the data.


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

Help:Logging-in

2010-05-16T16:56:48Z

Momse: /* Logging in */

Logging in is not required for viewing pages, and but is required for editing them. However, it provides additional features, and in general PGVWiki recommends it.

==Logging in==
Creating a user account means that you supply a [[PGVWiki:Username|username]] (your real name or a nickname) and a password. The system will reject a username that is already in use. A user account is created only once. You are then "logged in". Next time you log in you supply your username again and demonstrate with the password that you are the same person.

Edits you make are recorded under your username.

== Why log in? ==

You don't have to log in to read. You need to log in to edit.

However, it's still a good idea to log in, for these reasons:

* Other users will be able to recognise you by your username when you make changes to pages.
*You will have your own ''user page'' where you can write a bit about yourself, and a ''user talk page'' which you can use to communicate with other users.
* You will be able to mark an edit as minor, which avoids inconvenience for other users.
* You will be able to keep track of changes to modules you are interested in using a ''watch list''.
* If you choose to give an email address, other users will be able to contact you by email. This feature is anonymous - the user who emails you will not know your email address. You don't have to give your email address if you don't want to.
* You will be able to [[Help: Renaming (moving) a page|rename pages]].
* You will be able to set your own ''[[Help:Preferences|preferences]]'', to change things such as:
** The number of pages displayed in ''[[Help:Recent changes|Recent changes]]''

== How to log in ==

First, make sure that your browser accepts cookies. Some browsers can accept or reject cookies from individual sites; users of these should configure the browser to accept cookies from PGVWiki. Click on the ''Log in'' link at the top right of the page. You will then be prompted to enter your username and password. If you haven't logged in before, you will need to enter your password twice.

You may give your email address if you like. Other users will be able to send email to the address, but they won't be able to find out what the address is.

If you click the box ''Remember my password across sessions'', you will not have to give your password again when you access PGVWiki from the same computer. This feature will only work if your password was not generated by the Mediawiki software. So change your password please.

=== Log in problems ===
If you appear to be able to log in, but as soon as you try to look at a page after the 'Log in successful' page you appear logged out again, it is very likely to be a cookie problem. If you are certain that cookies are enabled, make sure that you haven't inadvertently listed wiki.phpgedview.net on a list of sites to never allow cookies for. Also make sure your computer's date and time are set correctly; if they are not, cookies may expire before they are supposed to.

If you log in and enabled the cookie feature, a subsequent log in as a different user without the cookie feature enabled will appear as logged out.

=== What if I forget the password? ===
If you enter an e-mail address when signing up for the account, or in your Preferences, you can request on the login screen for a temporary password to be sent to that address, which will allow you to retrieve your account. If you did not enter an e-mail address, or the address was out of date, but you are determined to regain access to the account, you ''might'' be able to persuade someone with direct access to the database that it is your account, and ask them to retrieve it for you.

==Username==
Note that in some sans-serif fonts I (capital-i) and l (lowercase-L) look exactly the same, e.g. in Arial: I and l. If your user username contains one of the two, it may be wise to register also under the name that may look the same, without using that name, to prevent impersonation.

== How to set preferences ==
Click on the ''Preferences'' link at the top right of the page for various options, including:
* Changing your password.
See [[Help:Preferences]].

== Your ''User page'' and ''User talk page'' ==
As a logged in user, you will be able to create your own ''user page'' and ''user talk page''. When you are logged in, you will see your username displayed at the top right of the page. Click on this to get to your user page, which you can edit in the same way as any MediaWiki wiki page.

Most users write a little bit about themselves and their interests on their user page.

You also have a ''User talk page''. You can access this by clicking on the ''Talk'' link next to your username at the top right of the page. Other people may write messages in your user talk page by editing it, and you can respond. See [[Help:Talk page]] for more.

== How to log out ==
You can log out any time by clicking on the ''Log out'' link at the top right of the page.

[[Category:Help|Logging in]]

Help:Username

2010-05-16T16:53:38Z

Momse: /* Signatures */

When you create a new account, so you can log in, one of the things you'll have to do is pick a username. This page gives some advice on this.

== What are usernames used for? ==

Your user name will be attached to all your edits, while you're logged in. This is partly for reasons of accountability. It is also helpful from a copyright perspective: if someone wants to use your contributions in a way not allowed under the copyright, they can ask you on your talk page, for example. Also, the GFDL encourages giving appropriate credit to authors, and your username is used to give that credit.

We recommend against using multiple usernames, unless you have a very good reason.

== Choosing a username ==

The best username is typically either your real name, or a longstanding Internet pen name. Please pick a username that you're comfortable writing under, but it also means picking a name that others are comfortable seeing and collaborating with. Remember that a controversial name may colour other users' perspective on you. In addition remember that PGVWiki is a world-wide book so take care in selecting a name to avoid anything that might potentially cause offence to someone from a different culture, religious or ethnic group.

PGVWiki recommends that users avoid
# names of politicians, military or religious figures or events;
# any other names that may be seen as potentially offensive, or endorsing or opposing the politics, policies or beliefs of a public figure.

People should be able to judge you purely on your contributions, not an emotional response to a potentially controversial nickname. Avoiding such names is in your own interest. So do please be careful. Remember you are working as part of a community. Show everyone else the respect for their beliefs that you expect them to show to you.

===Username capitalization===
PGVWiki usernames are case sensitive and, for consistency, the first letter of all usernames will be capitalized when you create an account. This means that if you request the username "'''your name'''", the account created will instead be: "'''Your name'''".

If your username will consist of more than one name, and you'd like your signature to be internally consistent, you might prefer to capitalize each one when you create the account. This conforms to the widely accepted rules of capitalization: usernames are, after all, proper nouns. Examples would be "'''Your Name'''", "'''Your Middle Name'''", and "'''Your M Name'''".

== Inappropriate usernames ==
Fairly or unfairly, the line between acceptable and unacceptable user names is drawn by those who find the username inappropriate, not by the creator of the name.

=== Signatures ===
Through the [[Special:Preferences|Preferences]], one can choose a nickname used in signatures, independent of the actual user name (connected to a User: page). In general, the same rules apply for signatures as for usernames. A signature should not be misleading.

=== Changing inappropriate usernames ===
If enough people complain about your user name the administrators will change it. Neither complaints, nor name changes should be arbitrary, but user names that are offensive to a significant number of people will be changed, not without notice, but without appeal. Where inappropriate or borderline inappropriate usernames are coupled with vandalism, the username may be blocked indefinitely on sight: again. Usernames that are designed to impersonate legitimate users may be blocked immediately. The IP address of these users should be left autoblocked.

[[Category:Help|Username]]

How to recreate the pgv news table from the news.dat backup file

2010-05-16T16:48:35Z

Momse: /* Checking the file */

== Overview ==

The news.dat file from a previous backup can be used to recreate the pgv_news table. Basically it involves scrubbing unnecessary information from news.dat, and importing the new file using a CSV import into pgv_news from the phpMyAdmin console. You will only need to do this if your PGV database gets hosed and you don't have a good recent backup of the tables but do have a recent backup from the PGV Admin menu. These news and journal items are not stored in the gedcom file.

=== Scrubbing news.dat ===

The bulk of the task lies in scrubbing news.dat. The first step is to copy news.dat to a new file. Let's call the new file news_clean.dat. At this point, news_clean.dat looks a little like this:

a:27:{i:36;a:5:{s:2:"id";s:2:"36";s:8:"username";s:6:"vhhawk";s:4:"date";s:10:"1232506030";s:5:
"title";s:28:"New Arkansas twigs to expand";s:4:"text";s:682:"By chance I discovered 3 new Doe
families living in proximity in the 1860 census in Clark County, Arkansas. I also still have
work to do to expand the Amanda and "Jonathan" Bacon family, not yet done.";}i:35;a:5:s:2:"id";
s:2:"35";s:8:"username";s:13:"crudupfamilies.ged";s:4:"date";s:10:"1231822465";s:5:"title";s:20
:"The Illinois Bacons";s:4:"text";s:488:"I have been working recently to update the Illinois
Bacon lines through the 1930 census records. I would surely welcome any input to help me
straighten them out. ";}i:34;a:5:s:2:"id";s:2:"34";s:8:"username";s:6:"vhhawk";s
:4:"date";s:10:"1231132454";s:5:"title";s:16:"Nobels of Texas";s:4:"text";s:148:"Currently
crawling the censuses and the "Texas Death Index" for these people. There's more than the
usual number of misspellings. It's challenging.";}i:33;a:5:

You can use any text editor to work on this file. Above is the first three items taken from an actual news.dat backup file, with some minor changes to the text for the sake of privacy. You want the above data in news_clean.dat to look like this after your first edit:

"36";"vhhawk";"1232506030";"New Arkansas twigs to expand";"By chance I discovered 3 new
Doe families living in proximity in the 1860 census in Clark County, Arkansas. I also still
have work to do to expand the Amanda and "Jonathan" Bacon family, not yet done."
"35";"crudupfamilies.ged";"1231822465";"The Illinois Bacons";"I have been working
recently to update the Illinois Bacon lines through the 1930 census records. I would surely
welcome any input to help me straighten them out."
"34";"vhhawk";"1231132454";"Nobels of Texas";"Currently crawling the censuses and the
"Texas Death Index" for these people. There's more than the usual number of misspellings.
It's challenging."

The key thing to note is that you've reduced the data to five elements for each news/journal item. Each element is delimited by double-quotes on each side, and each element is separated by the semicolon character. The end of each row has no semicolon. The five elements are the item number, the user or gedcom, the date in Unix format, the title of the item, and the text of the item. If there is a userid in field 2, then it's a user journal item. If there is a gedcom in field 2, then it is a welcome page news item. You don't have to put these in any order: the import process and the display software are able to figure out what goes where.

=== Embedded special characters " and ; ===

Notice that the above file uses the doublequote and the semicolon as delimiters. If any of these characters are embedded within the text field they must be changed. In the above, the text fields contain "Jonathan" and "Texas Death Index". Replace those with single-quotes such as 'Jonathan' and 'Texas Death Index'. In the same way, if your text field contains semicolons (;) replace those with other punctuation.

=== Embedded HTML and vertical spaces ===

If you have any hypertext links or other embedded HTML, the original news.dat file will contain interpreted HTML code. That is, a less-than symbol < will be written as an ampersand & followed by "lt;" -- you must change these back to the symbolic characters prior to import. Any vertical blank spaces should be converted to HTML paragraph code.

I attempted to show those special characters here but Wiki keeps interpreting them.

=== Checking the file ===

A good way to further check your file is to log onto your site and create a new (bogus) news or journal item, exit from your site, open a phpMyAdmin page, click on your pgv_news table, click on Export, and then choose CSV format with everything else left at default. Compare your news_clean.dat file with the just exported datafile.

=== Importing news_clean.dat ===

When you're ready to import news_clean.dat, open up a phpMyAdmin session, go to pgv_news, and click on Import / CSV with all other defaults left alone. Browse to news_clean.dat, and proceed. If there are any problems with the import, it will tell you at what line number the fault occurred. Reopen news_clean.dat, navigate to that line number, and fix the problem. In phpMyAdmin, you can choose to delete previously imported lines in the pgv_news table and restart the import. If you don't do this you will get errors about reusing an index number. When the import is finally clean, you're done.

How to install PunBB Forum

2010-05-16T16:47:18Z

Momse: /* Re-activate after PGV update */

[[Image:PunBB_logo.png|right]]
==Installation==
A brief guide to installing the [[PunBB module]].

To add the PunBB module:
# copy the included "modules" directory to your PhpGedView installation (if you did not download it with PhpGedView)
# Rename the PunBB config file at modules/punbb/config.php to configold.php using a program such as FileZilla or your hosting control panel's file manager.
# To activate the module use the url (replacing the bold portions appropriately):
#: http://'''yourdomainname.com'''/'''phpgedview'''/module.php?mod=punbb&pgvaction=install
#:The path may vary according to your installation.
# When activating the module, you will be asked to fill out your database connection parameters again and create a forum administrator
# After saving the configuration, you may be prompted to copy the configuration text into the PunBB configuration file ''config.php''
# The menu item for "Message Forum" from PHPGedView should now work.

To link to the forums, use the url:
http://'''yourdomainname.com'''/'''phpgedview'''/module.php?mod=punbb


==Sample configuration file==
A sample config.php file looks like this:

<pre>
<?php
$db_type = 'mysql';
$db_host = 'localhost';
$db_name = 'arw_name';
$db_username = 'arw_user';
$db_password = 'password';
$db_prefix = 'punbb_';
$p_connect = false;
$cookie_name = 'punbb_cookie';
$cookie_domain = '';
$cookie_path = '/';
$cookie_secure = 0;
$cookie_seed = '433a0c44';
define('PUN', 1);
?>
</pre>

==Re-activate after PGV update==
If you are upgrading PhpGedView to a new version, the Message Forum may not work. You should save the copy of the configuration file before PGV upgrade. After the update, replace copy the saved PunBB ''config.php'' file to the modules/punbb directory.

==PunBB upgrades==
The version distributed with PhpGedView (PunBB 1.2.12 with PhpGedView 4.1.4) has been tested with this version. The upgrade may or may not work correctly. Check the [http://punbb.org/docs/install.html PunBB installation instructions] and the [http://punbb.org/forums PunBB Forums] for PhpGedView related entries.
[[Category:How To]]

[[Category:PunBB Module]]


[[fr: Comment installer le module PunBB]]

Use subversion (SVN)

2010-05-16T16:45:58Z

Momse: /* Update */

== SUBVERSION ==

This is a simplified explanation of Subversion (SVN). The aim of these notes is to show you how to use SVN as a source for draft PhpGedView files. It does not cover any other function. If you want to know more about SVN, try http://svnbook.red-bean.com/.

SVN is a version control system. Wikipedia says “It allows users to keep track of changes made over time to any type of electronic data. Typical uses are versioning source code, web pages or design documents.”

Open source software like PhpGedView has many contributors. As revisions are written, the developer(s) “commit” the changed files into a repository. This repository is the core filing cabinet for the SVN system. Other developers and users can draw these files from the repository. But, with many hundreds of files involved, sharing changes could be quite complicated without SVN control software.

Using control software, you can create a parallel version of the repository on your computer. The software then allows you to keep the two locations synchronized, so you always have a copy of the latest revisions.

From there, you can work on the source files, or upload the revisions to your server, either local or remote, to test and comment on.

<center>
=== PART 1 ===
</center>
[[image:svn1.jpg|center|215px]]
====Installing A Client (for Windows Users)====

[[image:svn2.jpg|left|260px|thumb]]There are some good Windows tools available that will give you the means to build a replica of the files in the repository on your computer. Tortoise is one piece of software, and will be used in this Wiki to guide you along. Tortoise is free, and can be downloaded from http://tortoisesvn.tigris.org/

There are other clients available. SmartSVN is a more full-featured client, and it too is free (you don’t need the professional version).

Installation is quite straight-forward. This is the welcome setup screen for the Tortoise version used to prepare this document.

Click on '''Next>''' to start the process. .[[image:svn4.jpg|right|191px]]

There is little to gain (or lose) by choosing options on the next screen, so simply click '''Next>''' again.

When the process is complete, restart your computer.

====Installing A Client (other)====

For '''Linux/*BSD/Unix''' the command line SVN client can be installed for your distribution of choice. See: http://subversion.tigris.org .

For '''MacOS X users''', see [http://www.wikihow.com/Install-Subversion-on-Mac-OS-X WikiHow] for several options and additional links.

====Checkout====

[[image:svn5.jpg|left|86px|thumb]]When your computer has rebooted, right-click anywhere on the screen. You will get a list with a couple of new entries – SVN Checkout and TortoiseSVN.

The next part of the process is to get a copy from the repository to your computer – in the parlance, do a “checkout”. So select the first of the new options.
[[image:svn6.jpg|left|233px|thumb]]

This brings you to the only typed/copied and pasted input required.

The URL is below on one line!

Tortoise will suggest a target/checkout directory, which you can adjust to suit. It is preferable to keep the path simple.

C:\Checkout would be a practical suggestion, so amend the second input box to read that. 

 
 

====PGV repository on the SourceForge server====

The URL is https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/trunk/phpGedView (this currently is 4.1.1)

or:

https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/branches/phpGedView-4.2 (this currently is the draft of 4.2)

Type your selection exactly as shown here, or cut and paste it if convenient. Then, as nothing else needs attention, click OK.

[[image:svn7.jpg|left|283px|thumb]]Things get busy now. A long list of files will scroll through the window as they download to your computer.

At this time, Tortoise will download about 12,600 files, consuming a bit over 100 MB of disk space (the actual files total about 70MB, the rest is slack space).

When the download has finished, open Windows Explorer and scroll down through your main folders. Buried in there will be the Checkout folder, with a small green dot/tick to indicate that this is a special folder. [[image:svn8.jpg|right|120px]]

If you open the Checkout folder, you will see some differences between this folder and a more usual one.

The small green circle/tick is repeated to tell you that this is a SVN folder, subfolder or file. And there will be subfolders labelled “.svn”
[[image:svn9.jpg|right|137px]]
 
 <center>

===PART 2===
</center>
[[image:svn10.jpg|center|427px]]
====.svn====

These folders are both a blessing and a curse. The blessing is that they hold all the version information for the other files in the mother folder. When you do an update, Tortoise will compare the information about the files you hold with the information about the files at SourceForge. If the information is identical, there is no need for a download because you have the latest. If the SourceForge file is newer than yours, then it has to be downloaded, and the .svn files updated to show this. This has many advantages, including
* the ability to reverse-out an update if you find a problem with it
* comparing the update with the previous change
* merging the changes to any manual alterations to the files you have done for your own purposes, etc

They are a curse because, if you are working your files to a remote server, you don’t want to upload all this extra baggage. To give you some idea: .svn about doubles the number and gross disk space used by PGV.

====Preparing To Upload====

Whether to a local or remote location, the next step will be to copy the files from your computer to that server. But first, it would be wise to do some housekeeping.

The .svn folders are not wanted or needed in the final location, so they need to be cleaned out. To do this is quite easy, by and large. Here are two longhand ways and a shorthand way - if your FTP client is up to it, jump straight to Part 3.

[[image:svn11.jpg|left|185px|thumb]] '''Longhand #1:''' Tortoise has an Export command. Find the Checkout folder and right-click on it. The side menu that opens has an item “TortoiseSVN”, which leads to Export…” Select this. 

[[image:svn12.jpg|left|165px|thumb]]
Select where you want to create the exported copy and click on Make New Folder. Select OK.

This process will make a fresh copy of Checkout, but without all the .svn folders.

A warning: this process does '''not''' currently work with Microsoft Vista.

'''Longhand #2:''' the second longhand way is also easy. Copy all the files to a new folder – call it “xxxxx” for this example.

Open a command line window – “Run” then “cmd”

Now type in this line: '''for /r c:\xxxxx %f in (.svn) do rd /s /q “%f”''' and press Enter

That will clean all the .svn subfolders from “xxxxx” for you.

Why follow this longhand path? It is useful when you plan to delete anything you don’t want or require – eg, modules you don’t plan to use, flags, themes, language files. But, unless you are really short of server space, leave them in place. Uploading them intact can be useful because it simplifies later updates.

When this has been finished, you are ready to upload the files in “xxxxx” to your server. You can now go ahead and configure and populate the SVN version of PGV.

<center>

===PART 3===
</center>
[[image:svn13.jpg|center|217px]]
The whole point of SVN is that, as files are amended, you can download copies to your computer, and then upload them to your server.

====Update====

[[image:svn14.jpg|left|190px]]Open your file directory, and right-click on the SVN folder.

Left-click on SVN Update. The Tortoise system will check all your current files against the repository, and download any repository files that are more recent.
 

====Synchronize====

Now you need an FTP client with the ability to synchronize your files with the server files. And, as your files have all the .svn folders, it is essential that you can set some conditions to prevent them being uploaded as well.

One useful client is at http://winscp.net/eng/index.php. Get a copy and install it. Arrange the conditions for it to connect to your server site. Connect to test your handiwork.

[[image:svn15.jpg|left|155px|thumb]] At this stage, go to the menu bar and select Commands / Synchronize… [[image:svn16.jpg|right|222px|thumb]]

Now you can control the upload to your server. Select “Remote” as your target directory, and tick the “Existing files only” box. This ensures that the only files uploaded are a match for the files already on the server.

However, there will be times when new files are added to the repository. In that case, because they won’t have yet been uploaded to your server, this system won’t copy them or new issues of them.

[[image:svn17.jpg|left|270px|thumb]]
 
So, instead, click on Transfer settings, and on the next screen, work your way to Transfer/Presets, then click the Add button.
[[image:svn18.jpg|left|321px|thumb]]Give this “Preset” of conditions a name – “Mine” or “Mask_1” to suit.
 
Down the lower left, in the Exclude box, type

*/;.svn;

And then click the OK button. That will look in every folder and subfolder for .svn files, and exclude them from the upload.

You may exclude other sections if you want. For example, SVN also inserts .htaccess files in various folders. Except for the Index folder, these are not required. So, upload .htaccess to the Index folder the first time you do an upload, but after that, make the exclude mask:

*/;.svn;.htaccess or .svn;.htaccess

Add any others to suit your needs (eg, the Images folder) with a comma or semi-colon between the parameters.

[[Category:How To]]



[[Fr: Comment disposer en permanence de la dernière version à jour du logiciel PhpGedView ?]]

Set up a local test server

2010-05-16T16:42:53Z

Momse: /* What it isn't */

==What it is==

A brief description on how to set up your own local server for testing and working on your PhpGedView installation. This lets you run a complete website on your desktop and is a much easier and better way to design or modify your website than doing it over the web. It's free and easy to use. It's also a great way to try the software and learn how to use it , as well as any number of other things.

==What it isn't==

This installation is not recommended for production servers in live environments, if you use it in one you do so entirely at your own risk and may not hold the authors or owners of this site responsible if it goes wrong.

==What you need==

Any computer better than a 486 with 64 MB of RAM will do. If you have a reasonably late model machine, say something less than 4 years old, then you can run this server in the background on your main machine, you won't even notice the overhead increase.

PhpGedView requires recent versions of PHP and MySql and a webserver to make it all work. You can download and install all these packages individually then configure them as recommended, but this is complicated and not easy unless you have very advanced computer skills. If you wish to run a live server, ie one connected to the internet, then you really should learn how to configure the individual packages, and that is beyond the scope of this article.

For a test server however, the easiest way to set all these up is to grab one of the great all-in-one server packages like [http://www.apachefriends.org/en/xampp.html XAMPP]. Get the package for your operating system, the full download in zip format is recommended. It does not require installation within Windows, you can move copy or delete this installation instantly with no problems. The software you will install is just the same as that used by the websites you browse every day, but it is configured for ease of use, not with security in mind. All folders are installed in default directories with default passwords and this is the best way for our purposes, since we just want a quick installation we can use right away.

XAMPP Lite works just as well with the latest PhpGedView Version 4 beta 4, but it may not support other software if you intend to experiment.

You can set XAMPP up on a thumbdrive too, and this may suit some peoples purpose better. This allows you to carry your webserver and PhpGedView installation in your pocket and run it from any PC with a USB port. But, be warned! There are lots of files in the package, and thumbdrives are very slow when faced with a lot of files. Setup and use can be slow.

It should also be possible to burn your server and software to a CD once you have it installed and configured, we will look into that in another article

==Installing==

Once you have downloaded the XAMPP package, unzip it to its destination folder according to the directions, it really is that easy. It should go in the base directory of your hard drive. You can install multiple servers and experiment with different configurations, but only running one at a time is recomended

==Running==

Now go to the folder you created for your server, XAMPP by default, open it and find xampp-control.exe, and create a shortcut from this to your desktop. This allows you to start the Apache webserver and MySql services with a couple of clicks.

Run xampp-control.exe and click Apache and MySql, don't worry about the other services for now, and don't tick the Svc box unless you want your server to always start with windows.

The usual way to "connect" is by entering http://127.0.0.1 or http://localhost in your web browser. However, other applications may use port 80 - eg Skype - so you might need to look at conflicts. Run the useful utility, xampp-portcheck.exe that is included in the full parcel, and you will see which ports are free/used. (In Skype, you can tell it not to use port 80)

'''Do not''' give Apache web access at this time, if your firewall pops up a window asking for permission, '''deny it'''. You may need to configure your firewall to allow local access if you can't access your site in the next step.

After you start the services, open your browser, type <nowiki>http://localhost/</nowiki> , in the address bar and hit Enter. This should open a welcome page to your new server, just like a web site you access on the net. If you don't get a welcome page or get error messages instead, then check the instructions for installing XAMPP and try again. You can delete this directory and start over at any time.

==PhpGedView on your Desktop==

Once you have XAMPP installed and working, you are ready for PhpGedView, so if you don't have it handy, download and install the latest version. If you feel adventurous give the CVS version a try.

Open the htdocs folder in the XAMPP directory, this is your "public root folder", and where all your "web accessible" software resides, really in this case it's desktop accessible hence the quotes. Unzip your PhpGedView files into the directory, then follow the directions for installing PhpGedView. You should now have a PhpGedView folder within htdocs and this contains the installation, and the themes folder where you can modify your themes if you so desire.

Congratulations, you now have your very own test site. You can access it at any time now by opening xampp control, starting Apache and MySql and typing <nowiki>http://localhost/phpgedview/</nowiki> in your browser.

[[Category:How To]]

Restrict bot access

2010-05-16T16:41:37Z

Momse: /* Examples */

==Introduction==
Search engine spiders (bots) are programs that search your sites so that search engines can index them and then point searchers to your site. This is very important since it is the way most researchers will find your site. That said, the robots can create an excessive load on your site by trawling unnecessary pages. There is a way to mitigate most of the problem by selectively disallowing the bots from part of your site. The Robots exclusion standard used by all search engines allow you to specify specific parts of your site that you want excluded from indexing. An example of a page that can be excluded is the calendar page. All information available on this page is available on other pages. The same goes for most trees. To exclude pages, create a file named robots.txt. This article explains how to make the file.

==File name and format==

[http://www.searchengineworld.com/robots/robots_tutorial.htm Source] 
Search engines will look in your root domain for a special file named "robots.txt". The file tells the robot (spider) which files it may spider (download). This system is called, The Robots Exclusion Standard.

The format for the robots.txt file is special. It consists of records. Each record consists of two fields : a User-agent line and one or more Disallow: lines. The format is:

<Field> ":" <value>

The robots.txt file should be created in Unix line ender mode! Most good text editors will have a Unix mode or your FTP client *should* do the conversion for you. Do not attempt to use an HTML editor that does not specifically have a text mode to create a robots.txt file.

==User-agent==

The User-agent line specifies the robot. For example:

User-agent: googlebot

You may also use the wildcard charcter "*" to specify all robots:

User-agent: *

You can find user agent names in your own logs by checking for requests to robots.txt. Most major search engines have short names for their spiders.

==Disallow==

The second part of a record consists of Disallow: directive lines. These lines specify files and/or directories. For example, the following line instructs spiders that it can not download email.htm:

Disallow: email.htm

You may also specify directories:

Disallow: /cgi-bin/

Which would block spiders from your cgi-bin directory.

There is a wildcard nature to the Disallow directive. The standard dictates that /bob would disallow /bob.html and /bob/indes.html (both the file bob and files in the bob directory will not be indexed).

If you leave the Disallow line blank, it indicates that ALL files may be retrieved. At least one disallow line must be present for each User-agent directive to be correct. A completely empty Robots.txt file is the same as if it were not present.

==White Space & Comments==

Any line in the robots.txt that begins with # is considered to be a comment only. The standard allows for comments at the end of directive lines, but this is really bad style:

Disallow: bob #comment

Some spider will not interpret the above line correctly and instead will attempt to disallow "bob#comment". The moral is to place comments on lines by themselves.

White space at the beginning of a line is allowed, but not recommended.

<nowiki> </nowiki> Disallow: bob #comment

==Examples==

The following allows all robots to visit all files because the wildcard "*" specifies all robots.

User-agent: *
Disallow:

This one keeps all robots out.

User-agent: *
Disallow: /

The next one bars all robots from the cgi-bin and images directories:

User-agent: *
Disallow: /cgi-bin/
Disallow: /images/

This one bans Roverdog from all files on the server:

User-agent: Roverdog
Disallow: /

This one bans keeps googlebot from getting at the cheese.htm file:

User-agent: googlebot
Disallow: cheese.htm

For more complex examples, try retrieving some of the robots.txt files from the big sites like Cnn, or Looksmart.

==Examples submitted by Users==

===Example 1===
User-agent: *
Disallow: /phpgedview/reportengine.php
Disallow: /phpgedview/fanchart.php
Disallow: /phpgedview/search.php
Disallow: /phpgedview/login.php
Disallow: /phpgedview/clippings.php
Disallow: /phpgedview/sosabook.php
Disallow: /phpgedview/timeline.php
Disallow: /phpgedview/calendar.php
Disallow: /phpgedview/images/

In this case PhpGedView was installed in the phpgedview directory. Place this file in your server root.

===Example 2===
Submitted By: pmarfell

The following shows *part* of the content of mine. As you can see it goes on to ban other bots completely. Use Google for more info that might be relevant to your situation:-

User-agent: *
Disallow: /bin/
Disallow: /cgi-bin/
Disallow: /dev/
Disallow: /mypostnuke/
Disallow: /phpfunc/
Disallow: /phpGedView/reportengine.php
Disallow: /phpGedView/fanchart.php
Disallow: /phpGedView/search.php
Disallow: /phpGedView/login.php
Disallow: /phpGedView/clippings.php
Disallow: /phpGedView/sosabook.php
Disallow: /phpGedView/timeline.php
Disallow: /phpGedView/calendar.php
Disallow: /phpGedView/hourglass.php
Disallow: /phpGedView/ancestry.php
Disallow: /phpGedView/descendancy.php
Disallow: /phpGedView/pedigree.php
Disallow: /phpGedView/family.php
Disallow: /phpGedView/relationship.php
Disallow: /phpGedView/famlist.php
Disallow: /phpGedView/patriarchlist.php
Disallow: /phpGedView/repolist.php
Disallow: /phpGedView/aliveinyear.php

User-agent: URL_Spider_Pro
Disallow: /

User-agent: CherryPicker
Disallow: /

==Bad Bots==
What do you do if a spider doesn't obey the exclusions you've carefully crafted in robots.txt? Easiest way to stop the spider in its tracks is to deny it access to your site by using .htaccess

For example the omni-explorer spider doesn't appear to obey Disallow: so deny it access by adding these lines to the .htaccess file in the phpGedView directory.

RewriteEngine On
RewriteBase /
RewriteCond %{REMOTE_ADDR} "^64\.127\.124\." [OR]
RewriteCond %{REMOTE_ADDR} "^65\.19\.150\."
RewriteRule .* - [F,L]

==Related==
* [http://www.robotstxt.org/wc/faq.html The Web Robots FAQ]
* [http://www.robotstxt.org/wc/norobots.html A Standard For Robot Exclusion]
* [http://www.robotstxt.org/wc/exclusion.html Robots Exclusion]
* [http://www.robotstxt.org/wc/active.html A List Of Robots]
* [http://www.searchengineworld.com/misc/robots_txt_crawl.htm Problems found with Robots.txt Files]
* [http://tool.motoricerca.info/robots-checker.phtml Test your robots.txt file for errors]
* [http://www.sxw.org.uk/computing/robots/check.html Another site to test your robots.txt file]

[[da:How_to_restrict_bot_access]]

[[Category:How To]]


[[fr: Restreindre l'accès aux robots]]

Integrate with CMS

2010-05-16T16:38:45Z

Momse: /* Document/File Repositories */

==Content Management Systems==

PhpGedView has been integrated with various '''Content Management Systems (CMS)'''. Wikipedia tells us what a [http://en.wikipedia.org/wiki/Content_Management_Systems Content Management System] is. It is possible for PhpGedView to be integrated into these systems quite successfully. There are also a number of different CMS packages avaailable.

CMS allow the easy creation of a website without detailed knowledge of html. They are designed to allow the integration of other pieces of software to provide a modularised website - you add what you want. Primary considerations for integration with a CMS are user authentication (login and registration processes) and theme/template integration. CMS packages are able to use theme/template selectors, very similar to PGV, which allow the quick changing of the look of your web site whilst maintaining the content.

This area contains information on "How To" integrate PGV into these packages and provides links to sites using the relevant software

===Joomla!===

[http://www.joomla.org Joomla] is an offshoot from the original [Mambo] project and at this time the two products are very similar.

Joomla! uses Components and Modules to add to a web site. Many third part components and modules have been written to add onto the base components that come with Joomla!. They are added to your Joomla! site via a menu system making it very easy to modify your site. Joomla! comes with a number of inbuilt components/modules. You may not wish to use any/all of these but it is advisable to NOT remove the default components/modules from the system as a full renistall of Joomla is required to restore them - this will include deleting your MYSQL database and therefore your content/site unless you are familiar with MYSQL (be warned from experience).

====Modifying PGV Theme for integration with Joomla====

Since version 4 menu items are called in header.html which is located in your theme directory. With integration into a Content Management System you may want menu items to appear only if the person is logged into your system. This is particularly relevant to the login options for phpGedView. This can be done on an integration of Joomla, PGV and Ron Fields Component for PGV. It is accomplished using the following code in header.html around the menu item that you wish to only be shown if a person is logged into Joomla:-

$uname = getUserName();
if (! empty($uname)) {
menu item goes here
}

The line beginning with $uname only needs to be present once if you choose to use it on multiple items. Even if a person goes to PGV directly, http://yoursite.example/phpgedview the items will not be displayed.

That menu item appear will only appear if the person is logged into Joomla.

This has not been tested on any other integration but I can not see why it would not work.

====Components/Modules====

=====PhpGedView Component=====
There is a component '''com_gedview''' already developed to integrate Gedview with Joomla!. It was developed by Ron Field and Veit Olschinski. The latest version 1.4.3 can be found [http://joomlacode.org/gf/project/phpgedview/frs/ here].

The component com_gedview will allow registered users to be automatically registered with phpGedView (depending upon your choice of settings).

For the component com_gedview to work you first install PhpGedView in a directory on the same domain like Joomla and configure it for your system. To integrate it with Joomla you then install the component via the menu system and configure the component with the settings relevant to your system.
[[Image:joomla_comp_configure.jpg|thumb|250px|center|Click to Enlarge Image of Component Configuration]]

Tested with Joomla! 1.5.10, PhpGedView 4.1.6 - 4.2.1 and com_gedview 1.4.3.

=====Gallery 2=====
[http://gallery.menalto.com/ Gallery] is an electronic photo album. Components/Modules to integrate it into Joomla have been written and are available. There is a component that allows the integration of Gallery2 into Joomla and Currently, there are two modules – a Sidebar module (for controlling album actions and navigation while you are using the Gallery 2 component) and a Random Picture module (for displaying a random picture from your Gallery 2 installation on your home page).

For Joomla 1.5 the following components, modules, and plugins are available (as of October 2008) from [http://joomlacode.org/gf/project/gallery2_bridge/frs/ joomlacode.org]. Note that these are ALPHA versions:
*com_g2bridge - the main component
*mod_g2bridge_sidebar
*mod_g2bridge_imageblock
*plg_g2bridge_search
*plg_g2bridge_user
*plgcb_g2bridge_cb

After installing the Gallery2 Bridge you need to configure it from the Components -> Gallery 2 Bridge menu:
* Gallery 2 Path: the full file system path and filename of the Gallery 2 embed.php file. Ex. /var/www/gallery2/embed.php
* Gallery 2 URI: the URI of the native Gallery 2 installation. Ex http://www.mysite.net/gallery2/
* Login Redirect: the URL to display the Joomla login page. Ex. /index.php?option=com_login

=====Document/File Repositories=====
These modules will allow you to share files with others and accept files from others. This may assist you with family research etc.
Examples of them include:-
* [http://www.mambodocman.com/ Docman]

=====Guest Books=====
This allows visitors to your site to leave feedback. This area has been subject to spamming so it is suggested that you use a component that requires some form of additional security such as image identification to stop unsolicited use of your site. Examples of them include:-
* [http://www.joomlaos.de/option,com_remository/Itemid,41/func,download/id,1779/chk,2bdd05a35cda9afd211881cac6e58733.html AKOBook Plus]

=====Group Access=====
One of the limitations I have found with Joomla is the number of groups that can be created to restrict/give access to users. This is apparently being looked at in a later version. There are some things I only want to see when I log on (menu items / personal blog / local weather) are just a few possible examples. I have been able to do this using a component called Group Access. It is a bit difficult to find and appears to have dropped off the net but it can be accessed at

[http://mamboforge.net/frs/?group_id=618 Group Access Download] and [http://thelewisfamily.id.au my web site] (there are two parts to this a component and a module make sure you get both if downloading from here).

You can also look at JACLPlus from [http://www.byostech.com www.byostech.com] this is a hack of the main joomle code so it is best to use there joomla upgrade patches as the normal joomla patch will beak your site.

=====Problems and tips=====
You need to watch your permission's in the joomla menu as the most restictive wins even if it not been shown ( I had a family only menu and had a like to PHPGED locked down in the menu which meant that the link in the main menu was there but guest user got an permission error from that link)

=====Component List=====
A Joomla user has listed and categorised some components/modules that are available. It is makes looking much easier and is available [http://forum.joomla.org/index.php/topic,25317.0.html here]

====Example Sites====
* [http://thelewisfamily.id.au The Lewis Family]
* [http://gilhousenfamily.com Gilhousen Family Association]
* [http://www.thefamilyweb.net Morton families]
* [http://field.ath.cx/ Ron Field]
* [http://www.bearne.com/ The Bearne Family]Joomla 1.0.15 and PhpGed 4.1.4
* [http://dcommunity.isgreat.org/ The Depala Family]Joomla Version 1.5.14 and PhpGed 4.2.1

Remember all these sites are using the same CMS but have just applied different templates.

===CPG-Nuke DragonflyCMS===
A very basic module for installing PhpGedView within Dragonfly which utilises the current Dragonfly Theme and menu system as a wrapper using iframes around PhpGedView is available here http://dragonflycms.org/Downloads_9x/details/id=284.html

It may be seen in action at Pretzy's Place Pertzel Family Tree History site here
http://pretzy.dnsalias.com
The module can also be downloaded from my site's Downloads section

A second version of this module is being created which will integrate a single sign on for both programs and some extra features in the admin section of Dragonfly

===phpNuke & PostNuke===

Within the PGV distribution, there is a pgvnuke folder for integration with phpNuke and PostNuke. Follow the instructions in the postged-readme.txt file for more information.

===Xoops===
Separate, but closely following the PGV project, is PGVXooops, which is a modified version of PGV for use with Xoops-based web sites. This project is being maintained at [http://dev.xoops.org/modules/xfmod/project/?pgvxoops phpGedView for Xoops].

[http://dev.xoops.org/modules/xfmod/project/?pgvxoops PhpGedView for Xoops (revived)], known as PGVXoops, is a project to integrate PGV 3.3.5 into Xoops 2.0.* as a module. The original integration was done by Patrick Kellum and was later revived by Steve Kenow.

* There are two main benefits to using this integration.
*# The user database is shared between the two programs.
*#* You need only one login Id for both programs.
*# PhpGedView is not viewed inside an Iframe.
*#* This allows for better search engine indexing.
*#*It also allows for bookmarking of pages within PhpGedview.
However, with this type of visual integration some conflicts arose. This integration includes PGV theme
modifications to eliminate many of the conflicts with Xoops html and css selectors.
Make sure to use the included themes.

'''Notes:'''
* A patch for the SunTzu Worm (only for PGV 3.3.5) is also available on the projects website, [http://dev.xoops.org/modules/xfmod/project/?pgvxoops PGVXoops].
* Please direct all support questions for this integration to the [http://dev.xoops.org/modules/xfmod/forum/?group_id=1278 PGVXoops forums].
* A patch for PGVXoops is available to make it compatible with PhpGedView 3.3.8. It can be found in the patches section [http://dev.xoops.org/modules/xfmod/tracker/?group_id=1278&atid=1294 Here],
along with the instructions.

===Wordpress===
See [[Integrate with Wordpress|integrating PhpGedView with Wordpress]]

== PGV with new Menu ==
You can also display contents by a added PGV-menu, inside of PGV, described in a [[How_To:Build_a_New_Menu|tutorial]].

[[Category:How To]]


[[fr: Intégration dans un CMS]]

Install and use phpLaunch

2010-05-16T16:35:13Z

Momse: /* Are you running a web server with php? */

== What is PHPLaunch? ==

PHPLaunch is a Windows program that allows you to use PHP script-based webpages like PhpGedView. With PHPLaunch on your computer you can view and edit PhpGedView without the need to install a web server. The difference between a web server and PHPLaunch is that PHPLaunch is only available on your own computer and can not be visited by others through the internet, so on-line editing is not possible.
PHPLaunch can also be burned on a CD to transport PhpGedView to another computer. Because PhpGedView "writes back" to its parent, you can't easily run PHPLaunch from a CD. If you have copied PHPLaunch from a CD to your hard drive and want to edit it, you ''may'' need to turn off the "read-only" attributes.

== What is this guide? ==

This installation guide will walk you step-by-step through installing and upgrading PHPLaunch, so you can use PhpGedView on your computer or burn it on a CD and give it away to family members.
Don’t be afraid to try this out. It’s much easier then you think!
This guide will help you with pictures and easy-to-read text.

== Will this guide help me? ==

This guide was written after some PHPLaunch installation tests. But you can also use it as a reference with other versions and different configurations.
The following configurations have been tested.

'''Hard drive installation'''
* PhpGedView 3.8.8
** PHP and PHP pecl 5.1.2 version
*** Index files (simple)
*** SQLite database (recommended)
*** MySQL database 5.0.18 (advanced)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

* PhpGedView 4 Beta 4 (not recommended)
** PHP and PHP pecl 5.1.2 version
*** Index files (unavailable)
*** SQLite database (unavailable)
*** MySQL database 5.0.18 (not recommended, surfing problems)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

* PhpGedView 4.0.1
** PHP and PHP pecl 5.1.4 version
*** Index files (unavailable)
*** SQLite database (unavailable)
*** MySQL database 5.0.22 (for advanced users)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

'''CD installation'''
* PhpGedView 3.8.8
** PHP and PHP pecl 5.1.2 version
*** Index files (simple)
*** SQLite database (recommended)
*** MySQL database (not recommended)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

* PhpGedView 4 Beta 3 (not recommended)
** PHP and PHP pecl 5.1.2 version
*** Index files (unavailable)
*** SQLite database (unavailable)
*** MySQL database 5.0.18 (not recommended, surfing problems)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

* PhpGedView 4 Beta 4 (not recommended)
** PHP and PHP pecl 5.1.2 version
*** Index files (unavailable)
*** SQLite database (unavailable)
*** MySQL database (not recommended and surfing problems)
*** Microsoft SQL Server 2005 Express (not recommended, compatibility fault with PHP)

== What do I need to start? ==

You need to download the following files
# PHPLaunch
# PHP zip package
# PHP pecl modules package
# PhpGedView

PhpGedView and PHPLaunch: http://sourceforge.net/projects/phpgedview/ [http://sourceforge.net/projects/phpgedview/] 
PHP and PHP pecl package: http://www.php.net/ [http://www.php.net/]

You need to download PHP and PHP pecl to upgrade PHPLaunch and to get a few extensions (DLL files) to make PhpGedView work properly.
Always use the same version with PHP and PHP pecl.

For more advanced database like MySQL for Hard drive installation: http://www.mysql.com/ [http://www.mysql.com/] 
(You are on your own!)

== Are you running a web server with php? ==

If you have a web server installed and running with php on your computer, than I suggest that you temporarily shut it down during this installation. Or use another computer. 
If you have your php.ini in a global folder, like “C:\WINDOWS”, than it’s a good thing that you rename the php.ini file, otherwise PHPLaunch will use that php.ini file instead of what you will configure later. 
If you would start up PHPLaunch with a running web server and php installed, the error page in the PHPLaunch would be: 
“The page can not be found”, “HTTP 404 – File not found”

== Install PHPLaunch ==

Make a “temp” folder on your hard drive “C:\” 
Find the downloaded PHPLaunch zip file and extract it to “C:\temp” folder. 
See Figure 1
[[Image:Phplaunch_install_001.jpg|centre|450px|thumb|PHPLaunch, figure 1]]

You can test “PHPLaunch.exe” now. Double click on the file as shown here. 
If you see error messages, see Figure 2 and “Page not found” in the PHPLaunch window, than you have NOT renamed the php.ini in “C:\WINDOWS”. 
Stop your web server and rename “C:\WINDOWS\php.ini” to something else 
[[Image:Phplaunch_install_002.jpg|centre|PHPLaunch, figur 2]]

If you have followed the instructions, you will see Figure 3.
[[Image:Phplaunch_install_003.jpg|centre|450px|thumb|Figure 3]]

As you can see on the picture, “C:\temp\php.ini” has been loaded correctly.

== Upgrading PHPLaunch with PHP ==

The currrent PHPLaunch package includes PHP version 5.0.3. We will update this to the latest version and get the extensions (DLL files) that we will need for PhpGedView.

Make a “php” folder on your hard drive “C:\” 
Find the downloaded PHP zip file and extract it to “C:\php” -folder. 
Mark and copy these files in the “C:\php\” -folder:
* php5ts.dll
* php.ini-recommended
* php-cgi.exe
See Figure 4
[[Image:Phplaunch_install_004.jpg|centre|450px|thumb|PHPLaunch, figure 4]]

Paste the copied files into the “C:\temp\” folder and overwrite the old files. See Figure 5
[[Image:Phplaunch_install_005.jpg|centre|450px|thumb|PHPLaunch, figure 5]]

If you start up “PHPLaunch.exe” now, you will see that now we have the latest PHP version installed. 
In this case, it is the version 5.1.2. See Figure 6
[[Image:Phplaunch_install_006.jpg|centre|450px|thumb|PHPLaunch, figure 6]]

PHP has a folder called “C:\php\ext\”. In this folder you can see a bunch of DLL files and some of them are needed to use PhpGedView. 
Sometimes PHP includes in their own package the DLL files that you need to run PhpGedView but these change from time to time. If a DLL file is missing from the PHP package then you will find it in the PHP pecl package.

Find the downloaded PHP pecl zip file and extract it to “C:\php\ext” folder.

Which extensions (DLL files) you need depends on how you want to use PhpGedView.
With “Index files” you don’t need any database extension.

'''PhpGedView 3.8.8''' 
General extensions you’ll need 
* php_gd2.dll 
* php_mbstring.dll 

Database extensions with SQLite database 
* php_pdo.dll 
* php_sqlite.dll 

Select and copy all the DLL files you need in the “C:\php\ext\” folder. 
Make an “ext” folder in “C:\temp\” and paste the copied files there.

Example for PhpGedView 3.8.8 with SQLite database. See Figure 7
[[Image:Phplaunch_install_007.jpg|centre|450px|thumb|PHPLaunch, figure 7]]

You can of course copy the whole PHP directly to the “C:\temp\” folder and PHP pecl to “C:\temp\ext\ folder if you have plenty of space. 
This example is using only the minimal requirements.

== How to configure php.ini for PHPLaunch ==

Php.ini is the PHP‘s configuration file. PHP read this file to know what to do. 
When you make a change in this file you have to shut down your web server, PHPLaunch and other programs that using PHP or the changes will not take place.

We want to update php.ini to the latest version as well, just in case. 
Delete “C:\temp\php.ini” 
Rename the file “C:\temp\php.ini-recommended” to “php.ini”. 
Open to edit “C:\temp\php.ini” with notepad or another text editor. 
Find:
max_execution_time = 30
and change to:
max_execution_time = 120

This will increase a scripts execution time limit to 120 seconds. You can change this to a higher value if needed.

Find:
extension_dir = "./"
and change to:
extension_dir = "ext"

This will tell PHP where are all the extensions (DLL files)

Go the “Dynamic Extensions” section. 
Here you will find many lines that start with something like 
;extension=xxxyyy.dll 
Here we will enable or write in all the extensions we need to tell PHP what to use, how to work. These are the extensions that we have already copied to “C:\temp\ext\” folder. See Figure 7 in the “Upgrading PHPLaunch with PHP” section

Enable the following extensions by removing the “;” at the beginning of the line, like this:
extension=php_mbstring.dll
extension=php_gd2.dll

As an example, this guide is using SQLite database with PhpGedView, then we need the following extensions exactly in this order. If you write these lines in the wrong order you will receive error messages.
extension=php_pdo.dll
extension=php_sqlite.dll

If you need other extensions, enable or write them here.

Start up “PHPLaunch.exe” and control if these extension has been loaded. 
If they have been correctly loaded, you will see “gd”, “mbstring” and “SQLite” on the page. 
Example for “mbstring”, see Figure 8
[[Image:Phplaunch_install_008.jpg|centre|450px|thumb|PHPLaunch, figure 8]]

== Install PhpGedView ==

Find the downloaded PhpGedView zip file and extract it to “C:\temp\web\” -folder. 
Example for PhpGedView 3.8.8. See Figure 9
[[Image:Phplaunch_install_009.jpg|centre|450px|thumb|PHPLaunch, figure 9]]

Now you can start up “PHPLaunch.exe” 
If everything is right, in this example PhpGedView 3.8.8 will start up. 
See Figure 10
[[Image:Phplaunch_install_010.jpg|centre|500px|thumb|PHPLaunch, figure 10]]

<center>'''Congratulations!'''</center>
<center>'''DON’T SKIP THESE LINES! IMPORTANT!'''</center>

As you can see on the picture, the “Configuration help” window pops up. '''Do not close this window!''' 
For some reason this window allows you to make selections in the boxes. If you close the window, you will get this error message and you will not be able to choose any boxes, see Figure 11 or see Figure 13
[[Image:Phplaunch_install_011.jpg|centre|PHPLaunch, figure 11]]

If you close the “Configuration help” window by mistake, don’t worry, you can either push “F5” on your keyboard to refresh the window or just shut down “PHPLaunch.exe” and start it again and this time don’t close the window.

It’s time to copy all the files you need to run PhpGedView. 
Copy your GEDCOM record to “C:\temp\web\index\” folder. 
You can even use GEDCOM record that has been updated with Beta 4 versions. I have tested them up to 4.0 Beta 4 
Copy your multimedia files to “C:\temp\web\media\” folder. 

'''Caution''' 
If you are planning to have PhpGedView on a CD and give it away and have sensitive information in your GEDCOM file then it’s time to delete them. The GEDCOM record is just a text file that can be viewed by anyone with a text editor.

When you are finished with all the copying, you can start up “PHPLaunch.exe” and start with the configurations. 

Please follow the PhpGedView manual on how to configure PhpGedView. 

'''To use PHPLaunch:''' 
# Make a desktop shortcut to PHPLaunch.exe, and you will have a convenient start-up 

'''To admininister PHPLaunch:''' 
# Open PHPLaunch as in the step above
# Open your web browser and point it to http://localhost:32123/index.php 
# Log in as administrator, and you can edit, add, subtract and generally modify your file 

Tested with Internet Explorer 6 and PhpGedView 3.8.8

== CD or hard drive installation? ==

- PhpGedView on your hard drive doesn’t need any special consideration to run. You can view, edit, upgrade. You have no limitations.

- If you are planning to have PhpGedView only an a CD 
PhpGedView is trying to write always to some files, that means you will have warning messages because a CD is a Read-Only media. So it’s a good thing to disable all kind of writings made by PhpGedView like logging, online-editing. 
Before you burn this project to a CD you can test it by marking all the files under the “C:\temp\web\index\”, right-click with the mouse, choose “Properties” and mark the “Read-only” attributes. 
PhpGedView will try to write to these files so you will see all the warning messages. Don’t waste your CD’s for testing until you reduce the warning messages. 
PhpGedView has no functions to check if the installation is on a read-only CD or on your hard drive.

- So why burn it on a CD if you get annoying warning messages? 
The good thing with the CD installation is that you can give it away to your family members, which is the whole idea. Just tell them to copy the whole CD on they hard drive before they want to use it. Then they will enjoy it in a warnings free environment. 

When you are ready with everything, you can burn all the files and folders under “C:\temp\” –folder to your CD. 
See Figure 12

[[Image:Phplaunch_install_012.jpg|centre|450px|thumb|PHPLaunch, figure 12]]

If you are distributing PHPLaunch by CD and want to give it all a professional appearance, have a look at http://www.jrsoftware.org/isinfo.php This allows you to present a Windows-installer look alike "wrapper" to your information, and makes installation a breeze. The software is free.

== Problems? ==

Use this as guidelines and not as an absolute problem solver.

--
At start of PHPLaunch: 
“The page can not be found”, “HTTP 404 – File not found”

-You have a php.ini file in your “C:\WINDOWS\” –folder. 
Rename that php.ini –file to something else, while you are using or installing PHPLaunch.

-----
“The procedure entry point yyy could not be located in the dynamic link library xxx.dll.”

-You have a php.ini file in your “C:\WINDOWS\” –folder. 
Rename that php.ini –file to something else, while you are using or installing PHPLaunch. 
Or 
-The xxx.dll –file is another version than PHP 
See “Upgrading PHPLaunch with PHP” section.

-----
At start of PHPLaunch 
In the main window: 
“Your current database configuration is bad. Please check your database connection parameters and configure again. 
DB Error:extension not found [DB Error:extension not found]**Array” 
and 
In the pop-up window: 
“PHP Warning: PHP Startup: Unable to load dynamic library 'xxx\php_ sqlite.dll' - The specified module could not be found. in Unknown on line 0” 

-You have a php.ini file in your “C:\WINDOWS\” –folder. 
Rename that php.ini –file to something else, while you are using or installing PHPLaunch. 
Or 
Check your php.ini that - extension_dir = "ext" - is correct 
Or 
Check your php.ini for the extension=php_pdo.dll, in this case. If it is misspelled or missing from your php.ini. 
See “How to configure php.ini for PHPLaunch” section.

-----
In the main window only. 
“Your current database configuration is bad. Please check your database connection parameters and configure again. 
DB Error:extension not found [DB Error:extension not found]**Array” 

-You have a php.ini file in your “C:\WINDOWS\” –folder. 
Rename that php.ini –file to something else, while you are using or installing PHPLaunch. 
Or 
Check your php.ini that - extension_dir = "ext" - is correct 
Or 
You want to use “Index file” as your database. Ignore this warning and continue. 
See “How to configure php.ini for PHPLaunch” section.

-----
“Internet Explorer Script Error” or “A Runtime error has occurred”

Which error message you receive depends on your systems installation but it’s the same thing. 
And the “URL: http://localhost:32123/xxx.php“can be different. Depends on where you are… 
See Figure 13
[[Image:Phplaunch_install_013.jpg|centre|PHPLaunch, figur 13]]

Or, see Figure 11

- You have probably closed a pop-up window. 
Click “Yes” 
Or 
Press or “F5” on your keyboard to refresh the window or close PHPLaunch and start it up again. 

-----
“php-cgi.exe – Unable To Locate Component” 
See Figure 14
[[Image:Phplaunch_install_014.jpg|centre|PHPLaunch, figur 14]]

-Check your php.ini for the extension=php_pdo.dll, in this case. If it is misspelled or missing from your php.ini. 
See “How to configure php.ini for PHPLaunch” section. 
Check also if this file is missing from your folder. In this installation example “C:\temp\ext\”. 
See Figure 7

-----
Warning in the pop-up window. And no warnings in the main window. 
“PHP Warning: PHP Startup: Unable to load dynamic library 'ext\php_sqlite.dll' - The specified module could not be found. in Unknown on line 0” 

-Check your php.ini. It is possible that you wrote some lines in this order: 
extension=php_sqlite.dll
extension=php_pdo.dll
Switch these two lines. 
See “How to configure php.ini for PHPLaunch” section. 

-----
Can not edit the Welcome page. The error message is: 
Access Denied 
You do not have access to this resource. 

-Start PHPLaunch 
-Start Internet Explorer and type in the address bar: 
http://localhost:32123/index.php 

Now log in and continue to edit.

[[Category:How To]]


[[fr: Installer et utiliser PhpLaunch]]

Install IIS with PHP and MySQL

2010-05-16T16:32:38Z

Momse: /* Configure IIS */

== What is IIS? ==

IIS stands for Internet Information Services.

IIS is Microsoft's own web server which can be installed by everyone who has Microsoft Windows operating system and the Windows installation CD. IIS doesn't cost anything, just the time to install.

== What is this article? ==

This article will walk you through with the help of many images how to install IIS, PHP and MySQL for PhpGedView. When finished, you will have your own web server which you can use privately at home as a test web server or even go online and let your family members connect to your PhpGedView installation.

The installation is quite easy. Don't be afraid to try it, no matter if you are a pro or a newbie.

This article is using only the basic installation to set up a working PhpGedView.

Security and firewall issues would be an other and even a longer article.

== What do I need to start? ==

* Microsoft Windows installation CD
** To install IIS
* PHP and PHP pecl package
** Download from http://www.php.net/
* MySQL database and MySQL Administrator
** Download from http://www.mysql.com/
* PhpGedView
** Download from http://sourceforge.net/projects/phpgedview

This article will use the following configuration : 
*Microsoft Windows XP Professional, with Service Pack 2 
:*IIS 5.1 
*PHP and PHP pecl package 5.2.0 
:*When you are downloading the packages, make sure that the PHP package and PHP pecl package have the same version and that they are not the installer, but the zip package.
*MySQL Database 5.0.27 and MySQL Administrator 1.2.4rc 
*PhpGedView 4.0.2 

Attention! If you are using different Windows Operating systems, or different program versions of the downloaded programs, there might be some installation and configuration differences.

== Install IIS ==

The first thing is to install IIS. 

Place your Microsoft Windows installation CD into your CD drive. 
Go to "Control Panel" -> "Add or Remove Programs" -> "Add/Remove Windows Components" 
In the "Windows Components Wizard" window highlight "Internet Information Services" and click on "Details" 
In the "Internet Information Services" window mark the box for "World Wide Web Services" and click on "OK". 
These steps you can see on figure 1 
[[Image:Install_IIS_001.jpg|centre|450px|thumb|Install IIS, figure 1]]

In the "Windows Components Wizard" click "Next". 
Click "Finish" after Windows has installed IIS. 

Open your Internet Explorer browser and type in the address bar http://localhost 
Congratulations! You have your own web server. 
Figure 2 shows you how it should look in Windows XP 
[[Image:Install_IIS_002.jpg|centre|450px|thumb|Install IIS, figure 2]]

For now, we will wait to configure IIS. 

== Install PHP ==

Why install the PHP package? 
The PHP package makes it possible for any web server to be able to run php script web pages, like PhpGedView. Without the php package you would see only the text of the script and not the page. 
When you are downloading the packages, make sure that the PHP package and PHP pecl package have the same version and that they are not the installer, but the zip package. 
* Make a new folder and name it "php" on your root drive, like C:\
* Extract the downloaded php zip file into this folder
* Extract the downloaded php pecl zip file into the ":\php\ext" folder

See figure 3 
[[Image:Install_IIS_003.jpg|centre|450px|thumb|Install PHP, figure 3]]

Find "php.ini-recommended" file in the ":\php" folder. Copy the file to ":\WINDOWS" folder and rename it to "php.ini". 
This is the file that controls how php should work. 

== Configure PHP ==

Open the file ":\WINDOWS\php.ini" in any text editor. 
Find:
max_execution_time = 30
and change it to:
max_execution_time = 60
This tells php how many seconds a script should run before timeout. 
Find:
doc_root =
and change it to:
doc_root = "C:\Inetpub\wwwroot"
or where your web pages will be 
Find:
extension_dir =
and change it to:
extension_dir = "C:\php\ext"
Enable these extensions by removing the ";" in front of the line. If you can not find some of them, write them here in this section.
extension=php_mbstring.dll
extension=php_gd2.dll
extension=php_mysqli.dll
These extensions are needed to run PhpGedView. 

You can also change the session folders path insted of using the Windows default temporary folder. 
You can do this by adding or editing the "session.save_path" variable to this:
session.save_path = "C:\php\session"
Make sure that this folder exists, if not, make one. 

For testing later on, make a php file to test the php installation. 
Open a text editor, like Notepad and write these lines:
<?php
phpinfo();
?>

Save this as "phpinfo.php" in your web folder "C:\Inetpub\wwwroot" (if this is the default folder for your web pages.) 

== Configure IIS ==

Windows XP has IIS 5.1. This example shows you how to configure this version. 
Go to "Control Panel" -> "Administrative Tools" -> "Computer Management" 
Browse to "Services and Applications" -> "Internet Information Services" -> "Web Sites" -> "Default Web Site" 
Right click on "Default Web Site". 
Click on "Properties" -> "ISAPI Filters" tab -> "Add". 
"Filter Properties" window will be opened. In the "Filter name:" box, write
.php
In the "Executable:" box, browse to your php installation folder and choose "php5isapi.dll". 
See figure 4 
[[Image:Install_IIS_004.jpg|centre|450px|thumb|Configure IIS, figure 4]]

Click "OK" to close the window and click "Apply". 

Go to "Documents" tab -> "Add". In the "Default Document Name:" box, write:
index.php
See figure 5 
[[Image:Install_IIS_005.jpg|centre|450px|thumb|Configure IIS, figure 5]]

Click on "OK" to close the window and click "Apply". 

We have now added “index.php” to a list of files that IIS will search for in a web folder. The first file IIS finds in this list in a web folder will be loaded. You can mark index.php and with the arrows you can move it up or down to choose the files priority. You can change the priority for every folder separately in the same way. 
Go to "Home Directory" tab -> "Configuration..." -> "Add". In the "Executable:" box, browse to the "php5isapi.dll" file and in the "Extension:" box write
.php
See figure 6 
[[Image:Install_IIS_006.jpg|centre|450px|thumb|Configure IIS, figure 6]]

Click "OK" -> "Apply” -> and "OK" in the "Default Web Site Properties" window to close it. 
In the "Computer Management" window browse to "Services and Applications" -> "Services". 
In the right window, search for "IIS Admin" and click on "Restart" to apply all changes we made. 
See figure 7 
[[Image:Install_IIS_007.jpg|centre|450px|thumb|Configure IIS, figure 7]]

Open your web browser and type: http://127.0.0.1/phpinfo.php 
See figure 8 
[[Image:Install_IIS_008.jpg|centre|450px|thumb|Configure IIS, figure 8]]

Congratulations! You have a web server with PHP installed! 

'''IIS 6''' is installed and configured in a similar way as IIS 5 so far. IIS 6 has one more setting left before you can restart the web service to apply all your changes and to browse to phpinfo.php. 
In the "Computer Management" window browse to "Services and Applications" -> "Internet Information Services (IIS) Manager" -> "Web Service Extensions" 
Click "Add a new Web service extension..." 
In the "Extension name:" box, write example: "PHP" 
For "Required files" click "Add" and browse to your":\php\php5isapi.dll" 
Mark the box "Set extension status to Allowed" 
See figure 9 
[[Image:Install_IIS_014.JPG|centre|450px|thumb|Configure IIS 6, figure 9]]

Restart IIS and now browse to http://127.0.0.1/phpinfo.php 

== Install and configure MySQL ==

Why install MySQL? 
MySQL is probably the best free database in the market that PhpGedView supports. Most likely, PhpGedView will always support MySQL. 

Start the MySQL installation program. These are the steps window by window : 
Typical -> Next 
See Figure 10 
[[Image:Install_IIS_101.JPG|centre|450px|thumb|Install MySQL, figure 10]]
Install 
You can choose to "Skip Sign-Up", for now -> Next 
See Figure 11 
[[Image:MySQL_Signup.jpg|centre|450px|thumb|Install MySQL, figure 11]]
Mark "Configure the MySQL Server now" -> Finish 
See Figure 12 
[[Image:Install_IIS_104.jpg|centre|450px|thumb|Install MySQL, figure 12]]

The steps to configure MySQL : 

Next 
Mark "Detailed Configuration" -> Next 
See Figure 13 
[[Image:Install_IIS_106.JPG|centre|450px|thumb|Comfigure MySQL, figure 13]]
Mark "Developers Machine", for low memory usage -> Next 
See Figure 14 
[[Image:Install_IIS_107.JPG|centre|450px|thumb|Comfigure MySQL, figure 14]]
Mark "Transactional Database Only" -> Next 
See Figure 15 
[[Image:Install_IIS_108.JPG|centre|450px|thumb|Comfigure MySQL, figure 15]]
Make sure your installation path is ok -> Next 
Mark "Decision Support (DSS)/OLAP” -> Next 
See Figure 16 
[[Image:Install_IIS_110.JPG|centre|450px|thumb|Comfigure MySQL, figure 16]]
Mark "Enable TCP/IP Networking" and "Enable Strict Mode", set "Port Number:" to 3306 -> Next 
See Figure 17 
[[Image:Install_IIS_119.JPG|centre|450px|thumb|Comfigure MySQL, figure 17]]
Mark "Best Support For Multilingualism", support for UTF8 character set -> Next 
See Figure 18 
[[Image:Install_IIS_111.jpg|centre|450px|thumb|Comfigure MySQL, figure 18]]
Mark "Install As Windows Service" and "Launch the MySQL Server automatically" and "Include Bin Directory in Windows PATH" -> Next 
See Figure 19 
[[Image:Install_IIS_112.jpg|centre|450px|thumb|Configure MySQL, figure 19]]
Mark "Modify Security Settings", type your password -> Next 
See Figure 20 
[[Image:Install_IIS_113.jpg|centre|450px|thumb|Configure MySQL, figure 20]]
Execute 
Finish 

You may need to restart Windows now. 
Open your browser and browse to http://127.0.0.1/phpinfo.php 
Now you can also find the "mysqli" extension on the PHP information page. 
See Figure 21 
[[Image:Install_IIS_120.jpg|centre|thumb|450px|Configure MySQL, figure 21]]

Install MySQL Administrator. 
After installation start the program and fill in the settings and click "OK". 
See figure 22 
[[Image:Install_IIS_009.jpg|centre|MySQL Administrator, figure 22]]

Here you can manage and configure MySQL easy. Usually the only two things you would need to configure are "User Administration" and "Catalogs" 
Click on "Catalogs" and right click in the "Schemata" window (not the empty box), "Create New Schema". Type in the "Schema name:" like "phpgedview". 
See figure 23 
[[Image:Install_IIS_010.jpg|centre|450px|thumb|MySQL Administrator, figure 23]]

Now you have a database for PhpGedView with the name "phpgedview". 
When you start PhpGedView for the first time, PhpGedView will fill this database out for you. Do not change anything manually in the database! 
You might also need to add a new MySQL User to use it in PhpGedView instead of the main administrator "root", for security reasons, especially if you go online. 
To add a new user in MySQL, just click on the "User Administration" and "New User". Fill in the user name and the password you want to use for PhpGedView. 
You also have to assign this MySQL user some privileges to your PhpGedView database. The privileges have to be: SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, INDEX, ALTER. 
See figure 24 
[[Image:Install_IIS_121.jpg|centre|450px|thumb|MySQL Administrator, figure 24]]

== Install PhpGedView ==

Make a new folder in ":\Inetpub\wwwroot" and name it "phpgedview". 
Extract the downloaded PhpGedView zip file into the "phpgedview" folder. 
Go to "Tools" -> "Folder Options" -> "View" tab and unmark "Use simple file sharing" -> "Apply" and "OK" 
See figure 25 
[[Image:Install_IIS_011.jpg|centre|450px|thumb|Install PhpGedView, figure 25]]

In Windows XP, this is how you have to enable to have the right to give security permissions to files and folders. 

Right click on "config.php" and "Properties" -> "Security" tab. 
Highlight "Internet Guest Account". "IUSR_xxx" is the IIS user for which we have to give write permission. The "_xxx" in "IUSR_xxx" is your computer name. 
See figure 26 
[[Image:Install_IIS_012.jpg|centre|Install PhpGedView, figure 26]]

Click "Apply" and "OK". 
If you cannot find "IUSR_xxx" in the list, just hit the "Add" -> "Advanced" -> "Find Now" to add the IIS user to the list. 
You also have to add write permission to the "index" and "media" folder. 
When you are finished with the PhpGedView configuration, don't forget to remove the write permission of the "config.php" file for security reasons. 

Open your browser and type: http://127.0.0.1/phpgedview/ 
See figure 27 
[[Image:Install_IIS_013.jpg|thumb|450px|centre|Install PhpGedView, figure 27]]

Congratulations! You have now your own IIS web server with PHP, MySQL and PhpGedView. 
In this article we are using the "php_mysqli.dll" extension for MySQL 4.1+ and PHP 5 so Figure 27 shows you the basics of starting configuration. 

'''Configuring'''

1. Choose "MySQL 4.1+ and PHP 5" as the database type 
2. Set the database host as localhost, or you can also use the IP address 127.0.0.1 

For browsing, don't use http://localhost, that will give you login problems.
Use instead http://127.0.0.1 or your computers IP address for your computer - to get this, open a command prompt (Start/Run/cmd) and type:
ipconfig
The "IP Address" is your computers address. 

Good luck.

[[Category:How To]]

Configure memory usage for php

2010-05-16T16:30:35Z

Momse: /* Additonal Comments */

{{stub}}

== Configure memory usage ==

That is the right place to set the '''memory limit''' in PGV's configuration. After setting it there, you need to check '''phpinfo''' from the config menu to see if your hosting provider's setup permits it to take effect. In most cases, the lower of the two limits (the one set in '''php.ini''' and the config of the running script) controls.

Don't assume that your hosting provider's limit is unchangeable. If you can't adjust the memory limit through the PGV config, contact them, and ask whether '''php.ini''' is customer-accessible, and if not, ask them to change the mem limit for you.

I work on sites hosted on servers from different providers, and their policies and procedures regarding '''php.ini''' vary widely. The one I use the most has php.ini in a peculiar location in the directory tree, to slow down hackers, and don't publish that location in their online help pages for obvious reasons, but were happy to tell me how to get to it. The provider which hosts my phpGedView site does not permit customer edits of php.ini, but bumped my php memory limit up to 16 and then to 32 on my request, with no complaint. Even with PGV 3.3.7, the speed boost was dramatic, and a transient and erratic problem I had with '''MySQL''' stopping, sometimes leaving a table locked, vanished.

Some hosts do not enable the memory limit (windows binaries usually don't have it enabled) which may be why you aren't seeing it in the '''phpinfo'''.

With Apache it is also possible to change '''php.ini''' settings in a '''.htaccess''' file. You can try creating a blank .htaccess file and put it in your ''phpgedview'' directory. Then put the following line in it: '''php_value memory_limit 32M'''

Though PHP presents a very versatile and user friendly interface for handling file uploads, the default installation is not geared for working with files in excess of ''2 Mega Bytes''. This article will help you configure your PHP engine for handling such large file transfers.
The '''php.ini''' File

==Special Note:==
You could be wasting bandwidth, If your file upload page is nothing more than an HTML form.

Most browsers just ignore the '''MAX_FILE_SIZE''' hidden field and size limits are checked only after the data has been sent over the wire.

Our applet saves your bandwidth by imposing client side restrictions.

All the configuration settings for your installation are contained in the '''php.ini''' file. Sometimes these setting might be overridden by directives in apache '''.htaccess''' files or even with in the scripts themselves. However you cannot over ride the settings that effect file uploads with .htaccess directives in this way. So let's just concentrate on the ini file.

You can call the '''phpinfo()''' function to find the location of your '''php.ini''' file, it will also tell you the current values for the following settings that we need to modify

* '''file_uploads'''
* '''upload_max_filesize'''
* '''max_input_time'''
* '''memory_limit'''
* '''max_execution_time'''
* '''post_max_size'''

The first one is fairly obvious if you set this off, uploading is disabled for your installation. We will cover the rest of the configuration settings in detail below.
===upload_max_filesize and post_max_size===
Files are usually POSTed to the webserver in a format known as ''''multipart/form-data''''. The '''post_max_size''' sets the upper limit on the amount of data that a script can accept in this manner. Ideally this value should be larger than the value that you set for '''upload_max_filesize'''.

It's important to realize that '''upload_max_filesize''' is the sum of the sizes of all the files that you are uploading. '''post_max_size''' is the '''upload_max_filesize''' plus the sum of the lengths of all the other fields in the form plus any mime headers that the encoder might include. Since these fields are typically small you can often approximate the upload max size to the post max size.

According to the PHP documentation you can set a '''MAX_UPLOAD_LIMIT''' in your HTML form to suggest a limit to the browser. Our understanding is that browsers totally ignore this directive and the only solution that can impose such a client side restriction is our own Rad Upload Applet

===memory_limit===
When the PHP engine is handling an incoming POST it needs to keep some of the incoming data in memory. This directive has any effect only if you have used the --'''enable-memory-limit''' option at configuration time. Setting too high a value can be very dangerous because if several uploads are being handled concurrently all available memory will be used up and other unrelated scripts that consume a lot of memory might effect the whole server as well.

===max_execution_time and max_input_time===
These settings define the maximum life time of the script and the time that the script should spend in accepting input. If several mega bytes of data are being transfered '''max_input_time''' should be reasonably high. You can override the setting in the ini file '''for max_input_time''' by calling the '''set_time_limit()''' function in your scripts.

==Additonal Comments==
===Apache Settings===
The apache webserver has a '''LimitRequestBody''' configuration directive that restricts the size of all POST data regardless of the web scripting language in use. Some RPM installations sets limit request body to '''512Kb'''. You will need to change this to a larger value or remove the entry altogether.

==Other Options==
If you expect to handle a large number of concurrent file transfers on your website consider using a '''perl''' or '''java''' server side component. PHP happens to be our favourite web programming language as well but perl and Java are just slightly ahead when it comes to file upload.

Most installations of '''perl''' as an apache module can accept in excess of '''32 megabytes''' out of the box. Compare this against the '''2MB''' default for PHP. The downside is that perl coding takes just a bit more effort than PHP but it's worth it. You can try our sample scripts to get started.

[[Category:How To]]
[[Category:Administrators Guide]]

[[fr: Configurer_la_taille_mémoire_pour_PHP]]

Using SVN for PhpGedView

2010-05-16T16:23:17Z

Momse: /* PGV repository on the SourceForge server */

= PhpGedView for the more advanced =
Most of us use stable versions of PhpGedView, notified and released through the main PGV pages on SourceForge. But there are always developments in the pipeline. These take two forms—patches (and you will find "fixes" there from time to time) and unproven scripts—often referred to as "subversions" (SVN for short). You will find references to "revision control", which is the same concept.

SVN is for everyone involved in developing and testing open source software. The hub of SVN is the repository, where all the current subversions are stored. There are writers/scripters/progammers/etc who are working on changes, which are committed to the repository. Then there are the users/testers/leading edgers, who draw down from the repository to their workspace. This document will hopefully help you begin using the Subversion repository code on your PhpGedView web site.

== Subversion ==
SVN is a version control system; it allows users to keep track of changes made over time to any type of electronic data. Typical uses are versioning source code, web pages or design documents.

Open source software like PhpGedView has many contributors. As revisions are written, the developer(s) “commit” the changed files into a repository. This repository is the core "filing cabinet" for the SVN system. Other developers and users can draw these files from the repository, but with many hundreds of files involved, sharing changes could be quite complicated without SVN control software.

Using version control software, you can create parallel versions of the repository on your computer. The software then allows you to keep the two locations synchronized, so you always have a copy of the latest revisions. From there, you can work on the source files, or upload the revisions to your server, either local or remote, to test and comment on.

=== Installing a Client (for Windows Users) ===
[[image:svn2.jpg|left|260px|thumb]]
There are some good Windows tools available that will give you the means to build a replica of the files in the repository on your computer. Tortoise is one such piece of software, and will be used in this wiki to guide you along. Tortoise is free and can be downloaded from http://tortoisesvn.tigris.org/.

Note: There are other clients available: SmartSVN is a more full-featured client and it too is free.

Installation is quite straight-forward. This is the welcome setup screen for the Tortoise version used to prepare this document. Click on "Next" to start the process. There is little to gain, or lose, by choosing options on the next screen, so simply click "Next" again. When the process is complete, restart your computer.

 

=== Installing a Client (other) ===
For Linux/*BSD/Unix the command line SVN client can be installed through your distribution's package manager.
* For Debian/Ubuntu
sudo apt-get install subversion

For MacOS X users see [http://www.wikihow.com/Install-Subversion-on-Mac-OS-X WikiHow] for several options and additional links.

=== Using the SVN Client ===
==== Checkout ====
[[image:svn5.jpg|right|86px|thumb]]
When your computer has rebooted, right-click anywhere on the screen. You will get a list with a couple of new entries: "SVN Checkout" and "TortoiseSVN". The next part of the process is to get a copy from the repository to your computer—a checkout. Select "SVN Checkout". Tortoise will suggest a target/checkout directory, which you can adjust to suit your needs. Note: It is preferable to keep the path simple. <tt>C:\Checkout</tt> is a simple suggestion.

For the command-line client (CLI) use:
svn co https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/trunk/phpGedView phpgedview

==== PGV repository on the SourceForge server ====
[[image:svn6.jpg|right|233px|thumb]]
In the "URL of repository" field enter either https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/trunk/phpGedView or https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/branches/phpGedView-4.2 if you want the development version.

Things get busy now. A long list of files will scroll through the window as they download to your computer. At this time, Tortoise will download about 12,600 files, consuming a bit over 100 MB of disk space (the actual files total about 70MB, the rest is slack space). When the download has finished, open Windows Explorer and browse to the <tt>C:\Checkout</tt> directory.

 

==== Update ====
[[image:svn14.jpg|right|190px]]
The "update" function of Subversion will only update those files that are newer in the SVN repository. You don't need to do this immediately after a checkout because you already have the latest files.
# Open your file directory, and right-click on the SVN folder.
# Left-click on "SVN Update". The Tortoise system will check all your current files against the repository, and download any repository files that are more recent.

For Linux/BSD/other:
cd /path/to/svn/tree
svn update

==== The .svn directory ====
These folders are both a blessing and a curse. The blessing is that they hold all the version information for the other files in the mother folder. When you do an update, Tortoise will compare the information about the files you hold with the information about the files at SourceForge. If the information is identical, there is no need for a download because you have the latest. If the SourceForge file is newer than yours, then it has to be downloaded and the <tt>.svn</tt> files updated to show this. This has many advantages, including:
* the ability to reverse-out an update if you find a problem with it
* comparing the update with the previous change
* merging the changes to any manual alterations to the files you have done for your own purposes, etc.

They are a curse because if you are working with your files on a remote server, you don’t want to upload all this extra baggage. The <tt>.svn</tt> directory about doubles the gross disk space used by PGV.

==== Preparing to Upload ====
Whether to a local or remote location, the next step will be to copy the files from your computer to that server. But first, it would be wise to do some housekeeping. The <tt>.svn</tt> directoriess are not wanted or needed in the final location, so they need to be cleaned out. To do this is quite easy.

This process will make a fresh copy of <tt>C:\Checkout</tt>, but without all the <tt>.svn</tt> directories. Note: this process does not currently work with Microsoft Vista. [[image:svn11.jpg|right|185px|thumb]]

Using the Tortoise "Export" command:
# Find the <tt>C:\Checkout</tt> directory in Windows Explorer and right-click on it. The side menu that opens has an item "TortoiseSVN", which leads to "Export…", select this.
# Select where you want to create the exported copy and click on "Make New Folder", then select "OK".

Using Windows:
# Copy all the files to a new directory, call it "xxxxx" for this example.
# Open a command line window by clicking the "Start" bar, then “Run” and finally type "cmd" in the text box and push "OK".
# In the newly opened command line type in this line and press "Enter"
for /r c:\xxxxx %f in (.svn) do rd /s /q "%f"

That will clean all the <tt>.svn</tt> sub-directories from "xxxxx" for you.

The Linux/BSD/other user may do this in preparation for uploading their updated svn tree:
cp -a /path/to/svn/tree /tmp/pgv
find /tmp/pgv -type d -name '.svn' -exec rm -rf {} \;

Why follow this longhand path? It is useful when you plan to delete anything you don’t want or require, e.g., modules you don’t plan to use, flags, themes, language files, etc. However unless you are really short of server space leave them in place. Uploading them intact can be useful because it simplifies later updates.

When this has been finished, you are ready to upload the files in "xxxxx" to your server. You can now go ahead and configure and populate the SVN version of PGV.

[[image:svn15.jpg|right|155px|thumb|Synchronize step 1]]
 

==== Synchronize ====
[[image:svn16.jpg|right|222px|thumb|Synchronize step 2]][[image:svn17.jpg|right|270px|thumb|Synchronize step 3]][[image:svn18.jpg|right|321px|thumb|Synchronize step 4]]
Now you need a FTP client to synchronize your files with the server files. Unless you followed the procedures above your files have all the .svn directories and it is essential that you can set some conditions within the FTP client to prevent them being uploaded as well.

One useful client is called WinSCP and can be downloaded here: http://winscp.net/eng/index.php. After installing and starting the program setup the conditions for it to connect to your server site.

# Go to the menu bar and select "Commands / Synchronize…"
# Select "Remote" as your target directory, and tick the "Existing files only" box. This ensures that the only files uploaded are a match for the files already on the server. However, there will be times when new files are added to the repository. In that case, because they won’t have yet been uploaded to your server, this system won’t copy them or new issues of them
# In this case click on "Transfer settings" and on the next screen, work your way to "Transfer/Presets" and finally click the "Add" button
# Give this “Preset” of conditions a name—“Mine” or “Mask_1” to suit
# Next, down in the lower left, in the "Exclude" box, copy from below and then click the "OK" button. That will look recursively through all directories for <tt>.svn</tt> files and exclude them from the upload
*/;.svn;

You may exclude other sections if you want. For example, SVN also inserts <tt>.htaccess</tt> files in various directories. Except for the <tt>Index</tt> directory these are not required. So, upload <tt>.htaccess</tt> to the <tt>Index</tt> directory the first time you do an upload, but after that, make the exclude mask:
*/;.svn;.htaccess
OR
.svn;.htaccess

Add any others to suit your needs, e.g., the <tt>Images</tt> directory, with a comma or semi-colon between the parameters.

 
Linux/BSD/other users can use the CLI <tt>scp</tt> or any FTP client such as <tt>lftp</tt> or <tt>ncftp</tt>.

An example <tt>scp</tt> command might look like:
scp -r /tmp/pgv user@host:/hosting/site/phpgedview/



[[de:Installations Guide]]
[[Fr: Comment disposer en permanence de la dernière version à jour du logiciel PhpGedView ?]]

[[Category:SVN]]

Media Firewall

2010-05-16T16:20:17Z

Momse: /* Log entries */

{{Infobox Feature
| name = [[Media Firewall]]
| author = [[User:Ljm]]
| introduced in version = [[4.1.2]],
[http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/branches/phpGedView-4.2/mediafirewall.php?revision=1376&view=markup Revision 1376]
| introduced in date = [[3 August]], [[2007]]
}}

The Media Firewall (see [http://sourceforge.net/tracker/index.php?func=detail&aid=1749817&group_id=55456&atid=477081 1749817]) and watermarking (see [http://sourceforge.net/tracker/index.php?func=detail&aid=1739602&group_id=55456&atid=477081 477081]) features were released in phpGedView 4.1.2.

== High-level overview: ==

The Media Firewall does several things to protect your media items:

First and foremost, it enforces your PGV privacy settings. Without the Media Firewall, PGV can "hide" the urls to your private media items, but if someone figures out the right urls they can easily view them. The Media Firewall enforces your PGV privacy settings, ensuring that nobody can view your confidential images.

Second, the Media Firewall can watermark your images to make it harder for someone to take and post them on another site. You can choose to watermark images for only certain user types, if you wish.

The Media Firewall is able to do this when you move your sensitive images out of the standard web-accessible media directory into the protected media directory. When someone tries to view an image that no longer exists in the web-accessible directory, a 404 error occurs and the Media Firewall is activated. It decides whether to:
* show the image or not, based on who is trying to view it and what the privacy settings for the image are
* watermark the image, based on user type

The path used to view images from the web does not change.

There are four steps to using the Media Firewall:

1) Configure your site
2) Move your images to the protected directory
3) Tell PGV which images need to be protected
4) Test it

== Configure your site ==

=== Prerequisites ===

* You will probably want to move your index directory out of the web root. Fully test this before enabling the media firewall.
* Make sure your $MEDIA_DIRECTORY setting does not have "../" in it. The media firewall does not support this; it causes problems with sessions since you would have to run scripts outside of the /phpGedView/ directory.

Note: Except as noted above, DO NOT CHANGE your MEDIA_DIRECTORY setting. If it used to say "media/" it should still say "media/" after the media firewall is enabled.

=== Configure the Media Firewall Root Directory ===

By default, your protected media directory will be placed in your $INDEX_DIRECTORY. If you want to move it elsewhere, specify the directory here:

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Configuration file
* Expand the MULTIMEDIA category, then expand the MEDIA FIREWALL category
* Enter the path in the "Media Firewall Root Directory" area.

The primary reason to place it somewhere else is to allow multiple installations of PhpGedView to share the same media files.

Be sure to use the same "Media Firewall Root Directory" for all GEDCOMs on your site.

If you specify a custom path, you will need to create the $MEDIA_DIRECTORY at that location and make sure it is world-writable. For example, if your setttings are
MEDIA_FIREWALL_ROOTDIR : /user/somedir/
MEDIA_DIRECTORY : media/
then you need to create this directory and make it world-writable:
/user/somedir/media/
If your settings are
INDEX_DIRECTORY : /safe/place/index
MEDIA_FIREWALL_ROOTDIR : blank
MEDIA_DIRECTORY : my_stuff/
then PGV will create this directory:
/safe/place/index/my_stuff/
to hold your media.

=== Enable the media firewall ===

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Configuration file
* Expand the MULTIMEDIA category, then expand the MEDIA FIREWALL category
* Set "Use Media Firewall" to YES

You should do this for every GEDCOM on your site. If you share a file between GEDCOMs and that file is in the protected directory, it will only display for the GEDCOMs which have the Media Firewall enabled.

==== Apache ====
If your site is hosted on Apache, PGV will automatically create an .htaccess file in your media directory that intercepts 404 errors and sends them to the media firewall script.

==== IIS ====
Note: IIS Support was added in PhpGedView 4.1.3 (currently in SVN only)

If your site is hosted on IIS, you will need to redirect "HTTP 404 – File not found" errors for your standard media directory to the "mediafirewall.php" script in your root phpGedView directory. This requires altering the "Custom Errors" IIS configuration for your website. See [[http://support.microsoft.com/kb/302570 http://support.microsoft.com/kb/302570]] for details. If your phpGedView root directory is your website root, the correct 404 error redirection settings for your standard media directory are:
404 URL /mediafirewall.php
Note that this step requires administrator access to your website host, so you may need to have your hosting service implement it for you. At least one user has successfully configured IIS in this way.

=== Decide whether to protect thumbnails ===

By default, thumbnails are not stored in the protected media directory. If you want to protect thumbnails:

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Configuration file
* Expand the MULTIMEDIA category, then expand the MEDIA FIREWALL category
* Set "Protect Thumbnails of Protected Images" to YES

=== Enable watermarking ===

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Configuration file
* Expand the MULTIMEDIA category, then expand the MEDIA FIREWALL category
* Set "Who can view non-watermarked images?" to "Show only to Authenticated users" or higher.

You can also set the following options:
* Add watermarks to thumbnails? Y/N (Your media lists will load faster if you don't watermark the thumbnails.) Note: Thumbnails must be in the protected image directory in order to be watermarked. To put thumbnails there automatically, set "Protect Thumbnails of Protected Images" to YES (see previous entry)

* Store watermarked thumbnails on server Y/N (Storing a watermarked copy of thumbnails shouldn't take too much space, and is the best way to speed up media lists while retaining the watermarks.)

* Store watermarked full size images on server Y/N (For people who have plenty of disk space, this will save time generating the watermarked image.)

== Move your images to the protected directory ==

You can protect some/all/none of your images behind the media firewall.

Decide which images you want to protect, and move them from the /phpGedView/media/ directory into your MEDIA_FIREWALL_ROOTDIR/media/ directory.

You can either do this yourself manually or you can use phpGedView/media.php to select and move images to/from the protected directory.

=== Move the images manually ===

Keep the entire path to your images the same, for instance:
/phpGedView/media/dir1/dir2/file.jpg
becomes:
index/media/dir1/dir2/file.jpg

If you want to protect the thumbnail of the image, be sure to move it as well. For example:
/phpGedView/media/thumbs/dir1/dir2/file.jpg
becomes:
index/media/thumbs/dir1/dir2/file.jpg

Be sure you MOVE the files. If you keep the files in your normal media directory, a 404 error will not occur and the media firewall will have no effect.

In case it isn't clear, note that you WILL still have a /phpGedView/media/ directory and it must remain world-writable. At a minimum, it will contain the .htaccess file that enables the media firewall to work.

=== Allow phpGedView to move the images ===

Visit the /phpGedView/media.php file on your site (you must have editing enabled in order to do this). You can move individual files by clicking the "Move to standard directory" or "Move to protected directory" links. You can move entire directories (and subdirectories) by clicking the "Move Standard" or "Move Protected" buttons. Thumbnails will be moved to the protected directory as well if you have set "Protect Thumbnails of Protected Images" to YES.

Note: All images you move to the protected directory will benefit from the watermarking feature. However, if you want only certain people to be able to view the images you must also perform the next step.

== Tell PGV which images need to be protected ==

There are several ways to tell PGV which images are sensitive:

=== Link the image to a private individual ===

If you link the image to a private individual (such as a living person), then the image is considered private.

Question: Are there any Admin settings which affect this? Or does it always work this way?

=== Link the image to a private source ===

If you link the image to a private source, then the image is considered private.

There are at least a couple of ways to make a source private:

# Use the Privacy Settings by ID functionality (described below for media items, same technique for sources)
# Link the source to a private repository
#* Use the Privacy Settings by ID functionality to make a repository private
# Make all sources private:
#* Choose Manage GEDCOMs and edit Privacy
#* EDIT the Privacy file
#* Modify the "Show sources" dropdown

=== Use the Privacy Settings by ID functionality: ===

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Privacy file
* Choose "Privacy Settings by ID"
* Lookup the media which needs to be protected and choose the appropriate authentication level

=== Use the RESN Privacy functionality: ===

First, make sure RESN Privacy is enabled:

* Choose Manage GEDCOMs and edit Privacy
* EDIT the Privacy File
* Set "Use GEDCOM (RESN) Privacy restriction" to YES

Then (assuming editing is enabled), go to the medialist and choose EDIT DETAILS for the image you wish to protect. Expand the RESTRICTION option at the bottom of the form and select PRIVACY or CONFIDENTIAL.

=== Notes ===

Note: You must remember to move each file you wish to protect to the index directory. If you fail to move the files, a 404 will not occur and the Media Firewall will not get the chance to activate.

Question: Are there any other media-related privacy options in PGV?

== Test it ==

First, go to the medialist as an admin and verify that you can view a private image. Copy the direct url to the image and save it to your clipboard.

Logout and try viewing the image as an non-authenticated user. If you moved the image to the correct directory and set your privacy settings appropriately, you will not be able to see the image.

== About Watermarking ==

The media firewall auto-detects the capabilities of your server, and will apply a large diagonal text watermark to your image if your system supports it.

The requirements for this type of watermarking are: PHP compiled with GD and FreeType support.

If your system does not support this, the media firewall will add basic some horizontal text watermarks to your images. On large images, these are barely visible. Try to get your host to support GD and FreeType if at all possible.

If you see a mixture, where some images have the nice watermarking, some have the fallback watermarking and some are not watermarked at all, check your PGV log as described below. Some of your images are probably corrupt.

== Troubleshooting ==

=== Strange Behavior ===

If the standard PGV image viewer shows an all-black image, or if the Album says "Unable to open image", check your PGV log file as described below. The image is probably broken.

If you don't see any errors in your log file, try viewing one of the images directly (not through the album or image viewer). In other words, visit the url directly:
www.yoursite.com/phpGedView/media/path/image.jpg
Note any error messages you see (IE tends to show these errors better than Firefox). If the errors you see are not described on this page, please post a note to the [http://sourceforge.net/forum/forum.php?forum_id=185166 Help Forum].

=== Error Messages ===

==== 404 Not Found ====

When you enable the media firewall, it adds an .htaccess file to your /phpGedView/media/ directory. This is all that is needed on most Apache-based systems. If you are getting a 404 error from Apache you need to contact your host and ask them to add "AllowOverride FileInfo" to your site configuration. See [http://httpd.apache.org/docs/2.0/mod/core.html#allowoverride]

If you are not using Apache you will need to configure your system to detect 404 errors from the /phpGedView/media/ directory and have them processed by the /phpGedView/mediafirewall.php script.

==== No Media Found ====

The requested file was not found in the protected image directory (by inference, it is also not in the standard image directory)

==== Privacy restrictions prevent you from viewing this item ====

This could be one of two things:

1) The requested file does exist in the protected media directory but it is not attached to a GEDCOM record. The media firewall assumes this is a sensitive image and only allows admin users and editors to view it.

2) The requested file does exist in the protected media directory, but PGV privacy rules do not allow the current user to view it.

==== Error: The Media Firewall was launched from a directory other than the media directory. ====

Your server should only send 404 errors from the /phpGedView/media/ directory to the media firewall. This error means your server is sending 404 errors from other directories to the media firewall as well. This will most likely happen if you mis-configure IIS.

=== Log entries ===

You should occasionally check your log file for error messages relating to the Media Firewall:
* Go to the admin page
* Choose View Log Files

Any message which starts with "Media Firewall error" should be investigated as described below.

==== Media Firewall error: >Unknown Mimetype< for file >FILENAMEHERE< ====

If you see this, please open a support ticket asking to have the media firewall to support your media type. Please put the full error message into the ticket.

==== Media Firewall error: >This media file is broken and unable to be watermarked< in file >FILENAMEHERE< (FILESIZE) ====

This indicates there is a problem with a particular media file. Try opening the file in your favorite image processing software and save out a new version.

Note that the media firewall will be unable to add watermarks to this file until you upload a new version.

==== Media Firewall error: >imagettftext() [<a href='function.imagettftext'>function.imagettftext</a>]: Could not find/open font< in file >FILENAMEHERE< (FILESIZE) ====

If you see this error on ALL your images, and you only see the fallback style of watermarking (horizontal text), please post a note to the [http://sourceforge.net/forum/forum.php?forum_id=185166 Help forum].

If this error happens only on some of your images, try opening them in your favorite image processing software and saving out a new version. It may? help to reduce the file size of these image. We are not really sure what causes this, but we have seen it happen.

=== Reminders ===

If you have multiple gedcoms, make sure you set "Use Media Firewall" and "Media Firewall Root Directory" to the same thing for all Gedcoms.

Note: The media firewall does cache your images. You may need to CTRL-R refresh to force your browser to bypass the cache. If that doesn't help, clear your browser cache entirely.

=== Getting Help ===

If you need help, please post a question in the [http://sourceforge.net/forum/forum.php?forum_id=185166 help forum] with the following information about your configuration:

* Multimedia Directory:
* Use Media Firewall:
* Media Firewall Root Directory:
* Protect Thumbnails of Protected Images:
* Who can view non-watermarked images:
* Add watermarks to thumbnails:
* Store watermarked thumbnails on server:
* Store watermarked full size images on server:

Please provide urls to your site if at all possible.

When describing the problem, please provide details about what page you were on and what error messages you received. Also specify whether you did this while logged in or not.

Try viewing an image file directly, bypassing the mediaviewer, lightbox, etc. For instance:
www.domain.com/phpGedView/media/path/image.jpg
Try it as an authenticated user and as a regular user and let us know what happened. Don't forget to CTRL-R refresh after logging out.

Users Guide

2010-05-16T16:11:12Z

Momse: /* Privacy */

{{Phpgedview}}

This '''Users Guide''' is intended to introduce novices to [[PhpGedView]] (or '''PGV''' for short) so they get comfortable using the program on a day-to-day or more occasional basis for their genealogical research. The Guide aims to provide information about how to use PhpGedView from the basics to some more advanced features. Most importantly, it serves to gently introduce the processes and steps to accomplish specific tasks. More a tutorial and overview than reference manual.

This guide is aimed at researchers and editors and not the casual public visitor who does not login nor the administrator who is managing more advanced capabilities. Some features of PhpGedView can only be modified by the site administrator and are detailed in the [[Administrators Guide]]. Online help via the many question mark symbols (insert symbol here yet) can aid the casual visitor as well as novice user to navigate the program.

We start with a Quick Start Guide and overview, followed by more detailed User Tutorials and procedures.

== Quick Start Guide ==
Provided here is a brief overview to get the new [[PhpGedView]] user off to a flying start. At the top of each main heading is a link to more detail for that step. For those who are experienced with similar software, skip directly to the detail in the link. For users new to PGV and genealogy programs in general, read through the quick start completely before jumping down the rabbit hole of links. This to first get an overall feel of important points about the setup and flow. Once done, then go back through and hit the detailed pages to get a step by step introduction of how to do a specific task.

=== Starting a New Tree / GEDCOM ===
{{main|Starting a New Tree}}
What layman call a '''Family Tree''' is often termed a "[[GEDCOM]]" or Genealogical Database in [[PGV]] and to genealogists. Each '''Family Tree''' or database in a PGV installation is stored in its own GEDCOM file. A tree is possibly misleading and represents a myopic view of the relations of people over generations from one persons perspective. Like a banyon tree, as soon as there is a large enough group of people each with their own view, it is no longer easy to determine a starting trunk or source. It is a dense forest of interconnections. Hence database, web or mesh of individuals is a more correct term overall to represent what you are creating here. But the terms are used interchangeably in this guide and often the software to help ease the casual user into using the system.

You can either start from scratch or import work done previously in another program. Those with experience in some other genealogy program can often export the data from there into a GEDCOM file. Once available, the work can then be imported into PGV to start where you left off. Similarly, the PGV can be archived or exported to a GEDCOM file for loading into some other program elsewhere. Just remember that the GEDCOM file captures the facts but only hints at links to media. A user has to separately handle media files that may have been attached. Otherwise, if starting from scratch, the administrator will have to start a new GEDCOM to allow a new tree. Once available, you can begin entering new data on people, places and families. See the main article on how to perform these tasks.

Once you have a tree or database, you have to start adding or editing information. Information in PGV and GEDCOMs in general revolves around two major objects: '''Individuals''' (or People) and '''Families'''. Additional supporting objects are '''Place Hierarchy''', '''Media''', '''Sources''' and '''Repositories'''. To remind yourself of these objects later, look under the main '''Lists''' pull down menu in PGV.

Important secondary facts associated with most objects or facts are dates and places. Just realize there is a lot of freedom and flexibility in what you enter. But the more precise and following of conventions, the better the program can automatically process the data for you. So later on click through the links on these two important facts to learn these important conventions.

=== People and Families ===
Most genealogical software, as does [[PGV]], strive to avoid islands of disconnected people in the database. Therefore, you are restricted to adding people who are related to people already in your database. Further, the connections between people are made inside and through a '''Family'''. People become related by how they relate inside a Family. Some term this the immediate family. In [[PGV]], they are known as '''Close Relatives''' as there are usually two and sometimes more immediate families an Individual may be a part of.

Most people become part of two families in their lifetime. A child in their parents family and, when they marry and have children, as a parent of their own family. Philanders and others may create many more families, whether intentional or not. Note that the concept of a family is not the same as a household. In databases such as these, there is a historical focus on biological relationships with a more recent one of legal relationship through adoption or religious connection available as well. So unless adopted, a young child raised by a step-parent will never appear associated with or in the same family as the step-parent. Something to keep in mind when recording individuals, families and their relationships.

=== Adding/Editing People and Families ===
{{main|Editing People|Editing Families}}

To add a new person, add a close relative to an existing person in the family tree. Generally one adds a spouse, father, mother, or child. A new person can be added in the '''Close Relatives''' tab on the '''Individuals''' screen, or from a '''Family''' screen by clicking to add a child, husband or wife. Adding a child, father, mother or spouse will create the new family if it did not exist already. This because the relationship has to be created when adding the new person and a relationship only exists within a family.

Adding a new spouse will create a new family with the two individuals as parents. A problem arises when trying to add a new sibling before the family exists. It takes a spousal or parent-child relationship to create the family. So even if nothing is known about either parent, one must create at least one parent first to add a sibling. In such cases, create the parent with "Unknown" as their first and last name as a place holder. Later on, the parent can be edited to correct information when known.

There is a distinction between adding someone NEW versus making a link to someone who already exists in the database. Most often you are adding new but occassionaly you may need to link to an existing person. The need arises when distant cousins marry or siblings in one family marry different siblings in another family.

See the main page on [[Editing People]] or [[Editing Families]] for specifics on each form to add a new or link to an existing Individual.

Rarely there is a need to add an unlinked person first, for example, if you are working on a separate branch that might eventually get connected. While possible, it is purposely inconvenient, requires Administrative privileges, and can only be done from inside the Administrator screen (see [[Add an unlinked person]]).

When you add a new Individual, you will have the chance to fill in a lot of information. Do not get too worried, just add what you know. You can always edit or add more information later.

To help with consistency and aid the user, some fields may be filled in for you. Like the last name of a child in a family, or the gender if you selected
"Add a son", "Add a daughter" or the like. But you can change any of the information even if pre-filled in. You can also leave blank any information that is not known.

Generally, a person is minimally defined by their name. Often the gender and maybe one basic event of their life is known as well. The three basic events are:
*Birth
*Marriage
*Death
Note that to add a marriage, you have to add a spouse. The marriage even is actually stored with the family and not the individuals.

Having finished one person, you can proceed to the next person in the family. However, it is likely that you have more [[Facts and Events|Facts and Events]] on the life of the person, like place of residence, religion, education, etc. You can add this data now as well or come back and do it later.

A [[Editing Families|Family]] is created automatically when you add a spouse, parent or child. Just as with an individual, you can add facts, events, and multimedia to the family. Such information will be displayed in the Family screen and with each spouse. A key fact with any family is the Marriage. Another might be a census giving the family members, occupation, and residence. Note that you can add a Marriage when in the Individuals screen. But that fact is actually stored with the family. Something to keep in mind when wondering why your edit disappeared after saving (because it appears staged as an edit waiting for approval with the family and not the individual).

* ''See also:'' a FAQ entry on [[Creating relationships]]

===Adding Sources and Repositories===
{{main|Proper use of sources}}
As you become more accomplished, you will appreciate the concept of sources. Every fact in the database can be attributed with a link to where you got that information from along with the details in the source reference. The name, birth, death and so on are all facts that can be sourced from many places. If you can, get in the habit of ALWAYS adding a source to every fact, event or even name and Individual. Many a time you come back six months later, see something that now seems incorrect, but wonder where you got that notion from. Genealogy is more a constant refining process where you develop better and better educated guesses until you feel you have overwhelming evidence to support just one answer. This happens with every fact -- the name, birth date, birth place and so on. So while it may appear as a tedious task, adding sources pays later.

You can add a source in the ''Sources'' tab on the individual display, and on virtually every fact and object editing screen - whether you are adding or editing new people, events, multimedia etc. The 'Sources' tab is appropriate for sources of a general nature relating to the person. If the source applies to the specific fact, event, image etc, it is better to note the source there. And it is just fine to create a use a source that simply identifies it as an attestation by a specific individual. At least you know where it came from in case you need to reconfirm later or decide which source wins out when conflicting.

Sources can be linked to a repository as well. So the source may be your family bible while the repository is a particular household or family that holds the bible. Or the source may be a particular book and the repository a library where you found the book. Get in the habit of listing the repository as well, even if your own collection. Like sources attached to facts, you will not remember later on where you had seen that important document you forgot to make a photo copy of. Leave a breadcrumb to find that trail later.

===Adding Multimedia===
{{main|Adding / Editing Media}}
You can illustrate your family data with a rich selection of Multimedia: images, voice and video, documents, webpages and other illustrative and documentary material. You can illustrate your sources with images of original documents, and include the complete works - stories, memoirs, biographies, as well as links to external sources and pages.

===Enriching the viewing experience===

After entering a number of people in the family, it is time to think of enriching the viewer's experience. There are many items that make viewing the family tree more enjoyable:

* Maps - GoogleMap module allows you to display locations for all events in person's life.
* News (the Welcome Page has forms for adding news about family etc.)
* Message Forum – an add-on module for a on-line forum

==The User Functions==
Once you have some data in your family tree, you are ready to show them to the users. This section desribes the basic operations the user - either visitor or registered user - can do to find what she wants on the PGV page. The PGV page should be mostly self-explanatory, but there is a lot of functionality under the hood. The user will want to '''Navigate''' the tree to find the information she is interested in, to '''Search''' if navigation does not get her there, and possibly to '''Get data''' - either as a printed report/page to show somebody without a computer, or possibly in an electronic form.

===Navigate===
PGV has a very powerful navigation functions, which allow you to move easily between different persons, families and branches of the Family Tree. You can start with a Person, and navigate using this person nearest relatives, a chart of descendants, a chart of ancestors or a chart that includes both. PGV also extensively uses Lists, which are "live", allowing you to filter, sort, select and jump to another list.

The ''Charts'' and ''Lists'' appear twice on the user interface: in the Top menu, and repeated for the Individual. The Top menu Charts by default start with the designated [[Pedigree Chart Root Person| root person of the family tree]], configurable for each registered user. The Individual menu charts start with the individual. The Top menu lists are global, the Individual menu lists start with the individual or his family.

The genealogy data is often represented as a tree, but one can construct two very different trees, each with an individual at its root. The '''Ancestry tree''' shows the individual and two parents, four grandparents, eight great-grandparents, sixteen great-great-grandparents etc. The '''Descendancy tree''' shows an individual, all his/her children, all grandchildren etc.

====Charts====

[[Charts]] can be used as excellent navigation tools, with many options. Start with the '''Hourglass''' chart, which combines the ''Ancestry'' with ''Descendancy'' views, centered around you or the chosen individual. This gives you the nearest family neighborhood, with more people than the Close Relatives tab. The '''Pedigree''' chart extends towards the ancestors, and is similar to the '''Ancestry''' chart except for the layout. The '''Descendancy''' chart has the same layout as ''Ancestry'' but extends towards individual's descendants. The '''Family Book''' chart displays descendant families, each arranged in an ''Hourglass'' layout. You can achieve similar effect of displaying separate families in the ''Ancestry'' and ''Descendancy'' charts by selecting the "Booklet" option. The '''Relationship''' chart shows all individuals on the way between two individuals; The Relationship charts from the individual to the user favorites are pre-defined.[[image:Sub_Diagrams.png|frame|right|Example sub-menu]]

All those ''standard'' charts have common navigation tools. The Zoom [[image:Zoom.png]] icon expands the individual box, showing his/her life details. The Link to charts  [[image:Link_to_charts.png]]  icon shows a sub-menu of various charts for the individual and related persons, and the Arrow [[image:Arrow.png]] pointing in different directions moves the display in the direction indicated, and in some contexts also displays a submenu if the destination is ambiguous. A plus or minus sign [[image:PlusMinus.png]] expands or contract parts of the tree.

Other diagrams present the data in different graphic formats. The '''Circle''' diagram gives a snapshot of several generations of ancestors, with individual in the center. The '''Compact''' chart crams the individual and his/her ancestors up to great great grandparents (with optional images) in one compact page. There are two diagrams showing people and events as they develop in time. The '''Timeline''' chart shows all ''events'' of one (or more) individuals on a timeline. The '''Lifespan''' chart compares multiple ''individuals'', with their events shown with small markers. Once selected, you can switch between those two views. In each diagram you can also navigate to the individual by clicking his/her name.

A summary of available charts:

* Ancestry tree
:* [[Ancestry Chart]]
:* [[Pedigree Chart]]
:* [[Circle Diagram]]
:* Compact Chart
*Descendancy tree
:* [[Descendancy Chart]]
:* [[Family Book Chart]]
*Combined Ancestry and Descendancy tree
:*[[Hourglass Chart]]
:*[[Interactive Tree]]
* Single line joining two individuals
:* [[Relationship Chart]]
* Time span
:* [[Timeline Chart]]
:* [[Lifespan Chart]]

====Lists====

[[Lists]], like charts, can also be used as live navigation tools. Lists, especially lists of people and families, show up in multiple locations, and almost all lists are connected. For example, viewing a list of people, you can click on the place name, which will bring you to the place hierarchy display with people and families related to this place; if you click at the date, you will be brought to the anniversary calendar with lists of events that occurred on this date (month, year, etc.). all list have column headers that can be clicked to sort the rows alphabetically; the people list have additional options to sort by first name, and to add parents.

=====People and families=====
Lists of people and families are displayed in many places: when the "[[Family List]]" and "[[Individual List]]" menu items are selected; as a result of a search; in the "On This Day" and "Upcoming Events" boxes; as lists of people and families linked to a particular Source or Media object; as lists of people and families related to the selected Place location etc.
People lists share the header that allows you to filter and select people based on a range of criteria:
[[image:Indi_List.png|frame|center]]
[[image:Fam_List.png|frame|center]]

{|
!width="33%"|
!width="33%"|
!width="33%"|
|-
|Males Females Persons whose gender is unknown Alive in specified year Alive (individual or both) Dead (individual or both) People born more than 100 years ago
|People born within last 100 years People who died over 100 years ago People who died within last 100 years Couples both alive Couples where only male is alive Couples where only female is alive Couples where both partners are deceased
|Couples with unknown marriage date Divorced couples Roots: people who have no parents recorded in the database (both if family) Leaves: people who are alive and have no children recorded in the database
|}

Using any one of those filters you can narrow the list of choices. Clicking the person or family will navigate to this person (family) display. Selecting the place or date will bring the Place Hierarchy or Anniversary lists.

=====Place Hierarchy=====
If places in your GEDCOM are structured (see [[Place data]] for details), the Place Hierarchy list will display the list of top level place elements. They typically should be country names, although in some not-so-distant future they could be "Earth", "Moon", "Mars" etc. When you click on any such element, you will be presented with a list of its sub-elements, for example States if the country was US. The sub-list will be accompanied by a map, if available. You can continue to lower level sub-units (Counties, etc.), or select "View all records found in this place". You will eventually see a list of people and families. Birth, Death and Marriage places are listed, but the name will show in this list if the place is mentioned with any event.

As always, clicking the person/family opens this person/family screen, clicking the place opens another another list of all people/families associated with this place etc.

=====Multimedia=====
The [[MultiMedia List]] menu item will display the list of Media Objects. You can use the "Filter" function to search for media that have the selected phrase in the title. The Objects returned usually include thumbnail, and also a list of people/families it is associated with. You can navagate to any of them by clicking the name.

=====Sources and Repositories=====
The [[Source List]] and [[Repository List]] display the sources and repositories found in your Gedcom respectively. They do not currently have any filtering tools. If you click on a source, you will be brought to the source screen, with its details and a list of people for which this source is cited. If you click on a repository, you will see a the depository details and a list of sources in this repository.

====Calendar====
The Anniversary Calendar will display the anniversaries occuring on a specific day, month or year. It will show lists of people and families, and for each the events that match the selection criteria. The list will show events (selectable in the "Show events" option) and also indicate, which anniversary it is, relative to the selected year (which may not be the current year). Only "positive" anniversaries are shown, i.e. the screen will only show events that occurred before (or in) the selected year,. For example if your anniversary date is March 1780, and you are displaying months, events that occurred in all Marches before 1780 will be shown.

[[image:Anniversary_Calendar.png|frame|center]]
You can select Day, Month or Year from the menu, or switch using the "View Day", "View Month" and "View Year" options on the screen.
* '''View Day''' will display events that occurred ''this day of this month in any year''.
* '''View Month''' will display events that occurred ''any day of this month in any year''.
* '''View Year''' will display events that occurred ''any day of any month in this year''.

For example, if you want to find all events that occurred on February 29, you need to first select a leap year (latest leap year if you want all events, for example 2008), then click on February and finally on the 29th.

The screen has other useful functionality. You can select all people, living people or limit the range to the last 100 years (the "Show" option). You can select the gender (all, men, women) and select the events that are to be shown (All, Births, Deaths and Marriages and a selection from more common events).

You can also select different calendars. The events that occurred on a specific date may have an anniversary on different dates in the Julian, Jewish or Islamic calendars. Due to different calendar rules, the determination of the anniversary may only be approximate (typically the difference does not exceed one day).

As with all lists, clicking on person's name (or family names) opens this person or family screen. Conversely, clicking on a date, month or year in any other lists brings this anniversary calendar focused on the selected date, month or year.

====Close relatives====
When you click the "Close relatives" tab on the individual display, you will switched to a screen showing the individual's family in which he or she is a child, and the family in which he or she is a spouse. You can navigate to parents and siblings, as well as to the families listed on this display.

===Search===
{{main|Search}}
PGV has a powerful search facility, which can be accessed for a quick search trough a '''Search box''', and via the '''Search menu'''. The Search box does the same search as the General Search item in the ''Search menu'', but with all ''Search for'' options and all ''Databases'' selected.

====General====
The General Search allows you to search for almost anything - names, places, dates, fragments of text, etc. There are some caveats - dates must be entered in their English abbreviated form (e.g. ''12 Jan 1817'') and you can use regular expressions if you know how. The search is not case sensitive, and wildcards are assumed - the search term will be found no matter what precedes or follows it. The options are:

;Search For
: You can check one or more of the following
:* Individual Names. Actually this should say Individuals - this option searches the Individual Records for the text string you entered
:* Family Names. As above, it searches Family Records fro the search string
:* Sources - will search Sources for the term you specified
;Exclude Filter
: Excludes some non-genealogical data by default, you can turn it off.
;Associates
:Includes records of [[Adding an Associate|associates]] in the search.
; Database to search in
: select the Gedcom to search for, if there is more than one.

====Non-English====
If your database has mostly '''English''' names, the General seach works well enough. For '''non-English''' families, there are language and culture based issues.Some examples are:
; Letters with diacriticals
: The General search is exact, i.e. it will not return a result if you substitute Muller or Mueller for Müller, or Lodz for Łódź.
; Declension
: In many languges names undergo declension depending on gender, (e.g. the daughter of Kowalski is Kowalska: looking for Kowalski misses all his daughters).
All such issues cause misses in search results. The best remedy is to use the Soundex Search with Daitch-Mokotoff type, as described below.

====Soundex====
Soundex should return search results even if the spelling is not exact. You can use Basic type, but the
Daitch-Mokotoff is more efficient in finding close matches, and only this type works for non-English search terms. Of course, the Soundex search may return more results than needed, but it is more likely to find what are you looking for. The search terms can be entered as '''Given name''', '''Last name''', or '''Place''', and modified by selecting a '''Year'''.

===Get data===
In addition to viewing the Family Tree on thew ebpage, you may need to extract some data to work on them off-line. Typically this would include the printed or printable form to be distributed on paper or included in a family book or other publication, and raw data for further manipulation, creating tables or extracts or importing to other programs.

====Printable data====
You can print any PGV page, with the help of an "Printer friendly version" at the bottom of each page; there is also a menu item called "Reports", devoted to generation of reports in printable form.
=====Reports=====
You can select from an array of reports in the Reports menu. For each report you have some options to select, and they can be delivered as HTML (i.e. on the webpage) or as a downloadable pdf file (you need a pdf reader to open the file). You can select family tree reports (Individual, Family, Descendants, Ancestors, etc.), some genealogical information information lists (Marriages, Deaths, Births etc.), as well as other lists like recent changes or address lists.

You can [[Create custom report|create your own report]] to be included in the menu. See also the list of [[XML Report Templates|XML report templates]] you can use.

Please note that the Address reports currently show only addresses attached to the individual and family records, not addresses in the Residence facts.

=====Charts=====
Often a better option to produce a printable version of some section of the family tree is to use the Charts menu. You can tune up your chart using its options, and then select the "Printer friendly version" at the bottom of the page to clean up the display. You can print the result or use a pdf printer driver (for example Open Source [http://sourceforge.net/projects/pdfcreator/ PDF Creator]) to create the pdf file.

====Electronic form====
If you have Administrator privileges, you can [[Manage_GEDCOMs_and_edit_privacy#Download_.28Gedcom.29|download]] the complete Gedcom together with the media. Other user categories can use the '''Family Clippings Cart''' to pack into a file a selection of data they can access, if this option is enabled by the administrator.
=====Family Tree Clippings=====
Anytime you view an individual, a family or a source, in the ''Other'' menu you can access an ''Add to Clippings Cart'' submenu. It will present you with a list of options to add just this item or expand the selection by adding other relations or, in case of sources, records of all people and families quoting this source. You can also reach the Clippings cart from the main menu.

You can keep adding items to your cart until you are ready - the content of the cart will be preserved between sessions. The cart will show the list of items, you can also remove unwanted ones. When you are ready, you can download the file which will contain a gedcom with all selected items, plus media files if you selected this option

== The User Interface ==

PhpGedView is a [[Features|feature]] rich piece of geneological software and as such there is a plethora of information that can be displayed and edited at any one time, thus resulting in a complex but reasonably intuitive user interface. This section aims to help orientate you by describing the general layout and design of the interface.

When visiting a PhpGedView powered website for the first time you will see the [[Welcome Page]]. This page should contain some form of introduction to the website and possibly some basic geneological information. If however, you are a registered user and are logged in, you will see the [[MyGedView Portal]] page instead.

=== Menu Bar ===

{{main|Menu Bar}}

Which ever page you visit you will always see and have access to the [[Menu Bar]]. Depending on whether you are logged in or not and what [[modules]] the site administrator has installed, will determine what menu items are available. In addition, the currently selected [[themes|theme]] may determine the "style" of the icons shown.

*[[Users menu items|User’s menu items]]

==Editing/Entering Data==
===Admin approval ===
Your editing status depends on the Administrator policy, and may vary depending on installation. Typically you can edit your own data, and need editing provileges to edit others.

The changes you make are not immediately visible to other users. They are marked on the page as changes, pending approval by the Administrator. There are several access levels for people that can approve others' edits. This process of displaying pending changes is not yet perfect, and some entites are not visible: for example creating a new Source does not display it, and if you did not happen to write down the source ID, you must wait for approval in order to proceed.

If you have configured your site with the PENDING CHANGES block, after any changes are made, an email is sent to admin informing him/her of edits to the database. The email is not repeated until 24 hours passes (lest each editing session would create a spam). The administrator approval process is described in a separate article, see [[Accept / Reject Changes]].

===Gedcom data structure ===
{{main|Gedcom data structure}}
The data model as well as file storage in PGV is based on [[GEDCOM]] standard. There are many resources detailing the structure, the meaning of Gedcom Tags and usage, including the draft Gedcom standard that is the base of PGV model. PGV is very flexible in using the model, and allows files with significant departures from the model to be processed. The [[Verify Gedcom File|verification]] procedure can check your Gedcom file for strict and lax conformance with Gedcom standard. It is recomended that you review the basics of [[Gedcom data structure]].

===Basic rules ===
In working with genealogy data you must remember to always verify, document, write down the sources. Memory is fragile, and years later you will not know if the error was in original source or just sloppy data entry. Two articles on this topic are available here, '''[[Evaluating Evidence Article|Evaluating Evidence]]''' and '''[[Standards For Sound Genealogical Research]]''', with many references to external sources. Before starting entering large amounts of data, review the most basic rules for entering dates, places, sources and other common elements:

:*[[Dates|Dates]]
:*[[Place data|Places]]
:*[[Proper use of sources|Sources]]
:*[[Common Data Elements|Common data elements]]

===Common Elements===
{{main|Common Data Elements}}
In entering Events and Facts you fill data fields, some of which are the common to most entries. In describing and Event, '''Date''' and '''Place''' are considered most important, and have their special rules for entering data: see the articles on '''[[Dates]]''' and '''[[Place data|Places]]'''. Other entries that you will frequently encounter are '''Type''', '''Address''', '''Associate''', '''Source Citation''', '''Restriction''', '''Agency''' and '''Note'''. All those elements are useful and add valuable structure to the data, you should take advantage of them if possible.

===People===
{{main|Editing People|Editing Families}}

In the heart of genealogy are people and their pedigree. Pedigree, according to Webster (''Middle English pedegru, from Anglo-French pé de grue, literally, crane's foot; from the shape made by the lines of a genealogical chart'') is defined as an ancestral line. Adding, modifying and deleting people and their links in families creating the ancestral lines is described in two main articles.

Also at the heart of genealogy are the family relationships between people. Whereas information about a specific person is contained in his individual record, relationships are handled by family (FAM) records. FAM records describe one family: usually husband, wife, and children. An individual record typically contains a FAMC pointer to the FAM record where the person is a child, and a FAMS pointer to the family where that person is a husband or wife. With these two fundamental relationships, all other relationships are derived.

===Facts and Events===

{{main|Facts and Events}}

To give life to people and famiy data in your database, you add facts and events. The terminology is a little confused; Gedcom standard talks about ''Events'' like Birth, Baptism, Graduation, etc. with a generic "Event", and about ''Attributes'' sometimes called ''Facts'' like Education, Occupation or Residence with a generic "Fact". The conceptual difference is that ''Events'' occur at a definite point in time (the point may extend as far as a day), while ''Facts'' are either extended in time (e.g Education), or don't have a specific time attached to them (e.g Number of Children). PGV does not treat the Facts and Events differently, and allows you to add Facts and Events to an individual or family by selecting from a list of possibilities. The Administator can customize this list, adding and removing both individual and family entries, as well as „Quick Add'” items available with a single click. If you don't see here what you need, ask the administrator to add it.

===Editing raw Gedcom record===
{{main|Edit raw GEDCOM record}}
Each [[Gedcom data structure#Top level records in Gedcom|top level record]] (individual, family, object, source and repository) has its own Gedcom fragment that you can view and edit. In a perfect world, all editing should be possible trough user interface, but who has seen perfect software? Also, imported Gedcom may contain errors or non-standard tags that PGV does not understand, and errors could also be introduced by PGV as well. Of course this should not happen, but who has seen software completely free from bugs?
The Gedcom record has a simple structure, each line starting with a number that indicates the level: after a tag with level 1, subsequent tag level 2 indicates that it is subordinate to the level one tag. For example if the event is Birth (1 BIRT), Date (2 DAT) applies to Birth, Time (3 TIME) applies to Date, and Place (2 PLAC) applies to Birth: <pre>
1 BIRT
2 DATE 11 NOV 1825
3 TIME 23:55
2 PLAC Greenwood...
</pre>

The tags are always 3 or 4 capital letters, and are separated by space from level number and from subsequent value of the tag (if any). If a tag is missing, is in the wrong place, or the user interface does not supply the value you seek, you can correct it by editing the Gedcom fragment. For example, if the Media Object you are adding is a painting, and the user interface offers only ''photo'' as the type of the file (no photography before 1827 or so :-(, you can look at the raw Gedcom fragment: <pre>
0 @M897@ OBJE
1 FILE media/Aunt_Matilda.jpg
2 FORM JPG
3 TYPE photo</pre>

and change the line ''3 TYPE photo'' to ''3 TYPE painting''.

==Privacy==
{{main|Privacy}}
As a user you are possibly concerned with privacy. While it is a responsibility of an Administrator to set the privacy policies, it is usefull to know, what options are avilable. You may wonder whether your personal data will be visible to everybody, and may also encounter restrictions on what you can see. PGV has very detailed privacy rules, which can restrict viewing and /or editing of specific event types, specific events, selected people, people not related to you or only distantly related etc.

==Tutorials==
===Research Assistant===
{{main|Research Assistant}}
Research Assistant is an add-on providing a number of tools and support for a collaborative genealogical research. It allows you to attach a task to a person being researched, assign a task to a used, organize tasks in folders, track task progress etc. It has heuristic tools for doing research (mostly, but not exclusively for the US -based events) and tools to auto-generate tasks. Read the [[Research Assistant]] tutorial for more details.

[[Category:Users Guide]]
[[Category:PhpGedView]]


[[fr:Guide de l'utilisateur]]
[[da:Bruger Guide]]