Author: pfrields
Update of /cvs/docs/example-tutorial/en In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv7878/en
Modified Files: entities.ent entities.xml example-tutorial.xml Log Message: 0.14.2 - move per-doc entities, license as OPL, and include system entity (snippet)
Index: entities.ent =================================================================== RCS file: /cvs/docs/example-tutorial/en/entities.ent,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- entities.ent 2 Mar 2006 02:19:53 -0000 1.1 +++ entities.ent 2 Mar 2006 13:04:15 -0000 1.2 @@ -7,5 +7,10 @@ <!-- Group: Example Tutorial Entities -->
<!ENTITY LOCAL-ENT "Per-document Entity" > <!-- A per-document entity --> + <!ENTITY DOCNAME "example-tutorial" > <!-- Should match the name of this module --> + <!ENTITY DOCVERSION "0.14.2" > <!-- Last revision number, bump when you change the doc --> + <!ENTITY DOCDATE "2006-03-02" > <!-- Last revision date, format YYYY-MM-DD --> + <!ENTITY DOCID "&DOCNAME;-&DOCVERSION; (&DOCDATE;)" > <!-- Same for every document --> + <!ENTITY BUG-NUM "000000" > <!-- This entity is used only in the draft stage to reference RFE in Bugzilla for some docs -->
Index: entities.xml =================================================================== RCS file: /cvs/docs/example-tutorial/en/entities.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- entities.xml 2 Mar 2006 02:19:53 -0000 1.1 +++ entities.xml 2 Mar 2006 13:04:15 -0000 1.2 @@ -1,14 +1,37 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> + <!DOCTYPE entities SYSTEM "../../docs-common/common/entities/entities.dtd">
<entities> - <title> - These entities are absolutely essential in this document. - </title> + <title>These entities are absolutely essential in this document.</title> <group name="Example Tutorial Entities"> <entity name="LOCAL-ENT"> <comment>A per-document entity</comment> - <text><wordasword>Per-document Entity</wordasword></text> + <text><wordasword>Per-document Entity</wordasword> + </text> + </entity> + <entity name="DOCNAME"> + <comment>Should match the name of this module</comment> + <text>example-tutorial</text> + </entity> + <entity name="DOCVERSION"> + <comment>Last revision number, bump when you change the doc</comment> + <text>0.14.2</text> + </entity> + <entity name="DOCDATE"> + <comment>Last revision date, format YYYY-MM-DD</comment> + <text>2006-03-02</text> + </entity> + <entity name="DOCID"> + <comment>Same for every document</comment> + <text> + <use entity="DOCNAME"/>-<use entity="DOCVERSION"/> (<use + entity="DOCDATE"/>)</text> + </entity> + <entity name="BUG-NUM"> + <comment>This entity is used only in the draft stage to reference RFE in + Bugzilla for some docs</comment> + <text>000000</text> </entity> </group> </entities>
Index: example-tutorial.xml =================================================================== RCS file: /cvs/docs/example-tutorial/en/example-tutorial.xml,v retrieving revision 1.7 retrieving revision 1.8 diff -u -r1.7 -r1.8 --- example-tutorial.xml 2 Mar 2006 02:19:53 -0000 1.7 +++ example-tutorial.xml 2 Mar 2006 13:04:15 -0000 1.8 @@ -1,4 +1,5 @@ <!-- $Id: --> + <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
@@ -8,24 +9,17 @@ <!ENTITY % DOCUMENT-ENTITIES SYSTEM "../entities.ent"> %DOCUMENT-ENTITIES;
-<!ENTITY DOCNAME "example-tutorial"> -<!ENTITY DOCVERSION "0.14.1"> <!-- change version here --> -<!ENTITY DOCDATE "2006-01-21"> <!-- change revision date here --> -<!ENTITY DOCID "&DOCNAME;-&DOCVERSION; (&DOCDATE;)"> -<!ENTITY BUG-NUM "000000"> <!-- use this only while in draft stage --> - ]> -<article id="example-tutorial">
+<article id="example-tutorial"> <xi:include href="fdp-info.xml" xmlns:xi="http://www.w3.org/2001/XInclude%22%3E xi:fallbackWHERE IS MY FDP-INFO, DUDE</xi:fallback> </xi:include>
<para> - This phrase uses the local entity &LOCAL-ENT;. + This phrase uses the local entity &LOCAL-ENT;. </para>
- <section id="sn-some-section"> <title>Some Section</title> <indexterm> @@ -56,13 +50,13 @@ Example of an admonition. </para> </warning> - + &BUG-REPORTING; <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> +<screen> <userinput><command>rpm -ivh <replaceable>pkgname</replaceable>-<replaceable>version</replaceable>.<replaceable>arch</replaceable>.rpm</command> </userinput> </screen> @@ -76,7 +70,7 @@ <command>computeroutput</command> tags, as in the following sample. </para> - <screen> +<screen> <userinput><command>grep snmptrap /etc/services</command> </userinput> <computeroutput>snmptrap 162/udp snmp-trap # Traps for SNMP</computeroutput> @@ -98,7 +92,7 @@
<section> <title>Callout Example</title> - <programlisting id="pl-callout"> +<programlisting id="pl-callout"> Line 1 <co id="pl-callout-L1"/> Line 2 Line 3