home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / comlink / Manual / TermInstr
Encoding:
Text File  |  1993-11-07  |  34.4 KB  |  801 lines

  1. ComLink Terminal Mode - Instructions
  2. ------------------------------------
  3.  
  4. Introduction
  5. ============
  6.  
  7. The ComLink program has a terminal mode which has been designed specifically
  8. for packet radio, it allows the user to directly communicate with the TNC
  9. (Terminal Node Controller) via the serial port. ComLink can also run special
  10. script programs, a separate manual describes this feature, you will find
  11. this is the "Script_Man" directory.
  12.  
  13. !ComLink has been carefully written to multi-task effectively. In particular
  14. ARM code is used to speed scrolling of received text. !ComLink is compatible
  15. with RISCOS version 2 and 3.
  16.  
  17. Terminal mode
  18. =============
  19.  
  20. The terminal mode operates under RISCOS within the desktop environment and
  21. is fully multitasking.
  22.  
  23. Facilities incorporated include:-
  24.  
  25.      * A split terminal window with separate tx and rx sections.
  26.      * A configurable number of lines for the rx window.
  27.      * Auto adjustment of rx line count to optimise memory use.
  28.      * 1 to 7 lines (user defined) for outgoing text (tx lines).
  29.      * Full cursor editing of all tx lines.
  30.      * 50 line scrollback facillity in the tx window.
  31.      * Edit and re-send of tx lines.
  32.      * Edit and send of lines from the rx window.
  33.      * Word/number/callsign 'grab' from the rx window.
  34.      * Auto-wrap option to automatically insert "Return" on tx.
  35.      * "Tx + rx" in view or "rx only" on pressing the mouse "Adjust" button.
  36.      * Auto adjustment Tx line count on pressing the mouse "Adjust" button.
  37.      * Programmable function keys with save/load/clear options.
  38.      * On screen "WimpKeys" to run scripts and send commands/text to TNC.
  39.      * Function/wimp key definitions fully editable within windows.
  40.      * Automatic control code insertion when editing function/wimp keys.
  41.      * System variables, such as sys$time, allowed in function/wimp keys.
  42.      * Mouse/icon based upload/download with simple "file dragging".
  43.      * Simultaneous file upload, download and rx buffer save.
  44.      * Optional appending of a fn key definition to end of upload files.
  45.      * Control code "filter" option on download files.
  46.      * Save buffer option to save all rx text in the terminal window.
  47.      * Suspend download option.
  48.      * Abort upload option.
  49.      * Append option, allows download data to be appended to existing files.
  50.      * File dragging to/from other RISCOS applications, eg !Edit.
  51.      * Data transfer statistics displays showing:-
  52.                                                   Spool file size.
  53.                                                   Upload file size.
  54.                                                   Percent sent.
  55.      * Connect alert via serial "Ring Indicator" line.
  56.      * A script can be executed automatically on running !ComLink.
  57.      * User definable colours for the terminal window.
  58.      * ARM code for speed and effective multi-tasking
  59.      * Single line scrolling to give a smoother scroll effect.
  60.  
  61. Getting up and running
  62. ======================
  63.  
  64. ComLink is installed on the icon bar by the usual method of double clicking
  65. on the !ComLink icon in the filer window, this will cause the ComLink icon
  66. to appear on the icon bar at the bottom of the screen.
  67.  
  68. Note that before you can use this terminal program you may need to change
  69. the serial control parameters, these can be viewed and changed with the
  70. "Config" option in the menu, this is described below.
  71.  
  72. The keyboard "Scroll Lock"  MUST be "off" for recieved text to appear in the
  73. terminal window.
  74.  
  75. Click the left (select) mouse button on the !ComLink icon on the icon bar to
  76. display the terminal window. This is described later.
  77.  
  78. Click the right (adjust) mouse button on the !ComLink icon on the icon bar to
  79. display the wimpkey window.
  80.  
  81.  
  82.                               The menu
  83.                               ========
  84.  
  85. Pressing the mouse menu (middle) button with the pointer over the ComLink
  86. icon on the icon bar will pop up a menu with the following options:-
  87.  
  88. Info     =>
  89. WimpKeys =>
  90. Fn Keys  =>
  91. Script   =>
  92. Config
  93. Quit
  94.  
  95.  
  96. Info
  97. ----
  98.  
  99.     Following the Info arrow will pop up the usual "About this program"
  100.     window. The only useful information here is the version number!
  101.  
  102.  
  103. WimpKeys
  104. --------
  105.  
  106.     Following the arrow will provide the following sub-menu:
  107.  
  108.       Display
  109.       Edit
  110.  
  111.     Selection of "Display" will pop up the WimpKey window. Wimpkeys are sort
  112.     of "on screen" function keys. There are two sets of keys in the window
  113.     which have different functions these consist of 8 yellow wimpkeys and 8
  114.     white ones, there are also some control icons.
  115.  
  116.     Selection of "Edit" displays the WimpKey edit window, this allows the
  117.     action and content of the WimpKeys to be defined.
  118.  
  119.     Wimpkeys provide a significant enhancement to the operation of !ComLink,
  120.     in particular, they make operation on "HF" a doddle!
  121.  
  122.     Further details can be found later on in these instructions.
  123.  
  124. Fn Keys
  125. -------
  126.  
  127.     Following the "Fn Keys" menu arrow pops up a sub_menu containing the
  128.     following options:
  129.  
  130.       All sets
  131.       Normal
  132.       Shift+Fn
  133.       Ctrl+Fn
  134.  
  135.     The "All sets" option pops up 3 stacked windows to allow the editing of
  136.     the red function (Fn) key definitions. Use the mouse to position the
  137.     cursor in the window to edit the chosen key.
  138.  
  139.     The remaining three options "Normal", "Shift+Fn" and "Ctrl+Fn" allows
  140.     individual function key edit windows to be popped up.
  141.  
  142.     The default key set is saved in the file Fkey within the ComLink
  143.     application, you may edit this by dragging to !Edit or by saving the new
  144.     definitions by selecting "Save" in any of the function key windows and
  145.     then dragging the file.
  146.  
  147.     Note the format of the file if you are going to use !Edit:-
  148.  
  149.       NFx: means normal fn key x
  150.       SFx: means shift + fn key x
  151.       CFx: means control + fn key x
  152.  
  153.     Not all the definitions need to be included in the file, in this case
  154.     only the ones included will be set up.
  155.  
  156.     The function key definitions can contain system variables in {}
  157.     brackets, eg {sys$time}, {sys$date}, {sys$year} etc. Make sure you get
  158.     the name of the system variable right, otherwise an error will be
  159.     generated! Control codes are automatically inserted as decimal numbers
  160.     in [] brackets, when you press the appropriate keys, eg [13] is the code
  161.     for "Return" and if you press Ctrl+C then [3] will be inserted.
  162.  
  163.     !ComLink provides four new system variables:-
  164.  
  165.     {real$time} which is a copy of time from the CMOS clock chip and not
  166.     from the software copy (which runs slow). The time will be in the format
  167.     "23:15:45".
  168.  
  169.     {full$date} the format is "Saturday 25th July 1992", so the {sys$date}
  170.     and {sys$year} variables can both be replaced by one variable.
  171.  
  172.     Further system variables which may be used are provided by the
  173.     !TimeUtils application within the !Comlink application itself. A help
  174.     file if included within !TimeUtils, this provides details of the
  175.     variables and how to customise the time and data formats.
  176.  
  177.    When a function key is pressed the system variable will be converted to
  178.    the appropriate text string. Control codes will show in the tx window in
  179.    brackets but will be sent correctly to the TNC as the code.
  180.  
  181.    !ComLink function key definitions have a special filetype &56D, double
  182.    clicking these files will automatically load them into ComLink, the key
  183.    definitions are then available for immediate use.
  184.  
  185.  
  186. Script
  187. ------
  188.  
  189.     Following this menu option leads to a sub-menu containing:
  190.  
  191.       Status
  192.       Run
  193.       Stop
  194.  
  195.     "Status" This option pops up a status window as part of the script
  196.     facility. This is described in "Script_Man" the script programming
  197.     manual.
  198.  
  199.     "Run" This option runs the default script called "SCRIPT" saved within
  200.     the !ComLink application.
  201.  
  202.     "Stop" Selecting this option, aborts any script that is currently being
  203.     run. This is described in "Script_Man", the script programming manual.
  204.  
  205.  
  206. Config
  207. ------
  208.  
  209.     Select this option to setup and save the program configuration, the
  210.     serial parameters must be setup to suit your system. The remaining ones
  211.     can be set to your own preferences. Changes to these parameters have an
  212.     immediate effect, excepting the default spool pathname. If you have
  213.     hardwired RS232 handshaking, leave the XON/XOFF option off.
  214.  
  215.     The default spool pathname sets the file path and name that appears in
  216.     the control panel for spooling. The path you enter here only has an
  217.     effect when saved and then only when ComLink is next run, thus the only
  218.     effect is to change the "Config" file in the ComlLink applications
  219.     directory. This file is always examined by ComLink when it is first run.
  220.  
  221.     The program/terminal functions switch on/off 2 options and allows the
  222.     number of lines in the tx area to be set.
  223.  
  224.     Line wrap when "ON" will cause the automatic insertion of "Return"s when
  225.     a line is typed in the tx area that is longer than 76 characters. The
  226.     line will be broken at the last space in the line. If there are no
  227.     spaces in the line then it will be cropped at the 77th character. The
  228.     characters that are cut off the end are automatically put on the next
  229.     line. This feature is particularly useful for live QSOs and for short
  230.     messages to PMSs etc. If you don't want to use this feature the switch
  231.     the option off. When "OFF" the program will run slightly faster, but you
  232.     probably won't notice this.
  233.  
  234.     The "Connect monitor" when "ON" will cause the ComLink icon to turn
  235.     amber  and generate a beep when a connection is made at your TNC. This
  236.     function will only work if you have the "Ring Indicator" line at the
  237.     Archimedes wired to your TNC. If you don't have this connection made
  238.     then leave this option "OFF".
  239.  
  240.     The "Colours" option pops up a palette window and allows the colours
  241.     used in the terminal window to be defined. Select "Tx fg" etc icon then
  242.     the chosen colour. Tx and Rx stands for the tx and rx areas
  243.     respectively, fg and bg stands for foreground and background
  244.     respectively. When changing the colours, the terminal window will pop up
  245.     if not already on the screen, this allows the effect of colour changes
  246.     to be seen immediately. The caret colour is controlled by the wimp
  247.     software, a red caret can only be obtained on a white background (unless
  248.     you edit the pallete!).
  249.  
  250.     Tx lines sets the number of lines in the tx area of the window. The
  251.     value can be 1 to 7. Changing the value will only have an effect if you
  252.     click the mouse "adjust" button once or twice in the terminal window.
  253.  
  254.     Rx lines shows the number of lines in the rx window. This cannot be
  255.     changed when the program is running, it is necessary to edit the file
  256.     "Config" in the !ComLink application directory. (Change the number after
  257.     RLINES:) !ComLink optimises the use of memory allocated by the task
  258.     manager and may allocate more or less than that specified, depending on
  259.     available memory.
  260.  
  261.     Upload append, selects which (if any) function key definition you want
  262.     appended to the end of upload files. This can be set to "None" or F1 to
  263.     F11. I normally set it to F11, and make this Fn key into a sign-off
  264.     line, eg.
  265.  
  266.     [13]73's de Alan. Sent on {sys$date} {sys$year} at {sys$time}[13]/ex
  267.  
  268.     (Note that a 'return' will automatically be added to the end of the fn
  269.     key when uploading.)
  270.  
  271.     Select "Save" to automatically update the Config file in the Comlink
  272.     directory. Next time you load ComLink, these parameters will be used.
  273.  
  274. Quit
  275. ----
  276.  
  277.     As might be expected, selecting this option quits the program!
  278.  
  279.  
  280.                           The Terminal window
  281.                           ===================
  282.  
  283. Selecting the !ComLink icon on the bar pops up the terminal window, this
  284. window consists of two areas, received text is displayed in the upper light
  285. grey (rx) area, text to be transmitted can be typed into the lower, white
  286. (tx) area. The maximum number of lines in the tx area can be chosen using
  287. the "Config" option described later. The window colours can be changed via
  288. the "Config" menu option.
  289.  
  290. To receive text, you must have the correct serial control parameters setup,
  291. these can be changed and saved via the "Config" menu option.
  292.  
  293. Only 'printable' ASCII characters in the range 32 to 127 will be sent to the
  294. screen. Linefeed codes (ASCII 10) are ignored. CTRL-G codes (ASCII 7) will
  295. cause a beep to sound.
  296.  
  297. Clicking select in the tx area will place the caret (cursor) on the line
  298. pointed to by the mouse: this allows lines to be edited in the normal way.
  299. You can move up, down and along the lines using the cursor keys. The caret
  300. will always be placed at the end of the line when the up/down keys are used.
  301.  
  302. There is a 50 line tx buffer so you can scroll through these lines using the
  303. cursor keys. These will scroll the window one line at a time.
  304.  
  305. The 'Page Up/Down' keys scroll the complete tx/rx window 'n' lines at a
  306. time, where 'n' is the number of lines in the window.
  307.  
  308. When lines are typed in, the text is not sent until you press "Return",
  309. the exception to this is the control codes which are immediately sent. This
  310. allows Ctrl+C etc to be typed. If the caret is on the bottom line the lines
  311. in the tx window will scroll up and the line will be cleared. Using
  312. "Shift+Return" will prevent the next line in the buffer from being
  313. cleared, this allows you to scroll back over the tx lines and re-send them
  314. without lines getting cleared.
  315.  
  316. Pressing the mouse 'menu' button with the pointer over the terminal window
  317. causes the Spool Control Panel to appear, this is described later.
  318.  
  319. Pressing "Shift and the mouse 'menu' button with the pointer over the
  320. terminal window causes the main menu to be popped up. The Quit option will
  321. be shaded to prevent accidentally quitting.
  322.  
  323. Files for upload may be dragged to the window or the ComLink icon and will
  324. be sent to the TNC, a status window will pop up automatically to allow the
  325. file to be sent/aborted and progress to be monitored . To start upload you
  326. must click one of  the "Send" icons.
  327.  
  328. The scroll bars may be used in the normal way to position the "viewing area".
  329.  
  330. The mouse adjust (right) button performs a number of functions when the
  331. pointer is over the terminal window:-
  332.  
  333.    - It scrolls the screen to alternately show tx+rx sections of the window
  334.      or only the rx section, at each click.
  335.  
  336.    - It automatically resizes the tx area according to the height of the
  337.      window. (If you don't like this feature, then just use the scroll
  338.      bars!)
  339.  
  340. These features are particularly useful when the window has been resized,
  341. since you can quickly click adjust to see the tx area again, or if you only
  342. want to "Monitor" then you can easily display the rx area only.
  343.  
  344. Double clicking the select (left) mouse button in the grey area of the
  345. window will grab a word from the rx area and place it in the 'selected'
  346. (green) wimpkey. The original wimpkey label can be restored either by using
  347. the 'RST' icon or by cycling up and down the keyset count.
  348.  
  349. A 'click and hold' or 'click and drag' of the select (left) mouse button in
  350. the rx window will, after a brief delay, grab a line and place it on the
  351. lowest line in the tx window. The line can then be editted as normal and
  352. sent.
  353.  
  354. Scrolling in the terminal window can be stopped by pressing and holding
  355. the Ctrl+Shift keys together. Scrolling will also stop if "Scroll Lock" is
  356. "on", watch out for this and don't leave it on accidentally or you may think
  357. !ComLink has 'hung up'!
  358.  
  359. Pressing Ctrl+Esc sends a break signal to the TNC but only if the terminal
  360. window has the input focus, this will get the TNC out of transparent mode.
  361.  
  362.  
  363.                         Spool Control Panel
  364.                         ===================
  365.  
  366. This window is popped up by pressing the mouse menu button over the terminal
  367. window. The definition of 'spooling' here is the saving of all received
  368. data.
  369.  
  370. Click OK to start spooling or drag the file icon to a filer window. You can
  371. of course edit the file name/path if you want. As usual if you drag the file
  372. icon to a window then the file path will be updated.
  373.  You also have the following options to select, "Filter on", "Save buffer",
  374. "Suspend" and "Append". The file name/path that appears as the default can
  375. be changed using the menu "Config" option. As supplied the default is
  376. "RAM:$.Spool", of course the RAM drive must be active to use it.
  377.  
  378. When the "Filter on" option is selected, the usual text file type icon is
  379. shown and control codes are removed from the incoming data. All carraige
  380. return codes are converted to linefeeds to be compatible with !Edit. Any
  381. line feeds received are left in. With the filter option "OFF" the file
  382. icon in the window changes to a data type. Now all characters received will
  383. be spooled to the file, none are changed or removed. Thus if you are
  384. transferring data such as non-coded programs, leave this option "OFF".
  385.  
  386. If the filter option is changed while a spool is in progress, the icon in
  387. the window will change type, but the actual file that is being spooled to
  388. will not have it's icon type changed. The filter option will however affect
  389. the data saved.
  390.  
  391. The "Save buffer" option can only be selected before a spool starts and will
  392. cause all text in the rx area to be saved to the spool file first, then all
  393. subsequently received data. This option is handy when reading messages and
  394. you suddenly decide you'd like to keep the text, but some of it has already
  395. been printed on screen. When a spooling operation is stopped, ie the file
  396. is closed, then this option will automatically be turned off.
  397.  
  398. The "Suspend" option can be used to temporarily stop the received text/data
  399. from being spooled to a file, the file remains open though. This option will
  400. automatically be switched off when the spool file is closed.
  401.  
  402. The "Append" option allows the received text/data to be appended to the end
  403. of an existing file. Unless this option is switched "ON" ComLink will not
  404. let you spool to an existing file. If the "append" option is "ON" and the
  405. file does not exist then an empty file will be created.
  406.  
  407. The size of the spool file is shown in the control window, this is updated
  408. by ComLink as the file grows. If the append option is "ON" the size of the
  409. whole file will be shown and not just the received character count. If the
  410. "Save buffer" option was "ON" then the file size includes the buffer.
  411.  
  412. To start a spool operation, make sure the filepath/name is as desired, then
  413. either drag the icon to a directory window or click on "OK", the OK will
  414. then change to "Close". Dragging the file to a filer window will cause the
  415. file path to be updated appropriately.
  416.  
  417. While spooling to a text file, the file is kept open by ComLink and will
  418. appear as a "text" type icon but with a red pen, it cannot be loaded into a
  419. text editor until the spool file is closed. If you are spooling this means
  420. that to examine the file with !Edit you have to "Close" the file first.
  421. One way of preventing any text received from being missed from the file, yet
  422. still enable to see the text spooled so far, is to hold down Shift+Control
  423. and while keeping these keys down, perform the following :-
  424.  
  425.   Click on "Close" hence closing the file
  426.   Drag the appropriate file to !Edit
  427.   Enabling spooling again by clicking "OK".
  428.  
  429. This works because while Shift+Ctrl are held down, no characters will be
  430. fetched from the serial port, hence none will be missed out in the spool
  431. file.
  432.  
  433. To end spooling, click on "Close".
  434.  
  435. The file icon in the spool window can be dragged directly to an application
  436. such as !Edit: this may be done without affecting spooling. The data
  437. transferred will be the contents of the rx window. This type of operation
  438. can be useful for "look what I've just recieved" type QSOs, since sections
  439. of the text can be selected within !Edit and the "Select/Save" menu options
  440. used to transfer the data back to the terminal window for sending. If only a
  441. few of the received lines are to be sent you can use the 'line grab'
  442. facility in the rx window, just click and hold the mouse select button on
  443. the line to be sent, this will appear in the tx window and may be
  444. editted/sent.
  445.  
  446.  
  447.                         Uploading files
  448.                         ===============
  449.  
  450. To send a text or data file, all you need to do is drag the file to the
  451. terminal window or to the ComLink icon on the bar. This will cause a small
  452. window to be popped up showing the filename (but not the path), the size of
  453. the file and the percentage sent. The upload can be aborted or started by
  454. clicking on "Abort" or "Send" or "Send+Fkey" as appropriate. The percent
  455. sent will be updated as the upload progresses. If "Send+Fkey" is selected
  456. then at the end of the upload, the chosen function key definition will be
  457. sent. This is handy when sending files to a BBS/PMS as you can put a sign
  458. off message in one of the function keys.
  459.  
  460. You can drag files directly from other applications such as !Edit, but a
  461. maximum of 8Kbytes can be transferred in this way. If the file is longer,
  462. only the first 8Kbytes will be sent.
  463.  
  464. Files dragged from filing systems, RAM disc, floppy disc etc can be of any
  465. length.
  466.  
  467. Note that if you have accidentally dragged the wrong file for upload, you
  468. don't have to abort it, just drag the correct one over and the file details
  469. will be updated.
  470.  
  471. Note also that when you have dragged the file, you must click on "Send" to
  472. start the upload. A file upload can be aborted at any time. If a file upload
  473. is started and aborted before it has been completely sent, the function key
  474. definition will still be sent.
  475.  
  476. WIMPKEYS
  477. ========
  478.  
  479. A wimpkey window can be popped up on the screen, either by clicking the
  480. right (adjust) mouse button on the !ComLink icon on the icon bar, or by
  481. selecting the WimpKeys 'Display' option in the menu.
  482.  
  483. The terminal window is of course popped up by clicking the left (select)
  484. mouse button on the !ComLink icon on the icon bar. (The menu option to
  485. display the Terminal window has been removed!)
  486.  
  487. The wimpkey window will be conveniently positioned if you first open the
  488. terminal window and then the wimpkey window. The wimpkey window can be moved
  489. around the screen as desired, or pushed partially off screen.
  490.  
  491. In mode 12, not all of the Wimpkey window will be visible, it is best to use
  492. the mode 86 or mode 90 application provided to obtain a slightly wider
  493. screen. Indeed this is sensible anyway to be able to get an 80 column wide
  494. window.
  495.  
  496. Wimpkeys are sort of "on screen" function keys. There are two sets of
  497. keys in the window which have different functions these consist of 8 yellow
  498. wimpkeys and 8 white ones, there are also some control icons.
  499.  
  500. Wimpkeys provide a significant enhancement to the operation of !ComLink, in
  501. particular, they make operation on "HF" a doddle!
  502.  
  503. When first run !ComLink loads the WimpKey definitions from the 'WimpKeys'
  504. directory within !ComLink. It will look for files with names in the range 1
  505. to 8.
  506.  
  507. The WimpKey 'definitions' are stored in program memory for quick access to
  508. each set without disc access being required.
  509.  
  510. Each yellow WimpKey can:-
  511.      - Send up to 128 characters to the TNC (stored in program memory)
  512.      - Run a script
  513.      - Send a file to the TNC
  514.  
  515. Read these instructions and then to have a fuller appreciation of the
  516. possibilities, have a play!
  517.  
  518. Icon functions
  519. --------------
  520.  
  521. The text on any key can be up to 9 characters, and is specified in scripts
  522. using the command "WKEY:". Up to 8 sets of keys can be defined.
  523.  
  524. The orange (or is it amber!) numbered icon allows a number of keys sets to
  525. be cycled through. The number will increment each time the icon is
  526. clicked with 'select' and decrements when clicked with 'Adjust'.
  527.  
  528. The directory icon, opens the "WimpKey" directory that holds the
  529. scripts/files used. This allows easy access for examination and
  530. modification.
  531.  
  532. Up to 8 basic sets of yellow keys can be set up. The scripts that define the
  533. labels in the keys are found in the "WimpKey" directory within !ComLink,
  534. they can have filenames "1" to "8". Not all these need be present, if only
  535. "1","2" and "3" are present, then only 3 sets will be available.
  536.  
  537.  
  538. Yellow wimpkey operation
  539. ------------------------
  540.  
  541. The yellow keys, when clicked (selected), can either cause a script to run,
  542. or cause some text or a file to be sent to the TNC directly.
  543.  
  544. The WimpKey definitions can be modifed and saved by using the edit window,
  545. this can be popped up using the "Wkey Def" menu option or by clicking the
  546. "Menu" button with the pointer over the WimpKey window.
  547.  
  548. Wimpkey scripts tend to be very simple, often only containing text to be
  549. sent to the TNC. Have a look at the script called "1" in the "Wimpkeys"
  550. directory within !ComLink to see the how the key definitions are done.
  551.  
  552. White wimpkey operation
  553. -----------------------
  554.  
  555. The white wimpkeys have a different type of function. The label text may be
  556. set within scripts in exactly the same way as the yellow ones.
  557.  
  558. The keys are numbered 11 to 18 from left to right. This means that the white
  559. wimpkey 11 is below yellow key 1, 12 is below 2, 13 is below 3, etc.
  560.  
  561. The white keys ONLY set string system variables which may be used in
  562. scripts. (Further details follow later)
  563.  
  564. When "clicked" with the left (select) mouse button one of the keys will be
  565. highlighted as "green".
  566.  
  567. When "clicked" with the right (adjust) mouse button, the key will gain the
  568. caret and the text may be editted. Pressing "Return" or "clicking" the icon
  569. will return the icon to it's original state (green or white). If the
  570. !ComLink terminal window is displayed at the time "Return" is pressed, it
  571. will automatically gain the caret.
  572.  
  573. White wimpkeys - system variable "wkey$var"
  574. -------------------------------------------
  575.  
  576. If you are familiar with scripts or the function key facilities of
  577. !ComLink, then you may have used system variables such as "sys$time",
  578. "sys$date" etc.
  579.  
  580. !ComLink places the label text in each white wimpkey into a system variable
  581. that may be used in scripts or in function keys.
  582.  
  583. ComLink puts the label text of the wimpkey that is set "green" into system
  584. variable "wkey$var". "So what!", you may say, well read on and the
  585. significance will become apparent!
  586.  
  587. This facility is used in wimpkey set "2", provided with the application. The
  588. white wimpkeys are set to the letters A - H. Selecting one of them, and the
  589. clicking the "Stream" yellow wimpkey will result in the selected letter
  590. being used to select the TNC stream, you will see the stream switch
  591. sequence appear in the tx window.
  592.  
  593. As another example of use is given in set 3, a callsign can be selected and
  594. then the "Connect" wimpkey pressed.
  595.  
  596. Assume that the white wimpkeys are set to:-
  597.  
  598. G3TKF
  599. G4HWT
  600. G6DEN
  601. ....
  602.  
  603. Now, if the white wimpkey G6DEN is selected and goes green, then if the
  604. yellow key "Connect" is clicked, then the text "C G6DEN" will be sent to the
  605. TNC. Thus we have a means of selecting a callsign, and then connecting with
  606. just the click of two wimpkeys!
  607.  
  608. Another yellow wimpkey is set to "Connect-2".
  609.  
  610. Now, using the same technique of selecting a callsign, and clicking the
  611. "Connect-2" yellow key, the text "C G6DEN-2" is sent to the TNC.
  612.  
  613. The above is illustrated in wimpkey set 3 provided with the application.
  614. Edit wimpkey set 3 to set your local callsign contacts.
  615.  
  616. Using the mouse right (adjust) button on the white key allows the text to be
  617. changed as mentioned previously. Though of course it may subsequently get
  618. overwritten as you cycle throgh the key sets. If you dont want a particular
  619. white key definition to get changed in this way, leave it out of all the key
  620. set scripts!
  621.  
  622. Using the 'select' mouse button over the rx window allows words, callsigns
  623. or numbers to be grabbed and inserted into the selected (green) wimpkey.
  624. This allows, for instance, the "Connect" callsign to be selected, of message
  625. numbers to be selected for reading/killing. Play with WimpKey set 5 provided
  626. to see the possiblities! Nb. The grabbed text will be overwritten as you
  627. cycle throgh the key sets.
  628.  
  629. White wimpkeys - system variable "wkey$1" to "wkey$8"
  630. -----------------------------------------------------
  631.  
  632. The label text in all the 8 white wimpkeys is also put into 8 system
  633. variables "wkey$1" to "wkey$8". These may also be used in scripts. This
  634. function is provided primarily for HF users. Thus the first white wimpkey
  635. may be editted with the right mouse button to read as a trucated callsign,
  636. say "GTKF" and the second to read "G3TKF". Then the wimpkey system
  637. variables, wkey$1 and wkey$2 can be used in the scripts as appropriate.
  638.  
  639. Further insructions on HF operation are provided in text file "HF_instr".
  640.  
  641.  
  642.                         WimpKey Edit window
  643.                         ===================
  644.  
  645. Clicking 'menu' over the WimpKey panel or selecting the WimpKeys 'Edit'
  646. option in the main menu pops up the wimpkey edit panel.
  647.  
  648. The key 'type' can be changed from 'None' to 'File' to 'Script' to
  649. 'Text'. The label can be different from the text/file name definition.
  650.  
  651. Control codes and system variables can be included in the text definitions.
  652.  
  653. The 'Yellow keys' button swops to the 'White keys' as desired to allow these
  654. to be viewed/altered.
  655.  
  656. The 'Use' button makes !ComLink use any changes you have made, without
  657. saving the new definitions to disc.
  658.  
  659. The 'Save' button..... saves the new definitions to disc and also makes
  660. !ComLink use the new definitions.
  661.  
  662. The 'Clear' button clears the definitions on view, without the results
  663. taking effect, the old definitions can be recovered using the 'Restore'
  664. button. After a 'Save' or 'Use' the old definitions can not be restored!
  665.  
  666. If you type in a label for a 'File'/'Script'/'Text' type key but not the
  667. definition and then press 'Use' and 'Restore', then the definition field
  668. will be filled in for you using the label as the file name/text.
  669.  
  670. Text string must end in [13] to be sent. Just pressing any control sequence
  671. eg 'Return' key will enter the code in the definition string.
  672.  
  673. Clicking 'Select' on the WimpKey Set increments the set number, clicking
  674. 'Adjust' decrements it.
  675.  
  676.  
  677.                    WimpKeys - advanced features
  678.                    ============================
  679.  
  680. An advanced feature of WimpKeys, is that any script can actually redefine
  681. one or more of the keys. Thus one wimpkey can run a script which results
  682. in some or all of the wimpkeys to be redefined! This is particularly useful
  683. for more complex TNC operations such as HF use, where a wimpkey "AMTOR",
  684. could define a different key set to say a "RTTY" wimpkey.
  685.  
  686. The same method can be used to set up a key to form a toggle action which
  687. say alternates between "MON_ON" and "MON_OFF".
  688.  
  689. The operating system string comparison and evaluation operators:-
  690.  
  691. if .... then .....
  692. seteval ..........
  693.  
  694. may be used to good effect in scripts, examples are provided in wimpkey set
  695. 4, provided with the application. These examples are relatively benign, and
  696. you can experiment with them without upsetting your TNC.
  697.  
  698.  
  699.                        Wimpkeys RST function
  700.                        =====================
  701.  
  702. Of course, the flexibility of wimpkeys has a price to be paid, it is
  703. possible to get in a right pickle, and not be able to get the basic keys
  704. back to there original definition for that key set, this is where the red
  705. "RST" key comes in handy!
  706.  
  707.  
  708.                       !WimpKeys application
  709.                       =====================
  710.  
  711. The scripts that are run when a wimpkey is clicked can reside either in the
  712. "WimpKeys" directory in !ComLink, or within the !WimpKey application
  713. directory.
  714.  
  715. The scripts must be available to !ComLink at all times since they are
  716. read directly from disc each time they are used. This may be inconvenient to
  717. floppy users since it means that the !ComLink disc will have to be in the
  718. drive. The !Wimpkeys application gets around this problem and allows the key
  719. sets to be kept in a RAM drive, thus disc swopping can  be avoided.
  720.  
  721. To make !ComLink use the scripts in the !WimpKey application, first run
  722. !ComLink, then copy the !WimpKeys application into a RAM drive (minimum size
  723. is about 48K). Double click the !WimpKey application and from that point
  724. onwards !ComLink will use the scripts from the RAM drive.
  725.  
  726. Hard disc users will find no significant advantage in using the !WimpKeys
  727. application.
  728.  
  729.  
  730.                         General hints and tips.
  731.                         =======================
  732.  
  733. The use of {} and [] brackets
  734. -----------------------------
  735.  
  736. The {} and [] brackets have a special meaning to ComLink when typed in or
  737. used in function key definitions. This provides a very flexible way of
  738. handling system variables and control codes, yet otherwise hardly limits
  739. their normal use as ordinary characters (This was not true for versions of
  740. ComLink prior to 3.01.).
  741.  
  742. The {} brackets can be used to contain contain system variables and ComLink
  743. will expand them for you, if the variable does not exist then an "Unknown
  744. operand error at line xxxxx" error message will be generated. However you
  745. can use the brackets IF THEY DO NOT INCLUDE A $ SIGN, without an error being
  746. generated, in this case the text will be sent as typed. Examples:-
  747.  
  748. {sys$time} - this is a standard system variable so will be converted to the
  749.              time eg "12:18:02"
  750.  
  751. {abc$xyz} -  this is very likely to cause an error!
  752.  
  753. {hello there} - this will be sent as typed, eg "{hello there}"
  754.  
  755.  
  756. The [] brackets are used to send control codes or characters in the
  757. range 0 to 255. ComLink tries to act intelligently, so if the contents of
  758. the [] brackets is longer than 3 characters it will NOT try to convert it
  759. into a control code! This means that the standard ID's can be typed which
  760. identify TNC types eg [YFB-3.42-BHR$] etc.
  761.  
  762. Furthermore {}/[] brackets MUST occur in pairs to be expanded from the
  763. system variable/converted to a control code, as soon as an "odd" bracket
  764. is found ComLink will stop trying to interpret the rest of the line. All this
  765. means is that you can use the brackets normally in most cases without getting
  766. odd effects.
  767.  
  768.  
  769.                   Executing a script on application startup
  770.                   =========================================
  771.  
  772. If a script with filename "0" exists in the 'WimpKeys' directory within the
  773. !ComLink application, then it will be executed each time !Comlink is run.
  774. This is a simple and handy way of configuring your TNC ready for
  775. communication. You can examine the script with !Edit and alter it as
  776. required.
  777.  
  778.  
  779.                             General tips
  780.                             ============
  781.  
  782. A useful control code to remember is Ctrl V, which can be used to set
  783. multiple line parameters on the TNC. To insert it in a line you must type
  784. it as [22].
  785.  
  786. Pressing Ctrl+Shift together will halt the scrolling in the terminal
  787. window.
  788.  
  789. The contents of the rx area can be saved directly to !Edit at any time by
  790. dragging the file icon in the "Spool Control Panel" to the !Edit icon.
  791.  
  792. Don't forget that full cursor editing can be performed in the tx area, this
  793. is very handy if you want to send the last line typed again, just tap the
  794. "up" cursor control arrow (or is it a caret control arrow on the Arc.!) and
  795. then hit "Return". Ctrl+U clears a line.
  796.  
  797. ComLink incorporates an advanced script language making it relatively easy to
  798. write routines to perform tasks like automatic logon and download of mail
  799. and messages from a BBS or PMS. For more information read the manual called
  800. "Script_Man"
  801.