view release on metacpan or  search on metacpan

README  view on Meta::CPAN

DATAFILE FORMAT:

      The program can handle excel, csv (txt), gedcom, serialized files and can get data from database. Follow these rules to decide which one to use:
      1, Use gedcom if you already have your family tree data in a gedcom file and the fields that the program is able to import is sufficient.
      2, Use the excel format if you just started to build your family tree data.
      3, Convert your data file into serialized format if the data file contains many people (like some thousand) and you would like to reduce response time and memory need.
    
      Data format history:
      Originally the input file was a csv flat file with semicolon as the separator. It could store 6 fields for each person (name, father name, mother name, email, webpage, date of birth/death). As new fields were required (like gender, place of bir...
    
      We encourage everybody to use the excel format. To convert from the csv format to the excel format, use script script/convertFormat.pl
    
      TIP 1.: Maintain your family tree data in excel using the Form option. Select all the columns, then press DATA->Form. It is convenient to add new people or to modify information of existing persons.
      TIP 2.: Freeze the first line so that header does not disappear when scrolling down.

The excel format:

      The excel format is quite straightforward based on the example file. Each row (except the header) represents a person. The fields are:
       * ID: the ID of the person. It can be anything (like 123 or Bart_Simpson), but it should only contain alphanumeric characters and underscore (no whitespace is allowed).
       * title: like: Dr., Prof.
       * prefix: like: sir
       * first name
       * middle name
       * last Name
       * suffix: like: VIII
       * nickname
       * father's ID
       * mother's ID
       * email
       * webpage
       * date of birth: the format is day/month/year, like: 24/3/1977
       * date of death: the format is day/month/year, like: 24/3/1977
       * gender: 0 for male, 1 female
       * is living?: 0 for live 1 for dead
       * place of birth: the format is: "country" "city". The city part may be omitted. Quotation marks are mandatory.
       * place of death: the format is: "country" "city". The city part may be omitted. Quotation marks are mandatory.
       * cemetery: the format is: "country" "city" "cemetery", like: "USA" "Washington D.C." "Arlington National Cemetery"
       * schools: use comma as separator, like: Harward, MIT
       * jobs: use comma as separator
       * work places: use comma as separator
       * places of living: places separated by comma, like: "USA" "Springfield", "USA" "Connecticut"
       * general: you would typically write something general about the person.
      Note, that the extension of an excel data file must be xls.
    
      Tip: Select the second row, click on menu Window and select Freeze Panels.
      This will freeze the first row and you can see the title of columns.

The csv format:

      Semicolon is the separator. The fields are:
    
      1. Full name.
       Middle names can be included in this field.
       If more than one person share the same name, a number can be appended (not shown in the displayed output). For example, "Bart Simpson2".
      2. Father (optional - leave blank if not known). No middle names.
      3. Mother (optional)
      4. email address (optional)
      5. web page (optional)
      6. Dates, birth-death (both optional).
      Examples: "17/10/49-24/11/83", "10/69-"
       Note that the year of birth is not displayed for people who are still alive.
      7. Gender (0 for male, 1 for female)
      8. title: like: Dr., Prof.
      9. prefix: like: sir
      10. suffix: like: VIII
      11. is living?: 0 for live 1 for dead
      12. place of birth: the format is: "country" "city". The city part may be omitted. Quotation marks are mandatory.
      13. place of death: the format is: "country" "city". The city part may be omitted. Quotation marks are mandatory.
      14. cemetery: the format is: "country" "city" "cemetery", like: "USA" "Washington D.C." "Arlington National Cemetery"
      15. schools: use comma as separator, like: Harward,MIT
      16. jobs: use comma as separator
      17. work places: use comma as separator
      18. places of living: places separated by comma, like: "USA" "Springfield", "USA" "Connecticut"
      19. general: you would typically write something general about the person.
      Note, that the extension of a csv data file must be either csv or txt. To define the encoding of the file use option encoding in the config file.

Convert from csv (txt) format to excel format:

      To switch from comma separated value file to excel spreadsheet, do the following:
      cd ftree2
      perl ./scripts/convertFormat.pl ./tree.txt ./tree.xls
      This will generate (overwrite) a tree.xls file.
    
      The GEDCOM format:
      GEDCOM, an acronym for GEnealogical Data COMmunication, is a specification for exchanging genealogical data between different genealogy software. GEDCOM was developed by The Church of Jesus Christ of Latter-day Saints as an aid in their extensi...
    
      Beside the father, mother relationships, the program handles the following information of a person:
      1, gender
      2, date of birth
      3, date of death
      4, place of birth (only city and country are extracted)
      5, place of death (only city and country are extracted)
      6, cemetery (only cemetery, city and country are extracted)
      7, email address
      8, homepage
    
      It is possible to switch from GEDCOM to excel (or serialized) format. Use the scripts/convertFormat.pl script. For example
      cd ftree2
      perl ./scripts/convertFormat.pl ./tree.ged ./tree.xls

    The ser format: The drawback of excel, csv and GEDCOM format is that it
    has to be parsed and processed every time the program runs. It is
    possible to speed-up the program (and hence reduce response time) and
    reduce memory usage if you use the serialized format. The serialized
    format cannot be edited directly. Basically you maintain your family
    tree data in excel (or in csv or GEDCOM) then create a serialized file
    using scripts/convertFormat.pl program. If the name of the family tree
    data is ftree.xls then, the following commands will generate the
    serialized file:

      cd ftree2
      perl ./scripts/convertFormat.pl ./tree.xls ./tree.ser
    
      Don't forget to set the data_source to "../tree.ser" in the PerlSettingsImporter.pm file.
    
      Note, that the extension of a serialized data file must be ser. Also keep in mind that different versions of perl may produce incompatible serialized versions. It is advised to run the convertFormat.pl script on the same mashine where the webse...

NAME OF THE PICTURE:

    One picture may belong to each person. The name of the picture file
    reflects the person it belongs to. The picture file is obtained from