Author: plavin
Date: 2007-09-12 15:17:37 +0200 (Wed, 12 Sep 2007)
New Revision: 7804
Log:
Begin changes to TOC as suggested by Stefan
Modified:
trunk/userguide/about.xml
trunk/userguide/installing.xml
trunk/userguide/php-pdo.xml
Modified: trunk/userguide/about.xml
===================================================================
--- trunk/userguide/about.xml 2007-09-12 12:04:48 UTC (rev 7803)
+++ trunk/userguide/about.xml 2007-09-12 13:17:37 UTC (rev 7804)
Changed blocks: 5, Lines Added: 75, Lines Deleted: 71; 6276 bytes
@@ -243,7 +243,76 @@
For an example attribution see
<xref linkend="userguide-mysql-client"/>.
<remark>[PL] We need to style an informaltable, role = "contributor"</remark>
- </para>
+ </para>
+
+ <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>.
+ <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 what
+ you wish to write about.
+ </para>
+
+ <note>
+ <para>
+ To avoid disappointment,
+ please do not write contributions before checking with the MySQL
+ documentation team; the TOC is subject to change and someone
+ may already be working on your chosen topic.
+ </para>
+
+ <para>
+ <remark>MySQL reserves the right to reject blah blah</remark>
+ </para>
+ </note>
+
+ </section>
<section id="userguide-contributions-content">
@@ -264,7 +333,7 @@
<para>
We've tried to structure the &userguide; in a format that will
- encourage a variety of submissions of different sizes at
+ encourage a variety of submissions of different lengths 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.
@@ -299,7 +368,7 @@
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
+ familiar. To find out more see
<ulink url="http://docbook.org">DocBook</ulink>.
<remark>
@@ -325,7 +394,7 @@
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
+ DocBook: The Definitive Guide</ulink>. The MySQL documentation
team doesn't use all the tags supported by DocBook. The subset
of DocBook tags is found in the MySQL DocBook Markup Guide. [Link to be
provided shortly.] The MySQL documentation team has also
@@ -345,80 +414,15 @@
</para>
<para>
- AS far as writing styles and conventions are concerned
+ As far as writing styles and conventions are concerned
please see the MySQL Style Guide. [Link to be
provided shortly.]
</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>.
- <remark>[PL] still need to make the Docs
- CLA (contributor license agreement) available on MySQL Forge.</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 what
- you wish to write about.
- </para>
-
- <note>
- <para>
- To avoid disappointment,
- please do not write contributions before checking with the MySQL
- documentation team; the TOC is subject to change and someone
- may already be working on your chosen topic.
- </para>
-
- <para>
- <remark>MySQL reserves the right to reject blah blah</remark>
- </para>
- </note>
-
- </section>
-
</section>
<!--End About-->
Modified: trunk/userguide/installing.xml
===================================================================
--- trunk/userguide/installing.xml 2007-09-12 12:04:48 UTC (rev 7803)
+++ trunk/userguide/installing.xml 2007-09-12 13:17:37 UTC (rev 7804)
Changed blocks: 3, Lines Added: 11, Lines Deleted: 24; 1222 bytes
@@ -93,33 +93,12 @@
<section id="installing-installation-windows">
- <title>Installing MySQL on Windows</title>
+ <title>Installing MySQL on <operating system></title>
<para></para>
</section>
-<!-- END WINDOWS -->
-
- <section id="installing-installation-linux">
-
- <title>Installing MySQL on Linux</title>
-
- <para></para>
-
- </section>
-
-<!-- END LINUX -->
-
- <section id="installing-installation-mac">
-
- <title>Installing MySQL on Mac</title>
-
- <para></para>
-
- </section>
-
-<!-- END MAC -->
<section>
<title>Checklist If Installer/RPM Not Used</title>
@@ -170,8 +149,7 @@
<!--gui tools-->
<section>
- <title>Using GUI Tools</title>
-
+ <title>Using GUI Tools</title>
<para></para>
@@ -185,6 +163,15 @@
</section>
+ <section>
+
+ <title>MySQL Query Browser</title>
+
+ <para></para>
+
+ </section>
+
+
<!--end gui tools-->
</chapter>
Modified: trunk/userguide/php-pdo.xml
===================================================================
--- trunk/userguide/php-pdo.xml 2007-09-12 12:04:48 UTC (rev 7803)
+++ trunk/userguide/php-pdo.xml 2007-09-12 13:17:37 UTC (rev 7804)
Changed blocks: 3, Lines Added: 6, Lines Deleted: 10; 1487 bytes
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % all.entities SYSTEM "../refman-common/all-entities.ent">
%all.entities;
]>
-<chapter id="php-pdo">
+<article id="php-pdo">
<title>Using MySQL with PDO</title>
@@ -121,9 +121,9 @@
<para>
The attached compressed file contains all the code and preserves
- the required directory structure. [See the end of the article for
- a link.] Any user-defined classes are found in the
- <filename>classes</filename> directory and XML files are found in
+ the required directory structure. Find that file
+ <ulink url="code.tar.gz">here</ulink>. Any user-defined classes are
+ found in the <filename>classes</filename> directory and XML files are found in
the <filename>xml</filename> directory. The PHP scripts are found
at the root directory.
</para>
@@ -803,11 +803,7 @@
the same database.
</para>
- <para>
- [Find the code <ulink url="code.tar.gz">here</ulink>. ]
- </para>
-
</section>
-</chapter>
+</article>
<!-- END PHP-PDO CHAPTER -->
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r7804 - trunk/userguide | plavin | 12 Sep |
