example-tutorial/en_US doc-entities.ent, NONE, 1.1 doc-entities.xml, NONE, 1.1 example-tutorial.xml, NONE, 1.1 para.xml, NONE, 1.1

Thu Mar 2 22:33:42 UTC 2006

Author: jtr

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

Added Files:
	doc-entities.ent doc-entities.xml example-tutorial.xml 
	para.xml 
Log Message:
Change to use the proper "en_US" locale instead of the bogus "en"
random string of characters.

--- NEW FILE doc-entities.ent ---
<!-- Group: Automatic Entities -->

  <!-- 
    These entities are absolutely essential in this document.
   -->

  <!-- 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 -->

--- NEW FILE doc-entities.xml ---
<?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>
  <group name="Example Tutorial Entities">
    <entity name="LOCAL-ENT">
      <comment>A per-document entity</comment>
      <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>

--- NEW FILE example-tutorial.xml ---
<!-- $Id: -->

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

 <!ENTITY % FEDORA-ENTITIES SYSTEM "../fdp-entities.ent">
%FEDORA-ENTITIES;

<!ENTITY % DOCUMENT-ENTITIES SYSTEM "../doc-entities.ent">
%DOCUMENT-ENTITIES;

]>

<article id="example-tutorial">
  <xi:include href="fdp-info.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
    <xi:fallback>WHERE IS MY FDP-INFO, DUDE</xi:fallback>
  </xi:include>

  <para>
    This phrase uses the local entity &LOCAL-ENT;.
  </para>

  <section id="sn-some-section">
    <title>Some Section</title>
    <indexterm>
      <primary>Index term</primary>
    </indexterm>
    <para>
      This is an example section. You should not use sect1, sect2, etc.,
      since those tags will make sections less modular, i.e., harder to
      relocate without changing a lot of other markup.
    </para>
    <xi:include href="para.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>
        <para>
          Could not find the <filename>para-en.xml</filename> file
        </para>
      </xi:fallback>
    </xi:include>
    <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>
      <title>Warning</title>

      <para>
        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>
<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>

  <section>
    <title>Callout Example</title>
<programlisting id="pl-callout">
Line 1 <co id="pl-callout-L1"/>
Line 2
Line 3
Line 4 <co id="pl-callout-L4"/>
</programlisting>
    <calloutlist>
      <callout arearefs="pl-callout-L1">
        <para>
          Here is a callout.
        </para>
      </callout>
      <callout arearefs="pl-callout-L4">
        <para>
          The second callout.
        </para>
      </callout>
    </calloutlist>
  </section>

  <section>
    <title>Deeply nested sections</title>

    <para>
      Early to bed, early to rise
    </para>

    <section>
      <title>Second Level</title>

      <para>
        Is the curse of the working class
      </para>

      <section>
        <title>Third Level</title>

        <para>
          He who can, does
        </para>

        <section>
          <title>Fourth Level</title>

          <para>
            He who cannot, manages.
          </para>
        </section>
      </section>
    </section>
  </section>

  <section id="sn-procedure-test">
    <title>Procedure Test</title>
    <procedure>
      <step>
        <para>
          First step
        </para>
      </step>
      <step>
        <para>
          Second step
        </para>
      </step>
      <step>
        <para>
          Third step
        </para>
      </step>
    </procedure>
  </section>

  <index id="generated-index"></index>
</article>

<!--
Local variables:
mode: xml
End:
-->

--- NEW FILE para.xml ---
<!-- $Id: -->

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

 <!ENTITY BOILERPLATE "This header makes editing XML easier" >

]>

<para>
  This paragraph was obtained via an
  <wordasword>&lt;xi:include&gt;</wordasword> element, just for an
  example.
</para>