home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 300-399 / ff324a.lzh / ANSIEd / ANSIEd.docs < prev    next >
Text File  |  1990-03-05  |  44KB  |  896 lines

  1.  
  2.                   ##   ##   ##   ####   ###### #######     ###
  3.                  ####  ###  ##  ##  ##    ##    ##  ##      ##
  4.                  ####  #### ##  ###       ##    ##       ## ##
  5.                 ##  ## ## ####   ###      ##    ####    ## ###
  6.                 ###### ##  ###     ###    ##    ##      ##  ##
  7.                ##    ####   ##  ##  ##    ##    ##  ##  ##  ##
  8.                ##    ####   ##   ####   ###### #######   ### ##
  9.  
  10.                            ANSI Screen File Editor
  11.                
  12.                              Version 1.3.0 DEMO
  13.                
  14.                
  15.                     Copyright (c) 1989  Second Sight [tm]
  16.                
  17.                            Developed by Greg Epley
  18.  
  19.  
  20. INTRODUCTION
  21. ~~~~~~~~~~~~
  22.   Documentation Notes
  23.   ~~~~~~~~~~~~~~~~~~~
  24.   PLEASE NOTE: This is a demonstration version of ANSIEd.  All "save"
  25.   features are disabled or do not otherwise have any effect as mentioned in
  26.   this and other documents included with this version.
  27.   
  28.   Throughout the remainder of this documentation these companies hold the
  29.   respective copyright, trademark, or registrations: Amiga is a registered
  30.   trademark of Commodore-Amiga, Inc.  Workbench and AmigaDOS are trademarks
  31.   respectively of Commodore-Amiga, Inc.
  32.   
  33.   It is our best intention to make this documentation as complete and
  34.   thorough as possible to reach the widest range of Amiga users.  However,
  35.   if you are a beginner or have not had a great deal of experience with the
  36.   Amiga we make these assumptions and suggestions:
  37.   
  38.       1. That you understand the basic operation of the computer.  Because
  39.          ANSIEd will operate from the friendly Workbench environment you
  40.          should thoroughly familiarize yourself with the basics.  We suggest
  41.          Chapter 3, "Getting Started" and Chapter 4, "Using the Workbench"
  42.          from the "Introduction To..." manual supplied with your computer. 
  43.          Chapter 3 will supply you with most of the information you need. 
  44.          Chapter 4 simply goes into a little more detail.
  45.          
  46.       2. That you understand the basic operation of software under the
  47.          above system.  While there are a few "lemon" software products
  48.          which do not conform to Amiga standards you will find that most do.
  49.          We prefer to stick to the terminology used in the Amiga manuals and
  50.          so a "gadget" will refer to some item on the display which you can
  51.          select to perform an operation.  It has been suggested that the
  52.          "gadget" be referred to as a "button" but that terminology is not
  53.          as generic and implies that you will actually see what appears to
  54.          be a little "button" on the display somewhere.
  55.   
  56.   What Is ANSI?
  57.   ~~~~~~~~~~~~~
  58.   ANSI is an acronym for the American National Standards Institue.  They,
  59.   along with the ISO (International Standards Organization) set various
  60.   standards in the computer field.  For example, they establish that the
  61.   number 65 decimal represents the character "A" to the computer.  Certain
  62.   combinations of characters have been established to control attributes of
  63.   the computer display such as text color and style.  You can also control
  64.   character positioning, clear the display, or move the cursor around
  65.   without erasing any displayed material.  On the Amiga, the console and the
  66.   printer devices are most likely to use these "display control codes". 
  67.   ANSIEd eliminates the need to memorize these cryptic code combinations and
  68.   allows your creativity to flow.
  69.   
  70.   Documentation Symbols
  71.   ~~~~~~~~~~~~~~~~~~~~~
  72.   Because of the way in which this product and this documentation is
  73.   presently distributed, it is assumed that you have already installed the
  74.   software as described on the enclosed notice.
  75.  
  76.   When it is necessary to indicate that you need to press a specific key to
  77.   perform an action it will be enclosed in <> (angle brackets).  Examples
  78.   are <RETURN> to press the large key above your right shift key or
  79.   <CTRL><J> to press and hold the <CTRL> key and then press the <J> key.
  80.   
  81.   The arrow or whatever other imagery you have saved under Preferences as
  82.   your mouse pointer is referred to as the "pointer".
  83.   
  84.   
  85. GETTING STARTED
  86. ~~~~~~~~~~~~~~~
  87.   Running ANSIEd
  88.   ~~~~~~~~~~~~~~
  89.   The best way to learn to use a new program is to actually use it so let's
  90.   get ANSIEd running.  ANSIEd will work from either the Workbench or CLI
  91.   (Command Line Interface) but we'll run it from the Workbench to simplify
  92.   things.
  93.   
  94.   With the ANSIEd drawer open, DOUBLE-CLICK the LEFT MOUSE BUTTON on the
  95.   ANSIED ICON.  Proceed to the section entitled "Errors" to continue now or
  96.   read on to find out how to run ANSIEd from the CLI.
  97.   
  98.   If you wish to run ANSIEd from the CLI we suggest you set your stack size
  99.   at 12000.  From the CLI prompt type:
  100.   
  101.     1> stack 12000  <RETURN>
  102.   
  103.   To run the program type:
  104.   
  105.     1> ansied   <RETURN>
  106.   
  107.   You can preceed the name from the CLI with the "Run" command to spawn
  108.   ANSIEd as a separate task from the CLI.
  109.   
  110.   If you encounter a strange lockup error when running the program it is
  111.   most likely due to insufficient memory.  If it seems that you have enough
  112.   memory then try increasing the stack size to 20000 using the above CLI
  113.   format or use the "Info" option from the "Workbench" menu on the
  114.   Workbench; change the stack from 12000 to 20000 and remember to select
  115.   SAVE so it takes effect.  If you run ANSIEd from the Workbench the icon is
  116.   set up with the stack size at 12000.
  117.   
  118.   Errors
  119.   ~~~~~~
  120.   Hereafter, the term "display" refers to the ANSIEd display.  The Workbench
  121.   display will be known as the Workbench.
  122.   
  123.   If you run ANSIEd from the Workbench an error window will open on the
  124.   Workbench just before the display appears.  This error window will remain
  125.   on the Workbench if an error occurs so that you can read any error
  126.   messages it contains, after which you must SINGLE-CLICK the LEFT MOUSE
  127.   BUTTON on the error window CLOSE BOX to close it.  If there are no error
  128.   messages the window will close automatically when you exit the program. 
  129.   If you run ANSIEd from the CLI any error messages will be displayed in CLI
  130.   window from which ANSIEd was started.
  131.  
  132.   In regular use, the only errors you are likely to encounter will be due to
  133.   some misuse of the program.  However, regardless of the amount of testing,
  134.   some logic errors still creep into even the most perfect of programs.
  135.   
  136.   If the error IS NOT serious, but you need to be informed of it, the
  137.   display will flash.  If the error IS serious a system requester will force
  138.   the Workbench to the front informing you immediately of the error.  In
  139.   BOTH cases a brief text message will be displayed appropriately in the CLI
  140.   or Workbench window.  If the error is serious you will have to respond to
  141.   the system requester to exit the program.  Take note of both the system
  142.   requester and window error messages and refer to the section entitled
  143.   "What Went Wrong" for further assistance.
  144.   
  145.   Currently, any error serious enough to cause a system requester to appear
  146.   will require full program shutdown.  You will not be able to save whatever
  147.   you were doing when the error occurred.  It is strongly recommended that
  148.   you select the "Cancel" option in these system requesters; "Retry" will
  149.   almost always cause a machine crash.  "Cancel" will at least allow you to
  150.   exit the program without having to re-boot.  Errors are most often caused
  151.   by a lack of memory.  Even in a 512K machine the memory can become
  152.   fragmented into small pieces as you use the computer.  When a program
  153.   requires a section of memory it sees all those little pieces strung
  154.   everywhere, but cannot piece them together for its use; it needs a section
  155.   all to itself for the operation.  The only cure for this problem is re-
  156.   booting the machine.
  157.   
  158.   There is a standard means of error reporting we use.  If the error is
  159.   trapped by one of our programs, the message is presented in the format:
  160.   
  161.     NAME: Text message
  162.   
  163.   where NAME: is the name of the program (or a portion of it) in which the
  164.   error occurred, and "Text message" provides a brief message relating to
  165.   the error.  If you see a system requester on the Workbench that does not
  166.   follow this format you have very likely found a serious bug or problem. 
  167.   In this event, make note of any other programs you were running, your
  168.   hardware setup, memory level, and any other information which might be of
  169.   help in tracking down the problem.  Contact us my mail, phone (voice), or
  170.   leave a message on the MEGA-Byte BBS to Greg Epley as soon as possible. 
  171.   If we don't know about the problem we can't fix it!  Refer to the section
  172.   entitled "Contacts for Customer Support" for this information.
  173.  
  174.  
  175. DISPLAY AND CONTROLS
  176. ~~~~~~~~~~~~~~~~~~~~
  177. The display consists of a green title bar at the top, a fast menu bar at the
  178. bottom, and an editing area in between.  The fast menu bar is the area below
  179. the green line at the bottom the display.  The editing area will hold 22
  180. lines of 80 characters each.  Now let's look at the fast menu bar a little
  181. more.
  182.  
  183.   The Fast Menu Bar
  184.   ~~~~~~~~~~~~~~~~~
  185.   On the far left is the color palette with the standard 8 ANSI colors. 
  186.   Next are the various quick-select tools for performing various operations.
  187.   On the far right is the status area which shows the current text styles,
  188.   foreground and background colors, and the drawing character and its
  189.   decimal ASCII code.
  190.   
  191.     The Status Area
  192.     ~~~~~~~~~~~~~~~
  193.     You should see the word "Style" in plain text style drawn in white on a
  194.     black background.  A few spaces over is the number "32" also drawn in
  195.     white.  "Style" is always drawn using the current text styles in the
  196.     forground color over a rectangle drawn in the background color.  The
  197.     current drawing character and its decimal code are drawn in a
  198.     complementary color to the background so that you can always see them.
  199.     
  200.     Color and Style Selection
  201.     ~~~~~~~~~~~~~~~~~~~~~~~~~
  202.     Try out the status area now.  Move the pointer over one of the colors in
  203.     the color palette and SINGLE-CLICK the LEFT MOUSE BUTTON.  See the color
  204.     of "Style" change?  Now try moving over another color and SINGLE-CLICK
  205.     the RIGHT MOUSE BUTTON.  See the background color now?  Try pressing
  206.     <RIGHT-AMIGA><B> and watch "Style" turn boldface.  Now press <RIGHT-
  207.     AMIGA><I> and watch "Style" turn italic as well.  To get things back to
  208.     normal set your foreground color to white and your background color to
  209.     black, then press <RIGHT AMIGA><P> to set the style to plain.
  210.     
  211.     Tools
  212.     ~~~~~
  213.     The tools are next to the color palette.  These are, from left to right,
  214.     Normal, Freehand, and Box.  You can enter single characters from the
  215.     keyboard in any of these modes.  Read about each mode first and then
  216.     we'll try them.
  217.     
  218.       Normal Tool
  219.       ~~~~~~~~~~~
  220.       Normal allows you to position the cursor within the edit area using
  221.       the mouse.  It does not leave any markings or erase anything.  SINGLE-
  222.       CLICK the LEFT MOUSE BUTTON anywhere within the edit area to move the
  223.       mouse to the pointer position.  Movement is restricted and based on
  224.       the 8 x 8 grid size used for characters but you should not have any
  225.       trouble getting precise positioning.
  226.       
  227.       Freehand Tool
  228.       ~~~~~~~~~~~~~
  229.       Freehand allows you to leave a trail which follows your pointer.  A
  230.       "trail" is currently the space character (decimal 32) drawn in the
  231.       current background color.  Simply HOLD DOWN the LEFT MOUSE BUTTON and
  232.       move it to "draw", in characters, where you wish.  As long as you hold
  233.       the button down you will draw; release it to stop.  The cursor
  234.       disappears while you hold the button down and reappears when you
  235.       release it.
  236.       
  237.       Box Tool
  238.       ~~~~~~~~
  239.       Box allows you to "draw" filled or unfilled boxes made up of the
  240.       trail.  This fill mode is determined by which half, left or right, of
  241.       the Box tool you select.  Regardless of the fill mode, you "draw" a
  242.       box as follows:
  243.       
  244.           1. HOLD DOWN the LEFT MOUSE BUTTON where you want one corner of the
  245.              box.  This is the start corner.
  246.              
  247.           2. Move the pointer out to where you want the opposite corner of
  248.              the box.  This is the end corner.
  249.              
  250.           3. As you perform step 2 you will see a fine outline of the box and
  251.              where it will be drawn.
  252.              
  253.           4. RELEASE the LEFT MOUSE BUTTON and the box will be drawn in the
  254.              proper fill mode as a trail.
  255.              
  256.     Before we try some drawing, the Normal tool is the stylized "N" which
  257.     should be highlighted (purple and white); the Freehand tool is the
  258.     squiggly line next to it; and the Box tool is the half unfilled, half
  259.     filled box next to that.  To select a tool SINGLE-CLICK the LEFT MOUSE
  260.     BUTTON somewhere over the tool you want.
  261.     
  262.     Now let's try some drawing.  Select the Normal tool if it is not
  263.     currently highlighted.  SINGLE-CLICK the LEFT MOUSE BUTTON somewhere in
  264.     the edit area.  The cursor will instantly jump to that point.  Type
  265.     something on the keyboard and watch the character in the status area
  266.     change.  Change your foreground and background colors and type some
  267.     more.  Remember, if you want to move somewhere else on the display to
  268.     edit - SINGLE-CLICK the LEFT MOUSE BUTTON there to move the cursor. 
  269.     Change your text styles as you did earlier using the <RIGHT-AMIGA> key
  270.     and the keys <P>, <B>, <U>, and <I>.  These are the first letters in the
  271.     text styles Plain, Boldface, Underlined, and Italic.
  272.     
  273.     Now select the Freehand tool.  You might want to change your background
  274.     color now as well.  Try out the Freehand tool as described above under
  275.     "Freehand Tool".  BUT PLEASE NOTE: you CANNOT move the cursor with the
  276.     mouse in Freehand without leaving at least one block of trail; you MUST
  277.     select Normal mode to move the cursor with the mouse without leaving a
  278.     trail.
  279.     
  280.     The Box tool needs a bit more explanation because of the two fill modes
  281.     it offers.  The left half selects Box Unfilled; the right half selects
  282.     Box Filled.  When either of these modes is selected you can still select
  283.     the half for the proper mode; you just don't have the center line
  284.     displayed as a guide.  For example, to select Box Unfilled SINGLE-CLICK
  285.     the LEFT MOUSE BUTTON on the LEFT HALF of the Box tool; an outlined box
  286.     appears as the highlight.  To select Box Filled mode now just SINGLE-
  287.     CLICK the LEFT MOUSE BUTTON on the RIGHT HALF of the Box tool; a filled
  288.     box appears as the highlight.  You might want to try this a few times to
  289.     get the hang of it but you should be able to select modes easily.
  290.     
  291.     Now select the Box Filled tool and set your background color to red. 
  292.     Move the pointer somewhere around the center portion of the edit area
  293.     and then follow the steps above under "Box Tool".  When you release the
  294.     button you should see a solid red box drawn as you indicated.  You might
  295.     want to change the background color again and try out the Box Unfilled
  296.     tool now.  BUT PLEASE NOTE: you CANNOT move the cursor with the mouse in
  297.     either of the Box modes without leaving a trail; you MUST select Normal
  298.     mode to move the cursor with the mouse without leaving a trail.
  299.     
  300.     Notes on Tools
  301.     ~~~~~~~~~~~~~~
  302.     When using the Box tool, a thin complementary color outline follows the
  303.     pointer to show you where the final box will appear.  This outline
  304.     appears just inside, not along the outermost edge, of the final box
  305.     edge; it's not very easy to describe, just try drawing a few boxes and
  306.     you'll notice it.
  307.     
  308.     Notes on Keyboard Entry
  309.     ~~~~~~~~~~~~~~~~~~~~~~~
  310.     Most of the keys will produce the character which is displayed on the
  311.     keycap itself.  Certain unexpected or "weird" combinations of keys may
  312.     cause a machine crash or lockup.  Generally the <ALT>, <CTRL>, <SHIFT>,
  313.     and <AMIGA> keys in combination with one other key are safe.  Combining
  314.     the <CTRL>, <ALT>, and another key may have drastically different
  315.     circumstances so be careful!  Usually, these problems will only occur
  316.     when trying to load a file containing these "weird" key sequences so
  317.     protect yourself and save any current work before loading another file
  318.     if you are unsure.
  319.     
  320.     Finally, under most circumstances, you can use the <DEL> key to produce
  321.     a nice little checkerboard character which is great for producing shaded
  322.     areas for more apparent colors.  The console device interprets this
  323.     character as displayable and does not perform a "character delete"
  324.     action.  However, if you are using ANSIEd files on a BBS system you
  325.     should test any files with this <DEL> character in them to make sure
  326.     that they will display properly for your users.  It is impossible for us
  327.     to test this due to the many different BBS packages and setups.  Some
  328.     BBS packages may display the character while others perform the "delete-
  329.     a-character" action.
  330.     
  331.   The Menus
  332.   ~~~~~~~~~
  333.   The following is a breakdown of the menus in ANSIEd from top-bottom, left-
  334.   right.
  335.   
  336.     Project Menu
  337.     ~~~~~~~~~~~~
  338.       New -     Resets and initializes the editor environment to a blank
  339.       ~~~       slate.  Use this if you want to ensure the buffer and the
  340.                 display are clear.  This will warn you if you have made
  341.                 changes since the last save and give you a chance to save
  342.                 them before clearing.  The keyboard shortcut is <RIGHT-
  343.                 AMIGA><N>.
  344.                 
  345.       Open    - Allows you to load a named file selected from the file
  346.       ~~~~      requester.  This DOES NOT ask if you wish to save the current
  347.                 buffer before loading a new file.  The keyboard shortcut is
  348.                 <RIGHT-AMIGA><O>.
  349.  
  350.       Save    - Allows you to save a file under the same name you used in
  351.       ~~~~      "Open" or "Save As".  This DOES NOT ask if you wish to
  352.                 overwrite the current file before saving the file.  The
  353.                 keyboard shortcut is <RIGHT-AMIGA><S>.
  354.                 
  355.       Save As - Allows you to save a file under a new or existing name from
  356.       ~~~~~~~   the file requester.  This DOES NOT ask if you wish to
  357.                 overwrite the current file before saving the file.
  358.                 
  359.       Delete  - Allows you to delete a named file selected from the file
  360.       ~~~~~~    requester.  This will warn you and give you a chance to back
  361.                 out of the deletion if you like.  The keyboard shortcut is
  362.                 <RIGHT-AMIGA><D>.
  363.                 
  364.       About   - Displays various information on the program development.
  365.       ~~~~~     
  366.       Quit    - Exits the program.  This will warn you if you have made
  367.       ~~~~      changes since the last save and give you a chance to save
  368.                 them.  The keyboard shortcut is <RIGHT-AMIGA><Q>.
  369.                 
  370.     Style Menu
  371.     ~~~~~~~~~~
  372.       This allows you to select the text styles from a menu if you prefer,
  373.       rather than using the keyboard shortcuts mentioned earlier.  These
  374.       notes apply regardless of which method you use.
  375.       
  376.       Plain
  377.       ~~~~~
  378.       This is mutually exclusive.  It will reset the text style back to
  379.       plain text even if there are several other styles set.  The keyboard
  380.       shortcut is <RIGHT-AMIGA><P>.
  381.       
  382.       Boldface
  383.       ~~~~~~~~
  384.       Sets the text style to bold.  This style can be mixed with all of the
  385.       others except Plain.  The keyboard shortcut is <RIGHT-AMIGA><B>.
  386.       
  387.       Underlined
  388.       ~~~~~~~~~~
  389.       Sets the text style to underlined.  This style can be mixed with all
  390.       of the others except Plain.  The keyboard shortcut is <RIGHT-AMIGA><U>.
  391.       
  392.       Italic
  393.       ~~~~~~
  394.       Sets the text style to italic.  This style can be mixed with all of
  395.       the others except Plain.  The keyboard shortcut is <RIGHT-AMIGA><I>.
  396.       
  397.     Special
  398.     ~~~~~~~
  399.       ANSI Filter
  400.       ~~~~~~~~~~~
  401.         ON/OFF
  402.         ~~~~~~
  403.         Turns the internal ANSI filter ON or OFF.  The filter only operates
  404.         while loading a file using the "Open" option on the "Project" menu. 
  405.         When the filter is ON all ANSI control sequences which begin with
  406.         the <ESC> (decimal 27) character are ignored.  By default the filter
  407.         is OFF.
  408.         
  409.       Line Term
  410.       ~~~~~~~~~
  411.         LF/CRLF
  412.         ~~~~~~~
  413.         Selects the end-of-line terminator which will be used when saving
  414.         the file.  LF stands for line feed and CRLF stands for carriage
  415.         return + line feed.  Generally on an Amiga system this should be LF,
  416.         although you can also use CRLF.  CRLF is provided mainly for those
  417.         users who operate Amiga BBS's on MS-DOS machines which require both
  418.         terminators.  Some MS-DOS text editors and word processors simply do
  419.         not recognize the end of a text line without the CR in the
  420.         terminator.  By default the end-of-line terminator is LF.
  421.         
  422.       Store Spaces
  423.       ~~~~~~~~~~~~
  424.         Compressed/Expanded
  425.         ~~~~~~~~~~~~~~~~~~~
  426.         Selects how space character gaps will be stored when saving the
  427.         file.  Compressed stores any group of more than five space
  428.         characters as a cursor movement sequence, which speeds up file
  429.         display and decreases file size.  Expanded stores single spaces in
  430.         gap areas; this is the same way ANSIEd files were stored.  By
  431.         default spaces are stored as Compressed.
  432.         
  433.       Make Icons
  434.       ~~~~~~~~~~
  435.         YES/NO
  436.         ~~~~~~
  437.         Selects whether you want icons saved with your files.  If you select
  438.         YES an icon is created when you save the file.  ANSIEd file icons
  439.         appear as the Second Sight logo (eye) in a small colored frame. 
  440.         These PROJECT type icons have ANSIEd as their default tool.  Just
  441.         DOUBLE-CLICK the LEFT MOUSE BUTTON to run ANSIEd and load the file. 
  442.         Be sure to read the section "Notes on File Handling" under "FILE
  443.         HANDLING" for further information.  By default icons are created
  444.         (YES).
  445.  
  446.  
  447. FILE HANDLING
  448. ~~~~~~~~~~~~~
  449.   The File Requester
  450.   ~~~~~~~~~~~~~~~~~~
  451.   The File Requester appears when you select "Save As", "Open", or "Delete"
  452.   from the "Project" menu.  We hope to be able to take advantage of a better
  453.   file requester with the addition of the Amiga Programmers Library (APL)
  454.   which will arrive with Release 1.4 of the Amiga System.  The current file
  455.   requester is adequate for the purpose it serves and will be left as-is
  456.   until we find a sutiable alternative.
  457.   
  458.   There are two types of information listed in the file requester. 
  459.   "Entries" are files and directories.  "Volumes" are mounted disk units
  460.   that are in use (including hard drives, recoverable drives, etc.).  Now
  461.   let's look at the various options in the file requester.
  462.   
  463.     Path/File Gadgets
  464.     ~~~~~~~~~~~~~~~~~
  465.       These horizontial boxes appear, one above, one below, the list of
  466.       Volumes or Entries.  The Path gadget above the list contains such
  467.       things as drive names, disk names (volumes), and directory names, and
  468.       combinations of any of these in that order.  The File gadget below the
  469.       list contains the selected filename.
  470.       
  471.       To activate either of these gadgets just SINGLE-CLICK the LEFT MOUSE
  472.       BUTTON within the black area of the gadget.  A cursor will appear in
  473.       the box waiting for you to type something in.  To make any changes
  474.       take effect or to simply exit either of these gadgets just press
  475.       <RETURN>.
  476.       
  477.     Volumes-Entries List and Slider
  478.     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  479.       Between the path/file gadgets is a list of items.  These will either
  480.       be Entries (files/directories) or mounted Volumes (disks), depending
  481.       on the Volumes-Entries gadget selection (see below).  Up to seven
  482.       items are shown at one time, sorted alphabetically; a maximum of 1000
  483.       entries or 30 volumes.  The Slider to the right of the list allows you
  484.       to scroll up and down through the list.
  485.       
  486.       To select a file, directory, or volume, just SINGLE-CLICK the LEFT
  487.       MOUSE BUTTON on the entry.  If the entry is a file its name will
  488.       appear in the File Gadget box.  If the entry is a directory or a
  489.       volume its name will appear properly in the Path Gadget box and the
  490.       new Path will be scanned for entries if possible.
  491.       
  492.       To move up or down a group of scanned entries at a time, just SINGLE-
  493.       CLICK the LEFT MOUSE BUTTON above or below the Slider box - somewhere
  494.       in the black area.  You can also HOLD DOWN the LEFT MOUSE BUTTON on
  495.       the Slider box - the solid purple area - and move the pointer up and
  496.       down to move through the list.
  497.  
  498.     Volumes-Entries Gadget
  499.     ~~~~~~~~~~~~~~~~~~~~~~
  500.       This is a toggle button.  Each time you call up the file requester it
  501.       ALWAYS lists entries first and this button displays the text
  502.       "Volumes".  If you select this button while "Volumes" appears a list
  503.       of mounted disk volumes will be displayed in the list area.  If you
  504.       select this button while "Entries" appears a list of files/
  505.       directories, based on the path currently in the Path gadget, will be
  506.       displayed in the list area.
  507.       
  508.       To activate this gadget just SINGLE-CLICK the LEFT MOUSE BUTTON on it.
  509.       
  510.     Parent Gadget
  511.     ~~~~~~~~~~~~~
  512.       Located beside the Volumes-Entries button, this will move you back up
  513.       one directory level towards the root directory.  It will NOT work if:
  514.       
  515.           1. There are no more levels or...
  516.           
  517.           2. You are looking at a Volumes list.
  518.           
  519.       To activate this gadget just SINGLE-CLICK the LEFT MOUSE BUTTON on it.
  520.       
  521.     OK/Cancel Gadgets
  522.     ~~~~~~~~~~~~~~~~~
  523.       The "OK" button accepts your selection and the "Cancel" button rejects
  524.       your selection.
  525.       
  526.       To activate either of these gadgets just SINGLE-CLICK the LEFT MOUSE
  527.       BUTTON on them.
  528.       
  529.   If you remove or insert a disk while the file requester is displayed it
  530.   will immediately display the list of volumes as if you had selected the
  531.   "Volumes" button.  NEVER eject a disk volume which is being scanned.  If
  532.   you decide you don't want to scan a disk just select the "Volumes" button
  533.   to stop the scan.
  534.   
  535.   Any item in the file requester that you can select can be acted upon while
  536.   the current path is being scanned for entries.  This means that you don't
  537.   have to wait for the scan to complete to take some action.
  538.   
  539.   If you enter a null path in the Path gadget, the path in effect when the
  540.   program was started will be reverted to.  This is a safety feature so that
  541.   the system has something to lock onto when nothing is provided.  In any
  542.   other case, the specific path in the Path gadget is used to access the
  543.   contents of the disk following that path.
  544.   
  545.   In the Entries list, DIRECTORIES appear in BOLD type in one color.  FILES
  546.   appear in PLAIN type in another color.
  547.   
  548.   FILES and VOLUMES have a number and letter which appears to the far left
  549.   of the list.  The letter (B, K, M, or G) appears farthest to the right
  550.   beside the number: B for Bytes, K for Kilobytes, M for Megabytes, and G
  551.   for Gigabytes.  Thus 64B is 64 bytes and 173K is 173 Kilobytes.  For
  552.   FILES, this is the size (rounded) of the file, or the amount of space USED
  553.   on the disk by that file.  For VOLUMES, this is the amount of space FREE
  554.   on the volume.  If your RAM Disk (RAM:) is available the amount of space
  555.   USED is shown, since the RAM Disk is ALWAYS full.  If the size of the
  556.   volume or file entry cannot be handled, something like "0 " will be shown.
  557.   Actually we haven't come across a file larger than 4 gigabytes to test
  558.   this so we aren't quite sure of what you will see.
  559.   
  560.   To remain compatible with Release 1.2 of the system the RAM Disk is called
  561.   RAM: to avoid a system crash.  This bug is fixed in V1.3 of the system but
  562.   we will leave it like this until most people are on V1.3/V1.4 of the
  563.   system.  It has been noted that on many occasions the RAN Disk will still
  564.   cause a total system crash that is unrecoverable.  We would suggest that
  565.   you do not use the RAM Disk if at all possible until we are able to
  566.   provide a 1.3 only version of ANSIEd which uses the working RAM Disk. 
  567.   Virtual drives such as VD0: seem okay; RAD: has not been tested since it's
  568.   not as efficient as VD0: anyway.
  569.   
  570.   Using Delete
  571.   ~~~~~~~~~~~~
  572.   "Delete" displays the standard file requester and allows you to select a
  573.   file to delete from disk.  The file requester functions as described above
  574.   except for the following changes:
  575.   
  576.       1. A file MUST be selected.  "OK" will have no effect if there is no
  577.          filename in the file gadget.  "Cancel" will back out without doing
  578.          anything.
  579.          
  580.       2. When a file has been selected and "OK" is selected, a delete warning
  581.          requester will appear in the top left corner of the display.  You
  582.          have these options:
  583.         
  584.              a. "Cancel" will back out without deleting but will still leave
  585.                 you in the file requester.  Just select "Cancel" again to
  586.                 exit the file requester or select another file.
  587.                 
  588.              b. "OK" will ATTEMPT to delete the file and any associated icon.
  589.                 The warning and file requesters will disappear at this point.
  590.                 If the delete fails the display will flash, and an error
  591.                 message will be displayed in the error or CLI window on the
  592.                 Workbench.
  593.                 
  594.                 NOTE: Because of the design of the AmigaDOS system the delete
  595.                 will sometimes occur several seconds later than you might
  596.                 expect so NEVER remove a disk immediately after selecting
  597.                 "Delete".
  598.   
  599.   Notes on File Handling
  600.   ~~~~~~~~~~~~~~~~~~~~~~
  601.   ANSIEd tries to store its files as compactly as possible and it
  602.   understands a certain set of rules in doing so.  Because of this it knows
  603.   exactly how to load any files which it saved.  However, it is possible to
  604.   load non-ANSIEd files into ANSIEd with some minor alterations and
  605.   considerations in mind.
  606.   
  607.   ANSIEd expects to find any ANSI control sequences preceeded by the <ESC>
  608.   (decimal 27) character and ending in a sequence terminator for which it
  609.   currently writes the sequence.  That is, if ANSIEd currently writes an
  610.   ANSI sequence it also knows how to interpret it when loading.  If it
  611.   doesn't support a particular ANSI sequence at this time you cannot expect
  612.   it to properly interpret it, although it will do its best.
  613.   
  614.   An ANSI reset sequence will be stored at the beginning and end of all
  615.   files saved with ANSIEd.  A reset sequence is also stored at the end of
  616.   each line to eliminate any "ANSI code sticking".
  617.   
  618.   If you use ANSIEd files are on a BBS system you should attempt to keep the
  619.   width of each line within 78 characters.  However, you can use the entire
  620.   22 line by 80 character editing area, including the lower right corner
  621.   just above the fast menu bar.  When you enter a character in column 80,
  622.   line 22 the cursor wraps back up to the top left corner.
  623.   
  624.   You can load a file into ANSIEd at startup if you run it from the CLI with
  625.   the command:
  626.   
  627.     1> ansied [path/filename]   <RETURN>
  628.   
  629.   The [path/filename] can be a filename alone if the file resides in the
  630.   current directory.  Otherwise you should include the path.  Consult any
  631.   one of several books on the Amiga CLI if you need more help.
  632.   
  633.   You can also load a file into ANSIEd at startup if you run it from the
  634.   Workbench.  There are three ways to do this:
  635.   
  636.       1. SINGLE-CLICK the LEFT MOUSE BUTTON on the ANSIED ICON, HOLD DOWN
  637.          either <SHIFT> key, and DOUBLE-CLICK the LEFT MOUSE BUTTON on the
  638.          file icon.
  639.          
  640.       2. SINGLE-CLICK the LEFT MOUSE BUTTON on the file icon, HOLD DOWN
  641.          either <SHIFT> key, and DOUBLE-CLICK the LEFT MOUSE BUTTON on the
  642.          ANSIED ICON.
  643.          
  644.       3. DOUBLE-CLICK the LEFT MOUSE BUTTON on the file icon.
  645.          
  646.          This will only work if the system "knows" where the ANSIEd program
  647.          is.  The best way to do this is to add a CLI command to your normal
  648.          system startup-sequence.  You could also type the command in each
  649.          time you wanted to use ANSIEd, or you could even set up an icon,
  650.          along with a file with the command in it, and the IconX program
  651.          from your workbench 1.3 disk (there are similar public domain
  652.          utilities available too).
  653.          
  654.          The startup-sequence or CLI command format is:
  655.          
  656.              1> assign ANSIEd: location     <RETURN>
  657.          
  658.          where "location" is the path where the ANSIEd program resides.  For
  659.          instance, if ANSIEd is in a drawer called ANSIEd on your hard disk
  660.          the command might be:
  661.          
  662.              1> assign ANSIEd: DH0:ANSIEd   <RETURN>
  663.  
  664.          or if the ANSIEd drawer were in another drawer called BBS the
  665.          command might be:
  666.          
  667.              1> assign ANSIEd: DH0:BBS/ANSIEd   <RETURN>
  668.          
  669.          Regardless of the "location", a line of the above format in your
  670.          system startup-sequence, or executed directly from the CLI, would
  671.          have the same effect.  To remove the assignment later just use the
  672.          command:
  673.          
  674.              1> assign ANSIEd:
  675.          
  676.          While this may seem like a lot of effort a little planning and
  677.          organization right now can make your system and its resources
  678.          (programs and files) much easier to work with in the long run.  If
  679.          any or most of what is described here is "over your head" you can
  680.          always contact us or just use one of the first two file loading
  681.          techniques.
  682.  
  683.  
  684. TROUBLESHOOTING
  685. ~~~~~~~~~~~~~~~
  686.   What Went Wrong?
  687.   ~~~~~~~~~~~~~~~~
  688.   The error messages below are in alphabetical order of the section name
  689.   where the error occurred.  Find the message provided in the CLI or
  690.   Workbench window below and see the additional information for that error
  691.   as noted.
  692.     
  693.     ANSIED: Icon Alloc Error
  694.         Internal program error; there was not enough contiguous memory to
  695.         store the icon definition.  Memory has most likely become too
  696.         fragmented and will require a warm boot to recover it.
  697.     
  698.     ANSIED: Open File Error
  699.         The file selected in the file requester from the "Project" menu
  700.         "Open" option could not be found at the path given in the file
  701.         requester.  Check your selection and try again or select another
  702.         filename.
  703.     
  704.     ANSIED: Passed File Error
  705.         The file passed in from the command line at startup could not be
  706.         found at the current or supplied path.  Check your selection and try
  707.         again, select another filename, or start the program without passing
  708.         a filename.
  709.     
  710.     ANSIED: Requester Alloc Error
  711.         Internal program error; there was not enough contiguous memory to
  712.         store the requester definition.  The name of the specific requester
  713.         is given in a system requester when this message is displayed in
  714.         your error window.  Memory has most likely become too fragmented and
  715.         will require a warm boot to recover it.
  716.     
  717.     ANSIED: Requester Request() Error
  718.         Internal program error; the defined requester could not be displayed
  719.         by the system routines.  The name of the specific requester is given
  720.         in a system requester when this message is displayed in your error
  721.         window.  Memory has most likely become too fragmented and will
  722.         require a warm boot to recover it.
  723.     
  724.     ANSIED: Save File Error
  725.         The file selected in the file requester from the "Project" menu
  726.         "Save" or "Save As" options could not be found at the path given in
  727.         the file requester.  Check your selection and try again or select
  728.         another filename.
  729.         
  730.         This may be caused by a disk which is write-protected.  If the disk
  731.         is not write protected and you receive this error when you use the
  732.         "Save" option try using the "Save As" option and selecting OK in the
  733.         file requester (the original file name should be in the File
  734.         gadget).  If that doesn't work try using "Save As" with another file
  735.         name.
  736.  
  737.     ANSIED: Screen Open Error
  738.         Internal program error; there is only one screen in ANSIEd and it
  739.         could not be opened by the system routines.  Memory has most likely
  740.         become too fragmented and will require a warm boot to recover it.
  741.     
  742.     ANSIED: Window Open Error
  743.         Internal program error; there is only one window in ANSIEd and it
  744.         could not be opened by the system routines.  Memory has most likely
  745.         become too fragmented and will require a warm boot to recover it.
  746.     
  747.     CONSOLEUTILS: Console Port Creation Error
  748.         Internal program error; ANSIEd creates its own write port for
  749.         console communications and this port could not be created by the
  750.         system routines.  Memory fragmentation is the most likely culprit
  751.         but there may be other conditions unique to your case which could
  752.         cause it.  Only remedy is to warm boot and attempt to run ANSIEd
  753.         again by itself.
  754.     
  755.     CONSOLEUTILS: Console Request Creation Error
  756.         Internal program error; ANSIEd creates its own write request for
  757.         console communications and this request could not be created by the
  758.         system routines.  Memory fragmentation is the most likely culprit
  759.         but there may be other conditions unique to your case which could
  760.         cause it.  Only remedy is to warm boot and attempt to run ANSIEd
  761.         again by itself.
  762.     
  763.     FILEREQ: DeleteFile() Error
  764.         Internal program error; the file selected in the file requester from
  765.         the "Project" menu "Delete" option could not be found at the path
  766.         given in the file requester.  Check your selection and try again or
  767.         select another filename.  This may also be caused by a disk which is
  768.         write-protected.  It may also be due to some AmigaDOS failure.
  769.     
  770.     FILEREQ: Entry Alloc Error
  771.         Internal program error; file or directory (Entry) space could not be
  772.         allocated for a file requester entry.  Memory has most likely become
  773.         too fragmented and will require a warm boot to recover it.
  774.  
  775.     FILEREQ: FileInfo Alloc Error
  776.         Internal program error; FileInfoBlock space could not be allocated
  777.         for the file requester to handle entries in.  Memory has most likely
  778.         become too fragmented and will require a warm boot to recover it.
  779.     
  780.     FILEREQ: InfoData Alloc Error
  781.         Internal program error; InfoData space could not be allocated for
  782.         the file requester to handle the device list in.  Memory has most
  783.         likely become too fragmented and will require a warm boot to recover
  784.         it.
  785.     
  786.     FILEREQ: Maximum Entries Reached
  787.         Warning that the maximum (1000) file/directory entries was reached
  788.         and the file list was truncated at that point.  This should NEVER
  789.         occur.  Anyone with more than 1000 files or directories on a single
  790.         filing system level deserves this error!
  791.     
  792.     FILEREQ: Maximum Volumes Reached
  793.         Warning that the maximum (30) volume entries was reached and the
  794.         volume list was truncated at that point.  This should NEVER occur. 
  795.         Anyone with more than 30 volumes (disk devices) attached to their
  796.         computer deserves this error!
  797.     
  798.     FILEREQ: Path Lock() Error
  799.         Internal program error; the path supplied in the file requester
  800.         could not be found.  Check your path entry and try again or select
  801.         another path entry.
  802.     
  803.     FILEREQ: Requester Alloc Error
  804.         Internal program error; there was not enough contiguous memory to
  805.         store the requester definition.  The name of the specific requester
  806.         is given in a system requester when this message is displayed in
  807.         your error window.  Memory has most likely become too fragmented and
  808.         will require a warm boot to recover it.
  809.     
  810.     FILEREQ: Requester Request() Error
  811.         Internal program error; the defined requester could not be displayed
  812.         by the system routines.  The name of the specific requester is given
  813.         in a system requester when this message is displayed in your error
  814.         window.  Memory has most likely become too fragmented and will
  815.         require a warm boot to recover it.
  816.  
  817.   Contacts For Customer Support
  818.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  819.   Do you have an idea for a software product?  If you do, we'd like to hear
  820.   from you.  All submissions are welcome.  We can be reached by U.S. Mail at
  821.   the address below or electronically at the BBS below:  
  822.         
  823.       Second Sight
  824.       306 Arbor Drive
  825.       Lexington, NC  27292
  826.       Attn: Greg Epley
  827.       
  828.       MEGA-Byte (BBS)
  829.       (704) 798-3431
  830.       1200/2400 Baud, F8N1, 24 hrs/day
  831.       ANSI Color Graphics, 140MG...and growing!, Private EMAIL
  832.   
  833.   Electronic messages should be left to Greg Epley.  Please DO NOT leave
  834.   messages addressed to SysOp related to this product or this company.  I do
  835.   not have access to these messages as the Co-SysOp.
  836.   
  837.   There is a registered user area for Second Sight on the above BBS now.  If
  838.   you are a registered user leave a message to Greg Epley with the following
  839.   information:
  840.   
  841.       Program names, their version numbers, and their serial numbers, or
  842.       your most recent invoice number.
  843.       
  844.   Make sure you also provide your name and address so that you can be
  845.   verified and given access to the Second Sight file area.  This file area
  846.   will be used to exchange files or other information among registered
  847.   users.  Any purely free updates will be provided here as WARP (.WRP)
  848.   files.  Sorry, but if an update charge is required and a free update is
  849.   released later, we can't provide that free update on-line; users who did
  850.   not purchase the charged update cannot be given access to a later free
  851.   update which also has the charged update features in it.
  852.  
  853.  
  854. DEVELOPMENT ENVIRONMENT
  855. ~~~~~~~~~~~~~~~~~~~~~~~
  856. ANSIEd was developed entirely on the Amiga for the Amiga!
  857.  
  858.   Software
  859.   ~~~~~~~~
  860.   Graphic images were drawn with DPaint II and DPaint III from Electronic
  861.   Arts.  ILBMDump was used to create C-image dumps which were converted to
  862.   Modula-2 image dumps.  Icons were created using ZapIcon and IconMerge. 
  863.   Interface art was used as a template for the final product model and is in
  864.   full accordance with the Amiga design "Style".
  865.  
  866.   The program was coded entirely in Modula-2 using Release 3.1 of Interface
  867.   Technologies' M2Amiga Modula-2 Development System for the Amiga.
  868.  
  869.   Hardware
  870.   ~~~~~~~~
  871.   This product was developed on a 3MG Amiga 2000 system with 2 floppy
  872.   drives, SONY CPD-1201 RGB monitor, and Panasonic KX-P1092 dot matrix
  873.   printer.
  874.  
  875.  
  876. PURCHASER INFORMATION
  877. ~~~~~~~~~~~~~~~~~~~~~
  878. There are two ways to order the commercial version of ANSIEd:
  879.  
  880.       1. Send a personal check, certified check, or money order for $30.00
  881.          to the address given above under "Customer Contacts".  Payment must
  882.          be in U.S. funds drawn on a U.S. bank - NO EXCEPTIONS.  Orders are
  883.          shipped by First Class U.S. Mail - NO EXCEPTIONS.  DO NOT request
  884.          any other payment or shipping methods!  Stated price is in effect
  885.          until the next major release.  If you are unsure of the current
  886.          price please contact us first.
  887.          
  888.       2. Send a Self-Addressed, Stamped Mailer (SASM), one blank 3.5" disk,
  889.          and a personal check, certified check, or money order for $25.00
  890.          to the address given above under "Customer Contacts".  Payment must
  891.          be in U.S. funds drawn on a U.S. bank - NO EXCEPTIONS.  Orders are
  892.          shipped by First Class U.S. Mail - NO EXCEPTIONS.  DO NOT request
  893.          any other payment or shipping methods!  Stated price is in effect
  894.          until the next major release.  If you are unsure of the current
  895.          price please contact us first.
  896.