Author: plavin
Date: 2007-09-04 22:37:41 +0200 (Tue, 04 Sep 2007)
New Revision: 7664
Log:
Reorganise, clean up sections on user contributions.
Added:
trunk/userguide/about.xml
Modified:
trunk/userguide/Makefile.depends
trunk/userguide/all-entities.ent
trunk/userguide/introduction.xml
trunk/userguide/userguide.xml
Modified: trunk/userguide/Makefile.depends
===================================================================
--- trunk/userguide/Makefile.depends 2007-09-04 18:34:11 UTC (rev 7663)
+++ trunk/userguide/Makefile.depends 2007-09-04 20:37:41 UTC (rev 7664)
Changed blocks: 3, Lines Added: 23, Lines Deleted: 5; 1663 bytes
@@ -1,3 +1,24 @@
+about_INCLUDES = \
+ ../common/fixedchars.ent \
+ ../refman-common/urls.ent \
+ all-entities.ent \
+ userguide.ent
+about_IMAGES =
+about_SOURCES = about.xml $(about_INCLUDES)
+about_IDMAPS = \
+ metadata/disaster-prevention.idmap \
+ metadata/excel-mysql.idmap \
+ metadata/mysql-client-programs.idmap \
+ metadata/userguide.idmap
+about.validpure: $(about_SOURCES)
+about.titles: $(about_SOURCES)
+about.useless: $(about_SOURCES)
+about.valid: $(about_SOURCES) $(about_IDMAPS)
+about.validwarn: $(about_SOURCES) $(about_IDMAPS)
+about-prepped.xml: $(about_SOURCES) $(about_IDMAPS)
+about-manprepped.xml: $(about_SOURCES) $(about_IDMAPS)
+about-remprepped.xml: $(about_SOURCES) $(about_IDMAPS)
+
basic_administration_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
@@ -100,11 +121,7 @@
userguide.ent
introduction_IMAGES =
introduction_SOURCES = introduction.xml $(introduction_INCLUDES)
-introduction_IDMAPS = \
- metadata/disaster-prevention.idmap \
- metadata/excel-mysql.idmap \
- metadata/mysql-client-programs.idmap \
- metadata/userguide.idmap
+introduction_IDMAPS =
introduction.validpure: $(introduction_SOURCES)
introduction.titles: $(introduction_SOURCES)
introduction.useless: $(introduction_SOURCES)
@@ -251,6 +268,7 @@
userguide_INCLUDES = \
../common/fixedchars.ent \
../refman-common/urls.ent \
+ about.xml \
all-entities.ent \
basic-administration.xml \
disaster-prevention.xml \
Added: trunk/userguide/about.xml
===================================================================
--- trunk/userguide/about.xml (rev 0)
+++ trunk/userguide/about.xml 2007-09-04 20:37:41 UTC (rev 7664)
Changed blocks: 1, Lines Added: 412, Lines Deleted: 0; 15436 bytes
@@ -0,0 +1,412 @@
+<?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-about-this-book">
+
+ <title>About This Book</title>
+
+ <section id="userguide-not-the-manual">
+
+ <title>This is <emphasis>Not</emphasis> the Manual</title>
+
+ <para>
+ On the MySQL documentation web page
+ (<ulink url="&base-url-docs;"/>) you'll find the various versions
+ of the MySQL manual. At the time of writing there are three
+ different versions, each one running to about 2,000 pages in PDF
+ format. These manuals are meant to be the definitive reference
+ books for each specific server version; they should provide the
+ answer to any question you have about any version of MySQL.
+ </para>
+
+ <para>
+ The manuals are an excellent resource but they can be very
+ intimidating for users who are new to MySQL, especially for those
+ who have no previous experience with a Relational Database
+ Management System (RDMS). Even for users familiar with other
+ RDMSs, the wealth of information contained in the manuals makes it
+ easy to lose sight of the forest for the trees. For this reason
+ the focus of the &userguide; is strictly circumscribed; as far as
+ possible, this book aims to be OS-neutral and MySQL
+ version-specific.
+ </para>
+
+ <para>
+ This book deals with MySQL version 5.0 [5.1 if it is GA] only.
+ Concentrating on one server version makes for greater simplicity
+ and using version 5.0 means we can take advantage of the improved
+ feature set of the newest production version.
+ </para>
+
+ <para>
+ MySQL's popularity is partly due to the fact that it is supported
+ on numerous operating systems (OSs). However, this also adds a
+ level of complexity to the manual — exactly the kind of
+ thing we aim to reduce. For this reason, as far as is possible,
+ this book ignores any OS-specific features of MySQL. For instance,
+ <literal>mysqlhotcopy</literal> is a very useful utility but it is
+ not supported under Windows or Mac OS X so will not be discussed
+ here. Concentrating on features common to all OSs removes one of
+ the distractions inherent in reading the MySQL manual.
+ </para>
+
+ <para>
+ In no way is this book meant to be a definitive treatment of MySQL
+ but therein lies its strength. It should speed up the process of
+ getting you up and running with MySQL. For those questions it
+ doesn't answer, see the manual.
+ </para>
+
+ <para>
+ MySQL is a flexible RDMS useful in many circumstances. At one end
+ of the spectrum it is suitable for enterprise applications and at
+ the other it can also be used for simple desktop applications.
+ Regardless of how you plan to use MySQL, the &userguide; should
+ prove to be a good introduction to MySQL.
+ </para>
+
+ </section>
+
+ <section id="userguide-target-audience">
+
+ <title>Target Audience</title>
+
+ <para>
+ When describing the nature of the &userguide; in
+ <xref linkend="userguide-not-the-manual"/> we hinted at the kinds
+ of readers that this book should appeal to; users new to databases
+ in general and users new to MySQL in particular.
+ </para>
+
+ <para>
+ It is also probably a fair assumption that many of our readers,
+ regardless of the OS they are using, will be more familiar working
+ within a GUI environment than from the command line. There's no
+ getting around the fact that being capable from the command line
+ is an advantage when using MySQL. The primary tool for interacting
+ with a MySQL server, <literal>mysql</literal>, is command-line
+ based.
+ </para>
+
+ <para>
+ Mastering MySQL from the command line will allow you to operate in
+ environments where there is no GUI, the majority of web servers
+ for example. Besides some command-line tools are unquestionably
+ superior. There's no quicker way of creating a database than
+ issuing the command, <userinput>mysqladmin create
+ <replaceable>db_name</replaceable></userinput>.
+ </para>
+
+ <para>
+ However, whenever possible we'll make use of MySQL Administrator
+ and MySQL Query Browser, open source MySQL GUI Tools. Creating
+ database objects is made especially easy using the Table Editor, a
+ feature of the Query Browser also common to other GUI Tools. By
+ pointing and clicking you can quickly build a table without
+ knowing anything about data definition language (DDL). Not only
+ will the table editor help you work more quickly, but it's a good
+ way to learn MySQL's implementation of SQL. Any alterations made
+ to a table using the graphical interface are shown as SQL
+ statements, making it easy to learn the appropriate SQL command.
+ </para>
+
+ </section>
+
+ <section id="userguide-want-your-help">
+
+ <title>We Want Your Help</title>
+
+ <para>
+ The idea for a &userguide; came about as a response to the
+ expressed needs of MySQL users and especially community comments
+ about the manuals. Find below some of those comments:
+ </para>
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ It can be hard to find information even when you
+ <emphasis>know</emphasis> that it is in the manual
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In some cases, you would expect to find information on one
+ page, but it's actually on another page
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Sometimes cross-references are missing or they are not
+ immediately obvious
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ It's hard to determine which information given in the manual
+ applies to your situation
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ New users, in particular, have difficulties finding their way
+ around the manual
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ More code examples are needed
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The manual is hard to navigate because it covers a variety of
+ server versions and a variety of OSs
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ <para>
+ We responded to the opinion that the reference manuals should be
+ version-specific by creating manuals specific to versions 4.1 and
+ earlier, version 5.0, version 5.1, and the beginnings of a 6.0
+ manual. You'll find them all
+ <ulink url="&base-url-docs;">here</ulink>.
+ </para>
+
+ <para>
+ Another initiative inspired by community requests is what we know
+ internally as <quote>dynamic docs</quote>. Instead of producing
+ content statically in one section of the manual, it is stored in
+ an XML <quote>database</quote> so that it can be sorted and
+ filtered for specific needs. Centralizing the information in one
+ file not only makes maintenance easier but means that we can
+ create custom documents and easily repeat content if necessary.
+ </para>
+
+ <para>
+ For example, the table of string functions shown
+ <ulink url="&base-url-docs;/refman/5.0/en/string-functions.html">here</ulink>
+ is created from such an XML <quote>database</quote>. Taking this
+ approach, makes the manuals easier to navigate and makes
+ information more accessible.
+ </para>
+
+ <para>
+ This technology has also been used to produce a number of the
+ appendixes in this book. For example, the tables of options for
+ the various MySQL utilities
+ (<xref
+ linkend="userguide-options-tables-utilities"/>)
+ and likewise the table of operators and functions
+ (<xref linkend="userguide-functions-operators"/>).
+ </para>
+
+ <para>
+ We've expended considerable effort in making the manuals more
+ readable and accessible. However, only so much can be done to
+ improve the manuals. A document that is meant to be comprehensive
+ and all-inclusive is always going to be intimidating to new users.
+ Clearly, making the manuals less comprehensive is not an
+ alternative; hence the need to create different document,
+ a &userguide;.
+ </para>
+
+ <para>
+ We've responded to your request to improve the manual
+ and now we would like you to respond to our request to
+ help create a &userguide; — after all, it was your
+ idea.
+ </para>
+
+ <para>
+ Part of the reason for the success of
+ open source projects is because
+ submissions come from a variety of sources.
+ Help improve MySQL documentation by making a contribution.
+ </para>
+
+ <para>
+ Contributors will receive credit for their submissions.
+ For an example attribution see
+ <xref linkend="userguide-mysql-client"/>.
+ <remark>[PL] We need to style an informaltable, role = "contributor"</remark>
+ </para>
+
+ <section id="userguide-contributions-content">
+
+ <title>Content of Contributions</title>
+
+ <para>
+ The table of contents (TOC) can serve as a guide to the topics
+ we would like to see covered in the &userguide;. Parts I through
+ III deal with introductory topics and later sections deal with
+ more advanced topics. Chapters or sections should integrate
+ closely with related subjects. Some sections will be shorter or
+ longer depending upon the nature of the topic.
+
+ <remark>
+ [PL] Check and change references
+ </remark>
+ </para>
+
+ <para>
+ We've tried to structure the &userguide; in a format that will
+ encourage a variety of submissions of different sizes at
+ differing levels of difficulty. Some sections have already been
+ completed by MySQL staff and can serve as examples of the kinds
+ of submissions we are seeking.
+ For example, <xref linkend="userguide-mysqldump-intro"/> could
+ serve as a template for a section on
+ <command>mysqlimport</command> and <xref linkend="excel-mysql"/>
+ could serve as a guide to <xref linkend="userguide-access-mysql"/>.
+ </para>
+
+ <para>
+ Depending upon your time and expertise you may wish to submit a
+ short, narrowly focused section on a specific introductory topic
+ or a complete chapter on something more advanced.
+ </para>
+
+ <para>
+ The TOC is meant as a guideline for possible submissions but you
+ needn't feel constrained by the chapters or sections listed
+ there. If you feel that a topic warrants inclusion but is not
+ included in the TOC, please let us know.
+ </para>
+
+ </section>
+
+ <section id="userguide-contributions-format">
+
+ <title>Format of Contributions</title>
+
+ <para>
+ The MySQL documentation team uses DocBook, an XML markup
+ language particularly suited to software documentation.
+ like HTML, it is a derivative of Standard Generalized Markup
+ Language (SGML). If you are familiar with HTML, especially XHTML
+ then the DocBook format will immediately seem
+ familiar. To find out more information see
+ <ulink url="http://docbook.org">DocBook</ulink>.
+
+ <remark>
+ [PL] promotion with O'Reilly?
+ </remark>
+ </para>
+
+ <para>
+ The MySQL documentation team uses DocBook because it can be
+ transformed into a variety of different output formats using XSL
+ style sheets. One source document can be used to generate HTML,
+ PDF, or CHM output for example, thereby eliminating the need to
+ maintain documentation in a variety of output formats. A
+ secondary reason for using DocBook is its structured approach to
+ documentation. Like any well formed XML document, DocBook imposes
+ a structure; subsections must appear within sections and
+ sections within chapters and so on. Because
+ DocBook is XML it can be written using any text editor though
+ you may prefer using an XML-specific editor.
+ </para>
+
+ <para>
+ Complete documentation of the tags and attributes used by
+ Docbook is available online at
+ <ulink url="http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html">
+ DocBook: The Definitive Guide</ulink>. TheMySQL documentation
+ team doesn't use all the tags supported by DocBook. The subset
+ of DocBook tags is found in the MySQL Style Guide. [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>
+ We would prefer to receive contributions in DocBook format but
+ understand that this is not always possible. If you wish to make
+ a contribution in a format other than DocBook please contact the
+ documentation team at <email>docs@stripped</email>.
+ </para>
+
+ </section>
+
+ <section id="userguide-contribution-checklist">
+
+ <title>Contribution Checklist</title>
+
+ <para>
+ If you do plan to make a contribution to the &userguide;, pay
+ special attention to the following sections:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <xref linkend="userguide-not-the-manual"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="userguide-target-audience"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="userguide-contributions-content"/>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <xref linkend="userguide-contributions-format"/>
+ </para>
+ </listitem>
+
+ </itemizedlist>
+
+ Familiarity with these sections is essential to determining an
+ appropriate topic at an appropriate level of complexity.
+ </para>
+
+ <para>
+ Additionally, make sure that you have read and understood
+ <xref to legal status of submissions>. Email
+ <email>docs@stripped</email> specifying <quote>&userguide;
+ Contribution</quote> as the subject line. This email
+ should contain a short biography and briefly describe what
+ you wish to write about.
+ </para>
+
+ <note>
+ <para>
+ Please do not make submissions before checking with the MySQL
+ documentation team; the TOC is subject to change and someone
+ may already be working on your chosen topic.
+ </para>
+ </note>
+
+ </section>
+
+ </section>
+
+<!--End About-->
+
+</chapter>
Modified: trunk/userguide/all-entities.ent
===================================================================
--- trunk/userguide/all-entities.ent 2007-09-04 18:34:11 UTC (rev 7663)
+++ trunk/userguide/all-entities.ent 2007-09-04 20:37:41 UTC (rev 7664)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 577 bytes
@@ -6,7 +6,7 @@
-->
<!ENTITY % fixedchars.entities SYSTEM "../common/fixedchars.ent">
<!ENTITY % urls.entities SYSTEM "../refman-common/urls.ent">
-<!ENTITY % userguide.entities SYSTEM "userguide.ent">
+<!ENTITY % userguide.entities SYSTEM "userguide.ent">
%fixedchars.entities;
%urls.entities;
%userguide.entities;
Modified: trunk/userguide/introduction.xml
===================================================================
--- trunk/userguide/introduction.xml 2007-09-04 18:34:11 UTC (rev 7663)
+++ trunk/userguide/introduction.xml 2007-09-04 20:37:41 UTC (rev 7664)
Changed blocks: 2, Lines Added: 36, Lines Deleted: 420; 16606 bytes
@@ -5,10 +5,12 @@
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
-<chapter id="introduction">
- <title>Introduction</title>
+<chapter>
+<title>Introduction</title>
+<!-- Start Intro -->
+
<section id="introduction-what-is-mysql">
<title>What is MySQL?</title>
@@ -65,472 +67,86 @@
</section>
- </section>
-
- <section>
-
- <title>MySQL Applications</title>
-
<section>
- <title>MySQL On the Web</title>
+ <title>Operating Systems Supported</title>
<para>
- phpMyAdmin - also refer to appendix
- </para>
+ touched briefly on this subject already
- </section>
-
- <section>
-
- <title>MySQL Enterprise Applications</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>MySQL Desktop Applications</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Main Features</title>
-
- <para></para>
-
- </section>
-
- </section>
-
-<!-- END WHAT IS MYSQL -->
-
-<!-- Start About this book -->
-
- <section>
-
- <title>About This Book</title>
-
- <section id="userguide-not-the-manual">
-
- <title>This is <emphasis>Not</emphasis> the Manual</title>
-
- <para>
- On the MySQL documentation web page
- (<ulink url="&base-url-docs;"/>) you'll find the various
- versions of the MySQL manual. At the time of writing there are
- three different versions, each one running to about 2,000 pages
- in PDF format. These manuals are meant to be the definitive
- reference books for each specific server version; they should
- provide the answer to any question you have about any version of
- MySQL.
+ <remark>
+ [PL]This section should probably move?
+ </remark>
</para>
- <para>
- The manuals are an excellent resource but they can be very
- intimidating for users who are new to MySQL, especially for
- those who have no previous experience with a Relational Database
- Management System (RDMS). Even for users familiar with other
- RDMSs, the wealth of information contained in the manuals makes
- it easy to lose sight of the forest for the trees. For this
- reason the focus of the &userguide; is strictly circumscribed;
- as far as possible, this book aims to be OS-neutral and MySQL
- version-specific.
- </para>
-
- <para>
- This book deals with MySQL version 5.0 [5.1 if it is GA] only.
- Concentrating on one server version makes for greater simplicity
- and using version 5.0 means we can take advantage of the
- improved feature set of the newest production version.
- </para>
-
- <para>
- MySQL's popularity is partly due to the fact that it is
- supported on numerous operating systems. However, this also adds
- a level of complexity to the manual — exactly the kind of
- thing we aim to reduce. For this reason, as far as is possible,
- this book ignores any OS-specific features of MySQL. For
- instance, <literal>mysqlhotcopy</literal> is a very useful
- utility but it is not supported under Windows or Mac OS X so
- will not be discussed here. Concentrating on features common to
- all OSs removes one of the distractions inherent in reading the
- MySQL manual.
- </para>
-
- <para>
- In no way is this book meant to be a definitive treatment of
- MySQL but therein lies its strength. It should speed up the
- process of getting you up and running with MySQL. For those
- questions it doesn't answer, see the manual.
- </para>
-
- <para>
- MySQL is a flexible RDMS useful in many circumstances. At one
- end of the spectrum it is suitable for enterprise applications
- and at the other it can also be used for simple desktop
- applications. Regardless of how you plan to use MySQL, the
- &userguide; should prove to be a good introduction to MySQL.
- </para>
-
- </section>
-
- <section id="userguide-target-audience">
-
- <title>Target Audience</title>
-
- <para>
- When describing the nature of the &userguide; in
- <xref linkend="userguide-not-the-manual"/> we hinted at the
- kinds of readers that this book should appeal to; users new to
- databases in general and users new to MySQL in particular.
- </para>
-
- <para>
- It is also probably a fair assumption that many of our readers,
- regardless of the OS they are using, will be more familiar
- working within a GUI environment than from the command line.
- There's no getting around the fact that being capable from the
- command line is an advantage when using MySQL. The primary tool
- for interacting with a MySQL server, <literal>mysql</literal>,
- is command-line based.
- </para>
-
- <para>
- Mastering MySQL from the command line will allow you to operate
- in environments where there is no GUI, the majority of web
- servers for example. Besides some command-line tools are
- unquestionably superior. There's no quicker way of creating a
- database than issuing the command, <userinput>mysqladmin create
- <replaceable>db_name</replaceable></userinput>.
- </para>
-
- <para>
- However, whenever possible we'll make use of MySQL Administrator
- and MySQL Query Browser, open source MySQL GUI Tools. Creating
- database objects is made especially easy using the Table Editor,
- a feature of the Query Browser also common to other GUI Tools.
- By pointing and clicking you can quickly build a table without
- knowing anything about data definition language (DDL). Not only
- will the table editor help you work more quickly, but it's a
- good way to learn MySQL's implementation of SQL. Any alterations
- made to a table using the graphical interface are shown as SQL
- statements, making it easy to learn the appropriate SQL command.
- </para>
-
- </section>
-
- <section id="userguide-external-submissions">
-
- <title>We Want Your Help</title>
-
- <para>
- The idea for a &userguide; came about as a response to the
- expressed needs of MySQL users and especially community comments
- about the manuals. Find below some of these comments:
- </para>
-
- <itemizedlist>
-
- <listitem>
- <para>
- It can be hard to find information even when you
- <emphasis>know</emphasis> that it is in the manual
- </para>
- </listitem>
-
- <listitem>
- <para>
- In some cases, you would expect to find information on one
- page, but it's actually on another page
- </para>
- </listitem>
-
- <listitem>
- <para>
- Sometimes cross-references are missing or they are not
- immediately obvious
- </para>
- </listitem>
-
- <listitem>
- <para>
- It's hard to determine which information given in the manual
- applies to your situation
- </para>
- </listitem>
-
- <listitem>
- <para>
- New users in particular can have difficulties especially
- with advanced topics
- </para>
- </listitem>
-
- <listitem>
- <para>
- More code examples are needed
- </para>
- </listitem>
-
- <listitem>
- <para>
- The manual is not operating system-specific
- </para>
- </listitem>
-
- </itemizedlist>
-
- <para></para>
-
- <para>
- In response to the general feeling that the Reference manuals
- should be version-specific A number of the issues discu in
- <xref linkend="userguide-not-the-manual"/>.
- </para>
-
- <para>
- You raised these issues and we responded by creating
- version-specific manuals. MySQL is seeking Community
- contributions to the &userguide;
- </para>
-
- <para>
- this doesn't mean that we have given up on some of the other
- issues raised -- dynamic docs
- </para>
-
- <para>
- A number of the appendixes the tables of options for the various
- MySQL utilities
- (<xref
- linkend="userguide-options-tables-utilities"/>)
- and likewise the table of operators and functions
- (<xref linkend="userguide-functions-operators"/>.
- </para>
-
<section>
- <title>Why Submit</title>
+ <title>Variations Between Operating Systems</title>
<para>
- attribution for an example see
- <xref linkend="userguide-mysql-client"/>.
+ In some circumstances, discussions of the differences between
+ OSs is inevitable; when talking about file
+ permissions for example. ...
</para>
- </section>
-
- <section id="userguide-submissions-content">
-
- <title>Content of Submissions</title>
-
<para>
- The table of contents (TOC) can serve as a guide to the topics
- we would like to see covered in the &userguide;. Parts I
- through III deal with introductory topics and later sections
- deal with more advanced topics. Chapters or sections should
- integrate closely with related subjects. Some sections will be
- shorter or longer depending upon the nature of the topic.
-
- <remark>
- [PL] Check and change references
- </remark>
+ localhost/127.0.0.1 different paths file names
</para>
<para>
- We've tried to structure the &userguide; in a format that will
- encourage a variety of submissions of different sizes at
- differing levels of difficulty. Some sections have already
- been completed by MySQL staff and can serve as examples.
+ autocompletion?
</para>
<para>
- For example, <xref linkend="userguide-mysqldump-intro"/> can serve
- as a template for a section on <command>mysqlimport</command> and
- <xref linkend="excel-mysql"/> could serve as a guide to
- <xref to Access to MySQL >.
+ GUI Tools implementation different by OS
</para>
<para>
- Depending upon your time and expertise you may wish to submit
- a short, narrowly focused section on a specific introductory
- topic or a complete chapter on something more advanced.
+ location and name of the configuration files
</para>
</section>
- <section id="userguide-submissions-format">
+ </section>
- <title>Format of Submissions</title>
+ </section>
- <para>
- The MySQL documentation team uses DocBook, an XML markup
- language particularly suited to software documentation which
- like HTML, is a derivative of Standard Generalized Markup
- Language (SGML). If you are familiar with HTML, especially
- XHTML then the <literal>DocBook</literal> format will
- immediately seem familiar. To find out more information see
- <ulink url="http://docbook.org">DocBook</ulink>.
+ <section>
- <remark>
- [PL] promotion with O'Reilly?
- </remark>
- </para>
+ <title>MySQL Applications</title>
- <para>
- The MySQL documentation team uses DocBook because it can be
- transformed into a variety of different output formats using
- XSL style sheets. One source document can be used to generate
- HTML, PDF, or CHM output for example, thereby eliminating the
- need to maintain documentation in a variety of output formats.
- A secondary reason for using DocBook is its structured
- approach to documentation. Like any well formed XML document
- DocBook imposes a structure; subsections must appear within
- sections and sections within chapters and so on.
- </para>
+ <section>
- <para>
- Complete documentation of the tags and attributes used by
- Docbook is available online at
- <ulink url="http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html">
- DocBook: The Definitive Guide</ulink>. TheMySQL documentation
- team doesn't use all the tags supported by DocBook. The subset
- of DocBook tags is found in the MySQL Style Guide. [Link to be
- provided shortly.] the MySQL documentation team has also
- prepared DocBook templates to assist you <xref> Because
- DocBook is XML it can be written using any text editor though
- you may prefer using an XML editor.
+ <title>MySQL On the Web</title>
- <remark>
- [PL] promotion with oXygen?
- </remark>
- </para>
+ <para>
+ phpMyAdmin - also refer to appendix
+ </para>
- <para>
- We would prefer to receive contributions in DocBook format but
- understand that this is not always possible. If you wish to
- make a contribution in a format other than DocBook please
- contact the email <email>docs@stripped</email> for more
- information.
- </para>
+ </section>
- </section>
+ <section>
- <section id="userguide-submission-checklist">
+ <title>MySQL Enterprise Applications</title>
- <title>Submission Checklist</title>
+ <para></para>
- <para>
- If you do plan to make a submission to the &userguide;, pay
- special attention to the following sections:
+ </section>
- <itemizedlist>
+ <section>
- <listitem>
- <para>
- <xref linkend="userguide-not-the-manual"/>
- </para>
- </listitem>
+ <title>MySQL Desktop Applications</title>
- <listitem>
- <para>
- <xref linkend="userguide-target-audience"/>
- </para>
- </listitem>
+ <para></para>
- <listitem>
- <para>
- <xref linkend="userguide-submissions-content"/>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <xref linkend="userguide-submissions-format"/>
- </para>
- </listitem>
-
- </itemizedlist>
-
- Familiarity with these sections is essential to determining an
- appropriate topic at an appropriate level of complexity.
- </para>
-
- <para>
- Additionally, make sure that you have read and understood
- <xref to legal status of submissions>. Email
- <email>docs@stripped</email> Please specify
- <quote>&userguide; Submission Suggestion</quote> as the
- subject line. This email should contain a brief description
- (circa 100 words) of your proposed topic and a short
- biography. Briefly describe what you would like to write about
- and any pertinent facts about yourself.
- </para>
-
- <note>
- <para>
- Please do not make submissions before checking with the
- MySQL documentation team. The TOC is subject to change and
- someone may already be working on your chosen topic.
- </para>
- </note>
-
- </section>
-
</section>
- </section>
-
- <section id="introduction-why-use-mysql">
-
- <title>Why Use MySQL?</title>
-
- <para></para>
-
- </section>
-
- <section>
-
- <title>Operating Systems Supported</title>
-
- <para>
- touched briefly on this subject already
-
- <remark>
- [PL]This section should probably move?
- </remark>
- </para>
-
<section>
- <title>Variations Between Operating Systems</title>
+ <title>Main Features</title>
- <para>
- In some circumstances, discussions of the differences between
- operating systems is inevitable; when talking about file
- permissions for example. ...
- </para>
+ <para></para>
- <para>
- localhost/127.0.0.1 different paths file names
- </para>
-
- <para>
- autocompletion?
- </para>
-
- <para>
- GUI Tools implementation different by OS
- </para>
-
- <para>
- location and name of the configuration files
- </para>
-
</section>
</section>
Modified: trunk/userguide/userguide.xml
===================================================================
--- trunk/userguide/userguide.xml 2007-09-04 18:34:11 UTC (rev 7663)
+++ trunk/userguide/userguide.xml 2007-09-04 20:37:41 UTC (rev 7664)
Changed blocks: 2, Lines Added: 6, Lines Deleted: 3; 985 bytes
@@ -14,7 +14,7 @@
<abstract>
<para>
- This is the MySQL User Guide.
+ This is the MySQL User Guide version &version;.
</para>
<para>
@@ -30,14 +30,17 @@
<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"/>
- <xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<!--Start Part I-->
<part label="I">
- <title>Getting Started</title>
+ <title>Getting Started</title>
+
+ <xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="installing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7664 - trunk/userguide | plavin | 4 Sep |
