Author: plavin
Date: 2007-08-29 22:06:14 +0200 (Wed, 29 Aug 2007)
New Revision: 7594
Log:
Copy material from GUI Tools where applicable
Added:
trunk/workbench-pro/grt-shell.xml
trunk/workbench-pro/using.xml
Modified:
trunk/workbench-pro/installing.xml
trunk/workbench-pro/uninstalling.xml
trunk/workbench-pro/version.ent
trunk/workbench-pro/workbench-pro.xml
Added: trunk/workbench-pro/grt-shell.xml
===================================================================
--- trunk/workbench-pro/grt-shell.xml (rev 0)
+++ trunk/workbench-pro/grt-shell.xml 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 1, Lines Added: 717, Lines Deleted: 0; 23700 bytes
@@ -0,0 +1,717 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<chapter id="grt-shell">
+
+ <title>The Generic Runtime Environment (GRT) Shell</title>
+
+ <section id="grt-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ The GRT is a thin C layer, inspired by Objective C, which allows
+ for dynamic typing and dynamic data objects. The GRT provides a means
+ for expanding &workbench_pro;. Through the use of the GRT, &workbench_pro;
+ 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>
+ The GRT is not only useful for expanding &workbench_pro;. By using a
+ script file from within the GRT shell you can perform repetitive
+ tasks programmatically from the command line. Suppose, for
+ example, that you have multiple schemata that you wish to migrate
+ to MySQL. You can do this once using the graphical interface, in
+ the process saving the procedure as a script file. You can then
+ adapt this script file and run it unattended from the GRT shell.
+ </para>
+
+ <para>
+ The preferred development language is <literal>Lua</literal>, a
+ lightweight scripting language expressly designed for extending
+ applications. For more information about this language see
+ <ulink url="http://www.lua.org/">lua.org</ulink>.
+ </para>
+
+ </section>
+
+<!-- End INTRODUCTION -->
+
+ <section id="exploring-grt-shell">
+
+ <title>Exploring the GRT Shell</title>
+
+ <para>
+ To open the GRT shell click on the <guimenu>View</guimenu>
+ menu and choose the <guimenu>GRT Shell</guimenu> option under the
+ <guimenu>Advanced</guimenu> submenu. However, the simplest way to
+ open the GRT Shellis to use
+ the <keycap>F4</keycap> key.
+ </para>
+ <!--If you haven't docked the GRT shell
+ window you should see something similar to the following:
+ </para>
+
+ <figure>
+ <title>The GRT shell (Windows)</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/grt-shell.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The GRT shell (Windows)</phrase>
+ </textobject>
+ </mediaobject>
+ </figure-->
+
+ <para>
+ The GRT shell itself is the default tab on the left of the screen.
+ Beside it is the <literal>Snippets</literal> tab, used for saving
+ code snippets.
+ </para>
+
+ <para>
+ On the right, is the <literal>GRT Globals
+ Tree</literal>—showing the various objects, variables,
+ structures, and code modules used by the application. These
+ objects are all directly accessible from the shell.
+ </para>
+
+ <!--section id="grt-menu-items">
+
+ <title>Menu Items</title>
+
+ <para>
+ The menu runs across the top of the screen and varies
+ significantly depending upon which OS you are using.
+ </para>
+
+ <section>
+
+ <title>The File or Shell Menu</title>
+
+ <section>
+
+ <title>Windows File Menu</title>
+
+ <para id="grt-file-menu">
+ 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>. The <guimenu>Open
+ Script</guimenu> option is for opening existing
+ <literal>Lua</literal> scripts and is only implemented under
+ Windows.
+ </para>
+
+ <para>
+ Sample scripts are found in the <filename>Scripts</filename>
+ directory which is immediately below the installation
+ directory. Opening a script from this menu option will
+ create an additional tab labeled with the name of the
+ script. Click on this tab to see the file contents. You may
+ paste text between the <literal>GRT Shell</literal> tab and
+ any script tab.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>Linux Shell Menu</title>
+
+ <para>
+ 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 option saves an
+ XML file of all the data types and classes shown in the
+ three tabs of the <literal>Objects Tree</literal>.
+ </para>
+
+ <para>
+ Under Linux there is no menu option to open a script.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section id="grt-view-menu">
+
+ <title>The View Menu</title>
+
+ <section>
+
+ <title>The View Menu: Windows</title>
+
+ <para>
+ The <guimenu>Refresh</guimenu> option of the
+ <guimenu>View</guimenu> menu refreshes the view of the
+ objects shown in the object tree tabs on the right.
+ </para>
+
+ <para>
+ The <guimenu>Display Type Info</guimenu> and
+ <guimenu>Display Object Values</guimenu> menu items toggle
+ the view of the objects in the <literal>Values</literal> tab
+ on the right. When checked, <guimenu>Display Type
+ Info</guimenu> shows the data type of objects and
+ <guimenu>Display Object Values</guimenu> shows their value.
+
+ <remark>
+ [PL]Same as panel below or not?
+ </remark>
+ </para>
+
+ <para>
+ The <guimenu>Display Object Refcount</guimenu> shows the
+ current number of references to specific objects.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>The View Menu: Linux</title>
+
+ <para>
+ The <guimenu>View</guimenu> menu has only one element,
+ <guimenu>Structure Only</guimenu> and it is not yet
+ activated.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section>
+
+ <title>Mac OS X Menu</title>
+
+ <para>
+ Under Mac OS X there are only two menu options,
+ <guimenu>Reload</guimenu> and <guimenu>Reload
+ Selected</guimenu>. <guimenu>Reload</guimenu> reloads all the
+ objects in the Object Tree panel and is equivalent to the
+ Windows <guimenu>View</guimenu>, <guimenu>Refresh</guimenu>
+ option. The <guimenu>Reload Selected</guimenu> option only
+ reloads the selected object.
+ </para>
+
+ </section>
+
+ </section>
+
+ <section id="grt-shell-window">
+
+ <title>The Shell</title>
+
+ <para>
+ The GRT shell is principally used for running Lua scripts or
+ typing Lua commands directly. However, you can also access the
+ GRT Scripting Library functions and global functions and
+ objects. To see the available commands type
+ ‘<literal>?</literal>’.
+ </para>
+
+ <para>
+ Some OS-specific commands are also available. For instance,
+ under Windows you can clear the screen by typing
+ <command>cls</command>. Unlike most shells, you can cut and
+ paste text to and from the shell window.
+ </para>
+
+ <para>
+ Working from the command line is described in detail in
+ <xref linkend="using-grt-shell"/>.
+ </para>
+
+ <para>
+ The <literal>Snippets</literal> tab functions as a scratch pad
+ for saving code snippets. This makes it easy to reuse code and
+ does away with the need to retype it at the command line.
+ </para>
+
+ <para>
+ If you have opened script files as described in
+ <xref linkend="grt-file-menu"/>, there may be any number of tabs
+ to the right of the <literal>Snippets</literal> tab. These tabs
+ will be labeled with the names of the script files. As with the
+ <literal>Snippets</literal> tab you can cut and paste to or from
+ any of the tabs. This gives you the opportunity to test code
+ from the command line.
+ </para>
+
+ </section-->
+
+ <!--section id="grt-globals-tree-panel">
+
+ <title>The Globals Tree Panel</title>
+
+ <para>
+ The <literal>Globals Tree</literal> is found on the right side
+ of the screen and is made up of three tabs,
+ <literal>Values</literal>, <literal>Structs</literal>, and
+ <literal>Modules</literal>.
+
+ <remark>
+ How are these different?
+ </remark>
+ </para>
+
+ <section>
+
+ <title>The <literal>Values</literal> Tab</title>
+
+ <para>
+ 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
+ <literal>root</literal> object. If you currently have a schema
+ loaded you should be able to find it beneath the
+ <literal>workbench</literal> object. Clicking
+ <literal>workbench </literal> will expose the
+ <literal>catalog</literal> object and clicking this object in
+ turn will show <literal>charcterSets</literal>,
+ <literal>schemata</literal>, and
+ <literal>simpleDataTypes</literal>. Beneath
+ <literal>schemata</literal> you should see the default
+ <literal>New Schema</literal> plus any schemata you have
+ loaded. Detailed information about the currently selected
+ object appears in the window below the module tree.
+ </para>
+
+ <para>
+ If you are running &migration_toolkit;, the
+ <literal>workbench</literal> object is absent but you will
+ find a <literal>migration</literal> object beneath the
+ <literal>root</literal> object. Both applications show the
+ <literal>rdbmsMgmt</literal> object.
+ </para>
+
+ <para>
+ When the <literal>Values</literal> tab is selected right
+ clicking an object in the Globals Tree panel opens a pop-up
+ menu with the options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Refresh
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Remove Object
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Type Info
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Object Values
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Display Object RefCount
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ With the exception of <guimenu>Remove Object</guimenu>, these
+ options are the same as those shown in
+ <xref linkend="grt-view-menu"/>. You may remove any object
+ except the <literal>root</literal> object.
+ </para>
+
+ <note>
+ <para>
+ Note this pop-up menu only shows under Windows.
+ </para>
+ </note>
+
+ </section>
+
+ <section>
+
+ <title>The <literal>Struct</literal> Tab</title>
+
+ <para>
+ A <literal>struct</literal> is a user-defined data type formed
+ by combining primitive data types. This tab shows the
+ definitions of the structs used by the objects in the
+ <literal>Values</literal> tab and the modules in the
+ <literal>Modules</literal> tab.
+ </para>
+
+ <para>
+ When the <literal>Structs</literal> tab is selected right
+ clicking a structure in the list opens a pop-up menu with the
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Order by Name
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Order by Hierarchy
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Order by Package
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <note>
+ <para>
+ Note this pop-up menu only shows under Windows.
+ </para>
+ </note>
+
+ <para>
+ The default view for this tab is by package, a grouping of
+ elements by functionality. Double-click a package to show
+ related structures. Under <literal>db.mgmt</literal>, for
+ example, you should see elements you are already familiar with
+ from the user interface, <literal>Connection</literal>,
+ <literal>Driver</literal>, and so forth. If an element can be
+ further decomposed, an arrow will show on it's left.
+ Double-click the item to reveal its constituent elements.
+ </para>
+
+ <para>
+ If you switch to the hierarchical view you'll find the
+ <literal>db.mgmt.driver</literal> object under the
+ <literal>GRT Object</literal> since this is the parent object
+ from which it is derived.
+ </para>
+
+ <para>
+ Ordering by name simply shows all the different objects
+ arranged alphabetically.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>The <literal>Modules</literal> Tab</title>
+
+ <para>
+ A module can be either a Python or Lua script or a Java class
+ file. Information about modules 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. Double
+ click a module and you will see its methods.
+ </para>
+
+ <para>
+ 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>
+
+ </section-->
+
+ </section>
+
+<!--End Exploring-->
+
+ <section id="using-grt-shell">
+
+ <title>Using the GRT Shell</title>
+
+ <para>
+ There are three built-in Lua modules that assist working from the
+ GRT shell:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>grtV</literal> – for accessing any
+ object/variable in the <literal>Values</literal> tab
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>grtS</literal> – for viewing the structs
+ defined in the <literal>Structures</literal> tab
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>grtM</literal> – for accessing any object in
+ the <literal>Modules</literal> tab
+ </para>
+
+ <para>
+ <remark>grtA grtU</remark>
+ </para>
+
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ All items in all the tabs are accessible from the GRT shell.
+
+ <remark>
+ You can use the structs defined ...
+ </remark>
+ </para>
+
+ <para>
+ The script example below uses the <literal>getGlobal</literal>
+ 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
+ print(dbs[i].name)
+end
+</programlisting>
+
+ <para>
+ 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_pro;:
+ </para>
+
+<programlisting>
+"Oracle"
+"Mysql"
+"MaxDB"
+"GenericJdbc"
+"Mssql"
+"Access"
+</programlisting>
+
+ <para>
+ To discover all the methods available for a specific object, type
+ the object name preceded by a ‘<literal>?</literal>’.
+ For example typing <command>?grtV</command> shows:
+ </para>
+
+<programlisting>
+GRT Value Management Library - grtV
+-----------------------------------
+A library that contains functions to work with GRT values.
+
+clearList child diffMake
+diffApply duplicate fromXml
+getContentType getKey getListItemByObjName
+getListRefValueByObjName getn getGlobal
+insert load lookupAdd
+lookupId newDict newList
+newObj remove save
+setContentType setGlobal toLua
+toXml typeOf
+
+Type 'help grtV.<command>' 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?
+ Above list needs changing.
+ </remark>
+ </para>
+
+ </section>
+
+ <section id="invoking-grt-from-command-line">
+
+ <title>Invoking the GRT Shell From the Command Line</title>
+
+
+ <para>
+ In addition to using the GRT shell from within the &workbench_pro;,
+ you can invoke it directly from the
+ command line. If the location of the &workbench_pro; is not included
+ in the <literal>PATH</literal> variable, navigate to the
+ installation directory and find the <filename>MySQLGrtShell.exe</filename>
+ file.
+ </para>
+
+ <para>
+ Execute this file by typing:
+ </para>
+
+<programlisting>
+C:\> <userinput>MySQLGrtShell.exe -?</userinput>
+</programlisting>
+
+ <para>
+ Do this and you should see the following listing:
+ <remark>Not yet Implemented</remark>
+ </para>
+
+<programlisting>
+Usage: C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe [-classpath path] »
+ [-modulepath path] [-jvm library] [-d path] [-listen port] [-verbose] [-x] [luafile]
+ C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -j structsfile outputdir
+ C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -p structsfile outputdir
+
+ -lua ......... Use the Lua shell (default).
+ -py .......... Use the Python shell.
+ -classpath ... Sets the java classpath to the given value.
+ -modulepath .. Sets the location of the GRT module directory.
+ -jvm ......... The java virtual machine library to use (with absolute path).
+ -basedir ..... Path to the data files location.
+ -d path ...... Modules directory
+ -x ........... Exits the shell after running the specified file
+ luafile ...... File that is run at startup.
+
+ -listen port . Runs in 'remote agent' mode on the given port number.
+ -verbose ..... Prints detailed startup information.
+ -j ........... Generates Java classes from the given structs file.
+ -p ........... Generates PHP classes from the given structs file.
+ -D var=value . Sets a global shell variable to the given value.
+Environment variables:
+GRT_MODULE_PATH Equivalent to -modulepath, must point to the directory
+ where the grtsh binary resides
+</programlisting>
+
+ <para>
+ The default shell is the <literal>Lua</literal> shell and is
+ indicated by the <literal>/ ></literal> prompt. Using the
+ <option>-py</option> option opens a Python shell, indicated by the
+ <literal>/>>></literal> prompt.
+ </para>
+
+ <para>
+ If you wish to set the classpath for Java classes use the
+ <option>classpath</option> option. You may also change the Java
+ Virtual Machine (JVM) by using the <option>jvm</option> option
+ with the absolute path to the JVM you wish to use.
+ </para>
+
+ <para>
+ The <option>modulepath</option> option sets the location of the
+ <filename>dll</filename> files used with the GRT shell. These
+ files are located in the same directory as the
+ <filename>grtsh.exe</filename> file. You can also set this
+ directory by defining the environment variable,
+ <literal>GRT_MODULE_PATH</literal>.
+ </para>
+
+ <para>
+ The location of any data files you wish to use may be set using
+ the <option>basedir</option> option.
+
+ <remark>
+ [PL]What are data files?
+ </remark>
+ </para>
+
+ <para>
+ To see the various modules that are loaded at startup use the
+ <option>verbose</option> option. The java modules are stored in
+ the <filename>java\com\mysql\grt\modules</filename> directory
+ immediately below the installation directory and the
+ <literal>Lua</literal> modules in the <filename>lua</filename>
+ directory. Currently, importing Python modules is not supported.
+ </para>
+
+ <para>
+ To include modules other than the default modules, use the
+ <option>d</option> option with a path.
+ </para>
+
+ <para>
+ It is also possible to use the GRT shell to convert XML files to
+ Java or PHP class files, by opening the shell using the
+ <option>j</option> or the <option>p</option> option and specifying
+ the XML source file and the destination directory.
+ </para>
+
+ <para>
+ Use the <option>listen</option> option with a port number to run
+ the GRT shell as a service that can be accessed from a remote
+ location.
+ </para>
+
+ <para>
+ Perhaps most importantly, you can pass a <literal>Lua</literal>
+ script to the shell on startup. This allows you to perform tasks
+ using a script file without even opening the &workbench_pro;.
+ This is an especially useful feature if you
+ need to migrate the same database a number of times or you want to
+ customize a migration. You can easily create a
+ <literal>Lua</literal> script by clicking the <guibutton>Generate
+ Migration Script</guibutton> when migrating using the graphical
+ interface.
+ <!-- For information on creating a Lua script see,
+ xref linkend="mysql-migration-toolkit-indepth-summary". A Lua
+ migration script is examined in detail in
+ linkend="scripted-migration" /-->.
+ </para>
+
+ <para>
+ Passing a <literal>Lua</literal> file to the shell is usually
+ invoked using the <option>x</option> option so that the shell
+ closes after the script has executed.
+ </para>
+
+ <para>
+ The appearance of the GRT shell run from the command line is
+ identical to its appearance when run from within the &workbench_pro;.
+ All the commands and options described
+ in <xref linkend="using-grt-shell"/> are available when the GRT
+ shell is invoked from the command line.
+ </para>
+
+ </section>
+
+<!--End Using -->
+
+</chapter>
+<!-- end GRT Shell -->
Modified: trunk/workbench-pro/installing.xml
===================================================================
--- trunk/workbench-pro/installing.xml 2007-08-29 19:12:53 UTC (rev 7593)
+++ trunk/workbench-pro/installing.xml 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 1, Lines Added: 64, Lines Deleted: 41; 4873 bytes
@@ -8,80 +8,103 @@
<chapter id="workbench-pro-installing">
<title>Installation of &workbench_pro;</title>
-
+
<section>
+
<title>Requirements</title>
-
+
<para>
+ Currently, &workbench_pro; is available for Windows only.
+
+<!--
The &workbench_pro; requires the Java
Runtime Environment (JRE). The minimum version supported is 5.0
- update 8.
+ update 8.-->
</para>
-
+
<para>
- A working, current
- <literal>OpenGL</literal> installation is required by the
- &workbench_pro;. To find out more about <literal>OpenGL</literal> got
- to <ulink url="http://www.opengl.org/">www.opengl.org</ulink>. The
+ The <literal>.Net 2.0 </literal> Framework is also a requirement.
+ If you do not already have this framework installed download it
+ <ulink url="http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5">here</ulink>.
+ You may also need the <literal>VS2005.net
+ Redistributable</literal> but first try &workbench_pro;. If the
+ application does not start download <literal>VS2005.net
+ Redistributable</literal>
+ <ulink url="http://www.microsoft.com/downloads/details.aspx?FamilyID=200b2fd9-ae1a-4a14-984d-389c36f85647&DisplayLang=en">here</ulink>.
+ </para>
+
+ <para>
+ A working, current <literal>OpenGL</literal> installation is
+ required by the &workbench_pro;. To find out more about
+ <literal>OpenGL</literal> got to
+ <ulink url="http://www.opengl.org/">www.opengl.org</ulink>. The
installation of OpenGL is beyond the scope of this document.
</para>
-
+
<para>
&workbench_pro; runs on recent 32-bit Windows NT based operating
- systems, including Windows 2000, XP, Vista, and 2003. It doesn't run on
- Windows NT 4 and below.
+ systems, including Windows 2000, XP, Vista, and 2003. It doesn't
+ run on Windows NT 4 and below.
</para>
-
-
+
</section>
-
- <section>
-
- <title>Installing &workbench_pro;</title>
-
-
+
+ <section id="workbench-pro-installation-using-installer">
+
+ <title>Installing &workbench_pro; Using the Installer</title>
+
<para>
- Download the zipped file to a convenient location and
- decompress it.
- </para>
-
- <para>
- Unless you choose otherwise, &gui_tools; are installed in
+ Unless you choose otherwise, &workbench_pro; is installed in
<literal>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL
- Tools for <replaceable>version</replaceable>\</literal>, where
- <replaceable>%PROGRAMFILES%</replaceable> is the default
- directory for programs on your machine and
- <literal>version</literal> is the version number of &gui_tools;.
- The <literal>%PROGRAMFILES%</literal>directory might be
+ Tools for <replaceable>version</replaceable>\</literal>, where
+ <replaceable>%PROGRAMFILES%</replaceable> is the default directory
+ for programs on your machine and <literal>version</literal> is the
+ version number of &workbench_pro;. The
+ <literal>%PROGRAMFILES%</literal>directory might be
<literal>C:\Program Files</literal> or
<literal>C:\programme</literal>.
</para>
-
+
<note>
<para>
- Installing &gui_tools; using the Windows installer
+ Installing &workbench_pro; using the Windows installer
automatically creates entries in the <literal>Start</literal>
menu.
</para>
-
-
+ </note>
+
</section>
-
- <section id="&workbench_pro;-installation-zip">
-
+
+ <section id="workbench-pro-installation-zip">
+
<title>Installing From the ZIP File</title>
-
+
<para>
+ Download the zipped file to a convenient location and decompress
+ it.
+ </para>
+
+ <para>
If you are having problems running the installer, as an
alternative, you can download a ZIP file without an installer.
That file is called
- <literal>mysql-gui-tools-noinstall-<replaceable>version</replaceable>-win32.zip</literal>.
+ <literal>mysql-workbench-<replaceable>version</replaceable>-win32.zip</literal>.
Using a ZIP program, unpack it to the directory of your choice.
You may also want to create a shortcut on your desktop or the
quick launch bar.
</para>
-
+
</section>
-
+ <section id="workbench-pro-starting">
+
+ <title>Starting &workbench_pro;</title>
+
+ <para>
+ To start &workbench_pro; navigate to the installation directory
+ and double click <literal>MySQLWorkbench.exe</literal>.
+ </para>
+
+ </section>
+
</chapter>
Modified: trunk/workbench-pro/uninstalling.xml
===================================================================
--- trunk/workbench-pro/uninstalling.xml 2007-08-29 19:12:53 UTC (rev 7593)
+++ trunk/workbench-pro/uninstalling.xml 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 445 bytes
@@ -24,7 +24,7 @@
<note>
<para>
Currently, there is no command line option for removing
- &gui_tools;.
+ &workbench_pro;.
</para>
</note>
Added: trunk/workbench-pro/using.xml
===================================================================
--- trunk/workbench-pro/using.xml (rev 0)
+++ trunk/workbench-pro/using.xml 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 1, Lines Added: 31, Lines Deleted: 0; 1060 bytes
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="workbench-pro-using">
+
+ <title>Using &workbench_pro;</title>
+
+ <para>
+ * Overview Page
+ ** Listing of EER Model Views
+ ** Creation of EER Model View
+ ** Listing of schema objects
+ * EER Model View
+ ** Placing of Tables, Views & Routine Groups
+ ** Relationship tools
+ ** Dragging of objects
+ ** Scrolling & Hand tool
+ * Editing
+ ** Editing of Tables
+ *** Name, Comment, Columns, Indices
+ ** Editing of Views
+ *** Name, SQL, Comment
+ * Import of SQL CREATE scripts
+ * GRT Shell
+ </para>
+
+</chapter>
Modified: trunk/workbench-pro/version.ent
===================================================================
--- trunk/workbench-pro/version.ent 2007-08-29 19:12:53 UTC (rev 7593)
+++ trunk/workbench-pro/version.ent 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 395 bytes
@@ -1,3 +1,3 @@
<?xml version='1.0' encoding='utf-8'?>
-<!ENTITY workbench_pro_version "Alpha 1.0.2">
+<!ENTITY workbench_pro_version "Alpha 1.0.3">
Modified: trunk/workbench-pro/workbench-pro.xml
===================================================================
--- trunk/workbench-pro/workbench-pro.xml 2007-08-29 19:12:53 UTC (rev 7593)
+++ trunk/workbench-pro/workbench-pro.xml 2007-08-29 20:06:14 UTC (rev 7594)
Changed blocks: 2, Lines Added: 11, Lines Deleted: 5; 1160 bytes
@@ -7,15 +7,14 @@
]>
<book id="workbench-pro" lang="en">
- <title>TITLE OF DOCUMENT HERE</title>
+ <title>&workbench_pro;</title>
<bookinfo>
<abstract>
<para>
- [OPTIONAL HIGH-LEVEL DESCRIPTION OF DOCUMENT; edit or remove
- this para]
+ This manual documents the &workbench_pro; version &workbench_pro_version;.
</para>
<para>
@@ -33,9 +32,16 @@
</bookinfo>
-<!-- [DOCUMENT CONTENT GOES HERE; chapters, sections, etc.] -->
-
+<!-- [DOCUMENT CONTENT GOES HERE; chapters, sections, etc.] -->
<index/>
+
+ <xi:include href="installing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="grt-shell.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="uninstalling.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</book>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7594 - trunk/workbench-pro | plavin | 29 Aug |
