Author: shinz
Date: 2007-04-17 15:38:47 +0200 (Tue, 17 Apr 2007)
New Revision: 5919
Log:
Amended proto doc for the user guide
Modified:
trunk/proto-doc/proto-userguide-chapter.xml
Modified: trunk/proto-doc/proto-userguide-chapter.xml
===================================================================
--- trunk/proto-doc/proto-userguide-chapter.xml 2007-04-17 11:56:26 UTC (rev 5918)
+++ trunk/proto-doc/proto-userguide-chapter.xml 2007-04-17 13:38:47 UTC (rev 5919)
Changed blocks: 4, Lines Added: 70, Lines Deleted: 0; 3176 bytes
@@ -65,6 +65,38 @@
<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>
@@ -78,6 +110,12 @@
<listitem>
<para>
+ This is an <email>email address</email>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
This is a <function>function</function>
</para>
</listitem>
@@ -102,6 +140,17 @@
</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>
@@ -160,6 +209,27 @@
</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>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5919 - trunk/proto-doc | stefan | 17 Apr |
