home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 518.lha / ImConEd_v1.1 / ImConEd.Doc.pp / ImConEd.Doc
Encoding:
Text File  |  1991-06-09  |  10.5 KB  |  247 lines
  1.  
  2.  
  3.                   *************
  4.                 ImConEd1.1
  5.                   *************
  6.  
  7.         What the hell is an ImConEd? Well, it's a program to 
  8.     edit your Imagine.config file with. I assure you that if you
  9.     don't know what an Imagine.config file is, this program is NOT
  10.     for you. Sure, you can use a text editor to change the settings
  11.     in your Imagine.config file, but ImConEd is easier, and more
  12.     fun. ;^) 
  13.  
  14.         First and foremost, I want to tell anyone who might 
  15.     want to use this program, that it is an ALPHA release (at best!) 
  16.     and is NOT complete. Most bugs have been stomped on, but this
  17.     is no commercial program and therefore does not have a
  18.     commercial developers budget for testing, behind it. If you use 
  19.     this program, you do so at your OWN RISK!! I will not take ANY 
  20.     responsibility for ANY problems that you run into while using
  21.     this program. 
  22.  
  23.         While I maintain all copyrights to this program,
  24.     it  may be freely distributed under the condition that this 
  25.     text file accompanies the program. (That's not TOO much to ask 
  26.     is it? :) Also, ImConEd may not be distributed with any
  27.     commercial software without the express written consent of the
  28.     author (Who just happens to be me!).  
  29.  
  30.  
  31.  
  32.         ********************************************
  33.  
  34.  
  35.  
  36.         That out of the way, using this program is actually 
  37.     very easy, but there are a number of restrictions and 
  38.     requirements that you should be aware of. First, you MUST 
  39.     have your Imagine.config file in either the same directory as
  40.     ImConEd, or in your assigned S: directory. Your best bet is to
  41.     put ImConEd in the same directory that you have Imagine in. 
  42.     Both ImConEd and Imagine look in their own directory, and 
  43.     then the S: directory to find the Imagine.config file while 
  44.     starting up. 
  45.  
  46.         I do not know exactly what Imagine requires from 
  47.     Imagine.config in terms of text formatting, but I've tried to  
  48.     be at least as open if not more so. ImConEd requires that your 
  49.     Imagine.config file have no more than ONE configuration on a
  50.     line. The configuration must have a name first on the line.
  51.     Imconed considers a configuration name to be four (4)
  52.     characters that are either numbers or CAPITAL letters. If you
  53.     have stuck something else in your Imagine.config file, then
  54.     ImConEd may simply decide to remove it. 
  55.  
  56.                      *** IMPORTANT NOTE ***
  57.         When you get an upgrade to Imagine along with a new
  58.     Imagine.config file, be SURE that all commands are compatible
  59.     with these criterion BEFORE you run ImConEd. Then be SURE to 
  60.     ALWAYS use a COPY of your original Imagine.config file. If you 
  61.     blast a particular configuration into binary limbo and you don't
  62.     know what it was, you may never be able to edit that configuration
  63.     again, until you find another copy of a configuration file for 
  64.     your version of Imagine.
  65.     
  66.         It is also noteworthy that ImConEd will remove anything on 
  67.     a line beyond the 108th character.
  68.  
  69.         A value is expected after the configuration. This can be
  70.     a path name for things like the "EDIT" or "PPTH" configurations,
  71.     or it can be a "T" (for true) or "F" (for false) value for any 
  72.     of the BOOLEAN configurations like "GRON" or "WARN". It would be
  73.     a three digit hexadecimal value for commands like "STAR" or "CUBE"
  74.     and a single three digit (or less) number for "NUMS", "RSDP", and
  75.     "EDLE". The commands, "GSIZ" and "SCRL" should be real numbers 
  76.     (i.e. they should have a decimal point) and function key definitions
  77.     are three digit numbers. Strings are used as "PSET" values.
  78.         
  79.         Lastly, ImConEd really wants to see a comment for the 
  80.     configuration, that begins with a hash mark (#). (ImConEd hopes 
  81.     that your comments are kept short (49 characters or less).) If 
  82.     you have any leading spaces on a line, ImConEd will dispose of 
  83.     them. If you have large spaces between the various fields on a 
  84.     line, ImConEd will reduce them to the size that it prefers. 
  85.     (ImConEd prefers four spaces right now...)   
  86.  
  87.  
  88.     ************************************************************
  89.  
  90.  
  91.  
  92.         If you have tried playing around with ImConEd, then you
  93.     probably already know how it works. (It's VERY easy to use.)
  94.     Some things might look a bit odd however. For example, if you
  95.     have started up ImConEd and you see some gadgets with
  96.     configurations on them, and some that are blank, then it is 
  97.     because you are editing a version of Imagine.config that is 
  98.     previous to version 1.1. It is time for you to either upgrade
  99.     your copy of Imagine, or put your new Imagine.config file in
  100.     the same directory as your new Imagine. ( I forgot to do that
  101.     and had a 0.9 config file for Imagine 1.0 for months before I
  102.     figured out why I had no presets, etc. :^)
  103.  
  104.  
  105.         Speaking of PreSets, if you've tried to edit the
  106.     PreSets in your Imagine.config file using ImConEd, then you
  107.     will have already ascertained  why I refer to this as an
  108.     "incomplete" program. Attempting to edit your Function Key
  109.     assignments and/or playing with the "Errors and Omissions"
  110.     gadget would have given you the same story. These feature are
  111.     not done yet; plain and simple. The Function Key Editor is well
  112.     along at this time, however, and the others should follow suit
  113.     in good time. 
  114.  
  115.  
  116.         If you have not yet started ImConEd, then you can do so
  117.     by typing ImConEd at the prompt, or by double clicking on its
  118.     icon. Start ImConEd from the CLI with no arguments. (If you 
  119.     give ImConEd any arguements, they will be ignored.) If you 
  120.     prefer to use the Workbench to start ImConEd, then simply 
  121.     double click on its icon. If ImConEd found your Imagine.config 
  122.     file, it will present you with a screen filled with a whole 
  123.     bunch of gadgets. Each of the configuration gadgets has its 
  124.     name and current value on it. Clicking on one of these gadgets 
  125.     will allow you to edit that configuration.
  126.  
  127.  
  128.         There are four different configuration editors used by 
  129.     ImConEd, depending on the configuration's requirements. 
  130.     The first configuration editor is a string gadget that will
  131.     allow you to edit the path to "Imagine.pic" and to the text
  132.     editor of your choice to edit the "Movie" files for your
  133.     Imagine animation. ImConEd strips off the quotation marks that
  134.     are present in the config file's paths before presenting them
  135.     to you for editing in the string gadget. ImConEd will also
  136.     automatically put quotation marks around the path name when it
  137.     writes to your configuration file. What this means to you, is
  138.     that you will not see quotation marks and should NEVER put
  139.     quotation marks into the string gadgets in ImConEd. If they are
  140.     supposed to be in the config file, ImConEd will put them there
  141.     for you. 
  142.  
  143.         The second editor is simply a switch that can be 
  144.     [T]rue or [F]alse. The gadgets that use this type of editor
  145.     will have a "T" or "F". Clicking on one of these gadgets will 
  146.     present you with a requester telling you the current setting, 
  147.     and asking you if you want to change it. Clicking on "Yup" will
  148.     change that setting to its opposite value, clicking "Nope" will 
  149.     leave the setting as it is.
  150.  
  151.         The third editor is the Triple Proportional Gadget 
  152.     Colour Requester (whew!). This requester presents you with 
  153.     three proportional gadgets that display the current settings 
  154.     for the colour components of that configuration. The values are 
  155.     set between 0 and f (f is the hexadecimal equivalent of 15).
  156.     Play with the sliders until the colour in the "swatch box" is
  157.     something that you find acceptable. Click "Accept" when you are 
  158.     satisfied with the values, or "Cancel" if you decide not to 
  159.     change them.
  160.  
  161.         The last way to set a configuration is the Single 
  162.     Proportional Gadget Number Requestor. This editor allows you 
  163.     to set the value of a configuration which uses a single
  164.     numerical value. Maximum and minimum values depend on the 
  165.     configuration. Note: I have set a maximum of 10 screens open 
  166.     for animation creation and a maximum grid size on startup to 
  167.     999.9, if these values are inadequate, then let me know...they
  168.     seemed like more than enough to me and I must set some
  169.     arbitrary maximum value for the proportional gadget to work.
  170.     Click "Accept" when you are satisfied with the value, or 
  171.     "Cancel" if you decide not to change it.
  172.  
  173.         When you are finished editing your config file, click
  174.     on the "Done" gadget.  This will present you with the options
  175.     of:
  176.  
  177.        -Save N' Go: Your changes will be written to the
  178.     Imagine.config file that was read, and the program will 
  179.     exit. (If you have deleted the file in the mean time, ImConEd
  180.     will make a new one.)
  181.  
  182.        -Save N' Stay: Your changes will be written to the
  183.     Imagine.config file that was read, but the program will not
  184.     exit. Instead, it will wait for you to edit some more stuff.
  185.     This feature was implemented to complement Imagine1.1's
  186.     "Reconfig" command, which forces Imagine to re-read the
  187.     Imagine.config file and configure itself over again. If you
  188.     have both Imagine and ImConEd running at the same time, you 
  189.     can quickly see what effect any changes that you have made to
  190.     the configuration have had.
  191.  
  192.        -Just Go: Your changes will not be written to the Imagine.config
  193.     file, and it will remain unchanged. ImConEd will exit.
  194.  
  195.        -Cancel: Your changes will not be written to the Imagine.config
  196.     file, and it will remain unchanged. ImConEd will remain ready
  197.     and waiting for you to edit some more stuff.
  198.  
  199.  
  200.     ***********************************************************
  201.  
  202.  
  203.  
  204. KNOWN BUGS.
  205.  
  206.     -ImConEd assumes that you are using Topaz/8 as your 
  207.         system font. If you have changed your system font, 
  208.         you may wind up with some screwy gadgets. I don't know 
  209.         what it would really look like, but I know that it 
  210.         could be pretty ugly if your font is not the same size
  211.         as Topaz/8! I was just too lazy to take care 
  212.         of this assumption...I'll fix it if anyone tells me
  213.         that this is a problem. (Technically, I guess it's not 
  214.         _really_ a bug.)
  215.  
  216.  
  217.     -You might still see a bit of weird things happening in the 
  218.         proportional gadgets...don't worry about it. Those 
  219.         problems are due to my nominal programming skills, but 
  220.         they will not have an adverse effect on the 
  221.         Imagine.config file.
  222.  
  223.  
  224.     ***********************************************************
  225.  
  226.  
  227. CREDITS
  228.  
  229.     This program was written because Steve Menzies said that he 
  230.         thought that it would be nice to be able to set his 
  231.         Edge level without having to dig out a text editor. 
  232.         To that end, I have spent many weeks, learning about, 
  233.         and programming my Amiga...Thanx Steve. 
  234.  
  235.     This program would not have been written if it were not for the 
  236.         fact that Imagine was created in the first place (and 
  237.         that it has this "Imagine.config" file that needs 
  238.         occasional editing.:)...Thanx Mike.
  239.  
  240.  
  241. If you have any comments and/or more bug reports, leave me mail on 
  242. Electronic Image BBS (514)937-9984.
  243.  
  244.  
  245. Imagine is a Trademark of Impulse, Inc.
  246. ImConEd was written by, and is copyright 1991 by Sheldon Arnst.
  247.