db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r434195 - in /db/derby/site/trunk: build/site/manuals/dita.html src/documentation/content/xdocs/manuals/dita.xml
Date Wed, 23 Aug 2006 21:37:00 GMT
Author: jta
Date: Wed Aug 23 14:36:59 2006
New Revision: 434195

URL: http://svn.apache.org/viewvc?rev=434195&view=rev
Log:
DITA instructions on the web site: expanded the section on how to test changes.

Modified:
    db/derby/site/trunk/build/site/manuals/dita.html
    db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml

Modified: db/derby/site/trunk/build/site/manuals/dita.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/dita.html?rev=434195&r1=434194&r2=434195&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Wed Aug 23 14:36:59 2006
@@ -411,8 +411,22 @@
 <li> 
 
 <p>
-Test your changes by running <span class="codefrag">ant</span> to create output
in both HTML and PDF.  Make sure no new errors or build failures result from your changes,
and check that the output looks correct.  This is the documentation that users will read,
so please check your writing for spelling, grammar, and punctuation mistakes.  
+Test your changes.
 </p> 
+   
+<ul>
+   
+<li> At the very least run <span class="codefrag">ant html</span>, <span
class="codefrag">ant monohtml</span> and 
+        <span class="codefrag">ant pdf</span> to create HTML and PDF output (running
<span class="codefrag">ant all</span> is best).
+        Verify that the PDF docs were actually created.   If they weren't created, 
+        doublecheck that the <span class="codefrag">fop.jar</span>, <span
class="codefrag">avalon-framework-cvs-20020806.jar</span>, 
+        and <span class="codefrag">batik.jar</span> files are in your <span
class="codefrag">CLASSPATH</span>.</li>
+   
+<li> Make sure no new errors or build failures result from your changes, and check
that the output looks correct.</li>
+   
+<li> This is the documentation that users will read, so please check your writing for
spelling, grammar, and punctuation mistakes.  </li>
+   
+</ul>
 
 </li> 
 
@@ -476,7 +490,7 @@
 </div>
 
 
-<a name="N10229"></a><a name="Committing+documentation+patches"></a>
+<a name="N1024A"></a><a name="Committing+documentation+patches"></a>
 <h2 class="boxed">Committing documentation patches</h2>
 <div class="section">
 <ol>
@@ -545,7 +559,7 @@
 
 
 <p>
-<em>Last Updated: August 17, 2006</em>
+<em>Last Updated: August 23, 2006</em>
 </p>
 
 </div>

Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml?rev=434195&r1=434194&r2=434195&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Wed Aug 23 14:36:59
2006
@@ -211,8 +211,17 @@
 
 <li> 
 <p>
-Test your changes by running <code>ant</code> to create output in both HTML and
PDF.  Make sure no new errors or build failures result from your changes, and check that the
output looks correct.  This is the documentation that users will read, so please check your
writing for spelling, grammar, and punctuation mistakes.  
+Test your changes.
 </p> 
+   <ul>
+   <li> At the very least run <code>ant html</code>, <code>ant monohtml</code>
and 
+        <code>ant pdf</code> to create HTML and PDF output (running <code>ant
all</code> is best).
+        Verify that the PDF docs were actually created.   If they weren't created, 
+        doublecheck that the <code>fop.jar</code>, <code>avalon-framework-cvs-20020806.jar</code>,

+        and <code>batik.jar</code> files are in your <code>CLASSPATH</code>.</li>
+   <li> Make sure no new errors or build failures result from your changes, and check
that the output looks correct.</li>
+   <li> This is the documentation that users will read, so please check your writing
for spelling, grammar, and punctuation mistakes.  </li>
+   </ul>
 </li> 
 <li> 
 <p> 
@@ -306,6 +315,6 @@
 
 </section>
 
-<p><em>Last Updated: August 17, 2006</em></p>
+<p><em>Last Updated: August 23, 2006</em></p>
 </body>
 </document>



Mime
View raw message