Author: pfrields
Update of /cvs/docs/documentation-guide/en_US In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv29125/en_US
Modified Files: acknowledgments.xml module-struct.xml rpm-info.xml tutorial.xml Log Message: This is finally being updated; I hope to finish this in the next week.
Index: acknowledgments.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/acknowledgments.xml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- acknowledgments.xml 3 Feb 2007 22:29:37 -0000 1.5 +++ acknowledgments.xml 23 Jun 2007 05:24:16 -0000 1.6 @@ -11,7 +11,7 @@ <title>Acknowledgments</title>
<para> - This document is based on the a document started by Tammy Fox (tfox at + This document is based on a document started by Tammy Fox (tfox at redhat.com) and contributed to by Sandra Moore (smoore at redhat.com) and Johnray Fuller (jrfuller at redhat.com). </para> @@ -37,11 +37,11 @@ <para> A patch from Karsten Wade (kwade at redhat.com) has been applied to add <xref linkend="sn-screenshots"></xref>. It was edited by Paul - W. Frields (stickstr5 at hotmail.com). + W. Frields (stickster at gmail.com). </para>
<para> - A patch from Paul W. Frields (stickstr5 at hotmail.com) has been applied + A patch from Paul W. Frields (stickster at gmail.com) has been applied to add more explanation of the <command>screen</command> tag set to <xref linkend="sn-xml-tags-screen"></xref>. </para>
Index: module-struct.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/module-struct.xml,v retrieving revision 1.4 retrieving revision 1.5 diff -u -r1.4 -r1.5 --- module-struct.xml 12 Mar 2007 01:25:56 -0000 1.4 +++ module-struct.xml 23 Jun 2007 05:24:16 -0000 1.5 @@ -98,7 +98,7 @@ </seglistitem> </segmentedlist> </section> - <section id="ch-getting-files-build-system"> + <section id="sn-build-system"> <title>The Document Build System</title> <para> The build system can render the document into another format such @@ -205,7 +205,7 @@ rules to actually build the document and the various archives. </para> </section> - <section> + <section id="sn-rpm-info"> <title>The Document <filename>rpm-info.xml</filename></title> <para>Each document module's primary language directory contains a file called <filename>rpm-info.xml</filename>. This file @@ -213,42 +213,6 @@ history, copyright, and contributor information. It follows a DTD specification included with the rest of the build system tools.</para> - <para><xref linkend="ex-rpminfo"/> illustrates the content of - this file:</para> - <example id="ex-rpminfo"> - <title>Example <filename>rpm-info.xml</filename> File</title> - <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!DOCTYPE rpm-info SYSTEM "../../docs-common/packaging/rpm-info.dtd"> - -<rpm-info> - <colophon> - <worker surname="Smith" firstname="John" othername="Q." - id="JohnSmith" email="jsmith@example.com" - wholename="John Q. Smith" initials="JS"/> - </colophon> - <author worker="JohnSmith"/> - <license> - <rights>OPL</rights> - <version>1.0</version> - </license> - <copyright> - <year>2006</year> - <holder>John Q. Smith</holder> - </copyright> - <title>My Tutorial</title> - <desc>A tutorial about something important</desc> - <changelog order="newest-first"> - <revision date="2006-06-01" number="0.1" role="doc"> - <author worker="JohnSmith"/> - <details>First draft</details> - </revision> - </changelog> -</rpm-info>]]></programlisting> - </example> - <para>If you are not familiar with XML editing, copy and paste - this file from an existing module and then edit the values for - the various elements as appropriate. Consult &FDP; members and - help channels for more assistance if needed.</para> </section> </section> <section id="ch-getting-files-build-system-targets">
Index: rpm-info.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/rpm-info.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- rpm-info.xml 29 Nov 2006 00:29:48 -0000 1.3 +++ rpm-info.xml 23 Jun 2007 05:24:16 -0000 1.4 @@ -1,5 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE rpm-info SYSTEM "../../docs-common/packaging/rpm-info.dtd"> +<!DOCTYPE rpm-info PUBLIC "-//Fedora//DTD Docs RPM-INFO V1.0//EN" +"http://docs.fedoraproject.org/dtds/rpm-info.dtd"> <rpm-info> <colophon> <worker id="TammyFox" wholename="Tammy Fox" email="tfox@redhat.com" @@ -25,6 +26,7 @@ <year>2004</year> <year>2005</year> <year>2006</year> + <year>2007</year> <holder>Red Hat, Inc.</holder> <holder>Tammy Fox</holder> <holder>Johnray Fuller</holder> @@ -34,12 +36,12 @@ <title>Fedora Documentation Guide</title> <desc>Guidelines and procedures for producing documentation for Fedora</desc> <changelog order="newest-first"> - <revision date="2005-09-18" number="0.2.6.3"> + <revision date="2007-06-23" number="0.3.0"> <author worker="PaulWFrields"/> <author worker="TammyFox"/> <author worker="JohnrayFuller"/> <author worker="SandraMoore"/> - <details>Update to new build requirements</details> + <details>Update to new content and build requirements</details> </revision> </changelog> </rpm-info>
Index: tutorial.xml =================================================================== RCS file: /cvs/docs/documentation-guide/en_US/tutorial.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- tutorial.xml 3 Feb 2007 22:29:37 -0000 1.2 +++ tutorial.xml 23 Jun 2007 05:24:16 -0000 1.3 @@ -1,3 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?> <!-- $Id$ --> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ @@ -8,101 +9,92 @@
]>
- <chapter id="ch-tutorial"> - <title>The Layout of a Tutorial</title> - - <para> - In this chapter, you will find an example of a &PROJECT; documentation - parent file. This example is specific to the way the Docs Project uses - DocBook XML. The parent file contains the main structural format of the - book, a link to the entities file that contain common entities that should - be used, and an entity to change the version and date of the tutorial. - </para> - - <section id="sn-tutorial-parent"> - <title>The Parent File</title> - - <para> - Below is a sample parent file: - </para> - -<screen> -<computeroutput> -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ - -<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../common/fedora-entities-en.xml"> -%FEDORA-ENTITIES-EN; - -<!ENTITY VERSION "0.1"> <!-- change version of tutorial here --> - -<!ENTITY DOCID "example-tutorial-&VERSION; (2003-07-07)"> <!-- change last modified date here --> - -<!ENTITY LEGALNOTICE SYSTEM "../common/legalnotice-en.xml"> - - -]> - -<article id="example-tutorial" lang="en"> - <articleinfo> - <title>Example Tutorial</title> - <copyright> - <year>2003</year> - <holder>&FORMAL-RHI;</holder> - <holder>Tammy Fox</holder> - </copyright> - <authorgroup> - <author> - <surname>Fox</surname> - <firstname>Tammy</firstname> - </author> - </authorgroup> - &LEGALNOTICE; - </articleinfo> - - <section id="some-section"> - <title>Some Section</title> - - <para> - This is an example section. You can also use section, section, etc. - </para> - - <warning> - <title>Warning</title> - <para> - Example of an admonition. - </para> - </warning> +<chapter id="ch-tutorial"> + <title>The Layout of a Tutorial</title> + <para>In this chapter, you will find an example of a very short tutorial + as used by the &FDP;. This example is specific to the way the Docs + Project uses DocBook XML. The example consists of a set of files + used to hold the content and metadata for the tutorial.</para> + <section id="sn-tutorial-article"> + <title>The Article</title> + <indexterm> + <primary>tutorial layout</primary> + <secondary>article</secondary> + </indexterm> + <para>Below is a sample article:</para> + <screen><![CDATA[<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- </section> +<!ENTITY % FEDORA-ENTITIES SYSTEM "fdp-entities.ent"> +%FEDORA-ENTITIES;
-<index id="generated-index"></index> -</article> -</computeroutput> -</screen> - - </section> - - <section id="sn-tutorial-license"> - <title>Including the License Information</title> - - <indexterm> - <primary>tutorial layout</primary> - <secondary>license</secondary> - </indexterm> +]>
+<article id="sample-tutorial" lang="en_US"> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" + href="fdp-info.xml"/> + <section id="some-section"> + <title>Some Section</title> + <para> + This is an example section. You can nest sections or make + additional sections as needed. + </para> + <warning> + <title>Warning</title> <para> - All &PROJECT; manuals <emphasis>must</emphasis> contain the file - <filename>legalnotice.xml</filename>. This file makes the license for - the file the GNU Free Documentation License (FDL). - </para> - - <para> - The sample parent file shows how it is included. + Example of an admonition. </para> - - </section> - - </chapter> - - + </warning> + </section> +<index id="generated-index"/> +</article> +]]></screen> + </section> + <section id="sn-tutorial-metadata"> + <title>The Metadata</title> + <indexterm> + <primary>tutorial layout</primary> + <secondary>metadata</secondary> + </indexterm> + <para>The <filename>rpm-info.xml</filename> file contains all the + required metadata for the document. This metadata includes title, + authorship, licensing, and revision history. <xref + linkend="ex-rpminfo"/> illustrates the content of this + file:</para> + <example id="ex-rpminfo"> + <title>Example <filename>rpm-info.xml</filename> File</title> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE rpm-info PUBLIC "-//Fedora//DTD Docs RPM-INFO V1.0//EN" + "http://docs.fedoraproject.org/dtds/rpm-info.dtd"> + +<rpm-info> + <colophon> + <worker surname="Smith" firstname="John" othername="Q." + id="JohnSmith" email="jsmith@example.com" + wholename="John Q. Smith" initials="JS"/> + </colophon> + <author worker="JohnSmith"/> + <license> + <rights>OPL</rights> + <version>1.0</version> + </license> + <copyright> + <year>2006</year> + <holder>John Q. Smith</holder> + </copyright> + <title>My Tutorial</title> + <desc>A tutorial about something important</desc> + <changelog order="newest-first"> + <revision date="2006-06-01" number="0.1" role="doc"> + <author worker="JohnSmith"/> + <details>First draft</details> + </revision> + </changelog> +</rpm-info>]]></programlisting> + </example> + <para>If you are not familiar with XML editing, copy and paste this + file from an existing module and then edit the values for the + various elements as appropriate. Consult &FDP; members and help + channels for more assistance if needed.</para> + </section> +</chapter>