; Wed, 19 Dec 2012 18:20:46 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: 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... Date: Wed, 19 Dec 2012 18:20:28 -0000 To: general@db.apache.org From: rhillegas@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121219182046.BA57E2388B6C@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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 @@ + + + + + + + +Apache Derby Web Site + + + + + + + + + +

+ +

+apache > db +

+ + +

+ +

+ + +

+ +

+ + +

+ + + + + +

Font size: + + + +

Apache Derby Web Site

+Web Site Change Notes +
+
+Forrest in a Nutshell +
+Testing New Pages for the Derby Site +
- +Create a Forrest seed site +
- +Add your new page to the seed site +
- +What editor can you use for Forrest XML? +
- +Resolve Forrest DTDs locally +
+
+Updating the Apache Derby web site +
- +1. Install Forrest on your machine +
- +2. Check out the Derby web site pages +
- +3. Modify files in the src tree +
- +4. Build the site +
- +5. Test the changes +
- +6. Adjust the site build - odd diffs +
- +7. Create a patch +
- +8. Commit changes to the src and build/site directories +
- +9. Make web site changes visible +
- +10. Considering a quick fix to the build tree? +
+

+ + +

+The Derby project web site +at +http://db.apache.org/derby +uses +Forrest. +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. +

+ + + +

Web Site Change Notes

+ +

21-Dec-2007: Web site upgraded to Forrest 0.8

The web site was upgraded to build with the latest +release of Forrest, Forrest 0.8.

+ +

12-Aug-2005: Web site upgraded to Forrest 0.7

The web site was recently upgraded to build with the latest +release of Forrest, Forrest 0.7.

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.

+ +

31-Jul-2005: Web site moved from Incubator to Apache DB

+Derby graduated from the Incubator to the Apache DB project, +so the web site moved from +http://incubator.apache.org/derby to +http://db.apache.org/derby. +Specific changes, beginning with SVN revision 226719, included: +

+src/documentation/skinconf.xml: + Changed the group logo, which appears on the masthead, + from the Incubator logo to the Apache DB logo, and updated the bread + crumb trail. +
Updated references and URLs throughout the site from + incubator to db or from incubator.apache.org to db.apache.org. +

+ +

15-May-2005: Version 10.0 manuals moved

+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 +http://db.apache.org/derby/docs/10.0/index.html. +

+ +

27-Jan-2005: Web site upgraded to Forrest 0.6

+The Derby web site was initialized in August 2004 with Forrest 0.5.1. +

+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: +

Source pages: SVN 134379
Built pages: +
- SVN 145725 : manuals/admin,getstart
- SVN 145920 : manuals/develop
- SVN 146259 : manuals/tools
- SVN 146516 : manuals/tuning
- SVN 146733 : manuals/reference
- SVN 148837 : site/skin
- SVN 148838 : site
+ +

+ + + +

Forrest in a Nutshell

+Apache Forrest is an XML documentation framework that is used for +generating static/dynamic web sites. +For many details, see +forrest.apache.org. +

+This web page walks you through using two Forrest commands: +'forrest site' +and +'forrest run'. +

+The 'forrest site' +command consumes the source input files in the +src tree of the project hierarchy +and spits out a static site composed of HTML pages in the +build tree of the project hierarchy. +

+The 'forrest run' command starts up the Jetty web server +that is included in the Forrest distribution on port 8888. +

Warning

+The Derby web site uses Forrest 0.8 and must be built using Forrest 0.8. +

+ + + + +

Testing New Pages for the Derby Site

+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. +

+ +

Create a Forrest seed site

+The +Using Forrest: +A tutorial on how to use Forrest in your own projects guide +provides an excellent overview of Forrest. +Below are some simple steps to get started: +

+Download + Forrest 0.8.
+Install Forrest and set up your environment.
Create a new directory, cd into it, + and enter 'forrest seed' to initialize a new project. +
Enter 'forrest site' to build the site.
Enter 'forrest run' to start the jetty server that is bundled + with Forrest.
Point your browser at localhost:8888.
Look at the sample pages that are included in the seed site.

+ +

Add your new page to the seed site

+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: +

If you have an HTML file, perhaps named your_file.html, +
- One option is to leave the file as is + (previous forrest releases had you rename it to a file + named your_file.ihtml, but support for the ihtml extension + is deprecated in forrest 0.7). + Forrest will convert the file into a new + your_file.html file in the build tree and will add the site + decoration and navigation to it. + The Derby JDBC Implementation + Notes paper is an example of an HTML document + that is stored in the project source tree as an html file. +
- Another option is to rename the file with a .htm + 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 Running DOTS (Database Open + Source Test Suite) with Derby is an example of this approach. +
+ +
You can also create an XML file that uses the Forrest DTD. + The Derby Engine + Architecture Overview is an example. + Also, the site you just seeded provides examples. +

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: + +

+<?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[
+    Put the contents of your text file here ]]></source>
+
+ </body>
+</document>
+

+ + +

The seed site includes a "Samples" tab. + After you create the file for Forrest to ingest, + update the src/documentation/content/xdocs/site.xml file + to include your new page in that tab, as shown below: +
```
+<samples label="Samples" href="samples/" tab="samples">
+  <your_tag label="Your page" href="your_file.html" description="Your test page" />
+
```
+ Notice that at this point you need to refer to the file + as your_file.html even if the source file is + your_file.ihtml or + your_file.xml. +
Execute 'forrest site' to rebuild your site.
Restart the jetty server ('forrest run').
Do you like what Forrest did? If you don't, go back and tweak your + source file.

+ +

What editor can you use for Forrest XML?

+The Forrest web site mentions jEdit, oXygen, xmlspy, +and XMLmind XML Editor (XXE) -- and no doubt many more XML products also work. +

+One Derby community cohort has recently looked at two editors, +which are both quite excellent: +

+jEdit (GPL) with the jEdit XML plugin. +See the +Forrest jEdit configuration instructions.
+XMLBuddy eclipse plugin (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 + File -> Open With -> XMLBuddy because WTP includes the WST + XML editor.)

+If you find other tools that also work well, please let others know +by posting to +derby-dev@db.apache.org. +

+ +

Resolve Forrest DTDs locally

+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: +

<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+   "http://forrest.apache.org/dtd/document-v20.dtd">
+

+To reduce requests to the forrest.apache.org site itself, +it's important to resolve Forrest DTDs locally. +The forrest 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 +Forrest web site. +

+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. +

+ + + + +

Updating the Apache Derby web site

+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. +

+ +

1. Install Forrest on your machine

+If you haven't installed Forrest yet, +install Forrest 0.8 +on your local system. +

+ +

2. Check out the Derby web site pages

+Check the Derby web site files out of the subversion repository: +

+svn co https://svn.apache.org/repos/asf/db/derby/site/trunk
+

+ +

3. Modify files in the src tree

+After checking the site out of subversion, +the web site source is in +src/documentation/content/xdocs and the files processed +("skinned") by Forrest are in build/site. +(Forrest also outputs files to build/webapp and +build/tmp, but we don't commit +those directories to subversion.) +Modifying the web site requires changing files in the +src tree, then building the site with Forrest. +

+The Derby web site is composed of many file types and +it's helpful to understand what Forrest does with them: +

*.xml and *.html: + Forrest reads these files, adds site navigation and + decoration, then outputs them as .html files to the + build directory. +
*.htm: + Forrest copies these files without modifying them to + the build/site directory (in other words, + they don't get site navigation and decoration). +
binary (*.tar.gz, *.zip) and image (*.gif, *.jpg) files: + Forrest copies these files without modifying them to + build/site/binaries + and build/site/images, respectively. +
*.aart : + These files contain ascii stick diagrams that Forrest converts to png, + then outputs to the build/site directory. +
*.cgi : + Forrest copies these files without modifying them to the + build/site directory. +

+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): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Source Location	Description	Tab(s)
xdocs	The root location of the web site source.	Home, Quick Start, Community
xdocs/binaries	Binary files, such as .tar.gz and .ZIP.	Linked to from various pages.
xdocs/images	Image files, such as .gif, .jpg and *.png.	Linked to from various pages.
xdocs/integrate	Documents that explain how to use Derby with some other product.	Resources (Products and Eclipse Plug-ins sections)
xdocs/logo	Apache Derby logo files.	Community
xdocs/manuals	Files that describe the Derby manuals and DITA + processing.	Documentation
xdocs/papers	Miscellaneous contributions.	Resources (Papers section), Community
xdocs/releases	Contains files for the Derby downloads.	Download

+Two files in xdocs +don't get output to the build/site tree; +they control the information and links in the resulting navigation bar: +

+
+tabs.xml: sets up the tabs for the web site. + Over time the specific tabs have changed. +
+ +
+
+site.xml: 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. +
+ +

+ +

4. Build the site

+After modifying files, rebuild the site with the +'forrest site' command. +Do this in the trunk (one level above the src and +build directories). +

Due to FOR-480, +the skinned HTML for the release pages will be output to your +FORREST_HOME/main/site directory. +If you have made changes to the site navigation or to +the release pages themselves copy these files to +build/site/releases +so that they can be checked into subversion with the source +changes. +

+If you run out of memory building the web site, +try setting the ANT_OPTS environment variable to +-mx512M. +

+ +

5. Test the changes

+There are a couple ways (at least) to review changes. +

+One way is to open build/site/index.html with your web browser. +

+Another way is to start the Jetty webserver that is included in +the Forrest distribution: +

forrest run

+After it starts, point your browser at +localhost:8888 and review the new or modified pages. +

+The breadcrumb trail will be different. Instead of this: +

+apache > db > derby
+

+You'll see this with your local Jetty server: +

+apache > db 
+

+The difference in bread crumb behavior is alright, though confusing. +The skinconf.xml specifies the base links for the trail, +then Javascript adds extra breadcrumbs for each directory after the domain. +Extra breadcrumbs +won't be added when the site is viewed locally. + +

+ +

6. Adjust the site build - odd diffs

Derby developers build the site on a variety of platforms, +including Windows, Mac, and Linux. The +svn status command might report modifications to files under +build/site/skin +and to the png files under +build/site/papers +after you build the site, +depending on who last committed those files. +

For example, when you run the forrest site command to build the +site, Forrest generates inconsistent line endings on Windows machines +(see FOR-492 +and FOR-805). +Also png files generated from aart +source may get generated differently on different operating systems. +

As a result, you might get odd diffs under build/site/skin and +the build/site/papers directories.

If you are using a Windows machine to build the site, you +should revert the changes made to the skin directory +before you create the patch. For example:

svn revert build\site\skin\*

If you are using TortoiseSVN, you can use Windows Explorer to revert the +changes.

+ +

7. Create a patch

+Create a patch at the trunk level and only include the +src directory, as shown below: +

svn diff src > changes.diff

+Upload the patch to a Jira issue to make it available to a Derby committer. +

+ +

8. Commit changes to the src and build/site directories

+Apply any patch, if one was provided, then build and test the web site +(Steps 4-6). +

+Commit modified pages in the src and +build/site trees. +The 'forrest site' command also outputs +build/webapp and +build/tmp directories, +but they aren't checked into the subversion repository. +

+If you add or delete a file, you must 'svn add' or 'svn delete' it in the +src and +build/site directory hierarchies. +Do this after 'forrest site' has been run but +before committing changes to the the subversion repository. +

+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 native. +You can do so explicitly with the command shown below: +

svn propset svn:eol-style native filename
+

+However, +the easiest way to manage svn:eol-style is to +automatically set end of line for common file types by adding the +Apache dev list +of files to your ~/.subversion/config file. +

+When you're ready to commit, +one way is to enter the command shown below +one level above the src and +build directories: +

+svn commit --message "here is my commit message" src build/site 
+

+ +

9. Make web site changes visible

+A Derby committer can make web site changes visible as follows: +

+ssh -l your_apache_login people.apache.org
+cd /www/db.apache.org/derby
+svn update
+

+www.apache.org automatically syncs up with people.apache.org every couple hours +(the specific schedule could change). +

+ +

10. Considering a quick fix to the build tree?

+If you modify a file in the build/site tree, +be sure to also change the source file in the src tree. +Otherwise, the next 'forrest site' followed by 'svn commit' +will likely overwrite your changes to the build tree. +

+Last updated Dec 21, 2007 +

+ + +

+ +

+ + + 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 @@ + + + + + + + +Apache Derby Fortune Server Tutorial + + + + + + + + + +

+ +

+apache > db +

+ + +

+ +

+ + +

+ +

+ + +

Blogs and Articles About Derby

+Overview +

+Blogs +

Articles

Tutorials, Tips and Tuning

+Getting Started +

+Features, Hints and Tips +

+Security +

+Performance and Tuning +

Tools and Migration

+Tools +

+Migration +

Applications

+Client +

+Middle Tier +

+Persistence +

+Scalability and Failover +

Integration With Other Products

+Overview +

+What works with Derby? +

+Product Writeups +

Eclipse Plug-ins

+Info +

Papers and Presentations

+Overview +

Derby Engine

Javadoc

+Engine +

+Language +

+Tools +

+API +

+Architecture +

+BTree +

+Disk Page Format +

+How Things Work +

+Intersect & Except +

+JDBC +

+Log Format +

+Logging & Recovery +

+Optimizer +

+Type System +

+Versioning +

Derby Network Client

+Functional Spec +

Derby Tutorial

+Overview +

+Step 1: Install Software +

+Step 2: ij Basics +

+Step 3: Embedded Derby +

+Step 4: Derby Network Server +

Presentations

+ApacheCon +

+Victorian JUG 2008 +

+OSCON 2005 +

+Colorado 2004 +

+ + + +

+ +

+ + +

Font size: + + + +

Apache Derby Fortune Server Tutorial

+Overview +
+Intended Audience +
+Tutorial Topics +
+Download Software +
+Credits and Acknowledgments +
+Revision History +

+ + + +

Overview

+ +Apache Derby, +an Apache DB 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. +

+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 fortune 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. +

+ + + +

Intended Audience

+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. +

+ + + +

Tutorial Topics

+The tutorial is organized into the sections below: +

The Introduction describes + the functionality of the Apache Derby Fortune Server. +
The Getting Started + 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. +
The SQL section + provides nitty gritty details about the Fortune Server database and + shows how to work with databases using ij, + the Derby SQL scripting tool. +
The Java/JDBC 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: +
- How to create a SQL function that generates a random number + using the + Jakarta + Mathematics Library.
- How to create a SQL function that performs regular expression + searches using + Jakarta + Regexp. +
+ +
The Tomcat + section shows a way to embed Derby in + Jakarta + Tomcat and provides a couple web applications that query the + Derby database.

+ + + + +

Download Software

+
Download the Apache Derby Fortune Server distribution + [tar.gz] + [zip]. + Extract it, + then open Fortune/doc/index.html with your web browser. + That opens a local copy of this page. + A good place to start is the + Introduction, + which describes the functionality of the Fortune Server. +
+ +
+
Download and install Jakarta Tomcat 5.0.28 from + http://jakarta.apache.org/tomcat. +
+ +

+ + + +

Credits and Acknowledgments

+Jean Anderson (jta@bristowhill.com) developed this tutorial. +Email her any problems or post them to the Derby user mail list +(http://db.apache.org/derby/derby_mail.html). +

+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 +http://www.ibm.com/developerworks/db2/library/techarticle/dm-0408bader. +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 +FortuneServer and +FortuneServer2 JavaServer Pages. +

+ +Apache Forrest +was used for generating the web-based materials. +

+ + + +

Revision History

+Changes to the Fortune Server Tutorial are summarized in the table below. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

21-Apr-2006	Updated links to point to 10.1 documentation instead of to the + Incubator release documentation. + Also repackaged project with Derby 10.1 jars. +
24-Nov-2004	Incorporated feedback from ApacheCon + (improved Tomcat instructions and + incorporated Ed Korthof's improvements + for the LoadFortune data loading program). +
12-Nov-2004	Added Susan Cline's FortuneServer2 JSP, which invokes a servlet + to dynamically load categories from the Derby database.
10-Nov-2004	Corrected typos in the Getting Started sections.
7-Nov-2004	First document version, PDF generated for ApacheCon US 2004.

+ + +

+ +

+ + + 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 @@ + + + + + + + +Apache Derby Papers + + + + + + + + + +

+ +

+apache > db +

+ + +

+ +

+ + +

+ +

+ + +

Blogs and Articles About Derby

+Overview +

+Blogs +

Articles

Tutorials, Tips and Tuning

+Getting Started +

+Features, Hints and Tips +

+Security +

+Performance and Tuning +

Tools and Migration

+Tools +

+Migration +

Applications

+Client +

+Middle Tier +

+Persistence +

+Scalability and Failover +

Integration With Other Products

+Overview +

+What works with Derby? +

+Product Writeups +

Eclipse Plug-ins

+Info +

Papers and Presentations

Overview

Derby Engine

Javadoc

+Engine +

+Language +

+Tools +

+API +

+Architecture +

+BTree +

+Disk Page Format +

+How Things Work +

+Intersect & Except +

+JDBC +

+Log Format +

+Logging & Recovery +

+Optimizer +

+Type System +

+Versioning +

Derby Network Client

+Functional Spec +

Derby Tutorial

+Overview +

+Step 1: Install Software +

+Step 2: ij Basics +

+Step 3: Embedded Derby +

+Step 4: Derby Network Server +

Presentations

+ApacheCon +

+Victorian JUG 2008 +

+OSCON 2005 +

+Colorado 2004 +

+ + + +

+ +

+ + +

Font size: + + + +

Apache Derby Papers

+Derby Engine +
+Derby Network Client +
+Instruction +
+How to Contribute Papers +

+ + +

+This ad hoc spot in the Derby site hosts papers, and check the +Derby Wiki for more. +

+ + + +

Derby Engine

+The table below summarizes resources that describe the Derby engine. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Navigation Menu Entry	Title
Javadoc	Engine
	Language
	Tools
	API
Architecture	Derby Engine Architecture Overview
BTree	BTree package documentation
Disk Page Format	Derby On Disk Page Format
How Things Work	How Things Work
Intersect & Except	Intersect & Except Design
JDBC	Derby JDBC Implementation Notes
Log Format	Derby Write Ahead Log Format
Logging & Recovery	Derby Logging and Recovery
Optimizer	Derby Optimizer Design
Type System	Derby Type System +(Note: if your browser shows HTML source for this page instead of +displaying it, save the file locally with File -> Save Page As, +then open the file you saved.) +
Versioning	Derby Versioning Scheme

+ + + +

Derby Network Client

+The table below summarizes white papers that describe the Derby Network Client. +

+ + + + + + + + + + + + +

Navigation Menu Entry	Title
Functional Spec	Derby Network Client

+ + + +

Instruction

+The online Apache Derby Tutorial +provides a quick hands-on overview. +Pointers to +even more tutorials and other instructional materials are on the +Derby Wiki. +

+ + + +

How to Contribute Papers

+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 +open a Jira issue +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. +

+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 +testing +your white paper in Forrest to verify it works well before you post it. +

+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: +

HTML (an example is Derby JDBC + Implementation Notes).
XML, using the + Forrest + DTD + (an example is Derby Engine Architecture + Overview). +
ASCII text embedded in XML + (an example is in the derby_web.html + page). +

+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: +

+Running DOTS (Database open Source + Test Suite) with Derby.
The C-JDBC + PDF and + Open Office + files. +

You can also link directly to a file in the Derby code tree; +for example, to the + Building Derby 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: +

+   https://svn.apache.org/viewcvs.cgi/*checkout*/db/derby/code/trunk/BUILDING.txt
+

+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: +

+   http://svn.apache.org/repos/asf/db/derby/code/trunk/BUILDING.txt
+

+ + +

+Last Updated: March 30, 2005 +

+ +

+ + +