Author: mhillyer
Date: 2006-02-01 23:28:24 +0100 (Wed, 01 Feb 2006)
New Revision: 1174
Log:
Update several screenshots, fix outdated information in first four sections of Query Browser doc.
Modified:
trunk/gui-common/images/options-connection.png
trunk/query-browser/chapter-options-query-browser.xml
trunk/query-browser/images/connection.png
trunk/query-browser/images/mainscreen.png
trunk/query-browser/images/qb-options.png
trunk/query-browser/query-browser.xml
Modified: trunk/gui-common/images/options-connection.png
===================================================================
(Binary files differ)
Modified: trunk/query-browser/chapter-options-query-browser.xml
===================================================================
--- trunk/query-browser/chapter-options-query-browser.xml 2006-02-01 20:54:25 UTC (rev 1173)
+++ trunk/query-browser/chapter-options-query-browser.xml 2006-02-01 22:28:24 UTC (rev 1174)
@@ -37,33 +37,52 @@
The display options affect the appearance of the &query_browser;.
</para>
- <para>
- <literal>Show advanced toolbars</literal> turns on and off the
- display of the
- <link linkend="mysql-query-browser-tour-buttonbar">The Advanced
- Toolbar</link>.
- </para>
+ <itemizedlist>
- <para>
- <literal>Hide the tab when only one tab is open</literal>
- determines whether or not to display a tab icon at the top of the
- <link linkend="mysql-query-browser-tour-resultarea">Result
- Area</link> if there is only one active result area.
- </para>
+ <listitem>
+ <para>
+ <literal>Show advanced toolbars</literal> turns on and off the
+ display of the
+ <link linkend="mysql-query-browser-tour-buttonbar">The
+ Advanced Toolbar</link>.
+ </para>
+ </listitem>
- <para>
- <literal>Toolbars use gradient background</literal> enables and
- disables use of gradient effects in the background of the
- <link linkend="mysql-query-browser-tour-querybar">Query
- Toolbar</link>.
- </para>
+ <listitem>
+ <para>
+ <literal>Hide the tab when only one tab is open</literal>
+ determines whether or not to display a tab icon at the top of
+ the <link linkend="mysql-query-browser-tour-resultarea">Result
+ Area</link> if there is only one active result area.
+ </para>
+ </listitem>
- <para>
- <literal>Show field overlay images for long VARCHAR, TEXT, and
- BLOG fields</literal> toggles on and off the BLOB management
- icons.
- </para>
+ <listitem>
+ <para>
+ <literal>Toolbars use gradient background</literal> enables
+ and disables use of gradient effects in the background of the
+ <link linkend="mysql-query-browser-tour-querybar">Query
+ Toolbar</link>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>Show field overlay images for long VARCHAR, TEXT, and
+ BLOG fields</literal> toggles on and off the BLOB management
+ icons.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Show composer buttons toolbar</literal> toggles on
+ and off the query composition buttons on the Advanced Toolbar.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
</sect2>
<!-- END DISPLAY OPTIONS -->
Modified: trunk/query-browser/images/connection.png
===================================================================
(Binary files differ)
Modified: trunk/query-browser/images/mainscreen.png
===================================================================
(Binary files differ)
Modified: trunk/query-browser/images/qb-options.png
===================================================================
(Binary files differ)
Modified: trunk/query-browser/query-browser.xml
===================================================================
--- trunk/query-browser/query-browser.xml 2006-02-01 20:54:25 UTC (rev 1173)
+++ trunk/query-browser/query-browser.xml 2006-02-01 22:28:24 UTC (rev 1174)
@@ -119,12 +119,12 @@
url="http://bugs.mysql.com">MySQL Bug System</ulink> to
request features or report problems.
</para>
-
+
<para>
For MySQL Query Browser, there's a dedicated forum available on
<ulink url="http://forums.mysql.com/list.php?108"/>.
</para>
-
+
</chapter>
<!-- END INTRODUCTION -->
@@ -155,15 +155,15 @@
<para>
&query_browser; runs on recent 32-bit Windows NT based operating
- systems, including Windows 2000, XP, and 2003. It doesn't run on
- Windows NT 4 and below.
+ systems, including Windows 2000, XP, and 2003. It is not
+ supported on any previous versions of Windows.
</para>
<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
- contained within an archive named
+ named
<literal>mysql-query-browser-<replaceable>version</replaceable>-win.msi</literal>,
where <replaceable>version</replaceable> indicates the
&query_browser; version.
@@ -229,7 +229,7 @@
tarball. The tarball file is called
<literal>mysql-query-browser-<replaceable>version</replaceable>-linux.tar.gz</literal>,
where <replaceable>version</replaceable> indicates the
- &query_browser; version (for example 1.0.5-alpha).
+ &query_browser; version.
</para>
<para>
@@ -260,8 +260,13 @@
</para>
<para>
- Distribution-specific packages are available for Redhat Linux 9
- (x86) and Suse Linux 9.1 (x86).
+ RPM packages are available for generic Linux systems and SUSE
+ Linux. When installed via RPM, the
+ <filename>mysql-query-browser</filename> executable is installed
+ by default to <filename>/usr/bin</filename>, with supporting
+ files found in <filename>/usr/share/applications</filename>,
+ <filename>/usr/share/locale</filename> and
+ <filename>/usr/share/mysql-gui</filename>.
</para>
</sect1>
@@ -283,52 +288,53 @@
<para>
The way you start &query_browser; depends on the operating
system you are using:
+ </para>
- <itemizedlist>
+ <itemizedlist>
- <listitem>
- <para>
- On Windows, start &query_browser; by double-clicking its
- desktop icon, or by selecting its entry from the
- <literal>Start</literal> menu (typically the
- <guimenu>&query_browser;</guimenu> entry of the
- <guimenu>MySQL</guimenu> section of the
- <literal>Start</literal> menu). Alternatively, you can
- open a DOS window and start the &query_browser; from the
- command line:
+ <listitem>
+ <para>
+ On Windows, start &query_browser; by double-clicking its
+ desktop icon, or by selecting its entry from the
+ <literal>Start</literal> menu (typically the
+ <guimenu>&query_browser;</guimenu> entry of the
+ <guimenu>MySQL</guimenu> section of the
+ <literal>Start</literal> menu). Alternatively, you can open
+ a DOS window and start the &query_browser; from the command
+ line:
<programlisting>
C:\<replaceable>%PROGRAMFILES%</replaceable>\MySQL\MySQL Query Browser 1.1\MySQLQueryBrowser.exe
</programlisting>
- <replaceable>%PROGRAMFILES%</replaceable> is the default
- directory for programs on your machine. For example,
- <literal>C:\Program Files</literal> or
- <literal>C:\programme</literal>. If your path contains
- spaces, you should enclose the command within double
- quotes. For example:
+ <replaceable>%PROGRAMFILES%</replaceable> is the default
+ directory for programs on your machine. For example,
+ <literal>C:\Program Files</literal> or
+ <literal>C:\programme</literal>. If your path contains
+ spaces, you should enclose the command within double quotes.
+ For example:
<programlisting>
C:\> "C:\program files\MySQL\GUITools\MySQLQueryBrowser.exe"
</programlisting>
- </para>
- </listitem>
+ </para>
+ </listitem>
- <listitem>
- <para>
- On Linux desktops, start &query_browser; by changing
- directories into
- <literal>/opt/mysql-query-browser/bin</literal>, and then
- executing <literal>mysql-query-browser</literal>.
- </para>
- </listitem>
+ <listitem>
+ <para>
+ On Linux desktops, start &query_browser; by changing
+ directories into
+ <filename>/opt/mysql-query-browser/bin</filename> or
+ <filename>/usr/bin</filename>, and then executing
+ <literal>mysql-query-browser</literal>.
+ </para>
+ </listitem>
<!-- ADD STARTING PROCEDURE FOR MAC OS -->
- </itemizedlist>
- </para>
+ </itemizedlist>
</sect1>
@@ -383,6 +389,40 @@
</para>
<para>
+ To set advanced connection options, click the
+ <guibutton>Details</guibutton> button and check the desired
+ options:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>Use compression protocol</literal> - Use
+ compression when communicating with the MySQL server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Use SSL if available</literal> - Encrypt
+ communications with the MySQL server using SSL. This option
+ only applies if the MySQL client library on your client
+ machine has SSL enabled.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>Use ANSI quotes to quote identifiers</literal> -
+ enclose all object names in double-quotes instead of
+ back-ticks.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
If you have difficulties connecting, please see the
<link linkend="mysql-gui-appendix-troubleshooting-connection-errors">Troubleshooting
Connection Errors</link> section in the
@@ -443,10 +483,6 @@
</figure>
<para>
- <remark>
- [MH] OUTDATED FIGURE AS OF QB 1.0.8.5
- </remark>
-
The main query window is divided up into several sections:
<itemizedlist>
@@ -476,6 +512,15 @@
<guibutton>From</guibutton>, <guibutton>Where</guibutton>,
and so on.)
</para>
+
+ <para>
+ The Advanced Toolbar is only visible as illustrated when
+ the <literal>Show advanced toolbars</literal> and
+ <literal>Show composer buttons toolbar</literal> options
+ in the Browser Options screen are checked. See
+ <xref
+ linkend="gui-options-query-browser"/>.
+ </para>
</listitem>
<listitem>
@@ -796,8 +841,8 @@
<para>
Individual tabs can closed by either right-clicking within the
result area and choosing the <guimenu>Remove Tab</guimenu>
- option, or by clicking the <literal>X</literal> icon on the
- tab you wish to close.
+ option, or by clicking the <literal>X</literal> icon on the tab
+ you wish to close.
</para>
<para>
@@ -899,9 +944,9 @@
To view a database's tables, stored procedures, and views,
click the black arrow on the left of the database name. You
can view a table's columns by clicking on the black arrow to
- the left of the table name. Columns that form part of a primary key
- have a small key icon to the left of their name, otherwise
- they have a blue diamond icon.
+ the left of the table name. Columns that form part of a
+ primary key have a small key icon to the left of their name,
+ otherwise they have a blue diamond icon.
</para>
<para>
@@ -1139,22 +1184,23 @@
choose the <guimenu>New Script Tab</guimenu> option from the
<guimenu>File</guimenu> menu.
</para>
-
+
<para>
- If you're experiencing problems with character sets (for example,
- Spanish accented characters, Russian, or Chinese characters aren't
- displayed properly), here's some advice:
+ If you're experiencing problems with character sets (for
+ example, Spanish accented characters, Russian, or Chinese
+ characters aren't displayed properly), here's some advice:
</para>
-
+
<para>
- <emphasis role="bold">Avoid ANSI encoding in your script files!</emphasis>
- Rather than using ANSI, always save them in <emphasis>UTF-8</emphasis> encoding.
- Watch out when loading script files generated by other tools.
- They usually save files in ANSI encoding, which in turn means
- you'll have to open them as ANSI in Query Browser (see the file
- type combo box in the file open dialog):
+ <emphasis role="bold">Avoid ANSI encoding in your script
+ files!</emphasis> Rather than using ANSI, always save them in
+ <emphasis>UTF-8</emphasis> encoding. Watch out when loading
+ script files generated by other tools. They usually save files
+ in ANSI encoding, which in turn means you'll have to open them
+ as ANSI in Query Browser (see the file type combo box in the
+ file open dialog):
</para>
-
+
<figure>
<title>The file open dialog</title>
<mediaobject>
@@ -1166,27 +1212,27 @@
</textobject>
</mediaobject>
</figure>
-
+
<para>
- However, due to limitations with ANSI, when loading such a file,
- the current system locale must be the same as the one on the
- machine where the file was written. Hence you cannot store a
- script in ANSI on a French version of Windows and expect it to
- load correctly on a Spanish version of Windows. Because of this
- and many other limitations we strongly recommend to always use
- Unicode for scripts. It doesn't matter whether you use UTF-8
- or UTF-16, since both are Unicode transformation formats and
- can be read properly by any of the MySQL GUI tools.
- Using UTF, you could even write Spanish text with Chinese
- comments on a German version of Windows.
+ However, due to limitations with ANSI, when loading such a file,
+ the current system locale must be the same as the one on the
+ machine where the file was written. Hence you cannot store a
+ script in ANSI on a French version of Windows and expect it to
+ load correctly on a Spanish version of Windows. Because of this
+ and many other limitations we strongly recommend to always use
+ Unicode for scripts. It doesn't matter whether you use UTF-8 or
+ UTF-16, since both are Unicode transformation formats and can be
+ read properly by any of the MySQL GUI tools. Using UTF, you
+ could even write Spanish text with Chinese comments on a German
+ version of Windows.
</para>
-
+
<para>
The MySQL Query Browser forum provides many contributions by
users of non-Latin1 characters sets; see
<ulink url="http://forums.mysql.com/list.php?108"/>.
</para>
-
+
<sect2 id="mysql-query-browser-tour-scripteditor-buttons">
<title>The Script Debugging Buttons</title>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1174 - in trunk: gui-common/images query-browser query-browser/images | mhillyer | 1 Feb |
