home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 2 / LSD and 17bit Compendium Deluxe - Volume II.iso / a / prog / amigae / ged-e2.0.lha / GED-E / GED-E.readme < prev    next >
Encoding:
Text File  |  1994-10-10  |  6.8 KB  |  135 lines
  1. //////////////////////////// DOCUMENTATION OF //////////////////////////////
  2. /                                                                          /
  3. /         The E Language Environnement for GED 1.0 - Version 2.0           /
  4. /       © BURGHARD Eric - burghard@iuta.u-nancy.fr - WANABOSO/AGOA         /
  5. /                                                                          /
  6. /                       GED - GoldED is © Dietmar Eilert                   /
  7. /                     E Language - © Wouter van Oortmersen                 /
  8. /                     Mac2E - © Lionel Vintenat                            /
  9. /                     EPP - © Barry Wills                                  /
  10. ////////////////////////////////////////////////////////////////////////////
  11.          
  12. INTRODUCTION:
  13. ~~~~~~~~~~~~~
  14.         I started programming with Fantastic Wouter van Oortmersen's E
  15.     language 1,5 years ago. At this time, all seems to be simple for me;
  16.     how many times did i type under shell "EC foo.e", each time i wanted to
  17.     compile what i just have edit under ED ?
  18.         Since this was quite boring, i started to search for a good
  19.     programmer's editor with AREXX scripts capabilities. And then i found
  20.     GoldED, another incredible Amiga DP programmer's work, which fill up
  21.     all my wishes and many more. I easily write a script that compile
  22.     current edit file, and write ec output on a CON: window, but this wasn't
  23.     enought, Since i should jump manualy on the error line.
  24.         But i started programming AREXX, and without any documentation
  25.     this was quite hard. By chance, i found, a day, a script which handle
  26.     EC errors on GED requesters, and jump automaticly on the bad line
  27.     (I think this was ESEE1.0). I start then to modify an enhanced it day
  28.     by day, to handle the numerous utilities written around E language;
  29.     I think about EPP © Barry Wills, wich enable you to programm in a
  30.     modular fashion, and Mac2E © Lionel VINTENAT (Salut Lionel), wich is a
  31.     macros preprocessor.
  32.         These AREXX scripts are not bugs free, but i used them for several
  33.     months now, without any big problems, and now i give them to all
  34.     E Language Fanatics, who will, be impressed today or tomorrow, by the
  35.     powerfull GED.
  36.         As this is not ultimate GED-E language environnement, all scripts
  37.     are fully in public domain. Do what you want with them, but send me
  38.     a email if you found them usefull. Bugs reports, wishes, are welcome too.
  39.  
  40.  
  41. DESCRIPTION:
  42. ~~~~~~~~~~~~
  43.                               -------------------
  44. PRELIMINARY NOTE:
  45.         You will find 2 versions of ec_compile.rexx; One for compiling with
  46.         EC2.1b and the other for EC3.0a|b. What differs beetween these 2
  47.         versions:
  48.            - EPP is no more useful with EC3.0a|b so all stuffs related to EPP
  49.            are removed.
  50.            - EC3.0a|b show you where it find an error with an ANSI code;
  51.            i handled this by printing "^" under the error line in a GED
  52.            requester.
  53.            - Menus change a little; ShowModuleCache and FlushModuleCache
  54.            items are removed from 2.1b menu.
  55.                               -------------------
  56.  
  57.         But what these 22 AREXX scripts, enables you ?
  58.  
  59.              - Compiling with EC v2.1b. Errors and Warnings messages are
  60.     reported in GED gadtools requesters. Automatic line jump. Option
  61.     for compile to disk, auto-revision (chekmarks), ec and executable
  62.     arguments (GED-gadtools requesters). Run produced file on request or
  63.     by menu.
  64.              - Debug with MonAm (Soon a module to debug with SIM) and
  65.     Profile (AProf).
  66.              - EPP 1.4d is handled in a transparent manner (if you use the
  67.     keyword PMODULE), like his errors output.
  68.              - Mac2E is handled with a menu checkmark. You can defined
  69.     multiples pre-analyzed macros files, by requester. Errors are handled.
  70.              - You can load EPP's or Mac2E's files, after they have
  71.     processing source file.
  72.              - Automatic autodoc's help, based on the word under cursor, or
  73.     requester, using amigaguide and his AREXX port. (You must have
  74.     the file autodocs.xref and all autodocs converted in aguide format
  75.     by AD2AG, AD2HT or similar tools).
  76.              - Compile/Tools menu enable you to launch MUIBuilder
  77.     © Eric Totel, GadToolsBox © Jan van den Baard, ScrGen; for automatics
  78.     source generation of a gadtoolsbox's gui file, Converter; a very simple
  79.     base numbers convertor (writen by me in E), ShowModuleGui; a tools to
  80.     show, in a gadtools window, e modules contents in a readable fashion.
  81.     With EC3.0 you can see modules cache contents and flush it. If you
  82.     compile to ram:, you can free it with all sources, executables, variables.
  83.     RtRequest put files you select with a reqtools requester in the specified
  84.     variables; i have write it, because GED's AREXX 'REQUEST' command don't
  85.     support multiple selection. (You will need it if you use Mac2E).
  86.              Note: Since some of these tools are not part of this archive,
  87.     you should have to get them. You can find them on all good aminet mirror
  88.     sites, or all good PD libraries. ShowModuleGui is a part of CAPUS
  89.     archive, located in dev/e on aminet.
  90.  
  91.  
  92. INSTALLATION:
  93. ~~~~~~~~~~~~~
  94.                               ------------------
  95. NOTE:   It's quite difficult to provide a universal installation or an
  96.     automatic script; you must do all by your hand.
  97.                               ------------------
  98.  
  99.         If you are conviced, and have GED an E language installed
  100.     somewere, then all that you have do is to
  101.         - Create an AmigaE and a GoldED directory in the REXX:
  102.     directory.Then copy the script beginning with ec_ in AmigaE, and
  103.     the other ones in GoldED
  104.         - Append GED-E.men to your menu after lauching GED
  105.         - Certainly, you have to modify scripts and menus.
  106.  
  107.         Severals assigns are used:
  108.         - PROGDEVICE: this is my language directory. tools, like
  109.     gadtoolsbox, muibuilder... are placed in directory tools of
  110.     PROGDEVICE:
  111.         - EDEVICE:    this is PROGDEVICE:E2.1b/ directory. Mac2E,EPP
  112.     ShowModuleGui, are copyed here. EReference.guide is located in the docs
  113.     directory.
  114.         - REXX:       See above
  115.  
  116. TO DO:
  117. ~~~~~~
  118.         - Notification on ECOpt; Auto-Recompile if ECOpt change
  119.         - Send your suggestions
  120.  
  121. LASTWORDS:
  122. ~~~~~~~~~~
  123.         I wish that all descriptions above, are enough to use these
  124.     scripts correctly. In a case of problems, you can contact me
  125.     by snail-mail:              BURGHARD Eric - 19 boulvard Emile ZOLA
  126.                                                      54520 - LAXOU
  127.     or by electronic mail:      burghard@iuta.u-nancy.fr
  128.         English, as you probably noticed, is a foreign language for
  129.     me, i write the best english as i can, but excuse me for these
  130.     horribles vocabulary, grammar and syntax errors, you should find
  131.     in this text.
  132.  
  133.         Enjoy E and GED.
  134.  
  135.