Author: plavin
Date: 2007-12-12 18:59:42 +0100 (Wed, 12 Dec 2007)
New Revision: 9268
Log:
Add section on notes, update engineering
Modified:
trunk/workbench/Makefile.depends
trunk/workbench/forward-engineering.xml
trunk/workbench/notes.xml
trunk/workbench/reverse-engineering.xml
Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends 2007-12-12 17:28:41 UTC (rev 9267)
+++ trunk/workbench/Makefile.depends 2007-12-12 17:59:42 UTC (rev 9268)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 1; 767 bytes
@@ -203,7 +203,9 @@
workbench.ent
notes_IMAGES =
notes_SOURCES = notes.xml $(notes_INCLUDES)
-notes_IDMAPS =
+notes_IDMAPS = \
+ metadata/notes.idmap \
+ metadata/reference.idmap
notes.validpure: $(notes_SOURCES)
notes.titles: $(notes_SOURCES)
notes.useless: $(notes_SOURCES)
@@ -485,6 +487,7 @@
metadata/foreign-key-relationships.idmap \
metadata/forward-engineering.idmap \
metadata/grt-shell.idmap \
+ metadata/notes.idmap \
metadata/options-connections.idmap \
metadata/plugins.idmap \
metadata/printing.idmap \
Modified: trunk/workbench/forward-engineering.xml
===================================================================
--- trunk/workbench/forward-engineering.xml 2007-12-12 17:28:41 UTC (rev 9267)
+++ trunk/workbench/forward-engineering.xml 2007-12-12 17:59:42 UTC (rev 9268)
Changed blocks: 4, Lines Added: 31, Lines Deleted: 6; 3052 bytes
@@ -17,7 +17,7 @@
<section id="wb-forward-engineering-sql-scripts">
- <title>Forward Engineering using SQL Scripts</title>
+ <title>Forward Engineering Using SQL Scripts</title>
<para>
To create a script of your database model use the
@@ -36,7 +36,7 @@
<section id="wb-export-script-create-sql">
- <title>Export Options: Creating a Schema</title>
+ <title>Creating a Schema</title>
<para>
The SQL export options are as follows:
@@ -86,14 +86,39 @@
indexes rather than having indexes created in the <literal>CREATE TABLE</literal>
statement. To update the privileges of existing users as opposed
to creating new users, select the <literal>Do not create users,
- just export privileges</literal> check box.
+ just export privileges</literal> check box. Exporting privileges
+ for non-existent users will result in errors when you execute
+ the <literal>CREATE</literal> script.
</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.
+ </para>
+
+ <para>
+ Clicking <guibutton>Next</guibutton> takes
+ you to the <guilabel>SQL Export Filter</guilabel> window
+ where you can select the objects you wish to export.
+ For a description of this window see <xref linkend="wb-reverse-engineer-live"/>.
+ </para>
+
+ <para>
+ The <guibutton>Finish</guibutton> button saves the
+ script file and exits. You may return to the previous
+ screen using the <guibutton>Back</guibutton> button.
+ </para>
+
+ <para>
+ Use the saved script to create a database.
+ </para>
</section>
<section id="wb-export-script-alter-schema">
- <title>Export Options: Altering a Schema</title>
+ <title> Altering a Schema</title>
<para>
The menu option for altering a schema, <guimenu>Forward Engineer
@@ -112,13 +137,13 @@
Script</guimenu> menu option found under the
<guimenu>File</guimenu>, <guimenu>Import</guimenu> options.
In any case, this file should represent the state of the
- exported database prior to alteration.
+ re-engineered database prior to alteration.
</para>
<para>
The differences between the original database and the altered
database are displayed on the next screen, the <guilabel>SQL
- Diff Tree</guilabel> window. To view the details click the
+ Diff Tree</guilabel> window. To view the details, click the
<guibutton>+</guibutton> button to the left of the model
database.
</para>
Modified: trunk/workbench/notes.xml
===================================================================
--- trunk/workbench/notes.xml 2007-12-12 17:28:41 UTC (rev 9267)
+++ trunk/workbench/notes.xml 2007-12-12 17:59:42 UTC (rev 9268)
Changed blocks: 1, Lines Added: 272, Lines Deleted: 22; 8549 bytes
@@ -5,39 +5,289 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="notes-procedures">
+<chapter id="wb-notes">
<title>Creating Notes</title>
-
+
<para>
-
+ You can add notes to a database either from the <literal>Physical
+ Schemata</literal> section of the <literal>Overview</literal> page
+ or from the EER Diagram.
</para>
-
- <section id="notes-overview">
- <title>Overview </title>
-
+
+ <section id="wb-notes-physical-schemata">
+
+ <title>Adding Notes to the Physical Schemata</title>
+
<para>
-
+ Double clicking the <literal>Add Note</literal> icon in the
+ <literal>Physical Schemata</literal> section of the
+ <literal>Overview</literal> page adds a note with the default name
+ of <literal>note1</literal>. If a note with this name already
+ exists, the new note is named <literal>note2</literal>.
</para>
-
+
+ <para>
+ Adding a new note automatically opens the note editor docked at
+ the bottom of the application. Using the note editor is described
+ in <xref linkend="wb-note-editor"/>.
+ </para>
+
+ <para>
+ Right clicking a note opens a pop-up menu with the following
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Edit Note ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Rename</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Cut</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Copy</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Delete</guimenu>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ The <guimenu>Edit Note ...</guimenu> option opens the note editor.
+ Using the note editor is described in
+ <xref linkend="wb-note-editor"/>.
+ </para>
+
+ <para>
+ The <guimenu>Cut</guimenu> and <guimenu>Paste</guimenu> options
+ are useful for copying notes between different schemata.
+ </para>
+
+ <para>
+ The action of the <guimenu>Delete</guimenu> option varies
+ depending upon the way you have configured &workbench;. For more
+ information see <xref linkend="wb-options-advanced"/>.
+ </para>
+
</section>
-
- <section id="notes-tools">
- <title> The Notes Tool</title>
-
+
+ <section id="wb-using-note-tool">
+
+ <title>Adding Notes to an EER Diagram</title>
+
<para>
-
+ Notes can also be added to an EER Diagram using the
+ <literal>Note</literal> tool on the vertical toolbar. To do this
+ make sure that the <literal>EER Diagram</literal> tab is selected,
+ and right click the note icon on the vertical toolbar. The note
+ icon is the two overlapping rectangles found below the table icon.
</para>
-
+
+ <para>
+ Clicking the mouse on this icon changes the mouse pointer to a
+ note pointer. You can also change the mouse pointer to a note
+ pointer by pressing the <keycap>N</keycap> key.
+ </para>
+
+ <para>
+ Choosing the <literal>Note</literal> tool changes the contents of
+ the toolbar that appears immediately below the menu bar. When the
+ <literal>Notes</literal> pointer is active, this toolbar a drop
+ down color chart. Use this list box to select the color accent for
+ the new note. The color of your note can easily be changed later
+ using the <literal>Properties</literal> palette.
+ </para>
+
+ <para>
+ Create a note by clicking anywhere on the EER Diagram canvas. This
+ creates a new note with the default name <literal>note1</literal>.
+ To revert to the default mouse pointer, click the arrow icon at
+ the top of the vertical toolbar.
+ </para>
+
+ <para>
+ Left clicking this object opens a pop-up menu with the following
+ options:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <guimenu>Cut</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Copy</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Edit Note ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guimenu>Edit in New Window ...</guimenu>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Delete
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ These menu options function in exactly the same way as the options
+ described in <xref linkend="wb-notes-physical-schemata"/>.
+ </para>
+
</section>
-
- <section id="notes-editor">
- <title>The Notes Editor</title>
-
+
+ <section id="wb-note-editor">
+
+ <title>The Note Editor</title>
+
<para>
-
+ You can invoke the note editor by double clicking a note object on
+ the EER Diagram canvas or by double clicking a note in the
+ <literal>Physical Schemata</literal> section on the <literal>MySQL
+ Model</literal> page. Doing this opens the note editor docked at
+ the bottom of the application. Double clicking the title bar
+ undocks the editor. Do the same to redock it. Any number of notes
+ may be open at the same time. Each additional note appears as a
+ tab at the top of the note editor,
</para>
-
+
+ <para></para>
+
+ <section id="wb-modifying-note">
+
+ <title>Modifying a Note using the Properties Palette</title>
+
+ <para>
+ When you select a view on the EER Diagram canvas, its properties
+ are displayed in the <literal>Properties</literal> palette. Most
+ of the properties accessible from the
+ <literal>Properties</literal> palette apply to the appearance of
+ a view on the EER Diagram canvas.
+
+ <remark>
+ This only applies to notes on the canvas not notes on the
+ Model Page. Await response to bugs.
+ </remark>
+ </para>
+
+ <para>
+ The properties are as follows:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>color</literal> – The color accent of the
+ object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enabled</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>expanded</literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>height</literal> – The height of the
+ object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>left</literal> – The number of pixels from
+ the object to the left side of the canvas.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>locked</literal> – Whether the object is
+ locked or not. Use <literal>‘1’</literal> for
+ true and <literal>‘0’</literal> for false.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>name</literal> – The name of the object.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>top</literal> – The number of pixels from
+ the object to the top of the canvas.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>visible</literal> – This property controls
+ whether an object shows up on the canvas or not. Use
+ <literal>‘1’</literal> for true and
+ <literal>‘0’</literal> for false.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>width</literal> – The width of the object.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ <remark>
+ Update when app updated, F5 is used for refresh.
+ </remark>
+ </para>
+
+ </section>
+
</section>
-
+
</chapter>
Modified: trunk/workbench/reverse-engineering.xml
===================================================================
--- trunk/workbench/reverse-engineering.xml 2007-12-12 17:28:41 UTC (rev 9267)
+++ trunk/workbench/reverse-engineering.xml 2007-12-12 17:59:42 UTC (rev 9268)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 0; 522 bytes
@@ -140,6 +140,7 @@
objects you are importing. You may view a log of the activities by
clicking the <guibutton>Advanced</guibutton> button.
</para>
+
<para>
The next screen is the <literal>Select Objects</literal> screen.
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9268 - trunk/workbench | plavin | 12 Dec |
