home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 051.lha / Journal / JournalEdit.doc < prev    next >
Encoding:
Text File  |  1986-11-20  |  7.0 KB  |  178 lines
  1.  
  2.    FromASCII / ToASCII 1.0       Mike Scalora                 PLink : SCARY
  3.  
  4.    This MODULE is public domain.   Freely distributable as long as this 
  5.    notice stays in.
  6.  
  7.    This program was originally uploaded to PeopleLink's Amiga Zone.  The Amiga
  8.    Zone has well over 2700 members, and a library of thousands of public domain
  9.    files.  If you're interested in joining us, call 800-524-0100 (voice) 
  10.    or 800-826-8855 (modem).
  11.  
  12.    NOTE All inputs, arguments, and options may be upper or lower case.
  13.    For syntax descriptions: Any items that are in upper or mixed case
  14.    are text constants and any items that are in lower case are variable
  15.    text.  Also, any items between the characters '[' and ']' are optional.
  16.    Any items that are followed by '...' may be repeated.  
  17.  
  18. SYNTAX
  19.  
  20.   ToASCII inputfile [ [TO] outputfile ] [-T] [-S]
  21.  
  22.   FromASCII inputfile [TO] outputfile
  23.  
  24.   -=-=-=-=-=-=-=-=-              ToASCII                    -=-=-=-=-=-=-=-=-
  25.  
  26.   ToASCII converts a journal file to a text description of each event.  The
  27.   output of ToASCII can be used as the source (input) file for FromASCII.
  28.   See documentation for FromASCII bellow for a description of the format
  29.   of the output.
  30.  
  31.   -Total  This option lists totals of mouse move events between key and 
  32.           button transitions.  You can use this to replace many mouse 
  33.           move events with one event.  Only '-T' is significant.
  34.  
  35.   -Short  This option combines down and up, key transition events that
  36.           occur one after another into a single line.  FromASCII will 
  37.           convert this line back into two events, one down transition
  38.           event and one up transition event.  In this process, the delay
  39.           between the down and up transition events is trimmed to 0.001
  40.           seconds. Only '-S' is significant.
  41.  
  42.   -=-=-=-=-=-=-=-=-             FromASCII                   -=-=-=-=-=-=-=-=-
  43.  
  44.   FromASCII converts text descriptions of journal events into a journal
  45.   file suitable for being used with the Playback program. 
  46.  
  47.   -=-=-=-=-=-=-=-=-  SYNTAX FOR CODING JOURNAL FILE EVENTS  -=-=-=-=-=-=-=-=-  
  48.  
  49. SYNTAX: for Key or Button events
  50.  
  51. nnnnn ss [D|U] [qq ...] [; [comments] ]
  52.  
  53. SYNTAX: for Mouse events
  54.  
  55. nnnnn [-]xxx [-]yyy [qq ...] [; [comments] ]
  56.  
  57. NOTE: Any line that does not have a numerical digit as its first nonblank
  58.       character will be treated as a comment.
  59.  
  60. WHERE: 
  61.   
  62.   nnnnn is a one to five digit decimal number 0 to 65535.  This is the 
  63.         delay from the last event in 100ths of a second.
  64.  
  65.   ss    is a one or more character symbol for a key.    
  66.  
  67.         One character symbols: A through Z , . / ; ' [ ] = \ ` 
  68.  
  69.         Two character symbols:
  70.  
  71.         Symbols that start with '@' are keys on the numeric keypad.
  72.           @1 @2 @3 @4 @5 @6 @7 @8 @9 @0 @. @-
  73.         Symbols thet start with '#' are keys NOT on the numeric keypad.
  74.           #1 #2 #3 #4 #5 #6 #7 #8 #9 #0 #- 
  75.         Two character symbols the start with 'F' are function keys.
  76.           F1 F2 F3 F4 F5 F6 F7 F8 F9 F0        NOTE: F0 is F10
  77.         Special symbols 
  78.           SP - Space        BS - Back Space    RE - Return     EN - Enter
  79.           CU - Cursor Up    CD - Cursor Down   HE - Help       TA - Tab 
  80.           CL - Cursor Left  CR - Cursor Right  DE - Del        ES - ESC 
  81.           LS - Left Shift   RS - Right Shift   CA - Caps Lock  CO - Control
  82.           LA - Left Alt     LC - Left Command ('Closed Amiga') 
  83.           RA - Right Alt    RC - Right Command ('Open Amiga')
  84.           LB - Left Button (Mouse)             RB - Right Button (Mouse)
  85.           MB - Middle Button (Mouse)
  86.         NOTE: All two character keys may have extra character add to them,
  87.         for example SP may be SPACE or SPA or SPASTIC or anything else 
  88.         that starts with SP
  89.  
  90.   [D|U]  You may use 'D', 'U', or neither.  'D' is for a down
  91.         transition of a key and 'U' is for an up transition of a key.
  92.         If you don't use 'D' or 'U' then two key events will be generated,
  93.         one for a down transition and another for an up trasition.  The time
  94.         delay for the up transition will be 1/100 of a second.  Only the
  95.         first character is significant.
  96.  
  97.   [qq ...]  is optionally one or more, two or more character symbols for
  98.         'qualifiers'.  These describe the state of effect keys at the
  99.         time of this key event.  The effent keys are Control (CTRL),
  100.         Caps Lock, Left Shift, Right Shift, Left Alt, Right Alt,
  101.         Left Command ('Closed Amiga'), and Right Comand ('Open Amiga').
  102.         They also can describe the state of the mouse buttons, if the
  103.         key is on the numeric keypad, an interrupt, multi-broadcast,
  104.         if the key event was created by key repeating.
  105.         Qualifier symbols:
  106.           CO - Control             CA - Caps Lock   
  107.           LS - Left Shift          RS - Right Shift
  108.           LA - Left Alt            LC - Left Command ('Closed Amiga') 
  109.           RA - Right Alt           RC - Right Command ('Open Amiga')
  110.           NU - Numeric Keypad      RE - Repeated Key
  111.           IN - Interrupt           MU - Multi-Broadcast
  112.           LB - Left Mouse Button   RB - Right Mouse Button
  113.           MB - Middle Mouse Button
  114.         NOTE: Qualifier symbols may be longer than two character. Only the
  115.         first two characters are significant.
  116.  
  117.   ;     The semicolon ';' is ignored and all text to the right of a
  118.         a semicolon is ignored also.  
  119.  
  120.   [-]xxx 
  121.   [-]yyy  'xxx' and 'yyy' are offsets for the change in position 
  122.         of the mouse pointer.  Positive 'xxx' values move the pointer to the
  123.         right and negative 'xxx' values move the pointer to the left.
  124.         Positive 'yyy' values move the pointer down and negative 'yyy' values
  125.         move the pointer up.  Values for 'xxx' and 'yyy' are limited to
  126.         the range -2048 to 2048.  The units used for mouse move events
  127.         map the screen as being 400 tall and 640 wide.
  128.  
  129. EXAMPLE:    To create a journal file to type 'Scary!^X' where ^X is CTRL-X:
  130.  
  131. ------------------------------------------------------------------------------
  132. 00010  LS D LS        ; Left Shift DOWN 
  133. 00010  S    LS
  134. 00010  LS U           ; Left Shift UP
  135. 00010  C
  136. 00010  A
  137. 00010  R
  138. 00010  Y 
  139. 00010  LS D LS        ; Left Shift DOWN
  140. 00010  #1   LS
  141. 00010  LS U           ; Left Shift UP
  142. 00100  CO D CO        ; Control    DOWN
  143. 00010  X    CO
  144. 00010  CO U           ; Control    UP
  145. ------------------------------------------------------------------------------
  146.  
  147.             If you created a Journal file using this EXAMPLE with FromASCII
  148.             and then ran it through ToASCII, here is what you would get:
  149.  
  150. ------------------------------------------------------------------------------
  151.  
  152. ;Journal v1.0 (June 1987)
  153.  
  154. 00010  LS D LSHIFT 
  155. 00010  S  D LSHIFT 
  156. 00001  S  U LSHIFT 
  157. 00010  LS U 
  158. 00010  C  D 
  159. 00001  C  U 
  160. 00010  A  D 
  161. 00001  A  U 
  162. 00010  R  D 
  163. 00001  R  U 
  164. 00010  Y  D 
  165. 00001  Y  U 
  166. 00010  LS D LSHIFT 
  167. 00010  #1 D LSHIFT 
  168. 00001  #1 U LSHIFT 
  169. 00010  LS U 
  170. 00100  CO D CONTROL 
  171. 00010  X  D CONTROL 
  172. 00001  X  U CONTROL 
  173. 00010  CO U 
  174. ------------------------------------------------------------------------------
  175.  
  176.  
  177.   -=-=-=-=-=-=-=-=-              THE END                    -=-=-=-=-=-=-=-=-
  178.