Author: tbedford
Date: 2009-01-06 13:08:39 +0100 (Tue, 06 Jan 2009)
New Revision: 13011
Log:
Added C/OOo docs to main manual.
Added:
trunk/refman-common/connector-ooo.xml
Modified:
trunk/mysqlqb/Makefile.depends
Modified: trunk/mysqlqb/Makefile.depends
===================================================================
--- trunk/mysqlqb/Makefile.depends 2009-01-06 10:47:40 UTC (rev 13010)
+++ trunk/mysqlqb/Makefile.depends 2009-01-06 12:08:39 UTC (rev 13011)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 575 bytes
@@ -67,7 +67,7 @@
../refman-5.0/metadata/views.idmap \
../refman-common/metadata/bug-reports.idmap \
../refman-common/metadata/credits.idmap \
- metadata/mysqlqb_functions.idmap
+ ../refman-common/metadata/regexp.idmap
mysqlqb.validpure: $(mysqlqb_SOURCES)
mysqlqb.titles: $(mysqlqb_SOURCES)
mysqlqb.useless: $(mysqlqb_SOURCES)
Added: trunk/refman-common/connector-ooo.xml
===================================================================
--- trunk/refman-common/connector-ooo.xml (rev 0)
+++ trunk/refman-common/connector-ooo.xml 2009-01-06 12:08:39 UTC (rev 13011)
Changed blocks: 1, Lines Added: 421, Lines Deleted: 0; 13193 bytes
@@ -0,0 +1,421 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+ %all.entities;
+]>
+<section id="connector-ooo">
+
+ <title>MySQL Connector/OpenOffice.org</title>
+
+ <para>
+ MySQL Connector/OpenOffice.org is a native MySQL database connector
+ for OpenOffice.org. Currently, it is in preview status and supports
+ OpenOffice.org 2.4 only. It can be used to connect OpenOffice.org
+ applications to a MySQL server.
+ </para>
+
+ <para>
+ Before MySQL Connector/OpenOffice.org became available you would
+ have to use MySQL Connector/J (JDBC) or MySQL Connector/ODBC to
+ connect to a MySQL server.
+ </para>
+
+ <para>
+ Connector/OpenOffice.org is a community project, although Sun
+ Microsystems actively contributes code. The source code for
+ Connector/OpenOffice.org is available under GPL with the FLOSS
+ License Exception.
+ </para>
+
+ <para>
+ In the future a closed-source StarOffice version of
+ Connector/OpenOffice.org will be made available.
+ </para>
+
+ <para>
+ <emphasis role="bold">Advantages</emphasis>
+ </para>
+
+ <para>
+ Using MySQL Connector/OpenOffice.org has the following advantages:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Easy installation through the OpenOffice.org Extension Manager.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Seamless integration into OpenOffice.org.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ No need to go through an additional Connector installation
+ routine (ODBC/JDBC)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ No need to configure or register an additional Connector (ODBC)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ No need to install or configure a driver manager (ODBC)
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ <emphasis role="bold">Status</emphasis>
+ </para>
+
+ <para>
+ MySQL Connector/OpenOffice.org is available as a development preview
+ version. We kindly ask users and developers to try it out and
+ provide us with feedback. We do not encourage you to use it in
+ production environments, though.
+ </para>
+
+ <note>
+ <para>
+ Sun Microsystems does not provide formal support for
+ Connector/OpenOffice.org.
+ </para>
+ </note>
+
+ <para>
+ If you have any queries please contact us through our mailing list
+ at <email>users@stripped</email>
+ </para>
+
+ <section id="connector-ooo-installation">
+
+ <title>Installation</title>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ Install or upgrade to OpenOffice.org 2.4.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Download MySQL Connector/OpenOffice.org from
+ <ulink url="http://downloads.mysql.com/forge/openoffice_preview">The
+ OpenOffice.org download site</ulink>. Save the file,
+ <filename>mysql-native-win32.oxt</filename> or
+ <filename>mysql-native-linux.oxt</filename>, respectively, to
+ a location of your choice, for example <filename>My
+ Documents</filename> or <filename>~/Documents</filename>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Add the <filename>.oxt</filename> extension through the
+ Extension Manager of OpenOffice.org. In OpenOffice.org, select
+ <guimenu>Tools</guimenu>, <guimenu>Extension
+ Manager...</guimenu> and specify the <filename>.oxt</filename>
+ file as a new extension. When done, MySQL
+ Connector/OpenOffice.org will show up as a new extension under
+ <guilabel>My Extensions</guilabel>.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-add-extension">
+ <title>Adding an extension</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-add-extension.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Adding an extension</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Restart OpenOffice.org.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
+ <section id="connector-ooo-getting-started">
+
+ <title>Getting Started: Connecting to MySQL</title>
+
+ <para>
+ MySQL Connector/OpenOffice.org allows you to access the MySQL
+ Server and its schemata from the OpenOffice.org suite. Currently
+ the connector is in preview status, and only OpenOffice.org 2.4 is
+ supported.
+ </para>
+
+ <para>
+ The following example demonstrates the creation of a new
+ OpenOffice.org Base database which uses a local MySQL Server for
+ storage and the new connector for connecting.
+ </para>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ Select the database
+ </para>
+
+ <para>
+ Create a new database by selecting <guimenu>File</guimenu>,
+ <guimenu>New</guimenu>, <guimenu>Database</guimenu>. This
+ starts a wizard that allows you to create a new, open an
+ existing, or connect to existing database. Select the latter
+ option. From the drop-down list, select MySQL native driver.
+ Click <guibutton>Next >></guibutton>.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-dbwizard1">
+ <title>Selecting the database</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-dbwizard1.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Selecting the database</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Fill in the connection settings
+ </para>
+
+ <para>
+ Under <guilabel>MySQL native driver</guilabel>, fill in the
+ hostname, and optionally a database name, and port name, for
+ example:
+ </para>
+
+ <para>
+ <userinput>localhost/test</userinput>
+ </para>
+
+ <para>
+ This will connect to a MySQL server running on the local host
+ and select the test database. Note that is you do not specify
+ a database the process below will still work, and all
+ databases will be available for selection.
+ </para>
+
+ <para>
+ On Linux, you may have to specify an IP number and a port
+ number instead, due to a limitation in
+ Connector/OpenOffice.org. You have to do so if your MySQL
+ socket file is not <filename>/tmp/mysql.sock</filename>. Enter
+ your data using the format illustrated in the following
+ example:
+ </para>
+
+ <para>
+ <userinput>127.0.0.1:3006/test</userinput>
+ </para>
+
+ <para>
+ This will connect to a MySQL server running on the local host,
+ but do so via TCP/IP using 3306 as the port number. Click
+ <guibutton>Next >></guibutton>.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-dbwizard2">
+ <title>Entering connection settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-dbwizard2.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Entering connection settings</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Fill in credentials
+ </para>
+
+ <para>
+ If you are using MySQL server's anonymous account without a
+ password, you do not have to fill in anything in this step.
+ Otherwise, fill in your MySQL username and check the password
+ checkbox. Note, for security reasons, you should not normally
+ use the anonymous account without a password.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-user-authentication">
+ <title>Setting up user authentication</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-user-authentication.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Setting up user
+ authentication</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+
+ <para>
+ You can now test your connection to the MySQL database server
+ by clicking the <guibutton>Test Connection</guibutton> button.
+ Check the checkbox if you do not want OpenOffice.org to ask
+ you for your password again in the current session. Testing
+ the connection is optional, although recommended.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-user-authentication-credentials">
+ <title>Entering user credentials</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-user-authentication-credentials.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Entering user credentials</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+
+ <para>
+ Click <guibutton>Next >></guibutton>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Finish the wizard
+ </para>
+
+ <para>
+ Leave the default settings and click
+ <guibutton>Finish</guibutton>. You will be forwarded to the
+ OpenOffice.org Base main window. Note that you can invoke the
+ wizard again at any point by right-clicking in the
+ <guilabel>Tables</guilabel> section of the
+ <guilabel>Base</guilabel> main window and selecting
+ <guimenu>Database</guimenu>, <guimenu>Connection
+ type</guimenu>.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ </section>
+
+ <section id="connector-ooo-getting-started-examples">
+
+ <title>Getting Started: Usage Examples</title>
+
+ <para>
+ <emphasis role="bold">Listing Tables</emphasis>
+ </para>
+
+ <para>
+ In the <guilabel>Database</guilabel> area of the
+ <guilabel>Base</guilabel> main window, select
+ <guilabel>Tables</guilabel>. If this is the first time you are
+ accessing the database you will be prompted for your credentials
+ (username and password); you can store these settings for your
+ current Base session.
+ </para>
+
+ <para>
+ <figure id="figure_connector-ooo-base">
+ <title>Listing tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/published/connector-ooo-base.png" format="PNG" lang="en"/>
+ </imageobject>
+ <textobject>
+ <phrase lang="en">Listing tables</phrase>
+ </textobject>
+ </mediaobject>
+ </figure>
+ </para>
+
+ <para>
+ Depending on your connection settings you will now see all
+ databases with all their tables, or just the database you have
+ specified in the connection settings.
+ </para>
+
+ </section>
+
+ <section id="connector-ooo-references">
+
+ <title>References</title>
+
+ <para>
+ See the <ulink url="http://www.openoffice.org/">OpenOffice.org
+ website</ulink> for documentation of the office suite and its
+ Extension Manager.
+ </para>
+
+ </section>
+
+ <section id="connector-ooo-bugs">
+
+ <title>Known Bugs</title>
+
+ <para>
+ If you discover a bug in Connector/OpenOffice.org please
+ <ulink url="http://wiki.services.openoffice.org/wiki/Database/Drivers/MySQL_Native#Known_issues">add
+ it to this list</ulink> and send an email to
+ <email>users@stripped</email>. You need to be logged in
+ with an OpenOffice.org account for both; see the
+ <ulink url="http://dba.openoffice.org/servlets/ProjectMailingListList">project
+ mailing list</ulink> for details.
+ </para>
+
+ </section>
+
+ <section id="connector-ooo-contact">
+
+ <title>Contact</title>
+
+ <para>
+ To discuss the new MySQL Connector/OpenOffice.org, please
+ subscribe to the mailing list
+ <email>users@stripped</email>. It is a low-volume list
+ with less than 10 mails per day.
+ </para>
+
+ </section>
+
+</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r13011 - in trunk: mysqlqb refman-common | anthony.bedford | 6 Jan |
