Author: plavin
Date: 2007-10-15 22:28:14 +0200 (Mon, 15 Oct 2007)
New Revision: 8108
Log:
Add more files for TOC, rearrange others
Added:
trunk/workbench-pro/images.xml
trunk/workbench-pro/notes.xml
trunk/workbench-pro/reference.xml
trunk/workbench-pro/stored-procedures.xml
trunk/workbench-pro/table-editor.xml
trunk/workbench-pro/views.xml
Removed:
trunk/workbench-pro/using.xml
Renamed/Moved:
trunk/workbench-pro/tutorial.xml (from rev 8092, trunk/workbench-pro/using.xml)
Modified:
trunk/workbench-pro/Makefile.depends
trunk/workbench-pro/options-connections.xml
trunk/workbench-pro/toc.txt
trunk/workbench-pro/workbench-pro.ent
trunk/workbench-pro/workbench-pro.xml
Modified: trunk/workbench-pro/Makefile.depends
===================================================================
--- trunk/workbench-pro/Makefile.depends 2007-10-15 20:04:37 UTC (rev 8107)
+++ trunk/workbench-pro/Makefile.depends 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 6, Lines Added: 146, Lines Deleted: 13; 8078 bytes
@@ -89,6 +89,24 @@
grt-shell-manprepped.xml: $(grt_shell_SOURCES) $(grt_shell_IDMAPS)
grt-shell-remprepped.xml: $(grt_shell_SOURCES) $(grt_shell_IDMAPS)
+images_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+images_IMAGES =
+images_SOURCES = images.xml $(images_INCLUDES)
+images_IDMAPS =
+images.validpure: $(images_SOURCES)
+images.titles: $(images_SOURCES)
+images.useless: $(images_SOURCES)
+images.valid: $(images_SOURCES) $(images_IDMAPS)
+images.validwarn: $(images_SOURCES) $(images_IDMAPS)
+images-prepped.xml: $(images_SOURCES) $(images_IDMAPS)
+images-manprepped.xml: $(images_SOURCES) $(images_IDMAPS)
+images-remprepped.xml: $(images_SOURCES) $(images_IDMAPS)
+
initial_startup_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -156,6 +174,42 @@
mysql-enterprise-manprepped.xml: $(mysql_enterprise_SOURCES) $(mysql_enterprise_IDMAPS)
mysql-enterprise-remprepped.xml: $(mysql_enterprise_SOURCES) $(mysql_enterprise_IDMAPS)
+notes_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+notes_IMAGES =
+notes_SOURCES = notes.xml $(notes_INCLUDES)
+notes_IDMAPS =
+notes.validpure: $(notes_SOURCES)
+notes.titles: $(notes_SOURCES)
+notes.useless: $(notes_SOURCES)
+notes.valid: $(notes_SOURCES) $(notes_IDMAPS)
+notes.validwarn: $(notes_SOURCES) $(notes_IDMAPS)
+notes-prepped.xml: $(notes_SOURCES) $(notes_IDMAPS)
+notes-manprepped.xml: $(notes_SOURCES) $(notes_IDMAPS)
+notes-remprepped.xml: $(notes_SOURCES) $(notes_IDMAPS)
+
+options_connections_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+options_connections_IMAGES =
+options_connections_SOURCES = options-connections.xml $(options_connections_INCLUDES)
+options_connections_IDMAPS =
+options-connections.validpure: $(options_connections_SOURCES)
+options-connections.titles: $(options_connections_SOURCES)
+options-connections.useless: $(options_connections_SOURCES)
+options-connections.valid: $(options_connections_SOURCES) $(options_connections_IDMAPS)
+options-connections.validwarn: $(options_connections_SOURCES) $(options_connections_IDMAPS)
+options-connections-prepped.xml: $(options_connections_SOURCES) $(options_connections_IDMAPS)
+options-connections-manprepped.xml: $(options_connections_SOURCES) $(options_connections_IDMAPS)
+options-connections-remprepped.xml: $(options_connections_SOURCES) $(options_connections_IDMAPS)
+
plugins_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -192,6 +246,24 @@
printing-manprepped.xml: $(printing_SOURCES) $(printing_IDMAPS)
printing-remprepped.xml: $(printing_SOURCES) $(printing_IDMAPS)
+reference_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+reference_IMAGES =
+reference_SOURCES = reference.xml $(reference_INCLUDES)
+reference_IDMAPS =
+reference.validpure: $(reference_SOURCES)
+reference.titles: $(reference_SOURCES)
+reference.useless: $(reference_SOURCES)
+reference.valid: $(reference_SOURCES) $(reference_IDMAPS)
+reference.validwarn: $(reference_SOURCES) $(reference_IDMAPS)
+reference-prepped.xml: $(reference_SOURCES) $(reference_IDMAPS)
+reference-manprepped.xml: $(reference_SOURCES) $(reference_IDMAPS)
+reference-remprepped.xml: $(reference_SOURCES) $(reference_IDMAPS)
+
reverse_engineering_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -210,6 +282,60 @@
reverse-engineering-manprepped.xml: $(reverse_engineering_SOURCES) $(reverse_engineering_IDMAPS)
reverse-engineering-remprepped.xml: $(reverse_engineering_SOURCES) $(reverse_engineering_IDMAPS)
+stored_procedures_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+stored_procedures_IMAGES =
+stored_procedures_SOURCES = stored-procedures.xml $(stored_procedures_INCLUDES)
+stored_procedures_IDMAPS =
+stored-procedures.validpure: $(stored_procedures_SOURCES)
+stored-procedures.titles: $(stored_procedures_SOURCES)
+stored-procedures.useless: $(stored_procedures_SOURCES)
+stored-procedures.valid: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+stored-procedures.validwarn: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+stored-procedures-prepped.xml: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+stored-procedures-manprepped.xml: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+stored-procedures-remprepped.xml: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+
+table_editor_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+table_editor_IMAGES =
+table_editor_SOURCES = table-editor.xml $(table_editor_INCLUDES)
+table_editor_IDMAPS =
+table-editor.validpure: $(table_editor_SOURCES)
+table-editor.titles: $(table_editor_SOURCES)
+table-editor.useless: $(table_editor_SOURCES)
+table-editor.valid: $(table_editor_SOURCES) $(table_editor_IDMAPS)
+table-editor.validwarn: $(table_editor_SOURCES) $(table_editor_IDMAPS)
+table-editor-prepped.xml: $(table_editor_SOURCES) $(table_editor_IDMAPS)
+table-editor-manprepped.xml: $(table_editor_SOURCES) $(table_editor_IDMAPS)
+table-editor-remprepped.xml: $(table_editor_SOURCES) $(table_editor_IDMAPS)
+
+tutorial_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ version.ent \
+ workbench-pro.ent
+tutorial_IMAGES =
+tutorial_SOURCES = tutorial.xml $(tutorial_INCLUDES)
+tutorial_IDMAPS =
+tutorial.validpure: $(tutorial_SOURCES)
+tutorial.titles: $(tutorial_SOURCES)
+tutorial.useless: $(tutorial_SOURCES)
+tutorial.valid: $(tutorial_SOURCES) $(tutorial_IDMAPS)
+tutorial.validwarn: $(tutorial_SOURCES) $(tutorial_IDMAPS)
+tutorial-prepped.xml: $(tutorial_SOURCES) $(tutorial_IDMAPS)
+tutorial-manprepped.xml: $(tutorial_SOURCES) $(tutorial_IDMAPS)
+tutorial-remprepped.xml: $(tutorial_SOURCES) $(tutorial_IDMAPS)
+
uninstalling_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -246,23 +372,23 @@
upgrading-manprepped.xml: $(upgrading_SOURCES) $(upgrading_IDMAPS)
upgrading-remprepped.xml: $(upgrading_SOURCES) $(upgrading_IDMAPS)
-using_INCLUDES = \
+views_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
all-entities.ent \
version.ent \
workbench-pro.ent
-using_IMAGES =
-using_SOURCES = using.xml $(using_INCLUDES)
-using_IDMAPS =
-using.validpure: $(using_SOURCES)
-using.titles: $(using_SOURCES)
-using.useless: $(using_SOURCES)
-using.valid: $(using_SOURCES) $(using_IDMAPS)
-using.validwarn: $(using_SOURCES) $(using_IDMAPS)
-using-prepped.xml: $(using_SOURCES) $(using_IDMAPS)
-using-manprepped.xml: $(using_SOURCES) $(using_IDMAPS)
-using-remprepped.xml: $(using_SOURCES) $(using_IDMAPS)
+views_IMAGES =
+views_SOURCES = views.xml $(views_INCLUDES)
+views_IDMAPS =
+views.validpure: $(views_SOURCES)
+views.titles: $(views_SOURCES)
+views.useless: $(views_SOURCES)
+views.valid: $(views_SOURCES) $(views_IDMAPS)
+views.validwarn: $(views_SOURCES) $(views_IDMAPS)
+views-prepped.xml: $(views_SOURCES) $(views_IDMAPS)
+views-manprepped.xml: $(views_SOURCES) $(views_IDMAPS)
+views-remprepped.xml: $(views_SOURCES) $(views_IDMAPS)
workbench_pro_INCLUDES = \
../common/fixedchars.ent \
@@ -273,17 +399,24 @@
foreign-key-relationships.xml \
forward-engineering.xml \
grt-shell.xml \
+ images.xml \
initial-startup.xml \
installing.xml \
legalnotice.en.xml \
mysql-enterprise.xml \
+ notes.xml \
+ options-connections.xml \
plugins.xml \
printing.xml \
+ reference.xml \
reverse-engineering.xml \
+ stored-procedures.xml \
+ table-editor.xml \
+ tutorial.xml \
uninstalling.xml \
upgrading.xml \
- using.xml \
version.ent \
+ views.xml \
workbench-pro.ent \
writing-plugins.xml \
writing-scripts.xml
Added: trunk/workbench-pro/images.xml
===================================================================
--- trunk/workbench-pro/images.xml (rev 0)
+++ trunk/workbench-pro/images.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 43, Lines Deleted: 0; 954 bytes
@@ -0,0 +1,43 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="wbpro-images">
+
+ <title>Creating Images</title>
+
+ <para>
+
+ </para>
+
+ <section id="images-overview">
+ <title>Overview </title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="images-tool">
+ <title> The Images Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="images-editor">
+ <title>The Images Editor</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+</chapter>
Added: trunk/workbench-pro/notes.xml
===================================================================
--- trunk/workbench-pro/notes.xml (rev 0)
+++ trunk/workbench-pro/notes.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 43, Lines Deleted: 0; 950 bytes
@@ -0,0 +1,43 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="notes-procedures">
+
+ <title>Creating Notes</title>
+
+ <para>
+
+ </para>
+
+ <section id="notes-overview">
+ <title>Overview </title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="notes-tools">
+ <title> The Notes Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="notes-editor">
+ <title>The Notes Editor</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+</chapter>
Modified: trunk/workbench-pro/options-connections.xml
===================================================================
--- trunk/workbench-pro/options-connections.xml 2007-10-15 20:04:37 UTC (rev 8107)
+++ trunk/workbench-pro/options-connections.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 3, Lines Added: 8, Lines Deleted: 8; 1081 bytes
@@ -1,11 +1,11 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+<?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 % all.entities SYSTEM "all-entities.ent">
- %all.entities;
+[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
]>
-<section id="mysql-gui-options-connections">
+<chapter id="wbpro-options-connections">
<title>Connections</title>
@@ -223,7 +223,7 @@
</itemizedlist>
- <section id ="mysql-gui-options-ssl-connections">
+ <section id ="wbpro-options-ssl-connections">
<title>SSL Connections</title>
@@ -288,5 +288,5 @@
</section>
-</section>
+</chapter>
<!-- END CONNECTIONS -->
Added: trunk/workbench-pro/reference.xml
===================================================================
--- trunk/workbench-pro/reference.xml (rev 0)
+++ trunk/workbench-pro/reference.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 228, Lines Deleted: 0; 3775 bytes
@@ -0,0 +1,228 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="wbpro-reference">
+
+ <title>&workbench_pro; Reference</title>
+
+ <para>
+ - UI Overview
+ - Docking Area
+ - Palettes
+ - Toolbar
+ - Status Bar
+ - etc.
+ </para>
+
+ <section id="menus">
+ <title>&workbench_pro; Menus</title>
+
+ <section id="file-menu">
+ <title>The File Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="edit-menu">
+ <title> The Edit menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="view-menu">
+ <title>The View Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="database-menu">
+ <title>The Database Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="plugins-menu">
+ <title>The Plug-ins Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="tools-menu">
+ <title>The Tools Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="window-menu">
+ <title>The Window Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="help-menu">
+ <title>The Help Menu</title>
+
+ <para>
+
+ </para>
+
+ </section>
+ </section>
+ <!--end menus-->
+
+ <section id="overview-page">
+ <title>Overview Page</title>
+
+
+ <section id="views-overview-diagrams">
+ <title>Overview </title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="view-overview-physical-schemata">
+ <title> The Physical Schemata</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="views-overview-privileges">
+ <title>Privileges</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="views-overview-other">
+ <title>Other</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ </section>
+
+
+ <!--end overview page-->
+
+ <section id="workbench-pro-diagrams">
+ <title>Overview </title>
+
+ <para>
+ The following is only for editing diagrams
+ </para>
+
+
+
+ <section id="vertical-toolbar">
+ <title> The Vertical Toolbar</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="standard-mouse-pointer">
+ <title>The Standard Mouse Pointer</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="hand-tool">
+ <title> The Hand Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="eraser-tool">
+ <title>The Eraser Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="layer-tool">
+ <title>Using the Layer Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+ </section>
+
+ <!--end diagrams-->
+
+ <section id="wbpro-navigator-palettes">
+
+ <title>The Navigator Palettes</title>
+
+ <para>
+
+ </para>
+
+ <section id="views-schemata-layers-palettes">
+ <title>The Schemata/Layers Palettes</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="views-properties-palettes">
+ <title>The Properties Palettes</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ </section>
+
+</chapter>
Added: trunk/workbench-pro/stored-procedures.xml
===================================================================
--- trunk/workbench-pro/stored-procedures.xml (rev 0)
+++ trunk/workbench-pro/stored-procedures.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 43, Lines Deleted: 0; 1074 bytes
@@ -0,0 +1,43 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="wbpro-stored-procedures">
+
+ <title>Creating Stored Procedures and Functions</title>
+
+ <para>
+
+ </para>
+
+ <section id="stored-procedures-overview">
+ <title>Overview </title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="stored-procedures-tools">
+ <title> The Routine Group Tool</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="stored-procedures-editor">
+ <title>The Routine Groups Editor</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+</chapter>
Added: trunk/workbench-pro/table-editor.xml
===================================================================
--- trunk/workbench-pro/table-editor.xml (rev 0)
+++ trunk/workbench-pro/table-editor.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 620, Lines Deleted: 0; 20196 bytes
@@ -0,0 +1,620 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="gui-table-editor">
+
+ <title>The &table_editor;</title>
+
+ <section id="gui-table-editor-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ The &table_editor; is a component that enables the visual creation and
+ modification of tables.
+ </para>
+
+ <para>
+ The &table_editor; can be accessed from the &workbench; by double
+ clicking a table in the <literal>Main View</literal> panel. On
+ Windows you also have the option of right-clicking in the schemata
+ panel and choosing the <guimenu>Create MySQL Table</guimenu>
+ option from the pop-up menu.
+ </para>
+
+ <para>
+ The appearance of the &table_editor; varies slightly depending
+ upon the operating system (OS) and whether the &table_editor; is
+ docked or not. For example, under Linux the Columns and Indexes
+ are separate tabs but under Windows they are combined in one.
+ However, the same basic functionality is available regardless of
+ docking or the particular OS.
+ </para>
+
+ <note>
+ <para>
+ Docking is not supported on all operating systems.
+ </para>
+ </note>
+
+ </section>
+
+<!-- END INTRODUCTION -->
+
+ <section id="wbpro-editor-main-window">
+
+ <title>The Main Editor Window</title>
+
+ <para>
+ The &table_editor; consists of a work space divided into tabs,
+ some general information prompts, and two or three action buttons.
+ </para>
+
+ <para>
+ Regardless of the active tab, you can always edit the table name
+ and the table comment.
+ </para>
+
+ <!--figure>
+ <title>The &table_editor;</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/tableeditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The &table_editor;</phrase>
+ </textobject>
+ </mediaobject>
+ </figure-->
+
+ <para>
+ The tabbed area is divided into three sections:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <emphasis>Columns and Indices:</emphasis> Use the Columns and
+ Indices tab to create and modify the table's column and index
+ information. You can also create FOREIGN KEY relationships
+ using this tab.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Table Options:</emphasis>Use the Table Options tab
+ to choose the storage engine and default character set used by
+ the table.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>Advanced Options:</emphasis> Use the Advanced
+ Options tab to configure options such as the per-table storage
+ directory, MERGE and RAID table options, and table/row length
+ options.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Each of these areas are discussed in further detail in the
+ following sections.
+ </para>
+
+ </section>
+
+<!-- END MAIN WINDOW -->
+
+ <section id="wbpro-editor-columns-and-indices">
+
+ <title>The Columns And Indices Tab</title>
+
+ <para>
+ The <literal>Columns and Indices</literal> tab can be used to
+ display and edit all column and index information for your table.
+ Using this tab, you can add, drop, and alter columns and indexes.
+ </para>
+
+ <section id="table-editor-columns-and-indices-column-editor">
+
+ <title>The Column Editor</title>
+
+ <para>
+ You can use the column editor to change the name, data type,
+ default value, and other properties of your table's columns.
+ </para>
+
+ <!--figure>
+ <title>The column editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/columneditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The column editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure-->
+
+ <para>
+ To add a column simply double-click a column in an empty row and
+ enter an appropriate value.
+ </para>
+
+ <para>
+ To change the name, data type, default value, or comment of a
+ column, double click on the value you wish to change. The value
+ becomes editable and you can complete your changes by pressing
+ the <keycap>Enter</keycap> key.
+ </para>
+
+ <para>
+ To modify the flags on a column (<literal>UNSIGNED</literal>,
+ <literal>BINARY</literal>, <literal>ASCII</literal>, and so on)
+ check and uncheck the boxes corresponding to the flag you wish
+ to change.
+ </para>
+
+ <para>
+ To the left of the column name is an icon that indicates whether
+ the column is a member of the primary key. If the icon is a
+ small key, that column belongs to the primary key, otherwise the
+ icon is a blue diamond. To add or remove a column from the
+ primary key, you can click on the icon.
+ </para>
+
+ </section>
+
+<!-- END COLUMN EDITOR -->
+
+ <section id="table-editor-columns-and-indices-detail">
+
+ <title>The Detail Area</title>
+
+ <para>
+ The detail area of the <literal>Columns and Indices</literal>
+ tab is divided into three tabs used for modifying the index,
+ foreign key, and miscellaneous information regarding your
+ columns.
+ </para>
+
+ <section id="table-editor-columns-and-indices-detail-indices">
+
+ <title>The Indices Tab</title>
+
+ <para>
+ The <literal>Indices</literal> tab holds all index information
+ for your table. You can add, drop, and modify indexes using
+ the indices tab, in combination with the column editor.
+ </para>
+
+ <!--figure>
+ <title>The index editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/indexeditor.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The index editor</phrase>
+ </textobject>
+ </mediaobject>
+ </figure-->
+
+ <para>
+ To add an index, click the <guibutton>+</guibutton> (plus)
+ button below the index list. The &workbench; prompts for
+ an index name and the new index is created. Under Windows, you
+ can change the automatically generated index name by using the
+ <literal>Options</literal> dialog window. For more information
+ see, <!--xref linkend="mysql-gui-options-editors"/-->.
+ </para>
+
+ <para>
+ To drop an index, select the index and click the
+ <guibutton>–</guibutton> (minus) button.
+ </para>
+
+ <para>
+ Use the <guilabel>Index Name</guilabel> and <guilabel>Index
+ Kind</guilabel> dialog boxes to modify the name and type
+ (<literal>UNIQUE</literal>, <literal>FULLTEXT</literal>, and
+ so on) of the index.
+ </para>
+
+ <para>
+ To add columns to an index, either click and drag the column
+ to the <guilabel>Index Columns</guilabel> box or select the
+ column you wish to add and click the <guibutton>+</guibutton>
+ (plus) button to the right of the <guilabel>Index
+ Columns</guilabel> box. You can remove a column from the index
+ by selecting the column and clicking the
+ <guibutton>–</guibutton> (minus) button to drop the
+ column from the index.
+ </para>
+
+ <para>
+ To change an index to only refer to a column prefix (such as
+ with the CHAR and VARCHAR string data types), select the index
+ column you wish to prefix in the <guilabel>Index
+ Columns</guilabel> box and then click the arrow icon to the
+ right of the <guilabel>Index Columns</guilabel> box. Select
+ the <guimenu>Set Index Column Length</guimenu> option from the
+ drop-down menu that appears.
+ </para>
+
+ </section>
+
+<!-- END INDICES TAB -->
+
+ <section id="table-editor-columns-and-indices-detail-foreign-keys">
+
+ <title>The Foreign Keys Tab</title>
+
+ <para>
+ The <literal>Foreign Keys</literal> tab is divided into two
+ sections, one with a list of foreign keys and one with various
+ dialog boxes for foreign key settings.
+ </para>
+
+ <para>
+ To add a foreign key, click the <guibutton>+</guibutton>
+ (plus) button below the foreign key list. A dialog box prompts
+ for a foreign key name and the new foreign key is created.
+ Under Windows, you can change the automatically generated
+ foreign key name by using the <literal>Options</literal>
+ dialog window. For more information see,
+ <!--xref linkend="mysql-gui-options-editors"/-->.
+ </para>
+
+ <para>
+ To drop a foreign key, select the foreign key and click the
+ <guibutton>–</guibutton> (minus) button below the
+ foreign key list.
+ </para>
+
+ <para>
+ You can modify the name of the foreign key, its <literal>ON
+ DELETE</literal>, and its <literal>ON UPDATE</literal> actions
+ using the dialog boxes provided in the <guilabel>Foreign Key
+ Settings</guilabel> section of the tab.
+ </para>
+
+ <para>
+ The options are:
+
+ <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>
+
+ <para>
+ To establish a foreign key relationship, choose a table from
+ the <guilabel>Ref. Table</guilabel> drop-down list. (Under
+ Linux this list box is called <guilabel>Refer.
+ Table</guilabel>.) The fields that can be related to create a
+ foreign key are listed in the frame below the drop-down list.
+ This frame contains two columns; one labeled
+ <literal>Column</literal> and the other <literal>Reference
+ Column</literal>. To select a column as a foreign key, double
+ click the area below <guilabel>Column</guilabel> and select a
+ column from the drop-down list. Alternately, drag a column
+ from the column editor to the <guilabel>Column</guilabel>
+ section. To add a related column from the referenced table,
+ double click the area below <guilabel>Reference
+ Column</guilabel> and select the related column from the
+ drop-down list.
+ </para>
+
+ </section>
+
+<!-- END FOREIGN KEY -->
+
+ <section id="table-editor-columns-and-indices-detail-column-details">
+
+ <title>The Column Details Tab</title>
+
+ <para>
+ The <literal>Column Details</literal> tab provides an
+ interface for setting the parameters of a column without using
+ the table interface of the column editor.
+ </para>
+
+ <para>
+ All settings that are available in the
+ <!--link linkend="gui-table-editor-columns-and-indices-column-editor">Column
+ Editor</link--> are also available in the Column Details tab,
+ and in addition you can also configure the column character
+ set and column default collation from the Column Details tab.
+ </para>
+
+ <para>
+ Depending upon circumstances one or the other of these views
+ may be more convenient. However, changing the data type in the
+ tabular view is especially easy because a drop-down list shows
+ all available data types.
+ </para>
+
+ </section>
+
+<!-- END COLUMN DETAILS -->
+
+ </section>
+
+<!-- END DETAIL AREA -->
+
+ </section>
+
+<!-- END COLUMNS AND INDICES -->
+
+ <section id="table-editor-Table-Options">
+
+ <title>The Table Options Tab</title>
+
+ <para>
+ The <literal>Table Options</literal> tab allows you to change the
+ storage engine and default character set of your table.
+ </para>
+
+ <para>
+ The potential storage engines are listed in a drop-down list box.
+ Select a particular engine to display a brief summary of that
+ engine's features and capabilities.
+ </para>
+
+ <para>
+ Under Windows, engines that are not available are shown in red.
+
+ <remark>
+ [PL] Change when appropriate. (This behavior will soon be
+ implemented under Linux as well.)
+ </remark>
+
+ Under Mac OS X, unavailable engines are grayed out and under Linux
+ there is no differentiation. If your server has built-in support
+ for the <literal>Falcon</literal> engine, that engine will show up
+ in the list of available engines. Otherwise, the
+ <literal>Falcon</literal> engine does not show at all.
+ </para>
+
+ <para>
+ To change the storage engine for your table, select the desired
+ storage engine from the list box.
+ </para>
+
+ <para>
+ To change the default character set or collation of your table,
+ choose a new option from the drop-down list of available character
+ sets.
+ </para>
+
+ </section>
+
+<!-- END TABLE OPTIONS -->
+
+ <section id="table-editor-advanced-options">
+
+ <title>The Advanced Options Tab</title>
+
+ <para>
+ The <literal>Advanced Options</literal> tab is used to configure
+ table options that would be considered outside the standard set of
+ options that most users designate when creating and modifying
+ tables.
+ </para>
+
+ <para>
+ The <literal>Advanced Options</literal> tab is divided into
+ several sub-sections, each of which is described in the upcoming
+ sections of this manual.
+ </para>
+
+ <para>
+ For descriptions of most options set using the Advanced Options
+ tab, see <!--xref linkend="create-table"/-->.
+ </para>
+
+ <section id="table-editor-advanced-options-various">
+
+ <title>The Various Section</title>
+
+ <para>
+ The <literal>Various</literal> section of the <literal>Advanced
+ Options</literal> tab contains options for you to set the
+ <literal>PACK KEYS</literal> behavior, the table password, the
+ initial <literal>AUTO_INCREMENT</literal> value, and the delayed
+ key update behavior.
+ </para>
+
+ <para>
+ The <literal>AUTO_INCREMENT</literal> and delayed key update
+ behaviors apply only to MyISAM tables.
+ </para>
+
+ </section>
+
+<!-- END VARIOUS SECTION -->
+
+ <section id="gui-table-editor-advanced-options-row-options">
+
+ <title>The Row Options Section</title>
+
+ <para>
+ The <literal>Row Options</literal> section can be used to
+ configure options such as the row format, checksum use, and the
+ row size parameters needed for large tables.
+ </para>
+
+ <para>
+ To set the row format, choose the desired row format from the
+ drop-down list. See <!--xref linkend="myisam-table-formats"/-->, for
+ more information on the different row formats that are
+ available. This option only applies to MyISAM tables.
+ </para>
+
+ <para>
+ When you expect a table to be particularly large, use the
+ <guilabel>Avg Row Length</guilabel>, <guilabel>Min
+ Rows</guilabel>, and <guilabel>Max Rows</guilabel> options to
+ enable the MySQL server to better accommodate your data. See
+ <!--xref linkend="create-table"/-->, for more information on how to
+ use these options.
+ </para>
+
+ </section>
+
+<!-- END ROW OPTIONS -->
+
+ <section id="table-editor-advanced-options-storage-options">
+
+ <title>The Storage Options Section</title>
+
+ <para>
+ The <literal>Storage Options</literal> section is used to
+ configure a custom path to the table storage and data files.
+ This option can help improve data integrity and server
+ performance by locating different tables on different hard
+ drives.
+ </para>
+
+ <para>
+ This option is only available for MyISAM tables and is not
+ available for servers running under the Windows operating
+ system.
+ </para>
+
+ </section>
+
+<!-- END STORAGE OPTIONS -->
+
+ <section id="table-editor-advanced-options-merge-options">
+
+ <title>The Merge Table Options Section</title>
+
+ <para>
+ The <literal>Merge Table</literal> Options section is used to
+ configure MERGE tables in MyISAM. To create a MERGE table,
+ select MERGE as your storage engine in the
+ <!--link linkend="gui-table-editor-Table-Options">Table Options
+ Tab</link--> and then specify the tables you wish to MERGE in the
+ <guilabel>Union Tables</guilabel> dialog.
+ </para>
+
+ <para>
+ You can also specify the action the server should take when
+ users attempt to perform INSERT statements on the merge table.
+ See <!--xref linkend="merge-storage-engine"/-->, for more information
+ on MERGE tables.
+ </para>
+
+ </section>
+
+<!-- END MERGE OPTIONS -->
+
+ <section id="table-editor-advanced-options-raid-options">
+
+ <title>The Table RAID Settings Section</title>
+
+ <para>
+ The <literal>Table RAID Settings</literal> section allows you to
+ configure RAID support for MyISAM tables. RAID allows MyISAM
+ table data files to grow larger than the 2GB/4GB size limit
+ imposed by some operating systems.
+ </para>
+
+ <para>
+ For more information on using RAID support with MyISAM, see
+ <!--xref linkend="create-table"/-->.
+ </para>
+
+ </section>
+
+<!-- END RAID SECTION -->
+
+ </section>
+
+<!-- END ADVANCED OPTIONS -->
+
+ <section id="table-editor-changes">
+
+ <title>Applying Your Changes</title>
+
+ <para>
+ The changes you make with the &table_editor; are not immediately
+ applied but are instead queued to be applied in batches after you
+ have made all your edits.
+ </para>
+
+ <para>
+ To apply the changes you have made, click the <guibutton>Apply
+ Changes</guibutton> button. The <literal>Confirm Table
+ Edit</literal> dialog will appear.
+ </para>
+
+ <!--figure>
+ <title>The Confirm Table Edit dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/confirmchanges.png" lang="en" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">The Confirm Table Edit dialog</phrase>
+ </textobject>
+ </mediaobject>
+ </figure-->
+
+ <para>
+ You can click the <guibutton>Execute</guibutton> button to confirm
+ the changes and have them applied, or click the
+ <guibutton>Cancel</guibutton> button to cancel the changes (the
+ table editor window is redisplayed with your changes intact). You
+ can also click the <guibutton>Discard Changes</guibutton> button
+ in the main &table_editor; window to discard all changes you have
+ made.
+ </para>
+
+ <para>
+ You can also copy the proposed changes to the clipboard for
+ further editing by highlighting the ALTER TABLE or CREATE TABLE
+ statement, right-clicking and choosing <guimenu>Copy</guimenu>
+ from the drop-down menu.
+ </para>
+
+ </section>
+
+<!-- END APPLYING CHANGES -->
+
+</chapter>
+<!-- END TABLE EDITOR -->
Modified: trunk/workbench-pro/toc.txt
===================================================================
--- trunk/workbench-pro/tutorial.xml (rev 0)
+++ trunk/workbench-pro/tutorial.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 2, Lines Added: 96, Lines Deleted: 1; 3787 bytes
@@ -23,6 +23,7 @@
4.2.1. Tarball Upgrade
4.2.2. RPM Upgrade
4.3. Upgrading – Mac OS X
+
5. Initial Startup
- Activation Procedure (commercial version)
5.1. Startup Under Windows
Copied: trunk/workbench-pro/tutorial.xml (from rev 8092, trunk/workbench-pro/using.xml)
===================================================================
--- trunk/workbench-pro/tutorial.xml (rev 0)
+++ trunk/workbench-pro/tutorial.xml 2007-10-15 20:28:14 UTC (rev 8108)
@@ -0,0 +1,94 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="workbench-pro-tutorials">
+
+ <title>&workbench_pro; Tutorials</title>
+
+ <para>
+
+ </para>
+
+ <section id="importing-sql-script">
+ <title>Importing an SQL Script</title>
+
+ <para>
+ 1. Start Workbench
+ 2. Select File -> Import -> SQL Script from the menu
+ 3. Open an SQL file, e.g. Sakila.sql
+ 4. Now create an EER Model View by doubleclicking on the [Add View] icon.
+ 5. Browse the Catalog Palette to the right till you find the Sakila tables
+ 6. Draw a table from the Catalog Palette to the canvas
+ 7. Repeat for all tables you want to place
+ </para>
+
+ </section>
+
+ <section id="basic-modeling">
+ <title>Basic Modeling</title>
+
+ <para>
+ 1. Start Workbench
+ 2. On the Overview page doubleclick on the [Add View] icon. This will create a new EER Model View
+ 3. On the Model View select the Table Placement Tool from the sidebar to the left or press T on the keyboard
+ 4. Click on the Canvas to place the table. Notice that the table is selected
+ 5. Press E on the keyboard or doubleclick the table to launch the table editor
+ 6. Type in the name of the table, e.g. product. Notice that the table name was automatically selected in the table editor.
+ 7. Press Tab or Enter to proceed to the column grid
+ 1. The column editor will suggest "id + tablename" as the first column name. Press Tab or Enter to accept it
+ 2. Now the datatype column has the focus. Press Tab or Enter again. Notice that the focus is now on the 2nd column
+ 3. Enter the name of the 2nd column.
+ 4. Repeat this for all columns
+ 8. Close the table editor
+ 9. Select the Place Table Tool again and create a second table. Name it product_part
+ 10. Now select the 1:n Relationship Tool from the sidebar
+ 1. First click on the "1" table, product in this case
+ 2. Second click on the "n" table, product_part in this case
+ 3. A foreign key relationship will be created
+ 4. Notice that a foreign key column is added to the "n" table
+ 11. Select the View Placement Tool in the sidebar or press V on the keyboard when the Canvas has the focus
+ 12. Click on the canvas to place the view
+ 13. Press E on the keyboard or doubleclick the view to edit it
+ </para>
+
+ </section>
+
+ <section id="default-schema">
+ <title>The Default Schema</title>
+
+ <para>
+
+ </para>
+ <section>
+ <title>Creating a new Table</title>
+
+ <para>
+
+ </para>
+ </section>
+
+ <section>
+ <title>Creating Other Schema Objects</title>
+
+ <para>
+
+ </para>
+ </section>
+
+ </section>
+
+ <section>
+ <title>Creating a New Schema</title>
+
+ <para>
+
+ </para>
+ </section>
+
+
+
+</chapter>
Added: trunk/workbench-pro/views.xml
===================================================================
--- trunk/workbench-pro/views.xml (rev 0)
+++ trunk/workbench-pro/views.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 43, Lines Deleted: 0; 954 bytes
@@ -0,0 +1,43 @@
+<?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 % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<chapter id="wbpro-creating-views">
+
+ <title>Creating Views</title>
+
+ <para>
+
+ </para>
+
+ <section id="views-overview">
+ <title>Overview </title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="view-tools">
+ <title> The View Tools</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+ <section id="views-editor">
+ <title>The Views Editor</title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+</chapter>
Modified: trunk/workbench-pro/workbench-pro.ent
===================================================================
--- trunk/workbench-pro/workbench-pro.ent 2007-10-15 20:04:37 UTC (rev 8107)
+++ trunk/workbench-pro/workbench-pro.ent 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 451 bytes
@@ -2,5 +2,5 @@
<!ENTITY workbench_pro "MySQL Workbench">
<!ENTITY table_editor "MySQL Table Editor">
<!ENTITY workbench "MySQL Workbench">
+<!ENTITY table_editor "MySQL Table Editor">
-
Modified: trunk/workbench-pro/workbench-pro.xml
===================================================================
--- trunk/workbench-pro/workbench-pro.xml 2007-10-15 20:04:37 UTC (rev 8107)
+++ trunk/workbench-pro/workbench-pro.xml 2007-10-15 20:28:14 UTC (rev 8108)
Changed blocks: 2, Lines Added: 10, Lines Deleted: 2; 1695 bytes
@@ -46,14 +46,22 @@
<xi:include href="initial-startup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="using.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="table-editor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="foreign-key-relationships.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="views.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="stored-procedures.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="images.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<xi:include href="reverse-engineering.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="forward-engineering.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@@ -62,7 +70,7 @@
<xi:include href="plugins.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <!--xi:include href="options-connections.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/-->
+ <xi:include href="options-connections.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="expanding.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8108 - trunk/workbench-pro | plavin | 15 Oct |
