dgv2/en_US creating-document.xml,NONE,1.1

[Paul W. Frields (pfrields)]

Author: pfrields

Update of /cvs/docs/dgv2/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv1321

Added Files:
	creating-document.xml 
Log Message:
Add beginning of creating-document file


--- NEW FILE creating-document.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.docbook.org/xml/4.4/docbookx.dtd" [

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

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

]>

<chapter id="creating-document">
  <title>Creating a Document in &SCM;</title>
  <para>
    The &FDP; uses a standard organization for its work in &SCM;.  This
    organization promotes ease of use for writers, editors, and
    publishers. Each document in the &FDP; &SCM; system resides in its
    own separate directory, or <firstterm>module</firstterm>, named
    after the content.  Each module contains a number of required files
    which allow contributors to ensure the document can be easily built
    and published.  To create a new document, simply follow these steps.
  </para>
  <procedure>
    <step>
      <title>Checking Out Common Tools</title>
      <para>
	The <filename class="directory">docs-common</filename> module in
	&SCM; contains essential tools and support files.  To create a
	new document, make a work area and check out this module on your
	local system:
      </para>
      <screen>
	<command>mkdir ~/fdp</command>
	<command>cd ~/fdp</command>
	<command>&SCM-CMD; -d &SCM-ROOT; co docs-common</command>
      </screen>
    </step>
    <step>
      <title>Creating a Module Directory</title>
      <para>
	Use a descriptive name, but do not use the word "&FED;" in your
	module's name.  The following module names are good usage
	examples:
      </para>
      <itemizedlist>
	<listitem>
	  <para>
	    <filename class="directory">example-tutorial</filename>
	  </para>
	</listitem>
	<listitem>
	  <para>
	    <filename class="directory">system-planning-guide</filename>
	  </para>
	</listitem>
      </itemizedlist>
    </step>
  </procedure>
</chapter>
	

<!--

Local variables:
mode: xml
fill-column: 72
End:

-->