example-tutorial/en_US example-tutorial2.xml,1.3,1.4

[Paul W. Frields (pfrields)]

Author: pfrields

Update of /cvs/docs/example-tutorial/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv32033

Modified Files:
	example-tutorial2.xml 
Log Message:
Everything from the Wiki list of technical terms is now included in
this tutorial.



Index: example-tutorial2.xml
===================================================================
RCS file: /cvs/docs/example-tutorial/en_US/example-tutorial2.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- example-tutorial2.xml	3 Feb 2007 21:51:40 -0000	1.3
+++ example-tutorial2.xml	3 Feb 2007 22:19:52 -0000	1.4
@@ -335,18 +335,22 @@
 <!-- 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. -->
+<!-- The first time a term of art or jargon appears, use the
+    <firstterm> element.  It is useful to define the term immediately
+    following or during its first use. -->
     <para>
       <application>ShmooMaker</application> is a utility for making
-      shmoos. Everyone loves shmoos due to their warm and cuddly nature.
+      <firstterm>shmoos</firstterm>. A shmoo is a lovable, globular
+      beastie with a penchant for turning himself into other objects.
+      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>
-
+<!-- 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>
         To install <application>ShmooMaker</application>, use
         <command>yum</command> to install the
@@ -376,11 +380,16 @@
         <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>[shmoo]
+      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.
+      You can use other elements inside a <screen>.  It is common to
+      denote what the user types with <userinput>, and the output with
+      <computeroutput>.  Avoid including shell prompts, since users may
+      not be using the same shell environment. -->
+<screen><userinput>cat /etc/shmoos</userinput>
+<computeroutput>[shmoo]
 size = medium
 lovable = True
 
@@ -405,20 +414,98 @@
       selection is a button, use <guibutton>.  If the selection is an
       icon, use <guiicon>.  For any other GUI elements, use the generic
       <guilabel>. -->
+<!-- Denote options for a command using the <option> element. -->
       <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.
+        <guimenuitem>ShmooMaker</guimenuitem> </menuchoice>.
+      </para>
+
+      <para>
+        If you want to run <application>ShmooMaker</application> as a
+        daemon process, use the command <command>shmoo-maker
+        <option>-d</option></command>.
+      </para>
+    </section>
+
+    <section id="sn-creating-shmoos">
+      <title>Creating Shmoos</title>
+
+      <para>
+        To create a shmoo, do the following:
+      </para>
+<!-- Any incremental series of steps should use the <procedure>
+      element as below. -->
+      <procedure>
+        <step>
+          <para>
+            Click the <guibutton>New</guibutton> button.
+          </para>
+        </step>
+        <step>
+          <para>
+            Select the desired shmoo from the list in the dialog.
+          </para>
+        </step>
+        <step>
+          <para>
+            When the shmoo appears, feed it and give it a hug.
+          </para>
+        </step>
+      </procedure>
+<!-- To indicate keystrokes, use the <keycap> element.  If your
+      keystroke includes more than one key, use the <keycombo> element
+      as shown below.  The proper symbols for joining the <keycap>
+      contents are automatically added by the DocBook stylesheets when
+      rendered. -->
+      <para>
+        To put away your shmoo for safe-keeping, hit
+        <keycombo><keycap>Ctrl</keycap><keycap>Q</keycap>
+        </keycombo>
+        .
+      </para>
+<!-- You can, and should, mark important terms for indexing.  The
+      FDP toolchain will allow you to automatically generate an index
+      for your document at render time.  Use the <primary> and
+      <secondary> elements consistently to organize your index
+      topically.  The <secondary> element is not required. -->
+<!-- The <itemizedlist> element is useful for lists where order is
+      not important.  Although there is an <orderedlist> element, make
+      sure you don't use it instead of <procedure> if a <procedure> is
+      more appropriate. -->
+      <para>
+        Shmoos love the following kinds of food:
       </para>
+      <indexterm>
+        <primary>shmoo</primary>
+        <secondary>feeding</secondary>
+      </indexterm>
+      <itemizedlist>
+        <listitem>
+          <para>
+            Candied yams
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Marshmallows
+          </para>
+        </listitem>
+        <listitem>
+          <para>
+            Gummi bears
+          </para>
+        </listitem>
+      </itemizedlist>
     </section>
   </section>
 
 <!-- And now the closing tag for the whole article, which ends the -->
 
 <!-- actual document. -->
+
+  <index />
 </article>
 
 <!-- The final comment block below is a special section used for the GNU -->