home *** CD-ROM | disk | FTP | other *** search
/ Hacks & Cracks / Hacks_and_Cracks.iso / hackersguides-&-software / whale22r.zip / WHALEX.TXT < prev   
Text File  |  1994-12-31  |  46KB  |  1,183 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9. Whale Express
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27. Information in this document is subject to change without notice and does not represent a commitment on the part of Tartan Software.  No part of this document may be copied or reproduced by any means without the prior written consent of Tartan Software.  Tartan Software assumes no responsibility for any errors which might appear in this document.
  28.  
  29. This edition applies to Whale Express version 1.5
  30.  
  31. The Software, Whale Express and accompanying written materials are provided "as is" without warranty of any kind.  Tartan Software has made reasonable effort to assure it's safety and worthiness. but will not be responsible for damage exceeding the price paid for using the Software.
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43. Copyright ⌐ 1993-1994 Tartan Software.
  44.  
  45. All Rights Reserved
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57. C-Room is a trademark of Tartan Software
  58. America Online is a service mark of America Online Inc.
  59. Microsoft is a registered trademark of Microsoft Corporation.
  60. Windows is a trademark of Microsoft Corporation.
  61.  
  62.  
  63.  
  64.  
  65.  
  66. Table of Contents
  67.  
  68.  
  69. What is Whale Express............................................    3
  70.  
  71. Getting Started............................................................    3
  72.         What is a Whale Express File...........................    4
  73.         Command & Data...............................................    5
  74.          Things to Notice..................................................    6
  75.         Running a Whale Express (wex) file................    7
  76.  
  77. Whale Express Commands........................................    9
  78.  
  79. Command Variables...................................................    21
  80.  
  81. Time, Date, Input Variables........................................    37
  82.  
  83. Common Questions & Answers................................        38
  84.  
  85. Appendix A:  ReadList................................................    39
  86.  
  87. Appendix B:  Sample Files..........................................    41
  88.  
  89. Ordering Whale Express............................................    44
  90.  
  91. WHAT IS WHALE EXPRESS?
  92.  
  93. Whale Express is an example of an "application specific" scripting language.  Whale Express is custom designed to work with America Online for Windows.  While a number of scripting languages already exist in the Windows market, most are complex and require programming experience on the part of the user.  Whale Express is designed using K.I.S.S.(Keep It Simple Stupid) technology.  While future versions may include complex programming structures, this version uses knowledge of WAOL to include conditional information within Whale Express.
  94.  
  95. The free trial size version of Whale Express is available for downloading on America Online.  The only charge is the short time required for downloading. This free version of Whale Express is fully functional but is limited to 10 commands per script.    If you find yourself using Whale Express often, you'll probably wish to order the pro-version for a small fee.  Ordering is simple and an order form is available by clicking here.
  96.  
  97. Distribution of Whale Express is done strictly through America Online via electronic mail.  There are a number of advantages to ordering Whale Express and being a registered user.  Most importantly, you'll be eligible for support via electronic mail on America Online.  Tartan Software will also be sure you receive any maintenance and incremental feature releases of Whale Express.  Be sure to include your screen name when ordering. 
  98.  
  99.  
  100. GETTING STARTED
  101.  
  102. First let me assure you that you don't have to be a computer programmer to use Whale Express.  It's easy to create straight forward, easy to use macro files which will save you time while using America Online.
  103.  
  104. Probably the best way to understand how to create your own scripts is to read this document, and then review the sample macro scripts we've included with Whale Express.  All of the scripts are documented under the online Help and are completely safe to use online.
  105.  
  106. Some scripts are useful in that you can use them to sign you on to America Online, perform requested functions, and sign off.  Other scripts are run when you're already online. For example, the forward.wex script is only used when you've recently read a mail message.
  107.  
  108. WHAT IS A WHALE EXPRESS FILE?
  109.  
  110. You'll notice that all Whalex scripts have the suffix,  .WEX.  This is used to indicate a Whale Express script, even though a WEX file is the same as an ASCII text file.  Our program provides a full Windows style editor to view and edit your work.  You're not required to use this editor to create or edit scripts.  Since these files are ASCII text,  most any text editor will do.  If you're more comfortable using your favorite DOS editor, or even Windows 
  111. Notepad, you'll be fine.
  112.  
  113. A WEX file is made up on a sequence of instructions.  Each line of the file contains a new instruction.  Each instruction is processed one at a time, starting with the first line.  Each one of these instruction lines contains two parts,   the command and the data.  No special characters are required.  The command and data are separated by one or more spaces.
  114.  
  115. The syntax of a Whale Express instruction is straight forward and easy.  Many of the internally built application specific commands provide the error checking and conditional responses needed for useful scripting.  This allows scripts to be short and easy with as few commands as necessary.  The following is the simple syntax of a Whale Express instruction:
  116.  
  117. Command         Data
  118.  
  119. * There must be at least one space between the Command and its data.
  120.  
  121. * Only one instruction per line.   
  122.  
  123. * Data strings DO NOT require any quotes for delimiters.  If you include quotes, they will be taken literally as quotes.
  124.  
  125. * The Whale command processor is case insensitive so you don't have to worry if your capitalization matches the examples in this document.
  126.  
  127. * Many data fields have default values so data is optional or not required.
  128.  
  129. * In many cases, the full text is not required in the data field. Whale Express allows partial text matches.
  130.  
  131. COMMAND & DATA
  132.  
  133. A complete list of commands is available in the online help.  Most relate directly to operations you're familiar with online.  Some examples include; Keyword,  Menu, SelectButton, Signon, SendText, and others.
  134.  
  135. The data portion of the instruction line varies depending on the command but is often, a filename,  text label, or control number.
  136.  
  137. Some scripts are useful in that you can use them to sign you on to America Online, performs requested functions, and sign off.  Other scripts are run when you're already online. For example, the forward.wex script is only used when you've recently read a mail message.
  138.  
  139. Suppose you're online, and you'd like to attend a conference in the Windows chat room.  Here's a simple script which will take you there. 
  140.  
  141. Keyword  Windows
  142. SelectIcon    Conference
  143.  
  144. Perhaps this doesn't seem like it would be very helpful.  It only saves you from a couple clicks right?  Well, it also saves you from staring at the computer screen waiting when the system performance might be a little slower than normal.
  145.  
  146. You might want to go ahead and add some additional instructions.  If you already know you're planning to attend the Windows conference, you might add the Signon command to the beginning of your script.  If you're already online, the Signon command is ignored so you can still use this script.  You might also want to add an automatic greeting when you enter the room.  This can be done with the SendText command.  This command will send text to an AOL chat room just as if you typed it in.  So, we end up with the following.
  147.  
  148.  
  149. Signon
  150. Keyword Windows
  151. selecticon Confer
  152. SendText  Hi everyone,  What's the topic tonight?
  153.  
  154. So,  here we have four simple instructions which will get you online, and get you started while you go grab a snack,  stop by the little boy's or girl's room, or explain to your spouse why you need to use the computer.
  155.  
  156. THINGS TO NOTICE
  157.  
  158. You'll notice a few things about the macro script we created on the previous page. If you look at the Signon instruction you'll see there is no data.  Not all commands require a data field.  In the case of Signon, if you don't specify the number of your account name, we'll default to the last account you used to access America Online.
  159.  
  160. There are no quotes in the text we used in SendText.  This is something programmers are used to, but not required for Whale Express.  Everything after the last space after the command is considered data.
  161.  
  162. You might also notice that the "selecticon" command isn't capitalized in this example.  Whale Express doesn't care whether you capitalize it or not.  
  163.  
  164. The same is true with the word Conference.  You don't have to know the exact capitalization used by AOL and you won't even need the complete word.  The first icon with the text you provide will be used.    You setup your instructions so they are visually appealing to your own tastes. 
  165.  
  166.  
  167. RUNNING A WHALE EXPRESS(WEX) FILE
  168.  
  169. Under the File menu, you'll find the item,  "Run".  Selecting Run bring up the standard File open dialog which allows you to select the Whalex macro file you want to execute.  Just find the WEX file you want to run, and select the OK button.
  170.  
  171. Anytime you run a WEX file successfully, the name of the file will be added to the Express menu.  This allows you quick access to those macros which you use most often.  Up to 10 WEX files will be stored here. 
  172.  
  173. The F3 key can be used to abort a script in progress.
  174.  
  175.  
  176. FILE / EDIT MENUS
  177.  
  178. You'll find that the File and Edit menus with our program work just like ever Windows program. Using the File New, Open and Save allows you to create, view and edit Whalex files.  The Edit menu also provides the same abilities to Undo, Cut, Copy and Paste the text when your editing a Whale Express file.
  179.  
  180.  
  181. OPTIONS MENU
  182.  
  183. "Stay on Top" is something you turn on or off.  This tells our program that you want the Whale Express program to always be visible and not blocked by other windows on your desktop.
  184.  
  185. "Save Settings" tells Whale Express to remember it's size and position for the next time you use the program.
  186.  
  187. "Font" allows you to select the font and font size to use used when editing WEX file.
  188.  
  189.  
  190. EXPRESS MENU
  191.  
  192. "NewScreenName" is a built in macro which will sign you off-line, and back on again using a new account name.
  193.  
  194. "Instant Message" is another built in macro which allows you to keep others from sending you Instant Messages which might disturb you while you're running your macro.
  195.  
  196.  
  197. HELP MENU
  198.  
  199. When in doubt,  use the online Help to learn more about each of the Whale Express commands. 
  200.  
  201.  
  202. Whale Express Commands
  203.  
  204. AddText
  205. Begin
  206. BitmapBitmap
  207. CallCall
  208. CloseChatLogCloseLog
  209. CloseLogCloseLog
  210. CloseWindowCloseWindow
  211. Copy
  212. Cut
  213. Download
  214. ErrorDownload
  215. ExecExec
  216. ExitExit
  217. InstantMessageInstantMessage
  218. KeywordKeyword
  219. MenuMenu
  220. MessageMessage
  221. Movie
  222. NewScreenNameNewScreenName
  223. OnErrorOnError
  224. OpenChatLogOpenChatLog
  225. OpenLogOpenLog
  226. PausePause
  227. PastePaste
  228. PasteFilePasteFile
  229. PlayWavPlayWav
  230. RemRem
  231. ReadListReadList
  232. Repeat
  233. QuitQuit
  234. SelectButtonSelectButton
  235. SelectEditSelectEdit
  236. SelectIconSelectIcon
  237. SelectListSelectList
  238. SendMailSendMail
  239. SendTextSendText
  240. SetTextSetText
  241. SignOn
  242. Upload
  243.  
  244. AddText
  245.  
  246. AddText        Text message
  247.  
  248. This command will add your text to an edit field with the current focus, just as if you had typed it in.  Use SelectEditSelectEdit if needed to set the focus to the desired AOL edit field.
  249.  
  250. AddText also adds End of Line characters so that multiple AddText commands can be used within the same Edit field.  Unlike SetText, this command will not replace the text currently in the edit field.
  251.  
  252. See Also:  SelectEdit, SetText
  253.  
  254. SignOn
  255. Bitmap
  256.  
  257. Bitmap        BMP filename
  258.  
  259. This command will display a bitmap in the center of the screen for the default number of seconds or number of seconds set by the Delay variable. This command can be used within a script which might be used for applications using Express scripts for demos.
  260.  
  261. Delay     10
  262. Bitmap     c:\windows\tartan.bmp
  263.  
  264.  
  265. Begin/Repeat
  266.  
  267. BEGIN/REPEAT        number of times
  268.  
  269. The Begin/Repeat structure allow scripts to repeat a certain number of times. 
  270.  
  271. Example:  Lobby.WEX
  272.     OnError  PlavWav  Hello.wav
  273.     SelectIcon    List
  274.     BEGIN
  275.     SelectList    Lobby
  276.     SelectButton    No
  277.     REPEAT    30
  278.  
  279. This is an example of wanting to get into a particular room in the People Connection area.  This script will bring up the room list and make the selection to enter the room named Lobby. In many cases, rooms you want to enter are full and you get a message asking if you'd like to enter a similiar room. This script will continue to knock on the door of the room  for 30 times or until it finally likes you enter. When you enter, it won't find the No button and the OnError condition will play a wav to let you know.
  280.  
  281. You could also use BEGIN/REPEAT to look for people online using the Get Info menu. Don't forget you can include a Pause in your loops and create operations which are performed every minute or so.
  282.  
  283.  
  284. Call
  285.  
  286. Call        Express Script name
  287.  
  288. This command  allows you to call scripts from within another script.  This allows the creation of small reusable scripts which can be called from other main scripts. 
  289.  
  290. Example:
  291.  
  292. Signon 1
  293. Call    C:\whalex\myscript1.wex
  294. Call    C:\whalex\myscript2.wex
  295.  
  296. Another good use of Call is in conjunction with the OnErrorOnError command.  This allows you to execute multiple commands following a script error.
  297.  
  298. Example
  299.  
  300. OnError     Call  myerror.wex
  301.  
  302. Note if your scripts are in the same directory as the Whale Express application, you aren't required to use the full path.
  303.  
  304.  
  305. CloseLog  / CloseChatLog
  306.  
  307. CloseLog / CloseChatLog
  308.  
  309. These two commands are used to close respective logs of the previous OpenLog commands. You may Exit America Online without closing the Log file, but some data loss may occur.
  310.  
  311.  
  312. Also see:  OpenLog,  OpenChatLog
  313.  
  314.  
  315. CloseWindow
  316.  
  317. CloseWindow
  318.  
  319. This command will force the current top most window to close.
  320.  
  321.  
  322. Copy
  323.  
  324. Copy        Edit field 1..n 
  325.  
  326. This command will select all the text in the text box and copy it into the Windows clipboard.    Copy will also access non-editable text messages allowing scripts to copy text from on-line articles and messages.  It will also act on Edit fields similar to CutCut, but will not delete the text from the edit field.   Current focus can be set using the SelectEditSelectEdit command or you can specify the edit field as data.
  327.  
  328.  
  329. Cut
  330.  
  331. Cut            Edit field 1..n
  332.  
  333. This command will select all the text in the edit field specified in the data field and delete the text, placing it into the Windows clipboard.  If no data field is used, then the field with the current focus is used.  Current focus can be set using the SelectEditSelectEdit command or can be specified in the data field.
  334.  
  335.  
  336.  
  337. Download
  338.  
  339. Download
  340.  
  341. This command is the proper way to exit the system and download all the files in the download manager before exiting.  Download should be the last item in a script file.
  342.  
  343. All files found in your Download Manager will be downloaded, and Whale Express will exit America Online.
  344.  
  345. also see:  Exit
  346.  
  347.  
  348.  
  349. Exec
  350.  
  351. Exec        <program name>
  352.  
  353. This command allows you to run other programs from within a Whale Express script.  This is handy for running other WAOL Add-On programs which you might enjoy as much as Whale Express.  You should include the full path name of your program unless the program exists in one of your path directories.
  354.  
  355.  
  356. Example:
  357.  
  358. Exec    C:\waol\croom.exe
  359.  
  360.  
  361. Exit
  362.  
  363. Exit
  364.  
  365. When you have completed your on-line duties, Exit will sign you off America Online, and will exit the America Online program.  You may notice a short pause while Whale checks if you have files in your Download Manager. If the Download Manager has files, they will not be downloaded using this command.  You can use the DownloadDownload command if you'd like files downloaded when you exit.
  366.  
  367.  
  368. InstantMessage
  369.  
  370. InstantMessage        off | on
  371.  
  372. This is handy little-known feature of America Online.  This command will tell America Online to hold sending you Instant Messages and Promotional banners.  This command can be used to make sure that your automated operation isn't disrupted by a well meaning friend.  The data tells whether you want messages on or off.
  373.  
  374. Example:
  375.  
  376. Signon         1
  377. InstantMessage     off
  378. Keyword     StockLink
  379. SelectEdit         1
  380. SetText             AMER
  381. SelectButton     Get
  382.  
  383. While turning off Instant Message isn't required for using Whale Express, it will prevent people from thinking you might be ignoring them.
  384.  
  385.  
  386. Keyword
  387.  
  388. Keyword        keyword
  389.  
  390. Just like the CTRL-K for doing Keywords on-line, this command will take you to the department on-line which is specified in the data field.  For Compuserve users, this is the same as using  GO.   For Prodigy users this would be the same as a JUMP.
  391.  
  392. Example:
  393.  
  394. Keyword TITF
  395. SelectList 1
  396.  
  397. TITF is the short keyword for "Tonight in the Forums".  By selecting the first list item, it will currently display a list of open conference rooms.
  398.  
  399.  
  400.  
  401. Menu
  402.  
  403. Menu        Menu Text
  404.  
  405. Menu allows Whale Express to select a menu item just as if you pulled down a menu and selected an item.  You won't have to include all the text found in the WAOL menu, but you'll need to provide enough so there's no confusion with other menu items.
  406.  
  407. The entire text of the menu is not required.  Whale Express will start with the File menu and check all menus until a match if found.
  408.  
  409. Example:
  410.  
  411. Menu                  Lobby
  412. SelectIcon         List
  413. SelectButton    Private
  414. SelectEdit         1
  415. SetText              Whale Express
  416. SelectButton    Go
  417.  
  418.  
  419.  
  420. Message
  421.  
  422. Message        Text Message
  423.  
  424. This allows some interaction during the script playback and can be helpful for OnError situations.  Using this command will create a popup message box with the text you specify as the text message.  
  425.  
  426. If you include the following in your script, anytime there is an error you'll received a message.
  427.  
  428. Example:
  429.  
  430. OnErrorOnError        Message  There has been an error.
  431.  
  432.  
  433. NOTE:  The text does not require single or double quotes.  All text following the Message command will be considered part of the message.
  434.  
  435.  
  436. Movie
  437.  
  438. Movie        AVI filename
  439.  
  440. This command will center a dialog on the screen and play the Video for Windows movie specified by the AVI file name.  It's not necessarily something you'll need to automate your America Online scripts, but it does provide an easy way to play AVI files.
  441.  
  442. The Video for WindowsÖ runtime package is required for this command.  If you require this software contact Tartan Software and it will be sent to you free of charge(excluding AOL download costs).
  443.  
  444. Example:
  445.  
  446. Movie     c:\windows\media\earth.avi
  447.  
  448. NewScreenName
  449.  
  450. NewScreenName        1..5
  451.  
  452. This is a very useful command which combines all the commands needed to allow you to sign off, and  back on-line using a new screen name.  This command is so useful that it's also available from the Express menu for easy access.
  453.  
  454. NOTE:  Signon requires that auto-password is enabled.  You can set this feature using CTRL = from the America Online options dialog.
  455.  
  456.  
  457. OnError
  458.  
  459. OnError        Express command
  460.  
  461. In case of a command failure,  the command from the last OnError statement is executed. Common examples would allow you to ExitExit AOL if a script failures, or begin other scripts with the CallCall statement.  Multiple OnErrors are allowed within a script, but only the last OnError command will be used.
  462.  
  463. Example:
  464.  
  465. OnError       Call  error.wex
  466.  
  467.  
  468.  
  469. OpenChatLog
  470.  
  471. OpenChatLog        Filename
  472.  
  473. This command uses the Chat Logging feature of America Online which allows you to maintain a file which will capture all the conversations in a conference room or in People Connection.  The filename parameter should be any normal DOS file or path name.  If the file already exists, the log file will be opened in Append mode and will not delete information previously contained in the file.
  474.  
  475. see also: CloseChatLog
  476.  
  477.  
  478. OpenLog
  479.  
  480. OpenLog        Filename
  481.  
  482. This command uses the Logging feature of America Online which allows you to maintain a file which will capture all the message read while on-line.  The filename parameter should be any normal DOS file or path name.  If the file already exists, the log file will be opened in Append mode and will not delete information previously in the file.
  483.  
  484. Example:
  485.  
  486. Signon        1
  487. OpenLog     c:\mail.txt
  488. Menu             Read
  489. ReadList
  490. CloseLog
  491. Exit
  492.  
  493. see also: CloseLog
  494.  
  495. Pause
  496.  
  497. Pause        Seconds
  498.  
  499. This command will create a pause in the Whale script.    The data field is the number of seconds you wish to wait before continuing on to the next Whalex instruction.  A common use for this command is in creating a lecture in a conference room. A Pause should be used between successive SendTextSendText to users have time to read your messages.
  500.  
  501. The number of seconds is optional and defaults to the current value of the DelayDelay variable.  The default for Delay is 10 seconds.
  502.  
  503. Example:
  504.  
  505. SendText     I'd like to thank you all for coming tonight
  506. Pause         2
  507. SendText     Next weeks topic will be Windows
  508. Pause         2
  509. SendText     Goodnight
  510.  
  511.  
  512. Paste
  513.  
  514. Paste        Edit field 1..n
  515.  
  516. This command will copy any text in the Windows clipboard into the currently selected Edit field.  You can also set the paste field by using a number in the data field.  This can be a handle command to export data from other applications.
  517.  
  518. see also:  Cut, Copy, PasteFile
  519.  
  520.  
  521.  
  522. PasteFile
  523.  
  524. PasteFile        Filename
  525.  
  526.  
  527. PasteFile allows you to read a file directly into an America Online edit field.  Before using PasteFile it might be necessary to use SelectEditSelectEdit to set the typing focus to the edit field you're pasting into.
  528.  
  529. Example:
  530.  
  531. SelectEdit     2
  532. PasteFile        c:\waol\document\help.txt
  533.  
  534. see also:  Paste,  SelectEdit
  535.  
  536.  
  537. PlayWav
  538.  
  539. PlayWav        WAV filename
  540.  
  541. This feature allows you to add fun sounds to your scripts.
  542.  
  543. This command will play a  sound "wav" file using the installed Windows sound driver.  The wave file name can be the wav name listed in the WIN.INI file, or just filename if the wav file is in a directory found in the directory Path.   You can also use the full path name of the wav file.
  544. The .WAV suffix is not required.
  545.  
  546. Example:
  547.  
  548. PlayWav     c:\sounds\coool.wav
  549.  
  550. You can also utilize the PlayWav command with the OnErrorOnError by setting the following example.
  551.  
  552. OnError     PlayWav  c:\sounds\bummer.wav
  553.  
  554.  
  555.  
  556. Rem
  557.  
  558. Rem
  559.  
  560. Like most languages, Whale Express allows comments and remarks within a file.  You can use a Rem statement to add comments to your Whale scripts.
  561.  
  562.  
  563. ReadList
  564.  
  565. ReadList        Express command
  566.  
  567. ReadList is a powerful command which is used in a variety of places to process list items.  Use this command when you've reached an area online which presents you with a list box, like Mail, or Message boards.  This command will read each item one at a time.  
  568.  
  569. The number of items can be set with the ReadRead variable.  In many cases , before using this command you'll probably wish to use the OpenLogOpenLog command so that text will be saved in  file.
  570.  
  571. The optional data parameter allows extra processing of each item.  You many add any command here which will be executed for each item in the list.  An example is the Download Later button while viewing a list of files in a library.
  572.  
  573. The following script will search for all the files which have been uploaded during the pass week and queue them for download at a later time.
  574.  
  575. Example:
  576.  
  577. Keyword        File Search
  578. SelectButton    Past Week
  579. SelectButton     List
  580. ReadList         Download Later
  581.  
  582. Here the SelectButton command is done after each item is processed putting the file into the download manager.  At the end of this script you could add the DownloadDownload command which would exit America Online after downloading all items in the download manager.
  583.  
  584. ReadList Options:
  585.  
  586. Under normal circumstances when ReadList processes an item, it will look for a valid Next icon which is used in many message boards.  This is extremely helpful for reading complete folders.  In some message boards however, the messages read with the Next icon are the same as those in the the list.  To prevent this redundancy, you can turn the processing of the Next icon off with the listNextlistNext variable.
  587.  
  588. ReadList processes the list by selecting each item on the list.  This is the same action as a user double clicking.  In some cases you may want to process a list by highlighting an item and selecting one of the buttons on the current list.  This can be accomplished with the help of the listSelectlistSelect variable
  589.  
  590. There will be times when you might only want to read a particular set of messages in the list.  You can specify those messages you wish to process by using the listMatch command variable.
  591.  
  592. Also See:
  593.     listStart, listEnd, listNext, listEnd, listMatch, Read
  594.  
  595.  
  596.  
  597. Repeat
  598.  
  599.  
  600.     See:  Begin
  601.  
  602. Quit
  603.  
  604. Quit
  605.  
  606. This command provides a way for you to quit the Whale Express program from within a script.  This is not the same as the ExitExit command which will quit the Windows America Online software.  
  607.  
  608.  
  609.  
  610. SelectButton
  611.  
  612. SelectButton        Button text
  613.  
  614. Works just like SelectIconSelectIcon in that it simulates a user pressing or double clicking on a button.  This allows you to select any button on the current top window.  Partial matches are supported.
  615.  
  616. NOTE: SelectButton will also work on radio buttons and check boxes.
  617.  
  618.  
  619. Example:
  620.  
  621. Menu             Lobby
  622. SelectIcon        List
  623. SelectButton    Private
  624. SelectEdit        1
  625. SetText        Whale Express
  626. SelectButton    Go
  627.  
  628.  
  629.  
  630. SelectEdit
  631.  
  632. SelectEdit        Edit field 1..n
  633.  
  634. This command will set the focus to an edit field control. This command is important for using the SetTextSetText command and can also be used in setting focus for the CutCut/CopyCopy/PastePaste/PasteFilePasteFile commands.  The relative position of the edit control is determined by AOL form designers.  Any changes made in form definition by AOL programs could affect your scripts.  You might have to experiment a little to find the correct field number, but in most cases AOL have created fields in a logical order.
  635.  
  636. Example:
  637.  
  638. SelectIcon     Forward
  639. SelectEdit     1
  640. SetText         BillP
  641. SelectEdit     4
  642. SetText      ----  Forwarded by Whale Express  ----
  643. SelectIcon     Send
  644.  
  645. This short script is handy if you'd like to forward mail to another user or screen name.  In this case, while reading mail, this script will click on the Forward icon bringing up the Forward Mail form SelectEdit is used prior to using SetTextSetText to fill in the form with the user name BillP
  646.  
  647.  
  648. SelectIcon
  649.  
  650. SelectIcon        Icon label text
  651.  
  652. This command will simulate a mouse click on an Icon picture on the current window.  Whale Express will search for the icon immediately above the text you specify.  Partial text matches are allowed and recommended. In fact, if icon text is contained on two lines, you should only match with the first line.   In cases where multiple icons have the same text, such as "Click Here", the first icon found will be selected.  To handle these situations, there is an alternate way to select your icon by icon number.
  653.  
  654. Examplea:
  655.  
  656.     SelectIcon   #3
  657.  
  658.     SelectIcon   Send
  659.  
  660.  
  661. SelectList
  662.  
  663. SelectList         list text  or  #number
  664.  
  665. This command will simulate the user selecting an item in a list box. SelectList assumes only one List control is in the current top most AOL window.  The first item in the list is considered list item number 1 when selecting an item by its position. 
  666.  
  667. Using text to find a list item works for the first item withing the list range which contains your text anywhere in the item.
  668.  
  669. Example:
  670.  
  671. SelectList     Check for live discussions
  672.  
  673. or 
  674.  
  675. SelectList     #1
  676.  
  677.  
  678.  
  679.  
  680. SendMail
  681.  
  682. SendMail        Mail Filename
  683.  
  684. SendMail is used to send text files which have been formatted as an off-line mail file. SendMail allows you to write all your Email off-line with the Whale Express editor, and use a Whalex script to automatically send your Email as quickly as possible.
  685.  
  686. The format of an off-line mail message contains all of the information found in the Mail Compose form Online.  With the exception of the text of the message,  each line of the file contains one item.  Each line can wrap within the Whale Express editor, but ends when you press the Enter key
  687.  
  688. Line 1> TO: information
  689. Line 2> CC: information.  Leave a blank line if no Carbon Copies are to be sent.
  690. Line 3>SUBJ: This is required field and must contain the title of your message
  691. Line 4>File:  This is also optional, but if you'd like to send a file via Email, enter the full path on this line.
  692. Line 5> The text of your message begins here.
  693.  
  694.  
  695.  
  696. SendText
  697.  
  698. SendText        Text message
  699.  
  700. This command allows you to broadcast text in a conference or room in People Connection.  This command is intended for people who run conferences or teach classes on-line where text can be prepared ahead of time.  Data must be less than 93 characters.
  701.  
  702. NOTE:  Misuse of this command in such a way to be disturbing to other America Online members can be a violation of terms of service.  Loss of your America Online account could result.
  703.  
  704. Example:
  705.  
  706. SendText     I'd like to thank you all for coming tonight
  707. Pause         4
  708. SendText     Next weeks topic will be Windows
  709. Pause         4
  710. SendText     Goodnight
  711.  
  712.  
  713. You'll notice the pause statements between multiple SendText statements.  These are very important in making your text readable by both new users and old-timers.
  714.  
  715.  
  716.  
  717. SetText
  718.  
  719. SetText        Text message
  720.  
  721. This command will enter text into the edit field with the current focus, just as if you had typed it in.  Use SelectEditSelectEdit if needed to set the focus to the desired AOL edit field.
  722.  
  723. Example:
  724.  
  725. Menu             Compose
  726. SelectEdit       1
  727. SetText         Tartan
  728. SelectEdit      3
  729. SetText         Whale Express test
  730. SelectEdit     4
  731. SetText            Hi!  I'm testing the mailform.wex script
  732. SelectIcon        Send
  733.  
  734. This example brings up the Email compose form and fills in text based on the edit field number.  The edit field numbers are determined by America Online forum designers and are subject to change.  In most cases, they won't change and field numbers will be created in a logical order.
  735.  
  736.  
  737. SignOn
  738.  
  739. SignOn        name
  740.  
  741. This command initiates the signon process to America Online, including the selection of screen name and dialing America Online. The name should be the screen name or Email address you wish to use.  If no name is  provided, the current screen name will be chosen.  If you are already signed on to America Online, this command is ignored.
  742.  
  743. NOTE:  Signon requires that stored-passwords are enabled.  You can set this feature using CTRL = from the America Online options dialog.
  744.  
  745.  
  746.  
  747. Upload
  748.  
  749. Upload    filename
  750.  
  751. Note:  Upload will only be available to registered Whale Express users.
  752.  
  753. The Upload command may only be used when the current America Online window is an Upload form. This form is usually in response to selecting the Upload icon, or using "SelectIcon Upload".
  754.  
  755. Before using the Upload command it's appropriate to set the values of the various fields.  These values can be set once and used for each upload or can be reset before each Upload command.  If no values are set, default values will be used.
  756.  
  757. Subject
  758. Author
  759. Equipment
  760. Needs
  761. Description
  762.  
  763. Subject           data
  764. This field is required by America Online
  765. Data field is limited to 32 characters
  766.  
  767. Author          data
  768. Data field is limited to 20 characters
  769.  
  770. Equipment   data
  771. Data field limited to 32 characters
  772.  
  773. Needs               data
  774. Data field is limited to 36 characters
  775.  
  776. Description   filename
  777. This data field should be the name of a description file.  If no file is specified default value is used.
  778.  
  779. Example Upload script
  780.  
  781. In the following example we have a number of files, all with the same Author, Needs and Description.  We set these fields once and then instruct Whale Express to upload the file.  After the initial upload, we change the Subject line and upload other parts of the program. 
  782.  
  783. SelectIcon     Upload
  784. Subject         PAINT: v1.3 Basic Paint Program
  785. Author          My Software Company
  786. Needs          An UnZIPing program
  787. Description  C:\paint\mypaint.txt
  788. Upload         c:\paint\mypaint.exe
  789. Subject         PAINT: Utility for MyPaint
  790. Upload         c:\paint\paint1.dll
  791. Upload         c:\paint\paint2.dll
  792. Upload         c:\paint\paint3.dll
  793. Upload         c:\paint\paint4.dll
  794. CloseWindow
  795.  
  796. Command Variables
  797.  
  798. The following commands are used as modifiers for Whale Express commands.  Most are used to modify the powerful ReadList command.  The only exception is the Delay which is used as the default time for Pause command and Bitmap display.
  799.  
  800. Delay
  801. Error
  802. listStart
  803. listEndlistEnd
  804. listMatch
  805. listNextlistNext
  806. listSelectlistSelect
  807. ReadRead
  808.  
  809.  
  810. Delay
  811.  
  812. Delay        1..n
  813.  
  814. This variable is used to specify default waiting periods for commands such as BitmapBitmap or PausePause.  Default value is 10 seconds.
  815.  
  816. Example
  817.  
  818. Delay     10
  819.  
  820. Error
  821.  
  822. Error    On | Off
  823.  
  824. Under most cases, your script will fail to continue an error occurs in any of the commands.  There may be times when you'll want to continue even if are button or icon is not found in previous commands.  You can turn Error checking off by using the statement,    Error  Off
  825.  
  826. Error On  will reset the default error checking condition.
  827.  
  828. listStart
  829.  
  830. listStart        1..n
  831.  
  832. Under default conditions ReadListReadList will begin on the first list item and process the max. items available.  Setting listStart in your script will allow you to begin the list processing on the item you need.
  833.  
  834. Example:
  835.  
  836. listStart        3
  837.  
  838.  
  839. listEnd
  840.  
  841. listEnd        1..n                                    
  842.  
  843. Example:        
  844.  
  845. listEnd      9
  846.  
  847. Under default conditions ReadListReadList will process max. items available. Setting listEnd in your script will allow you to specify the last 
  848. item you need.
  849.  
  850. Sample Use:
  851.  
  852. listStart        3
  853. listEnd        9
  854. ReadList
  855.  
  856.  
  857.  
  858. listMatch
  859.  
  860. listMatch        text to search on
  861.  
  862. The ReadList command will use listMatch to decide which items to select.  Normally, ReadList will select all the items in the list.  With the addition of a listMatch instruction, you can tell ReadList to only select those messages with particular text in the list item text
  863.  
  864. The default for listMatch is to read all items. To set listMatch back to it's default status use the wildcard character.
  865.  
  866. listMatch     *
  867.  
  868. At this time no logical operations are supported.  Only single text matches are supported. such as AND/OR operations.
  869.  
  870. Example:
  871.  
  872. Menu             Read New Mail
  873. listMatch        Test
  874. ReadList        Call  treply.wex
  875.  
  876.  
  877. The above sample script which we use here at Tartan Software to automatically respond to those mail messages which are send to the Tartan name from people testing Whale Express.  The script reads all our new Email and selects those messages with the text "Mail Test" in the subject line.   We've provide you with the TREPLY.WEX below so you'll see the full picture.
  878.  
  879. SelectIcon         Reply
  880. SelectEdit         4
  881. PasteFile         c:\tartan\treply.txt
  882. SelectIcon         Send
  883. SelectButton     OK
  884. CloseWindow
  885.  
  886.  
  887.  
  888. listNext
  889.  
  890. listNext        on | off    
  891.  
  892. Normally, when ReadListReadList processes messages, it will automatically look for a valid Next icon.  If found, the Next button is processed.
  893.  
  894. On some boards the next message can be found in the list, and 
  895. accessed with a Next button.  This can cause redundant reading of
  896. messages.
  897.  
  898. Example::
  899.  
  900. listSelect     OFF
  901. ReadList 
  902.  
  903.  
  904. listSelect
  905.  
  906. listSelect        on | off                
  907.  
  908. This command variable allows you tell Whale Express if you want to actually select a list item or just highlight it.
  909.  
  910. Under normal conditions both SelectListSelectList and ReadListReadList will act as if you double click the mouse on the list item.  By turning listSelect off, you can highlight the item you desire, and then select the appropriate action.
  911.  
  912. Example:
  913.  
  914. listSelect    OFF
  915. SelectList    3
  916. SelectIcon     Find Since
  917. SelectEdit     1
  918. SetText        7
  919. SelectIcon     Search
  920. listSelect     ON
  921. ReadList
  922.  
  923.  
  924. Read
  925.  
  926.  
  927. Read        1..n
  928.  
  929. Setting this variable will allow you to set the number of messages read when reading the news, message boards or download libraries.  You can set and reset Read anywhere in the script, The preference would be to set Read directly before calling a function which reads multiple messages.
  930.  
  931. Example:
  932.  
  933. Keyword        file search
  934. SelectButton    Past week
  935. SelectButton     Windows
  936. SelectButton     List
  937. read             10
  938. ReadList     SelectButton Download Later
  939.  
  940. This will tell Whale Express you only wish the first 10 files found to be added to your Download Manager.
  941.  
  942.  
  943.  
  944. Date, Time, Input
  945.  
  946. The following special variables can be used in your data parameter to allow you to change the value of what is used based on the current date, time or what you type in during the execution of the script.
  947.  
  948.  
  949. %input 
  950.  
  951. Will prompt you for variable data to be entered.  Do not use this in any scripts which you run unattended.
  952.  
  953.     Example:      SendText  Hi %input,  How the heck are you?
  954.  
  955. %date 
  956.  
  957. Will insert the current date into the data.
  958.    
  959.     Example:      OpenLog  C:\MAIL\MAIL%date.TXT
  960.  
  961.     The %date is four characters in the format  MMDD
  962.  
  963. %time 
  964.  
  965. Will insert the current time into the data
  966.  
  967.     Example:     Message   The date is %date, current time is %time
  968.  
  969.     The %time is six characters in the format  HHMMSS
  970.  
  971.  
  972. Common Questions & Answers
  973.  
  974.  
  975. Q:  How do I cancel a script in progress?
  976. A:  Use the F3 key. 
  977.  
  978. Q:  Will Whale Express slow my system down?
  979. A:  No.  Whale Express requires no special hooks that monitor your system activities.  Until you run a script, the program acts like any other Windows program waiting for the user to select an action.
  980.  
  981. Q:  Why the name Whale Express?
  982. A:  Internally at America Online, the Windows version of America Online, WAOL is pronounced "Whale".
  983.  
  984. Q:  I'm having trouble running a script which uses the Download Later button to store programs in my Download Manager.
  985. A:  Use  CTRL= in America Online and set your Download Preferences.  Be sure to remove the check box item which says "Confirm Additions to my download list".
  986.  
  987. Q:  When I use Signon, it still asks for my password.
  988. A:   Using Signon and NewScreenName requires the use of the Stored Password feature of America Online.  Use CTRL = in America Online to store your passwords in your WAOL software.  Note: Due to a feature in the WAOL software you'll need to redo your stored passwords after creating a new screen name.
  989.  
  990. Q:  When I try SelectIcon Message Board, it's not finding the icon.
  991. A:  The text for Message Board is probably split between two lines.  You only need to use the top line of the Icon name.   Try  SelectIcon Message or even  SelectIcon Mess will work.  Whale Express will find partial matches of text.
  992.  
  993. Q:    Can I use Whale Express to capture my NewsGroup messages on Internet?
  994. A:    At this time, Whale Express can be used to help you capture your Newsgroup messages but can't do it all.  The current structure of the newsgroup message boards is different from the regular boards on AOL.  For example, the Next -> button is not disabled when you reach the end of a newsgroup folder.  We'll continue to work with AOL on solutions to this in the future.
  995.  
  996. Appendix A:   ReadList
  997.  
  998. ReadList is the key to accessing Email, and Message boards.  This command provides all the error checking and logic required to so being a programmer is not required to use Whale Express.  This section is provide for those users who feel more comfortable knowing what's going on.
  999.  
  1000. You'll notice that Readlist takes a couple of seconds to get started. During this time Whalex is checking for some conditions which are common to list processing.  The following is the behind the screen processing which ReadList performs.
  1001.  
  1002. First:
  1003. We need to handle situations where no list exists when you might be expecting one. Whalex looks for a standard message with an OK button.
  1004. Something like.. "You have no new mail", No more messages,  etc...  If such a messagebox is found, no list is processed and the script continues on with no errors reported.
  1005.  
  1006. Next:
  1007. If you do have a list then we want to be sure we can access all the available messages. Whalex will look for a More button, More icon and List More Icon.  Whalex will keep pressing this button or icon until there are no more items available or there are more items than READ is set to..
  1008.  
  1009.  
  1010. Now comes the real power:
  1011. At this point Whalex knows how many items there are in the list, or how many you want to process per the Read variable.
  1012. Here's effectively what happens...
  1013.  
  1014. For I = listStart to listEnd
  1015. {
  1016.      if(listMatch) SelectList  I            ; select each item in turn if they match
  1017.      If (Express command)                ; check for data command and do it
  1018.          Execute the data command
  1019.      else                                     ; comes here after reading 1st message
  1020.          while(Next Button Active)        ; if there's a Next Icon,  click it.
  1021.                 SelectIcon Next
  1022.      CloseWindows                        ; Close Message window, get ready
  1023. }                                          ; to select the next item.
  1024.  
  1025.  
  1026. "Express command" could be anything like,  SelectIcon  Download later
  1027. or Call xxxxx.wex
  1028.  
  1029. Or in the case of message boards where when you select a folder you just get
  1030. another List of folders you can just add another ReadList so it looks like...
  1031.  
  1032. ReadList ReadList
  1033.  
  1034. And note that the 2nd ReadList could even have it's own data parameter so
  1035. effectively you could have
  1036. ReadList ReadList ReadList ReadList SelectIcon Download
  1037.  
  1038. The simplest case is where you have a single list of folders or files and
  1039. ReadList will go down DoubleClick on each of them so they will be logged.
  1040.  
  1041.  
  1042. You'll find that in some message boards, processing the Next message isn't required and could be redundant.  In these cases you may turn off Next processing by setting the command variable listNext
  1043.  
  1044. listNext    Off
  1045.  
  1046.  
  1047.  
  1048. Appendix B:   Sample Files
  1049.  
  1050.  
  1051. AMER.WEX
  1052.  
  1053. This is a simple script which takes the user to the StockLink area on AOL.  AMER is the stock symbol for America Online Inc.  This provide a quick way to check the price of America Online.  Change this script to allow you to quickly check your own favorite stock.  Note that Signon is used, but this script can still be used while already online.  Sigon will be ignored.
  1054.  
  1055. Signon 
  1056. Keyword     StockLink
  1057. SelectEdit     1
  1058. SetText     AMER
  1059. SelectButton Get
  1060.  
  1061.  
  1062.  
  1063. GETMAIL.WEX
  1064.  
  1065. This is an example of how you can use Whale Express to SignOn,  Read all your mail, and sign off again.  You can  change the name of the file in the OpenLog command if you'd like your mail to be saved to another directory.
  1066.  
  1067.  
  1068. Signon     
  1069. OpenLog     c:\mail.log
  1070. Menu         Read
  1071. ReadList
  1072. CloseLog
  1073. Exit
  1074.  
  1075.  
  1076. NEWWIN.WEX
  1077.  
  1078. This powerful script demonstrates using Whale Express to find recent uploads in America Online's File Search.  In this case, all files in the Windows libraries uploaded in the past week at marked for Download Later.  This is a good example of the powerful ReadList command.  Adding the Download command will cause all files in the Download Manager to be downloaded before exiting your online session.  You will need to change your download options on America Online(CTRL=) so that you no longer confirm additions to your download manager.
  1079.  
  1080. Note how a complete command can be included in the ReadList command. When each item in the list is read, the Download Later button will be selected, adding the file to your download manager.  The Download command will also exit you from AOL when downloads are complete.
  1081.  
  1082.  
  1083. Signon 
  1084. Keyword          File Search
  1085. SelectButton Past Week
  1086. SelectButton Windows
  1087. SelectButton List
  1088. ReadList     SelectButton Download Later
  1089. Download
  1090.  
  1091.  
  1092.  
  1093. ROOMS.WEX
  1094.  
  1095. A little known feature allows members to list all active discussions in conference rooms.  These rooms allow up to 48 users and often have useful topics.  This script keywords to the "Tonight in the Forum" area and selects the first menu item which is "Check for Live Discussions"  This is a handy script and one that proves scripts don't have to be complex to be useful.
  1096.  
  1097. Keyword     TITF
  1098. SelectList  #1
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104. MAILFORM.WEX
  1105.  
  1106. This is a good example of using SelectEdit and SetText to fill in an online form such as Email.  This sample will send a friendly note to Tartan Software support.  We'll send you a note back to let you know this script worke ok.
  1107.  
  1108.  
  1109. Menu             Compose
  1110. SelectEdit    1
  1111. SetText         Tartan
  1112. SelectEdit     3
  1113. SetText         Whale Express test
  1114. SelectEdit     4
  1115. SetText          Hi!  I'm testing the mailform.wex script
  1116. SelectIcon      Send
  1117.     
  1118.  
  1119. FORWARD.WEX
  1120.  
  1121. Instead of using the Reply button when reading Email.  This is a sample of  a script you could use to forward mail back to the original sender and then include your comments.  This is handy when you might need to remind the sender what you're replying to.  For this script to work, you should run it right after reading a piece of mail.
  1122.  
  1123.  
  1124. SelectIcon     Reply to All
  1125. Copy         1
  1126. CloseWindow
  1127. SelectIcon     Forward
  1128. Paste         1
  1129. SelectEdit     4
  1130.  
  1131.  
  1132.  
  1133.  
  1134. (Print this form)
  1135.  
  1136.  
  1137.  
  1138.  
  1139. TARTAN SOFTWARE ORDER FORM
  1140.  
  1141.  
  1142. AOL Screen Name ___________________________________________
  1143.  
  1144. Name ______________________________________________________
  1145.  
  1146. Address ___________________________________________________
  1147.  
  1148. City ___________________________ State ______ ZIP _________
  1149.  
  1150. Phone (optional) _____________________     Circle: home or work
  1151.  
  1152.  
  1153.  
  1154. (New York residents must add appropriate sales tax.)
  1155.  
  1156. County______________________________________
  1157.  
  1158.  
  1159. Whale Express v1.x    ________    $ 39.95
  1160. C-Room v2.x            ________    $ 19.95
  1161. TimeKard    v1.x        ________    $ 24.95
  1162.  
  1163. Tartan Booster
  1164. Complete Package    ________    $ 69.95 (Save $16.00)
  1165.  
  1166. NYS Sales Tax        ________    (if New York state resident)
  1167.  
  1168.  
  1169. Amount enclosed:  $______________
  1170.  
  1171.  
  1172.  
  1173. Please make all checks payable to Tartan Software
  1174.  
  1175. Mail to:      Tartan  Software           
  1176.             143 Horstman Dr.
  1177.             Scotia, NY  12302
  1178.  
  1179.  
  1180. Tartan Software    - {PAGE|24} -    Whale Express
  1181.  
  1182.  
  1183.