Author: plavin
Date: 2006-12-13 18:04:39 +0100 (Wed, 13 Dec 2006)
New Revision: 4235
Log:
Reorganize workbench to include the common table editor chapter
Added:
trunk/workbench/getting-started.xml
Modified:
trunk/workbench/Makefile
trunk/workbench/using.xml
trunk/workbench/workbench.xml
Property changes on: trunk/workbench/getting-started.xml
___________________________________________________________________
Name: svn:executable
+ *
Modified: trunk/workbench/Makefile
===================================================================
--- trunk/workbench/Makefile 2006-12-13 16:47:25 UTC (rev 4234)
+++ trunk/workbench/Makefile 2006-12-13 17:04:39 UTC (rev 4235)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 1325 bytes
@@ -39,7 +39,7 @@
WORKBENCH_SRCS_EXTRA = ../common/fixedchars.ent ../gui-common/gui-common.ent
-WORKBENCH_SRCS = $(WORKBENCH_SRCS_EXTRA) workbench.xml ../gui-common/chapter-grt-shell.xml ../gui-common/chapter-uninstall-all.xml ../gui-common/images/grt-shell.png ../gui-common/installation-all.xml ../gui-common/starting-all.xml copyright.xml images/create-columns.png images/create-table.png images/workbench-windows.png legalnotice.en.xml overview.xml reverse-engineering.xml using.xml
+WORKBENCH_SRCS = $(WORKBENCH_SRCS_EXTRA) workbench.xml ../gui-common/chapter-grt-shell.xml ../gui-common/chapter-table-editor.xml ../gui-common/chapter-uninstall-all.xml ../gui-common/images/columneditor.png ../gui-common/images/confirmchanges.png ../gui-common/images/grt-shell.png ../gui-common/images/indexeditor.png ../gui-common/images/tableeditor.png ../gui-common/installation-all.xml ../gui-common/starting-all.xml copyright.xml getting-started.xml images/workbench-windows.png legalnotice.en.xml overview.xml reverse-engineering.xml using.xml
workbench-prepped.xml: $(WORKBENCH_SRCS) $(IDMAP_OBJS)
Added: trunk/workbench/getting-started.xml
===================================================================
--- trunk/workbench/getting-started.xml (rev 0)
+++ trunk/workbench/getting-started.xml 2006-12-13 17:04:39 UTC (rev 4235)
Changed blocks: 1, Lines Added: 130, Lines Deleted: 0; 4201 bytes
@@ -0,0 +1,130 @@
+<?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 % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+ <chapter id="workbench-starting">
+
+ <title>Getting Started with The &workbench;</title>
+
+ <para>
+ When &workbench; is first opened, an empty <literal>Main View
+ </literal> tab occupies most of the screen and
+ <literal>Schemata</literal> and <literal>Layers</literal> tabs
+ appear on the right.
+ </para>
+
+ <para>
+ If you are not opening an existing file, creating a schema is the
+ natural place to begin.
+ </para>
+
+ <section>
+
+ <title>Creating a New Schema</title>
+
+ <para>
+ You may begin by using the <literal>test</literal> schema shown in
+ the <literal>schemata</literal> panel on the right.
+ </para>
+
+ <para>
+ However, to create a new schema right-click in the
+ <literal>Schemata</literal> tab. Choose the <literal>Create MySQL
+ Schema</literal> option. This will create a schema called
+ <literal>New Schema</literal> in the <literal>Object
+ Tree</literal>.
+ </para>
+
+ <para>
+ Click on the <guibutton>arrow</guibutton> icon to the right of
+ your new schema in order to see all the elements in the object
+ tree. Those elements are:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ routineGroups
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ routines
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ sequences
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ structuredTypes
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ synonyms
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ tables
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ views
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <note>
+ <para>
+ &workbench; is beta software. Not all features are implemented
+ and some are only implemented on specific platforms.
+ </para>
+ </note>
+
+ <para>
+ The first thing you will want to do is create tables for your
+ schema. Under Windows you can create a table by right-clicking
+ in the <literal>schemata</literal> panel and choosing the
+ <guimenu>Create MySQL Table</guimenu> option from the pop-up
+ menu. This will open the <literal>Table Editor</literal>.
+ Under Linux, open the <literal>Table Editor</literal> by
+ double-clicking a table on the <literal>Main View</literal>
+ canvas. This method will also work under Windows.
+ </para>
+
+ <para>
+ When creating or editing a table you can choose to dock the table
+ editor or not. To toggle the table editor view, select the
+ <guimenu>View</guimenu>, <guimenu>Advanced</guimenu>,
+ <guimenu>Open Editors Dock</guimenu> option. <remark>The description of
+ the table editor given here applies to the docked view.</remark>
+ </para>
+
+ <para>
+ The following chapter describes how to create a table using
+ the <literal>Table Editor</literal>, a tool common to
+ the &workbench;, &administrator;, and &query_browser;
+ tools.
+ </para>
+
+ </section>
+
+
+ </chapter>
+
\ No newline at end of file
Property changes on: trunk/workbench/getting-started.xml
___________________________________________________________________
Name: svn:executable
+ *
Modified: trunk/workbench/using.xml
===================================================================
--- trunk/workbench/using.xml 2006-12-13 16:47:25 UTC (rev 4234)
+++ trunk/workbench/using.xml 2006-12-13 17:04:39 UTC (rev 4235)
Changed blocks: 3, Lines Added: 87, Lines Deleted: 456; 15282 bytes
@@ -7,475 +7,65 @@
<!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
%gui-common.entities;
]>
-<chapter id="workbench-using">
-
- <title>Using &workbench;</title>
-
+<chapter id="using-workbench">
+ <title>Using Workbench</title>
+
<para>
- When &workbench; is first opened, an empty <literal>Main View
- </literal> tab occupies most of the screen and
- <literal>Schemata</literal> and <literal>Layers</literal> tabs
- appear on the right.
+ The previous chapter described how to create tables
+ using the Table editor. This chapter describes
+ manipulating foreign keys in ways that are
+ specific to the &workbench;.
+ It also deals with creating other database objects
+ such as views. In each case these objects are created
+ by expanding schema objects
+ shown in the <literal>Object Tree</literal>
+ panel on the right. Right-clicking a schema drops down
+ a list of objects that can be created.
+
</para>
-
- <para>
- If you are not opening an existing file, creating a schema is the
- natural place to begin.
- </para>
-
- <section>
-
- <title>Creating a New Schema</title>
-
- <para>
- You may begin by using the <literal>test</literal> schema shown in
- the <literal>schemata</literal> panel on the right.
- </para>
-
- <para>
- However, to create a new schema right-click in the
- <literal>Schemata</literal> tab. Choose the <literal>Create MySQL
- Schema</literal> option. This will create a schema called
- <literal>New Schema</literal> in the <literal>Object
- Tree</literal>.
- </para>
-
- <para>
- Click on the <guibutton>arrow</guibutton> icon to the right of
- your new schema in order to see all the elements in the object
- tree. Those elements are:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- routineGroups
- </para>
- </listitem>
-
- <listitem>
- <para>
- routines
- </para>
- </listitem>
-
- <listitem>
- <para>
- sequences
- </para>
- </listitem>
-
- <listitem>
- <para>
- structuredTypes
- </para>
- </listitem>
-
- <listitem>
- <para>
- synonyms
- </para>
- </listitem>
-
- <listitem>
- <para>
- tables
- </para>
- </listitem>
-
- <listitem>
- <para>
- views
- </para>
- </listitem>
-
- </itemizedlist>
-
- <note>
- <para>
- &workbench; is beta software. Not all features are implemented
- and some are only implemented on specific platforms.
- </para>
- </note>
+
+ <section id="workbench-foreign-keys">
- <para>
- The first thing you will want to do is create tables for your
- schema. Under Windows you can create a table by right-clicking
- in the <literal>schemata</literal> panel and choosing the
- <guimenu>Create MySQL Table</guimenu> option from the pop-up
- menu. This will open the <literal>Table Editor</literal>.
- Under Linux, open the <literal>Table Editor</literal> by
- double-clicking a table on the <literal>Main View</literal>
- canvas. This method will also work under Windows.
- </para>
+ <title>Foreign Keys</title>
<para>
- When creating or editing a table you can choose to dock the table
- editor or not. To toggle the table editor view, select the
- <guimenu>View</guimenu>, <guimenu>Advanced</guimenu>,
- <guimenu>Open Editors Dock</guimenu> option. <remark>The description of
- the table editor given here applies to the docked view.</remark>
+ Adding and manipulating foreign keys using the table editor
+ is described in detail in
+ <xref linkend="gui-table-editor-columns-and-indices-detail-foreign-keys"/>.
+
</para>
<para>
- The following chapter describes how to create a table using
- the <literal>Table Editor</literal>, a tool common to
- the &workbench;, &administrator;, and &query_browser;
- tools.
+ Adding a foreign key creates a relationship. Using &workbench;
+ you may edit this relationship
+ by right clicking the relationship in the <literal>Main View</literal> window
+ and choosing the
+ <guimenu>Edit</guimenu> option from the pop-up menu.
+ Doing this opens the Properties window on the right. From the
+ Properties window you can set additional characteristics of the relationship.
</para>
-
+
</section>
-
- <section id="workbench-creating-tables">
-
- <title>Creating Tables</title>
-
- <para>
- The first thing you will want to do is create tables for your
- schema. Under Windows you can create a table by right-clicking
- in the <literal>schemata</literal> panel and choosing the
- <guimenu>Create MySQL Table</guimenu> option from the pop-up
- menu. This will open the <literal>Table Editor</literal>.
- Under Linux, open the <literal>Table Editor</literal> by
- double-clicking a table on the <literal>Main View</literal>
- canvas. This method will also work under Windows.
- </para>
-
- <para>
- When creating or editing a table you can choose to dock the table
- editor or not. To toggle the table editor view, select the
- <guimenu>View</guimenu>, <guimenu>Advanced</guimenu>,
- <guimenu>Open Editors Dock</guimenu> option. <remark>The description of
- the table editor given here applies to the docked view.</remark>
- </para>
-
- <para>
- If the table editor is docked this
- will open a panel at the bottom of the screen, similar to the
- figure shown below:
- </para>
-
- <figure id="create-table">
- <title>Creating a table</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create-table.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Creating a table</phrase>
- </textobject>
- </mediaobject>
- </figure>
-
- <note>
- <para>
- Docking is not supported on all operating systems.
- </para>
- </note>
+
+ <!--section>
+ <title>Adding Triggers</title>
+
<para>
- This panel has seven tabs along the bottom. The first tab, the
- table information view, is the default view.
- </para>
-
- <para>
- In this view you may set the table name, engine type, collation,
- and also add a comment.
- </para>
-
- <para>
- To apply your changes, click the <guibutton>Apply
- Changes</guibutton> button shown on the lower left in
- <xref linkend="create-table" />. This button will only be enabled
- if there are changes that have not been applied. To back out of
- any changes, choose the <guibutton>Discard Changes</guibutton>
- button. Again, this button will only be enabled if there are
- changes to discard.
- </para>
-
- <section>
-
- <title>Adding Columns</title>
-
- <para>
- Add columns to your table by choosing the
- <literal>columns</literal> tab.
- </para>
-
- <para>
- You may choose the name, data type, default value, and collation
- for each column. New columns may be added using the column
- details frame in the lower part of the screen or by using the
- tabular layout—both are shown in
- <xref linkend="create-columns" />.
- </para>
-
- <figure id="create-columns">
- <title>Creating columns</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create-columns.png" format="PNG" lang="en"/>
- </imageobject>
- <textobject>
- <phrase lang="en">Creating columns</phrase>
- </textobject>
- </mediaobject>
- </figure>
-
- <para>
- To edit a column select the column you wish to edit and choose
- the property you wish to change.
- </para>
-
- <para>
- Depending upon circumstances one or the other of these views may
- be more convenient.
- </para>
-
- <para>
- However, changing the data type in the tabular view is
- especially easy because a drop-down list shows all available
- data types.
- </para>
-
- </section>
-
- <section>
-
- <title>Adding Indexes</title>
-
- <para>
- Once you have created a table, it will appear in the
- <literal>Main View </literal> panel and its properties will be
- displayed in a separate window below the <literal>Main
- View</literal> panel. You may close this panel by clicking the
- <guibutton>x</guibutton> beside the table name.
- </para>
-
- <para>
- To add an index, reopen the properties window by right clicking
- the table and choosing the <literal>Edit</literal> option. This
- will re-open the table edit window below the <literal>Main
- View</literal> tab. Choose the <literal>indices</literal> tab.
- </para>
-
- <remark>
- Image here?
- </remark>
-
- <para>
- This will open a horizontally split screen, showing any existing
- indexes in the top half and the index properties in the lower
- half.
- </para>
-
- <para>
- To create a new index, find an empty row in the upper half of
- the table edit window and double click the <literal>Index
- Name</literal> column. Choose an appropriate name for the index.
- </para>
-
- <para>
- Double click the <literal>Type</literal> column and choose an
- index type from the drop down box. You may choose from:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- INDEX
- </para>
- </listitem>
-
- <listitem>
- <para>
- PRIMARY
- </para>
- </listitem>
-
- <listitem>
- <para>
- UNIQUE
- </para>
- </listitem>
-
- <listitem>
- <para>
- FULL TEXT
- </para>
- </listitem>
-
- <listitem>
- <para>
- SPACIAL
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- Once you have named the index and chosen its type, you may set
- the properties in the lower half of the split screen.
- </para>
-
- </section>
-
- <section id="adding-foreign-keys">
-
- <title>Adding Foreign Keys</title>
-
- <para>
- To add a foreign key, choose the <literal>Foreign Keys</literal>
- tab.
- </para>
-
- <para>
- You create a foreign key in much the same way that you create an
- index. Assign a name to the foreign key, identify the referred
- table, and then choose the action to perform on update and on
- delete.
- </para>
-
- <para>
- The options are:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- NO ACTION
- </para>
- </listitem>
-
- <listitem>
- <para>
- RESTRICT
- </para>
- </listitem>
-
- <listitem>
- <para>
- CASCADE
- </para>
- </listitem>
-
- <listitem>
- <para>
- SET NULL
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para>
- Choose the appropriate action for each event. For instance, on
- delete, you may wish to perform a cascading delete of related
- records.
- </para>
+ <remark>[PL]Has this been removed?</remark>
+ A trigger is a database object that is associated with
+ a table and is activated when a particular event occurs for the table.
- <para>
- Adding a foreign key creates a relationship. You
- may edit this relationship by right clicking the relationship in
- the <literal>Main View</literal> window and choosing the
- <guimenu>Edit</guimenu> option from the
- pop-up menu.
- </para>
+ Use the Trigger tab to add a trigger to a table.
- <para>
- Doing this opens the <literal>Properties</literal>
- window on the right. From the <literal>Properties</literal>
- window you can set additional characteristics of the relationship.
- </para>
- </section>
-
- <section>
-
- <title>Adding Triggers</title>
-
- <para>
- A trigger is a database object that is associated with a table
- and is activated when a particular event occurs for the table.
- </para>
-
- <para>
- Use the <literal>Trigger</literal> tab to add a trigger to a
- table.
- </para>
-
- <para>
- Use the textbox provided to enter the SQL statement for creating
- a trigger.
- </para>
-
- <para>
- Be sure to click <literal>Apply Changes</literal> to save your
- work.
- </para>
-
- </section>
-
- <section>
-
- <title>Adding Table Options</title>
-
- <para>
- Clicking the <literal>Table Options</literal> tab to
- manipulate the following table options:
- </para>
+ Use the textbox provided to enter the SQL statement for creating a trigger.
- <itemizedlist>
-
- <listitem>
- <para>Miscellaneous Options</para>
- </listitem>
-
- <listitem>
- <para>Row Options</para>
- </listitem>
-
- <listitem>
- <para>Storage Options</para>
- </listitem>
-
- <listitem>
- <para>Merge Table Options</para>
- </listitem>
-
- <listitem>
- <para>Table RAID Settings</para>
- </listitem>
-
- </itemizedlist>
-
-
- <para>
- Use this option to pack keys, add a table password or set the
- initial AUTO_INCREMENT value.
- </para>
-
-
- <para>
- Row options, storage options and merge options can also be set
- from this screen.
- </para>
-
- </section>
-
- <section>
-
- <title>Standard Inserts</title>
-
- <para>
- Use the <literal>Standard Inserts</literal> tab to ...
- </para>
-
- </section>
-
- </section>
-
+ Be sure to click Apply Changes to save your work.
+ </para>
+ </section-->
+
+
+
<section id="workbench-creating-views">
<title>Creating Views</title>
@@ -495,9 +85,20 @@
</para>
</section>
-
<section>
+
+ <title>Creating Routines</title>
+
+ <para>
+ This feature is not yet implemented.
+ </para>
+
+ </section>
+
+
+
+ <section>
<title>Creating Routine Groups</title>
@@ -508,9 +109,39 @@
</para>
</section>
-
<section>
+
+ <title>Creating Synonyms</title>
+
+ <para>
+ This feature is not yet implemented.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>Creating Structured Data Types</title>
+
+ <para>
+ This feature is not yet implemented.
+ </para>
+
+ </section>
+
+ <section>
+
+ <title>Creating Sequences</title>
+
+ <para>
+ This feature is not yet implemented.
+ </para>
+
+ </section>
+
+
+ <section>
<title>Saving a &workbench; File</title>
Modified: trunk/workbench/workbench.xml
===================================================================
--- trunk/workbench/workbench.xml 2006-12-13 16:47:25 UTC (rev 4234)
+++ trunk/workbench/workbench.xml 2006-12-13 17:04:39 UTC (rev 4235)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 715 bytes
@@ -47,6 +47,10 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/starting-all.xml"/>
<xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../gui-common/chapter-table-editor.xml"/>
<xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4235 - trunk/workbench | plavin | 13 Dec |
