Author: plavin
Date: 2008-02-21 16:42:40 +0100 (Thu, 21 Feb 2008)
New Revision: 9967
Log:
Remove references to DocBook, format of contributions etc
Modified:
trunk/userguide/about.xml
Modified: trunk/userguide/about.xml
===================================================================
--- trunk/userguide/about.xml 2008-02-21 15:36:00 UTC (rev 9966)
+++ trunk/userguide/about.xml 2008-02-21 15:42:40 UTC (rev 9967)
Changed blocks: 3, Lines Added: 1, Lines Deleted: 117; 5625 bytes
@@ -161,18 +161,6 @@
</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
@@ -182,26 +170,9 @@
<para>
The &userguide; is licensed under the GNU Free Documentation
License (GFDL). For a copy of this license see
- <xref linkend="gfdl"/>. 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.
+ <xref linkend="gfdl"/>.
</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>
- While we welcome any submissions, we reserve the right to
- accept or reject submissions as we see fit.
- </para>
- </note>
-
</section>
<section id="userguide-contributions-content">
@@ -248,93 +219,6 @@
</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
- see <ulink url="http://docbook.org">DocBook</ulink>.
- </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>. The MySQL documentation
- team doesn't use all the tags supported by DocBook. The subset
- of DocBook tags used by MySQL is found
- <ulink url="http://dev.mysql.com/doc/mysqldoc-guide/en/fg.html DocBook">here</ulink>.
- The MySQL documentation team has also prepared DocBook templates
- to help you get started. You'll find them <xref -here>.
- </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>
-
- <para>
- As far as writing styles and conventions are concerned please
- see
- <ulink url="http://dev.mysql.com/doc/mysqldoc-guide/en/sg.html" />.
- </para>
-
- <para>
- This publication is licenced under the GNU Free Documentation
- License (GFDL). Any submissions are subject to the conditions
- outlined in this licence. A copy is included in
- <xref linkend="gfdl"/>.
- </para>
-
- </section>
-
- <section id="where-find-user-guide">
-
- <title>Where to Find the &userguide; in DocBook Format</title>
-
- <para>
- You can find a link to the source tree for all the documentation
- at
- <ulink url="http://dev.mysql.com/tech-resources/sources.html"/>.
- This page also includes general instructions for checking out
- copies of the documentation. Using Subversion you can download
- the &userguide; from
- <ulink url="http://svn.mysql.com/svnpublic/mysqldoc/userguide"/>.
- You can also browse online at this URL. If you are unfamiliar
- with DocBook format, use existing chapters or sections as
- templates for your submissions. For an example of a complete
- chapter that uses most, if not all of the DocBook XML tags
- you'll need, see
- <ulink url="http://svn.mysql.com/svnpublic/mysqldoc/userguide/excel-mysql.xml"/>.
- Subversion is open-source, version control software available
- for Windows, Mac OS X, or various flavors of Linux and Unix.
- Find out more about it at
- <ulink url="http://subversion.tigris.org/"/>.
- </para>
-
- </section>
-
</section>
<!--End About-->
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r9967 - trunk/userguide | plavin | 21 Feb |
