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