home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 5 / RISCWORLD_VOL5.iso / SOFTWARE / Issue3 / FAMILY / GedcomWeb / !GedcomWeb / Resources / Help < prev    next >
Encoding:
Text File  |  2003-03-24  |  24.2 KB  |  578 lines
  1. GedcomWeb 3.01
  2. ----------------------------------------------------------------------------
  3. Introduction
  4.   GedcomWeb enables you to convert GEDCOM files into JavaScript family tree
  5.   Web pages.  Even if you don't want to display your family tree on the
  6.   Web, the output is still very useful for sending to relations who may not
  7.   have genealogy software, as it will work with any modern web browser on
  8.   any type of computer.
  9.   
  10.   The latest version should be available from
  11.   http://www.sinenomine.freeserve.co.uk/software/
  12.  
  13.   Any bug reports or suggestions for improvements should be sent to
  14.   support@sinenomine.freeserve.co.uk
  15.  
  16.   •  Registering GedcomWeb
  17.   •  Licence
  18.   •  Language support  
  19.   •  Credits  
  20.   •  Disclaimer
  21.  
  22. Using GedcomWeb
  23.   •  Creating a tree from a GEDCOM file
  24.   •  The choices window
  25.   •  Navigating the tree
  26.   •  Printing a tree
  27.   •  Frequently Asked Questions
  28.  
  29. Technical stuff
  30.   •  Yes, it does work with...
  31.   •  Limitations
  32.   •  GEDCOM fields currently supported
  33.   •  Version history
  34.  
  35.   There is also a StrongHelp version of this manual available: if a copy of
  36.   StrongHelp has been seen then that will be loaded instead of this when you
  37.   click on Help.
  38.   
  39. ============================================================================
  40.  
  41. Registering GedcomWeb
  42. --------------------------------------------------------------------------
  43.   Until you register your copy of GedcomWeb you will be unable to save or
  44.   load choices, or to process GEDCOM files containing more than 50 people.
  45.  
  46.   Online registration is available via Softshop for £6 at
  47.   http://gbp.swreg.org/cgi-bin/b.cgi?s=50264&p=50264G1&v=0&d=0&q=1
  48.   You will be sent licence details by email.
  49.  
  50.   Alternatively, you can send a cheque for £5, with a note of your email
  51.   address, to the address below.
  52.  
  53.   To receive a full copy of the software by post (UK orders only), please
  54.   send one of
  55.   •  £5.50 cheque and a 3.5" floppy disk
  56.   •  £6 cheque (we will supply a 1.44Mb disc)
  57.   to Hilary Phillips, 15 Lynn Close, Marston, Oxford, OX3 0JH.
  58.  
  59. Licence
  60. --------------------------------------------------------------------------
  61.   GedcomWeb is Shareware.
  62.  
  63.   The registered version is for the sole use of the registered user.
  64.  
  65.   The unregistered version may be distributed by any means to anyone,
  66.   providing that all files remain unaltered.
  67.  
  68. Language support
  69. --------------------------------------------------------------------------
  70.   In the Choices window you can select the language to be used in the web
  71.   pages.  English and French are supplied with this distribution.  Other
  72.   languages can be added by putting the translated WebMsgs file into an
  73.   appropriately named directory inside !GedcomWeb.Resources.
  74.   
  75.   Should you wish to use the GedcomWeb program itself in another
  76.   language, GedcomWeb supports ResFind for language configuration, but
  77.   only UK resource files are available at present.  Native speakers of
  78.   other languages who send me translations of the WebMsgs or resource
  79.   files will receive the full version free of charge!
  80.  
  81. ==========================================================================
  82.  
  83. Thanks to...
  84. --------------------------------------------------------------------------
  85.   Matthew for being generally helpful, for writing the machine code
  86.   routines for the original BASIC version, helping me to learn C, and for
  87.   buying me a book on JavaScript to save me having to do all the
  88.   JavaScript programming at work.
  89.   
  90.   Artur Albuquerque for testing the JavaScript output of version 1.0 on
  91.   Fresco.
  92.   
  93.   Duncan Breckels who wanted to be able to export all fields supported by
  94.   the latest version of !Family, which I think 3.00 will do.
  95.  
  96.   Kate Crennell for finding an example where my surname extraction
  97.   routine didn't work correctly (fixed in 2.01), and for a couple of
  98.   other suggestions which are implemented in 3.00.
  99.  
  100.   Clive Holland whose Gedcom file showed up a bug fixed in version 1.10c.
  101.   
  102.   Bernard Maugoust for alerting me to the need for conversion of accented
  103.   characters, and for the French WebMsgs file.
  104.  
  105.   Andrew Sparks whose Gedcom file had some interesting features which are
  106.   catered for by version 1.10ß.
  107.   
  108.   Richard Torrens for finding that my improved surname extraction routine
  109.   was not as good as I thought (fixed in 2.03) and for some other
  110.   suggestions for improvements, most of which I have tried to implement
  111.   in 3.00.
  112.  
  113.   Tony Tuck for discovering a bug in saving of choices with RISC OS
  114.   Select (fixed in 3.00).
  115.  
  116.  
  117. I hope you find it useful!
  118.  
  119. ==========================================================================
  120.  
  121. Disclaimer
  122. --------------------------------------------------------------------------
  123.   If you put personal information about living people on the WWW without
  124.   their permission you may fall foul of the Data Protection Act (or
  125.   similar legislation in your own country).
  126.  
  127.   I cannot accept responsibility for any use of this program which
  128.   infringes such legislation.  Sorry and all that.
  129.  
  130.   You may be able to cut out personal information about living people
  131.   using my freeware utility Prune.
  132.  
  133. ==========================================================================
  134.  
  135. Creating a tree from a GEDCOM file
  136. --------------------------------------------------------------------------
  137. Loading in the GEDCOM file
  138.   Most family tree software should be able to save GEDCOM files (e.g.
  139.   !Ancestor+), or may even use GEDCOM as their standard file format (e.g.
  140.   !Family, !Roots).
  141.  
  142.   Double-click on !GedcomWeb, and drag your GEDCOM file to the icon on
  143.   the icon bar.  A save window will be opened.
  144.  
  145. Setting choices
  146.   Click on Choices... to set your preferences for styles, colours,
  147.   titles, language and filenames to be used and which GEDCOM fields to
  148.   export.  In the Choices window, click on /Preview/ to see how the
  149.   settings you have chosen will look.
  150.  
  151.   For help on choices while running GedcomWeb, turn on interactive help
  152.   (run !Help or !BubbleHlp) and position your mouse pointer over the item
  153.   in the choices window which you want help on.
  154.  
  155. Saving the tree
  156.   Drag the directory icon from the GedcomWeb window to a filer window and
  157.   the files you need will be created.
  158.  
  159.   Inside the directory you will get
  160.   •  Two HTML files: the tree displaying program and an index of names.
  161.   The tree is most easily used via the index.  
  162.   •  One directory of images, which are the lines joining up people on
  163.   the tree.
  164.  
  165.   If you want to save to an existing directory or Zip file, one way to do
  166.   this is to drag the directory/Zip file from the Filer to the Save
  167.   window and click on "Save".  You can only save to a Zip file if
  168.   !SparkFS or equivalent archiving software is loaded at the time.
  169.  
  170. ==========================================================================
  171.  
  172. The choices window
  173. ------------------------------------------------------------------------
  174. The choices window comes in five parts:
  175. General
  176.   •  Choose the colours to be used for the background, the lines
  177.   joining people on the tree, and any header/footer text.
  178.   •  Set the font to be used for the text.
  179.   •  Choose the format in which dates will be displayed.
  180.   •  Choose the language to be used in the web pages.
  181.   •  Choose the titles to appear at the top of the web pages.
  182. Names
  183.   •  Choose the colours and text style in which names are printed.
  184.   •  Choose whether males and females are coloured differently on the
  185.   family tree.
  186.   •  Choose whether to annotate the index of names by showing people's
  187.   close relations.
  188.   •  Choose whether to include or omit identifiers after people's
  189.   surnames (e.g. John Smith [2], Oscar Hammerstein III, John
  190.   Dolittle M.D.)
  191. Fields
  192.   •  Choose whether to include birth, christening, baptism, death,
  193.   cremation, burial, occupation and notes data.
  194.   •  For each event, choose whether to include date, place,
  195.   site/address and cause.
  196.   •  For each event, choose text colour and text style.
  197. Page settings
  198.   •  Choose the filenames for the index of names and the family tree
  199.   diagram web pages.
  200.   •  Choose the name for the directory of images (which will be inside
  201.   the directory you save).  If you don't want them in their own
  202.   subdirectory, leave this blank.  To put the images in a separate
  203.   directory altogether, precede the name by ^.
  204.   •  Choose whether existing files can be overwritten without warning.
  205.   •  Create your own HTML header and footer for the pages.
  206.   Drag-and-drop files containing the data or type it in the boxes,
  207.   using the arrows to scroll.  Here you can put in links to other
  208.   web pages or images to include at the top of the page, so that
  209.   you can make them look as much as possible like your other web
  210.   pages.  The header and footer are limited to about 1000
  211.   characters.
  212.   •  Choose whether the header and/or footer appear at the top of the
  213.   index page, the family tree diagram page or both.
  214. Web defaults
  215.   •  The family tree web pages will include various options so that
  216.   users can customise the display.  Here you choose what the
  217.   default settings will be.  Options which are greyed out will not
  218.   appear on the web pages.  
  219.  
  220. Colours
  221. ------------------------------------------------------------------------
  222.   Colours can be chosen by clicking on the colour box or the menu beside
  223.   it and choosing from the Colour Picker window, or by typing the
  224.   appropriate RRGGBB hex code into the box.
  225.  
  226. Text style
  227. ------------------------------------------------------------------------
  228.   Text can be normal, bold, italic or bold italic.
  229.  
  230. Date format
  231. ------------------------------------------------------------------------
  232.   You can choose the date format from a menu or create your own by typing
  233.   in the box provided.  Today's date will be displayed nearby in your
  234.   chosen format, to help you.
  235.  
  236.   The date formatting string uses those of the standard RISC OS date
  237.   formatting expressions listed below.
  238.  
  239.   If the date in your GEDCOM file is 14 JUL 1792 (and you are using the
  240.   English language), then entering the following into the date format
  241.   string would produce
  242.   %dy Day number                          14
  243.   %mn Month number                        07
  244.   %zdy  Day number without leading zero   14
  245.   %zmn  Month number without leading zero  7
  246.   %mo Month name                        July
  247.   %m3 Short month name                   Jul
  248.   %ce Century                             17
  249.   %yr Year                                92
  250.   %%  Percentage sign                      %
  251.  
  252.   The date formats on the menu are:
  253.   %ce%yr                    1792
  254.   %dy-%m3-%ce%yr     14-Jul-1792
  255.   %zdy/%zmn/%ce%yr     14/7/1792
  256.   %ce%yr.%mn.%dy      1792.07.14
  257.  
  258. ========================================================================
  259.  
  260. Navigating the tree
  261. --------------------------------------------------------------------------
  262. Web browsers supported
  263.   You need a web browser with JavaScript support to display the family
  264.   tree.  The only RISC OS browsers currently available with sufficient
  265.   JavaScript are Oregano and Fresco, though Fresco fails to draw the
  266.   lines properly.  Most modern web browsers on other platforms also work.
  267.   The index file should be able to be viewed in any browser, but this is
  268.   not so interesting to look at.
  269.  
  270. To view the tree, either
  271.   •  load the HTML index file into your web browser, and click on a
  272.   person to centre the tree on,
  273.   or
  274.   •  load the HTML tree file into your web browser, which will show the
  275.   tree centred on the first person listed in the GEDCOM file.
  276.  
  277.   The selected person is displayed with their ancestors on their left and
  278.   descendants on their right.  People in the same generation will be in
  279.   the same column as each other.  Lines are drawn between the people to
  280.   indicate relationships.
  281.  
  282.   To redraw the tree centred on a different person, click on their name,
  283.   or go back to the index of names by clicking on the link at the top of
  284.   the screen.
  285.  
  286. Altering the display options
  287.   Above the tree are several display options which can be altered by the
  288.   user:
  289.  
  290.   •  turn on and off display of certain fields
  291.   •  show full details of events, or just dates
  292.   •  choose to display the central person's siblings and their
  293.   descendants too
  294.   •  display different sexes in different colours
  295.   •  choose to display between 0 and 10 generations of ancestors or
  296.   descendants
  297.   •  choose from three vertical spacing options (note that compact
  298.   options make the program take longer to work out the display)
  299.   •  display for printing, i.e. just display the tree without all the
  300.   instructions at the top of the screen, either in colours or black
  301.   on white.
  302.  
  303.   Some of these options may not be available, e.g. if a field has not
  304.   been exported in the file then there will be no option to display it.
  305.  
  306.   To activate your changed options, click on the name of the person you
  307.   wish to centre the tree on (this may be the current person), or click
  308.   on "Redraw this tree".
  309.  
  310. ==========================================================================
  311.  
  312. Printing a tree
  313. --------------------------------------------------------------------------
  314.   Display the tree you want in your web browser.  Select "Display for
  315.   printing" and the desired colouring option, then redraw the tree either
  316.   by clicking on the central person or by clicking on "Redraw this tree".
  317.   You should get a redrawn tree without the mess of options at the top of
  318.   it.
  319.  
  320.   To get the lines to print properly you may need to turn on printing of
  321.   background images in your browser.
  322.  
  323. Fresco users please note
  324.   Fresco 2.13 doesn't display the lines properly - just little bits and
  325.   corners here and there - so you will need to join up the dots after
  326.   printing out!  It should be fairly clear where to draw the lines,
  327.   though.
  328.  
  329. Oregano users please note
  330.   Note that with Oregano v1.10 there are various problems with printing.
  331.   To avoid these you must
  332.   •  be in a screen mode with more than 256 colours
  333.   •  not choose to print sideways
  334.   
  335.   Oregano v1.10 does not print GIF images properly.  This affects the
  336.   lines joining the people in the tree.  The easiest way to get round
  337.   this problem is to have the lines drawn as black-on-white JPEGs, which
  338.   will print fine.  You can do this by choosing black lines on a white
  339.   background in the GedcomWeb choices window.  Or when viewing the family
  340.   tree in Oregano, tick "Display for printing" and choose one of
  341.   •  in black on white
  342.   •  in colour on white
  343.   (if you have a coloured background by default)
  344.   •  in Oregano-friendly colour
  345.   (if you have a white background but coloured lines - this option
  346.   will only be displayed if you are using Oregano v1.10)
  347.   All these options will use black-on-white JPEGs for the lines.
  348.   
  349.   If you don't choose black lines and a white background, then the
  350.   default display and the "in colour" option will use GIFs for the lines.
  351.   To print these successfully from Oregano v1.10, move the Oregano window
  352.   so that all the images are off screen, press F12, press Return, then
  353.   print as normal from Oregano.  When you bring the window back on screen
  354.   the images will look rather peculiar, but they should come out right on
  355.   the printed page.
  356.   
  357. ==========================================================================
  358.  
  359. GedcomWeb FAQ
  360. We're often asked... sometimes asked... somebody asked me once...
  361. --------------------------------------------------------------------------
  362. I have several different family trees. How can they use the same set of
  363. graphics for the lines?
  364.   You can achieve this in two different ways:
  365.   1.  Save the images directory at the same level as the directory
  366.   containing the HTML files, by setting the directory name to be
  367.   ^.ftlines (if you wish to call it ftlines)
  368.   2.  For the different trees, save under the same directory name but
  369.   change the filenames of the HTML files, e.g. index1/htm and
  370.   index2/htm, tree1/htm and tree2/htm
  371.  
  372. I want to email the tree to one of my relations, but I can't attach a
  373. directory.
  374.   The best way to get round this is to put the tree into a Zip file,
  375.   using !SparkFS or similar software.  If you create a blank Zip file you
  376.   can drop this on to the GedcomWeb save window and click on /Save/ to
  377.   save the files into it.  Note that this will only work if SparkFS (or
  378.   equivalent) is loaded at the time.
  379.  
  380.   If you don't have any archiving software you will have to attach all
  381.   the files separately.  To save your recipient from having to recreate
  382.   the subdirectory for the images, you can blank out the images directory
  383.   name in the Choices window and all the files will be stored at the same
  384.   level.
  385.  
  386. ==========================================================================
  387.  
  388. Yes, it does work with...
  389. --------------------------------------------------------------------------
  390. GedcomWeb has been tested with GEDCOM files exported from:
  391.   !Family, !Roots, !Ancestor+, CPC Family Tree,
  392.   and a very large GEDCOM file which we found on the Web page of one of
  393.   Matthew's fourth cousins in Australia.
  394.  
  395. Web browsers tested successfully:
  396.   Oregano (with up to about 1000 people in the input file),
  397.   Fresco 2.13 (subject to limitations detailed below),
  398.   Netscape 4.7+ (PC: with 3000+ people in the input file),
  399.   Internet Explorer 5 (Mac and PC)
  400.   Internet Explorer 4 (PC: only works for files on the Web)
  401.   Konquerer 2.1.1 (Linux: running under KDE 2.1.2)
  402.  
  403. Does not work with:
  404.   WebsterXL 1.98n-1.99r
  405.   Oregano may crash or take a very long time before it displays anything
  406.   if it is trying to draw a particularly enormous part of your tree.
  407.   Fresco doesn't support style sheets or background images in tables.
  408.   This means that the text won't display in the colour or style you have
  409.   chosen, and the lines won't display properly.  But if you print the
  410.   tree out, you can join the dots!
  411.   Internet Explorer 4 (PC: does not work for files on your own machine),
  412.   Internet Explorer 3
  413.  
  414. ==========================================================================
  415.  
  416. Limitations
  417. --------------------------------------------------------------------------
  418.   You cannot display more than 10 generations above and 10 generations
  419.   below the chosen person.  However, this does add up to 21 generations
  420.   across!
  421.   
  422.   Not all GEDCOM fields are converted - see list for details.
  423.  
  424. ==========================================================================
  425.  
  426. GEDCOM fields currently supported
  427. --------------------------------------------------------------------------
  428.   The following fields are used by GedcomWeb.  Any others will be ignored.
  429.  
  430.   Individual records:
  431.   0 INDI
  432.   1 NAME
  433.   1 SEX
  434.   1 BIRT (+details)
  435.   1 CHR (+details)
  436.   1 BAPT (+details)
  437.   1 DEAT (+details)
  438.   1 CREM (+details)
  439.   1 BURI (+details)
  440.   1 FAMC
  441.   1 FAMS
  442.   1 OCCU (+details)
  443.   1 NOTE
  444.  
  445.   Family records:
  446.   0 FAM
  447.   1 HUSB
  448.   1 WIFE
  449.   1 CHIL
  450.   1 MARR (+details)
  451.  
  452.   Fields giving details of events (BIRT, CHR, BAPT, DEAT, CREM, BURI,
  453.   OCCU, MARR):
  454.   Date: DATE
  455.   Place: PLAC
  456.   Address/Site: SITE, ADDR, ADR1, ADR2, CITY, STAE, POST, CTRY, CEME,
  457.   PLOT
  458.   Cause: CAUS
  459.  
  460.   Continuation fields:
  461.   CONT
  462.   CONC
  463.  
  464.  
  465.   DATE fields can include ABT, EST, CAL, BEF, AFT or BET modifiers
  466.   ("about", "estimated", "calculated", "before", "after" or "between")
  467.  
  468. ==========================================================================
  469.  
  470. Version history
  471. --------------------------------------------------------------------------
  472. 1.00 (16-Apr-2001)
  473.   •  First public release
  474. 1.01 (11-Jun-2001)
  475.   •  Now converts accented characters to their HTML equivalents
  476.   •  Resources files reorganized to cope with incomplete language
  477.   resources
  478.   •  Also a couple of minor bug-fixes
  479. 1.02 (14-Jul-2001)
  480.   •  Fixed a syntax error in the BASIC and a colouring error in the HTML
  481. 1.10ß (2-Aug-2001)
  482.   •  Separate choices window created
  483.   •  Colours can be chosen by typing the RGB hex codes as well as by
  484.   using the colour picker
  485.   •  You can now choose the colour of pretty much everything
  486.   •  Males and females can be coloured differently
  487.   •  You can choose the language used in the web pages (subject to the
  488.   existence of a suitable WebMsgs file for that language)
  489.   •  Preview button added
  490.   •  Saving of choices possible
  491.   •  Now supports files with families which have the spouses the wrong
  492.   way round, i.e. male wife and female husband
  493.   •  Bug-fix: also copes with names containing asterisks
  494. 1.10c (22-Aug-2001)
  495.   •  Fixed a bug to do with lines containing @ symbols
  496.   •  Choosing background and line colours disabled pending testing with
  497.   Oregano 2 which we hope will be able to print GIFs
  498. 1.10d (23-Aug-2001)
  499.   •  Excessive blank lines at the end of notes are now ignored
  500. 2.00 (3-Nov-2001)
  501.   •  Rewritten in C
  502.   •  Processing is much faster
  503.   •  Improved JavaScript in places
  504.   •  Incorporates family tree data in HTML file rather than separate file
  505.   •  You can now choose whether to include notes in the exported data
  506.   •  Alerts the user to inconsistencies in the GEDCOM file
  507.   •  Choosing of all background and line colours is re-enabled, with
  508.   instructions for printing from Oregano included in help file  
  509. 2.01 (27-Nov-2001)
  510.   •  Now allows the choice of no image directory name, whereby the
  511.   images are stored in the same directory level as the HTML files
  512.   •  Fixed bugs in the image saving error-trapping and in the surname
  513.   extraction routine
  514. 2.02 (3-Dec-2001)
  515.   •  Includes option to warn the user if existing files will be
  516.   overwritten
  517.   •  Improved support for !Family-style identifiers and dates  
  518. 2.03 (9-Jan-2002)
  519.   •  Surname extraction routine improved (again)
  520.   •  Allows image directory to be at the same level as the directory
  521.   containing the HTML pages (try ^.ftlines) for people with multiple
  522.   trees but little disc space
  523.   •  /Redraw this tree/ link added to top of web page for the benefit of
  524.   those who haven't understood that you can do that by clicking on
  525.   the central person's name
  526.   •  Javascript data structure improved: files are now shorter and may
  527.   be slightly faster with Oregano, and the 19 children per family
  528.   limit has been removed
  529.   •  Option added in Choices window to omit identifiers and
  530.   qualifications from the ends of people's names, e.g. John Smith
  531.   [2], Oscar Hammerstein III, John Dolittle M.D.
  532.   •  Disabled /Preview/ button in Choices window if running on version
  533.   of RISC OS without Wimp_TextOp SWI (below 3.5)
  534.   •  StrongHelp manual created
  535. 2.04 (18-Jan-2002)
  536.   •  Fixed bug introduced in 2.03 which only surfaced if you unticked
  537.   "Show children's surnames"
  538.   •  Now allows <a href=...>...</a> tags (case-insensitive) in GEDCOM
  539.   fields to come through as links in the output files, so that you
  540.   can add links to other pages in an individual's NOTE field
  541.   •  Improved name parsing routine yet again
  542.   •  Fixed long-standing but rarely-occuring bug in index sorting routine
  543. 3.00 (4-Nov-2002)
  544.   •  Redesigned choices so that you can customise everything I can think
  545.   of - unfortunately this means five different choices windows are
  546.   required...
  547.   •  You can now choose text styles (fonts, italic, bold etc.)
  548.   •  Lots more GEDCOM fields supported: christening, baptism, cremation,
  549.   burial, occupation, place details (site, address etc.) and cause of
  550.   event.  You can, however, choose which fields you want exported.
  551.   •  You can now put in your own HTML headers and footers for the web
  552.   pages, so that you can put your own logo or link to your homepage
  553.   at the top of the tree
  554.   •  Fixed Choices saving bug which I think only affected Select users
  555.   •  Added option to display central person's siblings in tree
  556.   •  Made descendant display more compact in tree
  557.   •  Altered user display options at top of web pages - they can no
  558.   longer set the date format or choose to turn off display of
  559.   children's surnames, but they can specify which fields and how much
  560.   detail they want displayed.
  561.   •  These options are now also displayed at the top of the index page
  562. 3.01 (21-Mar-2003)
  563.   •  Fixed bug in compact displays
  564.  
  565.  
  566.   ==========================================================================
  567.   +----------------------------------------------------------------------+
  568.   |                                                                      |
  569.   | This text file was converted from a StrongHelp manual on 5 Nov 2002  |
  570.   |                                                                      |
  571.   |  using !StHlp2Txt version 1.10 (8 June 2001)                         |
  572.   |  by Chris Morison                                                    |
  573.   |                                                                      |
  574.   |  email: organizer@morison.net                                        |
  575.   |  web: http://www.organizer.morison.net/                              |
  576.   |                                                                      |
  577.   +----------------------------------------------------------------------+
  578.