r5247 - in trunk/editor-manual: chapter01 chapter04

matthew at linuxfromscratch.org matthew at linuxfromscratch.org
Sun May 8 11:12:49 PDT 2005


Author: matthew
Date: 2005-05-08 12:12:49 -0600 (Sun, 08 May 2005)
New Revision: 5247

Modified:
   trunk/editor-manual/chapter01/changelog.xml
   trunk/editor-manual/chapter04/checkrender.xml
   trunk/editor-manual/chapter04/introduction.xml
Log:
Mention XML validation and Makefile that facilitates rendering

Modified: trunk/editor-manual/chapter01/changelog.xml
===================================================================
--- trunk/editor-manual/chapter01/changelog.xml	2005-05-08 18:05:04 UTC (rev 5246)
+++ trunk/editor-manual/chapter01/changelog.xml	2005-05-08 18:12:49 UTC (rev 5247)
@@ -31,6 +31,8 @@
   <itemizedlist>
    <listitem><para>May 8, 2005 [matthew]</para>
      <itemizedlist>
+       <listitem><para>chapter04/introduction.xml, chapter04/checkrender.xml:
+       Mention the Makefile and validation of XML</para></listitem>
        <listitem><para>chapter03/moving.xml: Minor tagging improvements</para></listitem>
        <listitem><para>chapter03/diff.xml: Minor wording improvements</para></listitem>
        <listitem><para>chapter03/commit.xml: Minor wording and tagging improvements.  Also add explanation of <option>-F</option> option to <command>svn <option>commit</option></command></para></listitem>

Modified: trunk/editor-manual/chapter04/checkrender.xml
===================================================================
--- trunk/editor-manual/chapter04/checkrender.xml	2005-05-08 18:05:04 UTC (rev 5246)
+++ trunk/editor-manual/chapter04/checkrender.xml	2005-05-08 18:12:49 UTC (rev 5247)
@@ -10,11 +10,21 @@
 
   <para>Before commiting any changes, it's important to check that you have all
     the syntax correct and that the book can actually pass through
-    <userinput>openjade</userinput> without making it belch.  Instructions on
-    how to render the book can be obtained by reading the
-    <filename>INSTALL</filename> and <filename>README</filename> files that are
-    in the LFS CVS repository. It's generally best to have a script which
-    automatically does it all for you. If not better, at least it's easier as
-    you don't have to type out the long openjade command all the time.
+    <command>xsltproc</command> without any problems.  Instructions on how to
+    render the book can be obtained by reading the <filename>INSTALL</filename>
+    and <filename>README</filename> files that are in the LFS Subversion
+    repository.
   </para>
+
+  <para>The <filename>Makefile</filename> that accompanies the XML sources for
+    the book have various targets that aid in the rendering of the book.
+    Firstly, <command>make <option>validate</option></command> ensures that the
+    XML is valid, and that further processing with <command>xsltproc</command>
+    won't fail.  This target was added because rendering the full book into HTML
+    or PDF can take some time.  The most common cause of rendering failures is
+    because of invalid XML, hence this target was added as a time-saving
+    measure. Secondly, <command>make</command> will render the HTML output.
+    Finally, <command>make <option>pdf</option></command> will render the PDF
+    output.
+  </para>
 </sect1>

Modified: trunk/editor-manual/chapter04/introduction.xml
===================================================================
--- trunk/editor-manual/chapter04/introduction.xml	2005-05-08 18:05:04 UTC (rev 5246)
+++ trunk/editor-manual/chapter04/introduction.xml	2005-05-08 18:12:49 UTC (rev 5247)
@@ -20,6 +20,7 @@
       <userinput>svn add</userinput>'d or <userinput>remove</userinput>'d.
       </para>
     </listitem>
+    <listitem><para>Check the validity of the XML.</para></listitem>
     <listitem><para>Check that the book renders properly.</para></listitem>
     <listitem><para>Commit it.</para></listitem>
     <listitem><para>Update bugzilla to reflect the changes.</para></listitem>




More information about the lfs-book mailing list