home *** CD-ROM | disk | FTP | other *** search
/ NeedleCraft Plus / needlecraftplusvolume1.iso / dos / pwsdem / pwshelp.exe / lha / MACROS.HLP < prev    next >
Text File  |  1992-02-02  |  15KB  |  300 lines
  1. 002 038 186 200 237 260 279 000 000 000 000 000 000 000 000 000 000 000 000
  2.  Command:  Setup/Macros/Play OR CTRL ]            < SMP >
  3.  Purpose:  Play a keystroke Macro file on disk.
  4.  Information:
  5.      A "Macro" is a recorded collection of keystrokes.  This 
  6.      option presents a pick window of macro files on the current 
  7.      directory.  Select a file with the arrow keys or mouse, just 
  8.      as you would load other types of files.  After the file is 
  9.      loaded Patternland replays all keystrokes contained in the 
  10.      file.   
  11.  
  12.      Patternland uses the selected mode--Tutorial, Automatic, or 
  13.      neither--to play the macro.  If neither Tutorial nor 
  14.      Automatic modes are checked, you press any key to play each 
  15.      keystroke.  Tutorial and Automatic mode are described under 
  16.      the help for each option.
  17.  
  18.      In Automatic mode, you can pause the playback by pressing 
  19.      Space (or another key); press Space again to resume. 
  20.      
  21.      In any mode, press CTRL ESC once or twice to cancel the 
  22.      macro. 
  23.  Comments:
  24.      You can also use the "hotkey" combination Control "]" to 
  25.      activate the Play option from any menu.  HOWEVER, you must 
  26.      replay a macro at the same location from which it was 
  27.      recorded or UNPREDICTABLE consequences will result.  Usually 
  28.      you will only use the hotkey to play back macros which you 
  29.      recorded with the Record hotkey, e.g. a threading or 
  30.      treadling block.  Just move the cursor to the starting 
  31.      thread where you want to play the input, press ESC for the 
  32.      menu, and press Ctrl "]" to pick the macro file to play. 
  33.  
  34.  See Also:  Setup/Macros/Record 
  35.  ______________________________________________________________
  36.  
  37.  
  38.  Command:  Setup/Macros/Record OR CTRL \          < SMR >
  39.  Purpose:  Record a new keystroke Macro to disk.
  40.  Information:
  41.      A "Macro" is a recorded collection of keystrokes.  This 
  42.      option presents a file name window for you to type the name 
  43.      of a new macro file.  If the file exists, Patternland will 
  44.      warn you before overwriting the file.  After you specify the 
  45.      file name and press ENTER, you are in recording mode.  If 
  46.      the Key line option is ON (highly recommended for 
  47.      recording), the Key line appears as soon as you record the 
  48.      first key.  It tells you what key you pressed along with the 
  49.      status of the keyboard.  See the help under Key Line for a 
  50.      detailed description of the Key Line indicators. 
  51.  
  52.      To create the rest of the macro, simply press each key you 
  53.      want to record.  When you are done recording, return the 
  54.      Macro menu and select <Stop>. The Key line disappears when 
  55.      you stop recording.  You can also stop recording with the 
  56.      "hotkey" Ctrl ESC.  (Use Ctrl [ from MS-Windows.)
  57.  
  58.      EXTENDED MACROS -- recorded with Num Lock ON 
  59.  
  60.      An eXtended Macro is one with an associated window of text 
  61.      information; and an optionally modified delay or timed 
  62.      interval.  To record an extended macro, simply turn the 
  63.      NumLock ON before pressing the key you want.  A window 
  64.      appears with the current header and footer and text from the 
  65.      last recorded keystroke.  The available options are NOT 
  66.      displayed; you must refer to this document until you 
  67.      memorize them.  These are the XMacro commands:
  68.      
  69.      MOVEMENT:   Press the Left and Right, Up and Down Arrows to 
  70.                  move the window on the screen.  PgUp and PgDn 
  71.                  also move the window up and down.  Text mode 
  72.                  windows refresh the screen underneath; Graphics 
  73.                  mode windows obliterate the screen contents as 
  74.                  they are moved.
  75.      
  76.      SIZING:     Press Control plus Left Arrow to reduce the 
  77.                  width; Control Right Arrow to increase width.  
  78.                  Press Control PgUp to reduce height; Control 
  79.                  PgDn Increase height.  First use the movement 
  80.                  commands to put the upper left corner of the 
  81.                  window where you want it; then use the sizing 
  82.                  commands to resize it.
  83.                  
  84.      TEXT:       Press BACKSPACE to Erase the current text and 
  85.                  write new text. Press ESC ONCE to end text 
  86.                  input. 
  87.                    
  88.                  If you are in a text mode macro window, write 
  89.                  the text without carriage returns except to 
  90.                  force a new line or paragraph.  While you are 
  91.                  writing, the text wraps at the end of each      
  92.                  line, even in the middle of words; when you are 
  93.                  done, Press ESC ONCE:  the text will be 
  94.                  rewritten with a one space margin and wrapping 
  95.                  whole words to the next line.  You can resize 
  96.                  the window to adjust how the text wraps.
  97.                  
  98.                  For a Graphics mode macro, you must press ENTER 
  99.                  at the end of each line at the length that you 
  100.                  want.  You can still resize the window later, 
  101.                  but the text doesn't care how big it is and will 
  102.                  overwrite the window frame if the window is too 
  103.                  small.
  104.                         
  105.      HEADER:     Press <H> to rewrite the Header text.  The 
  106.                  window text is temporarily erased for you to 
  107.                  write the header.  Press ENTER when you are 
  108.                  done.  The header text is replaced and the 
  109.                  window text is redisplayed.  Headers are carried 
  110.                  over from one window to the next until you 
  111.                  rewrite them. 
  112.  
  113.      FOOTER:     Press <H> to rewrite the Footer text.  The 
  114.                  window text is temporarily erased for you to 
  115.                  write the footer.  Press ENTER when you are 
  116.                  done.  The footer text is replaced and the 
  117.                  window text is redisplayed.  Footers are carried 
  118.                  over from one window to the next until you 
  119.                  rewrite them.
  120.                  
  121.      DELAY:      Press <D> <value> <ENTER> to set a specific 
  122.                  Delay Factor for this keystroke only.  During 
  123.                  Automatic Mode, this value will be used instead 
  124.                  of the overall delay factor set from the menu.  
  125.                  Multiply the Delay Factor you set by 100 to get 
  126.                  the actual time in milliseconds.  A Delay Factor 
  127.                  of 10 creates a delay of 1 second.             
  128.  
  129.      TIMED:      Press <T> <value> <ENTER> to set a specific 
  130.                  Timed Interval for this keystroke only.  During 
  131.                  ANY mode, Patternland will continue activity for 
  132.                  the amount of time you specify BEFORE playing 
  133.                  back the recorded keystroke.  This feature is 
  134.                  mostly useful for demonstrations of the color 
  135.                  cycling in the VGA palette editor.  Use ASCII 
  136.                  255 (ALT plus NumPad 255) for a Timed Macro that 
  137.                  does nothing.  As with the Delay Factor, 
  138.                  multiply the value you set by 100 to get the 
  139.                  actual time in milliseconds.  A Timed Keystroke 
  140.                  does NOT wait for user input before playing the 
  141.                  next recorded keystroke, regardless of the mode 
  142.                  of playback. 
  143.  
  144.      DONE:       Press ESC to stop defining an XMacro keystroke.
  145.  
  146.  Comments:
  147.      You can also use the "hotkey" combination Control "\" to 
  148.      begin Recording from any menu.  HOWEVER, the user must 
  149.      replay a macro at the same location from which it was 
  150.      recorded or UNPREDICTABLE consequences will result.  Usually 
  151.      you will only use the hotkey to record macros that create a 
  152.      block of threading or treadling.  In this case it may be 
  153.      preferable to use the function and other top row numeric 
  154.      keys to enter the threading/treadling, rather than the space 
  155.      bar with smart cursor directional commands.  With F-key 
  156.      input it doesn't matter which harness the cursor is on when 
  157.      you ESC to the menu to record a macro.  Just move the cursor 
  158.      to the thread where you want to record the input; press ESC 
  159.      for the menu; and press Ctrl "\" to specify the name of the 
  160.      macro file to record.  Press Enter to begin recording. 
  161.      
  162.      NOTE:  You must have an enhanced style keyboard to record 
  163.      extended macro directional keys; and all numeric NumPad keys 
  164.      are extended macros by default.  Use the top row number keys 
  165.      to record non-extended numeric keystrokes. You can edit the 
  166.      macro file with a text editor if you don't have an enhanced 
  167.      keyboard and want to record extended macro directional keys. 
  168.  
  169.      If you need to edit an existing Macro, you can use 
  170.      Patternland's Write/File option (use F3 to change the File 
  171.      Mask from *.pnf to *.pxm to display existing macro files, or 
  172.      use F4 to type the name if you know it).  Note that 
  173.      Patternland's File/Write editor is limited to 249 characters 
  174.      per line.  Text mode macro text is usually entered without 
  175.      carriage returns except between paragraphs to allow word 
  176.      wrap to function as you resize the window.  If you do edit a 
  177.      macro file with lines longer than 249 characters, 
  178.      Patternland will insert carriage returns as needed.  You may 
  179.      need to move them to an appropriate place in your text. 
  180.  
  181.  See Also:  Setup/Macros/all options
  182.             the file "Macro.doc" for details on file format
  183.  ______________________________________________________________
  184.  
  185.  
  186.  Command:  Setup/Macros/Stop OR CTRL ESC or [     < SMS >
  187.  Purpose:  Stop recording or playing a keystroke Macro.
  188.  Information:
  189.      This option turns off the Macro recorder.
  190.  Comments:
  191.      With the "hotkey" combination Control ESC you can stop
  192.      recording at any time.  Then, when the macro is played,
  193.      it ends without returning to the Macro menu.  Note:  From
  194.      MS-Windows, PWS.PIF must reserve CTRL ESC; or use CTRL [.
  195.  
  196.  See Also:  Setup/Macros/Record 
  197.  ______________________________________________________________
  198.  
  199.  
  200.  Command:  Setup/Macros/Key line                  < SMK > 
  201.  Purpose:  Toggle the display of the keystroke name status line.
  202.  Information:
  203.      If the Key line option is ON (highly recommended for 
  204.      recording), the Key line appears as soon as you press the 
  205.      first key.  It tells you what key you pressed along with the 
  206.      status of the keyboard.  During Playback the Key line tells 
  207.      you what key will be played next, along with the status of 
  208.      the keyboard.   
  209.  
  210.          Example Key Line showing all possible indicators:
  211.      ╔══════════════════════════════════════════════════════╗
  212.      ║    Key Status Line:    "key" + Shf Ctl Alt CL SL 1   ║     
  213.      ║                          │      │   │   │  │  │  │   ║
  214.      ║    Name of key pressed───┘      │   │   │  │  │  │   ║
  215.      ║        Shift key was down───────┘   │   │  │  │  │   ║
  216.      ║            Control key was down─────┘   │  │  │  │   ║
  217.      ║                 Alt key was down────────┘  │  │  │   ║
  218.      ║                    Caps Lock was ON────────┘  │  │   ║
  219.      ║                       Scroll Lock was ON──────┘  │   ║
  220.      ║                         Keystroke count = one────┘   ║
  221.      ╚══════════════════════════════════════════════════════╝
  222.  
  223.  Comments:
  224.      If you create Extended Macro tutorials which prompt the user 
  225.      for the key to press within the window text, you may wish to 
  226.      turn the Key Line off for playback.  One way to control the 
  227.      status of all Patternland settings when a macro is played is 
  228.      to begin the macro by loading a weaving file which contains 
  229.      the settings as you want them to be at the start of the 
  230.      macro.  This assures you that all recorded keystrokes will 
  231.      result in the actions you intended.
  232.  
  233.  See Also:  Setup/Macros/other options 
  234.  ______________________________________________________________
  235.  
  236.  
  237.  Command:  Setup/Macros/Tutorial                  < SMT > 
  238.  Purpose:  Toggle Tutorial Mode, which gives you three tries.
  239.  Information:
  240.      Tutorial Mode pauses before executing each keystroke (except 
  241.      Timed keys), and waits for the correct key input from the 
  242.      user.  If the first user keystroke is incorrect, Patternland 
  243.      beeps once.  After the second incorrect keystroke, 
  244.      Patternland beeps twice.  With the third incorrect key, 
  245.      three beeps "and you're out": Patternland provides the 
  246.      correct key and moves on to the next one.
  247.  
  248.      Note that the status of the keyboard (Shift, Control, Alt, 
  249.      Scroll Lock, and Caps Lock) must also match the recorded 
  250.      keyboard status for the key to be "correct."  
  251.  Comments:
  252.      This is the mode to use for the Online Tutorial; it is 
  253.      optional for the Demo.  Weaving teachers may find this mode 
  254.      useful in preparing on-line lessons for their students.
  255.  
  256.  See Also:  Setup/Macros/Automatic 
  257.  ______________________________________________________________
  258.  
  259.  
  260.  Command:  Setup/Macros/Automatic                 < SMA > 
  261.  Purpose:  Toggle Automatic Mode, which plays without user input.
  262.  Information:
  263.      Automatic Mode uses the Delay Factor to pause for the 
  264.      specified amount of time before executing each keystroke 
  265.      (except Timed keys, which execute AFTER the timed interval). 
  266.      
  267.      This mode is useful for demonstrations and for "hotkey" 
  268.      macros which you record to create useful threadings and 
  269.      treadlings or perform other commonly used keystrokes.   
  270.  Comments:
  271.      If you set the Delay Factor for a specific extended macro 
  272.      keystroke, that delay is used instead of the overall Delay 
  273.      factor set from the menu.
  274.      
  275.  See Also:  Setup/Macros/Delay 
  276.  ______________________________________________________________
  277.  
  278.  
  279.  Command:  Setup/Macros/Delay                     < SMD > 
  280.  Purpose:  Set Macro Delay.  Value X 100 = Time in milliseconds 
  281.  Information:
  282.      This setting is used by Automatic Mode during playback, 
  283.      unless an extended macro keystroke has a specified delay 
  284.      factor, in which case that value overrides this one.
  285.  
  286.      The Delay factor is in 10ths of a second, i.e., a value of 
  287.      10 = 1 second.  
  288.      
  289.  Comments:
  290.      The maximum allowable delay is 255, or 25.5 seconds.  Use 
  291.      several "do nothing" keystrokes (like ASCII 255--ALT NumPad 
  292.      255) if you require a delay longer than 25 seconds. 
  293.  
  294.      If you set the Delay Factor for a specific extended macro 
  295.      keystroke, that delay is used instead of the overall Delay 
  296.      factor set with this option.
  297.      
  298.  See Also:  Setup/Macros/Record--Delay and Timed 
  299.  ______________________________________________________________
  300.