fedora-docs/example-tutorial example-tutorial-en.xml,1.10,1.11

Paul W. Frields (pfrields) fedora-extras-commits at redhat.com
Fri Apr 22 16:35:34 UTC 2005


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

Modified Files:
	example-tutorial-en.xml 
Log Message:
A few updates to example-tutorial to test checking


Index: example-tutorial-en.xml
===================================================================
RCS file: /cvs/docs/fedora-docs/example-tutorial/example-tutorial-en.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- example-tutorial-en.xml	13 Aug 2004 15:51:13 -0000	1.10
+++ example-tutorial-en.xml	22 Apr 2005 16:35:32 -0000	1.11
@@ -1,10 +1,11 @@
+<!-- $Id: -->
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 
 <!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml">
 %FEDORA-ENTITIES-EN;
 
-<!ENTITY BOOKID "example-tutorial-0.1 (2003-07-07)"> <!-- change version of manual and date here -->
+<!ENTITY BOOKID "example-tutorial-0.12 (2003-08-20)"> <!-- change version of manual and date here -->
 
 <!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml">
 
@@ -23,11 +24,16 @@
 	<surname>Fox</surname>
 	<firstname>Tammy</firstname>
       </author>
+      <editor>
+	<surname>Frields</surname>
+	<firstname>Paul</firstname>
+	<othername role="mi">W.</othername>
+      </editor>
     </authorgroup>
     &LEGALNOTICE;
   </articleinfo>
 
-  <section id="some-section">
+  <section id="sn-some-section">
     <title>Some Section</title>
 
     <indexterm>
@@ -35,7 +41,14 @@
     </indexterm>
 
     <para>
-      This is an example section. You can also use sect1, sect2, etc.
+      This is an example section. You can also use sect1, sect2, etc., but those
+      tags will make sections less modular — that is, harder to relocate
+      without changing a lot of other markup.
+    </para>
+    <para>
+      Keep text within the <command>title</command> tags on the same line as the
+      tags. Nesting the title on a separate line from the enclosing tags results
+      in extra spaces in HTML rendering.
     </para>
 
     <warning>
@@ -45,6 +58,41 @@
       </para>
     </warning>
 
+    <para>
+      This paragraph illustrates the use of command syntax to accomplish a
+      task. Note that specific filenames denoting versions should be
+      avoided. To install any RPM package, use the following syntax:
+    </para>
+<screen>
+<userinput><command>rpm -ivh <replaceable>pkgname</replaceable>-<replaceable>version</replaceable>.<replaceable>arch</replaceable>.rpm</command></userinput>
+</screen>
+    <para>
+      Notice that the <command>screen</command> section is entirely
+      left-justified with no preceding indent. This is necessary to ensure
+      proper rendering in PDFs. Also notice that the entire
+      <command>command</command> has been surrounded by
+      <command>userinput</command> since the user types this
+      command. Computer output would be enclosed in
+      <command>computeroutput</command> tags, as in the following
+      sample.
+    </para>
+<screen>
+<userinput><command>grep snmptrap /etc/services</command></userinput>
+<computeroutput>snmptrap        162/udp         snmp-trap       # Traps for SNMP</computeroutput>
+</screen>
+    <para>
+      Lines should be broken <emphasis>exactly</emphasis> as they are
+      on-screen. Also, note that spaces inside <command>screen</command> tags
+      are automatically treated as non-breaking.
+    </para>
+    <tip>
+      <title>Fill modes and <command>screen</command> tags</title>
+      <para>
+	Using automatic or manual fill commands in Emacs/PSGML will sometimes
+	mangle <command>screen</command> sections. Use care when performing fill
+	operations, and check the results.
+      </para>
+    </tip>
   </section>
 
 <index id="generated-index"></index>




More information about the fedora-extras-commits mailing list