example-tutorial/en_US example-tutorial2.xml,1.3,1.4
by fedora-docs-commits@redhat.com
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 -->
17 years, 3 months
example-tutorial/en_US example-tutorial2.xml,1.2,1.3
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/example-tutorial/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28512
Modified Files:
example-tutorial2.xml
Log Message:
Let's remove this CDATA stuff since it's only confusing to the novices.
Index: example-tutorial2.xml
===================================================================
RCS file: /cvs/docs/example-tutorial/en_US/example-tutorial2.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- example-tutorial2.xml 3 Feb 2007 21:50:49 -0000 1.2
+++ example-tutorial2.xml 3 Feb 2007 21:51:40 -0000 1.3
@@ -380,12 +380,12 @@
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]
+<screen><computeroutput>[shmoo]
size = medium
lovable = True
[add-ons]
-intelligibility = 0]]></computeroutput></screen>
+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. -->
17 years, 3 months
example-tutorial/en_US example-tutorial2.xml,1.1,1.2
by fedora-docs-commits@redhat.com
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. -->
17 years, 3 months