svn commit - mysqldoc@docsrva: r4042 - trunk/gui-common

[plavin]

Author: plavin
Date: 2006-11-27 19:30:55 +0100 (Mon, 27 Nov 2006)
New Revision: 4042

Log:
Start description of the GRT shell

Modified:
   trunk/gui-common/chapter-grt-shell.xml


Modified: trunk/gui-common/chapter-grt-shell.xml
===================================================================
--- trunk/gui-common/chapter-grt-shell.xml	2006-11-27 17:29:45 UTC (rev 4041)
+++ trunk/gui-common/chapter-grt-shell.xml	2006-11-27 18:30:55 UTC (rev 4042)
Changed blocks: 4, Lines Added: 95, Lines Deleted: 20; 4965 bytes

@@ -16,14 +16,31 @@
     <title>Introduction</title>
 
     <para>
-      The GRT is used by both MySQL Workbench and the MySQL Migration
-      Toolkit.
+      The GRT is a thin C layer, inspired by Objective C, which allows
+      for dynamic typing and dynamic data objects. The GRT is used by
+      both &workbench; and the &migration_toolkit; and provides a means
+      for expanding these tools. Through the use of the GRT, these tools
+      can support new behavior and data sources using code written in
+      languages such as C, C++, Java, Python, and Lua with support for
+      Mono forthcoming.
     </para>
 
     <para>
-      Lua
+      The preferred development language is <literal>Lua</literal>, a
+      light-weight scripting language expressly designed for extending
+      applications. For more information about this language see
+      <ulink url="http://www.lua.org/">lua.org</ulink>.
     </para>
 
+    <note>
+      <para>
+        The GRT shell is used both in the &migration_toolkit; and the
+        &workbench;. However, the &migration_toolkit; is only available
+        for Windows. The implementation of the GRT Shell varies
+        depending upon the operating system.
+      </para>
+    </note>
+
   </section>
 
 <!-- End INTRODUCTION -->

@@ -37,31 +54,99 @@
       <literal>&migration_toolkit;</literal> choose the
<guimenu>GRT
       Environment Shell</guimenu> option under the
       <guimenu>Tools</guimenu> menu. In
<literal>&workbench;</literal>
-      choose <guimenu>View</guimenu>,
<guimenu>Advanced</guimenu>,
-      <guimenu>Show GRT Shell</guimenu>. However, the simplest way to
-      open the GRT Shell in either application is to use the
+      under Windows, choose <guimenu>View</guimenu>,
+      <guimenu>Advanced</guimenu>, <guimenu>Show GRT
Shell</guimenu>.
+      However, the simplest way to open the GRT Shell in either
+      application or under any operating system is to use the
       <keycap>F4</keycap> key. If you haven't docked the GRT shell
       window you should see something similar to the following:
     </para>
 
     <figure>
-      <title>The GRT shell</title>
+      <title>The GRT shell (Windows)</title>
       <mediaobject>
         <imageobject>
           <imagedata fileref="images/grt-shell.png" format="PNG" lang="en"/>
         </imageobject>
         <textobject>
-          <phrase lang="en">The GRT shell</phrase>
+          <phrase lang="en">The GRT shell (Windows)</phrase>
         </textobject>
       </mediaobject>
     </figure>
 
+    <para></para>
+
     <section>
 
       <title>Menu Items</title>
 
-      <para></para>
+      <section>
 
+        <title>The File Menu</title>
+
+        <section>
+
+          <title>Windows File Menu</title>
+
+          <para>
+            Currently only two of the submenus under the
+            <guimenu>File</guimenu> menu are implemented;
+            <guimenu>Exit</guimenu>, which simply exits the GRT shell,
+            and <guimenu>Open Script</guimenu>.
+          </para>
+
+          <para>
+            The <guimenu>Open Script</guimenu> option is for opening
+            existing lua scripts and is only implemented
+            under Windows.
+          </para>
+
+          <para>
+            Sample scripts are found in the <filename>Scripts</filename>
+            directory which is immediately below the default installation
+            directory. Opening a script from this menu option
+            will create an addional tab 
+          </para>
+
+        </section>
+
+        <section>
+
+          <title>Linux Shell Menu</title>
+
+          <para>
+            Under Linux the equivalent to the <guimenu>File</guimenu>
+            menu is the <guimenu>Shell</guimenu> menu. This menu item
+            gives you options to close the shell, refresh the shell
+            screen or save the object tree.
+          </para>
+
+          <para>
+            The <guimenu>Save Tree ...</guimenu> menu item saves an XML
+            file of the hierarchy of objects shown on the upper right in
+            <literal>Values</literal> tab of the object tree.
+          </para>
+
+          <para>
+            Under Linux there is no menu option to open a script.
+
+            <remark>
+              Check OS X
+            </remark>
+          </para>
+
+        </section>
+
+      </section>
+
+      <section>
+
+        <title>View Menu</title>
+
+        <para></para>
+
+      </section>
+
     </section>
 
     <section>

@@ -79,7 +164,7 @@
 
     <section>
 
-      <title>Menu Items</title>
+      <title>GRT Globals Tree</title>
 
       <para></para>
 

@@ -99,15 +184,5 @@
 
 <!-- End Using -->
 
-  <section>
-
-    <title>Extending &gui_tools; With the GRT</title>
-
-    <para></para>
-
-  </section>
-
-<!-- End Extending -->
-
 </chapter>
 <!-- end GRT Shell -->