PlanoTse Handbook for Job Search Automation/PlanoTseScript Basic Commands

= Basic PlanoTseScript Commands = In PlanoTseScript, each statement begins with a basic command. A basic command is a single or double keyword. This page provides the list of all basic commands in PlanoTseScript. Unless otherwise stated, all must be written in lower case.

Commands from A to D
 aw PlanoTseScript WSA Commands

bookmark value2 Bookmark the first item whose number is value2 found the tree view. 

bookmarks [ on | off ] Select [View &raquo; Bookmarks] to turn on or off the Bookmarks node on the tree view.

clear [ keyword2 | data item collection ] keyword2 must be either a valid PlanoTse data item collection or one of the following:

<dl style="color:dimgray"> <dt>all</dt> <dd>Select [View &raquo; Clear All] from the main menu.</dd> <dt>bookmarks</dt> <dd>Delete all bookmarks.</dd> <dt>go</dt> <dd>Erase the current Go script.</dd> <dt>startup</dt> <dd>Erase the current Startup script.</dd> <dt>trace</dt> <dd>Erase the current PlanoTseScript execution trace log.</dd> <dt>websearch</dt> <dd>Delete all unprocessed web search results.</dd> </dl> </dd>

<dt>collapse all</dt> <dd>Select [View &raquo; Collapse All] from the main menu.</dd>

<dt>dragdrop [ on | off ]</dt> <dd>Select [View &raquo; Drag drop enabled] from the main menu to enable or disable drag-and-drop feature on the tree view.</dd>

</dl>

Commands from E to H
<dl style="font-size:small; color:saddlebrown;">

<dt>edit [ item-type item-number | item-title ]</dt> <dd>Open the item whose type and number are as specified, or whose title is as specified.

</dd>

<dt>exit</dt> <dd>Stop interpreting the rest of the source code in the current springboard.</dd>

<dt>expand all</dt> <dd>Select [View &raquo; Expand All] from the main menu.</dd>

<dt>expect item-type item-number</dt> <dd>The expression missing is true if the item whose type and number are as specified is not found. </dd>

<dt>find</dt> <dd>PlanoTseScript WSA Commands</dd> <dt>focus item-number</dt> <dd>Select the first item in the tree view whose number is as specified. </dd>

<dt>folder keyword2</dt> <dd>keyword2 must be one of the following:

<dl style="color:dimgray"> <dt>data item collection</dt> <dd>Open the folder containing the declared data items, e.g. responses or notes.</dd> <dt>dataroot</dt> <dd>Open the current data root folder.</dd> <dt>reports</dt> <dd>Open the reports folder.</dd> <dt>trace</dt> <dd>Open the trace log folder.</dd> <dt>websearch</dt> <dd>Open the web search result folder.</dd> </dl> </dd>

<dt>given</dt> <dd>PlanoTseScript WSA Commands</dd>

<dt>goto url2</dt> <dd>Go to the specified URL.

</dd>

</dl>

Commands from I to R
<dl style="font-size:small; color:saddlebrown;">

<dt>if condition2 then statement4</dt> <dd>The statement4 will be executed given that condition2 is true; condition2 must be one of the following keywords: [ yes | no | missing | testdata | realtest ]. <ul><li>Condition 'yes' and 'no' are set by the command 'yesno'. <li>Condition 'missing' is set by the command 'expect'. <li>Condition 'testdata' and 'realdata' by default set to match the directory mode: currently using either test or real data root directory. </ul>

</dd>

<dt>load all</dt> <dd>Load all data in the tree view or as much as the tree view can handle.</dd>

<dt>load collection2</dt> <dd>Load items of the data type as specified in collection2 </dd>

<dt>main press button steps</dt> <dd>Press the Steps button on the main window.</dd>

<dt>new item-type item-title</dt> <dd>Create a new item whose data type and title are as specified. </dd>

<dt>notice message2</dt> <dd>Please message2 on the status bar at the bottom of the main window. </dd>

<dt>panel [ 1 | 2 | 3 | 12 | 23 | 13 | 123 ]</dt> <dd>Show only the tree view (1), the node editor (2), or the whiteboard panel, or any of two, or all three.</dd>

<dt>realdata directory2</dt> <dd>Store directory2 as the real-data root folder and use it as such now.</dd>

<dt>replace key2 value3</dt> <dd>Anywhere in the code thereafter, replace key2 with value3. If value3 is not specified then, from this point on, stop replacing key2 with anything else.</dd>

<dt>run [ go | startup ]</dt> <dd>Run either the Go script or the start-up script.</dd>

<dt>run item-type item-number</dt> <dd>Run the PlanoTseScript code in the data direction (Steps) of the data item whose type and number are as specified. </dd>

</dl>

Commands from S to Z
<dl style="font-size:small; color:saddlebrown;">

<dt>say message2</dt> <dd>Pops up a message box showing message2.</dd>

<dt>searches [ on | off ]</dt> <dd>Turn the Searches node in the tree view on or off.</dd>

<dt>testdata directory2</dt> <dd>Save directory2 as the test data root folder and use it now.</dd>

<dt>trace message2</dt> <dd>Post message2 in the PlanoTseScript execution trace log.</dd>

<dt>unload collection2</dt> <dd>Clear all items of the type as specified by collection2 off of the tree view. </dd>

<dt>use [ realdata | testdata ]</dt> <dd>Switch to either real or test data root directory.</dd>

<dt>view trace</dt> <dd>Show to content of the PlanoTseScript execution trace log.</dd>

<dt>web search search-string-3</dt> <dd>Do a web search using search-string-3 as the search criteria. </dd>

<dt>ws search-string-2</dt> <dd>Abbreviated for web search; do a web search using search-string-2 as the search criteria. </dd>

<dt>yesno question2</dt> <dd>Ask a yes-or-no question and save the 'yes' and 'no' conditions for use by the 'if' command. </dd>

</dl>