RubyGems - rb-scpt - Versions diffs - 1.0.0 - Mend

rb-scpt 1.0.0

Files changed (94) hide show

checksums.yaml +7 -0
data/CHANGES +497 -0
data/doc/aem-manual/01_introduction.html +60 -0
data/doc/aem-manual/02_apioverview.html +107 -0
data/doc/aem-manual/03_packingandunpackingdata.html +135 -0
data/doc/aem-manual/04_references.html +409 -0
data/doc/aem-manual/05_targetingapplications.html +164 -0
data/doc/aem-manual/06_buildingandsendingevents.html +229 -0
data/doc/aem-manual/07_findapp.html +63 -0
data/doc/aem-manual/08_examples.html +94 -0
data/doc/aem-manual/aemreferenceinheritance.gif +0 -0
data/doc/aem-manual/index.html +56 -0
data/doc/appscript-manual/01_introduction.html +94 -0
data/doc/appscript-manual/02_aboutappscripting.html +247 -0
data/doc/appscript-manual/03_quicktutorial.html +167 -0
data/doc/appscript-manual/04_gettinghelp.html +188 -0
data/doc/appscript-manual/05_keywordconversion.html +106 -0
data/doc/appscript-manual/06_classesandenums.html +192 -0
data/doc/appscript-manual/07_applicationobjects.html +211 -0
data/doc/appscript-manual/08_realvsgenericreferences.html +96 -0
data/doc/appscript-manual/09_referenceforms.html +241 -0
data/doc/appscript-manual/10_referenceexamples.html +154 -0
data/doc/appscript-manual/11_applicationcommands.html +245 -0
data/doc/appscript-manual/12_commandexamples.html +138 -0
data/doc/appscript-manual/13_performanceissues.html +142 -0
data/doc/appscript-manual/14_notes.html +80 -0
data/doc/appscript-manual/application_architecture.gif +0 -0
data/doc/appscript-manual/application_architecture2.gif +0 -0
data/doc/appscript-manual/finder_to_textedit_event.gif +0 -0
data/doc/appscript-manual/index.html +62 -0
data/doc/appscript-manual/relationships_example.gif +0 -0
data/doc/appscript-manual/ruby_to_itunes_event.gif +0 -0
data/doc/full.css +106 -0
data/doc/index.html +45 -0
data/doc/mactypes-manual/01_introduction.html +54 -0
data/doc/mactypes-manual/02_aliasclass.html +124 -0
data/doc/mactypes-manual/03_fileurlclass.html +126 -0
data/doc/mactypes-manual/04_unitsclass.html +100 -0
data/doc/mactypes-manual/index.html +53 -0
data/doc/osax-manual/01_introduction.html +67 -0
data/doc/osax-manual/02_interface.html +147 -0
data/doc/osax-manual/03_examples.html +73 -0
data/doc/osax-manual/04_notes.html +61 -0
data/doc/osax-manual/index.html +53 -0
data/doc/rb-appscript-logo.png +0 -0
data/extconf.rb +65 -0
data/rb-scpt.gemspec +14 -0
data/sample/AB_export_vcard.rb +31 -0
data/sample/AB_list_people_with_emails.rb +13 -0
data/sample/Add_iCal_event.rb +21 -0
data/sample/Create_daily_iCal_todos.rb +75 -0
data/sample/Export_Address_Book_phone_numbers.rb +59 -0
data/sample/Hello_world.rb +21 -0
data/sample/List_iTunes_playlist_names.rb +11 -0
data/sample/Make_Mail_message.rb +33 -0
data/sample/Open_file_in_TextEdit.rb +13 -0
data/sample/Organize_Mail_messages.rb +61 -0
data/sample/Print_folder_tree.rb +16 -0
data/sample/Select_all_HTML_files.rb +14 -0
data/sample/Set_iChat_status.rb +24 -0
data/sample/Simple_Finder_GUI_Scripting.rb +18 -0
data/sample/Stagger_Finder_windows.rb +25 -0
data/sample/TextEdit_demo.rb +130 -0
data/sample/iTunes_top40_to_html.rb +71 -0
data/src/SendThreadSafe.c +380 -0
data/src/SendThreadSafe.h +139 -0
data/src/lib/_aem/aemreference.rb +1022 -0
data/src/lib/_aem/codecs.rb +662 -0
data/src/lib/_aem/connect.rb +205 -0
data/src/lib/_aem/encodingsupport.rb +77 -0
data/src/lib/_aem/findapp.rb +85 -0
data/src/lib/_aem/mactypes.rb +251 -0
data/src/lib/_aem/send.rb +279 -0
data/src/lib/_aem/typewrappers.rb +59 -0
data/src/lib/_appscript/defaultterminology.rb +277 -0
data/src/lib/_appscript/referencerenderer.rb +245 -0
data/src/lib/_appscript/reservedkeywords.rb +116 -0
data/src/lib/_appscript/safeobject.rb +249 -0
data/src/lib/_appscript/terminology.rb +471 -0
data/src/lib/aem.rb +253 -0
data/src/lib/appscript.rb +1075 -0
data/src/lib/kae.rb +1489 -0
data/src/lib/osax.rb +659 -0
data/src/rbae.c +979 -0
data/test/README +3 -0
data/test/test_aemreference.rb +118 -0
data/test/test_appscriptcommands.rb +152 -0
data/test/test_appscriptreference.rb +106 -0
data/test/test_codecs.rb +186 -0
data/test/test_findapp.rb +26 -0
data/test/test_mactypes.rb +79 -0
data/test/test_osax.rb +54 -0
data/test/testall.sh +10 -0
metadata +145 -0

data/doc/appscript-manual/03_quicktutorial.html ADDED

@@ -0,0 +1,167 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title>rb-appscript manual | 3. Quick Tutorial</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+<style type="text/css" media="all"><!--@import url(../full.css);--></style>
+</head>
+<body>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
+<!-- top navigation -->
+<div class="navbar">
+<a href="02_aboutappscripting.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="04_gettinghelp.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
+</div>
+<!-- content -->
+<div id="content">
+<h2>3. Quick Tutorial</h2>
+<p>The following tutorial provides a practical taste of application scripting with appscript. Later chapters cover the technical details of appscript usage that are mostly skimmed over here.</p>
+<h3>'Hello World' tutorial</h3>
+<p>This tutorial uses appscript, TextEdit and the interactive command line Ruby interpreter to perform a simple 'Hello World' exercise.</p>
+<p class="hilitebox">Caution: It is recommended that you do not have any other documents open in TextEdit during this tutorial, as accidental modifications are easy to make and changes to existing documents are not undoable.</p>
+<p>To begin, launch Terminal.app and type <tt>irb</tt> followed by a newline to launch the interactive Ruby interpreter:</p>
+<pre><code>brian% irb
+irb(main):001:0&gt;</code></pre>
+<h4>Target TextEdit</h4>
+<p>The first step is to import the appscript module, <code>Appscript</code>, which provides the following functions and classes: <code>app</code>, <code>con</code>, <code>its</code>, <code>CommandError</code> and <code>ApplicationNotFoundError</code>.</p>
+<pre><code>irb&gt; require "appscript"
+=&gt; true
+irb&gt; include Appscript
+=&gt; Object</code></pre>
+<p>Once appscript is imported, create new <code>app</code> object, identifying the application to be manipulated, and assign it to a variable, <code>te</code>, for easy reuse:</p>
+<pre><code>irb&gt; te = app('TextEdit')
+=&gt; app("/Applications/TextEdit.app")</code></pre>
+<p>The application may be identified by name, path, bundle ID, creator type, Unix process id, or, if running remotely, URL. If the application is identified by name, path, bundle ID or creator type and is not already running, it will be launched automatically for you.</p>
+<h4>Create a new document</h4>
+<p>First, create a new TextEdit document by making a new <code>document</code> object. This is done using the <code>make</code> command, passing it a single keyword parameter, <code>:new =&gt; :document</code>, indicating the type of object to create:</p>
+<pre><code>irb&gt; te.make(:new =&gt; :document)
+=&gt; app("/Applications/TextEdit.app").documents[1]</code></pre>
+<p>Notice that keyword parameters are specified as an inline Hash with symbols as keys. The <a href="11_applicationcommands.html">Application Commands</a> chapter will discuss appscript's command syntax in more detail.</p>
+<p>Because <code>document</code> objects are always elements of the root <code>application</code> class, applications such as TextEdit can usually infer the location at which the new <code>document</code> object should appear. At other times, you need to supply an <code>at</code> parameter that indicates the desired location.</p>
+<p>As you can see, the <code>make</code> command returns a reference identifying the newly-created object. This reference can be assigned to a variable for easy reuse. Use the <code>make</code> command to create another document, this time assigning its result to a variable, <code>doc</code>:</p>
+<pre><code>irb&gt; doc = te.make(:new =&gt; :document)
+=&gt; app("/Applications/TextEdit.app").documents[1]</code></pre>
+<h4>Set the document's content</h4>
+<p>The next step is to set the document's content to the string <code>"Hello World"</code>. Every TextEdit document has a property, <code>text</code>, that represents the entire text of the document. This property is both readable and writeable, allowing you to retrieve and/or modify the document's textual content as unstyled unicode text.</p>
+<p>Setting a property's value is done using the <code>set</code> command. The <code>set</code> command is exposed as a method of the root <code>application</code> class and has two parameters: a direct (positional) parameter containing reference to the property (or properties) to be modified, and a keyword parameter, <code>to</code>, containing the new value. In this case, the direct parameter is a reference to the new document's <code>text</code> property, <code>doc.text</code>, and the <code>to</code> parameter is the string <code>"Hello World"</code>:</p>
+<pre><code>irb&gt; te.set(doc.text, :to =&gt; 'Hello World')
+=&gt; nil</code></pre>
+<p>The front TextEdit document should now contain the text '<tt>Hello World</tt>'.</p>
+<p>Because the above expression is a bit unwieldy to write, appscript allows it to be written in a more elegant OO-like format as a special case, where the <code>set</code> command is called upon the reference and the <code>to</code> keyword is omitted:</p>
+<pre><code>doc.text.set('Hello World')</code></pre>
+<p>Appscript converts this second form to the first form internally, so the end result is exactly the same. Appscript supports several such special cases, and these are described in the <a href="11_applicationcommands.html">Application Commands</a> chapter. Using these special cases produces more elegant, readable source code, and is recommended.</p>
+<h4>Get the document's content</h4>
+<p>Retrieving the document's text is done using the <code>get</code> command:</p>
+<pre><code>irb&gt; doc.text.get
+=&gt; "Hello World"</code></pre>
+<p>This may seem counter-intuitive if you're used to dealing with AppleScript or object-oriented Ruby references, where evaluating a literal reference returns the <em>value</em> identified by that reference. However, always remember that appscript 'references' are really first-class query objects: while the syntax may look familiar, any similarity is purely superficial. For example, when evaluating the literal reference:</p>
+<pre><code>te.documents[1].text</code></pre>
+<p>the result is another reference, <code>app("/Applications/TextEdit.app").documents[1].text</code>, not the value being referenced (<tt>'Hello World'</tt>). To get the value being referenced, you have to pass the reference as the direct argument to TextEdit's <code>get</code> command:</p>
+<pre><code>irb&gt; te.get(doc.text)
+=&gt; "Hello World!"</code></pre>
+<p>As usual, appscript provides an alternative convenience form that allow this to be written as:</p>
+<pre><code>doc.text.get</code></pre>
+<p>Depending on what sort of attribute(s) the reference identifies, <code>get</code> may return a primitive value (number, string, list, dict, etc.), or it may return another reference, or list of references, e.g.:</p>
+<pre><code>irb&gt; doc.text.get
+=&gt; "Hello World!"
+irb&gt; te.documents[1].get
+=&gt; app("/Applications/TextEdit.app").documents[1]
+irb&gt; te.documents.get
+=&gt; [app("/Applications/TextEdit.app").documents[1],
+    app("/Applications/TextEdit.app").documents[2]]
+irb&gt; te.documents.text.get
+=&gt; ["Hello World", ""]</code></pre>
+<h4>More on <code>make</code></h4>
+<p>The above exercise uses two commands to create a new TextEdit document containing the text '<tt>Hello World</tt>'. It is also possible to perform both operations using the <code>make</code> command alone by passing the value for the new document's <code>text</code> property via the <code>make</code> command's optional <code>with_properties</code> parameter:</p>
+<pre><code>irb&gt; te.make(:new =&gt; :document, :with_properties =&gt; {:text =&gt; 'Hello World'})
+=&gt; app('/Applications/TextEdit.app').documents[1]</code></pre>
+<p>Incidentally, you might note that every time the <code>make</code> command is used, it returns a reference to document <em>1</em>. TextEdit identifies its <code>document</code> objects according to the stacking order of their windows, with document 1 being frontmost. When the window stacking order changes, whether as a result of a script command or GUI-based interaction, so does the order of their corresponding <code>document</code> objects. This means that a previously created reference such as <code>app('/Applications/TextEdit.app').documents[1]</code> may now identify a different <code>document</code> object to before! Some applications prefer to return references that identify objects by name or unique ID rather than index to reduce or eliminate the potential for confusion, but it's an issue you should be aware of, particularly with long-running scripts where there is greater opportunity for unexpected third-party interactions to throw a spanner in the works.</p>
+<h4>More on manipulating <code>text</code></h4>
+<p>In addition to getting and setting a document's entire text by applying <code>get</code> and <code>set</code> commands to <code>text</code> property, it's also possible to manipulate selected sections of a document's text directly. TextEdit's <code>text</code> property contains a <code>text</code> object, which in turn has <code>character</code>, <code>word</code> and <code>paragraph</code> elements, all of which can be manipulated using a variety of commands: <code>get</code>, <code>set</code>, <code>make</code>, <code>move</code>, <code>delete</code>, etc. For example, to set the size of the first character of every paragraph of the front document to 24pt:</p>
+<pre><code>te.documents[1].text.paragraphs.size.set(24)</code></pre>
+<p>Or to insert a new paragraph at the end of the document:</p>
+<pre><code>te.make(
+        :new =&gt; :paragraph,
+        :with_data =&gt; "Hello Again, World\n",
+        :at =&gt; te.documents[1].text.paragraphs.end)</code></pre>
+</div>
+<!-- bottom navigation -->
+<div class="footer">
+<a href="02_aboutappscripting.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="04_gettinghelp.html">Next</a>
+</div>
+</body>
+</html>

data/doc/appscript-manual/04_gettinghelp.html ADDED

@@ -0,0 +1,188 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title>rb-appscript manual | 4. Getting Help</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+<style type="text/css" media="all"><!--@import url(../full.css);--></style>
+</head>
+<body>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
+<!-- top navigation -->
+<div class="navbar">
+<a href="03_quicktutorial.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="05_keywordconversion.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
+</div>
+<!-- content -->
+<div id="content">
+<h2>4. Getting Help</h2>
+<p>When developing appscript-based scripts, there are several ways to get information about applications' scripting interfaces: the ASDictionary application, appscript's powerful built-in <code>help</code> method, and introspection.</p>
+<h3>ASDictionary</h3>
+<p>ASDictionary, available from the appscript website's <a href="http://appscript.sourceforge.net/tools.html">Tools page</a>, provides a convenient GUI interface for exporting application terminology resources in plain text and HTML formats. ASDictionary can export HTML dictionaries in both single-file format and a frame-based format similar to rdoc's.</p>
+<h3>Built-in <code>help</code> method</h3>
+<p>Appscript's <code>Application</code> and <code>Reference</code> classes include a powerful interactive help system that allows you to explore applications' scripting interfaces from within running scripts and Ruby's interactive <code>irb</code> interpreter. The <code>help</code> method can provide information on any suite, class, command or reference, and display the inheritance and relationships for a selected class or the entire application.</p>
+<div class="hilitebox">Note that rb-appscript's built-in help system is only available when ASDictionary 0.9.0 or later is installed. If ASDictionary isn't available or is too old, invoking <code>help</code> will simply result in a "No help available" message and the script will continue to run as normal.</div>
+<p>Built-in help is invoked by calling an <code>app</code> object's <code>help</code> method, optionally passing it a string indicating the type of information you want. The resulting help message is printed to <code>stderr</code> and script execution continues as normal. For example, to view the help system's own help, call the <code>help</code> method with <code>'-h'</code> as its argument:</p>
+<pre><code>app('TextEdit').help('-h')</code></pre>
+<p>To print a description of any class or command or view inheritance and relationships, pass the <code>help</code> method a help string containing one or more of the following options:</p>
+<dl>
+<dt>-h</dt>
+<dd>show help</dd>
+<dt>-o</dt>
+<dd>overview of all suites, classes and commands</dd>
+<dt>-k</dt>
+<dd>list all built-in keywords (type names)</dd>
+<dt>-u [suite-name]</dt>
+<dd>summary of named suite or all suites</dd>
+<dt>-t [class-or-command-name]</dt>
+<dd>terminology for named class/command or current reference</dd>
+<dt>-i [class-name]</dt>
+<dd>inheritance tree for named class or all classes</dd>
+<dt>-r [class-name]</dt>
+<dd>one-to-one and one-to-many relationships for named class or current reference</dd>
+<dt>-s [property-or-element-name]</dt>
+<dd>values of properties and elements of object(s) currently referenced</dd>
+</dl>
+<p>Arguments (shown in brackets) are optional. Additional information on usage is available via <code>help('-h')</code>.</p>
+<p>Examples:</p>
+<pre><code>app('Finder').help('-o')
+app('Finder').help('-t window')
+app('Finder').files.help # same as help('-t')
+app('Finder').help('-d item -r folder -i container')
+app('Finder').files.help('-s')</code></pre>
+<p>To print detailed information on a specific reference, call its <code>help</code> method without arguments. Examples:</p>
+<pre><code>app('TextEdit').help
+app('TextEdit').version.help
+app('TextEdit').documents.help</code></pre>
+<p>To print detailed information on a specific command, call the <code>help</code> method on an application or reference object with the <code>-t</code> option followed by the command's name. Examples:</p>
+<pre><code>app('TextEdit').help('-t open')
+app('TextEdit').documents.help('-t count -t close')</code></pre>
+<div class="hilitebox">
+<p>Tip: <code>help</code> calls can safely be inserted at any point in a reference without disrupting your script's execution:</p>
+<pre><code>c = app('TextEdit')<strong>.help.help('-o -i -s')</strong>.documents.<strong>help</strong>[1]<strong>.help</strong>.count</code></pre>
+</div>
+<h3>Introspection</h3>
+<p>In addition to supporting Ruby's standard <code>#methods</code> and <code>#respond_to?</code> methods, appscript's <code>Application</code> and <code>Reference</code> classes also define several instance methods for obtaining information on the target application: </p>
+<dl>
+<dt><code>properties</code></dt>
+<dd>Returns a list of all property names.</dd>
+<dt><code>elements</code></dt>
+<dd>Returns a list of all element names.</dd>
+<dt><code>commands</code></dt>
+<dd>Returns a list of all command names.</dd>
+<dt><code>keywords</code></dt>
+<dd>Returns a list of all class, enumerator, type and property names.</dd>
+<dt><code>parameters(commandName)</code></dt>
+<dd>Takes a command's name as string and returns the names of its parameters.</dd>
+</dl>
+<p>As with Ruby's <code>Object#methods</code>, all of these methods return a list of strings.</p>
+<p>Examples</p>
+<pre><code>te = app('TextEdit')
+p te.commands
+# ["activate", "close", "count", "delete", "duplicate", "exists", ...]
+p te.parameters('make')
+# ["at", "new", "with_data", "with_properties"]</code></pre>
+<h3>ASTranslate</h3>
+<p>ASTranslate, available from the appscript website's <a href="http://appscript.sourceforge.net/tools.html">tools page</a>, provides a simple tool for translating application commands from AppleScript to Ruby syntax - useful when help is needed in converting existing AppleScript code to Ruby. For example, the following AppleScript selects every file in the Home folder:</p>
+<pre><code>tell application "Finder"
+	select (every file of home whose name extension is in {"htm", "html"})
+end tell</code></pre>
+<p>To obtain the appscript equivalent, paste this script into ASTranslate and select <code>Execute</code> from the <code>Document</code> menu. ASTranslate will intercept any Apple events sent by AppleScript and display them appscript format:</p>
+<pre><code>app("Finder").home.files[its.name_extension.is_in(["htm", "html"])].select
+OK</code></pre>
+<p>See ASTranslate's documentation for more information.</p>
+<h3>Notes</h3>
+<p>While appscript's documentation systems try to be reasonably forgiving of flawed or faulty terminology resources, there may be a few particularly problematic applications on which they fail. Should this happen, use ASDictionary to export the application's terminology in plain text format instead.</p>
+<h3>Other sources of help</h3>
+<ul>
+<li>The <code>sample</code> folder contains example scripts demonstrating a range of common tasks.</li>
+<li>Refer to any scripting documentation and example scripts supplied by the application developer.</li>
+<li>Look for third-party scripts that provide examples of use (though many of these scripts will be written in AppleScript rather than Ruby).</li>
+<li>The <a href="http://appscript.sourceforge.net">appscript website</a> has links to mailing lists and other general resources.</li>
+</ul>
+</div>
+<!-- bottom navigation -->
+<div class="footer">
+<a href="03_quicktutorial.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="05_keywordconversion.html">Next</a>
+</div>
+</body>
+</html>

data/doc/appscript-manual/05_keywordconversion.html ADDED

@@ -0,0 +1,106 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<title>rb-appscript manual | 5. Keyword Conversion</title>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+<style type="text/css" media="all"><!--@import url(../full.css);--></style>
+</head>
+<body>
+<h1><img src="../rb-appscript-logo.png" alt="rb-appscript" title="rb-appscript" /></h1>
+<!-- top navigation -->
+<div class="navbar">
+<a href="04_gettinghelp.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="06_classesandenums.html">Next</a>
+<span>
+<strong><a href="../appscript-manual/index.html">appscript</a></strong> /
+<a href="../mactypes-manual/index.html">mactypes</a> /
+<a href="../osax-manual/index.html">osax</a> /
+<a href="../aem-manual/index.html">aem</a>
+</span>
+</div>
+<!-- content -->
+<div id="content">
+<h2>5. Keyword Conversion</h2>
+<h3>Keyword conversion</h3>
+<p>Because application terminology resources specify AppleScript-style keywords for class, property, command, etc. names, appscript uses the following rules to translate these keywords to legal Ruby identifiers:</p>
+<ul>
+<li>Characters a-z, A-Z, 0-9 and underscores (_) are preserved.</li>
+<li>Spaces, hyphens (-) and forward slashes (/) are replaced with underscores.</li>
+<li>Ampersands (&amp;) are replaced by the word 'and'.</li>
+<li>All other characters are converted to 0x00-style hexadecimal representations.</li>
+<li>Names that begin with '_' or 'AS_' have an underscore appended.</li>
+<li>Names that match the methods already defined on appscript's Application and Reference classes have an underscore appended. The reserved method names are:
+<pre><code>abort_transaction             ignore
+after                         inspect
+and                           instance_eval
+any                           instance_variable_get
+before                        instance_variable_set
+begin_transaction             instance_variables
+beginning                     is_in
+begins_with                   is_not_in
+by_aem_app                    keywords
+by_creator                    last
+by_id                         launch
+by_name                       le
+by_pid                        lt
+by_url                        method
+class                         method_missing
+clone                         methods
+commands                      middle
+contains                      ne
+current                       next
+display                       not
+does_not_begin_with           object_id
+does_not_contain              or
+does_not_end_with             parameters
+dup                           previous
+elements                      private_methods
+end                           properties
+end_transaction               protected_methods
+ends_with                     public_methods
+eq                            result_type
+extend                        send
+first                         singleton_methods
+freeze                        taint
+ge                            timeout
+gt                            to_a
+hash                          to_s
+help                          type
+ID                            untaint
+id                            wait_reply</code></pre>
+</li>
+<li>Appscript provides default terminology for standard type classes such as <code>integer</code> and <code>unicode_text</code>, and standard commands such as <code>open</code> and <code>quit</code>. If an application-defined name matches a built-in name but has a different Apple event code, appscript will append an underscore to the application-defined name.</li>
+</ul>
+<p class="hilitebox">You can use ASDictionary or appscript's built-in <code>help</code> method to export or view application terminology in appscript format. See the <a href="04_gettinghelp.html">Getting Help</a> chapter for more information.</p>
+</div>
+<!-- bottom navigation -->
+<div class="footer">
+<a href="04_gettinghelp.html">Previous</a> &bull;
+<a href="index.html">Up</a> &bull;
+<a href="06_classesandenums.html">Next</a>
+</div>
+</body>
+</html>