Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
mscripteditor [2017/12/22 02:20]
admin [Editing Triggers] 		mscripteditor [2020/05/10 03:08]
admin removed
Line 13: Line 13:
 //MScript Editor// is a tab which can be placed in any of the 3 panes.  By default, //MScript Editor// is placed in the //bottom right pane//. //MScript Editor// is a tab which can be placed in any of the 3 panes.  By default, //MScript Editor// is placed in the //bottom right pane//.
  
-When you click /select a state or transition, //MScript Editor// automatically loads the mscript for the corresponding state or transition. +When you click /select a state or transition, //MScript Editor// automatically loads the MScript for the corresponding state or transition. 
  
 Changes are automatically pushed to the server when you move focus to other tabs in the IDE. Changes are automatically pushed to the server when you move focus to other tabs in the IDE.
Line 54: Line 54:
  
 ====Code Assist==== ====Code Assist====
-//Code Assist// is supported.  By pressing //ctrl-space//, a popup list is displayed showing the list of suggested mscript functions or constants that can be inserted into the editor or replace the selected mscript text in the editor.  //Code Assist// is context sensitive, that is, the content of the list displayed is dependent on what element the cursor is currently on in the editor. +//Code Assist// is supported.  By pressing //ctrl-space//, a popup list is displayed showing the list of suggested MScript functions or constants that can be inserted into the editor or replace the selected MScript text in the editor.  //Code Assist// is context sensitive, that is, the content of the list displayed is dependent on what element the cursor is currently on in the editor. 
  
  
Line 60: Line 60:
  
  
-For example, if the cursor is on a blank line, the //Code Assist// list will be populated with list of mscript tags.  If the cursor is inside the //op// attribute of a //assert// tag, then the popup list will be populated with compare operators available: //eq//, //lt//, //gt//, etc.+For example, if the cursor is on a blank line, the //Code Assist// list will be populated with list of MScript tags.  If the cursor is inside the //op// attribute of a //assert// tag, then the popup list will be populated with compare operators available: //eq//, //lt//, //gt//, etc.
  
 Below are the description of different //Code Assist// context supported with //ctrl - space// pressed: Below are the description of different //Code Assist// context supported with //ctrl - space// pressed:
  
-  * on a blank line - brings up the list of mScript tags. The selected tag is inserted with all attributes set to empty string.+  * on a blank line - brings up the list of MScript tags. The selected tag is inserted with all attributes set to empty string.
  
-  * in an attribute value (between double quotes), code assist brings up the list of mScript methods. For some special attribute like //op//, a special list of values may be presented instead of mScript method list.+  * in an attribute value (between double quotes), code assist brings up the list of MScript methods. For some special attribute like //op//, a special list of values may be presented instead of MScript method list.
  
-With //ctrl-space//, it brings up a list of mscript functions that include both //system functions// and //plugin functions// as noted in the header of the popup.  Alternatively you may use //ctrl-S// to bring up just //system functions// and //ctrl-p// to bring up just //plugin functions//.+With //ctrl-space//, it brings up a list of Mscript functions that include both //system functions// and //plugin functions// as noted in the header of the popup.  Alternatively you may use //ctrl-S// to bring up just //system functions// and //ctrl-p// to bring up just //plugin functions//.
  
  
Line 131: Line 131:
 ---- ----
  
-====MScript Macro==== 
-You may define a set of macros to encapsulate a set of frequently used MScript. This is done via editing the //CAMacro.properties// in //config// folder. 
- 
-You may add tooltip to each of the macro by appending //@tooltip:my tool tip msg// to the end of the macro line. 
- 
-Macro file //CAMacro.properties// can include other files by adding the following: 
- 
-     include=file1,file2 
- 
-To call up macros, press //ctrl+M// (or //alt+M//). 
- 
----- 
  
 ====Requirements Tags==== ====Requirements Tags====
Line 156: Line 144:
      <!-- your comments goes here -->      <!-- your comments goes here -->
  
-  * you can add as many comments you would like anywhere in the mscript triggers.+  * you can add as many comments you would like anywhere in the MScript triggers.
   * you can continue to use //comment// parameter, but commenting using xml comment tag is recommended.   * you can continue to use //comment// parameter, but commenting using xml comment tag is recommended.
   * you may have the comments written out to an output file as MScript is executed. By default writing comments to an output file is off. It can be turned on with MScript function //$enableCommentToSeqOut()// or turned off with //$isableCommentToSeqOut()//.   * you may have the comments written out to an output file as MScript is executed. By default writing comments to an output file is off. It can be turned on with MScript function //$enableCommentToSeqOut()// or turned off with //$isableCommentToSeqOut()//.
Line 181: Line 169:
 The system collects the number of times each MScript tag is executed.  For MScript container tags like //if// and //while// that contain other MScript tags, the coverage is also presented. The system collects the number of times each MScript tag is executed.  For MScript container tags like //if// and //while// that contain other MScript tags, the coverage is also presented.
  
-The coverage metrics are then displayed with two additional mscript attributes: //execCount// and //coverage//.+The coverage metrics are then displayed with two additional MScript attributes: //execCount// and //coverage//.
  
   * //execCount// - number of times the MScript tag has been executed.   * //execCount// - number of times the MScript tag has been executed.
   * //coverage// - percentage of child MScript tags that have been executed.   * //coverage// - percentage of child MScript tags that have been executed.