home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #3 / amigamamagazinepolishissue1998.iso / bazy / scion407 / scionarexx.lha / ReadMe < prev    next >
Text File  |  1995-07-08  |  19KB  |  363 lines
  1. The ARexx scripts included with this distribution of Scion are the work of
  2. Scion users. If you wish to discuss these scripts or make suggestions, please
  3. contact the authors directly.
  4.  
  5. Please note that ALL scripts are supplied AS IS, and no guarantees are made.
  6. Note also that some of the scripts that involve a graphical user-interface
  7. may require the use of additional libraries (not supplied) and may be designed
  8. for PAL video screens only.
  9.  
  10. The following scripts are included:
  11.  
  12. -----------------------------------------------------------------------------
  13. Age.rexx
  14.    This script should tell you the Age of a person in the SCION database.
  15.    It does expect the date to be in the format DD MMM YYYY but as long as
  16.    the year is the last 4 characters, it will give you an age within 1 year.
  17.    The database must be running for this AREXX script to work.
  18.  
  19.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  20. -----------------------------------------------------------------------------
  21. Anniversary.rexx
  22.    This script will tell you what Anniversaries occurr on a certain date.
  23.    There are two forms to the date, DD MMM which will give Anniversaries
  24.    on that date ONLY and MMM which will give ALL Anniversaries of the Month.
  25.    All Anniversaries are checked: Birth, Death, Burial and Marriage.
  26.  
  27.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  28. -----------------------------------------------------------------------------
  29. Dump-Fam.rexx
  30.  Version 1.1 93/08/31
  31.    Dump the database by family, one line per family.
  32.  
  33.    Author: Ralph L Vinciguerra, 460 Summer Ave, Reading, MA 01867, USA
  34. -----------------------------------------------------------------------------
  35. Dump-Ind.rexx
  36.  Version 1.1 93/08/31
  37.    Dump the database by individual, one line per person. This can be sorted
  38.    with the Amiga command: sort from filein to fileout colstart 24
  39.  
  40.    Author: Ralph L Vinciguerra, 460 Summer Ave, Reading, MA 01867, USA
  41. -----------------------------------------------------------------------------
  42. FamilyGroup.rexx
  43.    This program should make a Family Group from the Families in the SCION
  44.    database. The database must be running  for this AREXX script to work.
  45.  
  46.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  47. -----------------------------------------------------------------------------
  48. FamilyList.rexx
  49.    This program should LIST ALL the Families in the SCION database. The
  50.    database must be running for this AREXX script to work.
  51.  
  52.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  53. -----------------------------------------------------------------------------
  54. FixLastNames.rexx
  55.    This script should FIND and REPLACE a given LAST name in the SCION
  56.    database.
  57.  
  58.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  59. -----------------------------------------------------------------------------
  60. FixPlaceNames.rexx
  61.    This script should FIND and REPLACE a given PLACE name in the SCION
  62.    database. It will check Birth, Death, Burial and Marriage place names.
  63.  
  64.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  65. -----------------------------------------------------------------------------
  66. GEDCOM2Scion.rexx
  67.  Version  2.11 (23 May 1995)
  68.    This program was created to import GEDCOM data into the Scion database.  
  69.    It is still very basic, which means it will only be able to parse the    
  70.    most basic GEDCOM files, and I can't even guarantee that it will handle  
  71.    these correctly...                                                       
  72.                                                                             
  73.    This version uses (by default) the rexxreqtools.library (which requires  
  74.    a version of reqtools larger than 2.0 and rexxsyslib.library)            
  75.    If you do not have these, you need to supply the NOREQ argument (for     
  76.    Shell output), or the QUIET argument (for no output at all).             
  77.                                                                             
  78.    Even though this script does no parsing of dates, it's safer if they are 
  79.    in the exact format "DD MMM YYYY".                                       
  80.    All unrecognized fields or fields that Scion doesn't use, are skipped.   
  81.    The database must be running for this AREXX script to work.              
  82.                                                                             
  83.    NOTE: The program generates a file DATABASE.err (where DATABASE is the   
  84.     name of the GEDCOM file read), in the directory where the GEDCOM file   
  85.     is located. This .err file contains parsing info about which lines were 
  86.     skipped and which non-fatal errors were encountered. It may be a good   
  87.     idea to read this file!                                                 
  88.     FAMS and FAMC fields, and EVEN structures will always be skipped,       
  89.     because I use another method of establishing family (spouse & children) 
  90.     relationships. If no relationships are established, this probably means 
  91.     that the imported file does not support that other method. If you       
  92.     encounter such a file, please send it to me, and tell me what program   
  93.     generated it. If this happens a lot, I will add support for the parsing 
  94.     of these relations in a future version.                                 
  95.  
  96.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  97. -----------------------------------------------------------------------------
  98. Help.rexx
  99.  Version 1.12 (12 June 1995)
  100.  
  101.    Just a simple menu, for those who can't remember under which function
  102.    key they have stored a certain function.
  103.  
  104.    This script will output a requester on the Scion window, in which it
  105.    will display the current settings of Scion's function keys.    
  106.    It requires a version of Scion Genealogist >= 4.04, as well as
  107.    rexxreqtools.library, which in turn needs reqtools.library (>=2.0)
  108.    and rexxsyslib.library.
  109.  
  110.    For this script to be of any use to you, you will have to add the
  111.    NewHelp.rexx command to the list of function keys that you have set in
  112.    the ScionPrefs program (eg. under F1 or F10).
  113.  
  114.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  115.            (plus minor modifications by Robbie Akins)
  116. -----------------------------------------------------------------------------
  117. Links.rexx
  118.  Version 1.15 (23 May 1995)
  119.  
  120.   ARexx script to find unrelated family trees in the database              
  121.   It will detect all family trees within the database that have no links   
  122.   (spouse, parent or child links) to other present family trees.           
  123.                                                                            
  124.   This version uses (by default) the rexxreqtools.library (which requires  
  125.   a version of reqtools larger than 2.0 and rexxsyslib.library)            
  126.   If you do not have these, change the line 'usereq = 1' to 'usereq = 0'   
  127.  
  128.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  129. -----------------------------------------------------------------------------
  130. PeopleList.rexx
  131.    This program should LIST ALL the people in the SCION database. The
  132.    database must be running for this AREXX script to work.
  133.  
  134.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  135. -----------------------------------------------------------------------------
  136. PersonInfo.rexx
  137.    This program should print out information about a person in the SCION
  138.    database. The database must be running for this AREXX script to work.
  139.  
  140.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  141. -----------------------------------------------------------------------------
  142. PrintDescendant.rexx
  143.  Version 2.00 (2 Feb 1995)
  144.  
  145.   Output options:                                                          
  146.    1. Descendant Chart - all descendants [Dutch: parenteel]                
  147.    2. Descendant Chart - male descendants (mention daughters, no children) 
  148.       [Dutch: genealogie - nageslacht van zonen, maar vermelding dochters] 
  149.    3. Descendant Chart - male descendants (leave out daughters)            
  150.       [Dutch: stamboom - nageslacht van zonen, geen vermelding dochters]   
  151.                                                                            
  152.   This version uses (by default) the rexxreqtools.library (which requires  
  153.   a version of reqtools larger than 2.0 and rexxsyslib.library)            
  154.   If you do not have these, you need to supply the NOREQ argument (for     
  155.   Shell output), or the QUIET argument (for no output at all).             
  156.  
  157.   As of v2 of this script, and Scion V4, the current person on Scion's
  158.   Personal Window will be used to determine where the search starts.
  159.   Scion 3.13 can still be used, though, in which case the user will be
  160.   asked at which IRN he wants to start.
  161.  
  162.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  163. -----------------------------------------------------------------------------
  164. PrintPedigree.rexx
  165.  Version 2.00 (2 Feb 1995)
  166.  
  167.   Output options:                                                          
  168.    1. Pedigree Chart - male ancestor line only [Dutch: stamreeks]          
  169.    2. Pedigree Chart - all ancestors, no siblings [Dutch: kwartierstaat]   
  170.    3. Pedigree Chart - all ancestors, only siblings of last generation     
  171.    4. Pedigree Chart - all ancestors, all siblings                         
  172.                                                                            
  173.   This version uses (by default) the rexxreqtools.library (which requires  
  174.   a version of reqtools larger than 2.0 and rexxsyslib.library)            
  175.   If you do not have these, you need to supply the NOREQ argument (for     
  176.   Shell output), or the QUIET argument (for no output at all).             
  177.                                                                            
  178.   As of v2 of this script, and Scion V4, the current person on Scion's
  179.   Personal Window will be used to determine where the search starts.
  180.   Scion 3.13 can still be used, though, in which case the user will be
  181.   asked at which IRN he wants to start.
  182.  
  183.   Known Bugs/Problems:                                                     
  184.    - This script is dog slow for large databases (ie. more than, say, 10   
  185.      generations), even on Amigas with a Turboboard!                       
  186.    - Incorrect results may be returned when there are persons in the
  187.      database whose sex-field has value '?'
  188.  
  189.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  190. -----------------------------------------------------------------------------
  191. Scion2GEDCOM.rexx
  192.  Version 2.11 (23 May 1995)
  193.    This program was created to export the Scion data into the GEDCOM file   
  194.    format. It is still very basic.                                          
  195.                                                                            
  196.    This version uses (by default) the rexxreqtools.library (which requires  
  197.    a version of reqtools larger than 2.0 and rexxsyslib.library)            
  198.    If you do not have these, you need to supply the NOREQ argument (for     
  199.    Shell output), or the QUIET argument (for no output at all).             
  200.                                                                            
  201.    Dates should be in English, and in the format "DD MMM YYYY",             
  202.    "DD-MMM-YYYY" or "DD.MMM.YYYY", if you don't want any problems with      
  203.    programs importing the GEDCOM data.                                      
  204.    The database must be running for this AREXX script to work.              
  205.  
  206.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  207. -----------------------------------------------------------------------------
  208. Scion2Guide.rexx
  209.  Version 1.00 (24 June 1995)
  210.  
  211.    An ARexx script to make ".guide" hypertexts from Scion Genealogist
  212.    databases. It will create not only a "guide" based representation of
  213.    a family tree, but will also provide buttons to note files and pictures
  214.    as long as the notes and pictures are in the same directory as the
  215.    database.
  216.    
  217.    Friendly warning: You'll need lots of disk space for the output!
  218.  
  219.    This version uses (by default) the rexxreqtools.library (which requires  
  220.    a version of reqtools larger than 2.0 and rexxsyslib.library)            
  221.    If you do not have these, you need to supply the NOREQ argument (for     
  222.    Shell output).
  223.  
  224.    Inspired by and derived from "Scion2html.rexx" by Harold H. Ipolyi (see
  225.    below). Also with assistance from Freddy Ariës.
  226.  
  227.    Thanks for doing all the HARD work, guys!
  228.  
  229.    NOTE: This is version 1 and requires a lot more work. Especially
  230.          support for the new fields available with Scion version 4,
  231.          and to remove some redundant code.
  232.  
  233.    Author: Robbie Akins
  234. -----------------------------------------------------------------------------
  235. Scion2html.rexx
  236.  Version: 5 July 1995
  237.    ARexx script to make html hypertexts from ScionGenealogist data bases
  238.  
  239.    **** NOTE FROM ROBBIE AKINS: This ARexx script from  Harold Ipolyi also
  240.         generates a text file containing virtually ALL the data from the
  241.         database (including note files) in an excellent text format.
  242.  
  243.    New: now includes PICTURES culled from PP{IRN}.DBNAME as inline links
  244.                   (please see PP & FP Notes)
  245.  
  246.    Prerequisites: ScionGenealogist V 3.13 (or greater) by Rob Akins
  247.                   html viewer (Mosaic, etc.)
  248.  
  249.          also:    (to incorporate and display pictures:)
  250.  
  251.                   GfxCon V1.6 (or greater) by Dirk Farin (in Sys:Tools)
  252.                   Amiga OS 3.0 (or greater) for picture datatypes
  253.  
  254.    WHY?    others in my family don't have Amigas
  255.  
  256.     ScionGenealogist by Rob Akins is easy to use, comprehensive,
  257.     and provides Arexx ports for extracting data.
  258.  
  259.     An ARexx script can repeatedly and painlessly recreate
  260.     html files from entries in a ScionGenealogist data base.
  261.  
  262.     Mosaic, etc are available common methods of presentation.
  263.  
  264.    TESTED:    on Amiga3000 Kickstart v.37.175 Workbench v.38.35
  265.         &  Amiga3000 Kickstart v.40.68  Workbench v.40.42
  266.         w/ ScionGenealogist V 3.06 & Mosaic1.2NoNet
  267.         w/ ScionGenealogist V 3.13 & Mosaic1.3betaAmitcp
  268.  
  269.         html file compatibility tested on Sun NCSA Mosaic
  270.         and IBM PC Netscape.
  271.  
  272.    Author: Harold H. Ipolyi, P.O.Box 891206, Houston, Tx 77289-1206, USA.
  273. -----------------------------------------------------------------------------
  274. Soundex.rexx
  275.  Version 1.00 (3 Feb 1995)
  276.    Program for Scion Genealogist 4.0 and above (no guarantees are given     
  277.    for lower versions). This program should ask the user for a (last)name,  
  278.    and output the list of names in the current Scion database that match    
  279.    the entered name, using the SOUNDEX method of name comparison.           
  280.    Scion Genealogist must be running for this script to work.               
  281.                                                                            
  282.    For those who don't know what SOUNDEX is, it is a search method that     
  283.    looks for persons based on the way their surname sounds, rather than     
  284.    the way it is spelled.                                                   
  285.  
  286.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  287. -----------------------------------------------------------------------------
  288. Tafel.rexx
  289.    This program should show the Ancestors of a person in the SCION database.
  290.    The database must be running for this AREXX script to work.
  291.  
  292.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  293. -----------------------------------------------------------------------------
  294. Translate.rexx
  295.  Version 1.30 (23 May 1995)
  296.  
  297.    You may have noticed that setting another language in Locale means that
  298.    the date (month) fields of your database are no longer recognized
  299.    correctly. This is where Translate comes in. 
  300.  
  301.    It will convert all the standard language fields in a Scion database (in
  302.    v4.0+, that means the Date fields) into another (predefined) language.
  303.    Currently only Dutch, German and French are supported, and only
  304.    translation to and from English is possible. Adding other languages
  305.    is easy, though. 
  306.                                                                            
  307.    This version uses (by default) the rexxreqtools.library (which requires
  308.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  309.    If you do not have these, you need to supply the NOREQ argument (for
  310.    Shell output), or the QUIET argument (for no output at all).
  311.  
  312.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  313. -----------------------------------------------------------------------------
  314. Unrelated.rexx
  315.  Version 1.00 (25 Apr 1995)
  316.    ARexx script to find "unrelated" people in the database.                 
  317.    That is, it will locate all those people who have no parents and who     
  318.    have no marriages recorded (and hence cannot have any recorded children) 
  319.                                                                            
  320.    This version uses (by default) the rexxreqtools.library (which requires  
  321.    a version of reqtools larger than 2.0 and rexxsyslib.library)            
  322.    If you do not have these, change the line 'usereq = 1' to 'usereq = 0'   
  323.  
  324.    See also Links.rexx by Freddy Ariës
  325.  
  326.    Author Robbie Akins
  327. -----------------------------------------------------------------------------
  328.  
  329. The following note is from the author Freddy Ariës:
  330.  
  331. The new versions are now able to use the ReqTools.library, and default
  332. to that, if you have rexxreqtools.library (No, these libraries are not
  333. included here, because it would make the package too large, but they are
  334. freely distributable and should be easy to obtain).
  335. If you don't want the scripts to use requesters, you can (apart from editing
  336. them and making them default to no requesters) pass the command line option
  337. 'NOREQ', in which case normal text output to the Shell shall be used. Note
  338. that the previous option 'NOMSG' has been renamed to 'QUIET' (matching
  339. Commodore's own commands). It still does the same - output no messages at all,
  340. neither by shell nor by requesters. So using 'QUIET' *and* 'NOREQ' is useless,
  341. and even impossible; if you pass both options to the program, only the first
  342. option passed will be used. The second option will simply be ignored.
  343.  
  344. Please don't use these scripts as examples of good programming in ARexx!
  345. They were all just quick hacks for myself, never really meant for public
  346. distribution. Apart from bad programming, they may also be full of bugs.
  347. These scripts are released to the Public Domain and are entirely without
  348. guarantees, so you can do with them whatever you want - at your own
  349. responsibility.
  350.  
  351. DISTRIBUTION
  352.  
  353. As I said, these scripts are Public Domain. That means that you can do with
  354. them whatever you want. All I ask of you is to name me as the original author.
  355.  
  356. NO WARRANTIES! I do not take the responsibility for ANYTHING, including,
  357. but not limited to, the loss of data caused by any of these scripts.
  358. Everything you do with the scripts is your own responsibility, and at your
  359. own risk.
  360.  
  361. Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  362. 2 Mar 1994
  363.