Author: plavin
Date: 2008-01-30 18:51:27 +0100 (Wed, 30 Jan 2008)
New Revision: 9668
Log:
Update based on discussion with Mike L -- thanks
Modified:
trunk/workbench/Makefile.depends
trunk/workbench/foreign-key-relationships.xml
trunk/workbench/forward-engineering.xml
trunk/workbench/layers.xml
trunk/workbench/reference.xml
trunk/workbench/tables.xml
Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/Makefile.depends 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 1; 718 bytes
@@ -50,7 +50,8 @@
forward_engineering_IDMAPS = \
../workbench/metadata/forward-engineering.idmap \
../workbench/metadata/options-connections.idmap \
- ../workbench/metadata/reverse-engineering.idmap
+ ../workbench/metadata/reverse-engineering.idmap \
+ ../workbench/metadata/tables.idmap
forward-engineering.validpure: $(forward_engineering_SOURCES)
forward-engineering.titles: $(forward_engineering_SOURCES)
forward-engineering.useless: $(forward_engineering_SOURCES)
Modified: trunk/workbench/foreign-key-relationships.xml
===================================================================
--- trunk/workbench/foreign-key-relationships.xml 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/foreign-key-relationships.xml 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 2, Lines Added: 3, Lines Deleted: 2; 1017 bytes
@@ -204,7 +204,7 @@
<para>
To select a connection, right click it. When a connection is
- selected it is outlined in blue and it's properties are displayed
+ selected it is highlighted and it's properties are displayed
in the properties palette. The properties of a connection are
quite different from the properties of other objects. These
properties are listed in the following:
@@ -286,7 +286,8 @@
<listitem>
<para>
<literal>mandatory</literal> – Whether ot not the
- entity is mandatory.
+ entities are mandatory. For more information
+ see <xref linkend="wb-relationship-editor"/>.
</para>
</listitem>
Modified: trunk/workbench/forward-engineering.xml
===================================================================
--- trunk/workbench/forward-engineering.xml 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/forward-engineering.xml 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 2, Lines Added: 9, Lines Deleted: 5; 1152 bytes
@@ -70,11 +70,7 @@
<listitem>
<para>
Generate INSERT statements for tables
-
- <remark>
- What does this do?
- </remark>
- </para>
+ </para>
</listitem>
</itemizedlist>
@@ -92,6 +88,14 @@
</para>
<para>
+ If you have added any records to a table
+ using the <literal>INSERT</literal> tab of
+ the &table_editor;, choose the <literal>Generate INSERT statements for tables</literal>
+ option. For more information about inserting records
+ see <xref linkend="wb-table-editor-inserts"/>.
+ </para>
+
+ <para>
Use the <guilabel>Output Options</guilabel> frame to set
the name of your script file. The <guibutton>Next</guibutton>
button is disabled until a script file name is supplied.
Modified: trunk/workbench/layers.xml
===================================================================
--- trunk/workbench/layers.xml 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/layers.xml 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 1, Lines Added: 13, Lines Deleted: 2; 1209 bytes
@@ -125,12 +125,23 @@
</para>
<para>
- To prevent accidental removal of objects from layers, you
- cannot simply click on an object and remove it. To remove an
+ Once objects are placed on a layer they become 'locked'
+ to that layer; this prevents their accidental removal.
+ You cannot remove them simply by clicking and dragging.
+ To remove an
object from a layer, press the <keycap>Ctrl</keycap> key
while dragging the object.
</para>
+ <para>
+ If you remove an object from a layer and then add
+ it back to that layer it will not be "locked" to that layer unless you
+ press the <keycap>Ctrl</keycap> key while you
+ drag the object back onto the layer. As a visual cue that
+ the object is again being "locked", the outline of
+ the layer is highlighted as the object is dragged over it.
+ </para>
+
</section>
</section>
Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/reference.xml 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 9, Lines Added: 40, Lines Deleted: 17; 4979 bytes
@@ -359,7 +359,8 @@
<listitem>
<para>
- <guimenu>Similar Figures</guimenu>
+ <guimenu>Similar Figures</guimenu> (Objects of the
+ same type)
</para>
</listitem>
@@ -421,19 +422,21 @@
<listitem>
<para>
- Entire Model – search the entire model
+ Entire Model – Search the entire model.
</para>
</listitem>
<listitem>
<para>
- Current View – search the current view only
+ Current View – Search the current view only. This
+ may be the <literal>MySQL Model</literal> page
</para>
</listitem>
<listitem>
<para>
- All Views
+ All Views – search the <literal>MySQL Model Page</literal>
+ and all EER diagrams
<remark>
Not sure what this means, all EER diagrams and
@@ -444,14 +447,14 @@
<listitem>
<para>
- Database Objects – search database objects only
+ Database Objects – Search database objects only.
</para>
</listitem>
<listitem>
<para>
- Selected Figures – search the currently selected
- objects
+ Selected Figures – Search the currently selected
+ objects. This feature only works for EER diagrams.
</para>
</listitem>
@@ -511,7 +514,9 @@
Use this window to navigate to objects. For example, double
clicking the <literal>Description</literal> of an object
located on an EER diagram navigates to the specific diagram
- and selects the object.
+ and selects the object. Notice that the properties of the
+ object are displayed in the <literal>Properties</literal>
+ palette.
</para>
<para>
@@ -1397,12 +1402,15 @@
A more detailed discussion of these options follows.
</para>
+ <note>
<para>
- <remark>
- ask about debug
- </remark>
+ The <guimenu>Debug</guimenu> menu option is
+ used for assistance in debugging the beta version
+ of &workbench;. It will be not appear in
+ the GA release.
</para>
-
+ </note>
+
<section id="wb-options-general">
<title>The General Tab</title>
@@ -1441,6 +1449,8 @@
If you are using &workbench_oss;, check the check box at the
bottom of the page to hide menu options that apply only to the
commercial version of &workbench;.
+ <remark>[PL]Change this to plural when there is more than one
+ commercial version.</remark>
</para>
</section>
@@ -2445,8 +2455,16 @@
<para>
Use the <literal>SQL Scripts</literal> panel to load and modify
- SQL scripts. Use the <literal> Model Notes</literal> panel to
- write project notes. Both of these panels will be saved with
+ SQL scripts. If you created your project from an SQL script
+ and plan to create an <literal>ALTER</literal> script,
+ you may want to add the original script here. since it will be
+ needed in order to create an <literal>ALTER</literal> script.
+ For more information see <xref linkend="wb-export-script-alter-schema"/>.
+ </para>
+
+ <para>
+ Use the <literal> Model Notes</literal> panel to
+ write project notes. Any scripts or notes added will be saved with
your project.
</para>
@@ -3050,14 +3068,17 @@
<listitem>
<para>
- <literal>expanded</literal> – Not yet implemented.
+ <literal>expanded</literal> – This attribute applies
+ to objects such as tables can be expanded to show columns, indexes,
+ and triggers. Not yet implemented.
</para>
</listitem>
<listitem>
<para>
<literal>height</literal> – The height of the
- object.
+ object. Depending upon the object, this property may be read only
+ or read/write.
</para>
</listitem>
@@ -3100,7 +3121,9 @@
<listitem>
<para>
- <literal>width</literal> – The width of the object.
+ <literal>width</literal> – The width of the object. Depending
+ upon the object, this property may be read only
+ or read/write.
</para>
</listitem>
Modified: trunk/workbench/tables.xml
===================================================================
--- trunk/workbench/tables.xml 2008-01-30 17:24:24 UTC (rev 9667)
+++ trunk/workbench/tables.xml 2008-01-30 17:51:27 UTC (rev 9668)
Changed blocks: 1, Lines Added: 2, Lines Deleted: 5; 596 bytes
@@ -880,11 +880,8 @@
<para>
Any records you add will be inserted when you forward engineer
- the database.
-
- <remark>
- Does INSERT happen when you forward engineer?
- </remark>
+ the database (if you choose the <literal>Generate INSERT statements for
+ tables</literal> option).
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9668 - trunk/workbench | plavin | 30 Jan |
