Author: plavin
Date: 2007-11-15 21:00:41 +0100 (Thu, 15 Nov 2007)
New Revision: 8747
Log:
Add menu options, make other related changes
Modified:
trunk/workbench-pro/Makefile.depends
trunk/workbench-pro/forward-engineering.xml
trunk/workbench-pro/grt-shell.xml
trunk/workbench-pro/plugins.xml
trunk/workbench-pro/reference.xml
Modified: trunk/workbench-pro/Makefile.depends
===================================================================
--- trunk/workbench-pro/Makefile.depends 2007-11-15 18:55:27 UTC (rev 8746)
+++ trunk/workbench-pro/Makefile.depends 2007-11-15 20:00:41 UTC (rev 8747)
Changed blocks: 2, Lines Added: 3, Lines Deleted: 0; 833 bytes
@@ -256,6 +256,8 @@
reference_SOURCES = reference.xml $(reference_INCLUDES)
reference_IDMAPS = \
metadata/forward-engineering.idmap \
+ metadata/grt-shell.idmap \
+ metadata/plugins.idmap \
metadata/printing.idmap
reference.validpure: $(reference_SOURCES)
reference.titles: $(reference_SOURCES)
@@ -435,6 +437,7 @@
../refman-5.1/metadata/sql-syntax.idmap \
metadata/forward-engineering.idmap \
metadata/grt-shell.idmap \
+ metadata/plugins.idmap \
metadata/printing.idmap
workbench-pro.validpure: $(workbench_pro_SOURCES)
workbench-pro.titles: $(workbench_pro_SOURCES)
Modified: trunk/workbench-pro/forward-engineering.xml
===================================================================
--- trunk/workbench-pro/forward-engineering.xml 2007-11-15 18:55:27 UTC (rev 8746)
+++ trunk/workbench-pro/forward-engineering.xml 2007-11-15 20:00:41 UTC (rev 8747)
Changed blocks: 2, Lines Added: 19, Lines Deleted: 2; 1201 bytes
@@ -5,7 +5,7 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="wbpro-forward-engineering">
+<chapter id="wb-forward-engineering">
<title>Forward Engineering</title>
@@ -31,9 +31,26 @@
<section id="database-synchronization">
<title>Database Synchronization (Commercial Version)</title>
+
<para>
+ The <guimenuitem>Synchronize ...</guimenuitem> menu item under the
+ <guimenu>Database</guimenu> menu option synchronizes your
+ database model with an existing database.
+ made to a database
+ </para>
+
+ <note>
- </para>
+ <para>
+ New tables or views can be synchronized with an
+ existing database.
+ Currently, changes to an existing table, such as the addition
+ of a column, cannot be synchronized using &workbench;.
+ </para>
+
+ </note>
+
+
</section>
Modified: trunk/workbench-pro/grt-shell.xml
===================================================================
--- trunk/workbench-pro/grt-shell.xml 2007-11-15 18:55:27 UTC (rev 8746)
+++ trunk/workbench-pro/grt-shell.xml 2007-11-15 20:00:41 UTC (rev 8747)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 2; 561 bytes
@@ -5,11 +5,11 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="grt-shell">
+<chapter id="wb-grt-shell">
<title>The Generic Runtime Environment (GRT) Shell</title>
- <section id="grt-introduction">
+ <section id="wb-grt-introduction">
<title>Introduction</title>
Modified: trunk/workbench-pro/plugins.xml
===================================================================
--- trunk/workbench-pro/plugins.xml 2007-11-15 18:55:27 UTC (rev 8746)
+++ trunk/workbench-pro/plugins.xml 2007-11-15 20:00:41 UTC (rev 8747)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 421 bytes
@@ -5,7 +5,7 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="wbpro-plugins">
+<chapter id="wb-plugins">
<title>Plug-ins</title>
Modified: trunk/workbench-pro/reference.xml
===================================================================
--- trunk/workbench-pro/reference.xml 2007-11-15 18:55:27 UTC (rev 8746)
+++ trunk/workbench-pro/reference.xml 2007-11-15 20:00:41 UTC (rev 8747)
Changed blocks: 8, Lines Added: 127, Lines Deleted: 25; 7937 bytes
@@ -19,29 +19,34 @@
</section>
- <section id="menus">
+ <section id="wb-menus">
<title>&workbench_pro; Menus</title>
- <section id="file-menu">
+ <section id="wb-file-menu">
<title>The File Menu</title>
<para>
- Use this menu item to open a project, begin a new project or
+ Use this menu item to open a project, begin a new project, or
save a project. Choosing <guimenuitem>New</guimenuitem> opens
- the default schema <literal>mydb</literal>. When you save a project
+ the default schema <literal>mydb</literal>.
+ Use the <guimenuitem>Save</guimenuitem> or <guimenuitem>Save As</guimenuitem>
+ to save a project.
+ When you save a project
its name appears in the title bar of the application. If you have
made changes to a project and haven't saved those changes,
an asterisk appears in the title bar following the project name.
+ When you save a project it is saved as a MySQL Workbench file
+ with the extension <literal>mwb</literal>.
</para>
<para>
- You can also use this menu option to import a MySQL data
- definition script file, one created by <command>mysqldump
+ Use the <guimenu>Import</guimenu> menu option to import a MySQL data
+ definition script file, one created by issuing the command <command>mysqldump
<option>--no-data</option></command> for example. If the script
- does not contain a <command>CREATE <option>db_name</option>
- ;</command> statement, the schema objects will be copied to the
+ does not contain a <command>CREATE <option>db_name</option>;</command>
+ statement, the schema objects will be copied to the
default schema, <literal>mydb</literal>. If the script contains
data, it will be ignored.
</para>
@@ -53,24 +58,32 @@
<para>
There are variety of options under the
- <guilabel>Export</guilabel> menu item. You may generate the SQL
+ <guilabel>Export</guilabel> menu item.
+ You may generate the SQL
statements necessary to create a new database or alter an
existing one. These menu items are discussed in detail in
- <xref linkend="wb-printing"/>.
+ <xref linkend="wb-exporting-sql-scripts"/>.
</para>
+
+ <para>
+ Using the <guilabel>Export</guilabel> menu item
+ you can also export an EER as a PNG or PDF
+ file. PDF files can be exported as a single page or
+ as multiple pages.
+ </para>
<para>
- The print options under this menu item are only enabled if the
+ The print options are only enabled if the
<guilabel>EER Diagrams</guilabel> tab is selected. You have the
choice of printing your model directly to your printer, printing
- it as a PDF file or creating a PostScript file. These menu items
+ it as a PDF file, or creating a PostScript file. These menu items
are discussed in detail in
- <xref linkend="wb-exporting-sql-scripts"/>.
+ <xref linkend="wb-printing"/>.
</para>
</section>
- <section id="edit-menu">
+ <section id="wb-edit-menu">
<title>The Edit menu</title>
@@ -104,11 +117,11 @@
Choose <guimenuitem>Rename</guimenuitem> or <guimenuitem>Edit
Selected</guimenuitem> to edit the currently selected object.
You can also perform edits in a new window using the
- <guimenuitem>Edit Selected in New Window </guimenuitem>. The
+ <guimenuitem>Edit Selected in New Window</guimenuitem>. The
keyboard shortcut for <guimenuitem>Edit Selected</guimenuitem>
is <keycap>Ctrl</keycap> <keycap>e</keycap> and
<keycap>Ctrl</keycap> <keycap>Shift</keycap><keycap>e</keycap>
- for <guimenuitem>Edit Selected in New Window </guimenuitem>.
+ for <guimenuitem>Edit Selected in New Window</guimenuitem>.
</para>
<para>
@@ -116,25 +129,109 @@
three submenus, <guimenuitem>Select All</guimenuitem>,
<guimenuitem>Similar Figures</guimenuitem>, and
<guimenuitem>Connected Figures</guimenuitem>. These menu items
- are active when the <guilabel>EER Diagram</guilabel> tab
- is selected.
+ are only active when the <guilabel>EER Diagram</guilabel> tab
+ is selected.<remark>Add</remark>
</para>
</section>
- <section id="view-menu">
+ <section id="wb-view-menu">
<title>The View Menu</title>
- <para></para>
+ <para>
+ The Options available under this menu item are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Overview – Under this menu item find the
+ <literal>MySQL Model</literal> option. This option
+ switches to the <literal>MySQL Model</literal> view
+ if it is not currently selected.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Windows <remark>ask -- nothing happens</remark>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Advanced
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Output Window – Use this option to display the
+ console output.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ GRT Shell – Open the GRT shell.
+ For more information about the GRT shell see
+ <xref linkend="wb-grt-shell"/>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </listitem>
+
+
+ <listitem>
+ <para>
+ Zoom 100% – The default level of detail of the
+ EER diagram.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Zoom In – Zoom in on the EER diagram.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Zoom Out – Zoom out from the EER diagram.
+ </para>
+ </listitem>
+
+
+ </itemizedlist>
+
+
+
</section>
<section id="database-menu">
<title>The Database Menu</title>
- <para></para>
+ <para>
+ The <guimenuitem>Reverse Engineering</guimenuitem> option
+ is used to create a model from an existing database.
+ </para>
+
+ <para>
+ The <guimenuitem>Synchronize ...</guimenuitem> menu item under the
+ <guimenu>Database</guimenu> menu option synchronizes your
+ database model with an existing database.
+ </para>
+
+ <para>
+ Both these menu options are discussed in detail in
+ <xref linkend="database-synchronization"/>.
+ </para>
</section>
@@ -142,7 +239,12 @@
<title>The Plug-ins Menu</title>
- <para></para>
+ <para>
+ The <guimenu>Plugins</guimenu> menu option
+ lists any plug-ins that you may have installed.
+ For more information about this menu option
+ see <xref linkend="wb-plugins"/>.
+ </para>
</section>
@@ -150,7 +252,7 @@
<title>The Tools Menu</title>
- <para></para>
+ <para><remark>ask</remark></para>
</section>
@@ -158,7 +260,7 @@
<title>The Window Menu</title>
- <para></para>
+ <para><remark>ask</remark></para>
</section>
@@ -166,7 +268,7 @@
<title>The Help Menu</title>
- <para></para>
+ <para><remark>ask</remark></para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8747 - trunk/workbench-pro | plavin | 15 Nov |
