Author: pfrields
Update of /cvs/docs/example-tutorial/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28476
Modified Files:
example-tutorial2.xml
Log Message:
Some additional element guidance is now included. This is still a WIP.
Index: example-tutorial2.xml
===================================================================
RCS file: /cvs/docs/example-tutorial/en_US/example-tutorial2.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- example-tutorial2.xml 7 Dec 2006 03:07:15 -0000 1.1
+++ example-tutorial2.xml 3 Feb 2007 21:50:49 -0000 1.2
@@ -302,9 +302,9 @@
<!-- element. -->
- <section id="sn-some-section">
+ <section id="sn-small-section">
<!-- You should give every section in your document a title. -->
- <title>Some Section</title>
+ <title>A Small Section</title>
<!-- If you want to mark content in your document for indexing,
simply place an "indexterm" element prior to the content to be
indexed. To include multiple index entries pointing to the
@@ -327,6 +327,95 @@
</para>
</section>
+<!-- The next section demonstrates the use of some standard DocBook -->
+
+<!-- elements which appear frequently in our documentation. -->
+
+ <section id="sn-about-ShmooMaker">
+<!-- A program with a graphical interface, or an application suite,
+ uses the <application> element. -->
+ <title>About <application>ShmooMaker</application></title>
+<!-- Use the <package> element for RPMs. When referring to a FILE
+ that is an RPM, use <filename> instead. For programs that are not
+ graphical, use the <command> element. -->
+ <para>
+ <application>ShmooMaker</application> is a utility for making
+ shmoos. Everyone loves shmoos due to their warm and cuddly nature.
+ </para>
+<!-- You can nest sections as appropriate to organize your
+ document. -->
+ <section id="sn-installing-ShmooMaker">
+ <title>Installing
<application>ShmooMaker</application></title>
+
+ <para>
+ To install <application>ShmooMaker</application>, use
+ <command>yum</command> to install the
+ <package>ShmooMaker</package>
+ RPM package:
+ </para>
+<!-- To demonstrate a command outside a sentence, or to show a
+ series of input or output lines, use the <screen> element.
+ IMPORTANT: All the text in a <screen> element is duplicated
+ verbatim when rendered to other formats, including line breaks and
+ initial white space. -->
+<screen><command>yum install ShmooMaker</command></screen>
+ </section>
+
+ <section id="sn-configuring-ShmooMaker">
+ <title>Configuring
<application>ShmooMaker</application></title>
+
+ <para>
+ <application>ShmooMaker</application> creates a basic system
+ configuration template for shmoos in the
+ <filename
+ class="directory">/etc/</filename> folder. The
+ configuration file is called <filename>/etc/shmoos</filename>.
+ You can add your own user-specific shmoo information by creating
+ a file in your home directory called
+ <filename>~/.shmoos</filename>. The
+ <filename>/etc/shmoos</filename> file resembles the following:
+ </para>
+<!-- Note again how the text in a <screen> element is rendered
+ exactly as it is included here. The second and following lines are
+ flush-left so that extra space does not appear in the document
+ output. If you use auto-indenting commands in your editor, be
+ careful that they do not improperly reformat the <screen> sections. -->
+<screen><computeroutput><![CDATA[[shmoo]
+size = medium
+lovable = True
+
+[add-ons]
+intelligibility = 0]]></computeroutput></screen>
+<!-- Use the <systemitem> element to mark user and group names,
+ services, daemons, and other items related to a running operating
+ system. -->
+ <para>
+ To edit the system configuration template, use the
+ <systemitem class="username">root</systemitem> account.
+ </para>
+ </section>
+
+ <section id="sn-using-ShmooMaker">
+ <title>Using <application>ShmooMaker</application></title>
+<!-- To denote GUI menu selections, use the <menuchoice> element
+ and the sub-elements <guimenu>, <guisubmenu>, and <guimenuitem>.
+ The <guimenu> element is the top-level menu label, followed
+ optionally by one or more <guisubmenu> elements as needed. The
+ terminal choice by the user is marked with <guimenuitem>. If the
+ selection is a button, use <guibutton>. If the selection is an
+ icon, use <guiicon>. For any other GUI elements, use the generic
+ <guilabel>. -->
+ <para>
+ To run <application>ShmooMaker</application>, select it from the
+ GUI menu under <menuchoice> <guimenu>Applications</guimenu>
+ <guisubmenu>Entertainment</guisubmenu>
+ <guimenuitem>ShmooMaker</guimenuitem> </menuchoice>. When the
+ main <application>ShmooMaker</application> dialog appears, click
+ the <guibutton>New</guibutton> button to create a new shmoo.
+ </para>
+ </section>
+ </section>
+
<!-- And now the closing tag for the whole article, which ends the -->
<!-- actual document. -->
Show replies by date