home *** CD-ROM | disk | FTP | other *** search
/ Freelog 10 / Freelog010.iso / BAS / Genealog / Ged2wwwf / readme.txt < prev    next >
Text File  |  2000-02-14  |  16KB  |  330 lines
  1. Use of GED2WWWF.EXE
  2.  
  3. CAREFUL !
  4. IF YOU ARE UPGRADING YOUR GED2WWWF VERSION (I.E. IT'S THE FIRST TIME YOU EXECUTE THE 1.5.x),
  5. DELETE THE GED2WWW.DAT FILE, OR UNPREDICTABLE BEHAVIOUR MAY OCCUR.
  6.  
  7.  
  8. This Readme as been first created on july 5, 1998.
  9. Last update on february 14, 2000.
  10.  
  11. Main changes in version 1.4 & 1.5
  12. ---------------------------------
  13. Option for classical presentation or tables presentation.
  14. Option for page shifting to the right.
  15. Option for creation or not of Places/Surnames & Surnames/Places lists.
  16. Danish version (thank to Hans Albeck).
  17. Swedish version (thank to Gilles Delorme and Carl Sparrenius)
  18. Options for printing references (REFN), notes (NOTE) and occupation (OCCU).
  19. The sort sequence is now (almost) adapted to the accented letters of Western Europe languages.
  20. (Sort sequence is almost correct).
  21. Option for printing Sosa numbers.
  22.  
  23. Copyright
  24. ---------
  25. This program is freeware; you can distribute it and/or modify it as long
  26. as you respect the terms in the GNU General Public License, published by
  27. the Free Software Foundation.
  28. Anyway, the copyright applies to this program.
  29. Please refer to the COPYING document, published by the Free Software Foundation.
  30.  
  31. You can get the source files of this program at
  32. Jean-Baptiste Fahy
  33. jbfahy@nordnet.fr
  34.  
  35. This program was originally written by Leslie Howard.
  36.  
  37. Executing GED2WWWF.EXE
  38. ----------------------
  39. In this version (1.5.4) in a DOS window of Windows 95, 98, NT or 2000.
  40. With Windows NT or 2000, be sure to have the sort.exe program (generally on the
  41. c:\winnt\system32 directory), and to be able to execute it from a DOS session.
  42. It needs the existence of the TEXTE.TXT file in the working directory. This file
  43. countains the texts in the language of your choice.
  44. For french texts, change FRANCAIS.TXT into TEXTE.TXT
  45. For english texts, change ENGLISH.TXT into TEXTE.TXT
  46. For dutch texts, change NEDERLND.TXT into TEXTE.TXT
  47. For german texts, change GERMAN.TXT into TEXTE.TXT
  48. For danish texts, change DANSK.TXT into TEXTE.TXT
  49. For swedish texts, change SVENSK.TXT into TEXTE.TXT
  50.  
  51. GED2WWWF uses a GEDCOM format file.
  52. It creates (if not already created) a sub-directory named HTML, under the default
  53. directory.
  54. This program asks some question, then generate the HTML pages in the HTML directory.
  55. The execution parameters can be saved (in the ged2www.dat file) in order to be used
  56. for a later run.
  57.  
  58. The special feature of Ged2wwwf is to produce a list of 'Places and surnames appearing'
  59. and a list of 'Surnames and places where they appear'. The places of these lists can
  60. be sorted at your will. See the note 'Sorting places'.
  61.  
  62. Ged2wwwf can insert photographies (in JPEG format) for any individual. This is done
  63. automatically, just by testing the existence of a I<n>.JPG file in the HTML sub-
  64. directory, where <n> is the rank of the invidual in the gedcom file (example: if the
  65. I1.JPG file exists, its contents will be shown close the data of the individual @I1@
  66. in the GEDCOM file. Caution: the I<n>.JPG files must be in the same directory than
  67. your html files. Don't forget to transfer them at the same time than your html files.
  68. Remenber than including photographies will strongly increase the loading time of your pages.
  69.  
  70. GED2WWWF will include, if present, the BOTTOM.TXT file at the end of any generated
  71. page (except the front page). This can help some of you, who have agreements with
  72. their Internet Space Provider, in order to include some ads into your pages.
  73. The TOP.TXT file, if present, will be included in any page, between tag </title> and
  74. tag </head>.
  75.  
  76. You can control the size of the html pages with the parameter
  77. "number of family groups per output data file". A small value will generate smaller files for
  78. data pages.
  79.  
  80. You can choose a background image, and to right-shift the information on the generated pages.
  81. For instance, try "reliure.gif" as background, and choose "Pages shifted to the right".
  82.  
  83. "Liste Θclair"
  84. --------------
  85. From 1.5 version, Ged2wwwf doesn't generate the 'Liste Θclair' file.
  86.  
  87.  
  88. Mentioning your name, address, ...
  89. ----------------------------------
  90. You must write in HTML format, i.e. "Stra▀e" = "Straße", "K°benhavn" = "København",
  91. "Malm÷" = "Malmö", ...
  92.  
  93. Mentioning your home page
  94. -------------------------
  95. Don't enter 'http://' before your home page. Just type:
  96. home.nordnet.fr/~jbfahy
  97. if your home page is:
  98. http://home.nordnet.fr/~jbfahy
  99.  
  100. Sorting places
  101. --------------
  102. The answer to the question 'Enter the sort type of places' permits you to sort the
  103. places at will in the 'Places/Surnames' and 'Surnames/Places' lists, if your places
  104. have all the same structure.
  105. In order to sort by State/Town:
  106. - if your places are coded 'Town,State', enter '2,1'
  107. - if your places are codes 'Town (State), enter '2(1)'
  108. In order to sort by Country/State/Town and to hide the parrishes, if your places are
  109. coded 'Parrish,Town,State,Country', enter '0,3,2,1'.
  110.  
  111. 0 means hide an item.
  112. The showed items can range from 1 to 9.
  113. As delimiters, you can use anything but spaces, letters and digits.
  114.  
  115. The 1.5 version now produces a gross table for places, composed by the 1 & 2 items
  116. described in  the sort type.
  117.  
  118. The 1.5 allow you to choose between an external or internal sort. The internal sort takes a
  119. very very very long time (several hours if your gedcom is some thousands individuals).
  120. Choose internal ONLY if you don't get Places/Surnames pages with the external sort.
  121.  
  122. Note on the TEXTE.TXT file
  123. --------------------------
  124. 1- GED2WWWF absolutely needs the TEXTE.TXT to be in the default directory. If not,
  125. you'll get the following messages:
  126. Fatal : Fichier des messages manquant
  127. Fatal : Missing messages file
  128.  
  129. You may skip the rest of this paragraph if you don't intend to modify the TEXTE.TXT file.
  130.  
  131. 2- You can modify the contents of this file, in order to generate pages in your own
  132. language, or to change some texts. Example: if you want to change the Gender display of
  133. individuals, just modify the 218 and 219 lines.
  134. 218#<BR>(Female)
  135. 219#<BR>(Male)
  136. If, in addition, you want the gender to be on the same line as the name of the individual,
  137. just suppress the <BR> html commands from the 218 and 219 lines.
  138. 3- If, after modifications in TEXTE.TXT, the program doesn't run OK, don't write me
  139. immediately... Backup to the previous file, and modify it, step by step, and check all your
  140. modifications.
  141. 4- GED2WWWF generate a copyright text in the main page. This message IS NOT in the TEXTE.TXT
  142. It is in french if the line 200 third character is 'F', in english otherwise.
  143. 5- The line 200 is important: its first character stands for YES (Y), the second for NO (N).
  144. You can use the characters you want, for instance SN for italian text (SI and NO).
  145. Remember: THIS LINE MUST BE WRITTEN IN CAPITAL LETTERS.
  146. In addition, don't forget to modify the texts of your questions:
  147. 'Do you want to continue (Y/N) ?' should be change into
  148. 'Voulez-vous continuer (O/N) ?' if you put ON in the first two characters of line 200.
  149. 6- The numbers in the TEXTE.TXT file can appear in any order. Just try to avoid duplication
  150. of numbers. Only the last occurence would be used, but you would waste some memory space.
  151. 7- NEVER suppress a line number. The program could crash.
  152. 8- Some lines countains codes like '%s', or '%7li'. Leave these code, they permit to display
  153. the contents of some variables.
  154. ABOVE ALL, do NOT add any sign like that, the program could crash, or run strangely.
  155. 9- The french version countains accented characters, in DOS, Windows, or HTML format,
  156. accordingly. This can look odd if you list the file.
  157. If you put accented characters in the 201 and more lines, respect the html format:
  158. 'é' for 'Θ', etc.
  159. 10- Don't worry, it's easy to modify this file. If you create foreign versions, you can send
  160. them to me, I'll include them in the distribution.
  161.  
  162. How to translate the months
  163. ---------------------------
  164. The gedcom files usually have dates like 14 AUG 1948. You can now "translate" them into
  165. 14 August 1948 (or 14 ao√t 1948, as you like).
  166. The ENGLISH.TXT file contains the "translations" for the 12 months JAN FEB ... and ABT (about)
  167. BEF (before) and AFT (after).
  168. These translations are in the Mnn lines of the ENGLISH.TXT file (that you must rename into
  169. TEXTE.TXT).
  170. You can add other translations if necessary. Ex: if you have a date like BET 1885 AND 1887
  171. (between 1885 and 1887), add the following lines:
  172. M16#BET#between
  173. M17#AND#and
  174. You can use the lines from M1 to M40.
  175. The M1 to M12 are not reserved (for the present) for the 12 months, but may be later.
  176.  
  177. Sosa numbers
  178. ------------
  179. Warning: this facility is only available if you choose the tables appearance.
  180. First, you must choose wich individual will have the Sosa number 1. Then, you must found
  181. this individual in your gedcom file. Please note his identifier: it's the information placed
  182. between two @ on the line 0 @xxx@ INDI just before the individual's description.
  183. At last, when executing ged2wwwf, answer Yes when asking about printing Sosa numbers, then
  184. give the identifier of the Sosa 1 as the next answer, with respect of the case of characters.
  185.  
  186. Printing NOTEs
  187. -------------------
  188. The NOTEs and SOURces are handled in the same way, and are printed at the individual level, or
  189. the marriage level, not at the level of the event where they exist.
  190. Indirect calls of NOTEs or SOURces are not handled (example: 2 NOTE @N1@).
  191.  
  192. If you print NOTEs (and SOURces), you can choose:
  193. 1-print NOTEs by the DATA pages (interesting if all your NOTEs are short).
  194. 2-print all your NOTEs in separate html pages.
  195. 3-print short NOTEs by the DATA pages, long ones in separate pages.
  196.  
  197. Choice 1: answer 0 (zero) to the 2 questions about limit sizes.
  198. Choice 2: answer 1 (one) to the 2 questions about limit sizes, then choose the maximum number of
  199. notes in each separate page.
  200. Choice 3: choose the sizes (in lines and characters) which will lead a NOTE in a separate file, then
  201. the maximum number of NOTEs in each separate file. These lines and characters parameters allow you
  202. to control at best the look of your pages. Example: you can choose to put a NOTE in a separate file
  203. if it is at least 5 lines, OR 200 characters.
  204.  
  205. Remarks
  206. -------
  207. Coding of the GEDCOM can be ANSI, ANSEL or IBMPC (DOS).
  208.  
  209. Known problems
  210. --------------
  211. DUPLICATE INDIVIDUAL #
  212. The program will stop if your Gedcom contains the same reference # for 2 individuals.
  213.  
  214. INCONSISTENCY IN FAMILIES
  215. If your Gedcom indicates that Paul is John's son, but doesn't indicate that John is Paul
  216. father's, Ged2wwwf will stop.
  217.  
  218. With version 1.5, when detecting inconsistency in the gedcom file, ged2wwwf ask you to strike
  219. Return before exiting. This will permit you to see what happens.
  220.  
  221. Maintenance
  222. -----------
  223. If you have some problem when using this program, or if you want some enhancement, just
  224. write me, at jbfahy@nordnet.fr
  225. If your request are compatible with the time I can give to this program, they will be
  226. honoured quickly.
  227.  
  228. History of modifications
  229. ------------------------
  230. Version 0.22, january 11, 1998
  231. Created from Leslie Howard source files (0.22).
  232. French looking program.
  233. Bug correction: individual without any connection is now displayed.
  234. Generation of Surnames/Places and Places/Surnames lists.
  235.  
  236. Version 0.1jbf, march 2, 1998
  237. Adding 'Liste Θclair'.
  238.  
  239. Version 0.2jbf, march 21, 1998
  240. Adding the number of births and deaths in the Places/Surnames list.
  241. Places are no more displayed for living people.
  242.  
  243. Version 1.0f&w, july 5, 1998
  244. Automatic creation of the HTML sub-directory.
  245. Internationalization: texts are in the TEXTE.TXT file.
  246. Parameters saving in the GED2WWW.DAT file (thanks to Fran Waarsenburg).
  247. Photography can be included (thanks to Frank Waarsenburg).
  248. Ads file BOTTOM.TXT included in the created pages (Frank Waarsenburg, from an idea
  249. from Jonh Hitcock).
  250. Temporary files are now deleted on program ending.
  251. The capital Y diaeresis are (I hope) now correctly handled (wink to Marie-Claire Bauche).
  252. 'Marriage', 'Parents' and 'Children' are now in bold characters (from an idea of
  253. Guy Gasiorowski).
  254. Automatic creation of the HTML sub-directory (this times, it works...) and deletion of
  255. possible *.htm and *.txt files in that directory.
  256. Sort facility on Surnames/Places and Places/Surnames lists.
  257. IBMPC (i.e. DOS) coding accepted, with accented letters.
  258.  
  259. Version 1.2f&w
  260. Translation for months (from an idea of many of you, and especially Paul-Marc Heudre, who
  261. insisted a lot ;-))
  262. Only the first NAME item of an individual is considered: the next one(s) is (are) ignored
  263. (considered as nicknames).
  264. Links to index pages in each index page (from an idea of Jean-Louis Mejecaze).
  265. The list of surnames is lightened: line feed when break on initial (from an idea of Alain
  266. Bourreau).
  267. Link to the main page at the end of Surnames/Places and Places/Surnames lists.
  268. The y acute should be handled correctly, now.
  269.  
  270. Version 1.3f&w, november 28, 1998
  271. Marriages in Places/Surnames and Surnames/Places lists
  272. Baptism, burial and occupation in data pages
  273. Place sort is now case insensitive (avoid different lines for a same place coded once with
  274. capital letters, once with small letters)
  275. Direct access to concerned individuals from Surnames/Places and Places/Surnames lists.
  276. Fixed bug on link colors management
  277. Explanation for the ░ x + symbols in the Places/Surnames and Surnames/Places lists.
  278. The beta letter is now handled
  279. Management of the html pages' sizes.
  280. Fixed bug about surnames with only one character.
  281.  
  282. Version 1.3.0f&w, decembre 13 1998 (smal malfunction correction)
  283. Baptism: CHR tag is accepted, as well as BAPM (thank you Frank)
  284. Surnames list: the link to the last surname is now correct
  285. NAME tag: the part on the right of the surname (title for some softwares, first names for
  286. other ones) have its accents now correctly handled.
  287.  
  288. Version 1.4f&w beta, march 3, 1999
  289. Correction of version 1.3 & 1.3.0: all individuals now appears.
  290. New presentation (tables) for data pages.
  291. Ability to shift pages to the right.
  292. Option for creation Places/Surnames & Surnames/Places lists.
  293. Option for reference display (REFN tag).
  294. Parameter for title of the data pages.
  295. Insertion of the content of the "top.txt" file (if present) in front of each page,
  296. giving the ability to insert a theme.
  297. Alphabet in the surnames list to improve legibility.
  298.  
  299. Version 1.5, january 15, 2000
  300. The name of the gedcom file is now stored in the parameter file ged2www.dat.
  301. Sort sequence for names is now compatible with Western Europe languages. It means that, letters
  302. like e Θ Φ Ω and δ are equivalent to e. But µ σ Σ ÷ and ° are letters distinct from a, e and o.
  303. Sosa number printing.
  304. NOTEs printing.
  305. Gross table for places.
  306. Inopportune commas removal in place names (commas generated by some genealogy softwares).
  307. Bug about photography fixed.
  308.  
  309. Version 1.5.1, january 20, 2000
  310. Correction of bug about surnames with non-alphabetic first character.
  311. File extension .ged not mandatory when giving gedcom file name.
  312.  
  313. Version 1.5.2, january 22, 2000
  314. Correction of bug about NOTEs larger than 1024 characters. They now can be up to 32 kilo-bytes,
  315. and are truncated if longer.
  316. Correction Places sort, now case insensitive.
  317. Html code has been "beautified".
  318.  
  319. Version 1.5.3 january 31, 2000
  320. Fixed a bug (crash) when you choosed to print Sosa numbers.
  321. Fixed a bug (crash) that could arrive during Processing GEDCOM (pass 1/2 or 2/2).
  322. Enhancement of NOTEs printing, ability to print marriage NOTEs.
  323. Reduced time for Place/Surnames pages.
  324.  
  325. Version 1.5.4 february 13, 2000
  326. Fixed a bug (crash) if you don't print the dates on index pages.
  327. Confirmation printinf (CONF tag).
  328. Divorce printing (if tag DIV is present in a family description).
  329. Option for external or internal sort (use internal only if Places/surnames pages are not
  330. generated).