old-www/authors/template/Sample-HOWTO.xml

<?xml version="1.0" encoding="ISO-8859-1"?>

<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
     "http://docbook.org/xml/4.2/docbookx.dtd" []>

<article>

  <articleinfo>

    <!-- Use "HOWTO", "mini HOWTO", "FAQ" in title, if appropriate -->
    <title>Sample XML HOWTO</title>

    <author>
       <firstname>your_firstname</firstname>
       <surname>your_surname</surname>
       <affiliation>
          <!-- Valid email...spamblock/scramble if so desired -->
          <address><email>xxx@xxx.xxx</email></address>
       </affiliation>
     </author>

     <!-- All dates specified in ISO "YYYY-MM-DD" format -->
     <pubdate>2003-12-01</pubdate>

     <!-- Most recent revision goes at the top; list in descending order -->
     <revhistory>
       <revision>
          <revnumber>1.0</revnumber>
          <date>2003-12-01</date>
          <authorinitials>xx</authorinitials>
          <revremark>first official release</revremark>
       </revision>
       <revision>
          <revnumber>0.9</revnumber>
          <date>2003-11-01</date>
          <authorinitials>xx</authorinitials>
          <revremark>first draft</revremark>
       </revision>
     </revhistory>

     <!-- Provide a good abstract; a couple of sentences is sufficient -->
     <abstract>
        <para>
         This is a sample DocBook XML HOWTO which has been
         constructed to serve as a document template.
        </para>
     </abstract>

  </articleinfo>


<!-- Content follows...include introduction, license information, feedback -->

<sect1 id="intro">
  <title>Introduction</title>

  <para>
   Provide a good overview and anything else you may think is needed in
   this area. Looking at other HOWTOs may assist in providing ideas.
  </para>

  <!-- Legal Sections -->
  <sect2 id="copyright">
    <title>Copyright and License</title>

    <!-- The LDP recommends, but doesn't require, the GFDL --> 
    <para>
     This document, <emphasis>Sample XML HOWTO</emphasis>,
     is copyrighted (c) 2002 by <emphasis>author_name</emphasis>.
     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation
     License, Version 1.1 or any later version published
     by the Free Software Foundation; with no Invariant Sections,
     with no Front-Cover Texts, and with no Back-Cover Texts.
     A copy of the license is available at
     <ulink url="http://www.gnu.org/copyleft/fdl.html">
     http://www.gnu.org/copyleft/fdl.html</ulink>.
    </para>

    <para>
     Linux is a registered trademark of Linus Torvalds.
    </para>
  </sect2>

  <sect2 id="disclaimer">
    <title>Disclaimer</title>

    <para>
     No liability for the contents of this document can be accepted.
     Use the concepts, examples and information at your own risk.
     There may be errors and inaccuracies, that could be damaging to
     your system.  Proceed with caution, and although this is highly
     unlikely, the author(s) do not take any responsibility.
    </para>

    <para>
     All copyrights are held by their by their respective owners,
     unless specifically noted otherwise.  Use of a term in this
     document should not be regarded as affecting the validity of any
     trademark or service mark.  Naming of particular products or
     brands should not be seen as endorsements.
    </para>
  </sect2>

  <!-- Give credit where credit is due...very important -->
  <sect2 id="credits">
    <title>Credits / Contributors</title>

    <para>
     In this document, I have the pleasure of acknowledging:
    </para>

    <!-- Please scramble addresses; help prevent spam/email harvesting -->
    <itemizedlist>
      <listitem> 
        <para>Individual 1 <email>someone1 (at) somewhere.org</email></para>
      </listitem>
      <listitem> 
        <para>Individual 2 <email>someone2 (at) somewhere.org</email></para>
      </listitem>
    </itemizedlist>
  </sect2>

  <!-- Feedback -->
  <sect2 id="feedback">
    <title>Feedback</title>

    <para>
     Feedback is most certainly welcome for this document. Send
     your additions, comments and criticisms to the following
     email address : <email>xxx@xxx.xxx</email>.
    </para>
  </sect2>

  <!-- Translations -->
  <sect2 id="translations">
    <title>Translations</title>

    <para>
     Pointers to available translations are nice.
     Also your translators tend to give very important inputs.
    </para>

    <itemizedlist>
      <listitem>
        <para>
         <ulink url="http://some_site.org/">French Translation</ulink>
         provided by Individual <email>someone (at) somewhere.fr</email>
        </para>
      </listitem>
      <listitem>
        <para>
         <ulink url="http://some_site.org/">German Translation</ulink>
         provided by Individual <email>someone (at) somewhere.de</email>
        </para>
      </listitem>
    </itemizedlist>
  </sect2>

</sect1>

<!-- 

     The rest of the document follows. This is where your
     subject-specific content goes. A logical reading
     progression should be present - installation, setup,
     configuration, using, advanced topics, etc.

-->


<!-- Other Sections of Interest... -->

<sect1 id="troubleshooting">
  <title>Troubleshooting</title>

  <para>
     This area contains general troubleshooting information,
     if applicable. The question/answer format works best 
     (like a FAQ).
  </para>

  <qandaset>
    <qandaentry>
      <question>
        <para>Question One</para>
      </question>
      <answer>
        <para>Answer One</para>
      </answer>
    </qandaentry>

  </qandaset>
</sect1>


<sect1 id="moreinfo">
  <title>Further Information</title>

  <para>
     This area lists other resources, which would include
     books, web sites, newsgroups, mailing lists, etc.
  </para>
</sect1>


</article>