You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@db.apache.org by rh...@apache.org on 2012/12/19 19:20:28 UTC
svn commit: r843115 [24/44] - in /websites/production/db/content/derby: ./
binaries/ blogs/ blogs/images/ dev/ docs/ images/ integrate/
integrate/plugin_help/ integrate/plugin_help/images/ logo/ manuals/ papers/
papers/DerbyTut/ releases/ skin/ skin/cs...
Added: websites/production/db/content/derby/papers/derby_web.html
==============================================================================
--- websites/production/db/content/derby/papers/derby_web.html (added)
+++ websites/production/db/content/derby/papers/derby_web.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,949 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Apache Derby Web Site</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://db.apache.org/">db</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://db.apache.org/derby"><img class="logoImage" alt="Apache Derby" src="../images/derby-logo-web.png" title="Derby is a zero-admin Java RDBMS"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://db.apache.org"><img class="logoImage" alt="Apache DB Project" src="../images/db-logo-white.png" title="Apache DB creates and maintains database solutions."></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../quick_start.html">Quick Start</a>
+</li>
+<li>
+<a class="unselected" href="../derby_downloads.html">Download</a>
+</li>
+<li class="current">
+<a class="selected" href="../derby_comm.html">Community</a>
+</li>
+<li>
+<a class="unselected" href="../manuals/index.html">Documentation</a>
+</li>
+<li>
+<a class="unselected" href="../blogs/index.html">Resources</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Community</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../derby_comm.html">Get Involved!</a>
+</div>
+<div class="menuitem">
+<a href="../derby_mail.html">Mailing Lists</a>
+</div>
+<div class="menuitem">
+<a href="../dev/derby_source.html">Source Code</a>
+</div>
+<div class="menuitem">
+<a href="../DerbyBugGuidelines.html">BUGS</a>
+</div>
+<div class="menuitem">
+<a href="../derby_tests.html">Tests</a>
+</div>
+<div class="menuitem">
+<a href="../logo.html">Logo</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Updating the web site</div>
+</div>
+</div>
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<hr>
+<form action="http://www.google.com/search" method="get">
+<input value="db.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="18" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div class="trail">Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Apache Derby Web Site</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Web+Site+Change+Notes">Web Site Change Notes</a>
+<ul class="minitoc">
+<li>
+<a href="#21-Dec-2007%3A+Web+site+upgraded+to+Forrest+0.8">21-Dec-2007: Web site upgraded to Forrest 0.8</a>
+</li>
+<li>
+<a href="#12-Aug-2005%3A+Web+site+upgraded+to+Forrest+0.7">12-Aug-2005: Web site upgraded to Forrest 0.7</a>
+</li>
+<li>
+<a href="#31-Jul-2005%3A+Web+site+moved+from+Incubator+to+Apache+DB">31-Jul-2005: Web site moved from Incubator to Apache DB</a>
+</li>
+<li>
+<a href="#15-May-2005%3A+Version+10.0+manuals+moved">15-May-2005: Version 10.0 manuals moved</a>
+</li>
+<li>
+<a href="#27-Jan-2005%3A+Web+site+upgraded+to+Forrest+0.6">27-Jan-2005: Web site upgraded to Forrest 0.6</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Forrest+in+a+Nutshell">Forrest in a Nutshell</a>
+</li>
+<li>
+<a href="#Testing+New+Pages+for+the+Derby+Site">Testing New Pages for the Derby Site</a>
+<ul class="minitoc">
+<li>
+<a href="#Create+a+Forrest+seed+site">Create a Forrest seed site</a>
+</li>
+<li>
+<a href="#Add+your+new+page+to+the+seed+site">Add your new page to the seed site</a>
+</li>
+<li>
+<a href="#What+editor+can+you+use+for+Forrest+XML%3F">What editor can you use for Forrest XML?</a>
+</li>
+<li>
+<a href="#Resolve+Forrest+DTDs+locally">Resolve Forrest DTDs locally</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Updating+the+Apache+Derby+web+site">Updating the Apache Derby web site </a>
+<ul class="minitoc">
+<li>
+<a href="#1.+Install+Forrest+on+your+machine">1. Install Forrest on your machine</a>
+</li>
+<li>
+<a href="#2.+Check+out+the+Derby+web+site+pages">2. Check out the Derby web site pages </a>
+</li>
+<li>
+<a href="#3.+Modify+files+in+the+src+tree">3. Modify files in the src tree </a>
+</li>
+<li>
+<a href="#4.+Build+the+site">4. Build the site </a>
+</li>
+<li>
+<a href="#5.+Test+the+changes">5. Test the changes </a>
+</li>
+<li>
+<a href="#odd_diffs">6. Adjust the site build - odd diffs</a>
+</li>
+<li>
+<a href="#7.+Create+a+patch">7. Create a patch</a>
+</li>
+<li>
+<a href="#8.+Commit+changes+to+the+src+and+build%2Fsite+directories">8. Commit changes to the src and build/site directories</a>
+</li>
+<li>
+<a href="#9.+Make+web+site+changes+visible">9. Make web site changes visible</a>
+</li>
+<li>
+<a href="#10.+Considering+a+quick+fix+to+the+build+tree%3F">10. Considering a quick fix to the build tree?</a>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+
+
+<p>
+The Derby project web site
+at
+<a href="http://db.apache.org/derby">http://db.apache.org/derby</a>
+uses
+<a class="external" href="http://forrest.apache.org">Forrest</a>.
+Page source and built pages are managed in the Apache DB
+subversion repository.
+This page introduces Forrest,
+suggests a way to test new pages using a local Forrest site,
+and provides information for committers on how to update the
+Derby web site itself.
+</p>
+
+
+<a name="N10018"></a><a name="Web+Site+Change+Notes"></a>
+<h2 class="boxed">Web Site Change Notes</h2>
+<div class="section">
+<a name="N1001E"></a><a name="21-Dec-2007%3A+Web+site+upgraded+to+Forrest+0.8"></a>
+<h3 class="boxed">21-Dec-2007: Web site upgraded to Forrest 0.8</h3>
+<p>The web site was upgraded to build with the latest
+release of Forrest, Forrest 0.8.</p>
+<a name="N10028"></a><a name="12-Aug-2005%3A+Web+site+upgraded+to+Forrest+0.7"></a>
+<h3 class="boxed">12-Aug-2005: Web site upgraded to Forrest 0.7</h3>
+<p>The web site was recently upgraded to build with the latest
+release of Forrest, Forrest 0.7.</p>
+<p>If you receive OutOfMemoryErrors while trying to build the
+site, try increasing the amount of memory available to forrest
+by setting the ANT_OPTS environment variable to -mx512M.</p>
+<a name="N10035"></a><a name="31-Jul-2005%3A+Web+site+moved+from+Incubator+to+Apache+DB"></a>
+<h3 class="boxed">31-Jul-2005: Web site moved from Incubator to Apache DB</h3>
+<p>
+Derby graduated from the Incubator to the Apache DB project,
+so the web site moved from
+http://incubator.apache.org/derby to
+<a href="http://db.apache.org/derby">http://db.apache.org/derby</a>.
+Specific changes, beginning with SVN revision 226719, included:
+</p>
+<ul>
+
+<li>
+<span class="codefrag">src/documentation/skinconf.xml</span>:
+ Changed the group logo, which appears on the masthead,
+ from the Incubator logo to the Apache DB logo, and updated the bread
+ crumb trail.
+ </li>
+
+<li>Updated references and URLs throughout the site from
+ incubator to db or from incubator.apache.org to db.apache.org.
+ </li>
+
+</ul>
+<a name="N1004E"></a><a name="15-May-2005%3A+Version+10.0+manuals+moved"></a>
+<h3 class="boxed">15-May-2005: Version 10.0 manuals moved</h3>
+<p>
+The files that comprise the 10.0 manuals are numerous (about 750), static,
+and take a while to build (20-40 minutes, depending on the machine).
+In May they were moved to a separate "mini" forrest site, which is now at
+<a href="http://db.apache.org/derby/docs/10.0/index.html">http://db.apache.org/derby/docs/10.0/index.html</a>.
+</p>
+<a name="N1005C"></a><a name="27-Jan-2005%3A+Web+site+upgraded+to+Forrest+0.6"></a>
+<h3 class="boxed">27-Jan-2005: Web site upgraded to Forrest 0.6</h3>
+<p>
+The Derby web site was initialized in August 2004 with Forrest 0.5.1.
+</p>
+<p>
+The site was upgraded to Forrest 0.6 on January 27, 2005.
+To keep the size of commit records down, changes were committed in the
+blocks listed below:
+</p>
+<ul>
+
+<li> Source pages: SVN 134379 </li>
+
+<li> Built pages:
+ <ul>
+
+<li> SVN 145725 : manuals/admin,getstart </li>
+
+<li> SVN 145920 : manuals/develop</li>
+
+<li> SVN 146259 : manuals/tools </li>
+
+<li> SVN 146516 : manuals/tuning </li>
+
+<li> SVN 146733 : manuals/reference</li>
+
+<li> SVN 148837 : site/skin</li>
+
+<li> SVN 148838 : site</li>
+
+</ul>
+
+</li>
+
+</ul>
+</div>
+
+
+<a name="N1008B"></a><a name="Forrest+in+a+Nutshell"></a>
+<h2 class="boxed">Forrest in a Nutshell</h2>
+<div class="section">
+<p>
+Apache Forrest is an XML documentation framework that is used for
+generating static/dynamic web sites.
+For many details, see
+<a class="external" href="http://forrest.apache.org">forrest.apache.org</a>.
+</p>
+<p>
+This web page walks you through using two Forrest commands:
+'<span class="codefrag">forrest site</span>'
+and
+'<span class="codefrag">forrest run</span>'.
+</p>
+<p>
+The '<span class="codefrag">forrest site</span>'
+command consumes the source input files in the
+<span class="codefrag">src</span> tree of the project hierarchy
+and spits out a static site composed of HTML pages in the
+<span class="codefrag">build</span> tree of the project hierarchy.
+</p>
+<p>
+The '<span class="codefrag">forrest run</span>' command starts up the Jetty web server
+that is included in the Forrest distribution on port 8888.
+</p>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+The Derby web site uses Forrest 0.8 and must be built using Forrest 0.8.
+</div>
+</div>
+</div>
+
+
+
+<a name="N100B6"></a><a name="Testing+New+Pages+for+the+Derby+Site"></a>
+<h2 class="boxed">Testing New Pages for the Derby Site</h2>
+<div class="section">
+<p>
+The information in this section is intended for anyone
+who wants to develop content for the Derby web site
+(in other words, for both committers and non-committers).
+It is much easier to integrate new pages by first
+testing them outside the Derby web site source tree.
+</p>
+<a name="N100BF"></a><a name="Create+a+Forrest+seed+site"></a>
+<h3 class="boxed">Create a Forrest seed site</h3>
+<p>
+The
+<em><a class="external" href="http://forrest.apache.org/docs_0_70/your-project.html">Using Forrest:
+A tutorial on how to use Forrest in your own projects</a></em> guide
+provides an excellent overview of Forrest.
+Below are some simple steps to get started:
+</p>
+<ul>
+
+<li>
+<a class="external" href="http://forrest.apache.org/mirrors.cgi">Download</a>
+ Forrest 0.8. </li>
+
+<li>
+<a class="external" href="http://forrest.apache.org/docs_0_70/your-project.html#installing">Install Forrest and set up your environment</a>. </li>
+
+<li> Create a new directory, <span class="codefrag">cd</span> into it,
+ and enter '<span class="codefrag">forrest seed</span>' to initialize a new project.
+ </li>
+
+<li> Enter 'forrest site' to build the site. </li>
+
+<li> Enter 'forrest run' to start the jetty server that is bundled
+ with Forrest. </li>
+
+<li> Point your browser at <span class="codefrag">localhost:8888</span>. </li>
+
+<li> Look at the sample pages that are included in the seed site.</li>
+
+</ul>
+<a name="N100F7"></a><a name="Add+your+new+page+to+the+seed+site"></a>
+<h3 class="boxed">Add your new page to the seed site</h3>
+<p>
+If you don't need to add a new page, skip this step.
+Otherwise, incorporate the new page(s) into the newly-created seed site:
+</p>
+<ul>
+
+<li> If you have an HTML file, perhaps named <em>your_file.html</em>,
+ <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>, 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 <span class="codefrag">html</span> file.
+ </li>
+
+<li>Another option is to rename the file with a <span class="codefrag">.htm</span>
+ 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
+ Architecture Overview</a> is an example.
+ Also, the site you just seeded provides examples.
+ </li>
+
+<li> If you have a file that is ascii text, one option is to create
+ an XML file and include it in a CDATA block, as shown below:
+
+<pre class="code">
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document>
+ <header>
+ <title>The Title of your Document</title>
+ </header>
+
+ <body>
+
+ <p>An introductory blurb for your document.</p>
+
+ <source><![CDATA[
+ <em>Put the contents of your text file here</em> ]]></source>
+
+ </body>
+</document>
+</pre>
+
+
+</li>
+
+<li>The seed site includes a "Samples" tab.
+ After you create the file for Forrest to ingest,
+ update the <span class="codefrag">src/documentation/content/xdocs/site.xml</span> file
+ to include your new page in that tab, as shown below:
+<pre class="code">
+<samples label="Samples" href="samples/" tab="samples">
+ <your_tag label="Your page" href="your_file.html" description="Your test page" />
+</pre>
+ Notice that at this point you need to refer to the file
+ as <em>your_file.html</em> even if the source file is
+ <em>your_file.ihtml</em> or
+ <em>your_file.xml</em>.
+ </li>
+
+<li> Execute '<span class="codefrag">forrest site</span>' to rebuild your site. </li>
+
+<li> Restart the jetty server ('<span class="codefrag">forrest run</span>').</li>
+
+<li> Do you like what Forrest did? If you don't, go back and tweak your
+ source file. </li>
+
+</ul>
+<a name="N1015A"></a><a name="What+editor+can+you+use+for+Forrest+XML%3F"></a>
+<h3 class="boxed">What editor can you use for Forrest XML?</h3>
+<p>
+The Forrest web site mentions jEdit, oXygen, xmlspy,
+and XMLmind XML Editor (XXE) -- and no doubt many more XML products also work.
+</p>
+<p>
+One Derby community cohort has recently looked at two editors,
+which are both quite excellent:
+</p>
+<ul>
+
+<li>
+<a class="external" href="http://www.jedit.org">jEdit</a> (GPL) with the jEdit XML plugin.
+<a class="external" href="http://forrest.apache.org/docs_0_70/catalog.html#jedit">See the
+Forrest jEdit configuration instructions</a>.</li>
+
+<li>
+<a class="external" href="http://xmlbuddy.com">XMLBuddy eclipse plugin</a> (free). Caches
+ the DTD, but am looking for a way to resolve locally.
+ (If you install this plugin along with the Web Tools Project (WTP) plugin,
+ you may need to do
+ <span class="codefrag">File -> Open With -> XMLBuddy</span> because WTP includes the WST
+ XML editor.)</li>
+
+</ul>
+<p>
+If you find other tools that also work well, please let others know
+by posting to
+<a href="../derby_mail.html">derby-dev@db.apache.org</a>.
+</p>
+<a name="N10184"></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"><?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd">
+</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.
+The mechanics of doing that is described in the next section.
+</p>
+</div>
+
+
+
+<a name="N101A3"></a><a name="Updating+the+Apache+Derby+web+site"></a>
+<h2 class="boxed">Updating the Apache Derby web site </h2>
+<div class="section">
+<p>
+This section explains how to add a new page to the Derby web site or
+modify an existing page.
+Steps 1-6 are for both contributors and committers.
+Step 7 tells contributors how to create a patch.
+Steps 8-10 tell committers how to commit and publish changes.
+</p>
+<a name="N101AC"></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,
+<a class="external" href="http://forrest.apache.org/mirrors.cgi">install Forrest 0.8</a>
+on your local system.
+</p>
+<a name="N101BA"></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:
+</p>
+<pre class="code">
+svn co https://svn.apache.org/repos/asf/db/derby/site/trunk
+</pre>
+<a name="N101C8"></a><a name="3.+Modify+files+in+the+src+tree"></a>
+<h3 class="boxed">3. Modify files in the src tree </h3>
+<p>
+After checking the site out of subversion,
+the web site source is in
+<span class="codefrag">src/documentation/content/xdocs</span> and the files processed
+("skinned") by Forrest are in <span class="codefrag">build/site</span>.
+(Forrest also outputs files to <span class="codefrag">build/webapp</span> and
+<span class="codefrag">build/tmp</span>, but we don't commit
+those directories to subversion.)
+Modifying the web site requires changing files in the
+<span class="codefrag">src</span> tree, then building the site with Forrest.
+</p>
+<p>
+The Derby web site is composed of many file types and
+it's helpful to understand what Forrest does with them:
+</p>
+<ul>
+
+<li> *.xml and *.html:
+ Forrest reads these files, adds site navigation and
+ decoration, then outputs them as .html files to the
+ <span class="codefrag">build</span> directory.
+ </li>
+
+<li> *.htm:
+ Forrest copies these files without modifying them to
+ the <span class="codefrag">build/site</span> directory (in other words,
+ they don't get site navigation and decoration).
+ </li>
+
+<li> binary (*.tar.gz, *.zip) and image (*.gif, *.jpg) files:
+ Forrest copies these files without modifying them to
+ <span class="codefrag">build/site/binaries</span>
+ <span class="codefrag">and build/site/images</span>, respectively.
+ </li>
+
+<li> *.aart :
+ These files contain ascii stick diagrams that Forrest converts to png,
+ then outputs to the <span class="codefrag">build/site</span> directory.
+ </li>
+
+<li> *.cgi :
+ Forrest copies these files without modifying them to the
+ <span class="codefrag">build/site</span> directory.
+ </li>
+
+</ul>
+<p>
+The table below describes the source directory structure
+and indicates which tabs might link to files in a given directory
+(the Derby project sometimes changes tab names and linkages):
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1"> Source Location </th>
+ <th colspan="1" rowspan="1"> Description </th>
+ <th colspan="1" rowspan="1"> Tab(s) </th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs</span></td>
+ <td colspan="1" rowspan="1"> The root location of the web site source.</td>
+ <td colspan="1" rowspan="1"> Home, Quick Start, Community </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/binaries</span></td>
+ <td colspan="1" rowspan="1"> Binary files, such as *.tar.gz and *.ZIP. </td>
+ <td colspan="1" rowspan="1"> Linked to from various pages.</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/images</span></td>
+ <td colspan="1" rowspan="1"> Image files, such as *.gif, *.jpg and *.png. </td>
+ <td colspan="1" rowspan="1"> Linked to from various pages. </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/integrate</span></td>
+ <td colspan="1" rowspan="1"> Documents that explain how to use Derby with some other product. </td>
+ <td colspan="1" rowspan="1"> Resources (Products and Eclipse Plug-ins sections) </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/logo</span></td>
+ <td colspan="1" rowspan="1"> Apache Derby logo files. </td>
+ <td colspan="1" rowspan="1"> Community </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/manuals</span></td>
+ <td colspan="1" rowspan="1"> Files that describe the Derby manuals and DITA
+ processing.</td>
+ <td colspan="1" rowspan="1"> Documentation </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/papers</span></td>
+ <td colspan="1" rowspan="1"> Miscellaneous contributions.</td>
+ <td colspan="1" rowspan="1"> Resources (Papers section), Community </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <span class="codefrag">xdocs/releases</span></td>
+ <td colspan="1" rowspan="1"> Contains files for the Derby downloads.</td>
+ <td colspan="1" rowspan="1"> Download </td>
+
+</tr>
+
+
+</table>
+<p>
+Two files in <span class="codefrag">xdocs</span>
+don't get output to the <span class="codefrag">build/site</span> tree;
+they control the information and links in the resulting navigation bar:
+</p>
+<ul>
+
+<li>
+<p>
+<span class="codefrag">tabs.xml</span>: sets up the tabs for the web site.
+ Over time the specific tabs have changed.
+ </p>
+
+</li>
+
+<li>
+<p>
+<span class="codefrag">site.xml</span>: contains a site map for files on the site.
+ If you add or delete a file you must update site.xml, which can be
+ tricky.
+ If you haven't updated it before, it might be a good idea to
+ ask somebody already familiar with Forrest to help you the first time.
+ </p>
+
+</li>
+
+</ul>
+<a name="N102DD"></a><a name="4.+Build+the+site"></a>
+<h3 class="boxed">4. Build the site </h3>
+<p>
+After modifying files, rebuild the site with the
+'<span class="codefrag">forrest site</span>' command.
+Do this in the trunk (one level above the <span class="codefrag">src</span> and
+<span class="codefrag">build</span> directories).
+</p>
+<p>Due to <a class="external" href="http://issues.apache.org/jira/browse/FOR-480">FOR-480</a>,
+the skinned HTML for the release pages will be output to your
+<span class="codefrag">FORREST_HOME/main/site</span> directory.
+If you have made changes to the site navigation or to
+the release pages themselves copy these files to
+<span class="codefrag">build/site/releases</span>
+so that they can be checked into subversion with the source
+changes.
+</p>
+<p>
+If you run out of memory building the web site,
+try setting the <span class="codefrag">ANT_OPTS</span> environment variable to
+<span class="codefrag">-mx512M</span>.
+</p>
+<a name="N10306"></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.
+</p>
+<p>
+One way is to open <span class="codefrag">build/site/index.html</span> with your web browser.
+</p>
+<p>
+Another way is to start the Jetty webserver that is included in
+the Forrest distribution:
+</p>
+<pre class="code">forrest run</pre>
+<p>
+After it starts, point your browser at
+<span class="codefrag">localhost:8888</span> and review the new or modified pages.
+</p>
+<p>
+The breadcrumb trail will be different. Instead of this:
+</p>
+<pre class="code">
+apache > db > derby
+</pre>
+<p>
+You'll see this with your local Jetty server:
+</p>
+<pre class="code">
+apache > db
+</pre>
+<p>
+The difference in bread crumb behavior is alright, though confusing.
+The <span class="codefrag">skinconf.xml</span> specifies the base links for the trail,
+then Javascript adds extra breadcrumbs for each directory after the domain.
+<a class="external" href="http://forrest.apache.org/faq.html#breadcrumbs">Extra breadcrumbs
+won't be added when the site is viewed locally.</a>
+
+</p>
+<a name="N1033B"></a><a name="odd_diffs"></a>
+<h3 class="boxed">6. Adjust the site build - odd diffs</h3>
+<p>Derby developers build the site on a variety of platforms,
+including Windows, Mac, and Linux. The
+<span class="codefrag">svn status</span> command might report modifications to files under
+<span class="codefrag">build/site/skin</span>
+and to the <span class="codefrag">png</span> files under
+<span class="codefrag">build/site/papers</span>
+after you build the site,
+depending on who last committed those files.
+</p>
+<p>For example, when you run the <span class="codefrag">forrest site</span> command to build the
+site, Forrest generates inconsistent line endings on Windows machines
+(see <a class="external" href="https://issues.apache.org/jira/browse/FOR-492">FOR-492</a>
+and <a class="external" href="https://issues.apache.org/jira/browse/FOR-805">FOR-805</a>).
+Also <span class="codefrag">png</span> files generated from <span class="codefrag">aart</span>
+source may get generated differently on different operating systems.
+</p>
+<p>As a result, you might get odd diffs under <span class="codefrag">build/site/skin</span> and
+the <span class="codefrag">build/site/papers</span> directories.</p>
+<p>If you are using a <strong>Windows</strong> machine to build the site, you
+should revert the changes made to the <span class="codefrag">skin</span> directory
+<strong>before</strong> you create the patch. For example:</p>
+<pre class="code">svn revert build\site\skin\*</pre>
+<p>If you are using TortoiseSVN, you can use Windows Explorer to revert the
+changes.</p>
+<a name="N10381"></a><a name="7.+Create+a+patch"></a>
+<h3 class="boxed">7. Create a patch</h3>
+<p>
+Create a patch at the <span class="codefrag">trunk</span> level and only include the
+<span class="codefrag">src</span> directory, as shown below:
+</p>
+<pre class="code">svn diff src > changes.diff</pre>
+<p>
+Upload the patch to a Jira issue to make it available to a Derby committer.
+</p>
+<a name="N10398"></a><a name="8.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
+<h3 class="boxed">8. Commit changes to the src and build/site directories</h3>
+<p>
+Apply any patch, if one was provided, then build and test the web site
+(Steps 4-6).
+</p>
+<p>
+Commit modified pages in the <span class="codefrag">src</span> and
+<span class="codefrag">build/site</span> trees.
+The '<span class="codefrag">forrest site</span>' command also outputs
+<span class="codefrag">build/webapp</span> and
+<span class="codefrag">build/tmp</span> directories,
+but they aren't checked into the subversion repository.
+</p>
+<p>
+If you add or delete a file, you must 'svn add' or 'svn delete' it in the
+<span class="codefrag">src</span> and
+<span class="codefrag">build/site</span> directory hierarchies.
+Do this after 'forrest site' has been run but
+before committing changes to the the subversion repository.
+</p>
+<p>
+One more note about adding new text files.
+After you add the file to the repository,
+it's important to set the end-of-line for the file to <span class="codefrag">native</span>.
+You can do so explicitly with the command shown below:
+</p>
+<pre class="code">svn propset svn:eol-style native <em>filename</em>
+</pre>
+<p>
+However,
+the easiest way to manage <span class="codefrag">svn:eol-style</span> is to
+automatically set end of line for common file types by adding the
+<a class="external" href="http://www.apache.org/dev/svn-eol-style.txt">Apache dev list
+of files to your ~/.subversion/config file</a>.
+</p>
+<p>
+When you're ready to commit,
+one way is to enter the command shown below
+one level above the <span class="codefrag">src</span> and
+<span class="codefrag">build</span> directories:
+</p>
+<pre class="code">
+svn commit --message "here is my commit message" src build/site
+</pre>
+<a name="N103E0"></a><a name="9.+Make+web+site+changes+visible"></a>
+<h3 class="boxed">9. Make web site changes visible</h3>
+<p>
+A Derby committer can make web site changes visible as follows:
+</p>
+<pre class="code">
+ssh -l <em>your_apache_login</em> people.apache.org
+cd /www/db.apache.org/derby
+svn update
+</pre>
+<p>
+www.apache.org automatically syncs up with people.apache.org every couple hours
+(the specific schedule could change).
+</p>
+<a name="N103F4"></a><a name="10.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
+<h3 class="boxed">10. Considering a quick fix to the build tree?</h3>
+<p>
+If you modify a file in the <span class="codefrag">build/site</span> tree,
+be sure to also change the source file in the <span class="codefrag">src</span> tree.
+Otherwise, the next '<span class="codefrag">forrest site</span>' followed by '<span class="codefrag">svn commit</span>'
+will likely overwrite your changes to the build tree.
+</p>
+<p>
+<em>Last updated Dec 21, 2007</em>
+</p>
+</div>
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2004-2012 Apache Software Foundation</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0papers/derby_web.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: websites/production/db/content/derby/papers/field-header-non-overflow.png
==============================================================================
Binary file - no diff available.
Propchange: websites/production/db/content/derby/papers/field-header-non-overflow.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/db/content/derby/papers/field-header-overflow.png
==============================================================================
Binary file - no diff available.
Propchange: websites/production/db/content/derby/papers/field-header-overflow.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: websites/production/db/content/derby/papers/fortune_tut.html
==============================================================================
--- websites/production/db/content/derby/papers/fortune_tut.html (added)
+++ websites/production/db/content/derby/papers/fortune_tut.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,566 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Apache Derby Fortune Server Tutorial</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://db.apache.org/">db</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://db.apache.org/derby"><img class="logoImage" alt="Apache Derby" src="../images/derby-logo-web.png" title="Derby is a zero-admin Java RDBMS"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://db.apache.org"><img class="logoImage" alt="Apache DB Project" src="../images/db-logo-white.png" title="Apache DB creates and maintains database solutions."></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../quick_start.html">Quick Start</a>
+</li>
+<li>
+<a class="unselected" href="../derby_downloads.html">Download</a>
+</li>
+<li>
+<a class="unselected" href="../derby_comm.html">Community</a>
+</li>
+<li>
+<a class="unselected" href="../manuals/index.html">Documentation</a>
+</li>
+<li class="current">
+<a class="selected" href="../blogs/index.html">Resources</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Blogs and Articles About Derby</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#blogs">Blogs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">Articles</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.3.1', '../skin/')" id="menu_1.1.3.1Title" class="menutitle">Tutorials, Tips and Tuning</div>
+<div id="menu_1.1.3.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#getstarted">Getting Started</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#features">Features, Hints and Tips</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#security">Security</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#performance">Performance and Tuning</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.2', '../skin/')" id="menu_1.1.3.2Title" class="menutitle">Tools and Migration</div>
+<div id="menu_1.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#tools">Tools</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#migration">Migration</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.3', '../skin/')" id="menu_1.1.3.3Title" class="menutitle">Applications</div>
+<div id="menu_1.1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#client">Client</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#middletier">Middle Tier</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#persistence">Persistence</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#scalability">Scalability and Failover</a>
+</div>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Integration With Other Products</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../integrate/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../integrate/index.html#uses">What works with Derby?</a>
+</div>
+<div class="menuitem">
+<a href="../integrate/index.html#products">Product Writeups</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Eclipse Plug-ins</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../integrate/derby_plugin_info.html">Info</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Papers and Presentations</div>
+<div id="menu_1.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/index.html">Overview</a>
+</div>
+<div onclick="SwitchMenu('menu_1.4.2', '../skin/')" id="menu_1.4.2Title" class="menutitle">Derby Engine</div>
+<div id="menu_1.4.2" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.4.2.1', '../skin/')" id="menu_1.4.2.1Title" class="menutitle">Javadoc</div>
+<div id="menu_1.4.2.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/engine">Engine</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/language">Language</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/tools">Tools</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/publishedapi">API</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../papers/derby_arch.html">Architecture</a>
+</div>
+<div class="menuitem">
+<a href="../papers/btree_package.html">BTree</a>
+</div>
+<div class="menuitem">
+<a href="../papers/pageformats.html">Disk Page Format</a>
+</div>
+<div class="menuitem">
+<a href="../papers/derby_htw.html">How Things Work</a>
+</div>
+<div class="menuitem">
+<a href="../papers/Intersect-design.html">Intersect & Except</a>
+</div>
+<div class="menuitem">
+<a href="../papers/JDBCImplementation.html">JDBC</a>
+</div>
+<div class="menuitem">
+<a href="../papers/logformats.html">Log Format</a>
+</div>
+<div class="menuitem">
+<a href="../papers/recovery.html">Logging & Recovery</a>
+</div>
+<div class="menuitem">
+<a href="../papers/optimizer.html">Optimizer</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/engine/org/apache/derby/iapi/types/package-summary.html#package_description">Type System</a>
+</div>
+<div class="menuitem">
+<a href="../papers/versionupgrade.html">Versioning</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.3', '../skin/')" id="menu_1.4.3Title" class="menutitle">Derby Network Client</div>
+<div id="menu_1.4.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/DerbyClientSpec.html">Functional Spec</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.4', '../skin/')" id="menu_1.4.4Title" class="menutitle">Derby Tutorial</div>
+<div id="menu_1.4.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/DerbyTut/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/install_software.html">Step 1: Install Software</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/ij_intro.html">Step 2: ij Basics</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/embedded_intro.html">Step 3: Embedded Derby</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/ns_intro.html">Step 4: Derby Network Server</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.5', '../skin/')" id="menu_1.4.5Title" class="menutitle">Presentations</div>
+<div id="menu_1.4.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/ApacheCon.html">ApacheCon</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#Victorian+Java+User+Group">Victorian JUG 2008</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#OSCON+2005">OSCON 2005</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#Colorado+Software+Summit+2004">Colorado 2004</a>
+</div>
+</div>
+</div>
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<hr>
+<form action="http://www.google.com/search" method="get">
+<input value="db.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="18" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div class="trail">Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Apache Derby Fortune Server Tutorial</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Overview">Overview</a>
+</li>
+<li>
+<a href="#Intended+Audience">Intended Audience</a>
+</li>
+<li>
+<a href="#Tutorial+Topics">Tutorial Topics</a>
+</li>
+<li>
+<a href="#Download+Software">Download Software</a>
+</li>
+<li>
+<a href="#Credits+and+Acknowledgments">Credits and Acknowledgments</a>
+</li>
+<li>
+<a href="#Revision+History">Revision History</a>
+</li>
+</ul>
+</div>
+
+
+<a name="N1000D"></a><a name="Overview"></a>
+<h2 class="boxed">Overview</h2>
+<div class="section">
+<p>
+
+<a href="http://db.apache.org/derby">Apache Derby</a>,
+an <a href="http://db.apache.org">Apache DB</a> project,
+is a relational database implemented in Java.
+Its footprint is so small you can embed it in any Java-based solution --
+with no requirement for database installation and administration.
+This makes Derby easy to develop on, easy to run, and easy to deploy.
+</p>
+<p>
+The Apache Derby Fortune Server,
+referred to as simply "Fortune Server" throughout most of this tutorial,
+stores fortunes in a Derby database and
+dispenses them like the UNIX <span class="codefrag">fortune</span> command does.
+But its real mission in cyber-life is to be a novice tutorial that
+teaches the basics of Derby and shows a couple ways to
+integrate it with other Apache products,
+all within Derby's easy-to-use embedded environment.
+</p>
+</div>
+
+
+<a name="N10025"></a><a name="Intended+Audience"></a>
+<h2 class="boxed">Intended Audience</h2>
+<div class="section">
+<p>
+This tutorial is intended for novices who have had at least light exposure to
+SQL, Java and Web applications, but are new to Derby.
+All source code used in the tutorial is either simple or "fill in the blank",
+so lack of experience in any of these areas should not be a barrier.
+</p>
+</div>
+
+
+<a name="N1002F"></a><a name="Tutorial+Topics"></a>
+<h2 class="boxed">Tutorial Topics</h2>
+<div class="section">
+<p>
+The tutorial is organized into the sections below:
+</p>
+<ul>
+
+<li> The <em>Introduction</em> describes
+ the functionality of the Apache Derby Fortune Server.
+ </li>
+
+<li> The <em>Getting Started</em>
+ section introduces basic Derby concepts, then
+ walks through installing, configuring, and
+ running the Fortune Server.
+ If you just want to install and run the Fortune Server,
+ and avoid implementation details entirely,
+ this section is for you.
+ </li>
+
+<li> The <em>SQL</em> section
+ provides nitty gritty details about the Fortune Server database and
+ shows how to work with databases using <span class="codefrag">ij</span>,
+ the Derby SQL scripting tool.
+ </li>
+
+<li> The <em>Java/JDBC</em> section
+ describes the Fortune Server components that are implemented in
+ Java and/or JDBC.
+ It covers a few basics, then shows how to implement JDBC code that
+ fetches data from and inserts data into a Derby database.
+ It also shows how to implement SQL functions in Java that execute code
+ in other software, including:
+ <ul>
+
+<li>How to create a SQL function that generates a random number
+ using the
+ <a class="external" href="http://jakarta.apache.org/commons/math/">Jakarta
+ Mathematics Library</a>.</li>
+
+<li> How to create a SQL function that performs regular expression
+ searches using
+ <a class="external" href="http://jakarta.apache.org/regexp/">Jakarta
+ Regexp</a>.
+ </li>
+
+</ul>
+
+</li>
+
+<li> The <em>Tomcat</em>
+ section shows a way to embed Derby in
+ <a class="external" href="http://jakarta.apache.org/tomcat/">Jakarta
+ Tomcat</a> and provides a couple web applications that query the
+ Derby database.</li>
+
+</ul>
+</div>
+
+
+
+<a name="N10072"></a><a name="Download+Software"></a>
+<h2 class="boxed">Download Software</h2>
+<div class="section">
+<ul>
+
+<li>
+<p>Download the Apache Derby Fortune Server distribution
+ [<a href="../binaries/DerbyFS-tut-21Apr06.tar.gz">tar.gz</a>]
+ [<a href="../binaries/DerbyFS-tut-21Apr06.zip">zip</a>].
+ Extract it,
+ then open <span class="codefrag">Fortune/doc/index.html</span> with your web browser.
+ That opens a local copy of this page.
+ A good place to start is the
+ <em>Introduction</em>,
+ which describes the functionality of the Fortune Server.
+ </p>
+
+</li>
+
+<li>
+<p>Download and install Jakarta Tomcat 5.0.28 from
+ <a class="external" href="http://jakarta.apache.org/tomcat"><span class="codefrag">http://jakarta.apache.org/tomcat</span></a>.
+ </p>
+
+</li>
+
+</ul>
+</div>
+
+
+<a name="N1009B"></a><a name="Credits+and+Acknowledgments"></a>
+<h2 class="boxed">Credits and Acknowledgments</h2>
+<div class="section">
+<p>
+Jean Anderson (jta@bristowhill.com) developed this tutorial.
+Email her any problems or post them to the Derby user mail list
+(<a href="http://db.apache.org/derby/derby_mail.html">http://db.apache.org/derby/derby_mail.html</a>).
+</p>
+<p>
+The Fortune Server embeds Derby in Tomcat by
+using the "casual" scenario from Lance Bader's IBM developerWorks
+article titled
+"Integrating Cloudscape and Tomcat: A cookbook for adding the database manager
+into the servlet container",
+which is available at
+<a class="external" href="http://www.ibm.com/developerworks/db2/library/techarticle/dm-0408bader">http://www.ibm.com/developerworks/db2/library/techarticle/dm-0408bader</a>.
+Bader's article was developed on Cloudscape 5.1.
+Susan Cline (slc@MeepZor.Com) helped Jean update it to work with Derby.
+Susan also contributed the
+<span class="codefrag">FortuneServer</span> and
+<span class="codefrag">FortuneServer2</span> JavaServer Pages.
+</p>
+<p>
+
+<a class="external" href="http://forrest.apache.org">Apache Forrest</a>
+was used for generating the web-based materials.
+</p>
+</div>
+
+
+<a name="N100BD"></a><a name="Revision+History"></a>
+<h2 class="boxed">Revision History</h2>
+<div class="section">
+<p>
+Changes to the Fortune Server Tutorial are summarized in the table below.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<td colspan="1" rowspan="1">21-Apr-2006</td>
+ <td colspan="1" rowspan="1">Updated links to point to 10.1 documentation instead of to the
+ Incubator release documentation.
+ Also repackaged project with Derby 10.1 jars.
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">24-Nov-2004</td>
+ <td colspan="1" rowspan="1">Incorporated feedback from ApacheCon
+ (improved Tomcat instructions and
+ incorporated Ed Korthof's improvements
+ for the LoadFortune data loading program).
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">12-Nov-2004</td>
+ <td colspan="1" rowspan="1">Added Susan Cline's FortuneServer2 JSP, which invokes a servlet
+ to dynamically load categories from the Derby database.</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">10-Nov-2004</td>
+ <td colspan="1" rowspan="1">Corrected typos in the Getting Started sections.</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">7-Nov-2004</td>
+ <td colspan="1" rowspan="1">First document version, PDF generated for ApacheCon US 2004.</td>
+
+</tr>
+
+</table>
+</div>
+
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2004-2012 Apache Software Foundation</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0papers/fortune_tut.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: websites/production/db/content/derby/papers/index.html
==============================================================================
--- websites/production/db/content/derby/papers/index.html (added)
+++ websites/production/db/content/derby/papers/index.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,602 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.8">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Apache Derby Papers</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://db.apache.org/">db</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://db.apache.org/derby"><img class="logoImage" alt="Apache Derby" src="../images/derby-logo-web.png" title="Derby is a zero-admin Java RDBMS"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://db.apache.org"><img class="logoImage" alt="Apache DB Project" src="../images/db-logo-white.png" title="Apache DB creates and maintains database solutions."></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="unselected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="unselected" href="../quick_start.html">Quick Start</a>
+</li>
+<li>
+<a class="unselected" href="../derby_downloads.html">Download</a>
+</li>
+<li>
+<a class="unselected" href="../derby_comm.html">Community</a>
+</li>
+<li>
+<a class="unselected" href="../manuals/index.html">Documentation</a>
+</li>
+<li class="current">
+<a class="selected" href="../blogs/index.html">Resources</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Blogs and Articles About Derby</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#blogs">Blogs</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">Articles</div>
+<div id="menu_1.1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.3.1', '../skin/')" id="menu_1.1.3.1Title" class="menutitle">Tutorials, Tips and Tuning</div>
+<div id="menu_1.1.3.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#getstarted">Getting Started</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#features">Features, Hints and Tips</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#security">Security</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#performance">Performance and Tuning</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.2', '../skin/')" id="menu_1.1.3.2Title" class="menutitle">Tools and Migration</div>
+<div id="menu_1.1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#tools">Tools</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#migration">Migration</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.3.3', '../skin/')" id="menu_1.1.3.3Title" class="menutitle">Applications</div>
+<div id="menu_1.1.3.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../blogs/index.html#client">Client</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#middletier">Middle Tier</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#persistence">Persistence</a>
+</div>
+<div class="menuitem">
+<a href="../blogs/index.html#scalability">Scalability and Failover</a>
+</div>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Integration With Other Products</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../integrate/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../integrate/index.html#uses">What works with Derby?</a>
+</div>
+<div class="menuitem">
+<a href="../integrate/index.html#products">Product Writeups</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Eclipse Plug-ins</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../integrate/derby_plugin_info.html">Info</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.4', '../skin/')" id="menu_selected_1.4Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Papers and Presentations</div>
+<div id="menu_selected_1.4" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.2', '../skin/')" id="menu_1.4.2Title" class="menutitle">Derby Engine</div>
+<div id="menu_1.4.2" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.4.2.1', '../skin/')" id="menu_1.4.2.1Title" class="menutitle">Javadoc</div>
+<div id="menu_1.4.2.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/engine">Engine</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/language">Language</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/tools">Tools</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/publishedapi">API</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../papers/derby_arch.html">Architecture</a>
+</div>
+<div class="menuitem">
+<a href="../papers/btree_package.html">BTree</a>
+</div>
+<div class="menuitem">
+<a href="../papers/pageformats.html">Disk Page Format</a>
+</div>
+<div class="menuitem">
+<a href="../papers/derby_htw.html">How Things Work</a>
+</div>
+<div class="menuitem">
+<a href="../papers/Intersect-design.html">Intersect & Except</a>
+</div>
+<div class="menuitem">
+<a href="../papers/JDBCImplementation.html">JDBC</a>
+</div>
+<div class="menuitem">
+<a href="../papers/logformats.html">Log Format</a>
+</div>
+<div class="menuitem">
+<a href="../papers/recovery.html">Logging & Recovery</a>
+</div>
+<div class="menuitem">
+<a href="../papers/optimizer.html">Optimizer</a>
+</div>
+<div class="menuitem">
+<a href="http://db.apache.org/derby/javadoc/engine/org/apache/derby/iapi/types/package-summary.html#package_description">Type System</a>
+</div>
+<div class="menuitem">
+<a href="../papers/versionupgrade.html">Versioning</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.3', '../skin/')" id="menu_1.4.3Title" class="menutitle">Derby Network Client</div>
+<div id="menu_1.4.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/DerbyClientSpec.html">Functional Spec</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.4', '../skin/')" id="menu_1.4.4Title" class="menutitle">Derby Tutorial</div>
+<div id="menu_1.4.4" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/DerbyTut/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/install_software.html">Step 1: Install Software</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/ij_intro.html">Step 2: ij Basics</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/embedded_intro.html">Step 3: Embedded Derby</a>
+</div>
+<div class="menuitem">
+<a href="../papers/DerbyTut/ns_intro.html">Step 4: Derby Network Server</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.4.5', '../skin/')" id="menu_1.4.5Title" class="menutitle">Presentations</div>
+<div id="menu_1.4.5" class="menuitemgroup">
+<div class="menuitem">
+<a href="../papers/ApacheCon.html">ApacheCon</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#Victorian+Java+User+Group">Victorian JUG 2008</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#OSCON+2005">OSCON 2005</a>
+</div>
+<div class="menuitem">
+<a href="../papers/MiscPresentations.html#Colorado+Software+Summit+2004">Colorado 2004</a>
+</div>
+</div>
+</div>
+<!--+
+ |start Search
+ +-->
+<div class="searchbox">
+<hr>
+<form action="http://www.google.com/search" method="get">
+<input value="db.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="18" name="q" id="query" type="text" value="Search the site with google">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<div id="credit">
+<hr>
+<a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
+</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+<div id="credit2"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div class="trail">Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Apache Derby Papers</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Derby+Engine">Derby Engine</a>
+</li>
+<li>
+<a href="#Derby+Network+Client">Derby Network Client</a>
+</li>
+<li>
+<a href="#Instruction">Instruction</a>
+</li>
+<li>
+<a href="#How+to+Contribute+Papers">How to Contribute Papers</a>
+</li>
+</ul>
+</div>
+
+
+<p>
+This <em>ad hoc</em> spot in the Derby site hosts papers, and check the
+<a class="external" href="http://wiki.apache.org/db-derby/">Derby Wiki</a> for more.
+</p>
+
+
+<a name="N10017"></a><a name="Derby+Engine"></a>
+<h2 class="boxed">Derby Engine</h2>
+<div class="section">
+<p>
+The table below summarizes resources that describe the Derby engine.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Navigation Menu Entry</th><th colspan="1" rowspan="1">Title</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="4"> Javadoc</td>
+ <td colspan="1" rowspan="1"> <a href="http://db.apache.org/derby/javadoc/engine/">Engine</a></td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"> <a href="http://db.apache.org/derby/javadoc/language/">Language</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <a href="http://db.apache.org/derby/javadoc/tools/">Tools</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"> <a href="http://db.apache.org/derby/javadoc/publishedapi/">API</a></td>
+
+</tr>
+
+
+
+<tr>
+<td colspan="1" rowspan="1"> Architecture</td>
+ <td colspan="1" rowspan="1"> <a href="derby_arch.html">Derby Engine Architecture Overview</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1"> BTree</td>
+ <td colspan="1" rowspan="1"> <a href="btree_package.html">BTree package documentation</a></td>
+
+</tr>
+
+
+<tr>
+<td colspan="1" rowspan="1">Disk Page Format</td>
+ <td colspan="1" rowspan="1"><a href="pageformats.html">Derby On Disk Page Format</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">How Things Work</td>
+ <td colspan="1" rowspan="1"><a href="derby_htw.html">How Things Work</a> </td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Intersect & Except</td>
+ <td colspan="1" rowspan="1"><a href="Intersect-design.html">Intersect & Except Design</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">JDBC</td>
+ <td colspan="1" rowspan="1"><a href="JDBCImplementation.html">Derby JDBC Implementation Notes</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Log Format</td>
+ <td colspan="1" rowspan="1"><a href="logformats.html">Derby Write Ahead Log Format</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Logging & Recovery</td>
+ <td colspan="1" rowspan="1"><a href="recovery.html">Derby Logging and Recovery</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Optimizer</td>
+ <td colspan="1" rowspan="1"><a href="optimizer.html">Derby Optimizer Design</a></td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Type System</td>
+ <td colspan="1" rowspan="1"><a class="external" href="http://svn.apache.org/repos/asf/db/derby/code/trunk/java/engine/org/apache/derby/iapi/types/package.html">Derby Type System</a>
+(Note: if your browser shows HTML source for this page instead of
+displaying it, save the file locally with <strong>File -> Save Page As</strong>,
+then open the file you saved.)
+</td>
+
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Versioning</td>
+ <td colspan="1" rowspan="1"><a href="versionupgrade.html">Derby Versioning Scheme</a></td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N100FF"></a><a name="Derby+Network+Client"></a>
+<h2 class="boxed">Derby Network Client</h2>
+<div class="section">
+<p>
+The table below summarizes white papers that describe the Derby Network Client.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+<th colspan="1" rowspan="1">Navigation Menu Entry</th><th colspan="1" rowspan="1">Title</th>
+</tr>
+
+<tr>
+<td colspan="1" rowspan="1">Functional Spec</td>
+ <td colspan="1" rowspan="1"> <a href="DerbyClientSpec.html">Derby Network Client</a></td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10125"></a><a name="Instruction"></a>
+<h2 class="boxed">Instruction</h2>
+<div class="section">
+<p>
+The online <a href="DerbyTut/index.html">Apache Derby Tutorial</a>
+provides a quick hands-on overview.
+Pointers to
+even more tutorials and other instructional materials are on the
+<a class="external" href="http://wiki.apache.org/db-derby/WorkingWithDerby">Derby Wiki</a>.
+</p>
+</div>
+
+
+<a name="N10137"></a><a name="How+to+Contribute+Papers"></a>
+<h2 class="boxed">How to Contribute Papers</h2>
+<div class="section">
+<p>
+If you have figured out how something works in Derby
+or how to do something cool and have produced a white
+paper you would like to contribute to the Derby web site,
+please
+<a href="../DerbyBugGuidelines.html">open a Jira issue</a>
+with the component set to "Web Site".
+Upload your contribution to that issue with
+the "Attach file to this issue" option.
+It will prompt you to click on
+"Grant license to ASF for inclusion in ASF works",
+and this is the permission we need in place to host your contribution on the
+Derby web site.
+</p>
+<p>
+As time permits, somebody will take the document from the Jira issue
+and put it on the Derby web site.
+You can speed the posting process up by
+<a href="derby_web.html#Testing+New+Pages+for+the+Derby+Site">testing
+your white paper in Forrest</a> to verify it works well before you post it.
+</p>
+<p>
+If you want the paper integrated with the Derby web site, with the
+forrest-generated navigation,
+it is easiest to incorporate these types of files:
+</p>
+<ul>
+
+<li> HTML (an example is <a href="JDBCImplementation.html">Derby JDBC
+ Implementation Notes</a>).</li>
+
+<li> XML, using the
+ <a class="external" href="http://forrest.apache.org/docs/your-project.html">Forrest
+ DTD</a>
+ (an example is <a href="derby_arch.html">Derby Engine Architecture
+ Overview</a>).
+ </li>
+
+<li> ASCII text embedded in XML
+ (an example is in the <a href="derby_web.html">derby_web.html</a>
+ page).
+ </li>
+
+</ul>
+<p>
+That much said, even though your favorite word processing program can
+produce an HTML file, that doesn't necessarily mean that forrest can read it
+and do something visually pleasing with it.
+If forrest can't consume your document,
+or you don't like what forrest did with it,
+or you want to provide your document in a binary format
+it can be included in its native format on the site -- it just
+won't have the forrest-generated left hand navigation and top banner.
+Examples are:
+</p>
+<ul>
+
+<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
+ <a href="../binaries/HOWTO_CJDBC_Derby_v0.2.sxw">Open Office</a>
+ files.
+ </li>
+
+</ul>
+<p> You can also link directly to a file in the Derby code tree;
+for example, to the
+ <a class="external" href="http://svn.apache.org/repos/asf/db/derby/code/trunk/BUILDING.txt">Building Derby</a> file.
+Don't link with a viewcvs URL like the one below because it turns out to put a
+heavier burden on the server than is needed:
+</p>
+<pre class="code">
+ https://svn.apache.org/viewcvs.cgi/*checkout*/db/derby/code/trunk/BUILDING.txt
+</pre>
+<p>
+ViewCVS is good for when you need to browse the history.
+But if all you need to do is display the file,
+link to it like this instead:
+</p>
+<pre class="code">
+ http://svn.apache.org/repos/asf/db/derby/code/trunk/BUILDING.txt
+</pre>
+</div>
+
+
+<p>
+<em>Last Updated: March 30, 2005</em>
+</p>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2004-2012 Apache Software Foundation</div>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/check/referer"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a>
+</div>
+<div id="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0papers/index.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>