db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r395706 - in /db/derby/site/trunk: build/site/papers/derby_web.html src/documentation/content/xdocs/papers/derby_web.xml
Date Thu, 20 Apr 2006 21:58:15 GMT
Author: jta
Date: Thu Apr 20 14:58:13 2006
New Revision: 395706

URL: http://svn.apache.org/viewcvs?rev=395706&view=rev
Log:
DERBY-1199 : Added instructions to the derby web site build information on
resolving forrest DTDs locally.

Modified:
    db/derby/site/trunk/build/site/papers/derby_web.html
    db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml

Modified: db/derby/site/trunk/build/site/papers/derby_web.html
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/build/site/papers/derby_web.html?rev=395706&r1=395705&r2=395706&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/papers/derby_web.html (original)
+++ db/derby/site/trunk/build/site/papers/derby_web.html Thu Apr 20 14:58:13 2006
@@ -132,6 +132,9 @@
 <li>
 <a href="#Add+your+new+page+to+the+seed+site">Add your new page to the seed site</a>
 </li>
+<li>
+<a href="#Resolve+Forrest+DTDs+locally">Resolve Forrest DTDs locally</a>
+</li>
 </ul>
 </li>
 <li>
@@ -420,6 +423,30 @@
         source file. </li>
 
 </ul>
+<a name="N1013C"></a><a name="Resolve+Forrest+DTDs+locally"></a>
+<h3 class="boxed">Resolve Forrest DTDs locally</h3>
+<p>
+Many source files in the Derby web site repository are in Forrest XML format.
+XML files include a DTD declaration at the top; 
+for example, here is an example of what you might see at the top of
+a Forrest XML file:
+</p>
+<pre class="code">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+   "http://forrest.apache.org/dtd/document-v20.dtd"&gt;
+</pre>
+<p>
+To reduce requests to the <span class="codefrag">forrest.apache.org</span> site
itself, 
+it's important to resolve Forrest DTDs locally.
+The <span class="codefrag">forrest</span> command
+resolves DTDs from local copies in the Forrest software distribution,
+so you don't need to do anything special when you build the Derby web site.
+However,
+if you use a tool to edit Forrest XML files that validates the XML, 
+then you should configure that tool to use a catalog entity resolver per 
+the instructions on the 
+<a class="external" href="http://forrest.apache.org/docs_0_70/catalog.html">Forrest
web site</a>.
+</p>
 <p>
 When you're satisfied with how your new page looks on your seed site,
 then it is ready to be added to the Derby web site.
@@ -429,14 +456,14 @@
 
 
 
-<a name="N10140"></a><a name="Updating+the+Apache+Derby+web+site"></a>
+<a name="N1015B"></a><a name="Updating+the+Apache+Derby+web+site"></a>
 <h2 class="boxed">Updating the Apache Derby web site </h2>
 <div class="section">
 <p>
 The information in this section is intended for committers
 who need to add a page to the Derby web site or modify an existing page.
 </p>
-<a name="N10149"></a><a name="1.+Install+Forrest+on+your+machine"></a>
+<a name="N10164"></a><a name="1.+Install+Forrest+on+your+machine"></a>
 <h3 class="boxed">1. Install Forrest on your machine</h3>
 <p>
 If you haven't installed Forrest yet,
@@ -446,7 +473,7 @@
 as described in the previous section,
 and play with it to get comfortable working with Forrest.
 </p>
-<a name="N10157"></a><a name="2.+Check+out+the+Derby+web+site+pages"></a>
+<a name="N10172"></a><a name="2.+Check+out+the+Derby+web+site+pages"></a>
 <h3 class="boxed">2. Check out the Derby web site pages </h3>
 <p>
 Check the Derby web site files out of the Subversion repository:
@@ -454,7 +481,7 @@
 <pre class="code">
 svn co https://svn.apache.org/repos/asf/db/derby/site/trunk
 </pre>
-<a name="N10165"></a><a name="3.+Modify+files+in+the+src+tree"></a>
+<a name="N10180"></a><a name="3.+Modify+files+in+the+src+tree"></a>
 <h3 class="boxed">3. Modify files in the src tree </h3>
 <p>
 Source files are in the places listed below:
@@ -533,7 +560,7 @@
 </li>
 
 </ul>
-<a name="N101EF"></a><a name="4.+Build+the+site"></a>
+<a name="N1020A"></a><a name="4.+Build+the+site"></a>
 <h3 class="boxed">4. Build the site </h3>
 <p>
 After modifying files, you need to rebuild the site with the
@@ -551,7 +578,7 @@
 build/site/releases so that they can be checked into subversion with the source
 changes.
 </p>
-<a name="N10209"></a><a name="5.+Test+the+changes"></a>
+<a name="N10224"></a><a name="5.+Test+the+changes"></a>
 <h3 class="boxed">5. Test the changes </h3>
 <p>
 There are a couple ways (at least) to review changes.
@@ -586,7 +613,7 @@
 won't be added when the site is viewed locally.</a>
 
 </p>
-<a name="N1023B"></a><a name="6.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
+<a name="N10256"></a><a name="6.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
 <h3 class="boxed">6. Commit changes to the src and build/site directories</h3>
 <p>
 Commit modified pages in the <span class="codefrag">src</span> and
@@ -628,7 +655,7 @@
 <pre class="code">
 svn commit --message "here is my commit message" src build/site 
 </pre>
-<a name="N10280"></a><a name="7.+Make+web+site+changes+visible"></a>
+<a name="N1029B"></a><a name="7.+Make+web+site+changes+visible"></a>
 <h3 class="boxed">7. Make web site changes visible</h3>
 <p>
 A Derby committer can make web site changes visible as follows:
@@ -642,7 +669,7 @@
 www.apache.org automatically syncs up with people.apache.org every couple hours
 (the specific schedule could change).
 </p>
-<a name="N10294"></a><a name="8.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
+<a name="N102AF"></a><a name="8.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
 <h3 class="boxed">8. Considering a quick fix to the build tree?</h3>
 <p>
 If you modify a file in the <span class="codefrag">build/site</span> tree, 
@@ -651,7 +678,7 @@
 will likely overwrite your changes to the build tree.
 </p>
 <p>
-<em>Last updated August 13, 2005</em>
+<em>Last updated April 20, 2006</em>
 </p>
 </div>
 

Modified: db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml?rev=395706&r1=395705&r2=395706&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml Thu Apr 20 14:58:13
2006
@@ -245,6 +245,36 @@
 </ul>
 </section>
 
+<section>
+<title>Resolve Forrest DTDs locally</title>
+
+<p>
+Many source files in the Derby web site repository are in Forrest XML format.
+XML files include a DTD declaration at the top; 
+for example, here is an example of what you might see at the top of
+a Forrest XML file:
+</p>
+
+<source>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+   "http://forrest.apache.org/dtd/document-v20.dtd"&gt;
+</source>
+
+<p>
+To reduce requests to the <code>forrest.apache.org</code> site itself, 
+it's important to resolve Forrest DTDs locally.
+The <code>forrest</code> command
+resolves DTDs from local copies in the Forrest software distribution,
+so you don't need to do anything special when you build the Derby web site.
+However,
+if you use a tool to edit Forrest XML files that validates the XML, 
+then you should configure that tool to use a catalog entity resolver per 
+the instructions on the 
+<a href="http://forrest.apache.org/docs_0_70/catalog.html">Forrest web site</a>.
+</p>
+
+</section>
+
 <p>
 When you're satisfied with how your new page looks on your seed site,
 then it is ready to be added to the Derby web site.
@@ -500,7 +530,7 @@
 
 </section>
 
-<p><em>Last updated August 13, 2005</em></p>
+<p><em>Last updated April 20, 2006</em></p>
 </section>
 
 </body>



Mime
View raw message