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 [19/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/manuals/guidelines.html
==============================================================================
--- websites/production/db/content/derby/manuals/guidelines.html (added)
+++ websites/production/db/content/derby/manuals/guidelines.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,926 @@
+<!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: Writing guidelines</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 class="current">
+<a class="selected" 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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../manuals/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/dita.html">DITA Source</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Writing Guidelines</div>
+</div>
+<div class="menuitem">
+<a href="../manuals/messages.html">Documenting Messages</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docsfaq.html">Writing FAQs</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</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: Writing guidelines</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#New+topics%3A+Choosing+the+correct+topic+type">New topics: Choosing the correct topic type</a>
+</li>
+<li>
+<a href="#New+topics%3A+Using+a+template+to+create+a+new+topic">New topics: Using a template to create a new topic</a>
+</li>
+<li>
+<a href="#New+topics%3A+Selecting+the+best+filename">New topics: Selecting the best filename</a>
+</li>
+<li>
+<a href="#Understanding+DITA+tags">Understanding DITA tags</a>
+</li>
+<li>
+<a href="#Tagging+examples+-+structural+tags">Tagging examples - structural tags</a>
+</li>
+<li>
+<a href="#Tagging+examples+-+textual+tags">Tagging examples - textual tags</a>
+</li>
+<li>
+<a href="#Indexing+guidelines">Indexing guidelines</a>
+</li>
+<li>
+<a href="#Customizing+tables+in+the+Derby+documentation">Customizing tables in the Derby documentation</a>
+</li>
+</ul>
+</div>
+
+<p>
+The Derby documentation is <a href="http://db.apache.org/derby/manuals/dita.html">sourced in DITA</a>.
+The tagging used with DITA is similar to HTML tagging. This page contains guidelines
+for working with DITA topics and tagging.
+</p>
+
+
+<a name="N10014"></a><a name="New+topics%3A+Choosing+the+correct+topic+type"></a>
+<h2 class="boxed">New topics: Choosing the correct topic type</h2>
+<div class="section">
+<p>
+There are three types of topics used in the Derby documentation:
+concepts, reference, and tasks.
+</p>
+<p>
+
+<strong>Concept topics</strong> are overview information that answer the
+question "What is...?". They explain "why" something is important or behaves
+the way it does. Concepts provide the background information users must
+understand before they can complete the tasks successfully.
+</p>
+<p>
+
+<strong>Reference topics</strong> provide detailed information about product
+capabilities for quick reference and for completeness. Reference
+information provides quick access to facts, but no explanation of
+concepts or procedures. Examples of reference topics are the syntax
+for commands, and SQL statements, class descriptions, detailed
+examples, and troubleshooting information.
+</p>
+<p>
+
+<strong>Task topics</strong> answer the question "How do I?". Tasks typically
+include step-by-step instructions. Task topics often list (or link to)
+prerequisites that need to be completed before the user can perform
+the task. Tasks also list (or link to) any restrictions on performing
+the task.
+</p>
+</div>
+
+
+<a name="N10030"></a><a name="New+topics%3A+Using+a+template+to+create+a+new+topic"></a>
+<h2 class="boxed">New topics: Using a template to create a new topic</h2>
+<div class="section">
+<p>When you need to create a new topic, use one of the templates that are
+included with the Derby source files. The templates are located in the
+<strong>\trunk\templates</strong> directory.
+</p>
+</div>
+
+
+<a name="N1003D"></a><a name="New+topics%3A+Selecting+the+best+filename"></a>
+<h2 class="boxed">New topics: Selecting the best filename</h2>
+<div class="section">
+<p>When you create a new topic, use a filename that is easy to understand.
+Filenames should consist of four parts:</p>
+<ol>
+
+<li>1 letter that indicates the type of topic: r=reference, c=concept, t=task</li>
+
+<li>Several letters that designate the abbreviation for the manual that the topic is in.
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Abbreviation</th>
+ <th colspan="1" rowspan="1">Derby Manual</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">admin</td>
+ <td colspan="1" rowspan="1">Derby Server and Administration Guide</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">dev</td>
+ <td colspan="1" rowspan="1">Derby Developer's Guide</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">gs</td>
+ <td colspan="1" rowspan="1">Getting Started with Derby</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">ref</td>
+ <td colspan="1" rowspan="1">Derby Reference Manual</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">tools</td>
+ <td colspan="1" rowspan="1">Derby Tools and Utilities Guide</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">tuning</td>
+ <td colspan="1" rowspan="1">Tuning Derby</td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">wwd</td>
+ <td colspan="1" rowspan="1">Working with Derby</td>
+
+</tr>
+
+</table>
+
+</li>
+
+<li>Several letters that indicate a category of information</li>
+
+<li>Several letters that specify the exact information in the file</li>
+
+</ol>
+<p>
+The following table shows some examples of good filenames.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Information in the topic</strong></td>
+ <td colspan="1" rowspan="1"><strong>Sample filename</strong></td>
+ <td colspan="1" rowspan="1"><strong>Comments</strong></td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">A new function, ROUND, is being documented in the Reference Manual
+ </td>
+ <td colspan="1" rowspan="1">rreffuncround</td>
+ <td colspan="1" rowspan="1">If all functions start with <span class="codefrag">rreffunc</span>, then they will be
+ grouped together alphabetically which makes the files that discuss functions
+ easier to find when the files need to be updated.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">The exclusive lock, is being documented in the Developers Guide
+ </td>
+ <td colspan="1" rowspan="1">cdevlocksshared</td>
+ <td colspan="1" rowspan="1">Because this is a concept topic in the
+ developers guide about locks, the beginning of the topic filename is
+ <span class="codefrag">cdevlocks</span>. The end of the filename <span class="codefrag">shared</span>
+ indicates the specific type of locks that the topic describes.
+ <br>
+
+<br>
+ The description of the support Derby has for shared locks should be documented
+ in a concept topic. How users set the locks should be documented in a task topic.
+ Information, such a table listing compatibility between the types of locks,
+ should be documented in a reference topic.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">A new utility, abc, is being documented in the Tools and Utilities Guide
+ </td>
+ <td colspan="1" rowspan="1">ttoolsabcstarting</td>
+ <td colspan="1" rowspan="1">This topic is a task that describes how to start the abc utility.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1012B"></a><a name="Understanding+DITA+tags"></a>
+<h2 class="boxed">Understanding DITA tags</h2>
+<div class="section">
+<p>The tags that are used in DITA topics are similar to HTML and XML tags.</p>
+<ul>
+
+<li>Structural tags: paragraphs, lists, tables, syntax diagrams, index entries</li>
+
+<li>Textual tags: external links, inline examples, notes</li>
+
+</ul>
+<p>The next 2 sections describe these tags and provides tagging examples.
+</p>
+<p>
+If you have questions about DITA tagging,
+ask on the <a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+</div>
+
+
+<a name="N10148"></a><a name="Tagging+examples+-+structural+tags"></a>
+<h2 class="boxed">Tagging examples - structural tags</h2>
+<div class="section">
+<p>The following table lists the proper structural tags to use for the most common
+features within the Derby topics.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Feature</strong></td>
+ <td colspan="1" rowspan="1"><strong>Tag to use</strong></td>
+ <td colspan="1" rowspan="1"><strong>Comments</strong></td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Paragraphs</strong>
+ </td>
+ <td colspan="1" rowspan="1"><p></td>
+ <td colspan="1" rowspan="1">A paragraph tag is used for a block of text that contains a single main idea.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Bulleted lists</strong> (also known as unordered lists)</td>
+ <td colspan="1" rowspan="1"><ul> and <li></td>
+ <td colspan="1" rowspan="1">The list starts with the <ul> tag. For each bullet that you want in the list, use a <li> tag.
+ In an unordered list, the order of the list items is not significant. The output displays a "bullet" character at the beginning of each item.
+ <p>
+ For example: <br>
+
+<br>
+ <ul><br>
+ <li>This is an item in an unordered list.</li><br>
+ <li>To separate it from other items in the list, the formatter puts a bullet beside it.</li><br>
+ <li>This is the last list item in our unordered list.</li><br>
+ </ul>
+ </p>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Tables</strong></td>
+ <td colspan="1" rowspan="1"><table></td>
+ <td colspan="1" rowspan="1">There are several tags that you need to use to create a table.
+ The simpliest type of table uses the following tagging. For more advanced
+ tagging see the section below on "Customizing tables in the Derby documentation".
+ <p>
+<table><br>
+<tgroup cols="3" colsep="1" rowsep="1"><br>
+<colspec colname="1"><br>
+<colspec colname="2"><br>
+<colspec colname="3"><br>
+<thead><br>
+<row><br>
+<entry colname="1">Column Name</entry><br>
+<entry colname="2">Type</entry><br>
+<entry colname="3">Description</entry><br>
+</row><br>
+</thead><br>
+<tbody><br>
+<row> <br>
+<entry colname="1">CONSTRAINTID</entry><br>
+<entry colname="2">CHAR</entry> <br>
+<entry colname="3">Unique identifier for the constraint</entry><br>
+</row><br>
+<row><br>
+<entry colname="1">CHECKDEFINITION</entry><br>
+<entry colname="2">LONG VARCHAR</entry><br>
+<entry colname="3">Text of check constraint definition</entry><br>
+</row><br>
+</tbody><br>
+</tgroup><br>
+</table><br>
+
+</p>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Index entries</strong></td>
+ <td colspan="1" rowspan="1"><indexterm></td>
+ <td colspan="1" rowspan="1">Indexing tags are used to index important terms. Index entries are displayed
+ at the end of the PDF output for each Derby manual. When there is an Information Center,
+ the index terms are added as metadata to help in searching for content in the Information Center.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Syntax diagrams</strong></td>
+ <td colspan="1" rowspan="1"><codeblock></td>
+ <td colspan="1" rowspan="1">Use the <codeblock> tag when you need to specify the syntax
+ for commands and SQL statements. The content of this tag preserves line endings
+ and the output is in a monospaced font. See the topic
+ <a href="http://db.apache.org/derby/docs/dev/getstart/rgsdocs10012.html">SQL Syntax</a>
+ for the correct symbols to use in Derby syntax diagrams.
+ <br>
+
+<br>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Definition lists</strong></td>
+ <td colspan="1" rowspan="1"><dl><br>
+ <dlentry><br>
+ <dt><br>
+ <dd></td>
+ <td colspan="1" rowspan="1">A definition list is a list of terms and their corresponding definitions.
+ The term appears flush left, followed by the description or definition that is
+ indented starting on the next line. Definition list require a series of tags.
+ <p>
+ For example:<br>
+
+<br>
+<dl><br>
+<dlentry><br>
+<dt>server</dt><br>
+<dd>The name of the machine where the server is running.</dd><br>
+</dlentry><br>
+<dlentry><br>
+<dt>port</dt><br>
+<dd>The port that the server is listening to.</dd><br>
+</dlentry><br>
+<dlentry><br>
+<dt>databaseName</dt><br>
+<dd>The name of the database that you are connecting to. </dd><br>
+</dlentry><br>
+</dl><br>
+
+</p>
+
+</td>
+
+</tr>
+
+
+</table>
+</div>
+
+
+<a name="N1025D"></a><a name="Tagging+examples+-+textual+tags"></a>
+<h2 class="boxed">Tagging examples - textual tags</h2>
+<div class="section">
+<p>The following table lists the proper textual tags to use for the most common
+features within the Derby topics.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Feature</strong></td>
+ <td colspan="1" rowspan="1"><strong>Tag to use</strong></td>
+ <td colspan="1" rowspan="1"><strong>Comments</strong></td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Links to external sites</strong></td>
+ <td colspan="1" rowspan="1"><xref></td>
+ <td colspan="1" rowspan="1">Use the cross-reference <xref> tag to specify a link to an
+ external Web page. You should specify the scope attribute to "external" when
+ you create the cross-reference.
+ <p>
+ For example:<br>
+ <xref href=http://db.apache.org/derby/manuals/index.html scope="external">Derby Documentation</xref>
+ </p>
+
+<p>
+ To create links to other topics in the Derby documentation, edit the ditamap
+ for the source manual to specify a related link to another Derby topic.
+ </p>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Code or examples in paragraphs</strong></td>
+ <td colspan="1" rowspan="1"><codeph></td>
+ <td colspan="1" rowspan="1">The code phrase tag represents a snippet of code within the main flow of text.
+ The code phrase is displayed in a monospaced font for emphasis.
+ <p>
+ For example:<br>
+ A runtime rollback is a system-generated rollback of a statement or
+ transaction by Derby, as opposed to an explicit <codeph>rollback</codeph>
+ call from your application.
+ </p>
+
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Notes</strong></td>
+ <td colspan="1" rowspan="1"><note></td>
+ <td colspan="1" rowspan="1">A note tag contains information, differentiated from the main text, that
+ expands on or calls attention to a particular point. Notes are displayed in
+ their own paragraph and do not need to be inside of a paragraph <p> tag.
+ You can specify a type of note, which displays as the lable for the note text
+ in the output. If you do not specify the type of note, the label is "Note:".
+ Commonly used types are: Attention, Fastpath, Important, Remember, Restriction, and Tip.
+ <p>
+ For example, this tagging
+ <note="tip"> You can override the default locale for ij with a
+ property on the JVM.</note>
+ </p>
+
+<p>
+ produces this result:
+ </p>
+
+<p>
+ Tip: You can override the default locale for ij with a property on the JVM.
+ </p>
+
+</td>
+
+</tr>
+
+
+</table>
+</div>
+
+
+
+<a name="N102CE"></a><a name="Indexing+guidelines"></a>
+<h2 class="boxed">Indexing guidelines</h2>
+<div class="section">
+<p>
+<strong>What to index? </strong>You should index general and specific terms.
+You should look at the index entries in other topics to see what valid entries
+look like. Nesting index terms can be very useful.
+</p>
+<p>
+<strong>What tags do I use to index terms? </strong>In Derby, the index
+entries are inserted inside the <prolog> tag. The <prolog> tag is
+immediately after the <title> and <shortdesc> tags.
+Index entries use the <indexterm> tag, but that tag must be nested
+inside serveral other tags. For example, if the index term is CREATE TABLE and
+the topic currently does not have any index entries, the tags that you would
+need are:
+</p>
+<p>
+<prolog><br>
+<metadata><br>
+<keywords><br>
+<indexterm>CREATE TABLE</indexterm><br>
+</keywords><br>
+</metadata><br>
+</prolog><br>
+
+</p>
+<p>
+If the topic already has at least one index term, then you only need to add
+the new term inside the keywords tag.
+</p>
+<p>
+For example:<br>
+
+<br>
+<indexterm>CREATE TABLE</indexterm>
+</p>
+<p>
+<strong>How do I add an index term? </strong>Add the <indexterm>
+tag and enter the term that you want to use. Typically you specify a general
+category of information followed by a specify term. For example, if you have
+added a new parameter called "abc", you would use "parameters" as the general
+catagory and "abc" as the specific term. The tagging for this entry is:
+</p>
+<pre class="code">
+<indexterm>parameters<indexterm>abc</indexterm></indexterm>
+</pre>
+<p>The output appears like this:
+</p>
+<pre class="code">
+parameters
+ abc
+</pre>
+<p>
+The specific term "abc" is nested under the general term "properties". Nesting
+index terms can be very useful, when done properly. You should never nest terms
+more than 3 levels.
+</p>
+<p>
+The following examples show how to index properly.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><strong>Bad Indexing</strong></td>
+<td colspan="1" rowspan="1"><strong>Good Indexing</strong></td>
+<td colspan="1" rowspan="1"><strong>Explanation</strong></td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">tables, constraints 16
+tables, locking 18
+tables, altering 17
+tables, temporary 16
+</pre>
+</td>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">tables
+ constraints 16
+ locking 18
+ altering 17
+ temporary 16
+</pre>
+</td>
+
+<td colspan="1" rowspan="1">The primary entry is repeated unnecessarily.
+Combine all of the secondary entries under one primary entry.</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">XML operators 21, 22, 24, 30, 32, 33
+</pre>
+
+</td>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">XML operators
+ XMLEXISTS 21, 30
+ XMLPARSE 22, 32
+ XMLQUERY 24, 33
+ XMLSERIALIZE 24, 33
+</pre>
+
+</td>
+
+<td colspan="1" rowspan="1">An entry should have no more than two page references.
+Split the entry into logical secondary entries.</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">functions
+ ACOS 70
+ ASIN 70
+ ATAN 71
+ DEGREES 81
+ FLOOR 82
+Function
+ CEIL 75
+ CEILING 75
+ LOG 86
+</pre>
+
+</td>
+
+<td colspan="1" rowspan="1">
+
+<pre class="code">functions
+ ACOS 70
+ ASIN 70
+ ATAN 71
+ CEIL 75
+ CEILING 75
+ DEGREES 81
+ FLOOR 82
+ LOG 86
+</pre>
+
+</td>
+
+<td colspan="1" rowspan="1">Entries that are capitalized and worded inconsistently
+appear as separate entries, even though they are related. Make the primary
+entries consistent (in this case, plural, non-capitalized) so that all
+of the secondary entries appear under one primary entry.</td>
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10374"></a><a name="Customizing+tables+in+the+Derby+documentation"></a>
+<h2 class="boxed">Customizing tables in the Derby documentation</h2>
+<div class="section">
+<p>
+<strong>How do I specify the widths of each column in the table? </strong>
+You can specify the column widths by using the colwidth attribute in the
+<colspec> tag. The <colspec> tag appears just after
+the <tgroup> tag. When you use the colwidth attribute, You specify
+the percent that the column width should be of the total width of the table.
+If you want the column to be 25% of the total width of the table,you specify
+<strong>25*</strong> in the colwidth attribute for that column.
+</p>
+<p>
+For example:<br>
+
+<br>
+<tgroup cols="3" colsep="1" rowsep="1"><br>
+<colspec colname="1" colwidth=25*"><br>
+<colspec colname="2" colwidth=25*><br>
+<colspec colname="3" colwidth=50*><br>
+
+</p>
+<p>
+<strong>How do I specify the alignment of the text in the header row?</strong>
+You can specify the heading aligment by using the align and valign attributes
+in the <entry> tag. Use the align attribute to specify horizontal alignment.
+Use the valign attribute to specify vertical alignment.
+</p>
+<p>
+For example:<br>
+
+<br>
+<thead><br>
+<row><br>
+<thead><br>
+<entry align="left" colname="1" valign="bottom">Column Name</entry><br>
+<entry align="left" colname="2" valign="bottom">Type</entry><br>
+<entry align="left" colname="3" valign="bottom">Description</entry><br>
+</row><br>
+</thead><br>
+
+</p>
+<p>Valid settings for the align attribute are: left, right, center, justify.
+<br>
+Valid settings for the valign attribute are: top, middle, bottom.
+</p>
+</div>
+
+
+<p>
+
+<br>
+Please post feedback to the
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+
+
+<p>
+<em>Last Updated: March 19, 2007</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="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0manuals/guidelines.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: websites/production/db/content/derby/manuals/index.html
==============================================================================
--- websites/production/db/content/derby/manuals/index.html (added)
+++ websites/production/db/content/derby/manuals/index.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,1370 @@
+<!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: Documentation</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 class="current">
+<a class="selected" 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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
+</div>
+<div class="menuitem">
+<a href="../manuals/dita.html">DITA Source</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/guidelines.html">Writing Guidelines</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/messages.html">Documenting Messages</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docsfaq.html">Writing FAQs</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</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: Documentation</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Descriptions">Descriptions</a>
+</li>
+<li>
+<a href="#latest">Latest Alpha Manuals</a>
+</li>
+<li>
+<a href="#docs_10.9">10.9 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.8">10.8 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.7">10.7 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.6">10.6 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.5">10.5 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.4">10.4 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.3">10.3 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.2">10.2 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.1">10.1 Manuals</a>
+</li>
+<li>
+<a href="#docs_10.0">10.0 Manuals</a>
+</li>
+<li>
+<a href="#javadoc">Internal API documentation</a>
+</li>
+<li>
+<a href="#doc_issues">Reporting Documentation Issues</a>
+</li>
+</ul>
+</div>
+
+
+<a name="N1000D"></a><a name="Descriptions"></a>
+<h2 class="boxed">Descriptions</h2>
+<div class="section">
+<p>
+The Derby documentation is available on-online.
+A description of each manual is below:
+</p>
+<ul>
+
+<li>
+<p>
+<em>Derby API Reference</em>:
+ An API Reference that is automatically generated for all public Derby
+ classes. No API Reference is provided for the JDBC API, which is part of the
+ Java 2 Platform, Standard Edition.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Getting Started with Derby</em>:
+ Describes how to install and configure Derby. Includes a self-study
+ tutorial for users new to Derby and a quick-start guide for experienced
+ JDBC users. Introduces the <span class="codefrag">sysinfo</span> and <span class="codefrag">ij</span> tools that
+ come with Derby. Describes the libraries and scripts that are included
+ with Derby.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Working with Derby</em>:
+ 10.0 - 10.2 releases only; A self-study guide that includes hands-on activities which demonstrate
+ how to use Derby in embedded and client-server configurations.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Derby Reference Manual</em>:
+ Provides reference information,
+ including SQL syntax and descriptions of the system catalogs.
+ </p>
+</li>
+
+<li>
+<p>
+<em>Derby Developer's Guide</em>:
+ Describes how to use JDBC to access Derby databases.
+ It is intended for developers building Derby applications.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Tuning Derby</em>:
+ Explains how to tune Derby for performance.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Derby Server and Administration Guide</em>:
+ Describes how to use the Derby Network Server and how
+ to perform administrative tasks such as backing up databases.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Derby Tools and Utilities Guide</em>:
+ Explains the ins and outs of <span class="codefrag">ij</span>, <span class="codefrag">dblook</span> and
+ <span class="codefrag">sysinfo</span>, and describes bulk export and import.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Internal API documentation</em>:
+ Automatically generated API documentation that describes packages,
+ classes, methods and parameters in the source code. The grammar for
+ SQL (as implemented in Derby) and ij is also described in BNF.
+ Generally useful only for Derby developers.
+ </p>
+
+</li>
+
+
+</ul>
+</div>
+
+
+<a name="N10067"></a><a name="latest"></a>
+<h2 class="boxed">Latest Alpha Manuals</h2>
+<div class="section">
+<p>The latest development version of the manuals, corresponding to the
+Derby alpha codeline, are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a class="external" href="https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/getstart/getstartderby.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/ref/refderby.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/devguide/derbydev.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/tuning/tuningderby.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/tools/derbytools.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<th colspan="2" rowspan="1">Brazilian Portuguese</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Introdução ao Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/getstart/getstartderby.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/getstart/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Manual de Referência do Derby</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/ref/refderby.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/ref/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Guia do Servidor e Administração do Derby</em></td>
+ <td colspan="1" rowspan="1">[<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/pt_BR/adminguide/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<th colspan="2" rowspan="1">Japanese</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>??????????????? Apache Derby</em></td>
+ <td colspan="1" rowspan="1">
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/ja_JP/getstart/index.html">HTML:??????????????????</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby ?????????????????????????????????</em></td>
+ <td colspan="1" rowspan="1">
+ [<a class="external" href="https://builds.apache.org/job/Derby-docs/lastSuccessfulBuild/artifact/trunk/out/ja_JP/ref/index.html">HTML:??????????????????</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1019A"></a><a name="docs_10.9"></a>
+<h2 class="boxed">10.9 Manuals</h2>
+<div class="section">
+<p>The 10.9 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.9/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.9/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.9/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.9/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.9/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.9/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.9/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.9/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1024F"></a><a name="docs_10.8"></a>
+<h2 class="boxed">10.8 Manuals</h2>
+<div class="section">
+<p>The 10.8 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.8/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.8/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.8/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.8/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.8/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.8/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.8/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.8/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10304"></a><a name="docs_10.7"></a>
+<h2 class="boxed">10.7 Manuals</h2>
+<div class="section">
+<p>The 10.7 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.7/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.7/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.7/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.7/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.7/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.7/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.7/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.7/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N103B9"></a><a name="docs_10.6"></a>
+<h2 class="boxed">10.6 Manuals</h2>
+<div class="section">
+<p>The 10.6 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.6/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.6/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.6/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.6/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.6/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.6/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.6/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.6/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1046E"></a><a name="docs_10.5"></a>
+<h2 class="boxed">10.5 Manuals</h2>
+<div class="section">
+<p>The 10.5 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.5/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.5/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.5/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.5/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.5/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.5/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.5/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.5/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10523"></a><a name="docs_10.4"></a>
+<h2 class="boxed">10.4 Manuals</h2>
+<div class="section">
+<p>The 10.4 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.4/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.4/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.4/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.4/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.4/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.4/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.4/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.4/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N105D8"></a><a name="docs_10.3"></a>
+<h2 class="boxed">10.3 Manuals</h2>
+<div class="section">
+<p>The 10.3 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.3/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.3/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.3/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.3/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.3/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.3/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.3/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.3/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1068D"></a><a name="docs_10.2"></a>
+<h2 class="boxed">10.2 Manuals</h2>
+<div class="section">
+<p>The 10.2 manuals are listed in this section.
+ </p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.2/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.2/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Working With Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/workingwithderby/WorkingWithDerby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/workingwithderby/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<th colspan="2" rowspan="1">Brazilian Portuguese</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Introdução ao Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.2/pt_BR/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/pt_BR/getstart/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Manual de Referência do Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/pt_BR/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/pt_BR/ref/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Guia do Servidor e Administração do Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.2/pt_BR/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.2/pt_BR/adminguide/index.html">HTML Páginas</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N107AA"></a><a name="docs_10.1"></a>
+<h2 class="boxed">10.1 Manuals</h2>
+<div class="section">
+<p>
+Derby adopted the Darwin Information Typing Architecture (DITA) XML
+format for the 10.1 Derby manuals.
+For a description of this Derby documentation project see the
+<a href="dita.html">Apache Derby: DITA-sourced documentation</a> page.
+Please participate in the
+<a href="../derby_mail.html">Derby mail list</a>
+discussions about format.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.1/publishedapi/index.html">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1"> [<a target="_blank" class="fork" href="../docs/10.1/getstart/getstartderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/getstart/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.1/ref/refderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/ref/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.1/devguide/derbydev.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/devguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.1/tuning/tuningderby.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/tuning/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.1/adminguide/derbyadmin.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/adminguide/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">[<a target="_blank" class="fork" href="../docs/10.1/tools/derbytools.pdf">PDF</a>]
+ [<a target="_blank" class="fork" href="../docs/10.1/tools/index.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10867"></a><a name="docs_10.0"></a>
+<h2 class="boxed">10.0 Manuals</h2>
+<div class="section">
+<p>
+The 10.0 manuals are the files
+that were originally contributed to Apache.
+Before reporting a problem in one of these manuals, please check
+to see if the problem still exists in the 10.1 manuals.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">API Reference</td>
+ <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../docs/10.0/publishedapi/">HTML</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">All docs </td>
+ <td colspan="1" rowspan="1">
+ [<a href="../docs/docs-10.0.zip">zip</a>]
+ [<a href="../docs/docs-10.0.tar.gz">tar.gz</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Getting Started with Derby</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/getstart/gspr02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Reference Manual</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/reference/sqlj02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Developer's Guide</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/develop/develop02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Tuning Derby</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/tuning/perf02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Server and Administration Guide</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/admin/hubprnt02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1"><em>Derby Tools and Utilities Guide</em></td>
+ <td colspan="1" rowspan="1">
+ [<a target="_blank" class="fork" href="../docs/10.0/manuals/tools/tools02.html">HTML Pages</a>]
+ </td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10913"></a><a name="javadoc"></a>
+<h2 class="boxed">Internal API documentation</h2>
+<div class="section">
+<p>A recent version of the internal API documentation for Derby.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="2" rowspan="1">English</th>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">Engine</td>
+ <td colspan="1" rowspan="1"><a class="external" href="https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/engine/index.html">HTML Pages</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">Language (grammar)</td>
+ <td colspan="1" rowspan="1"><a class="external" href="https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/language/sqlgrammar.html">HTML Pages</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">Testing</td>
+ <td colspan="1" rowspan="1"><a class="external" href="https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/testing/index.html">HTML Pages</a></td>
+
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">Tools (grammar)</td>
+ <td colspan="1" rowspan="1"><a class="external" href="https://builds.apache.org/job/Derby-trunk/lastSuccessfulBuild/artifact/trunk/javadoc/tools/ij.html">HTML Pages</a></td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N10968"></a><a name="doc_issues"></a>
+<h2 class="boxed">Reporting Documentation Issues</h2>
+<div class="section">
+<p>
+Please post any technical errors (incorrect information)
+to <a href="../DerbyBugGuidelines.html">Jira</a>.
+</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="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%A0manuals/index.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: websites/production/db/content/derby/manuals/messages.html
==============================================================================
--- websites/production/db/content/derby/manuals/messages.html (added)
+++ websites/production/db/content/derby/manuals/messages.html Wed Dec 19 18:20:21 2012
@@ -0,0 +1,255 @@
+<!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: Documenting messages</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 class="current">
+<a class="selected" 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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../manuals/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/dita.html">DITA Source</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/guidelines.html">Writing Guidelines</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Documenting Messages</div>
+</div>
+<div class="menuitem">
+<a href="../manuals/docsfaq.html">Writing FAQs</a>
+</div>
+<div class="menuitem">
+<a href="../manuals/docscheck.html">Release Checklist</a>
+</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: Documenting messages</h1>
+
+
+<p>
+Error and warning messages are documented in the Derby Reference Manual.
+When you add internationalized messages to the Derby engine, add the messages to
+the xml descriptors file that is located in <span class="codefrag">..java/engine/org/apache/derby/loc/messages.xml</span>.
+Specify friendly names for the message arguments. The friendly names appear in the SQLState tables in
+the Derby Reference Manual. Avoid vacuous names like "value". Useful, friendly names are:
+</p>
+
+<ul>
+
+<li>authorizationID</li>
+
+<li>columnName</li>
+
+<li>constraintName</li>
+
+<li>databaseName</li>
+
+<li>indexName</li>
+
+<li>objectName</li>
+
+<li>tableName</li>
+
+<li>triggerName</li>
+
+<li>viewName</li>
+
+</ul>
+
+
+<p>
+Make sure that you list the friendly argument names in the <strong>numeric</strong> order that they appear in their messages.
+For instance, for the following message...
+</p>
+
+
+<p class="code-block">Table {1} in schema {0} cannot be indexed.
+</p>
+
+
+<p>
+...the order of arguments would be...
+</p>
+
+
+<p class="code-block">schemaName
+tableName
+</p>
+
+
+<p>
+<strong>Do not edit the java/engine/org/apache/derby/loc/messages_en.properties file</strong>. This file
+has been removed from code management and is now generated from
+messages.xml during the Derby build.</p>
+
+
+<p>The MessageBuilder utility takes the content of the <span class="codefrag">..java/engine/org/apache/derby/loc/messages.xml</span>
+file, and updates the topic in the Derby Reference Manual that lists all of the
+messages. That topic is <strong>rrefexcept71493.dita</strong>.
+</p>
+
+
+<p>
+Please post feedback to the
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</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="feedback">
+ Send feedback about the website to:
+ <a id="feedbackto" href="mailto:derby-user@db.apache.org?subject=Feedback%C2%A0manuals/messages.html">derby-user@db.apache.org</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>