basis/cocoa/apple-script/apple-script-docs.factor

   1 USING: help.markup help.syntax strings ;
   2 IN: cocoa.apple-script
   3
   4 HELP: quote-apple-script
   5 { $values { "str" string } { "str'" string } }
   6 { $description "Escape special characters in a string to make it suitable as a literal string in AppleScript code." } ;
   7
   8 HELP: run-apple-script
   9 { $values { "str" string } }
  10 { $description "Runs the provided uncompiled AppleScript code." }
  11 { $notes "Currently, return values are unsupported." } ;
  12
  13 HELP: APPLESCRIPT:
  14 { $syntax "APPLESCRIPT: word [[ ...applescript string... ]] " }
  15 { $values { "word" "a new word to define" } { "...applescript string..." "AppleScript source text" } }
  16 { $description "Defines a word that when called will run the provided uncompiled AppleScript. The word has stack effect " { $snippet "( -- )" } " due to return values being currently unsupported." } ;