Author: plavin
Date: 2007-11-07 23:12:46 +0100 (Wed, 07 Nov 2007)
New Revision: 8574
Log:
Continue moving chapters from userguide.xml into separate files, remove remarks
Added:
trunk/userguide/data-types.xml
trunk/userguide/functions.xml
trunk/userguide/introduction-using.xml
trunk/userguide/operators.xml
trunk/userguide/optimizing.xml
trunk/userguide/prototype-userguide-chapter.xml
trunk/userguide/schemas-tables.xml
trunk/userguide/triggers.xml
trunk/userguide/upgrading.xml
Modified:
trunk/userguide/Makefile.depends
trunk/userguide/about.xml
trunk/userguide/backups.xml
trunk/userguide/indexing.xml
trunk/userguide/introduction.xml
trunk/userguide/mysql-client-programs.xml
trunk/userguide/userguide.xml
Modified: trunk/userguide/Makefile.depends
===================================================================
--- trunk/userguide/Makefile.depends 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/Makefile.depends 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 7, Lines Added: 144, Lines Deleted: 0; 8254 bytes
@@ -70,6 +70,23 @@
configuring-manprepped.xml: $(configuring_SOURCES) $(configuring_IDMAPS)
configuring-remprepped.xml: $(configuring_SOURCES) $(configuring_IDMAPS)
+data_types_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+data_types_IMAGES =
+data_types_SOURCES = data-types.xml $(data_types_INCLUDES)
+data_types_IDMAPS =
+data-types.validpure: $(data_types_SOURCES)
+data-types.titles: $(data_types_SOURCES)
+data-types.useless: $(data_types_SOURCES)
+data-types.valid: $(data_types_SOURCES) $(data_types_IDMAPS)
+data-types.validwarn: $(data_types_SOURCES) $(data_types_IDMAPS)
+data-types-prepped.xml: $(data_types_SOURCES) $(data_types_IDMAPS)
+data-types-manprepped.xml: $(data_types_SOURCES) $(data_types_IDMAPS)
+data-types-remprepped.xml: $(data_types_SOURCES) $(data_types_IDMAPS)
+
dotnet_INCLUDES =
dotnet_IMAGES =
dotnet_SOURCES = dotnet.xml $(dotnet_INCLUDES)
@@ -101,6 +118,23 @@
excel-mysql-manprepped.xml: $(excel_mysql_SOURCES) $(excel_mysql_IDMAPS)
excel-mysql-remprepped.xml: $(excel_mysql_SOURCES) $(excel_mysql_IDMAPS)
+functions_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+functions_IMAGES =
+functions_SOURCES = functions.xml $(functions_INCLUDES)
+functions_IDMAPS =
+functions.validpure: $(functions_SOURCES)
+functions.titles: $(functions_SOURCES)
+functions.useless: $(functions_SOURCES)
+functions.valid: $(functions_SOURCES) $(functions_IDMAPS)
+functions.validwarn: $(functions_SOURCES) $(functions_IDMAPS)
+functions-prepped.xml: $(functions_SOURCES) $(functions_IDMAPS)
+functions-manprepped.xml: $(functions_SOURCES) $(functions_IDMAPS)
+functions-remprepped.xml: $(functions_SOURCES) $(functions_IDMAPS)
+
gnu_fdl_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -150,6 +184,23 @@
installing-manprepped.xml: $(installing_SOURCES) $(installing_IDMAPS)
installing-remprepped.xml: $(installing_SOURCES) $(installing_IDMAPS)
+introduction_using_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+introduction_using_IMAGES =
+introduction_using_SOURCES = introduction-using.xml $(introduction_using_INCLUDES)
+introduction_using_IDMAPS =
+introduction-using.validpure: $(introduction_using_SOURCES)
+introduction-using.titles: $(introduction_using_SOURCES)
+introduction-using.useless: $(introduction_using_SOURCES)
+introduction-using.valid: $(introduction_using_SOURCES) $(introduction_using_IDMAPS)
+introduction-using.validwarn: $(introduction_using_SOURCES) $(introduction_using_IDMAPS)
+introduction-using-prepped.xml: $(introduction_using_SOURCES) $(introduction_using_IDMAPS)
+introduction-using-manprepped.xml: $(introduction_using_SOURCES) $(introduction_using_IDMAPS)
+introduction-using-remprepped.xml: $(introduction_using_SOURCES) $(introduction_using_IDMAPS)
+
introduction_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -251,6 +302,40 @@
mysql-server-programs-manprepped.xml: $(mysql_server_programs_SOURCES) $(mysql_server_programs_IDMAPS)
mysql-server-programs-remprepped.xml: $(mysql_server_programs_SOURCES) $(mysql_server_programs_IDMAPS)
+operators_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+operators_IMAGES =
+operators_SOURCES = operators.xml $(operators_INCLUDES)
+operators_IDMAPS =
+operators.validpure: $(operators_SOURCES)
+operators.titles: $(operators_SOURCES)
+operators.useless: $(operators_SOURCES)
+operators.valid: $(operators_SOURCES) $(operators_IDMAPS)
+operators.validwarn: $(operators_SOURCES) $(operators_IDMAPS)
+operators-prepped.xml: $(operators_SOURCES) $(operators_IDMAPS)
+operators-manprepped.xml: $(operators_SOURCES) $(operators_IDMAPS)
+operators-remprepped.xml: $(operators_SOURCES) $(operators_IDMAPS)
+
+optimizing_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+optimizing_IMAGES =
+optimizing_SOURCES = optimizing.xml $(optimizing_INCLUDES)
+optimizing_IDMAPS =
+optimizing.validpure: $(optimizing_SOURCES)
+optimizing.titles: $(optimizing_SOURCES)
+optimizing.useless: $(optimizing_SOURCES)
+optimizing.valid: $(optimizing_SOURCES) $(optimizing_IDMAPS)
+optimizing.validwarn: $(optimizing_SOURCES) $(optimizing_IDMAPS)
+optimizing-prepped.xml: $(optimizing_SOURCES) $(optimizing_IDMAPS)
+optimizing-manprepped.xml: $(optimizing_SOURCES) $(optimizing_IDMAPS)
+optimizing-remprepped.xml: $(optimizing_SOURCES) $(optimizing_IDMAPS)
+
php_mysqli_INCLUDES =
php_mysqli_IMAGES =
php_mysqli_SOURCES = php-mysqli.xml $(php_mysqli_INCLUDES)
@@ -290,6 +375,23 @@
querying-manprepped.xml: $(querying_SOURCES) $(querying_IDMAPS)
querying-remprepped.xml: $(querying_SOURCES) $(querying_IDMAPS)
+schemas_tables_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+schemas_tables_IMAGES =
+schemas_tables_SOURCES = schemas-tables.xml $(schemas_tables_INCLUDES)
+schemas_tables_IDMAPS =
+schemas-tables.validpure: $(schemas_tables_SOURCES)
+schemas-tables.titles: $(schemas_tables_SOURCES)
+schemas-tables.useless: $(schemas_tables_SOURCES)
+schemas-tables.valid: $(schemas_tables_SOURCES) $(schemas_tables_IDMAPS)
+schemas-tables.validwarn: $(schemas_tables_SOURCES) $(schemas_tables_IDMAPS)
+schemas-tables-prepped.xml: $(schemas_tables_SOURCES) $(schemas_tables_IDMAPS)
+schemas-tables-manprepped.xml: $(schemas_tables_SOURCES) $(schemas_tables_IDMAPS)
+schemas-tables-remprepped.xml: $(schemas_tables_SOURCES) $(schemas_tables_IDMAPS)
+
storage_engines_INCLUDES =
storage_engines_IMAGES =
storage_engines_SOURCES = storage-engines.xml $(storage_engines_INCLUDES)
@@ -316,6 +418,40 @@
stored-procedures-manprepped.xml: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
stored-procedures-remprepped.xml: $(stored_procedures_SOURCES) $(stored_procedures_IDMAPS)
+triggers_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+triggers_IMAGES =
+triggers_SOURCES = triggers.xml $(triggers_INCLUDES)
+triggers_IDMAPS =
+triggers.validpure: $(triggers_SOURCES)
+triggers.titles: $(triggers_SOURCES)
+triggers.useless: $(triggers_SOURCES)
+triggers.valid: $(triggers_SOURCES) $(triggers_IDMAPS)
+triggers.validwarn: $(triggers_SOURCES) $(triggers_IDMAPS)
+triggers-prepped.xml: $(triggers_SOURCES) $(triggers_IDMAPS)
+triggers-manprepped.xml: $(triggers_SOURCES) $(triggers_IDMAPS)
+triggers-remprepped.xml: $(triggers_SOURCES) $(triggers_IDMAPS)
+
+upgrading_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+upgrading_IMAGES =
+upgrading_SOURCES = upgrading.xml $(upgrading_INCLUDES)
+upgrading_IDMAPS =
+upgrading.validpure: $(upgrading_SOURCES)
+upgrading.titles: $(upgrading_SOURCES)
+upgrading.useless: $(upgrading_SOURCES)
+upgrading.valid: $(upgrading_SOURCES) $(upgrading_IDMAPS)
+upgrading.validwarn: $(upgrading_SOURCES) $(upgrading_IDMAPS)
+upgrading-prepped.xml: $(upgrading_SOURCES) $(upgrading_IDMAPS)
+upgrading-manprepped.xml: $(upgrading_SOURCES) $(upgrading_IDMAPS)
+upgrading-remprepped.xml: $(upgrading_SOURCES) $(upgrading_IDMAPS)
+
userguide_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -324,25 +460,33 @@
backups.xml \
basic-administration.xml \
configuring.xml \
+ data-types.xml \
dotnet.xml \
excel-mysql.xml \
+ functions.xml \
gnu-fdl.xml \
images/published/indexing-displaying-administrator.png \
images/published/logfiles-slow-query-log-administrator-settings.png \
images/published/logfiles-slow-query-log-administrator-view.png \
indexing.xml \
installing.xml \
+ introduction-using.xml \
introduction.xml \
java.xml \
log-files.xml \
modifying.xml \
mysql-client-programs.xml \
mysql-server-programs.xml \
+ operators.xml \
+ optimizing.xml \
php-mysqli.xml \
populating.xml \
querying.xml \
+ schemas-tables.xml \
storage-engines.xml \
stored-procedures.xml \
+ triggers.xml \
+ upgrading.xml \
userguide.ent \
views.xml
userguide_IMAGES = \
Modified: trunk/userguide/about.xml
===================================================================
--- trunk/userguide/about.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/about.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 3, Lines Added: 0, Lines Deleted: 21; 1469 bytes
@@ -179,13 +179,6 @@
<para>
Additionally, make sure that you have read and understood
<xref to legal status of submissions>.
-
- <remark>
- [PL] still need to make the Docs CLA (contributor license
- agreement) available on MySQL Forge. Also note the type of
- licence
- </remark>
-
Email <email>docs@stripped</email> specifying
<quote>&userguide; Contribution</quote> as the subject line.
This email should contain a short biography and briefly describe
@@ -263,10 +256,6 @@
(SGML). If you are familiar with HTML, especially XHTML then the
DocBook format will immediately seem familiar. To find out more
see <ulink url="http://docbook.org">DocBook</ulink>.
-
- <remark>
- [PL] promotion with O'Reilly?
- </remark>
</para>
<para>
@@ -293,16 +282,6 @@
[Link to be provided shortly.] The MySQL documentation team has
also prepared DocBook templates to help you get started. You'll
find them <xref -here>.
-
- <remark>
- [PL] which ones
- </remark>
-
-
-
- <remark>
- [PL] promotion with oXygen?
- </remark>
</para>
<para>
Modified: trunk/userguide/backups.xml
===================================================================
--- trunk/userguide/backups.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/backups.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 13; 1006 bytes
@@ -746,19 +746,7 @@
xref when available
</remark>
</para>
-
-<!--Leave out? add Migration Toolkit reference? para>
- Apart from exporting databases in various text formats, it is also
- possible to export to other database formats such as MS SQL
- Server, PostgreSQL, or even to convert to earlier versions of
- MySQL. This is done using the
- <option>– –compatible=<replaceable>name</replaceable></option>
- option. Using this option makes a best guess at transforming MySQL
- to the named format. However, this topic is beyond the scope of
- this discussion. For more information see
- <ulink url="&base-url-refman;5.0/en/mysqldump.html"/>.
- </para-->
-
+
</section>
</section>
Added: trunk/userguide/data-types.xml
===================================================================
--- trunk/userguide/data-types.xml (rev 0)
+++ trunk/userguide/data-types.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 20, Lines Deleted: 0; 720 bytes
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-data-types">
+
+ <title>Data Types</title>
+
+ <section id="userguide-specific-type">
+
+ <title><Data Type></title>
+
+ <para></para>
+
+ </section>
+
+</chapter>
\ No newline at end of file
Added: trunk/userguide/functions.xml
===================================================================
--- trunk/userguide/functions.xml (rev 0)
+++ trunk/userguide/functions.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 20, Lines Deleted: 0; 723 bytes
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-functions">
+
+ <title>Functions</title>
+
+ <section id="userguide-specific-function">
+
+ <title><Function Type></title>
+
+ <para></para>
+
+ </section>
+
+</chapter>
\ No newline at end of file
Modified: trunk/userguide/indexing.xml
===================================================================
--- trunk/userguide/indexing.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/indexing.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 3, Lines Added: 0, Lines Deleted: 12; 1091 bytes
@@ -464,10 +464,6 @@
3 rows in set (0.00 sec)
</programlisting>
- <remark>
- [MH] UPDATEME WHEN SAMPLE DB IS FINISHED
- </remark>
-
<para>
The output of the <literal>SHOW</literal> command shows that
there are two indexes on the <literal>film</literal> table:
@@ -570,10 +566,6 @@
3 rows in set (0.00 sec)
</programlisting>
- <remark>
- [MH] UPDATEME WHEN SAMPLE DB IS FINISHED
- </remark>
-
<para>
The output of a query to the
<literal>INFORMATION_SCHEMA</literal> closely matches that of
@@ -618,10 +610,6 @@
</mediaobject>
</figure>
- <remark>
- [MH] UPDATEME WHEN SAMPLE DB IS FINISHED
- </remark>
-
<para>
The <literal>Catalog</literal> screen displays the index
information for all tables in the selected schema. To view the
Added: trunk/userguide/introduction-using.xml
===================================================================
--- trunk/userguide/introduction-using.xml (rev 0)
+++ trunk/userguide/introduction-using.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 82, Lines Deleted: 0; 2013 bytes
@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-introduction-using-mysql">
+
+ <title>Introduction to Using MySQL</title>
+
+ <section id="userguide-differences-oses">
+
+ <title>Variations Between Operating Systems</title>
+
+ <para>
+ MySQL functions slightly differently on
+ different operating systems. For the most part
+ these differences can be ignored but you should
+ be aware of the following items:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ sockets
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ auto-completion
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ file separators
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ etc
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section id="userguide-command-line">
+
+ <title>Working From the Command Line</title>
+
+ <para>
+ <remark>
+ [PL] Not a repeat of the MySQL Client section.
+ Basics of querying a database.
+ </remark>
+ </para>
+
+ </section>
+
+ <section id="userguide-query-browser">
+
+ <title>Using Query Browser</title>
+
+ <para></para>
+
+ </section>
+
+ <section id="userguide-sample-schema">
+
+ <title>Sample Schema</title>
+
+ <para></para>
+
+ </section>
+
+</chapter>
\ No newline at end of file
Modified: trunk/userguide/introduction.xml
===================================================================
--- trunk/userguide/introduction.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/introduction.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 0, Lines Deleted: 42; 3094 bytes
@@ -17,48 +17,6 @@
<para></para>
- <remark>
- [SH] The following was sent in by community member Vangelis
- Katsikaros on the mysqldoc list. Even if we might not want to use
- his text we should have a short introduction to the client/server
- principle. intoduction to the client/server architecture MySQL
- follows the client/server architecture and as a consequence, MySQL
- consists of two parts: the server and the client(s). They
- communicate over a well-defined interface but let's not describe
- any more details of it. This interface simply defines the way that
- the server and the client communicate with each other. The
- important here is that such an interface for communication exists
- and both the server and the client use it. The server is a program
- that waits for requests to come on the well-defined interface.
- When a request comes, the server is trying to serve the request
- (perform the tasks described in the request) and replies back
- using the interface. The client is a program that sends requests
- to the server using the well-defined interface. Then it waits
- until for a reply to come back from the server through the
- interface. Many clients can be connected to the server at the same
- time. Examples of clients are: the MySQL command-line client
- **mysql* *, a GUI client like MySQL Query Browser or MySQL
- Administrator, or a programming language client. Lets see some
- examples of how things could work in the case of a MySQL client
- which asks from the MySQL server to preform specific database
- tasks. a) The client asks from the server the creation of a
- database. The server gets that request and performs the actual
- creation of the database in the filesystem. Then the server
- reports back to the client confirmation or errors. b) The client
- asks from the server the execution of a query (which could lead to
- retrieval of data). The server gets that request and performs the
- actual retrieval of data from the filesystem. Then the server
- reports back to the client the data. c) The client asks from the
- server the execution of a query (which could lead to storage of
- data). The server gets that request and performs the actual
- storage of data in the filesystem. Then the server reports back to
- the client confirmation or errors. In the above examples if the
- client is **mysql* * or a GUI then the report from the server is
- displayed on the user-interface of the client. If it is a
- programming language client the report is stored in a variable for
- further manipulation with the programming language.
- </remark>
-
<section id="userguide-client-server">
<title>Client and Server</title>
Modified: trunk/userguide/mysql-client-programs.xml
===================================================================
--- trunk/userguide/mysql-client-programs.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/mysql-client-programs.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 0, Lines Deleted: 4; 579 bytes
@@ -289,10 +289,6 @@
these options in a configuration file is a good way to simplify
things. Configuration files are discussed in detail in
<xref>.
-
- <remark>
- no longer use these options from this point on?
- </remark>
</para>
</section>
Added: trunk/userguide/operators.xml
===================================================================
--- trunk/userguide/operators.xml (rev 0)
+++ trunk/userguide/operators.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 20, Lines Deleted: 0; 671 bytes
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-operators">
+
+<title>Operators</title>
+
+<section id="userguide-operators-type">
+
+ <title><Operator Type></title>
+
+ <para></para>
+
+</section>
+
+</chapter>
Added: trunk/userguide/optimizing.xml
===================================================================
--- trunk/userguide/optimizing.xml (rev 0)
+++ trunk/userguide/optimizing.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 36, Lines Deleted: 0; 988 bytes
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-optimization">
+
+ <title>Optimization</title>
+
+ <section id="optimization">
+
+ <title>Using EXPLAIN</title>
+
+ <para></para>
+
+ </section>
+
+ <section id="userguide-optimization-select">
+
+ <title>Optimizing SELECT Statements</title>
+
+ <para></para>
+
+ </section>
+
+ <section id="userguide-optimization-indexes">
+
+ <title>Optimizing Indexes</title>
+
+ <para></para>
+
+ </section>
+
+</chapter>
\ No newline at end of file
Added: trunk/userguide/prototype-userguide-chapter.xml
===================================================================
--- trunk/userguide/prototype-userguide-chapter.xml (rev 0)
+++ trunk/userguide/prototype-userguide-chapter.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 243, Lines Deleted: 0; 6682 bytes
@@ -0,0 +1,243 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<!-- Replace "-chapter" with a more descriptive term -->
+<chapter id="user-guide-chapter">
+
+ <title>Title of Chapter here</title>
+
+ <para>
+ Outline the intention of the new chapter here, and/or give a summary
+ </para>
+
+ <para>
+ Do not code or mask characters except these:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ Use < for the opening angle bracket
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Use & for the ampersand sign
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ All other characters such as ä, ö, ü, ß, \, and so forth can be
+ written verbatim.
+ </para>
+
+<!-- Replace "-section1" with a more descriptive term -->
+
+ <section id="user-guide-section1">
+
+ <title>Title of Section 1 Here</title>
+
+ <para>
+ Outline the intention of this section, and/or give a summary
+ </para>
+
+ <para>
+ Fill in more contents
+ </para>
+
+ <para>
+ Here are the most often used inline elements:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ This is an <literal>all-purpose element for marking
+ something as <quote>code</quote></literal>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <emphasis>This emphasis</emphasis> will render in italics in
+ most output, and <emphasis role="bold">this
+ emphasis</emphasis> will render in boldface.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is how you link to a section within the same document:
+ <xref linkend="user-guide-section1"/>. In the output, the
+ link description will be taken from the
+ <literal>title</literal> of the link target
+ (<literal>linkend</literal>). If you must have a link
+ description other than that, you need to create a
+ <link linkend="user-guide-section1">link like this</link>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ To reference a location outside the document, use
+ <literal>ulink</literal>, like this:
+ <ulink url="http://dev.mysql.com/doc"/>. The description of
+ that link will be the URL itself. If you want a description
+ different from that, you can use this:
+ <ulink url="http://dev.mysql.com/doc">MySQL documentation
+ overview page</ulink>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is a <replaceable>placeholder</replaceable>, for
+ example for
+ <replaceable>username</replaceable>@<replaceable>hostname</replaceable>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is a <command>command</command>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is a <filename>file</filename> or
+ <filename>directory</filename>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is an <email>email address</email>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is a <function>function</function>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is an <option>option</option>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ <para>
+ The rest of this sections contains templates for various block
+ elements.
+ </para>
+
+ <note>
+ <para>
+ This is a note which is offset visibly from regular paragraphs
+ </para>
+ </note>
+
+<programlisting>
+A program listing is for code.
+Everything you type here will be rendered verbatim
+(including space characters and line breaks).
+Try to make lines no longer than 75 characters.
+We write shell commands like this:
+shell> <userinput>this is a shell command</userinput>
+We write mysql commands and statements like this:
+mysql> <userinput>this is a mysql command or statement</userinput>
+</programlisting>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ This is the first item of a bullet list
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is the second item of a bullet list – keep list
+ items consistent by starting them all with uppercase or
+ lowercase letters (but not mixed), and ending them with our
+ without periods (but not both)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is the third item of a bullet list
+ </para>
+
+ <para>
+ You can have multiple paragraphs for a bullet list item
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <orderedlist>
+
+ <listitem>
+ <para>
+ This is the first item of an ordered list
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is the second item of an ordered list – keep list
+ items consistent by starting them all with uppercase or
+ lowercase letters (but not mixed), and ending them with our
+ without periods (but not both)
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ This is the third item of a bullet list
+ </para>
+
+ <para>
+ You can have multiple paragraphs for a bullet list item
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ <informaltable>
+ <tgroup cols="2">
+ <colspec colwidth="50*"/>
+ <colspec colwidth="50*"/>
+ <tbody>
+ <row>
+ <entry><emphasis role="bold">Header cell, column 1</emphasis></entry>
+ <entry><emphasis role="bold">Header cell, column 2</emphasis></entry>
+ </row>
+ <row>
+ <entry>Content row 1, column 1</entry>
+ <entry>Content row 1, column 2</entry>
+ </row>
+ <row>
+ <entry>Content row 2, column 1</entry>
+ <entry>Content row 2, column 2</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ </section>
+
+</chapter>
Added: trunk/userguide/schemas-tables.xml
===================================================================
--- trunk/userguide/schemas-tables.xml (rev 0)
+++ trunk/userguide/schemas-tables.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 36, Lines Deleted: 0; 946 bytes
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-schemas-tables">
+
+ <title>Creating Schemas and Tables</title>
+
+ <section id="designing-schemas-tables">
+
+ <title>Designing a Schema</title>
+
+ <para></para>
+
+ </section>
+
+ <!--section>
+
+ <title>Database Normalization</title>
+
+ <para></para>
+
+ </section>
+
+ <section>
+
+ <title>Choosing Column Types</title>
+
+ <para></para>
+
+ </section-->
+
+</chapter>
Added: trunk/userguide/triggers.xml
===================================================================
--- trunk/userguide/triggers.xml (rev 0)
+++ trunk/userguide/triggers.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 36, Lines Deleted: 0; 810 bytes
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-triggers">
+
+<title>Triggers</title>
+
+<section id="triggers">
+
+ <title>What Are Triggers?</title>
+
+ <para></para>
+
+</section>
+
+<!--section>
+
+ <title>Events</title>
+
+ <para></para>
+
+ </section>
+
+ <section>
+
+ <title>Using Triggers</title>
+
+ <para></para>
+
+ </section-->
+
+</chapter>
Added: trunk/userguide/upgrading.xml
===================================================================
--- trunk/userguide/upgrading.xml (rev 0)
+++ trunk/userguide/upgrading.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 1, Lines Added: 24, Lines Deleted: 0; 774 bytes
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE chapter 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;
+]>
+<chapter id="userguide-upgrading">
+
+ <title>Upgrading MySQL </title>
+
+ <para></para>
+
+ <section id="upgrading-operating-system">
+ <title>Upgrading on <operating system></title>
+
+ <para>
+
+ </para>
+
+ </section>
+
+
+</chapter>
\ No newline at end of file
Modified: trunk/userguide/userguide.xml
===================================================================
--- trunk/userguide/userguide.xml 2007-11-07 21:29:28 UTC (rev 8573)
+++ trunk/userguide/userguide.xml 2007-11-07 22:12:46 UTC (rev 8574)
Changed blocks: 7, Lines Added: 11, Lines Deleted: 247; 6120 bytes
@@ -27,8 +27,6 @@
</abstract>
-<!--xi:include href="legalnotice.en.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/-->
-
</bookinfo>
<xi:include href="about.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
@@ -68,83 +66,8 @@
<title>Using MySQL</title>
<!--intro-->
-
- <chapter id="userguide-introduction-using-mysql">
-
- <title>Introduction to Using MySQL</title>
-
- <section id="userguide-differences-oses">
-
- <title>Variations Between Operating Systems</title>
-
- <para>
- MySQL functions slightly differently on
- different operating systems. For the most part
- these differences can be ignored but you should
- be aware of the following items:
-
- <itemizedlist>
-
- <listitem>
- <para>
- sockets
- </para>
- </listitem>
-
- <listitem>
- <para>
- auto-completion
- </para>
- </listitem>
-
- <listitem>
- <para>
- file separators
- </para>
- </listitem>
-
- <listitem>
- <para>
- etc
- </para>
- </listitem>
-
- </itemizedlist>
- </para>
-
- </section>
-
- <section id="userguide-command-line">
-
- <title>Working From the Command Line</title>
-
- <para>
- <remark>
- [PL] Not a repeat of the MySQL Client section.
- Basics of querying a database.
- </remark>
- </para>
-
- </section>
-
- <section id="userguide-query-browser">
-
- <title>Using Query Browser</title>
-
- <para></para>
-
- </section>
-
- <section id="userguide-sample-schema">
-
- <title>Sample Schema</title>
-
- <para></para>
-
- </section>
-
- </chapter>
-
+ <xi:include href="introduction-using.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<!--end intro-->
<!--populating-->
@@ -161,56 +84,20 @@
<!--Data Types-->
- <chapter id="userguide-data-types">
+ <xi:include href="data-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <title>Data Types</title>
-
- <section id="userguide-specific-type">
-
- <title><Data Type></title>
-
- <para></para>
-
- </section>
-
- </chapter>
-
<!--end Data Types-->
<!--operators-->
- <chapter id="userguide-operators">
-
- <title>Operators</title>
-
- <section id="userguide-operators-type">
-
- <title><Operator Type></title>
-
- <para></para>
-
- </section>
-
- </chapter>
-
+ <xi:include href="operators.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<!--end operators-->
<!--Functions-->
- <chapter id="userguide-functions">
+ <xi:include href="functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <title>Functions</title>
-
- <section id="userguide-specific-function">
-
- <title><Function Type></title>
-
- <para></para>
-
- </section>
-
- </chapter>
-
<!--end Functions-->
<!--Modifying Data-->
@@ -229,60 +116,9 @@
<title>Advanced MySQL Usage</title>
- <chapter id="userguide-schemas-tables">
- <title>Creating Schemas and Tables</title>
-
- <section id="designing-schemas-tables">
-
- <title>Designing a Schema</title>
-
- <para></para>
-
- </section>
-
-<!--section>
-
- <title>Database Normalization</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Choosing Column Types</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Creating Schemas</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Creating Tables</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Altering Schemas and Tables</title>
-
- <para></para>
-
- </section-->
-
- </chapter>
-
+ <xi:include href="schemas-tables.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
<!--end creating-->
<!--Indexing-->
@@ -299,36 +135,8 @@
<!--Start Triggers-->
- <chapter id="userguide-triggers">
+ <xi:include href="triggers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <title>Triggers</title>
-
- <section id="triggers">
-
- <title>What Are Triggers?</title>
-
- <para></para>
-
- </section>
-
-<!--section>
-
- <title>Events</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Using Triggers</title>
-
- <para></para>
-
- </section-->
-
- </chapter>
-
<!--end triggers-->
<!--Start Stored Procedures-->
@@ -341,36 +149,8 @@
<!--Optimizing-->
- <chapter id="userguide-optimization">
+ <xi:include href="optimizing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <title>Optimization</title>
-
- <section id="optimization">
-
- <title>Using EXPLAIN</title>
-
- <para></para>
-
- </section>
-
- <section id="userguide-optimization-select">
-
- <title>Optimizing SELECT Statements</title>
-
- <para></para>
-
- </section>
-
- <section id="userguide-optimization-indexes">
-
- <title>Optimizing Indexes</title>
-
- <para></para>
-
- </section>
-
- </chapter>
-
<!--end Optimizing-->
<!--chapter>
@@ -413,24 +193,8 @@
<!-- END UPGRADING MYSQL -->
- <chapter id="userguide-upgrading">
+ <xi:include href="upgrading.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <title>Upgrading MySQL </title>
-
- <para></para>
-
- <section id="upgrading-operating-system">
- <title>Upgrading on <operating system></title>
-
- <para>
-
- </para>
-
- </section>
-
-
- </chapter>
-
<chapter id="userguide-security">
<title>MySQL Security</title>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8574 - trunk/userguide | plavin | 7 Nov |
