r1583 - in nALFS/hackers_guide/trunk: . introduction/welcome part2/common part3/editor preface stylesheets

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Thu Nov 11 19:38:47 PST 2004


Author: jwrober
Date: 2004-11-11 20:38:45 -0700 (Thu, 11 Nov 2004)
New Revision: 1583

Modified:
   nALFS/hackers_guide/trunk/index.xml
   nALFS/hackers_guide/trunk/introduction/welcome/changelog.xml
   nALFS/hackers_guide/trunk/part2/common/svn.xml
   nALFS/hackers_guide/trunk/part3/editor/editor.xml
   nALFS/hackers_guide/trunk/preface/foreword.xml
   nALFS/hackers_guide/trunk/stylesheets/alfs.css
Log:
updates from the wiki page

Modified: nALFS/hackers_guide/trunk/index.xml
===================================================================
--- nALFS/hackers_guide/trunk/index.xml	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/index.xml	2004-11-12 03:38:45 UTC (rev 1583)
@@ -8,8 +8,8 @@
         $LastChangedRevision$ 
 -->
 
-<!ENTITY version "1.2-0.4">
-<!ENTITY releasedate "October 22nd, 2004">
+<!ENTITY version "1.2-0.5">
+<!ENTITY releasedate "November 11th, 2004">
 
 <!ENTITY % book         SYSTEM "book/book.ent">
 <!ENTITY % preface      SYSTEM "preface/preface.ent">

Modified: nALFS/hackers_guide/trunk/introduction/welcome/changelog.xml
===================================================================
--- nALFS/hackers_guide/trunk/introduction/welcome/changelog.xml	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/introduction/welcome/changelog.xml	2004-11-12 03:38:45 UTC (rev 1583)
@@ -12,6 +12,9 @@
 
 <itemizedlist>
 
+<listitem><para>November 11th, 2004 [jwrober]: Filled in a bunch of
+sections from the wiki page notes.</para></listitem>
+
 <listitem><para>October 22nd, 2004 [jwrober]: Small edits to the main
 SVN page.</para></listitem>
 

Modified: nALFS/hackers_guide/trunk/part2/common/svn.xml
===================================================================
--- nALFS/hackers_guide/trunk/part2/common/svn.xml	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/part2/common/svn.xml	2004-11-12 03:38:45 UTC (rev 1583)
@@ -16,7 +16,10 @@
 
 <para>To get a good feel for what all the repository contains, you can
 go to the SVN web at <ulink
-url="http://svn.linuxfromscratch.org/viewcvs.cgi/?root=ALFS">http://svn.linuxfromscratch.org/viewcvs.cgi/?root=ALFS</ulink></para>
+url="http://svn.linuxfromscratch.org/viewcvs.cgi/?root=ALFS">http://svn.linuxfromscratch.org/viewcvs.cgi/?root=ALFS</ulink>.
+There is also an excellent online book at <ulink
+url="http://svnbook.red-bean.com/">http://svnbook.red-bean.com/</ulink>
+that contains the whole SVN users and administrators guides.</para>
 
 <para>You can do an anonymous TRUNK checkout of the &book-product;
 source code by issuing the following command :</para>

Modified: nALFS/hackers_guide/trunk/part3/editor/editor.xml
===================================================================
--- nALFS/hackers_guide/trunk/part3/editor/editor.xml	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/part3/editor/editor.xml	2004-11-12 03:38:45 UTC (rev 1583)
@@ -10,19 +10,58 @@
 
 <sect1>
 
-<para>Editing the guides for the &book-product; is not difficult at any
+<para>Editing the guides for &book-product; is not difficult at any
 stretch of the imagination. The biggest piece is have an understanding of
 the DocBook XML DTD. The DTD's <ulink url="http://docbook.org/">home
 page</ulink> has a lot of information on how to use it and <ulink
 url="http://docbook.org/tdg/en/html/docbook.html">a book</ulink> is also
 available.</para>
 
-<para>The books (or guides) each have their own unique design and layout.
-They all, however, share a lot of common pieces. As mentioned above, they
-are all written using the DocBook XML DTD v4.3. They all can be parsed into
-three formats: chunks-html, nochunks-html and flat-text.</para>
+<para>The &book-product; books (or guides) each have their own unique
+design and layout.  They all, however, share some common pieces.</para>
 
+<itemizedlist>
 
+<listitem><para>As mentioned above, they are all written using the
+DocBook XML DTD v4.3.</para></listitem>
+
+<listitem><para>They all can be parsed into
+three formats: chunks-html, nochunks-html and
+flat-text.</para></listitem>
+
+<listitem><para>Each has a Preface that contains: a foreward, the
+guide's organization, a "Who would want to read this" section
+and finally a prerequisites page.</para></listitem>
+
+<listitem><para>Each has an Introduction that contains: a welcome page,
+acknowledgements, docuement conventions, contact info and changelog.</para></listitem>
+
+</itemizedlist>
+
+<para>This is where the similarities end.  After this point, each book
+takes on the charastistics necessary for its audience.</para>
+
+<para>The books are available from the SVN repository.  See the <xref
+linkend="common-svn"/> page for instructions.  In the root of the
+guide's source tree is a <filename>README</filename> file.  It provides
+the necessary instructions to help you install the tools that you will
+need to use the makefile to parse the XML source into one of the three
+rendered editions.</para>
+
+<para><emphasis role="bold">A note on version numbers</emphasis> :
+The guides each have a seperate version number.  The number is split
+into two pieces.  The first piece is the major and minor version of
+&book-product; that the guide is written for.  The second piece is the
+version of the guide itself.  The version numbering scheme is set up
+this way to ensure that a reader will know that the version of the guide
+they are reading goes with the version of the package they are using.
+The version number of the ALFS DTD syntax document is special.  It is
+versioned to be the same as the version of the DTD itself.  The ALFS DTD
+is special in this regard.  &book-product; uses the DTD, but the DTD is
+"implementation agnostic" and keeps its own version number
+seperate from any implementation (&book-product; is one implementation
+of the ALFS DTD).</para>
+
 </sect1>
 
 </chapter>

Modified: nALFS/hackers_guide/trunk/preface/foreword.xml
===================================================================
--- nALFS/hackers_guide/trunk/preface/foreword.xml	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/preface/foreword.xml	2004-11-12 03:38:45 UTC (rev 1583)
@@ -23,7 +23,7 @@
 <blockquote><literallayout>
 --
 James Robertson
-jwrober at linuxfromscratch.org
+jwrober at linuxfromscratch dot org
 </literallayout></blockquote>
 
 </sect1>

Modified: nALFS/hackers_guide/trunk/stylesheets/alfs.css
===================================================================
--- nALFS/hackers_guide/trunk/stylesheets/alfs.css	2004-11-11 20:30:09 UTC (rev 1582)
+++ nALFS/hackers_guide/trunk/stylesheets/alfs.css	2004-11-12 03:38:45 UTC (rev 1583)
@@ -1,8 +1,3 @@
-
-        $LastChangedDate$
-        $LastChangedBy$
-        $LastChangedRevision$ 
-
 div.navheader table
 {
     font-weight: normal;
@@ -179,3 +174,9 @@
 {
     padding-left: 0.2in
 }
+
+        $LastChangedDate$
+        $LastChangedBy$
+        $LastChangedRevision$ 
+
+




More information about the alfs-log mailing list