Author: shinz
Date: 2007-04-17 13:55:04 +0200 (Tue, 17 Apr 2007)
New Revision: 5917
Log:
Added proto doc for the user guide
Added:
trunk/proto-doc/proto-userguide-chapter.xml
Added: trunk/proto-doc/proto-userguide-chapter.xml
===================================================================
--- trunk/proto-doc/proto-userguide-chapter.xml (rev 0)
+++ trunk/proto-doc/proto-userguide-chapter.xml 2007-04-17 11:55:04 UTC (rev 5917)
Changed blocks: 1, Lines Added: 165, Lines Deleted: 0; 3978 bytes
@@ -0,0 +1,165 @@
+<?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 % fixedchars.entities SYSTEM "../common/fixedchars.ent">
+ %fixedchars.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>
+ 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 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>
+
+ <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>
+
+ </section>
+
+</chapter>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5917 - trunk/proto-doc | stefan | 17 Apr |
