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

[plavin]

Author: plavin
Date: 2006-11-29 01:33:23 +0100 (Wed, 29 Nov 2006)
New Revision: 4068

Log:
Minor changes

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-28 21:49:12 UTC (rev 4067)
+++ trunk/gui-common/chapter-grt-shell.xml	2006-11-29 00:33:23 UTC (rev 4068)
Changed blocks: 12, Lines Added: 54, Lines Deleted: 26; 6717 bytes

@@ -104,7 +104,7 @@
 
       <para>
         The menu runs across the top of the screen and varies
-        significantly depending upon the OS. Since the
+        significantly depending upon which OS you are using. Since the
         &migration_toolkit; is currently only implemented on Windows,
         all references to invoking the GRT shell from this application
         apply only to the Windows OS.

@@ -145,16 +145,16 @@
           <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.
+            Under Linux the <guimenu>Shell</guimenu> menu 
+            shows menu items
+            for closing the shell, refreshing the objects 
+            listed in the Global tree or saving the object tree.
           </para>
 
           <para>
-            The <guimenu>Save Tree ...</guimenu> menu item saves an XML
-            file of the hierarchy of the objects currently loaded. These
-            are the objects shown in the three tabs of the
+            The <guimenu>Save Tree ...</guimenu> menu option saves an XML
+            file of all the data types and classes shown in the 
+            three tabs of the
             <literal>Objects Tree</literal>.
           </para>
 

@@ -258,8 +258,8 @@
 
       <para>
         The <literal>Snippets</literal> tab functions as a scratch pad
-        for saving code snippets. This makes it easy to reuse code you
-        are repeatedly typing at the command line.
+        for saving code snippets. This makes it easy to reuse code 
+        without having to retype it at the command line.
       </para>
 
       <para>

@@ -288,14 +288,14 @@
           How are these different?
         </remark>
       </para>
+      
 
       <section>
 
         <title>The <literal>Values</literal> Tab</title>
 
         <para>
-          The <literal>Values</literal> tab shows the current state of
-          the application. The objects shown in this tab differ
+          The objects shown in this tab differ
           depending upon which &gui_tools; application you are running.
           For example, if you are running &workbench; you should find a
           <literal>workbench</literal> object beneath the

@@ -354,7 +354,8 @@
 
           With the exception of <guimenu>Remove Object</guimenu>, these
           options are the same as those shown in
-          <xref linkend="grt-view-menu"/>.
+          <xref linkend="grt-view-menu"/>. You may remove any object
+          except the <literal>root</literal> object.
         </para>
 
         <note>

@@ -370,6 +371,8 @@
         <title>The <literal>Struct</literal> Tab</title>
 
         <para>
+          This tab contains the definitions of the structs
+          used in the <literal>Values</literal> tab.
           <remark>
             Structures - C struct data types?
           </remark>

@@ -416,17 +419,20 @@
         <title>The <literal>Modules</literal> Tab</title>
 
         <para>
-          Go to the <literal>Modules</literal> tab and click on the
+          A module can be either a Python or Lua script or a
+          Java class file. Information about this module appears 
+          in the window below the
+          module tree. For example, 
+          go to the <literal>Modules</literal> tab and click on the
           <literal>ReverseEngineeringGeneric</literal> module.
-          Information about this module appears in the window below the
-          module tree. Double click to a module and you will see its
-          methods. A module can be either a Python or Lua script or a
-          Java class file.
+           Double click a module and you will see its
+          methods. 
         </para>
 
         <para>
-          All the objects described here are accessible from the GRT
-          shell.
+          Double clicking a method name will copy it into the 
+          GRT shell window. You will see how useful this can be in
+          <xref linkend="using-grt-shell"/>.
         </para>
 
       </section>

@@ -442,6 +448,7 @@
     <title>Using the GRT Shell</title>
 
     <para>
+      
       There are three built-in Lua modules that assist working from the
       GRT shell:
 

@@ -456,7 +463,7 @@
 
         <listitem>
           <para>
-            <literal>grtS</literal> &ndash; for accessing any object in
+            <literal>grtS</literal> &ndash; for viewing the structs
defined in
             the <literal>Structures</literal> tab
           </para>
         </listitem>

@@ -470,22 +477,37 @@
 
       </itemizedlist>
     </para>
+    
+    
+    <para>
+      All items in all the tabs are accessible from the GRT
+      shell.
+    </para>
 
     <para>
       The script example below uses the <literal>getGlobal</literal>
-      method of the <literal>grtV</literal> object to iterate through
-      the database formats:
+      method of the <literal>grtV</literal> object to return a list
+      of databases and then iterates through
+      this list.
     </para>
 
 <programlisting>
 dbs = grtV.getGlobal("/rdbmsMgmt/rdbms")
-for i= 1, grtV.getn(dbs) do
+for i = 1, grtV.getn(dbs) do
    print(dbs[i].name)
 end
 </programlisting>
 
     <para>
-      Running this <literal>for</literal> loop outputs the database
+      The <literal>getGlobal</literal> method returns the object found
+      at the path parameter passed to it. In this case, the object is a list
+      that is traversed using a <literal>for</literal> loop
+      controlled by the <literal>getn</literal> method which returns
+      the number of elements in the database list.
+    </para>
+    
+    <para>
+      Running this <literal>for</literal> loop outputs the names of the
database
       formats supported by the &workbench; and the &migration_toolkit;:
     </para>
 

@@ -499,7 +521,7 @@
 </programlisting>
 
     <para>
-      To discover all the methods available for a specific object type
+      To discover all the methods available for a specific object, type
       the object name preceded by a
&lsquo;<literal>?</literal>&rsquo;.
       For example typing <command>?grtV</command> shows:
     </para>

@@ -521,6 +543,12 @@
 
 Type 'help grtV.&lt;command&gt;' to get help on a specific command.
 </programlisting>
+    <para>
+      <remark>
+        Add an object that will appear in the tab?
+        i.e definition of an different database struct?
+      </remark>
+    </para>
 
   </section>