Author: plavin
Date: 2007-11-28 23:18:43 +0100 (Wed, 28 Nov 2007)
New Revision: 8954
Log:
Finish the reference chapter (at least for a first pass)
Modified:
trunk/workbench/reference.xml
Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml 2007-11-28 21:35:08 UTC (rev 8953)
+++ trunk/workbench/reference.xml 2007-11-28 22:18:43 UTC (rev 8954)
Changed blocks: 6, Lines Added: 367, Lines Deleted: 22; 13521 bytes
@@ -249,8 +249,8 @@
<note>
<para>
- These options are not available in the
- &workbench_oss; version.
+ These options are not available in the &workbench_oss;
+ version.
</para>
</note>
@@ -352,15 +352,15 @@
<title>The Diagram Tab</title>
<para>
- Use this tab to determine display settings for the
- EER Diagram canvas of the application.
+ Use this tab to determine display settings for the EER Diagram
+ canvas of the application.
</para>
<para>
Select whether to expand new objects by checking the
<literal>Expand New Objects</literal> check box and select
- whether to draw line crossings by checking the <literal>Draw Line
- Crossings</literal> check box.
+ whether to draw line crossings by checking the <literal>Draw
+ Line Crossings</literal> check box.
</para>
<para>
@@ -444,9 +444,39 @@
<title>The Community Menu</title>
<para>
- <remark>
- ask
- </remark>
+ The <guimenu>Community</guimenu> menu option offers the
+ following choices:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Workbench Blog
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ FAQs About Workbench
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Learn How To Code For Workbench
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Contribute To Workbench
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Use these menu options to go online and learn more about
+ &workbench;.
</para>
</section>
@@ -456,9 +486,51 @@
<title>The Help Menu</title>
<para>
- <remark>
- ask
- </remark>
+ The <guimenu>Help</guimenu> menu option offers the following
+ choices:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Help Index
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Check For Updates
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ MySQL.com Website
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Workbench Product Page
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Report a Bug
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ About Workbench
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Use these menu options to go online and learn more about
+ &workbench;.
</para>
</section>
@@ -856,24 +928,177 @@
<title>The Physical Schemata</title>
- <para></para>
+ <para>
+ The <literal>Physical Schemata</literal> panel of the
+ <literal>Overview</literal> page shows the active schemata and
+ the objects that they contain.
+ </para>
+ <para>
+ Expand and contract the <literal>Physical Schemata</literal>
+ section by double clicking the arrow on the left of the
+ <literal>Physical Schemata</literal> title bar. When the
+ <literal>Physical Schemata</literal> section is expanded, all
+ the schemata that are currently loaded are displayed.
+ </para>
+
+ <para>
+ Each schema shows as a tab; a specific schema is selected by
+ clicking it's tab. When &workbench; is first opened a default
+ schema, <literal>mydb</literal> is selected. You can start
+ working with this schema or you can load a new MySQL Workbench
+ Models (MWB) file.
+ </para>
+
+ <para>
+ There are a variety of ways to add schema to the
+ <literal>Physical Schemata</literal> panel. You can open an MWB
+ file, reverse engineer a MySQL create script, or, if you are
+ using &workbench_se;, you can reverse engineer a database by
+ connecting to a MySQL server.
+ </para>
+
+ <para>
+ You can also add a new schema by clicking the
+ <guibutton>+</guibutton> button on the top right of the
+ <literal>Physical Schemata</literal> panel. To remove a schema,
+ click its tab and use the <guibutton>-</guibutton> found to the
+ immediate left of the <guibutton>+</guibutton> button.
+ </para>
+
+ <para>
+ To expand the Physical Schemata window move the mouse pointer
+ anywhere over the gray area that defines the lower edge of the
+ <literal>Physical Schemata</literal> panel. Hold down the right
+ mouse button and move the mouse to adjust the size of the
+ window.
+ </para>
+
+ <section id="wb-overview-schema-objects">
+
+ <title>Schema Objects</title>
+
+ <para>
+ The <literal>Physical Schemata</literal> panel is divided up
+ into the following sections:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Tables
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Views
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Routines
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Routine Groups
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Each section contains the specified database objects and an
+ icon used for creating additional objects.
+ </para>
+
+ <para>
+ Any objects added to the <literal>Physical Schemata</literal>
+ show up in the <literal>Catalog</literal> palette docked on
+ the right side of the application. Any objects added to the
+ database on the EER Diagram canvas also show up in the
+ <literal>Physical Schemata</literal> section. For information
+ about adding objects to the EER Diagram canvas see
+ <xref linkend="wb-diagrams"/>.
+ </para>
+
+ </section>
+
</section>
<section id="wb-views-overview-privileges">
<title>Privileges</title>
- <para></para>
+ <para>
+ The <literal>Privileges</literal> panel of the
+ <literal>Overview</literal> page is used to create users for
+ your schema or schemata and also to define roles—making it
+ much easier to assign the same rights to different users or
+ different rights to different users.
+ </para>
+ <para>
+ The <literal>Schema Privileges</literal> panel is divided up
+ into the following sections:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Users
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Roles
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Once roles are created they can then be assigned to users. Users
+ may have more than one role.
+ </para>
+
+ <para>
+ To edit the name of a role click the role name. Double clicking
+ a role object opens the role editor docked at the bottom of the
+ screen. You may drag and drop objects from the <literal>Physical
+ Schemata</literal> panel to the <literal>Objects</literal>
+ section of the role editor. To assign privileges to a role
+ select the a role from the <literal>Roles</literal> section and
+ then select an object in the <literal>Objects</literal> section.
+ In the <literal>Privileges</literal> section check the rights
+ you wish to assign to this role. For example, a
+ <literal>web_user</literal> role might have only
+ <literal>SELECT</literal> privileges and only for database
+ objects exposed through a web interface. Creating roles can make
+ the process of assigning rights to new users much easier.
+ </para>
+
</section>
- <section id="wb-views-overview-other">
+ <section id="wb-views-overview-scripts-notes">
- <title>Other</title>
+ <title>SQL Scripts and Model Notes</title>
- <para></para>
+ <para>
+ The two remaining panels on the <literal>Overview</literal> page
+ are <literal>SQL Scripts</literal> panel and the <literal> Model
+ Notes</literal> panel.
+ </para>
+ <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
+ your project.
+ </para>
+
</section>
</section>
@@ -884,24 +1109,144 @@
<section id="wb-navigator-palettes">
- <title>The Navigator Palettes</title>
+ <title>The Navigator Palette</title>
- <para></para>
+ <para>
+ Docked on the top right of the application is the
+ <literal>Navigator</literal> palette. This palette gives you an
+ overview of the objects placed on the EER Diagram canvas and for
+ this reason it is most useful when an EER Diagram is active.
+ </para>
+ <para>
+ The <literal>Navigator</literal> palette shows the total area of
+ the EER Diagram. The view port onto the area of the EER Diagram
+ canvas that is visible when an EER Diagram is active is outlined
+ in black. Any objects that you have placed on the canvas should
+ be visible.
+ </para>
+
+ <para>
+ Close this window choosing the menu options <guimenu>View</guimenu>,
+ <guimenu>Windows</guimenu> and then <guimenu>Model Navigator</guimenu>
+ or by clicking the
+ <guibutton>x</guibutton> on the top right of the title bar.
+ To reopen the <literal>Navigator</literal> palette you must use
+ the menu option.
+ </para>
+
+ <para>
+ Double click the title bar to undock this palette or to redock it.
+ </para>
+
<section id="wb-catalog-layers-palettes">
- <title>The Schemata/Layers Palettes</title>
+ <title>The Catalog/Layers Palettes</title>
- <para></para>
+ <para>
+ By default these two palettes are docked on the right, in the
+ middle of the application. You can select one or the other by
+ clicking the tab at the bottom of this palette.
+ </para>
+ <section id="wb-catalog-palette">
+
+ <title>The Catalog Palette</title>
+
+ <para>
+ The <literal>Catalog</literal> palette shows all the schemata
+ that are present in the <literal>Physical Schemata</literal>
+ section of the <literal>Overview</literal> page. Expand the
+ view of the objects contained in a specific schema by clicking
+ the <guibutton>+</guibutton> button to the left of the schema
+ name. Doing this displays the following folder icons:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Tables
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Views
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Routine Groups
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Expand each of these in turn by clicking the
+ <guibutton>+</guibutton> button to the left of the folder
+ icon.
+ </para>
+
+ <para>
+ Selecting an object in this palette, displays its properties
+ in the <literal>Properties</literal> palette.
+ </para>
+
+ <para>
+ This palette is principally used to drag and drop objects onto
+ the EER Diagram canvas.
+ </para>
+
+ <para>
+ Double clicking the title bar undocks the active palette.
+ Do the same to redock a palette.
+ </para>
+
+ </section>
+
+ <section id="wb-layers-palette">
+
+ <title>The Layers Palette</title>
+
+ <para>
+ This palette shows all the layers and figures that have been
+ placed on the EER Diagram canvas. If a layer or figure is
+ currently selected, an <literal>X</literal> appears beside the
+ name of the object and its properties are displayed in the
+ <literal>Properties</literal> palette.
+ </para>
+
+ <para>
+ Clicking the name of an object in this palette allows you to
+ change the object's name.
+ </para>
+
+ <para>
+ Double clicking the title bar undocks the active palette.
+ Do the same to redock a palette.
+ </para>
+
+ </section>
+
</section>
<section id="wb-properties-palettes">
<title>The Properties Palettes</title>
- <para></para>
+ <para>
+ The <literal>Properties</literal> palette is used to display and
+ edit the properties of objects on the EER Diagram canvas. It is
+ especially useful for editing display objects such as layers and
+ notes.
+ </para>
+ <para>
+ Double clicking the title bar undocks the active palette. Do
+ the same to redock a palette.
+ </para>
+
</section>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8954 - trunk/workbench | plavin | 28 Nov |
