List:Commits« Previous MessageNext Message »
From:anthony.bedford Date:November 20 2009 1:27pm
Subject:svn commit - mysqldoc@docsrva: r17741 - trunk/workbench
View as plain text  
Author: tbedford
Date: 2009-11-20 14:27:47 +0100 (Fri, 20 Nov 2009)
New Revision: 17741

Log:
Further restructuring.

Modified:
   trunk/workbench/installing.xml


Modified: trunk/workbench/installing.xml
===================================================================
--- trunk/workbench/installing.xml	2009-11-20 13:15:32 UTC (rev 17740)
+++ trunk/workbench/installing.xml	2009-11-20 13:27:47 UTC (rev 17741)
Changed blocks: 4, Lines Added: 165, Lines Deleted: 173; 15913 bytes

@@ -163,128 +163,123 @@
       supported platforms is described in the following sections.
     </para>
 
-    <section id="wb-starting-windows">
+    <section id="wb-installing-windows">
 
-      <title>Starting &workbench; on Windows</title>
+      <title>Installing &workbench; on Windows</title>
 
-      <section id="wb-installing-windows">
+      <para>
+        &workbench; may be installed using the Windows installer file or
+        it may be installed manually from a ZIP file.
+      </para>
 
-        <title>Installing &workbench; on Windows</title>
+      <para>
+        <emphasis role="bold">Installing &workbench; Using the
+        Installer</emphasis>
+      </para>
 
-        <para>
-          &workbench; may be installed using the Windows installer file
-          or it may be installed manually from a ZIP file.
-        </para>
+      <para>
+        &workbench; can be installed using the Windows Installer
+        (<literal>.msi</literal>) installation package. The MSI package
+        bears the name
+        <literal>mysql-workbench-<replaceable>version</replaceable>-win32.msi</literal>,
+        where <replaceable>version</replaceable> indicates the
+        &workbench; version number.
+      </para>
 
+      <important>
         <para>
-          <emphasis role="bold">Installing &workbench; Using the
-          Installer</emphasis>
+          Installing &workbench; using the installer requires either
+          Administrator or Power User privileges. If you are using the
+          ZIP file without an installer, you do not need Administrator
+          or Power User privileges.
         </para>
+      </important>
 
-        <para>
-          &workbench; can be installed using the Windows Installer
-          (<literal>.msi</literal>) installation package. The MSI
-          package bears the name
-          <literal>mysql-workbench-<replaceable>version</replaceable>-win32.msi</literal>,
-          where <replaceable>version</replaceable> indicates the
-          &workbench; version number.
-        </para>
+      <para>
+        Improving the MySQL Installation Wizard depends on the support
+        and feedback of users. 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.
+      </para>
 
-        <important>
+      <orderedlist>
+
+        <listitem>
           <para>
-            Installing &workbench; using the installer requires either
-            Administrator or Power User privileges. If you are using the
-            ZIP file without an installer, you do not need Administrator
-            or Power User privileges.
+            To install &workbench;, right click on the MSI file and
+            select the <guimenu>Install</guimenu> option from the pop-up
+            menu, or simply double-click the file.
           </para>
-        </important>
+        </listitem>
 
-        <para>
-          Improving the MySQL Installation Wizard depends on the support
-          and feedback of users. 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.
-        </para>
+        <listitem>
+          <para>
+            In the <guilabel>Setup Type</guilabel> window you may choose
+            a <option>Complete</option> or <option>Custom</option>
+            installation. To use all features of &workbench; choose the
+            <option>Complete</option> option.
+          </para>
+        </listitem>
 
-        <orderedlist>
+        <listitem>
+          <para>
+            Unless you choose otherwise, &workbench; is installed in
+            <filename>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL
+            Workbench 5.1
+            <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>
+        </listitem>
 
-          <listitem>
-            <para>
-              To install &workbench;, right click on the MSI file and
-              select the <guimenu>Install</guimenu> option from the
-              pop-up menu, or simply double-click the file.
-            </para>
-          </listitem>
+      </orderedlist>
 
-          <listitem>
-            <para>
-              In the <guilabel>Setup Type</guilabel> window you may
-              choose a <option>Complete</option> or
-              <option>Custom</option> installation. To use all features
-              of &workbench; choose the <option>Complete</option>
-              option.
-            </para>
-          </listitem>
+      <para>
+        <emphasis role="bold">Installing from the ZIP File</emphasis>
+      </para>
 
-          <listitem>
-            <para>
-              Unless you choose otherwise, &workbench; is installed in
-              <filename>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL
-              Workbench 5.1
-              <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>
-          </listitem>
+      <para>
+        If you are having problems running the installer, as an
+        alternative, you can download a ZIP file without an installer.
+        That file is called
+        <literal>mysql-workbench-<replaceable>version</replaceable>-win32.zip</literal>.
+        Using a ZIP utility, unpack it to the directory of your choice.
+        You may also want to create a shortcut on your desktop or the
+        quick launch bar.
+      </para>
 
-        </orderedlist>
+      <para>
+        To install using the ZIP file, download the ZIP file to a
+        convenient location and decompress the file. You can place the
+        resulting directory anywhere on you system. You do not need to
+        install or configure the application before using it.
+      </para>
 
-        <para>
-          <emphasis role="bold">Installing from the ZIP File</emphasis>
-        </para>
+    </section>
 
-        <para>
-          If you are having problems running the installer, as an
-          alternative, you can download a ZIP file without an installer.
-          That file is called
-          <literal>mysql-workbench-<replaceable>version</replaceable>-win32.zip</literal>.
-          Using a ZIP utility, unpack it to the directory of your
-          choice. You may also want to create a shortcut on your desktop
-          or the quick launch bar.
-        </para>
+    <section id="wb-launching-windows">
 
-        <para>
-          To install using the ZIP file, download the ZIP file to a
-          convenient location and decompress the file. You can place the
-          resulting directory anywhere on you system. You do not need to
-          install or configure the application before using it.
-        </para>
+      <title>Launching &workbench; on Windows</title>
 
-      </section>
+      <para>
+        To start &workbench; on Windows select <guimenu>Start</guimenu>,
+        <guimenu>Programs</guimenu>, <guimenu>MySQL</guimenu> and then
+        select &workbench;.
+      </para>
 
-      <section id="wb-launching-windows">
+      <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 will see the following
+        output:
+      </para>
 
-        <title>&workbench; Launching on Windows</title>
-
-        <para>
-          To start &workbench; on Windows select
-          <guimenu>Start</guimenu>, <guimenu>Programs</guimenu>,
-          <guimenu>MySQL</guimenu> and then select &workbench;.
-        </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 will see the following
-          output:
-        </para>
-
 <programlisting>MySQL Workbench 5.1.12 OSS. (C) 2006-2009 by Sun Microsystems.
 All rights reserved.
 

@@ -300,101 +295,98 @@
   -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. The
-          <option>-grtversion</option> can be used to display the GRT
-          shell version number. The other options are self-explanatory.
-        </para>
+      <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. The
+        <option>-grtversion</option> can be used to display the GRT
+        shell version number. The other options are self-explanatory.
+      </para>
 
-        <note>
-          <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.
-          </para>
-        </note>
-
-      </section>
-
-      <section id="wb-windows-uninstalling">
-
-        <title>Uninstalling &workbench; on Windows</title>
-
+      <note>
         <para>
-          The method for uninstalling &workbench; will depend on how you
-          install &workbench; in the first place.
+          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>
+      </note>
 
-        <para>
-          <emphasis role="bold">Rmoving &workbench; when installed Using
-          the Installer</emphasis>
-        </para>
+    </section>
 
-        <orderedlist>
+    <section id="wb-windows-uninstalling">
 
-          <listitem>
-            <para>
-              To uninstall &workbench;, open the <guilabel>Control
-              Panel</guilabel> and Choose <guilabel>Add or Remove
-              Programs</guilabel>. Find the &workbench; entry and choose
-              the <guibutton>Remove</guibutton> button. Doing this will
-              remove &workbench;.
-            </para>
-          </listitem>
+      <title>Uninstalling &workbench; on Windows</title>
 
-          <listitem>
-            <para>
-              Any modules added to the <filename>C:\Program
-              Files\MySQL\MySQL Workbench
-              <replaceable>version</replaceable>\modules</filename>
-              directory will <emphasis role="bold">not</emphasis> be
-              deleted.
-            </para>
-          </listitem>
+      <para>
+        The method for uninstalling &workbench; will depend on how you
+        install &workbench; in the first place.
+      </para>
 
-        </orderedlist>
+      <para>
+        <emphasis role="bold">Rmoving &workbench; when installed Using
+        the Installer</emphasis>
+      </para>
 
-        <note>
+      <orderedlist>
+
+        <listitem>
           <para>
-            It is not possible to remove &workbench; from the command
-            line if you have installed &workbench; using the installer.
-            Although you can manually remove some of the compoentns
-            There is no command-line option for removing &workbench;.
+            To uninstall &workbench;, open the <guilabel>Control
+            Panel</guilabel> and Choose <guilabel>Add or Remove
+            Programs</guilabel>. Find the &workbench; entry and choose
+            the <guibutton>Remove</guibutton> button. Doing this will
+            remove &workbench;.
           </para>
+        </listitem>
 
+        <listitem>
           <para>
-            Removing the &workbench; directory manually will not remove
-            all the files belonging to &workbench;.
+            Any modules added to the <filename>C:\Program
+            Files\MySQL\MySQL Workbench
+            <replaceable>version</replaceable>\modules</filename>
+            directory will <emphasis role="bold">not</emphasis> be
+            deleted.
           </para>
-        </note>
+        </listitem>
 
+      </orderedlist>
+
+      <note>
         <para>
-          <emphasis role="bold">When installed from a ZIP
-          file</emphasis>
+          It is not possible to remove &workbench; from the command line
+          if you have installed &workbench; using the installer.
+          Although you can manually remove some of the compoentns There
+          is no command-line option for removing &workbench;.
         </para>
 
         <para>
-          If you installed &workbench; using a ZIP file, to remove
-          &workbench; you can just delete the &workbench; directory.
+          Removing the &workbench; directory manually will not remove
+          all the files belonging to &workbench;.
         </para>
+      </note>
 
-        <note>
-          <para>
-            If you installed any additional modules within the
-            <filename>modules</filename> directory and you want to keep
-            them, make sure you copy those modules to a different
-            directory before deleting the &workbench; directory.
-          </para>
-        </note>
+      <para>
+        <emphasis role="bold">When installed from a ZIP file</emphasis>
+      </para>
 
-      </section>
+      <para>
+        If you installed &workbench; using a ZIP file, to remove
+        &workbench; you can just delete the &workbench; directory.
+      </para>
 
+      <note>
+        <para>
+          If you installed any additional modules within the
+          <filename>modules</filename> directory and you want to keep
+          them, make sure you copy those modules to a different
+          directory before deleting the &workbench; directory.
+        </para>
+      </note>
+
     </section>
 
     <section id="wb-installing-linux">

@@ -498,7 +490,7 @@
 
     <section id="wb-launching-linux">
 
-      <title>&workbench; Launching on Linux</title>
+      <title>Launching &workbench; on Linux</title>
 
       <para>
         Once &workbench; has been installed it can be launched by

@@ -612,7 +604,7 @@
 
     <section id="wb-launching-osx">
 
-      <title>&workbench; Launching on Mac OS X</title>
+      <title>Launching &workbench; on Mac OS X</title>
 
       <para>
         To launch &workbench; on Mac OS X, simply open the Applications


Thread
svn commit - mysqldoc@docsrva: r17741 - trunk/workbenchanthony.bedford20 Nov