move quote-apple-script to cocoa.apple-script and out of elevate.macosx

[factor.git] / basis / cocoa / apple-script / apple-script-docs.factor

diff --git a/basis/cocoa/apple-script/apple-script-docs.factor b/basis/cocoa/apple-script/apple-script-docs.factor
index 820f08014618dd6bdad0a03ec9bebce53e8efba6..bcecb53248fd69278736fe3737e0529974d341e9 100644 (file)
--- a/basis/cocoa/apple-script/apple-script-docs.factor
+++ b/basis/cocoa/apple-script/apple-script-docs.factor
@@ -1,7 +1,11 @@
 USING: help.markup help.syntax strings ;
-
 IN: cocoa.apple-script
 
+HELP: quote-apple-script 
+{ $values { "str" string } }
+{ $description { "Escape special characters in a string to make it suitable as a literal string in AppleScript code." }
+{ $notes "Because this word is a port from Barney Gale's Elevate.py ("{ $vocab-link elevate }"), the only characters escaped are keys in " { $link apple-script-charmap } "; other special characters are unchanged." } ;
+
 HELP: run-apple-script
 { $values { "str" string } }
 { $description "Runs the provided uncompiled AppleScript code." }