db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r232570 [6/6] - in /db/derby/site/trunk: build/site/ build/site/binaries/ build/site/integrate/ build/site/integrate/plugin_help/ build/site/manuals/ build/site/papers/ build/site/releases/ src/documentation/content/xdocs/ src/documentation...
Date Sun, 14 Aug 2005 02:16:04 GMT
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=232570&r1=232569&r2=232570&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 Sat Aug 13 19:13:50
2005
@@ -128,9 +128,7 @@
 </p>
 
 <warning>
-The Derby web site uses Forrest 0.6 and it will be upgraded to 0.7 "soon".
-Forrest 0.7 must not be used to build the Derby site until it is upgraded
-because the directory structure is different.
+The Derby web site uses Forrest 0.7 and must be built using Forrest 0.7. 
 </warning>
 
 </section>
@@ -176,15 +174,26 @@
 
 <ul>
    <li> If you have an HTML file, perhaps named <em>your_file.html</em>,
-        one option is to leave it as is
+        <ul>
+        <li> One option is to leave the file as is
         (previous forrest releases had you rename it to a file 
-         named <em>your_file.ihtml</em>).
-	Forrest will convert it into a new
-        <em>your_file.html</em> file in the build tree -- and you may or may
not
-	like how Forrest formatted it.
+         named <em>your_file.ihtml</em>, but support for the ihtml extension
+         is deprecated in forrest 0.7).
+	Forrest will convert the file into a new
+        <em>your_file.html</em> file in the build tree and will add the site
+        decoration and navigation to it.
 	The <a href="JDBCImplementation.html">Derby JDBC Implementation
         Notes</a> paper is an example of an HTML document
-        that is stored in the project source tree as an <code>ihtml</code> file.
+        that is stored in the project source tree as an <code>html</code> file.
+        </li>
+       <li>Another option is to rename the file with a <code>.htm</code>
+       extension. Forrest won't touch it, but will just copy it as is
+       to the build tree; it won't add site decoration and navigation.
+       This is useful for documents that Forrest has trouble converting.
+	The <a href="../integrate/DOTS_Derby.htm">Running DOTS (Database Open 
+          Source Test Suite) with Derby</a> is an example of this approach.
+       </li>
+        </ul>
    </li>
    <li> You can also create an XML file that uses the Forrest DTD.
 	The <a href="derby_arch.html">Derby Engine 
@@ -258,7 +267,7 @@
 
 <p>
 If you haven't installed Forrest yet,
-<a href="#forrest">install Forrest 0.6</a> 
+<a href="#forrest">install Forrest 0.7</a> 
 on your local system.
 Then generate a seed project,
 as described in the previous section,
@@ -294,15 +303,15 @@
 </tr>
 <tr>
    <td> <code>src/documentation/content/xdocs</code></td>
-   <td> Source files in formats Forrest can consume (*.xml and *.ihtml).</td>
-   <td> Forrest ingests these files, adds navigation and
-        decorations, and outputs them as .html files to
+   <td> Source files in formats Forrest can consume, such as *.xml and *.html.</td>
+   <td> Forrest ingests these files, adds site navigation and
+        decoration, and outputs them as .html files to
         build/site and build/app.
    </td>
 </tr>
 <tr>
    <td> <code>src/documentation/content/xdocs/papers</code></td>
-   <td> Source HTML files you don't want Forrest to touch.</td>
+   <td> Source HTML files you don't want Forrest to touch (*.htm).</td>
    <td> Forrest copies these files without modifying them to 
          build/site/papers.
    </td>
@@ -318,14 +327,6 @@
 </table>
 
 <p>
-The default directory structure 
-is somewhat different for the src and build trees
-(and the Derby web site uses default locations).
-Links in source files
-need to point to the name and the location of the target file in the build tree.
-</p>
-
-<p>
 Two files in <code>src/documentation/content/xdocs</code>
 don't get output to the <code>build</code> tree; 
 they control the information and links in the resulting navigation bar:
@@ -427,7 +428,7 @@
 <code>src</code> and
 <code>build/site</code> directory hierarchies.
 Do this after 'forrest site' has been run but 
-before committing changes into Subversion.
+before committing changes to the the subversion repository.
 </p>
 
 <p>
@@ -442,9 +443,9 @@
 <p>
 However,
 the easiest way to manage <code>svn:eol-style</code> is to 
-automatically set common file types by adding the 
-<a href="http://www.apache.org/dev/svn-eol-style.txt">Apache dev list to 
-your ~/.subversion/config file</a>.
+automatically set end of line for common file types by adding the 
+<a href="http://www.apache.org/dev/svn-eol-style.txt">Apache dev list 
+of files to your ~/.subversion/config file</a>.
 </p>
 
 <p>
@@ -491,7 +492,7 @@
 
 </section>
 
-<p><em>Last updated August 1, 2005</em></p>
+<p><em>Last updated August 13, 2005</em></p>
 </section>
 
 </body>

Modified: db/derby/site/trunk/src/documentation/content/xdocs/papers/index.xml
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/src/documentation/content/xdocs/papers/index.xml?rev=232570&r1=232569&r2=232570&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/papers/index.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/papers/index.xml Sat Aug 13 19:13:50
2005
@@ -221,7 +221,7 @@
 </p>
 
 <ul>
-   <li> <a href="../DOTS_Derby.html">Running DOTS (Database open Source
+   <li> <a href="../integrate/DOTS_Derby.htm">Running DOTS (Database open Source
           Test Suite) with Derby</a>.</li>
    <li> The C-JDBC
 	    <a href="../binaries/HOWTO_CJDBC_Derby_v0.2.pdf">PDF</a> and

Modified: db/derby/site/trunk/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/src/documentation/content/xdocs/site.xml?rev=232570&r1=232569&r2=232570&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/site.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/site.xml Sat Aug 13 19:13:50 2005
@@ -69,7 +69,7 @@
       <misc      label="Summary"      href="misc.html"/>
       <cjdbc-pdf label="C-JDBC (PDF)" href="../binaries/HOWTO_CJDBC_Derby_v0.2.pdf"/>
       <cjdbc-oo  label="C-JDBC (SXW)" href="../binaries/HOWTO_CJDBC_Derby_v0.2.sxw"/>
-      <dots      label="DOTS Derby"   href="../DOTS_Derby.htm"/>
+      <dots      label="DOTS Derby"   href="DOTS_Derby.htm"/>
       <dots      label="DOTS System"  href="../binaries/UsingDotsDerbySystemTest.pdf"/>
       <emma      label="EMMA"         href="../binaries/DerbyCodeCoverageUsingEmma.pdf"/>
       <jpetstore label="iBATIS JPetStore" href="JPetStoreDerby.html" />



Mime
View raw message