Author: plavin
Date: 2006-08-29 23:57:00 +0200 (Tue, 29 Aug 2006)
New Revision: 3129
Log:
Started reading the Administrator docs - might as well work as I go
Modified:
trunk/administrator/Makefile
trunk/administrator/installation.xml
trunk/administrator/introduction.xml
trunk/administrator/main-window.xml
trunk/administrator/starting.xml
Modified: trunk/administrator/Makefile
===================================================================
--- trunk/administrator/Makefile 2006-08-29 20:40:11 UTC (rev 3128)
+++ trunk/administrator/Makefile 2006-08-29 21:57:00 UTC (rev 3129)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 3087 bytes
@@ -37,7 +37,7 @@
ADMINISTRATOR_SRCS_EXTRA = ../gui-common/gui-common.ent
-ADMINISTRATOR_SRCS = $(ADMINISTRATOR_SRCS_EXTRA) administrator.xml ../gui-common/appendix-common-files.xml ../gui-common/appendix-connection-storage.xml ../gui-common/appendix-source-install.xml ../gui-common/appendix-third-party.xml ../gui-common/appendix-translator-notes.xml ../gui-common/appendix-troubleshooting.xml ../gui-common/chapter-options-connections.xml ../gui-common/chapter-options-editors.xml ../gui-common/chapter-options-general.xml ../gui-common/chapter-options-introduction.xml ../gui-common/chapter-table-editor.xml ../gui-common/images/columneditor.png ../gui-common/images/confirmchanges.png ../gui-common/images/connectionerror.png ../gui-common/images/indexeditor.png ../gui-common/images/options-connection.png ../gui-common/images/options.png ../gui-common/images/tableeditor.png chapter-options-administrator.xml copyright.xml images/configure-service-mode-connection.png images/configure-service-mode-window.png images/connection.png images/graph-settings.png!
images/mainwindow.png images/marked-area.png images/replication.png images/restore-content.png images/server-logs-general-log.png images/system-tray.png images/user-accounts.png images/user-information.png legalnotice.en.xml
+ADMINISTRATOR_SRCS = $(ADMINISTRATOR_SRCS_EXTRA) administrator.xml ../gui-common/appendix-common-files.xml ../gui-common/appendix-connection-storage.xml ../gui-common/appendix-source-install.xml ../gui-common/appendix-third-party.xml ../gui-common/appendix-translator-notes.xml ../gui-common/appendix-troubleshooting.xml ../gui-common/chapter-options-connections.xml ../gui-common/chapter-options-editors.xml ../gui-common/chapter-options-general.xml ../gui-common/chapter-options-introduction.xml ../gui-common/chapter-table-editor.xml ../gui-common/images/columneditor.png ../gui-common/images/confirmchanges.png ../gui-common/images/connectionerror.png ../gui-common/images/indexeditor.png ../gui-common/images/options-connection.png ../gui-common/images/options.png ../gui-common/images/tableeditor.png backup.xml catalogs.xml chapter-options-administrator.xml copyright.xml health.xml images/configure-service-mode-connection.png images/configure-service-mode-window.png images/conne!
ction.png images/graph-settings.png images/mainwindow.png images/marked-area.png images/replication.png images/restore-content.png images/server-logs-general-log.png images/system-tray.png images/user-accounts.png images/user-information.png installation.xml introduction.xml legalnotice.en.xml main-window.xml replication-status.xml restore.xml server-connections.xml server-information.xml server-logs.xml service-control.xml starting.xml startup-variables.xml tray-monitor.xml user-administration.xml xml-files.xml
administrator-prepped.xml: $(ADMINISTRATOR_SRCS)
Modified: trunk/administrator/installation.xml
===================================================================
--- trunk/administrator/installation.xml 2006-08-29 20:40:11 UTC (rev 3128)
+++ trunk/administrator/installation.xml 2006-08-29 21:57:00 UTC (rev 3129)
Changed blocks: 5, Lines Added: 11, Lines Deleted: 11; 3436 bytes
@@ -14,7 +14,7 @@
<title>Introduction</title>
<para>
- &administrator; runs on Windows, Linux, and Mac OSX. You can
+ &administrator; runs on Windows, Linux, and Mac OS X. You can
find MySQL Administrator for the operating system of your choice
on the
<ulink url="http://dev.mysql.com/downloads/administrator/">MySQL
@@ -39,7 +39,7 @@
&administrator; is installed through the use of a Windows
Installer (<literal>.msi</literal>) installation package, which
can be used to install the &administrator; on all Windows
- operating systems. The MSI package in contained within a ZIP
+ operating systems. The MSI package is contained within a ZIP
archive named
<literal>mysql-administrator-<replaceable>version</replaceable>-win.msi</literal>,
where <replaceable>version</replaceable> indicates the
@@ -58,14 +58,14 @@
To install &administrator;, 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 if
- you want the installer to place a shortcut in the
+ installation preferences. During installation, you can choose
+ to allow the installer to place a shortcut in the
<literal>Start</literal> menu, and/or an icon on the desktop.
</para>
<para>
- If you are having problems running the installer, you can
- download a ZIP file without an installer as an alternative. That
+ 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-administrator-<replaceable>version</replaceable>-win-noinstall.zip</literal>.
Using a ZIP program, unpack it to a directory of your choice.
@@ -95,8 +95,8 @@
<para>
&administrator; runs on Linux machines that have a graphical
desktop installed. It is designed to run under the Gnome desktop
- with GTK2. It has been tested on Linux kernel versions 2.4 and
- 2.6, but it should also run on other versions, and even on a
+ with GTK2 and has been tested on Linux kernel versions 2.4 and
+ 2.6. It should also run on other versions, and even on a
number of Unix-like operating systems.
</para>
@@ -141,13 +141,13 @@
<section id="mysql-administrator-installation-osx">
- <title>Installing Under Mac OSX</title>
+ <title>Installing Under Mac OS X</title>
<para>
To install MySQL Administrator under Mac OS X, double-click the
- downloaded .dmg file and wait it to be opened and attached. Once
+ downloaded <literal>.dmg</literal> file and wait for it to be opened and attached. Once
a window containing the Administrator icon pops up, drag it to
- your Applications folder -- or any other location you prefer.
+ your Applications folder — or any other location you prefer.
</para>
<para>
Modified: trunk/administrator/introduction.xml
===================================================================
--- trunk/administrator/introduction.xml 2006-08-29 20:40:11 UTC (rev 3128)
+++ trunk/administrator/introduction.xml 2006-08-29 21:57:00 UTC (rev 3129)
Changed blocks: 3, Lines Added: 3, Lines Deleted: 3; 1123 bytes
@@ -21,7 +21,7 @@
<ulink url="http://dev.mysql.com/doc/mysql/en/mysqladmin.html"><command>mysqladmin</command>
</ulink> or
<ulink url="http://dev.mysql.com/doc/mysql/en/mysql.html"><command>mysql</command></ulink>,
- but &administrator; is advantageous in the following respects:
+ but &administrator; has the following advantages:
</para>
<itemizedlist>
@@ -55,7 +55,7 @@
</para>
<para>
- &administrator; is to a large extent the result of feedback MySQL
+ &administrator; is, to a large extent, the result of feedback MySQL
AB has received from many users over a period of several years.
However, if you find it's lacking some feature important to you,
or if you discover a bug, please use our
@@ -64,4 +64,4 @@
request features or report problems.
</para>
-</chapter>
+</chapter>
\ No newline at end of file
Modified: trunk/administrator/main-window.xml
===================================================================
--- trunk/administrator/main-window.xml 2006-08-29 20:40:11 UTC (rev 3128)
+++ trunk/administrator/main-window.xml 2006-08-29 21:57:00 UTC (rev 3129)
Changed blocks: 6, Lines Added: 11, Lines Deleted: 7; 2664 bytes
@@ -5,8 +5,10 @@
<!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
%gui-common.entities;
]>
- <chapter id="mysql-administrator-main-window">
+ <!-- Starting &administrator; -->
+ <chapter id="mysql-administrator-main-window">
+
<title>Main Window</title>
<section id="mysql-administrator-main-window-introduction">
@@ -45,7 +47,7 @@
<title>Sidebar</title>
<para>
- The sidebar consists of the following sections:
+ The sidebar consists of the following options:
</para>
<itemizedlist>
@@ -63,8 +65,10 @@
<para>
<link
linkend="mysql-administrator-service-control">Service
- Control</link>: Start and stop the MySQL server. On Windows,
- you can also configure the MySQL service.
+ Control</link>: Start and stop the MySQL server. If &administrator;
+ is running on Windows and connected to a MySQL server that is also running
+ on Windows,
+ you can configure the MySQL service.
</para>
</listitem>
@@ -97,7 +101,7 @@
<para>
<link
linkend="mysql-administrator-health">Health</link>:
- Graphical displays of a number of usage or hitrate values
+ Graphical displays of a number of usage or hit-rate values
that affect server performance, and a hierarchical view of
system and status variables.
</para>
@@ -151,7 +155,7 @@
<para>
You can change the width of the sidebar in the main window by
- dragging the separator between sidebar and working area. To hide
+ dragging the separator between the sidebar and the working area. To hide
the sidebar completely, click on the marked area in the
separator (located in the vertical center of it). To make the
sidebar visible again, double-click the marked area (which then
@@ -208,7 +212,7 @@
<para>
Opens the
<link linkend="mysql-administrator-starting-connection">Connection
- dialog</link>, allowing you to open another connection to a
+ dialog</link>, allowing you to open a connection to another
MySQL server. You may open an arbitrary number of
connections. MySQL Administrator opens a new main window for
each successfully established connection. Connections may be
Modified: trunk/administrator/starting.xml
===================================================================
--- trunk/administrator/starting.xml 2006-08-29 20:40:11 UTC (rev 3128)
+++ trunk/administrator/starting.xml 2006-08-29 21:57:00 UTC (rev 3129)
Changed blocks: 10, Lines Added: 20, Lines Deleted: 17; 4700 bytes
@@ -5,6 +5,8 @@
<!ENTITY % gui-common.entities SYSTEM "../gui-common/gui-common.ent">
%gui-common.entities;
]>
+ <!-- Installing &administrator; -->
+
<chapter id="mysql-administrator-starting">
<title>Starting &administrator;</title>
@@ -14,7 +16,7 @@
<title>Introduction</title>
<para>
- The way you start &administrator; depends on the operating
+ How you start &administrator; depends on the operating
system you are using:
</para>
@@ -29,7 +31,7 @@
</para>
<programlisting>
-C:\> C:\<replaceable>program
+C:\> C:\<replaceable>program »
directory</replaceable>\MySQL\&administrator; 1.0\MySQLAdministrator.exe
</programlisting>
@@ -50,15 +52,15 @@
<listitem>
<para>
On Linux desktops, start &administrator; by changing
- directory into
- <literal>/opt/mysql-administrator/bin</literal>, and then
+ to the
+ <literal>/opt/mysql-administrator/bin</literal> directory, and then
running <literal>mysql-administrator</literal>.
</para>
</listitem>
<listitem>
<para>
- On Mac OSX, navigate to the &administrator; installation
+ On Mac OS X, navigate to the &administrator; installation
directory and double-click on the &administrator; icon.
</para>
</listitem>
@@ -75,10 +77,9 @@
<para>
Once &administrator; has been started, it displays a connection
- dialog. You have to specify the MySQL server to which you would
- like to connect, the credentials needed for authorization on
- that server, and which machine that server runs on (and which
- port it listens to). You may also specify a number of other
+ dialog box. Specify the MySQL server you would
+ like to connect to, the necessary credentials, and both the host and port.
+ You may also specify a number of other
options, if required.
</para>
@@ -89,6 +90,8 @@
-service mode</link>.
</para>
+ <remark>update image</remark>
+
<figure>
<title>Connection dialog</title>
<mediaobject>
@@ -122,7 +125,7 @@
</para>
<para>
- You can change any of the values in the connection profiles just
+ You can change any of the values in the connection profiles
by overwriting the existing values with new ones. Similarly, if
you select another connection profile, you can change any of its
values. When you click the <guibutton>OK</guibutton> button
@@ -181,13 +184,14 @@
When you have
<ulink
url="http://dev.mysql.com/doc/mysql/en/Multiple_servers.html">multiple
- servers</ulink> running on your machine. On Windows, MySQL
+ servers</ulink> running on your machine. When running in normal mode
+ on Windows, MySQL
Administrator only allows you to configure the Windows
service that is listed first in the Windows services
- management when running in normal mode. This means that if
+ management. This means that if
you have more than one Windows service, you can only
configure the first one of those, no matter which server you
- have connected to. If you want to configure a service other
+ connect to. If you want to configure a service other
than the first service, you will have to run &administrator;
in configure-service mode.
</para>
@@ -239,9 +243,8 @@
Under <literal>Installed Services</literal> in the
<link linkend="mysql-administrator-sidebar">sidebar</link>, you
can select the service that you wish to configure, or the server
- that you want to stop or start. In configure-service mode, as
- opposed to normal mode, there is only a subset of the sections
- in the sidebar avaiable:
+ that you want to stop or start. In configure-service mode,
+ not all sidebar options are available:
</para>
<itemizedlist>
@@ -268,7 +271,7 @@
</itemizedlist>
<para>
- Both of those sections are described in detail below.
+ Both of those sections are described in what follows.
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r3129 - trunk/administrator | plavin | 29 Aug |
