<?xml version='1.0'?>

<article>
  <sect1 id="conventions">
    <title>This is a list of conventions that I follow when writing
    the HOWTO.</title>

    
      <itemizedlist>
        <listitem>
<para>Use Docbook XML V4.1.2</para>
        </listitem>

        <listitem>
<para>Single space after a period.</para></listitem>

        <listitem>
<para>xrefs have linkend and endterm attributes.</para></listitem>

        <listitem>
<para>bilioentries have their title's id attribute
        filled in so that xrefs can refer to the title with the
        endterm attribute.</para></listitem>

        <listitem>
<para>All sect1 elements have the id attribute filled in
        with the filename of the HTML version of the HOWTO.</para></listitem>

        <listitem>
<para>Whenever suggesting that the reader try a command,
        tag it with command, parameter tags, as
        appropriate.</para></listitem>

        <listitem>
<para>All commands or series of commands get their own
        paragraph.</para></listitem>

        <listitem>
<para>Tag the applications with the
        application tags.</para></listitem>

        <listitem>
<para>When talking about my personal experience, use a
        sidebar element.</para></listitem>

        <listitem>
<para>Tag directories and files with the filename
        element.</para></listitem>

        <listitem>
<para>Tag keystrokes appropriately. (keycap, keycombo,
        keysym, shortcut, accel)</para></listitem>

        <listitem>
<para>Precede commands with a prompt that mimicks the real 
      prompt. Use a "$" as the user's shell prompt and "#" as the
        root shell prompt. Also name the application that 
        generates the prompt. Tag them with
        &#60;prompt&#62;.</para>
        </listitem>

        <listitem>
<para>Biblios will have a URL to the document. Put
it inside of releaseinfo.</para></listitem>

        <listitem>
<para>Standard licensing text will be put into an
        sect1.</para></listitem>

      <listitem>
<para>Use these terms: Gbyte, Mbyte, Kbyte, byte.</para></listitem>

<listitem>
<para>Use this spelling : dependant, not dependent</para></listitem>

<listitem>
<para>make a note to merge/remove the .rpmsave files.</para>
</listitem>

<listitem>
<para>GNU wants the sections catorgorized as 'invarient',
backmatter, frontmatter, etc</para>
</listitem>

<listitem>
<para>Bibilo. entries should have : title, author, copyright
date, publish date, version, ulink.</para>
</listitem>

      </itemizedlist>
    

    <para>There are some fixes that the SGML needs after it's
    processed.</para>

    <para>
      <itemizedlist>
        <title>Corrections to the processing bugs.</title>

        <listitem>
          <para>Make sure that punctionation and words which follow
          a tag don't get extra spaces added by tidy, where they
          don't belong. This is true of tags before periods and
          all the other punctuation</para>
        </listitem>

<listitem>
<para>
tidy screws up the text in the &#60;screen&#62; from the
kernel's Changes file.
</para>
</listitem>

<listitem>
<para>
tidy screws up the text in the &#60;literallayout&#62; from 
the package order lists.
</para>
</listitem>

<listitem>
<para>tidy incorrectly converts the numerical entity
references back to symbolic ones (ent#62 to entgt
and ent#60 to entlt).
</para>
</listitem>

<listitem>
<para>entGFDLDOC; gets reformatted as entamp;GFDLDOC; 
by tidy.</para>
</listitem>

<listitem>
<para>Remove all of the extra white space at the "FIXME"
notes.</para>
</listitem>

      </itemizedlist>
    </para>
  </sect1>
</article>

