svn commit - mysqldoc@docsrva: r10051 - in trunk/workbench: . images/published

[plavin]

Author: plavin
Date: 2008-02-27 23:12:53 +0100 (Wed, 27 Feb 2008)
New Revision: 10051

Log:
Add image, update for version 5.0.14


Added:
   trunk/workbench/images/published/wb-roles.png
Modified:
   trunk/workbench/Makefile.depends
   trunk/workbench/installing.xml
   trunk/workbench/news-workbench-core.xml
   trunk/workbench/reference.xml

Property changes on: trunk/workbench/images/published/wb-roles.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream


Modified: trunk/workbench/Makefile.depends
===================================================================
--- trunk/workbench/Makefile.depends	2008-02-27 21:52:27 UTC (rev 10050)
+++ trunk/workbench/Makefile.depends	2008-02-27 22:12:53 UTC (rev 10051)
Changed blocks: 7, Lines Added: 10, Lines Deleted: 0; 2847 bytes

@@ -297,6 +297,7 @@
 	images/published/wb-navigator.png \
 	images/published/wb-options.png \
 	images/published/wb-reporting.png \
+	images/published/wb-roles.png \
 	images/published/wb-schema-privileges.png \
 	images/published/wb-table-tool-active.png \
 	images/published/wb-vertical-toolbar.png \

@@ -310,6 +311,7 @@
 	images/published/wb-navigator.png \
 	images/published/wb-options.png \
 	images/published/wb-reporting.png \
+	images/published/wb-roles.png \
 	images/published/wb-schema-privileges.png \
 	images/published/wb-table-tool-active.png \
 	images/published/wb-vertical-toolbar.png

@@ -319,12 +321,15 @@
 	../workbench/metadata/foreign-key-relationships.idmap \
 	../workbench/metadata/forward-engineering.idmap \
 	../workbench/metadata/grt-shell.idmap \
+	../workbench/metadata/images.idmap \
+	../workbench/metadata/layers.idmap \
 	../workbench/metadata/plugins.idmap \
 	../workbench/metadata/printing.idmap \
 	../workbench/metadata/reference.idmap \
 	../workbench/metadata/reverse-engineering.idmap \
 	../workbench/metadata/stored-procedures.idmap \
 	../workbench/metadata/tables.idmap \
+	../workbench/metadata/text-objects.idmap \
 	../workbench/metadata/tutorial.idmap \
 	../workbench/metadata/validation-plugins.idmap \
 	../workbench/metadata/views.idmap

@@ -570,6 +575,7 @@
 	images/published/wb-options.png \
 	images/published/wb-reporting.png \
 	images/published/wb-reverse-engineer-error.png \
+	images/published/wb-roles.png \
 	images/published/wb-sakila-eer.png \
 	images/published/wb-sakila-tutorial.png \
 	images/published/wb-schema-privileges.png \

@@ -616,6 +622,7 @@
 	images/published/wb-options.png \
 	images/published/wb-reporting.png \
 	images/published/wb-reverse-engineer-error.png \
+	images/published/wb-roles.png \
 	images/published/wb-sakila-eer.png \
 	images/published/wb-sakila-tutorial.png \
 	images/published/wb-schema-privileges.png \

@@ -633,7 +640,9 @@
 	../workbench/metadata/foreign-key-relationships.idmap \
 	../workbench/metadata/forward-engineering.idmap \
 	../workbench/metadata/grt-shell.idmap \
+	../workbench/metadata/images.idmap \
 	../workbench/metadata/installing.idmap \
+	../workbench/metadata/layers.idmap \
 	../workbench/metadata/notes.idmap \
 	../workbench/metadata/plugins.idmap \
 	../workbench/metadata/printing.idmap \

@@ -642,6 +651,7 @@
 	../workbench/metadata/server-connection-wizard.idmap \
 	../workbench/metadata/stored-procedures.idmap \
 	../workbench/metadata/tables.idmap \
+	../workbench/metadata/text-objects.idmap \
 	../workbench/metadata/tutorial.idmap \
 	../workbench/metadata/validation-plugins.idmap \
 	../workbench/metadata/views.idmap


Added: trunk/workbench/images/published/wb-roles.png
===================================================================


Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 321 bytes


Modified: trunk/workbench/installing.xml
===================================================================
--- trunk/workbench/installing.xml	2008-02-27 21:52:27 UTC (rev 10050)
+++ trunk/workbench/installing.xml	2008-02-27 22:12:53 UTC (rev 10051)
Changed blocks: 6, Lines Added: 45, Lines Deleted: 45; 5810 bytes

@@ -40,16 +40,19 @@
       <ulink url="http://www.opengl.org/">www.opengl.org</ulink>. The
       installation of OpenGL is beyond the scope of this document. On
       start up, the application checks the OpenGL version and selects
-      between software and hardware rendering. The GRT shell reports 
-      the active rendering method. For more information about the
-      GRT see <xref linkend="wb-grt-shell"/>.
-      <remark>Remove above?</remark>
+      between software and hardware rendering. The GRT shell reports the
+      active rendering method. For more information about the GRT see
+      <xref linkend="wb-grt-shell"/>.
+
+      <remark>
+        Remove above?
+      </remark>
     </para>
 
     <para>
       &workbench; runs on recent 32-bit Windows NT based operating
-      systems, including Windows XP, Vista, and Windows 2003. It doesn't run on
-      Windows 2000 and below.
+      systems, including Windows XP, Vista, and Windows 2003. It doesn't
+      run on Windows 2000 and below.
     </para>
 
   </section>

@@ -81,8 +84,8 @@
         and feedback of users like you. If you find that the MySQL
         Installation Wizard is lacking some feature important to you, or
         if you discover a bug, please report it in our bugs database. To
-        do this use the <guimenu>Report a Bug</guimenu> option
-        under the <guimenu>Help</guimenu> menu.
+        do this use the <guimenu>Report a Bug</guimenu> option under the
+        <guimenu>Help</guimenu> menu.
       </para>
 
       <para>

@@ -107,14 +110,15 @@
       <para>
         Unless you choose otherwise, &workbench; is installed in
        
<filename>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL
-        Workbench 5.0 OSS\</filename>, where
+        Workbench 5.0
+        <replaceable>edition_type</replaceable>\</filename>, where
         <replaceable>%PROGRAMFILES%</replaceable> is the default
         directory for programs for your locale. The
         <literal>%PROGRAMFILES%</literal>directory may be
         <filename>C:\Program Files</filename> or
         <filename>C:\programme</filename>.
       </para>
-     
+
     </section>
 
     <section id="wb-installation-zip">

@@ -137,27 +141,27 @@
       </para>
 
     </section>
-    
+
     <section id="wb-windows-running">
-      
-      <title>Running &workbench;</title>      
-      
+
+      <title>Running &workbench;</title>
+
       <para>
         Installing &workbench; using the Windows installer automatically
-        creates two entries in the <guimenu>Start</guimenu> menu
-        under <guimenu>MySQL</guimenu>. If your graphic card
-        does not support OpenGL 1.5 select the <literal>Software
-        Rendering</literal> menu entry.
+        creates two entries in the <guimenu>Start</guimenu> menu under
+        <guimenu>MySQL</guimenu>. If your graphic card does not support
+        OpenGL 1.5 select the <literal>Software Rendering</literal> menu
+        entry.
       </para>
-      
+
       <para>
-        You may also start &workbench; from the command line.
-        To view the available command line options,
-        issue the command <command>MySQLWorkbench -help | more</command>
-        from the &workbench; installation directory. You should see the
-        following output:
+        You may also start &workbench; from the command line. To view
+        the available command line options, issue the command
+        <command>MySQLWorkbench -help | more</command> from the
+        &workbench; installation directory. You should see the following
+        output:
       </para>
-      
+
 <programlisting>
   MySQL Workbench 5.0.14 SE Beta. (C) 2006-2008 by MySQL AB. All rights reserved.
   

@@ -172,33 +176,30 @@
   -swrendering .... Force the canvas to use software rendering instead of OpenGL
   -log ............ Instruction to save messages (other debug info) to file  
 </programlisting>
-      
+
       <para>
-        The &workbench; version number is displayed followed by 
-        a usage message and then the options. Use the
-        <option>-swrendering</option> option if your video
-        card does not support OpenGL 1.5. The <option>-version</option>
-        option can be used to display the &workbench; version number
-        or, optionally, the GRT shell version number. The other
-        options are self-explanatory.
+        The &workbench; version number is displayed followed by a usage
+        message and then the options. Use the
+        <option>-swrendering</option> option if your video card does not
+        support OpenGL 1.5. The <option>-version</option> option can be
+        used to display the &workbench; version number or, optionally,
+        the GRT shell version number. The other options are
+        self-explanatory.
       </para>
-      
+
       <para>
-        When using command line options that
-        display output to a console window, namely
-        <option>-help</option> and <option>-version</option>,
-        be sure that you pipe the output 
-        through the <command>more</command> command
-        otherwise nothing will be displayed.
+        When using command line options that display output to a console
+        window, namely <option>-help</option> and
+        <option>-version</option>, be sure that you pipe the output
+        through the <command>more</command> command otherwise nothing
+        will be displayed.
       </para>
-      
-      
-      
+
     </section>
 
   </section>
 
-  <!--section id="wb-installing-unix">
+<!--section id="wb-installing-unix">
 
     <title>Installing &workbench; on Unix</title>
 

@@ -242,6 +243,5 @@
     </note>
 
   </section-->
-  
 
 </chapter>


Modified: trunk/workbench/news-workbench-core.xml
===================================================================
--- trunk/workbench/news-workbench-core.xml	2008-02-27 21:52:27 UTC (rev 10050)
+++ trunk/workbench/news-workbench-core.xml	2008-02-27 22:12:53 UTC (rev 10051)
Changed blocks: 1, Lines Added: 8, Lines Deleted: 16; 1216 bytes

@@ -19,29 +19,21 @@
     
     <remark role="dynamic-dependency-list"/> 
     
-    <para>
-      This section documents all changes and bug fixes that have been
-      applied since the release of 5.0.13beta.
-    </para>
+    
+    <section id="wb-news-5-0-15">
       
+      <title condition="dynamic:changelog:vertitle"
role="5.0.15beta:workbench:all"/>
+      
+      <para condition="dynamic:changelog:entrylist"
role="5.0.15beta:workbench:all"/>
+      
+    </section>
+      
     <section id="wb-news-5-0-14">
 
       <title condition="dynamic:changelog:vertitle"
role="5.0.14beta:workbench:all"/>
 
       <para condition="dynamic:changelog:entrylist"
role="5.0.14beta:workbench:all"/>
       
- <!--     
-      <section id="wb-improvements-1.2">
-        
-        <title>Improvements</title>
-      
-              
-        <para>
-         <remark>Add improvements as a custom file?</remark>
-        </para>
-        
-      </section>
--->
     </section>
 
 


Modified: trunk/workbench/reference.xml
===================================================================
--- trunk/workbench/reference.xml	2008-02-27 21:52:27 UTC (rev 10050)
+++ trunk/workbench/reference.xml	2008-02-27 22:12:53 UTC (rev 10051)
Changed blocks: 20, Lines Added: 73, Lines Deleted: 29; 9774 bytes

@@ -1724,6 +1724,7 @@
             <listitem>
               <para>
                 Note Figure Text
+                <remark>[PL]Is this the final name?</remark>
               </para>
             </listitem>
 

@@ -1765,6 +1766,12 @@
 
           </itemizedlist>
         </para>
+        
+        <para>
+          Choose from the drop down list of fonts and font sizes.
+          You may also check the <literal>Bold</literal> and
+          <literal>Italic</literal> check boxes.
+        </para>
 
       </section>
 

@@ -2094,6 +2101,12 @@
               <guimenu>Learn How To Code For Workbench</guimenu>
             </para>
           </listitem>
+          
+          <listitem>
+            <para>
+              <guimenu>Discuss Workbench Topics</guimenu>
+            </para>
+          </listitem>
 
           <listitem>
             <para>

@@ -2158,7 +2171,7 @@
 
           <listitem>
             <para>
-              <guimenu>System Information</guimenu> &ndash; information
+              <guimenu>System Info</guimenu> &ndash; information
               about your system, useful when reporting a big.
             </para>
           </listitem>

@@ -2417,6 +2430,11 @@
         <literal>Physical Schemata</literal> panel. To remove a schema,
         click its tab and use the <guibutton>-</guibutton> button found
         to the immediate left of the <guibutton>+</guibutton> button.
+        To the left of these buttons are three buttons that control
+        way database object icons are displayed. The left-most button
+        displays database objects as large icons, the next button to the right
+        displays small icons in multiple rows, and the last button 
+        displays small icons in a single list.
       </para>
 
       <para>

@@ -2602,11 +2620,23 @@
         </para>
 
         <para>
-          Double clicking a role object opens the role editor docked at
-          the bottom of the screen. All roles that have been defined are
+           All roles that have been defined are
           listed under <literal>Roles</literal> on the left side of the
-          role editor.
+          role editor. Double clicking a role object opens the role editor docked at
+          the bottom of the screen.
         </para>
+        
+        <figure>
+          <title>Role editor</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="images/published/wb-roles.png" lang="en"
format="PNG"/>
+            </imageobject>
+            <textobject>
+              <phrase lang="en">Role editor</phrase>
+            </textobject>
+          </mediaobject>
+        </figure>
 
         <para>
           Select the role that you wish to add objects to. You may drag

@@ -2637,7 +2667,8 @@
         </para>
 
         <para>
-          Set the user's name using the <guilabel>Name</guilabel> text
+          In the <literal>User Editor</literal>, set the user's
+          name using the <guilabel>Name</guilabel> text
           box and set the password using the
           <guilabel>Password</guilabel> text box. Assign one role or a
           number of roles to the user by selecting the desired roles

@@ -2734,6 +2765,11 @@
         key associated with the tool. Mousing over a tool displays a
         description of the tool and its shortcut key.
       </para>
+      
+      <para>
+        A more detailed description of each of these tools
+        follows.
+      </para>
 
       <section id="wb-standard-mouse-pointer">
 

@@ -2769,7 +2805,7 @@
           <literal>Model Navigator</literal> panel on the upper right.
           If the <literal>Model Navigator</literal> panel is not open,
           use the <guimenu>View</guimenu>,
<guimenu>Windows</guimenu>,
-          <guimenu>Model Navigator</guimenu> to open this panel.
+          <guimenu>Model Navigator</guimenu> to open it.
         </para>
 
         <para>

@@ -2806,7 +2842,7 @@
             The delete action of the <literal>eraser</literal> tool is
             controlled by the general option setting for deletion. Be
             sure that you understand the available options described in
-            <xref linkend="wb-options-general"/>. before using the
+            <xref linkend="wb-options-general"/> before using the
             eraser tool
           </para>
         </note>

@@ -2836,7 +2872,7 @@
         </para>
 
         <para>
-          The layer tool is used to organize the objects on the EER
+          The layer tool is used to organize the objects on an EER
           Diagram canvas. It is useful for grouping together similar
           objects. You may, for instance, want to group all your views
           together.

@@ -2850,9 +2886,10 @@
         </para>
 
         <para>
-          To change the size of a layer, mouse over the lower left
-          corner of a layer and hold down the left button to adjust the
-          size of the layer.
+          To change the size of a layer, first select it by clicking on it.
+           When a layer is selected small rectangles appear at each corner
+           and in the middle of each side. Adjust the size by dragging
+           any one of these rectangles.
         </para>
 
         <para>

@@ -2864,43 +2901,42 @@
 
         <para>
           From the keyboard, use the <keycap>L</keycap> key to activate
-          this tool.
+          this tool. For more information about layers see <xref
+            linkend="wb-layers"/>.
         </para>
 
       </section>
 
       <section id="wb-note-tool">
 
-        <title>The Note Tool</title>
+        <title>The Text Tool</title>
 
         <para>
-          The note tool is the square icon with a capital
+          The text tool is the square icon with a capital
           <literal>N</literal> in the top left corner. Use this tool to
-          place notes on the EER diagram canvas. Click the tool and then
-          click the desired location on the canvas. Once a note has been
+          place text objects on the EER diagram canvas. Click the tool and then
+          click the desired location on the canvas. Once a text object has been
           dropped on the canvas, the mouse pointer reverts to its
           default.
+          <remark>[PL]Still awaiting confirmation of the name of this
object.</remark>
         </para>
 
         <para>
-          To write text in a note, right click the note and choose
+          To add text to a text object, right click the text object and choose
           either of the pop-up menu options, <guimenu>Edit Note
           ...</guimenu> or <guimenu>Edit in New Window ...</guimenu>.
-
-          <remark>
-            Bug to be fixed before more description
-          </remark>
         </para>
 
         <para>
-          You can manipulate the properties of a note by selection it
+          You can manipulate the properties of a text object by selecting it
           and then changing its properties in the
           <literal>Properties</literal> panel.
         </para>
 
         <para>
           From the keyboard, use the <keycap>N</keycap> key to activate
-          this tool.
+          this tool. For more information about text objects see
+          <xref linkend="wb-text-objects"/>.
         </para>
 
       </section>

@@ -2917,7 +2953,8 @@
 
         <para>
           From the keyboard, use the <keycap>I</keycap> key to activate
-          this tool.
+          this tool. For more information about images see <xref
+            linkend="wb-images"/>.
         </para>
 
       </section>

@@ -2990,7 +3027,7 @@
         </para>
 
         <para>
-          After selecting this tool, clicking in the canvas creates a
+          After selecting this tool, clicking on the canvas creates a
           new view. To edit this view, right click it and choose
           <guimenu>Edit View</guimenu> or <guimenu>Edit in New Window
           ...</guimenu>from the pop-up menu.

@@ -3029,7 +3066,7 @@
           After selecting this tool, clicking in the canvas creates a
           new group. To edit this view, right click it and choose
           <guimenu>Edit Routine Group</guimenu> or <guimenu>Edit in New
-          Window ...</guimenu>from the pop-up menu.
+          Window ...</guimenu> from the pop-up menu.
         </para>
 
         <para>

@@ -3085,6 +3122,9 @@
             </listitem>
 
           </itemizedlist>
+          
+          These tools appear at the bottom of the vertical tool bar. Mouse over
+          each tool to see a text hint that describes its function.
         </para>
 
         <para>

@@ -3148,6 +3188,7 @@
       Navigator</literal> palette choose the <guimenu>View</guimenu>,
       <guimenu>Windows</guimenu> menu options and then <guimenu>Model
       Navigator</guimenu>.
+      <remark>[PL]Still awaiting confirmation re docking behaviour</remark>
     </para>
 
   </section>

@@ -3225,8 +3266,9 @@
       </para>
 
       <para>
-        Clicking the name of an object in this palette allows you to
-        change the name of a layer.
+        Selecting an object in the <literal>Layers</literal>
+        palette also adjusts the view port to the area
+        of the canvas where the object is located.
       </para>
 
     </section>

@@ -3266,7 +3308,9 @@
               object. The color of the object is displayed here as is
               its hexadecimal value. Change the color of the object by
               changing this value. Only characters that are legal for
-              hexadecimal values may be entered.
+              hexadecimal values may be entered. You can also
+              change the color by clicking the <guibutton>...</guibutton>
+              button. This opens a color changer dialog box.
             </para>
           </listitem>