Use of GED2WWWF.EXE

CAREFUL !
IF YOU ARE UPGRADING YOUR GED2WWWF VERSION (I.E. IT'S THE FIRST TIME YOU EXECUTE THE 1.5.x),
DELETE THE GED2WWW.DAT FILE, OR UNPREDICTABLE BEHAVIOUR MAY OCCUR.


This Readme as been first created on july 5, 1998.
Last update on june 26, 2000.

Main changes in version 1.4 & 1.5
---------------------------------
Option for classical presentation or tables presentation.
Option for page shifting to the right.
Option for creation or not of Places/Surnames & Surnames/Places lists.
Danish version (thank to Hans Albeck).
Swedish version (thank to Gilles Delorme and Carl Sparrenius)
Options for printing references (REFN), notes (NOTE) and occupation (OCCU).
The sort sequence is now (almost) adapted to the accented letters of Western Europe languages.
(Sort sequence is almost correct).
Option for printing Sosa numbers.

Copyright
---------
This program is freeware; you can distribute it and/or modify it as long
as you respect the terms in the GNU General Public License, published by
the Free Software Foundation.
Anyway, the copyright applies to this program.
Please refer to the COPYING document, published by the Free Software Foundation.

You can get the source files of this program at
Jean-Baptiste Fahy
jbfahy@nordnet.fr

This program was originally written by Leslie Howard.

Executing GED2WWWF.EXE
----------------------
In this version (1.5.4) in a DOS window of Windows 95, 98, NT or 2000.
With Windows NT or 2000, be sure to have the sort.exe program (generally on the
c:\winnt\system32 directory), and to be able to execute it from a DOS session.
It needs the existence of the TEXTE.TXT file in the working directory. This file
countains the texts in the language of your choice.
For french texts, change FRANCAIS.TXT into TEXTE.TXT
For english texts, change ENGLISH.TXT into TEXTE.TXT
For dutch texts, change NEDERLND.TXT into TEXTE.TXT
For german texts, change GERMAN.TXT into TEXTE.TXT
For danish texts, change DANSK.TXT into TEXTE.TXT
For swedish texts, change SVENSK.TXT into TEXTE.TXT

GED2WWWF uses a GEDCOM format file.
It creates (if not already created) a sub-directory named HTML, under the default
directory.
This program asks some question, then generate the HTML pages in the HTML directory.
The execution parameters can be saved (in the ged2www.dat file) in order to be used
for a later run.

The special feature of Ged2wwwf is to produce a list of 'Places and surnames appearing'
and a list of 'Surnames and places where they appear'. The places of these lists can
be sorted at your will. See the note 'Sorting places'.

Ged2wwwf can insert photographies (in JPEG format) for any individual. This is done
automatically, just by testing the existence of a I<n>.JPG file in the HTML sub-
directory, where <n> is the rank of the invidual in the gedcom file (example: if the
I1.JPG file exists, its contents will be shown close the data of the individual @I1@
in the GEDCOM file. Caution: the I<n>.JPG files must be in the same directory than
your html files. Don't forget to transfer them at the same time than your html files.
Remenber than including photographies will strongly increase the loading time of your pages.

GED2WWWF will include, if present, the BOTTOM.TXT file at the end of any generated
page (except the front page). This can help some of you, who have agreements with
their Internet Space Provider, in order to include some ads into your pages.
The TOP.TXT file, if present, will be included in any page, between tag </title> and
tag </head>.

You can control the size of the html pages with the parameter
"number of family groups per output data file". A small value will generate smaller files for
data pages.

You can choose a background image, and to right-shift the information on the generated pages.
For instance, try "reliure.gif" as background, and choose "Pages shifted to the right".

"Liste clair"
--------------
From 1.5.5 version, Ged2wwwf generates again the 'Liste clair' file.
Ged2wwwf generates, in the default directory, the LISTEECL.TXT file, a 'Liste clair'
build according to your GEDCOM file.
In order to complete this file, GED2WWWF needs your locations declarations to like:
<town> (<state>)
For the present, the parenthesis are needed to isolate the town from the state.

Mentioning your name, address, ...
----------------------------------
You must write in HTML format, i.e. "Strae" = "Stra&szlig;e", "Kbenhavn" = "K&oslash;benhavn",
"Malm" = "Malm&ouml;", ...

Mentioning your home page
-------------------------
Don't enter 'http://' before your home page. Just type:
home.nordnet.fr/~jbfahy
if your home page is:
http://home.nordnet.fr/~jbfahy

Sorting places
--------------
The answer to the question 'Enter the sort type of places' permits you to sort the
places at will in the 'Places/Surnames' and 'Surnames/Places' lists, if your places
have all the same structure.
In order to sort by State/Town:
- if your places are coded 'Town,State', enter '2,1'
- if your places are codes 'Town (State), enter '2(1)'
In order to sort by Country/State/Town and to hide the parrishes, if your places are
coded 'Parrish,Town,State,Country', enter '0,3,2,1'.

0 means hide an item.
The showed items can range from 1 to 9.
As delimiters, you can use anything but spaces, letters and digits.

The 1.5 version now produces a gross table for places, composed by the 1 & 2 items
described in  the sort type.

The 1.5 allow you to choose between an external or internal sort. The internal sort takes a
very very very long time (several hours if your gedcom is some thousands individuals).
Choose internal ONLY if you don't get Places/Surnames pages with the external sort.

Note on the TEXTE.TXT file
--------------------------
1- GED2WWWF absolutely needs the TEXTE.TXT to be in the default directory. If not,
you'll get the following messages:
Fatal : Fichier des messages manquant
Fatal : Missing messages file

You may skip the rest of this paragraph if you don't intend to modify the TEXTE.TXT file.

2- You can modify the contents of this file, in order to generate pages in your own
language, or to change some texts. Example: if you want to change the Gender display of
individuals, just modify the 218 and 219 lines.
218#<BR>(Female)
219#<BR>(Male)
If, in addition, you want the gender to be on the same line as the name of the individual,
just suppress the <BR> html commands from the 218 and 219 lines.
3- If, after modifications in TEXTE.TXT, the program doesn't run OK, don't write me
immediately... Backup to the previous file, and modify it, step by step, and check all your
modifications.
4- GED2WWWF generate a copyright text in the main page. This message IS NOT in the TEXTE.TXT
It is in french if the line 200 third character is 'F', in english otherwise.
5- The line 200 is important: its first character stands for YES (Y), the second for NO (N).
You can use the characters you want, for instance SN for italian text (SI and NO).
Remember: THIS LINE MUST BE WRITTEN IN CAPITAL LETTERS.
In addition, don't forget to modify the texts of your questions:
'Do you want to continue (Y/N) ?' should be change into
'Voulez-vous continuer (O/N) ?' if you put ON in the first two characters of line 200.
6- The numbers in the TEXTE.TXT file can appear in any order. Just try to avoid duplication
of numbers. Only the last occurence would be used, but you would waste some memory space.
7- NEVER suppress a line number. The program could crash.
8- Some lines countains codes like '%s', or '%7li'. Leave these code, they permit to display
the contents of some variables.
ABOVE ALL, do NOT add any sign like that, the program could crash, or run strangely.
9- The french version countains accented characters, in DOS, Windows, or HTML format,
accordingly. This can look odd if you list the file.
If you put accented characters in the 201 and more lines, respect the html format:
'&eacute;' for '', etc.
10- Don't worry, it's easy to modify this file. If you create foreign versions, you can send
them to me, I'll include them in the distribution.

How to translate the months
---------------------------
The gedcom files usually have dates like 14 AUG 1948. You can now "translate" them into
14 August 1948 (or 14 aot 1948, as you like).
The ENGLISH.TXT file contains the "translations" for the 12 months JAN FEB ... and ABT (about)
BEF (before) and AFT (after).
These translations are in the Mnn lines of the ENGLISH.TXT file (that you must rename into
TEXTE.TXT).
You can add other translations if necessary. Ex: if you have a date like BET 1885 AND 1887
(between 1885 and 1887), add the following lines:
M16#BET#between
M17#AND#and
You can use the lines from M1 to M40.
The M1 to M12 are not reserved (for the present) for the 12 months, but may be later.

Sosa numbers
------------
Warning: this facility is only available if you choose the tables appearance.
First, you must choose wich individual will have the Sosa number 1. Then, you must found
this individual in your gedcom file. Please note his identifier: it's the information placed
between two @ on the line 0 @xxx@ INDI just before the individual's description.
At last, when executing ged2wwwf, answer Yes when asking about printing Sosa numbers, then
give the identifier of the Sosa 1 as the next answer, with respect of the case of characters.

Printing NOTEs
-------------------
The NOTEs and SOURces are handled in the same way, and are printed at the individual level, or
the marriage level, not at the level of the event where they exist.
Indirect calls of NOTEs or SOURces are not handled (example: 2 NOTE @N1@).

If you print NOTEs (and SOURces), you can choose:
1-print NOTEs by the DATA pages (interesting if all your NOTEs are short).
2-print all your NOTEs in separate html pages.
3-print short NOTEs by the DATA pages, long ones in separate pages.

Choice 1: answer 0 (zero) to the 2 questions about limit sizes.
Choice 2: answer 1 (one) to the 2 questions about limit sizes, then choose the maximum number of
notes in each separate page.
Choice 3: choose the sizes (in lines and characters) which will lead a NOTE in a separate file, then
the maximum number of NOTEs in each separate file. These lines and characters parameters allow you
to control at best the look of your pages. Example: you can choose to put a NOTE in a separate file
if it is at least 5 lines, OR 200 characters.

Remarks
-------
Coding of the GEDCOM can be ANSI, ANSEL or IBMPC (DOS).

Known problems
--------------
DUPLICATE INDIVIDUAL #
The program will stop if your Gedcom contains the same reference # for 2 individuals.

INCONSISTENCY IN FAMILIES
If your Gedcom indicates that Paul is John's son, but doesn't indicate that John is Paul
father's, Ged2wwwf will stop.

With version 1.5, when detecting inconsistency in the gedcom file, ged2wwwf ask you to strike
Return before exiting. This will permit you to see what happens.

Maintenance
-----------
If you have some problem when using this program, or if you want some enhancement, just
write me, at jbfahy@nordnet.fr
If your request are compatible with the time I can give to this program, they will be
honoured quickly.

History of modifications
------------------------
Version 0.22, january 11, 1998
Created from Leslie Howard source files (0.22).
French looking program.
Bug correction: individual without any connection is now displayed.
Generation of Surnames/Places and Places/Surnames lists.

Version 0.1jbf, march 2, 1998
Adding 'Liste clair'.

Version 0.2jbf, march 21, 1998
Adding the number of births and deaths in the Places/Surnames list.
Places are no more displayed for living people.

Version 1.0f&w, july 5, 1998
Automatic creation of the HTML sub-directory.
Internationalization: texts are in the TEXTE.TXT file.
Parameters saving in the GED2WWW.DAT file (thanks to Fran Waarsenburg).
Photography can be included (thanks to Frank Waarsenburg).
Ads file BOTTOM.TXT included in the created pages (Frank Waarsenburg, from an idea
from Jonh Hitcock).
Temporary files are now deleted on program ending.
The capital Y diaeresis are (I hope) now correctly handled (wink to Marie-Claire Bauche).
'Marriage', 'Parents' and 'Children' are now in bold characters (from an idea of
Guy Gasiorowski).
Automatic creation of the HTML sub-directory (this times, it works...) and deletion of
possible *.htm and *.txt files in that directory.
Sort facility on Surnames/Places and Places/Surnames lists.
IBMPC (i.e. DOS) coding accepted, with accented letters.

Version 1.2f&w
Translation for months (from an idea of many of you, and especially Paul-Marc Heudre, who
insisted a lot ;-))
Only the first NAME item of an individual is considered: the next one(s) is (are) ignored
(considered as nicknames).
Links to index pages in each index page (from an idea of Jean-Louis Mejecaze).
The list of surnames is lightened: line feed when break on initial (from an idea of Alain
Bourreau).
Link to the main page at the end of Surnames/Places and Places/Surnames lists.
The y acute should be handled correctly, now.

Version 1.3f&w, november 28, 1998
Marriages in Places/Surnames and Surnames/Places lists
Baptism, burial and occupation in data pages
Place sort is now case insensitive (avoid different lines for a same place coded once with
capital letters, once with small letters)
Direct access to concerned individuals from Surnames/Places and Places/Surnames lists.
Fixed bug on link colors management
Explanation for the  x + symbols in the Places/Surnames and Surnames/Places lists.
The beta letter is now handled
Management of the html pages' sizes.
Fixed bug about surnames with only one character.

Version 1.3.0f&w, decembre 13 1998 (smal malfunction correction)
Baptism: CHR tag is accepted, as well as BAPM (thank you Frank)
Surnames list: the link to the last surname is now correct
NAME tag: the part on the right of the surname (title for some softwares, first names for
other ones) have its accents now correctly handled.

Version 1.4f&w beta, march 3, 1999
Correction of version 1.3 & 1.3.0: all individuals now appears.
New presentation (tables) for data pages.
Ability to shift pages to the right.
Option for creation Places/Surnames & Surnames/Places lists.
Option for reference display (REFN tag).
Parameter for title of the data pages.
Insertion of the content of the "top.txt" file (if present) in front of each page,
giving the ability to insert a theme.
Alphabet in the surnames list to improve legibility.

Version 1.5, january 15, 2000
The name of the gedcom file is now stored in the parameter file ged2www.dat.
Sort sequence for names is now compatible with Western Europe languages. It means that, letters
like e    and  are equivalent to e. But     and  are letters distinct from a, e and o.
Sosa number printing.
NOTEs printing.
Gross table for places.
Inopportune commas removal in place names (commas generated by some genealogy softwares).
Bug about photography fixed.

Version 1.5.1, january 20, 2000
Correction of bug about surnames with non-alphabetic first character.
File extension .ged not mandatory when giving gedcom file name.

Version 1.5.2, january 22, 2000
Correction of bug about NOTEs larger than 1024 characters. They now can be up to 32 kilo-bytes,
and are truncated if longer.
Correction Places sort, now case insensitive.
Html code has been "beautified".

Version 1.5.3 january 31, 2000
Fixed a bug (crash) when you choosed to print Sosa numbers.
Fixed a bug (crash) that could arrive during Processing GEDCOM (pass 1/2 or 2/2).
Enhancement of NOTEs printing, ability to print marriage NOTEs.
Reduced time for Place/Surnames pages.

Version 1.5.4 february 13, 2000
Fixed a bug (crash) if you don't print the dates on index pages.
Confirmation printinf (CONF tag).
Divorce printing (if tag DIV is present in a family description).
Option for external or internal sort (use internal only if Places/surnames pages are not
generated).

Version 1.5.5 june 24, 2000
Liste clair is back.
Fixed a bug about special characters as     in ANSEL coding.
If pages are right shifted, the first separator of each page is now right shifted too.
Fixed hyperlink incoherence toward index or in index.
Error message and stop if more than 30 children in a family, or more than 20 marriages for an
individual.
If multiple parents, first declaration of parents is took into account (instead of last), and
you get a warning message for subsequent parents.
