home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / rexx / readme < prev    next >
Text File  |  1995-10-05  |  22KB  |  463 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.14 (14 Sep 1995)
  68.   This program was created to import GEDCOM data into the Scion database.
  69.   It should work pretty good by now, although no guarantees whatsoever
  70.   are made. If you have problems using this script, please contact Freddy
  71.   Ariës, and describe exactly what the problem is, or better yet, send Freddy
  72.   a copy of the GEDCOM file you are trying to read), and he will try to fix it.
  73.  
  74.   GEDCOM was developed by the Family History Department of the Church of
  75.   Jesus Christ of Latter-day Saints to provide a flexible uniform format
  76.   for exchanging computerized genealogical data.  GEDCOM is an acronym for
  77.   GEnealogical Data Communication.  GEDCOM is provided to foster the
  78.   sharing of genealogical information and the development of a wide range
  79.   of inter-operable software products to assist genealogists, historians,
  80.   and other researchers.
  81.  
  82.   This script uses (by default) the rexxreqtools.library (which requires
  83.   a version of reqtools larger than 2.0 and rexxsyslib.library).
  84.   If you do not have these, you need to supply the NOREQ argument (for
  85.   Shell output), or the QUIET argument (for no output at all).
  86.  
  87.   Even though this script does no parsing of dates, it's safer if they
  88.   are in the exact format "DD MMM YYYY".
  89.   The database must be running for this AREXX script to work.
  90.  
  91.   Now with progress indicator, using rexxarplib.library (requested by
  92.   Robbie J. Akins himself).
  93.  
  94.   All unrecognized fields or fields that Scion doesn't use, are skipped.
  95.  
  96.   NOTE: The program generates a file DATABASE.log (where DATABASE is the
  97.    name of the GEDCOM file read), in the directory where the GEDCOM file
  98.    is located. This .log file contains parsing info about which lines were
  99.    skipped and which non-fatal errors were encountered. It may be a good
  100.    idea to read this file!
  101.  
  102.    FAMS and FAMC fields, and EVEN structures will always be skipped,
  103.    because I use another method of establishing family (spouse & children)
  104.    relationships. If no relationships are established, this probably means
  105.    that the imported file does not support that other method. If you
  106.    encounter such a file, please send it to me, and tell me what program
  107.    generated it. If this happens a lot, I will add support for the parsing
  108.    of these relations in a future version.
  109.  
  110.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  111. -----------------------------------------------------------------------------
  112. Help.rexx
  113.  Version 1.12 (12 June 1995)
  114.  
  115.    Just a simple menu, for those who can't remember under which function
  116.    key they have stored a certain function.
  117.  
  118.    This script will output a requester on the Scion window, in which it
  119.    will display the current settings of Scion's function keys.
  120.    It requires a version of Scion Genealogist >= 4.04, as well as
  121.    rexxreqtools.library, which in turn needs reqtools.library (>=2.0)
  122.    and rexxsyslib.library.
  123.  
  124.    For this script to be of any use to you, you will have to add the
  125.    NewHelp.rexx command to the list of function keys that you have set in
  126.    the ScionPrefs program (eg. under F1 or F10).
  127.  
  128.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  129.            (plus minor modifications by Robbie Akins)
  130. -----------------------------------------------------------------------------
  131. Links.rexx
  132.  Version 1.16 (18 Jul 1995)
  133.  
  134.    ARexx script to find unrelated family trees in the database
  135.    It will detect all family trees within the database that have no links
  136.    (spouse, parent or child links) to other present family trees.
  137.  
  138.    This version uses (by default) the rexxreqtools.library (which requires
  139.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  140.    If you do not have these, change the line 'usereq = 1' to 'usereq = 0'
  141.  
  142.    Now with progress indicator, using rexxarplib.library (requested by
  143.    Master Robbie himself :-) )
  144.  
  145.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  146.  
  147.    See also "unrelated.rexx"
  148. -----------------------------------------------------------------------------
  149. PeopleList.rexx
  150.    This program should LIST ALL the people in the SCION database. The
  151.    database must be running for this AREXX script to work.
  152.  
  153.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  154. -----------------------------------------------------------------------------
  155. PersonInfo.rexx
  156.    This program should print out information about a person in the SCION
  157.    database. The database must be running for this AREXX script to work.
  158.  
  159.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  160. -----------------------------------------------------------------------------
  161. PrintDescendant.rexx
  162.  Version 2.00 (2 Feb 1995)
  163.  
  164.   Output options:
  165.    1. Descendant Chart - all descendants [Dutch: parenteel]
  166.    2. Descendant Chart - male descendants (mention daughters, no children)
  167.       [Dutch: genealogie - nageslacht van zonen, maar vermelding dochters]
  168.    3. Descendant Chart - male descendants (leave out daughters)
  169.       [Dutch: stamboom - nageslacht van zonen, geen vermelding dochters]
  170.  
  171.   This version uses (by default) the rexxreqtools.library (which requires
  172.   a version of reqtools larger than 2.0 and rexxsyslib.library)
  173.   If you do not have these, you need to supply the NOREQ argument (for
  174.   Shell output), or the QUIET argument (for no output at all).
  175.  
  176.   As of v2 of this script, and Scion V4, the current person on Scion's
  177.   Personal Window will be used to determine where the search starts.
  178.   Scion 3.13 can still be used, though, in which case the user will be
  179.   asked at which IRN he wants to start.
  180.  
  181.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  182. -----------------------------------------------------------------------------
  183. PrintPedigree.rexx
  184.  Version 2.03 (9 Sep 1995)
  185.  
  186.   Output options:
  187.    1. Pedigree Chart - male ancestor line only [Dutch: stamreeks]
  188.    2. Pedigree Chart - all ancestors, no siblings [Dutch: kwartierstaat]
  189.    3. Pedigree Chart - all ancestors, only siblings of last generation
  190.    4. Pedigree Chart - all ancestors, all siblings
  191.  
  192.   This version uses (by default) the rexxreqtools.library (which requires
  193.   a version of reqtools larger than 2.0 and rexxsyslib.library)
  194.   If you do not have these, you need to supply the NOREQ argument (for
  195.   Shell output), or the QUIET argument (for no output at all).
  196.  
  197.   As of v2 of this script, and Scion V4, the current person on Scion's
  198.   Personal Window will be used to determine where the search starts.
  199.   Scion 3.13 can still be used, though, in which case the user will be
  200.   asked at which IRN he wants to start.
  201.  
  202.   Known Bugs/Problems:
  203.    - This script is dog slow for large databases (ie. more than, say, 10
  204.      generations), even on Amigas with a Turboboard!
  205.    - Incorrect assumptions may be made (with regard to father/mother) when
  206.      there are persons in the database whose sex-field has value '?'
  207.  
  208.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  209. -----------------------------------------------------------------------------
  210. Scion2GEDCOM.rexx
  211.  Version  2.13 (29 Sep 1995)
  212.    This program was created to export the Scion data into the GEDCOM file
  213.    format. It should work pretty good by now, although no guarantees
  214.    whatsoever can be given. If you have any problems using this script,
  215.    please describe them to Freddy Ariës, as detailed as possible (and
  216.    please also tell him what program you are using to read the GEDCOM file),
  217.    then he will try to work out a solution.
  218.  
  219.    GEDCOM was developed by the Family History Department of the Church of
  220.    Jesus Christ of Latter-day Saints to provide a flexible uniform format
  221.    for exchanging computerized genealogical data.  GEDCOM is an acronym for
  222.    GEnealogical Data Communication.  GEDCOM is provided to foster the
  223.    sharing of genealogical information and the development of a wide range
  224.    of inter-operable software products to assist genealogists, historians,
  225.    and other researchers.
  226.  
  227.    This script uses (by default) the rexxreqtools.library (which requires
  228.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  229.    If you do not have these, you need to supply the NOREQ argument (for
  230.    Shell output), or the QUIET argument (for no output at all).
  231.  
  232.    + Dates should be in English, and in the format "DD MMM YYYY" or
  233.      "DD-MMM-YYYY", if you don't want any problems with programs importing
  234.      the GEDCOM data.
  235.      If the dates in your database are not in English, please run the
  236.      Translate.rexx script first!
  237.    + The database must be running for this AREXX script to work.
  238.  
  239.    Now with progress indicator, using rexxarplib.library (requested by
  240.    Master Robbie himself :-) )
  241.  
  242.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  243. -----------------------------------------------------------------------------
  244. Scion2Guide.rexx
  245.  Version 1.00 (24 June 1995)
  246.  
  247.    NOTE: The script "Scion2html.rexx" by Harold Ipolyi now supercedes this
  248.          programme.
  249.  
  250.    An ARexx script to make ".guide" hypertexts from Scion Genealogist
  251.    databases. It will create not only a "guide" based representation of
  252.    a family tree, but will also provide buttons to note files and pictures
  253.    as long as the notes and pictures are in the same directory as the
  254.    database.
  255.  
  256.    Friendly warning: You'll need lots of disk space for the output!
  257.  
  258.    This version uses (by default) the rexxreqtools.library (which requires
  259.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  260.    If you do not have these, you need to supply the NOREQ argument (for
  261.    Shell output).
  262.  
  263.    Inspired by and derived from "Scion2html.rexx" by Harold H. Ipolyi (see
  264.    below). Also with assistance from Freddy Ariës.
  265.  
  266.    See also "Scion2html.rexx" by Harold H. Ipolyi which now has the ability
  267.    to generate .guide files.
  268.  
  269.    Thanks for doing all the HARD work, guys!
  270.  
  271.    NOTE: This is version 1 and requires a lot more work. Especially
  272.          support for the new fields available with Scion version 4,
  273.          and to remove some redundant code. See "Scion2html.rexx" instead.
  274.  
  275.    Author: Robbie Akins
  276. -----------------------------------------------------------------------------
  277. Scion2html.rexx
  278.  Version: 24 Sep 1995
  279.    ARexx script to make html and amigaguide hypertexts from Scion Genealogist
  280.    data bases. Also produces an ASCII text file from the database.
  281.  
  282.    New: - changing & saving of configurable parameters
  283.         - now setting correct GfxCon stack size
  284.         - can now be run by double-click on ICON, as well as from shell
  285.  
  286.         - Now includes PICTURES culled from PP{IRN}.DBNAME as inline links
  287.           (please see PP & FP Notes)
  288.  
  289.         - Now has the ability to generate Amigaguide/Multiview hypertexts
  290.  
  291.    **** NOTE FROM ROBBIE AKINS: This ARexx script from  Harold Ipolyi also
  292.         generates a text file containing virtually ALL the data from the
  293.         database (including note files) in an excellent text format.
  294.  
  295.    Prerequisites: ScionGenealogist V 4.07 (or greater) by Rob Akins
  296.                ARexx (of course :)
  297.                rexxsupport.library
  298.                rexxarplib.library
  299.                html viewer (AMosaic, Mosaic, NetScape, ... )
  300.  
  301.          also:       (to incorporate and display pictures)
  302.                GfxCon V1.6 (or greater) by Dirk Farin ( » Sys:Tools)
  303.                Amiga OS 3.0 (or greater) for picture datatypes
  304.  
  305.    TESTED:
  306. |¯¯¯¯¯¯¯¯¯¯¯¯¯|    on Amiga3000 Kickstart v.37.175 Workbench v.38.35
  307. |    assume   |    &  Amiga3000 Kickstart v.40.68  Workbench v.40.42
  308. |  TradeMarks |    w/ ScionGenealogist V 3.06 & Mosaic1.2NoNet
  309. |      &      |    w/ ScionGenealogist V 3.13 & Mosaic1.3betaAmitcp
  310. |  CopyRights |    w/ ScionGenealogist V 4.07 & Mosaic2.0Prerelease
  311. |     as      |
  312. | appropriate |    HTML file compatibility tested on: AMosaic, HotJava,
  313. |_____________|    NCSA Mosaic (Sun), Netscape (Sun), Netscape (Mac and PC)
  314.  
  315.    BUGS:    If a new Thumbnail format is selected, the user must
  316.         manually edit the Picture Album files to reflect the
  317.         new Thumbnail suffixes.       (It is assumed that the
  318.         Picture Album files may have been  User  modified and
  319.         must therefore be protected against auto-regeneration)
  320.  
  321.    WHY?    others in my family don't have Amigas
  322.  
  323.     ScionGenealogist by Rob Akins is easy to use, comprehensive,
  324.     and provides Arexx ports for extracting data.
  325.  
  326.     An ARexx script can repeatedly and painlessly recreate
  327.     html files from entries in a ScionGenealogist data base.
  328.  
  329.     Mosaic, etc are available common methods of presentation.
  330.  
  331.  
  332.   IMPORTANT: if you have modified Picture Albums ( ® ), you may now need
  333.              to edit them to change from ".gif" to ".JPEG" ( or ".GIF" )
  334.              ( GfxCon creating new images is a BIG tipoff! )
  335.  
  336.  
  337.    Author: Harold H. Ipolyi, P.O.Box 891206, Houston, Tx 77289-1206, USA.
  338. -----------------------------------------------------------------------------
  339. Soundex.rexx
  340.  Version 1.02 (24 Aug 1995)
  341.    Program for Scion Genealogist 4.0 and above (no guarantees are given
  342.    for lower versions). This program should ask the user for a (last)name,
  343.    and output the list of names in the current Scion database that match
  344.    the entered name, using the SOUNDEX method of name comparison.
  345.    Scion Genealogist must be running for this script to work.
  346.  
  347.    For those who don't know what SOUNDEX is, here is a short intro:
  348.  
  349.    The Soundex system is the means established by the National Archives
  350.    to index the U.S. censuses (beginning with 1880). It codes together
  351.    surnames of the same and similar sounds but of variant spellings.
  352.    Soundexes are arranged by state, Soundex code of the surname, and
  353.    given name.
  354.  
  355.    Soundex codes begin with the first letter of the surname followed by a
  356.    three-digit code that represents the (first three) remaining consonants.
  357.    This Soundex converter will do the tricky work for you and capture the
  358.    nuances of the coding scheme (such as coding adjacent like letters as
  359.    one). Just enter the surname that you want coded.
  360.  
  361.    Soundex Coding Guide
  362.     1 = B,P,F,V
  363.     2 = C,S,G,J,K,Q,X,Z
  364.     3 = D,T
  365.     4 = L
  366.     5 = M,N
  367.     6 = R
  368.  
  369.    The letters A,E,I,O,U,Y,H and W are not coded.
  370.  
  371.    Note that surname prefixes such as Van, Von, Di, De, Le, D', dela, or
  372.    du are sometimes disregarded in alphabetizing and in coding.
  373.    Therefor it is wise to code it with and without the prefix because it
  374.    may be listed under either code. Eg. Van Hoesen could be coded as
  375.    VanHoesen or as Hoesen.
  376.  
  377.    FIXED (v1.02):
  378.    - 2 consecutive letters with the same code are now treated as one
  379.      eg. LLOYD=LOYD -> [LD=L300], and JACKSON (CKS are all 2) -> [JCN=J250]
  380.  
  381.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  382. -----------------------------------------------------------------------------
  383. Tafel.rexx
  384.    This program should show the Ancestors of a person in the SCION database.
  385.    The database must be running for this AREXX script to work.
  386.  
  387.    Author: Peter Billing, RMB 1240, Yinnar 3869, Australia
  388. -----------------------------------------------------------------------------
  389. Translate.rexx
  390.  Version 1.34 (19 Aug 1995)
  391.  
  392.    You may have noticed that setting another language in Locale means that
  393.    the date (month) fields of your database are no longer recognized
  394.    correctly. This is where Translate comes in.
  395.  
  396.    It will convert all the standard language fields in a Scion database (in
  397.    v4.0+, that means the Date fields) into another (predefined) language.
  398.    Currently Dutch, German, French, Italian and Norwegian are supported,
  399.    but only translation to and from English is possible. Adding other
  400.    languages shouldn't be hard.
  401.  
  402.  
  403.    This version uses (by default) the rexxreqtools.library (which requires
  404.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  405.    If you do not have these, you need to supply the NOREQ argument (for
  406.    Shell output), or the QUIET argument (for no output at all).
  407.  
  408.    Now with progress indicator, using rexxarplib.library (requested by
  409.    The Great Robbie himself ;-))
  410.  
  411.    Author: Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  412. -----------------------------------------------------------------------------
  413. Unrelated.rexx
  414.  Version 1.01 (18 Jul 1995)
  415.  
  416.    ARexx script to find "unrelated" people in the database.
  417.    That is, it will locate all those people who have no parents and who
  418.    have no marriages recorded (and hence cannot have any recorded children)
  419.  
  420.    This version uses (by default) the rexxreqtools.library (which requires
  421.    a version of reqtools larger than 2.0 and rexxsyslib.library)
  422.    If you do not have these, change the line 'usereq = 1' to 'usereq = 0'
  423.  
  424.    See also Links.rexx by Freddy Ariës
  425.  
  426.    Author Robbie Akins + bug fix from Freddy Ariës. See also "Links.rexx"
  427. -----------------------------------------------------------------------------
  428.  
  429. The following note is from the author Freddy Ariës:
  430.  
  431. The new versions are now able to use the ReqTools.library, and default
  432. to that, if you have rexxreqtools.library (No, these libraries are not
  433. included here, because it would make the package too large, but they are
  434. freely distributable and should be easy to obtain).
  435. If you don't want the scripts to use requesters, you can (apart from editing
  436. them and making them default to no requesters) pass the command line option
  437. 'NOREQ', in which case normal text output to the Shell shall be used. Note
  438. that the previous option 'NOMSG' has been renamed to 'QUIET' (matching
  439. Commodore's own commands). It still does the same - output no messages at all,
  440. neither by shell nor by requesters. So using 'QUIET' *and* 'NOREQ' is useless,
  441. and even impossible; if you pass both options to the program, only the first
  442. option passed will be used. The second option will simply be ignored.
  443.  
  444. Please don't use these scripts as examples of good programming in ARexx!
  445. They were all just quick hacks for myself, never really meant for public
  446. distribution. Apart from bad programming, they may also be full of bugs.
  447. These scripts are released to the Public Domain and are entirely without
  448. guarantees, so you can do with them whatever you want - at your own
  449. responsibility.
  450.  
  451. DISTRIBUTION
  452.  
  453. As I said, these scripts are Public Domain. That means that you can do with
  454. them whatever you want. All I ask of you is to name me as the original author.
  455.  
  456. NO WARRANTIES! I do not take the responsibility for ANYTHING, including,
  457. but not limited to, the loss of data caused by any of these scripts.
  458. Everything you do with the scripts is your own responsibility, and at your
  459. own risk.
  460.  
  461. Freddy Ariës, Lindeboomweg 7, NL-7135 KE Harreveld, The Netherlands.
  462. 2 Mar 1994
  463.