List:Commits« Previous MessageNext Message »
From:plavin Date:November 21 2007 11:40pm
Subject:svn commit - mysqldoc@docsrva: r8822 - trunk/workbench-pro
View as plain text  
Author: plavin
Date: 2007-11-21 23:40:01 +0100 (Wed, 21 Nov 2007)
New Revision: 8822

Log:
Redo section on connection


Modified:
   trunk/workbench-pro/Makefile.depends
   trunk/workbench-pro/editions.xml
   trunk/workbench-pro/options-connections.xml
   trunk/workbench-pro/reverse-engineering.xml
   trunk/workbench-pro/tutorial.xml
   trunk/workbench-pro/uninstalling.xml
   trunk/workbench-pro/workbench-pro.xml


Modified: trunk/workbench-pro/Makefile.depends
===================================================================
--- trunk/workbench-pro/Makefile.depends	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/Makefile.depends	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 2, Lines Added: 19, Lines Deleted: 0; 1350 bytes

@@ -16,6 +16,24 @@
 change-history-manprepped.xml: $(change_history_SOURCES) $(change_history_IDMAPS)
 change-history-remprepped.xml: $(change_history_SOURCES) $(change_history_IDMAPS)
 
+editions_INCLUDES = \
+	../common/fixedchars.ent \
+	../refman-common/urls.ent \
+	all-entities.ent \
+	version.ent \
+	workbench-pro.ent
+editions_IMAGES =
+editions_SOURCES = editions.xml $(editions_INCLUDES)
+editions_IDMAPS =
+editions.validpure: $(editions_SOURCES)
+editions.titles: $(editions_SOURCES)
+editions.useless: $(editions_SOURCES)
+editions.valid: $(editions_SOURCES) $(editions_IDMAPS)
+editions.validwarn: $(editions_SOURCES) $(editions_IDMAPS)
+editions-prepped.xml: $(editions_SOURCES) $(editions_IDMAPS)
+editions-manprepped.xml: $(editions_SOURCES) $(editions_IDMAPS)
+editions-remprepped.xml: $(editions_SOURCES) $(editions_IDMAPS)
+
 expanding_INCLUDES = \
 	../common/fixedchars.ent \
 	../refman-common/urls.ent \

@@ -407,6 +425,7 @@
 	../refman-common/urls.ent \
 	all-entities.ent \
 	change-history.xml \
+	editions.xml \
 	expanding.xml \
 	foreign-key-relationships.xml \
 	forward-engineering.xml \


Modified: trunk/workbench-pro/editions.xml
===================================================================
--- trunk/workbench-pro/editions.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/editions.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 413 bytes

@@ -7,7 +7,7 @@
 ]>
 <chapter id="wb-editions">
 
-  <title>&workbench; editions</title>
+  <title>&workbench; Editions</title>
 
   <section id="wb-community-edition">
 


Modified: trunk/workbench-pro/options-connections.xml
===================================================================
--- trunk/workbench-pro/options-connections.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/options-connections.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 3, Lines Added: 51, Lines Deleted: 210; 12116 bytes

@@ -10,15 +10,34 @@
   <title>Connections</title>
 
   <para>
-    The <literal>Connections</literal> section allows you to create,
-    edit, and delete connection profiles. The center box displays a list
-    of currently available profiles, together with a history of
-    connections that were made without being stored in a profile. You
-    can collapse or expand both the <literal>Connections</literal> and
-    <literal>History</literal> trees by double clicking them.
+    The <literal>Database Synchronization</literal> window is used to
+    create, edit, and delete connection profiles.
   </para>
 
   <para>
+    Choose a stored connection from the drop-down list box to the left
+    of the <guilabel>Stored Connection:</guilabel> label. or select
+    <literal>&lt;New Connection&gt;</literal> to create a new
+    connection. The <guibutton>+</guibutton> button to the right of the
+    list box is used when creating a new connection. Click it to open a
+    dialog box to input the name of the new connection. If you wish to
+    delete a connection, use the <guibutton>-</guibutton> button. The
+    <guibutton>C</guibutton> button clears all the data related to a
+    connection
+  </para>
+
+  <para>
+    Use the <guilabel>Database System</guilabel> list box to select type
+    of RDBMS server you wish to connect to. select a driver from the
+    <guilabel>Driver</guilabel> list box.
+
+    <remark>
+      [PL]Note about these options
+    </remark>
+  </para>
+
+<!--para>
+    <remark>[PL]This may still be true</remark>
     Connections are automatically added to the
     <literal>History</literal> tree whenever you establish a connection
     to a MySQL server without using one of the profiles stored under the

@@ -27,122 +46,52 @@
     can use any of them by manually typing their name into the
     <literal>Connection</literal> box of the
     <literal>Connection</literal> dialog.
-  </para>
+  </para-->
 
-  <!--figure>
-    <title>Options dialog: Connections</title>
-    <mediaobject>
-      <imageobject>
-        <imagedata fileref="images/published/options-connection.png" format="PNG"
lang="en"/>
-      </imageobject>
-      <textobject>
-        <phrase lang="en">Options dialog: Connections</phrase>
-      </textobject>
-    </mediaobject>
-  </figure-->
-
   <para>
-    To edit an existing connection profile, click on its name and change
-    the values that appear in the <literal>Connection
-    Parameters</literal> and <literal>Advanced Parameters</literal>
-    tabs, then click on the <guibutton>Apply Changes</guibutton> button
-    to save your changes.
+    When you select a connection profile from <literal>Stored
+    Connection</literal> list box or when you create a new connection,
+    the <literal>Parameters</literal> tab displays the following fields:
   </para>
 
-  <para>
-    When you select a connection profile from either the
-    <literal>Connections</literal> or <literal>History</literal>
trees,
-    the <literal>Connection Parameters</literal> tab displays the
-    following fields:
-  </para>
-
   <itemizedlist>
 
     <listitem>
       <para>
-        <literal>Connection</literal>: The connection profile label.
-        This is the name by which you refer to the profile and that
-        appears in the <literal>Connection</literal> drop-down box of
-        the Connection dialog. It may contain any characters, including
-        spaces. Choose distinctive names so that you can easily tell
-        which profiles they refer to. The names can help you distinguish
-        connections to different MySQL servers, or connections as
-        different MySQL users to a given server.
+        <guilabel>Hostname</guilabel>: The host name or IP address of
+        MySQL server
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <literal>Username</literal>: The username used to connect to the
-        MySQL server.
+        <guilabel>Port</guilabel>: The TCP/IP port on which the MySQL
+        server is listening
       </para>
     </listitem>
 
     <listitem>
-            <para>
-        <literal>Password</literal>: The password used to connect to the
-        MySQL server. Note that passwords are not stored in the
-        connection profile, unless you specify otherwise in the
-        <!--link
-linkend="mysql-gui-options-general-options">General
-        Options section</link-->.
-      </para>
-    </listitem>
-
-    <listitem>
       <para>
-        <literal>Hostname</literal>: The name of the host machine where
-        the MySQL server runs, or its IP address.
+        <literal>Username</literal>: The username used to connect to the
+        MySQL server.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <literal>Port</literal>: The TCP/IP port that the MySQL server
-        listens to on the host machine.
+        <literal>Password</literal>: The password used to connect to the
+        MySQL server. Note that passwords are not stored in the
+        connection profile, unless you specify otherwise in the
       </para>
     </listitem>
 
-    <listitem>
-      <para>
-        <literal>Type</literal>: Specifies the protocol used to connect
-        to the database server. The default protocol is
-        <literal>MySQL</literal> (which uses the native MySQL protocol).
-      </para>
-    </listitem>
-
-    <listitem>
-      <para>
-        <literal>Schema</literal>: The default database for a connection
-        when using the &workbench;.
-      </para>
-    </listitem>
-
-    <listitem>
-      <para>
-        <literal>Notes</literal>: You can use this field to enter
-        comments or additional information describing the connection
-        profile.
-      </para>
-    </listitem>
-
   </itemizedlist>
 
-  <note>
-    <para>
-      The <literal>Advanced Parameters</literal> tab is not available on
-      all platforms. Advanced parameters can still be configured in the
-      Connection dialog. Use the <guibutton>Details ...</guibutton>
-      button to display the <literal>Advanced Connection
-      Options</literal>.
-    </para>
-  </note>
 
   <para>
-    When you select a connection profile from either the
-    <literal>Connections</literal> or <literal>History</literal>
list,
-    the <literal>Advanced Parameters</literal> tab displays the
-    following checkboxes:
+    When you create a new connection or select a connection from the
+    <literal>Stored Connection</literal> list box, the
+    <literal>Advanced</literal> tab displays the following checkboxes:
   </para>
 
   <itemizedlist>

@@ -159,134 +108,26 @@
 
     <listitem>
       <para>
-        <literal>Return number of found rows, not number of affected
-        rows</literal>: By default, MySQL returns the number of rows
-        changed by the last <literal>UPDATE</literal>, deleted by the
-        last <literal>DELETE</literal> or inserted by the last
-        <literal>INSERT</literal> statement. When this option is
-        checked, the server returns the number of rows matched by the
-        <literal>WHERE</literal> statement for
<literal>UPDATE</literal>
-        statements.
+        Use SSL if available: This option turns on SSL encryption
       </para>
     </listitem>
 
     <listitem>
       <para>
-        <literal>Ignore spaces after function names, make them reserved
-        words</literal>: Normally, any reference to a function name in
-        an SQL statement must be followed immediately by an opening
-        parenthesis. If this option is checked, spaces may appear
-        between the function name and the parenthesis, like this:
+        <guilabel>Socket name</guilabel>: Use this option to connect to
+        a named pipe
       </para>
-
-<programlisting>
-COUNT (*)
-</programlisting>
-
-      <para>
-        Enabling this option has the effect that function names become
-        reserved words. This option corresponds to starting a MySQL
-        command-line tool with the <literal>--ignore-spaces</literal>
-        option.
-      </para>
     </listitem>
 
-    <listitem>
-      <para>
-        <literal>Allow interactive_timeout seconds of inactivity before
-        disconnect</literal>: Normally, the connection is closed by the
-        MySQL server after a certain period of inactivity on the client
-        side. This period can be set with the
-        <literal>interactive_timeout</literal> variable. If checked, the
-        server will not close the connection unless the period of
-        inactivity exceeds the value set by
-        <literal>interactive_timeout</literal>. This corresponds to
-        starting a MySQL command-line tool with the
-        <literal>--connect-timeout=<replaceable>seconds</replaceable>
-        </literal> option.
-      </para>
-    </listitem>
-
-    <listitem>
-      <para>
-        <literal>Enable LOAD DATA LOCAL handling</literal>: By default,
-        the <literal>LOCAL</literal> option of the <literal>LOAD
-        DATA</literal> statement is disabled for security reasons.
-        Enabling this option will allow you to load data from the local
-        machine (the machine where the client GUI application is
-        running). This option corresponds to starting a MySQL
-        command-line tool with the <literal>--local-infile=1</literal>
-        option. (Note that this option is ineffective unless the MySQL
-        server allows <literal>LOCAL</literal> handling.)
-      </para>
-    </listitem>
-
   </itemizedlist>
-
-  <section id ="wbpro-options-ssl-connections">
-
-    <title>SSL Connections</title>
-
-    <para>
-      To set up an SSL connection under Windows, open the
-      <guilabel>Advanced Parameters</guilabel> tab of the
-      <literal>Options Dialog</literal> window. Select the connection
-      you wish to configure, or create a new connection. Use the
-      <literal>Advanced Parameters</literal> text boxes to send options
-      to the MySQL client library in much the same way that you would
-      pass parameters to the command-line client.
-    </para>
-
-    <para>
-      The parameters are essentially the same as those you would use for
-      the command-line client, with underscores replacing
-      <quote><literal>-</literal></quote> and
<literal>USE_SSL</literal>
-      replacing <option>--ssl</option>. See the following example.
-    </para>
-
-    <!--figure>
-      <title>Options dialog: Advanced Parameters</title>
-      <mediaobject>
-        <imageobject>
-          <imagedata fileref="images/published/ssl-params.png" format="PNG"
lang="en"/>
-        </imageobject>
-        <textobject>
-          <phrase lang="en">Options dialog: Advanced Parameters</phrase>
-        </textobject>
-      </mediaobject>
-    </figure-->
-
-    <note>
-      <para>
-        The file separator used for path parameters is
-        <quote><literal>/</literal></quote> and not
-        <quote><literal>\</literal></quote>.
-      </para>
-    </note>
-
-    <para>
-      The parameters used with an SSL connection are found in the
-      <literal>SSL Command Options</literal> section of the reference
-      manual. For instructions on setting up SSL certificates, see
-      <literal>Setting Up SSL Certificates for MySQL</literal>. Links to
-      the different versions of the reference manual are found at
-      <ulink url="&base-url-refman;"/>.
-    </para>
-
-    <para>
-      <remark>
-        [PL] Confirm below with mikez.
-      </remark>
-    </para>
-
-<!--para>
-      To use SSL under Linux choose the <guilabel>Advanced Options</guilabel>
-      tab of the <literal>Options Dialog</literal> and check the
<literal>Encrypt connection if available</literal>
-      check box. Be sure to apply your changes before closing the tab.
-      </para-->
-
   
-  </section>
+  
+  <para>
+    To edit an existing connection profile, click on its name and change
+    the values that appear in the <literal> Parameters</literal> and
+    <literal>Advanced</literal> tabs, then click on the
<guibutton>Apply
+      Changes</guibutton> button to save your changes.
+  </para>
 
 </chapter>
 <!-- END CONNECTIONS -->


Modified: trunk/workbench-pro/reverse-engineering.xml
===================================================================
--- trunk/workbench-pro/reverse-engineering.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/reverse-engineering.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 514 bytes

@@ -7,7 +7,7 @@
 ]>
 <chapter id="workbench-reverse-engineering">
 
-  <title>Reverse Engineering</title>
+  <title>Reverse Engineering (Commercial Version)</title>
 
   <para>
     This chapter explains how to use the reverse engineering


Modified: trunk/workbench-pro/tutorial.xml
===================================================================
--- trunk/workbench-pro/tutorial.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/tutorial.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 2, Lines Added: 4, Lines Deleted: 2; 847 bytes

@@ -159,8 +159,10 @@
   <section id="wbpro-basic-modeling">
 
     <title>Basic Modeling</title>
+    
+    <para></para>
 
-    <para>
+    <!--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

@@ -184,7 +186,7 @@
       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>
+    </para-->
 
   </section>
 


Modified: trunk/workbench-pro/uninstalling.xml
===================================================================
--- trunk/workbench-pro/uninstalling.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/uninstalling.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 2, Lines Added: 3, Lines Deleted: 3; 828 bytes

@@ -31,8 +31,8 @@
         </para>
       
         <para>
-          Removing the application manually will not remove all the
-          files belonging to that application.
+          Removing the &workbench; manually will not remove all the
+          files belonging to &workbench;.
         </para>
       </note>
 

@@ -40,7 +40,7 @@
 
     <section id="wb-uninstall-windows-zipped">
 
-      <title>When installed From Zipped Files</title>
+      <title>When installed From a Zipped File</title>
 
       <para>
         If you installed &workbench; using zipped files find the


Modified: trunk/workbench-pro/workbench-pro.xml
===================================================================
--- trunk/workbench-pro/workbench-pro.xml	2007-11-21 20:09:02 UTC (rev 8821)
+++ trunk/workbench-pro/workbench-pro.xml	2007-11-21 22:40:01 UTC (rev 8822)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 3; 545 bytes

@@ -26,9 +26,7 @@
       </para>
 
         <para>
-          The documentation is currently incomplete. Some
-          descriptions may be applicable to older versions of
-          &workbench; only.
+          The documentation is currently incomplete. 
         </para>
 
       <para>


Thread
svn commit - mysqldoc@docsrva: r8822 - trunk/workbench-proplavin21 Nov