home *** CD-ROM | disk | FTP | other *** search
/ Boot Disc 8 / boot-disc-1997-04.iso / PDA_Soft / Psion / misc / Geni / README.TXT < prev   
Text File  |  1996-11-09  |  18KB  |  389 lines
  1.      ==================================================================
  2.                      README file for Geni Version 1.11
  3.      (c) Martin Dunstan  (mnd@dcs.st-andrews.ac.uk)  November 9th, 1996
  4.      ==================================================================
  5.  
  6. Credits:
  7.    Idea and design: Vivienne S. Dunstan
  8.    Programming:     Martin N. Dunstan
  9.  
  10.  
  11. Purpose:
  12.    Browse genealogical databases with ease.
  13.  
  14.  
  15. Copyright:
  16.    (c) Martin N. Dunstan  (mnd@dcs.st-andrews.ac.uk)  November, 1996.
  17.  
  18.    You are free to distribute Geni provided that you do not make any profit
  19.    from it and it is accompanied by this README file and the RdGed program.
  20.    This application is shareware. You may use it to browse to 25 individuals
  21.    while unregistered. After this point the program will become unusable
  22.    (except to read the help information) until it is registered.
  23.  
  24.  
  25. Features:
  26.    * Databases stored in compact format e.g. 4000 individuals in 300K.
  27.    * Browse to parents, siblings, children or spouses via a few
  28.      easy-to-remember keypresses.
  29.    * Ancestral tree display.
  30.    * View details of current individual and their marriages.
  31.    * Context-sensitive help as well as detailed help.
  32.    * Searching with wildcards.
  33.    * Remembers details of recently used databases.
  34.  
  35.  
  36. Changes from version 1.00 to 1.10:
  37.    * Geni 1.10 runs far quicker than version 1.00.
  38.    * Much quicker when closing down.
  39.    * Databases incompatible with version 1.00
  40.    * Doesn't rely on the sex field for locating spouses.
  41.    * Requires less memory to use.
  42.  
  43.  
  44. Changes from version 1.10 to 1.11
  45.    * RdGed uses non-recursive quick sort to save system memory.
  46.    * Search string only has a * wildcard at the end not at the
  47.      beginning as well.
  48.  
  49.  
  50. Registration:
  51.    This program is shareware - if you like it and wish to register your
  52.    copy please send 15 pounds (or whatever you feel the program is worth) in UK
  53.    currency (Sterling cheque or international bankers draft) to the address
  54.    below along with the name under which you want it registered (maximum of 60
  55.    characters). If you have an e-mail address please print it clearly and I
  56.    will e-mail your registration code to you, otherwise I will reply as soon
  57.    as possible via snail mail. If you wish I will notify you of any major
  58.    changes or bug fixes.
  59.  
  60.       Martin Dunstan
  61.       1 Cupar Mills
  62.       Cupar
  63.       Fife  KY15 5EH
  64.       Scotland
  65.  
  66.  
  67. RdGed 1.11 Footprint:
  68.    System memory (running) ... 22K
  69.    User memory (running) ..... 13K
  70.    Application size .......... 15K
  71.    Total ..................... 48K
  72.  
  73.    If large GEDCOM files are converted then some extra memory might
  74.    be needed for a lookup table. A database of 6000 records could
  75.    require an extra 64K of system memory.
  76.  
  77.  
  78. Geni 1.10 Footprint:
  79.    System memory (running) ...  47K
  80.    User memory (running) .....  28K
  81.    Application size ..........  32K
  82.    Help database .............   7K
  83.    Title screen ..............   7K
  84.    Resource file .............   1K
  85.    Total ..................... 122K
  86.  
  87.    The operating system requires some extram memory when opening new
  88.    Geni databases. This memory is released once the database has been
  89.    successfully opened. For a database of about 380K the extra memory
  90.    is around 22K.
  91.  
  92.  
  93. Description:
  94.    Geni is a fully-fledged genealogical database browser for the Psion 3a
  95.    and 3c. It is intended to be used by genealogists who maintain their
  96.    data on a computer such as a PC or Macintosh using a package designed
  97.    for the purpose. Users must be able to save their data in GEDCOM
  98.    format for Geni to work.
  99.  
  100.    The databases used by Geni are very compact (usually half the size
  101.    of the GEDCOM from which they were created) allowing the user to
  102.    carry large databases on a small Psion without the need for extra
  103.    disks. These databases are created from GEDCOM files by RdGed, a
  104.    program which accompanies the Geni distribution. 
  105.  
  106.    Users are not expected to keep the Geni file completely up-to-date
  107.    with their central database but will recreate it when needed. The
  108.    ability to save information in GEDCOM format is required for the
  109.    creation of the Geni database file. 
  110.  
  111.    The program begins by displaying an ancestral tree for the current
  112.    individual. This is either the first individual in the database or
  113.    the one which the user was at when the database was last used.
  114.  
  115.    The ancestral tree display shows the current individual
  116.    and their parents and grandparents; the lifespan of each person is
  117.    given for clarity. From this screen users can browse to the parents,
  118.    children, siblings or spouses of the current individual via a few
  119.    easy-to-remember keypresses. Alternatively a detailed display of the
  120.    current individual can be viewed by pressing ENTER.
  121.  
  122.    At the tree display the following keypresses are available:
  123.  
  124.         f    make their father the current individual
  125.         m    make their father the current individual
  126.         s    select a spouse to be the current individual.
  127.         c    select a child to be the current individual.
  128.         o    make their older full sibling the current individual.
  129.         y    make their younger full sibling the current individual.
  130.         d    show details of the current database.
  131.       ENTER  show details of the current individual.
  132.       HELP   show the currently available key-presses.
  133.       MENU   bring up the application menu.
  134.  
  135.    The "o" and "y" key presses browse to the next oldest or youngest
  136.    full sibling where "older" and "younger" is determined by the order
  137.    in which the siblings are listed in the GEDCOM rather than by age.
  138.    Only full siblings are considered - to browse to half-siblings press
  139.    "f" or "m" and then press "c". If the current individual is the oldest
  140.    then the "o" search wraps around to the youngest sibling. Similarly
  141.    the "y" search will wrap around if the current individual is the
  142.    youngest.
  143.  
  144.    The detailed display shows the birth (or christening) and death (or
  145.    burial) of the individual and two scrolling lists. The first scrolling
  146.    list contains all the spouses of the current individual while the second
  147.    contains all their children by all those spouses. The up and down cursor
  148.    keys scroll through the currently selected list and the left and right
  149.    cursor keys shift the list contents from side to side; the user can switch
  150.    between the two scrolling lists by pressing the TAB key.
  151.  
  152.    Pressing ENTER will browse to the highlighted individual in the currently
  153.    selected list and show their ancestral tree. As with the tree display,
  154.    HELP provides context-sensitive help and MENU brings up the application
  155.    menu.
  156.  
  157.    Individuals may be searched for by name from the menu. Searching is
  158.    case insensitive and limited pattern matching facilities are available
  159.    via the * and ? symbols. The * will match zero or more characters while
  160.    the ? matches any single character. For example, to find someone called
  161.    William Gordon with unknown middle names (or even no middle names) the
  162.    pattern "william*gordon" could be used. To search for someone whose
  163.    name might be spelt as Elizabeth or Elisabeth the pattern "eli?abeth"
  164.    should be used.
  165.  
  166.    Note that Geni always adds a * after the pattern you type so "b*sM?th"
  167.    matches "Fred /Blacksmith/ Jr" as well as names such as "Barbara Smith"
  168.    and "Basmyth". 
  169.  
  170.    Context-sensitive help is available at all times by pressing HELP.
  171.    More detailed help can be obtained via the menus. At the moment the
  172.    detailed help is in English but other languages could easily be
  173.    provided in the future.
  174.  
  175.    There are no facilities for altering the information stored in the
  176.    database except by modifying the original GEDCOM file and recreating
  177.    the database with RdGed. Also, there are no facilities for querying
  178.    relationships or for searching for people using anything other than
  179.    their name.
  180.  
  181.    Geni supports multiple databases although only one may be viewed at
  182.    a time. Various details of recently used databases are remembered
  183.    such as the current individual and search string so users can quit
  184.    the application and restart at the point where they left off.
  185.  
  186.    Menu options:
  187.  
  188.       File:
  189.          Load (Psion-O)
  190.  
  191.       Search:
  192.          Find (Psion-F)
  193.          Find Again (Psion-G)
  194.  
  195.       Info:
  196.          About (Psion-A)
  197.          Help (Psion-H)
  198.  
  199.       Special:
  200.          Register (Psion-R)
  201.          Exit (Psion-X)
  202.  
  203.  
  204. Installation:
  205.    The following notes assume you have enough memory to install Geni and
  206.    RdGed as well as storing the GEDCOM and the Geni database file at the
  207.    same time (see the Footprint section near the start of this file). If
  208.    you are limited for space you can leave the GEDCOM on your main computer
  209.    and access it via the serial link. If you are very short of space you can
  210.    direct RdGed (via the dialog windows) to store the Geni database on your
  211.    main computer until after installation.
  212.  
  213.    Make sure you are at the system screen and not inside an application.
  214.  
  215.    Now check that the RunOPL application is installed: hold down the Control
  216.    key and press the Calc icon on the button bar (above the 9 and 0 keys).
  217.    If you can see an icon in the shape of a speech bubble on a transparent
  218.    background with the word "OPL" inside then RunOPL is installed. The
  219.    Program application looks similar but has a dark background.
  220.  
  221.    If you can't find RunOPL and get the message "RunOPL not installed" then
  222.    you should install it as follows:
  223.  
  224.      * Press the MENU button and use the left or right arrow keys to move
  225.        to the "Apps" menu. Use the up or down arrows to select the "Install
  226.        Standard" option and press ENTER.
  227.  
  228.      * A dialog box will appear with a name between two arrows. This will
  229.        probably be RunImg but might not. Use the left or right arrow keys
  230.        to find RunOPL. Once found press ENTER and the RunOPL icon will
  231.        appear on the screen.
  232.  
  233.    Now make sure that the \OPO directory is created: select the Time icon
  234.    and press TAB. Since the Time application has no files you should see
  235.    a listing of the \ directory. Use the up arrow to see if \OPO is listed.
  236.    If not press the MENU key, move to the "Disk" menu and select "Make
  237.    Directory". Type in \OPO as the dirctory to be created.
  238.  
  239.      (1) Create directories:
  240.            \APP\GENI
  241.            \GENI
  242.            \GENI\GED
  243.  
  244.      (2) Copy:
  245.            GENI.OPA  into \APP
  246.            GENI.DBF  into \APP\GENI
  247.            GENI.PIC  into \APP\GENI
  248.            RDGED.OPO into \OPO
  249.            Your GEDCOM file(s) into \GENI\GED
  250.  
  251.      (3) Install Geni (choose INSTALL from the system screen APP menu).
  252.  
  253.      (4) You can now run RdGed on each GEDCOM file to convert them into
  254.          Geni files: see the tutorial section below for more help. Once
  255.          RdGed has finished converting the newly created files can be
  256.          used by Geni immediately.
  257.  
  258.    NOTE: the \APP directory in the notes above must be the same one each
  259.          time (i.e. you can't install \APP\GENI on one disk and then
  260.          place GENI.OPA on another). Also this directory must NOT be on a
  261.          Flash disk. Usually one would install Geni on the internal disk
  262.          but a RAM disk should work just as well.
  263.  
  264.    After conversion you can remove the GEDCOM files and RDGED.OPO as well
  265.    as \GENI\GED if you created it. RdGed can read GEDCOM and write Geni
  266.    databases over the serial link - at either of the dialogs press the down
  267.    arrow and then use the left and right arrows to select the appropriate
  268.    drive. Unfortunately Geni doesn't like to access the databases over the
  269.    serial link so you must have them stored on the Psion somewhere, ideally
  270.    in \GENI.
  271.  
  272.    The detailed help information is stored in the GENI.DBF file. If you
  273.    need a little extra space this file can be deleted and Geni will still
  274.    work although detailed help will be unavailable. If anyone would like
  275.    to translate the contents of GENI.DBF into other languages such as French
  276.    or German please send me a copy!
  277.  
  278.  
  279. Tutorial:
  280.    This is a short tutorial to familiarise yourself with using RdGed and
  281.    Geni. Start by installing Geni and RdGed as described in the previous
  282.    section and copy DEMO.GED into the \GENI\GED directory.
  283.  
  284.      (1) From the system screen find the RunOPL application which should
  285.          have RdGed listed as one of its files. Use the arrow keys to
  286.          highlight RdGed. If RdGed isn't listed and you have definitely
  287.          copied RDGED.OPO into the \OPO directory try pressing the System
  288.          button (leftmost icon on the button bar).
  289.  
  290.      (2) Start RdGed by pressing ENTER and then use the dialog box that
  291.          appears to select the GEDCOM file you wish to convert. If the
  292.          DEMO.GED file hasn't been copied into \GENI\GED then press the
  293.          TAB key and locate it using the standard Psion file browser.
  294.  
  295.      (3) Press ENTER and then type in the name of the Geni file to be
  296.          created at the second dialog box that appears. If you have
  297.          already created a Geni file with the same name and wish to
  298.          overwrite it it may be quicker to press the TAB key and then
  299.          use the arrow keys to find it. For the moment type in "DEMO".
  300.  
  301.      (4) When ready press ENTER. If the Geni file specified already
  302.          exists you will be asked if you want to overwrite it - either
  303.          answer yes to continue or no if you wish to enter another name.
  304.  
  305.      (5) A progress indicator should appear showing how much of the
  306.          file has been indexed. When the indicator reaches the right
  307.          edge it will be replaced by one showing how far the sorting
  308.          has got. This indicator will start slowly before speeding up.
  309.          Due to the way the index is sorted the indicator will probably
  310.          not reach the right edge before it vanishes.
  311.  
  312.          The final indicator shows how far the conversion process has 
  313.          got based on the number of bytes read from the GEDCOM file.
  314.  
  315.      (6) When the conversion is complete a small dialog box is displayed
  316.          informing the user of the number of individuals and families
  317.          that were found. Press ENTER or ESCAPE and RdGed will finish.
  318.  
  319.      (7) Now locate the Geni icon on the system screen. It should have
  320.          the name of the newly created database below it (DEMO). If not
  321.          press the System button and it should appear. Move the highlight
  322.          onto it and then press ENTER to start Geni.
  323.  
  324.      (8) Everything should be self-explanatory from this point onwards.
  325.          If you can't rememeber a key press then use the HELP key to get
  326.          context-sensitive help. For more detailed information select
  327.          the "Info/Help" menu option.
  328.  
  329.  
  330. Notes:
  331.    The Geni databases should be created using the RdGed program that comes
  332.    with this distribution. This program accepts a GEDCOM file as input
  333.    and will produce a compact database that Geni can read. I have tried
  334.    to make RdGed as resilient as possible and it should be able to
  335.    swallow any type of GEDCOM that is thrown at it. This is achieved by
  336.    the ostrich approach (if a line isn't recognised it will be ignored
  337.    and we hope it won't matter) and by placing very few restrictions on
  338.    the format of the GEDCOM. The single main assumption is that the INDI
  339.    and FAM records all begin at level 0 but this shouldn't create any problems.
  340.  
  341.    RdGed is also careful about memory usage: if there isn't enough memory to
  342.    store the rest of the Geni file being converted the user will be prompted
  343.    to either delete files to free up some memory or to abort. It may be
  344.    sufficient to quit all other applications to free enough memory without
  345.    having to resort to deleting files.
  346.  
  347.    The reason why Geni does not read GEDCOM directly (like Gedfried does
  348.    for example) is because of the speed of parsing and the size of the
  349.    GEDCOM file. At the moment the author is able to translate GEDCOM into
  350.    the OPL database at a rate of 1.3 records (INDI or FAM) per second when
  351.    both files are stored in main memory. When the GEDCOM and OPL databases
  352.    are accessed over the serial link (necessary for very large GEDCOM
  353.    files which might not fit onto a single flash disk) this drops to
  354.    around 0.8 records per second. 
  355.  
  356.    Since my wife has a 700K GEDCOM database containing under 6000 records,
  357.    processing time is over an hour and the GEDCOM won't fit onto her 1M
  358.    Psion! The conversion process usually produces a file about half the
  359.    size of the original GEDCOM which should easily fit on a small Psion
  360.    (my wife's database easily fits onto her 1M Psion with any disks).
  361.  
  362.    Users are expected to use RdGed infrequently so the inconvenience of
  363.    having to create a special database for their Psion should be offset
  364.    by the advantages of being able to take the information into places
  365.    such as record offices and libraries in such a compact format. 
  366.  
  367.  
  368. Bugs:
  369.    No bugs have been found in this version although there must be some
  370.    lurking somewhere. If you do find any bugs or the program crashes
  371.    with a fatal error please let me know! Ideally I need to know the
  372.    exact circumstances under which the bug appears so try and restart
  373.    the program and replicate the bug using the least number of moves.
  374.  
  375.    RdGed also seems to be free from bugs - if you find any please send
  376.    me a fragment of GEDCOM that is causing the problem. The program will
  377.    attempt to tell you which line it stopped at but it is probably best
  378.    to look at the lines immediately before and after it.
  379.  
  380.    If RdGed fails because INDI and FAM records aren't at level 0 (or a
  381.    similar error) please let me know what program you used to create the
  382.    file. I don't know what I can do to help with this but I'll see if
  383.    and when it happens!
  384.  
  385.      ==================================================================
  386.                      README file for Geni Version 1.11
  387.      (c) Martin Dunstan  (mnd@dcs.st-andrews.ac.uk)  November 9th, 1996
  388.      ==================================================================
  389.