Author: mhillyer
Date: 2006-05-17 17:47:41 +0200 (Wed, 17 May 2006)
New Revision: 2109
Log:
WIP push of Install chapter of Workbench doc for GUI team review.
Added:
trunk/workbench/copyright.xml
trunk/workbench/legalnotice.en.xml
Modified:
trunk/query-browser/query-browser.xml
trunk/workbench/workbench.xml
Modified: trunk/query-browser/query-browser.xml
===================================================================
--- trunk/query-browser/query-browser.xml 2006-05-17 14:29:07 UTC (rev 2108)
+++ trunk/query-browser/query-browser.xml 2006-05-17 15:47:41 UTC (rev 2109)
@@ -119,7 +119,7 @@
<para>
&query_browser; is installed through the use of a Windows
Installer (<literal>.msi</literal>) installation package, which
- can be used on all Windows operating systems. The MSI package in
+ can be used on all Windows operating systems. The MSI package is
named
<literal>mysql-query-browser-<replaceable>version</replaceable>-win.msi</literal>,
where <replaceable>version</replaceable> indicates the
@@ -1833,9 +1833,9 @@
<listitem>
<para>
- <literal>Clear</literal>: This icon looks like an X
- within a black box and is used to clear the contents of a
- <literal>TEXT</literal> ot <literal>BLOB</literal> field.
+ <literal>Clear</literal>: This icon looks like an X within a
+ black box and is used to clear the contents of a
+ <literal>TEXT</literal> or <literal>BLOB</literal> field.
</para>
</listitem>
@@ -2022,6 +2022,16 @@
detail result sets.
</para>
+ <note>
+
+ <para>
+ You can only continue splitting a result set in the same
+ direction as the previous split. You cannot, for example,
+ split vertically and then horizontally.
+ </para>
+
+ </note>
+
</section>
<!-- END MASTER DETAIL -->
Added: trunk/workbench/copyright.xml
===================================================================
--- trunk/workbench/copyright.xml (rev 0)
+++ trunk/workbench/copyright.xml 2006-05-17 15:47:41 UTC (rev 2109)
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<para>
+ Copyright 2004-2006 MySQL AB
+</para>
Added: trunk/workbench/legalnotice.en.xml
===================================================================
--- trunk/workbench/legalnotice.en.xml (rev 0)
+++ trunk/workbench/legalnotice.en.xml 2006-05-17 15:47:41 UTC (rev 2109)
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<legalnotice>
+
+ <xi:include href="copyright.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <para>
+ This documentation is NOT distributed under a GPL license. Use of
+ this documentation is subject to the following terms: You may create
+ a printed copy of this documentation solely for your own personal
+ use. Conversion to other formats is allowed as long as the actual
+ content is not altered or edited in any way. You shall not publish
+ or distribute this documentation in any form or on any media, except
+ if you distribute the documentation in a manner similar to how MySQL
+ disseminates it (that is, electronically for download on a website
+ with the software) or on a CD-ROM or similar medium, provided
+ however that the documentation is disseminated together with the
+ software on the same medium. Any other use, such as any
+ dissemination of printed copies or use of this documentation, in
+ whole or in part, in another publication, requires the prior written
+ consent from an authorized representative of MySQL AB. MySQL AB
+ reserves any and all rights to this documentation not expressly
+ granted above.
+ </para>
+
+ <para>
+ Please email <email>docs@stripped</email> for more information or
+ if you are interested in doing a translation.
+ </para>
+
+</legalnotice>
Modified: trunk/workbench/workbench.xml
===================================================================
--- trunk/workbench/workbench.xml 2006-05-17 14:29:07 UTC (rev 2108)
+++ trunk/workbench/workbench.xml 2006-05-17 15:47:41 UTC (rev 2109)
@@ -1,113 +1,293 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
-[
- <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
- %gui-common.entities;
-]>
-<book id="mysql-workbench" lang="en">
-
-<!--
-If <indexterm> elements are added to this document sometime, add an
-empty <index/> element before the closing </book> tag to enable
-index-generation. Right now there is no such element because there
-is no point in generating an empty index.
--->
-
- <title>&workbench;</title>
-
- <bookinfo>
-
- <title>&workbench;</title>
-
- <abstract>
-
- <para>
- This is the &workbench; Manual.
- </para>
-
- <para>
- Document generated on:
-
-<?dbtimestamp format="Y-m-d"?>
-
- <remark role="repository.revision"/>
- </para>
-
- </abstract>
-
- <copyright>
-
- <year>2004-2006</year>
-
- <holder>MySQL AB</holder>
-
- </copyright>
-
- <legalnotice>
-
- <para>
- This manual is NOT distributed under a GPL style license. Use of
- the manual is subject to the following terms:
-
- <itemizedlist>
-
- <listitem>
- <para>
- Conversion to other formats is allowed, but the actual
- content may not be altered or edited in any way.
- </para>
- </listitem>
-
- <listitem>
- <para>
- You may create a printed copy for your own personal use.
- </para>
- </listitem>
-
- <listitem>
- <para>
- For all other uses, such as selling printed copies or
- using the manual in whole or in part within another publication, prior
- written agreement from MySQL AB is required.
- </para>
- </listitem>
-
- </itemizedlist>
-
- Please email <email>docs@stripped</email> for more information or if you are
- interested in doing a translation.
- </para>
-
- </legalnotice>
-
- </bookinfo>
-
- <chapter id="mysql-workbench-introduction">
-
- <title>Introduction to &workbench;</title>
-
- <para>
- &workbench; is a schema design application, allowing users to
- graphically design and modify tables and other objects, then
- create that design in MySQL automatically.
- </para>
-
- <para>
- &workbench; is designed to work with MySQL versions 4.0 and
- higher.
- </para>
-
- <para>
- &workbench; is beta software and should not be used on production
- systems. It is strongly recommended you backup all data before
- using &workbench;. If you find it's lacking some feature important to you,
- or if you discover a bug, please use our
- <ulink
-url="http://bugs.mysql.com">MySQL Bug System</ulink> to
- request features or report problems.
- </para>
-
- </chapter>
-
-</book>
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
+ %gui-common.entities;
+]>
+<book id="workbench" lang="en">
+
+<!--
+If <indexterm> elements are added to this document sometime, add an
+empty <index/> element before the closing </book> tag to enable
+index-generation. Right now there is no such element because there
+is no point in generating an empty index.
+-->
+
+ <title>&workbench;</title>
+
+ <bookinfo>
+
+ <title>&workbench;</title>
+
+ <abstract>
+
+ <para>
+ This is the &workbench; Manual.
+ </para>
+
+ <para>
+ Document generated on:
+
+<?dbtimestamp format="Y-m-d"?>
+
+ <remark role="repository.revision"/>
+ </para>
+
+ </abstract>
+
+ <xi:include href="legalnotice.en.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ </bookinfo>
+
+ <chapter id="workbench-introduction">
+
+ <title>Introduction to &workbench;</title>
+
+ <para>
+ &workbench; is a schema design application that enables users to
+ graphically design and modify tables and other database objects,
+ then automatically implement their design in MySQL.
+ </para>
+
+ <para>
+ &workbench; is designed to work with MySQL versions 4.0 and
+ higher.
+ </para>
+
+ <para>
+ &workbench; is beta software and should not be used on production
+ systems. It is strongly recommended you backup all data before
+ using &workbench;. If you find it's lacking some feature important
+ to you, or if you discover a bug, please use our
+ <ulink
+url="http://bugs.mysql.com">MySQL Bug System</ulink> to
+ request features or report problems.
+ </para>
+
+ </chapter>
+
+ <chapter id="workbench-installation">
+
+ <title>Installing MySQL Workbench</title>
+
+ <section id="workbench-installation-introduction">
+
+ <title>Introduction</title>
+
+ <para>
+ &workbench; is available for the following platforms:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Microsoft Windows</literal> - Minimum supported
+ version is Windows 2000.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Mac OS X</literal> - Universal binary. Minimum
+ supported version is Mac OS X 10.4.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Linux</literal> - System requirements are listed in
+ the <link linkend="workbench-installation-linux">Linux
+ installation</link> section that follows.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ Regardless of platform, a working <literal>OpenGL</literal>
+ installation is required. The installation of OpenGL is beyond
+ the scope of this article.
+ </para>
+
+ <para>
+ Installation files for all supported packages can be downloaded
+ from
+ <ulink
+ url="http://dev.mysql.com/downloads/workbench/1.0.html">http://dev.mysql.com/downloads/workbench/1.0.html</ulink>.
+ </para>
+
+ <para>
+ The sections that follow describe the installation process for
+ each supported platform.
+ </para>
+
+ </section>
+
+ <section id="workbench-installation-windows">
+
+ <title>Installing &workbench; on Microsoft Windows</title>
+
+ <para>
+ &workbench; runs on recent 32-bit Windows NT-based operating
+ systems, including Windows 2000, XP, and 2003. It is not
+ supported on any previous versions of Windows.
+ </para>
+
+ <para>
+ Before installing &workbench; it is recommended that you ensure
+ you are using the latest drivers for your video hardware.
+ </para>
+
+ <para>
+ &workbench; is installed through the use of a Windows Installer
+ (<literal>.msi</literal>) installation package, which can be
+ used on all Windows operating systems. The MSI package is named
+ <literal>mysql-workbench-<replaceable>version</replaceable>-win32.msi</literal>,
+ where <replaceable>version</replaceable> indicates the
+ &workbench; version and release status (i.e. version-beta for a
+ beta release).
+ </para>
+
+ <para>
+ The Windows Installer system was updated with the release of
+ Windows XP; those using an older version of Windows can
+ reference
+ <ulink url="http://support.microsoft.com/default.aspx?scid=kb;EN-US;292539">this
+ Microsoft Knowledge Base article</ulink> for information on
+ upgrading to the latest version.
+ </para>
+
+ <para>
+ To install &workbench;, right-click on the MSI file and select
+ <guimenu>Install</guimenu>. The installation will begin
+ automatically after the installer prompts you for your
+ installation preferences. During installation, you can choose
+ whether you want the installer to place a shortcut in the
+ <literal>Start</literal> menu and an icon on the desktop.
+ </para>
+
+ <para>
+ Unless you choose otherwise, &workbench; is installed in
+ <literal>C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\&workbench;
+ MySQLWorkbench.exe</literal>, where
+ <replaceable>%PROGRAMFILES%</replaceable> is the default
+ directory for programs on your machine. For example, this
+ directory might be <literal>C:\Program Files</literal> or
+ <literal>C:\programme</literal>.
+ </para>
+
+ <para>
+ If you are having problems running the installer, you can
+ download a ZIP file without an installer as an alternative. That
+ file is called
+ <literal>mysql-workbench-noinstall-<replaceable>version</replaceable>-win32.zip</literal>.
+ Using a ZIP program, unpack it to a directory of your choice.
+ You may wish to create shortcuts to
+ <literal>MySQLWorkbench.exe</literal> for your desktop or quick
+ launch bar.
+ </para>
+
+ </section>
+
+ <section id="workbench-installation-osx">
+
+ <title>Installing &workbench; on Max OS X</title>
+
+ <para>
+ The Mac OS X version of &workbench; is available as a universal
+ binary and is supported for use on Mac OS X 10.4 and higher.
+ </para>
+
+ <para>
+ To install &workbench; on Mac OS X, download the installation
+ image to your local machine. The image should be named
+ <filename>mysql-workbench-<replaceable>version</replaceable>-osx10.4-universal.dmg</filename>,
+ where <replaceable>version</replaceable> indicates the
+ &workbench; version and release status (i.e. version-beta for a
+ beta release).
+ </para>
+
+ <para>
+ After downloading the install image, open it and drag the
+ &workbench; to your <literal>Applications</literal> folder to
+ install &workbench; on your machine. After installation is
+ complete, drag the image and accompanying file to the trash
+ icon.
+ </para>
+
+ </section>
+
+ <section id="workbench-installation-linux">
+
+ <title>Installing &workbench; on Linux</title>
+
+ <para>
+ &workbench; is available for all Linux and Unix-like systems
+ that meet the following prerequisites:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>OpenGL</literal> installed and up to date.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Gnome 2.10</literal> installed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>glx</literal> installed and up to date.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ &workbench; can be installed using either an RPM installer or a
+ tarball. RPM installers are available for Red Hat Enterprise
+ Linux 4, SUSE Linux 9.3 and generic Linux systems.
+ </para>
+
+ <para>
+ To install &workbench; using an RPM installer, download the
+ appropriate RPM file, which is named
+ <filename>mysql-workbench-<replaceable>version</replaceable>.<replaceable>platform</replaceable>.rpm</filename>,
+ where <replaceable>version</replaceable> indicates the
+ &workbench; version and release status (i.e. version-beta for a
+ beta release) and <replaceable>platform</replaceable> indicates
+ the intended platform for the package (i.e. rhel4.i386 for Red
+ Hat Enterprise Linux 4 on i386 architecture). After downloading
+ the RPM package, install it using your preferred package
+ manager.
+ </para>
+
+ <para>
+ To install &workbench; using a tarball, download the tarball
+ file, which is named
+ mysql-workbench-<replaceable>version</replaceable>-<replaceable>platform</replaceable>.tar.gz,
+ where <replaceable>version</replaceable> indicates the
+ &workbench; version and release status (i.e. version-beta for a
+ beta release) and <replaceable>platform</replaceable> indicates
+ the intended platform for the package (i.e. rhel4.i386 for Red
+ Hat Enterprise Linux 4 on i386 architecture). After downloading
+ the tarball, extract it in the <filename>/opt</filename>
+ directory:
+ </para>
+
+<programlisting>
+tar --directory=/opt -xvzf mysql-workbench-<replaceable>version</replaceable>-<replaceable>platform</replaceable>.tar.gz
+</programlisting>
+
+ </section>
+
+ </chapter>
+
+</book>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2109 - in trunk: query-browser workbench | mhillyer | 17 May |
