You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by jt...@apache.org on 2006/11/02 21:54:12 UTC
svn commit: r470517 - in /db/derby/site/trunk: build/site/
build/site/manuals/ src/documentation/content/xdocs/
src/documentation/content/xdocs/manuals/
Author: jta
Date: Thu Nov 2 12:54:11 2006
New Revision: 470517
URL: http://svn.apache.org/viewvc?view=rev&rev=470517
Log:
DERBY-1980 Updated the Documentation tab on the web site: added new messages
page and modified writing guidelines page.
Patch contributed by Laura Stewart <sc...@gmail.com>
Added:
db/derby/site/trunk/build/site/manuals/messages.html (with props)
db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml (with props)
Modified:
db/derby/site/trunk/build/site/linkmap.html
db/derby/site/trunk/build/site/manuals/dita.html
db/derby/site/trunk/build/site/manuals/guidelines.html
db/derby/site/trunk/build/site/manuals/index.html
db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml
db/derby/site/trunk/src/documentation/content/xdocs/site.xml
Modified: db/derby/site/trunk/build/site/linkmap.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/linkmap.html?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/build/site/linkmap.html (original)
+++ db/derby/site/trunk/build/site/linkmap.html Thu Nov 2 12:54:11 2006
@@ -122,6 +122,9 @@
<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>
<div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Other Products</div>
<div id="menu_1.6" class="menuitemgroup">
@@ -481,7 +484,13 @@
<ul>
<li>
-<a href="manuals/guidelines.html">Writing Guidelines</a> _________________________ <em>ditaguid</em>
+<a href="manuals/guidelines.html">Writing Guidelines</a> _________________________ <em>guidelines</em>
+</li>
+</ul>
+
+<ul>
+<li>
+<a href="manuals/messages.html">Documenting Messages</a> _________________________ <em>messages</em>
</li>
</ul>
Modified: db/derby/site/trunk/build/site/manuals/dita.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/dita.html?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Thu Nov 2 12:54:11 2006
@@ -71,6 +71,9 @@
<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>
<div class="searchbox">
<hr>
Modified: db/derby/site/trunk/build/site/manuals/guidelines.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/guidelines.html?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/build/site/manuals/guidelines.html (original)
+++ db/derby/site/trunk/build/site/manuals/guidelines.html Thu Nov 2 12:54:11 2006
@@ -71,6 +71,9 @@
<div class="menupage">
<div class="menupagetitle">Writing Guidelines</div>
</div>
+<div class="menuitem">
+<a href="../manuals/messages.html">Documenting Messages</a>
+</div>
</div>
<div class="searchbox">
<hr>
@@ -101,23 +104,28 @@
<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="#Tagging+guidelines">Tagging guidelines</a>
+<a href="#Understanding+DITA+tags">Understanding DITA tags</a>
+</li>
+<li>
+<a href="#Tagging+examples">Tagging examples</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 sourced in DITA. The tagging used with DITA is
-similar to HTML tagging. This page contains guidelines
+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="N10010"></a><a name="New+topics%3A+Choosing+the+correct+topic+type"></a>
+<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>
@@ -151,7 +159,7 @@
</div>
-<a name="N1002C"></a><a name="New+topics%3A+Using+a+template+to+create+a+new+topic"></a>
+<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
@@ -161,15 +169,33 @@
</div>
-<a name="N10036"></a><a name="Tagging+guidelines"></a>
-<h2 class="boxed">Tagging guidelines</h2>
+<a name="N1003A"></a><a name="Understanding+DITA+tags"></a>
+<h2 class="boxed">Understanding DITA tags</h2>
<div class="section">
-<p>The following table lists the proper tags to use for the most common
-features within the Derby topics. If you are not certain which tags to use,
+<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 section describes 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>
-<table class="ForrestTable" cellspacing="1" cellpadding="4">
+</div>
+
+<a name="N10057"></a><a name="Tagging+examples"></a>
+<h2 class="boxed">Tagging examples</h2>
+<div class="section">
+<p>The following table lists the proper tags to use for the most common
+features within the Derby topics.
+</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
@@ -179,21 +205,230 @@
</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">Index entries</td>
- <td colspan="1" rowspan="1"><indexterm></td>
- <td colspan="1" rowspan="1">See the section below for Indexing guidelines.</td>
+<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>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>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>
+
+
+<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="N1006E"></a><a name="Indexing+guidelines"></a>
+<a name="N101BB"></a><a name="Indexing+guidelines"></a>
<h2 class="boxed">Indexing guidelines</h2>
<div class="section">
<p>
@@ -203,39 +438,42 @@
</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
+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:
-
-<prolog>
- <metadata>
- <keywords>
- <indexterm>CREATE TABLE</indexterm>
- </keywords>
- </metadata>
-</prolog>
+</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. For example:
+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>
+<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>>
+<indexterm>parameters<indexterm>abc</indexterm></indexterm>
</pre>
<p>The output appears like this:
</p>
@@ -352,21 +590,70 @@
<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>
+of the secondary entries appear under one primary entry.</td>
</tr>
</table>
</div>
+<a name="N10261"></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.
+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: October 27, 2006</em>
+<em>Last Updated: November 2, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/build/site/manuals/index.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/index.html?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/build/site/manuals/index.html (original)
+++ db/derby/site/trunk/build/site/manuals/index.html Thu Nov 2 12:54:11 2006
@@ -71,6 +71,9 @@
<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>
<div class="searchbox">
<hr>
Added: db/derby/site/trunk/build/site/manuals/messages.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/messages.html?view=auto&rev=470517
==============================================================================
--- db/derby/site/trunk/build/site/manuals/messages.html (added)
+++ db/derby/site/trunk/build/site/manuals/messages.html Thu Nov 2 12:54:11 2006
@@ -0,0 +1,172 @@
+<!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.7">
+<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">
+<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>
+<div class="header">
+<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>
+<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>
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Home</a>
+</li>
+<li>
+<a class="base-not-selected" href="../quick_start.html">Quick Start</a>
+</li>
+<li>
+<a class="base-not-selected" href="../derby_downloads.html">Download</a>
+</li>
+<li>
+<a class="base-not-selected" href="../derby_comm.html">Community</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../manuals/index.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../integrate/index.html">Resources</a>
+</li>
+</ul>
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<div id="level2tabs"></div>
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+// --></script>
+</div>
+<div class="breadtrail">
+
+
+ </div>
+<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>
+<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 attr="value" name="Search" value="Search" type="submit">
+</form>
+</div>
+<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>
+<div id="credit2"></div>
+</div>
+<div id="content">
+<div class="trail">
+<text>Font size:</text>
+ <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 <strong>..java/engine/org/apache/derby/loc/messages.xml</strong>.
+Specify friendly names for the message arguments. The friendly names appear in the SQLState tables in
+the Derby Reference Manual. Valid 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>valueName</li>
+
+<li>viewName</li>
+
+</ul>
+
+<p>
+<strong>Do not edit the java/engine/apache/derby/loc/messages.xml file</strong>. This file
+has been removed from code management and is now generated from
+messages.xml during the Derby build.</p>
+
+
+<p>A utility takes the content of the <strong>..java/engine/org/apache/derby/loc/messages.xml</strong>
+file, and updates the topic in the Derby Reference Manual that lists all of the
+messages. That topic is rrefexcept71493.dita.
+</p>
+
+
+<p>
+Please post feedback to the
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+
+
+<p>
+<em>Last Updated: November 2, 2006</em>
+</p>
+
+</div>
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright ©
+ 2004-2006 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>
+</div>
+</body>
+</html>
Propchange: db/derby/site/trunk/build/site/manuals/messages.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml Thu Nov 2 12:54:11 2006
@@ -20,11 +20,10 @@
<header>
<title>Apache Derby: Writing guidelines</title>
</header>
- <body>
-
+<body>
<p>
-The Derby documentation is sourced in DITA. The tagging used with DITA is
-similar to HTML tagging. This page contains guidelines
+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>
@@ -66,25 +65,205 @@
</section>
<section>
-<title>Tagging guidelines</title>
-<p>The following table lists the proper tags to use for the most common
-features within the Derby topics. If you are not certain which tags to use,
+<title>Understanding DITA tags</title>
+<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 section describes 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>
-<table>
+</section>
+
+<section>
+<title>Tagging examples</title>
+<p>The following table lists the proper tags to use for the most common
+features within the Derby topics.
+</p>
+<table>
<tr>
<td><strong>Feature</strong></td>
<td><strong>Tag to use</strong></td>
<td><strong>Comments</strong></td>
</tr>
+ <tr>
+ <td><strong>Paragraphs</strong>
+ </td>
+ <td><![CDATA[<p>]]></td>
+ <td>A paragraph tag is used for a block of text that contains a single main idea.
+ <br></br>
+ <br></br>
+ </td>
+ </tr>
+
<tr>
- <td>Index entries</td>
- <td><![CDATA[<indexterm>]]></td>
- <td>See the section below for Indexing guidelines.</td>
- </tr>
+ <td><strong>Bulleted lists</strong> (also known as unordered lists)</td>
+ <td><![CDATA[<ul>]]> and <![CDATA[<li>]]></td>
+ <td>The list starts with the <![CDATA[<ul>]]> tag. For each bullet that you want in the list, use a <![CDATA[<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>
+ <br></br>
+ <![CDATA[<ul>]]><br></br>
+ <![CDATA[<li>]]>This is an item in an unordered list.<![CDATA[</li>]]><br></br>
+ <![CDATA[<li>]]>To separate it from other items in the list, the formatter puts a bullet beside it.<![CDATA[</li>]]><br></br>
+ <![CDATA[<li>]]>This is the last list item in our unordered list.<![CDATA[</li>]]><br></br>
+ <![CDATA[</ul>]]>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><strong>Tables</strong></td>
+ <td><![CDATA[<table>]]></td>
+ <td>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>
+<![CDATA[<table>]]><br></br>
+<![CDATA[<tgroup cols="3" colsep="1" rowsep="1">]]><br></br>
+<![CDATA[<colspec colname="1">]]><br></br>
+<![CDATA[<colspec colname="2">]]><br></br>
+<![CDATA[<colspec colname="3">]]><br></br>
+<![CDATA[<thead>]]><br></br>
+<![CDATA[<row>]]><br></br>
+<![CDATA[<entry colname="1">]]>Column Name<![CDATA[</entry>]]><br></br>
+<![CDATA[<entry colname="2">]]>Type<![CDATA[</entry>]]><br></br>
+<![CDATA[<entry colname="3">]]>Description<![CDATA[</entry>]]><br></br>
+<![CDATA[</row>]]><br></br>
+<![CDATA[</thead>]]><br></br>
+<![CDATA[<tbody>]]><br></br>
+<![CDATA[<row>]]> <br></br>
+<![CDATA[<entry colname="1">]]>CONSTRAINTID<![CDATA[</entry>]]><br></br>
+<![CDATA[<entry colname="2">]]>CHAR<![CDATA[</entry>]]> <br></br>
+<![CDATA[<entry colname="3">]]>Unique identifier for the constraint<![CDATA[</entry>]]><br></br>
+<![CDATA[</row>]]><br></br>
+<![CDATA[<row>]]><br></br>
+<![CDATA[<entry colname="1">]]>CHECKDEFINITION<![CDATA[</entry>]]><br></br>
+<![CDATA[<entry colname="2">]]>LONG VARCHAR<![CDATA[</entry>]]><br></br>
+<![CDATA[<entry colname="3">]]>Text of check constraint definition<![CDATA[</entry>]]><br></br>
+<![CDATA[</row>]]><br></br>
+<![CDATA[</tbody>]]><br></br>
+<![CDATA[</tgroup>]]><br></br>
+<![CDATA[</table>]]><br></br>
+</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>Index entries</strong></td>
+ <td><![CDATA[<indexterm>]]></td>
+ <td>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>
+ <br></br>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>Syntax diagrams</strong></td>
+ <td><![CDATA[<codeblock>]]></td>
+ <td>Use the <![CDATA[<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>
+ <br></br>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>Links to external sites</strong></td>
+ <td><![CDATA[<xref>]]></td>
+ <td>Use the cross-reference <![CDATA[<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></br>
+ <![CDATA[<xref href=http://db.apache.org/derby/manuals/index.html scope="external">]]>Derby Documentation<![CDATA[</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><strong>Code or examples in paragraphs</strong></td>
+ <td><![CDATA[<codeph>]]></td>
+ <td>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></br>
+ A runtime rollback is a system-generated rollback of a statement or
+ transaction by Derby, as opposed to an explicit <![CDATA[<codeph>]]>rollback<![CDATA[</codeph>]]>
+ call from your application.
+ </p>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>Definition lists</strong></td>
+ <td><![CDATA[<dl>]]><br></br>
+ <![CDATA[<dlentry>]]><br></br>
+ <![CDATA[<dt>]]><br></br>
+ <![CDATA[<dd>]]></td>
+ <td>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>
+ <br></br>
+<![CDATA[<dl>]]><br></br>
+<![CDATA[<dlentry>]]><br></br>
+<![CDATA[<dt>]]>server<![CDATA[</dt>]]><br></br>
+<![CDATA[<dd>]]>The name of the machine where the server is running.<![CDATA[</dd>]]><br></br>
+<![CDATA[</dlentry>]]><br></br>
+<![CDATA[<dlentry>]]><br></br>
+<![CDATA[<dt>]]>port<![CDATA[</dt>]]><br></br>
+<![CDATA[<dd>]]>The port that the server is listening to.<![CDATA[</dd>]]><br></br>
+<![CDATA[</dlentry>]]><br></br>
+<![CDATA[<dlentry>]]><br></br>
+<![CDATA[<dt>]]>databaseName<![CDATA[</dt>]]><br></br>
+<![CDATA[<dd>]]>The name of the database that you are connecting to. <![CDATA[</dd>]]><br></br>
+<![CDATA[</dlentry>]]><br></br>
+<![CDATA[</dl>]]><br></br>
+</p>
+ </td>
+ </tr>
+
+ <tr>
+ <td><strong>Notes</strong></td>
+ <td><![CDATA[<note>]]></td>
+ <td>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 <![CDATA[<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
+ <![CDATA[<note="tip">]]> You can override the default locale for ij with a
+ property on the JVM.<![CDATA[</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>
</section>
@@ -96,39 +275,40 @@
</p>
<p><strong>What tags do I use to index terms? </strong>In Derby, the index
-entries are inserted
-inside the <![CDATA[<prolog>]]> tag. The <![CDATA[<prolog>]]> tag is
+entries are inserted inside the <![CDATA[<prolog>]]> tag. The <![CDATA[<prolog>]]> tag is
immediately after the <![CDATA[<title>]]> and <![CDATA[<shortdesc>]]> tags.
Index entries use the <![CDATA[<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:
-<![CDATA[
-<prolog>
- <metadata>
- <keywords>
- <indexterm>CREATE TABLE</indexterm>
- </keywords>
- </metadata>
-</prolog>
-]]>
+</p>
+<p>
+<![CDATA[<prolog>]]><br></br>
+<![CDATA[<metadata>]]><br></br>
+<![CDATA[<keywords>]]><br></br>
+<![CDATA[<indexterm>CREATE TABLE</indexterm>]]><br></br>
+<![CDATA[</keywords>]]><br></br>
+<![CDATA[</metadata>]]><br></br>
+<![CDATA[</prolog>]]><br></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. For example:
-<![CDATA[
-<indexterm>CREATE TABLE</indexterm>
-]]>
+the new term inside the keywords tag.
+</p>
+<p>
+For example:<br></br>
+<br></br>
+<![CDATA[<indexterm>CREATE TABLE</indexterm>]]>
</p>
-<p><strong>How do I add an index term? </strong> Add the <![CDATA[<indexterm>]]>
+<p><strong>How do I add an index term? </strong>Add the <![CDATA[<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>
<source>
-<![CDATA[<indexterm>]]>parameters<![CDATA[<indexterm>]]>abc<![CDATA[</indexterm>]]><![CDATA[</indexterm>]]>>
+<![CDATA[<indexterm>]]>parameters<![CDATA[<indexterm>]]>abc<![CDATA[</indexterm>]]><![CDATA[</indexterm>]]>
</source>
<p>The output appears like this:
</p>
@@ -223,15 +403,55 @@
<td>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>
+of the secondary entries appear under one primary entry.</td></tr>
</table>
</section>
+<section>
+<title>Customizing tables in the Derby documentation</title>
+<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
+<![CDATA[<colspec>]]> tag. The <![CDATA[<colspec>]]> tag appears just after
+the <![CDATA[<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>
+<br></br>
+<![CDATA[<tgroup cols="3" colsep="1" rowsep="1">]]><br></br>
+<![CDATA[<colspec colname="1" colwidth=25*">]]><br></br>
+<![CDATA[<colspec colname="2" colwidth=25*>]]><br></br>
+<![CDATA[<colspec colname="3" colwidth=50*>]]><br></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 <![CDATA[<entry>]]> tag. Use the align attribute to specify horizontal alignment.
+Use the valign attribute to specify vertical alignment.
+</p>
+<p>
+For example:<br></br>
+<br></br>
+<![CDATA[<thead>]]><br></br>
+<![CDATA[<row>]]><br></br>
+<![CDATA[<thead>]]><br></br>
+<![CDATA[<entry align="left" colname="1" valign="bottom">Column Name</entry>]]><br></br>
+<![CDATA[<entry align="left" colname="2" valign="bottom">Type</entry>]]><br></br>
+<![CDATA[<entry align="left" colname="3" valign="bottom">Description</entry>]]><br></br>
+<![CDATA[</row>]]><br></br>
+<![CDATA[</thead>]]><br></br>
+</p>
+<p>Valid settings for the align attribute are: left, right, center, justify.
+Valid settings for the valign attribute are: top, middle, bottom.
+</p>
+</section>
<p>
+<br></br>
Please post feedback to the
<a href="../derby_mail.html">derby-dev</a> mail list.
</p>
-<p><em>Last Updated: October 27, 2006</em></p>
+<p><em>Last Updated: November 2, 2006</em></p>
</body>
</document>
Added: db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml?view=auto&rev=470517
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml (added)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml Thu Nov 2 12:54:11 2006
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to you under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd" >
+<document>
+ <header>
+ <title>Apache Derby: Documenting messages</title>
+ </header>
+ <body>
+
+<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 <strong>..java/engine/org/apache/derby/loc/messages.xml</strong>.
+Specify friendly names for the message arguments. The friendly names appear in the SQLState tables in
+the Derby Reference Manual. Valid 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>valueName</li>
+<li>viewName</li>
+</ul>
+<p><strong>Do not edit the java/engine/apache/derby/loc/messages.xml file</strong>. This file
+has been removed from code management and is now generated from
+messages.xml during the Derby build.</p>
+
+<p>A utility takes the content of the <strong>..java/engine/org/apache/derby/loc/messages.xml</strong>
+file, and updates the topic in the Derby Reference Manual that lists all of the
+messages. That topic is rrefexcept71493.dita.
+</p>
+
+<p>
+Please post feedback to the
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+
+<p><em>Last Updated: November 2, 2006</em></p>
+</body>
+</document>
Propchange: db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/site/trunk/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/site.xml?view=diff&rev=470517&r1=470516&r2=470517
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/site.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/site.xml Thu Nov 2 12:54:11 2006
@@ -1,4 +1,4 @@
-<?xml version="1.0"?>
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,137 +15,137 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-<site label="Derby" href=""
- xmlns="http://apache.org/forrest/linkmap/1.0" tab="home">
+<site label="Derby" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="home">
<about label="Home" tab="home">
- <index label="Apache Derby" href="index.html"/>
- <charter label="Charter" href="derby_charter.html"/>
- <license label="License" href="license.html"/>
- <faq label="FAQs" href="faq.html"/>
- <wiki label="Derby Wiki" href="http://wiki.apache.org/db-derby/"/>
- <proposal href="derby_proposal.html"/>
+ <index label="Apache Derby" href="index.html"></index>
+ <charter label="Charter" href="derby_charter.html"></charter>
+ <license label="License" href="license.html"></license>
+ <faq label="FAQs" href="faq.html"></faq>
+ <wiki label="Derby Wiki" href="http://wiki.apache.org/db-derby/"></wiki>
+ <proposal href="derby_proposal.html"></proposal>
</about>
<qstart label="Quick Start" tab="quick">
- <index label="Quick Start" href="quick_start.html"/>
+ <index label="Quick Start" href="quick_start.html"></index>
</qstart>
<download label="Download" tab="download">
- <index label="Overview" href="derby_downloads.html"/>
+ <index label="Overview" href="derby_downloads.html"></index>
<releases>
- <release10021 href="releases/release-10.0.2.1.html"/>
- <release10110 href="releases/release-10.1.1.0.html"/>
- <release10121 href="releases/release-10.1.2.1.html"/>
- <release10121 href="releases/release-10.1.3.1.html"/>
+ <release10021 href="releases/release-10.0.2.1.html"></release10021>
+ <release10110 href="releases/release-10.1.1.0.html"></release10110>
+ <release10121 href="releases/release-10.1.2.1.html"></release10121>
+ <release10121 href="releases/release-10.1.3.1.html"></release10121>
</releases>
</download>
- <community label="Community" tab="community">
- <index label="Get Involved!" href="derby_comm.html"/>
- <derby_mail label="Mailing Lists" href="derby_mail.html"/>
- <derby_bugs label="BUGS" href="DerbyBugGuidelines.html"/>
- <derby_tests label="Tests" href="derby_tests.html"/>
- <logo label="Logo" href="logo.html"/>
- <derby_web label="Updating the web site" href="papers/derby_web.html"/>
+ <community label="Community" tab="community">
+ <index label="Get Involved!" href="derby_comm.html"></index>
+ <derby_mail label="Mailing Lists" href="derby_mail.html"></derby_mail>
+ <derby_bugs label="BUGS" href="DerbyBugGuidelines.html"></derby_bugs>
+ <derby_tests label="Tests" href="derby_tests.html"></derby_tests>
+ <logo label="Logo" href="logo.html"></logo>
+ <derby_web label="Updating the web site" href="papers/derby_web.html"></derby_web>
</community>
<manuals label="Documentation" href="manuals/" tab="docs">
- <index label="Overview" href="index.html"/>
- <ditafile label="DITA Source" href="dita.html" />
- <ditaguid label="Writing Guidelines" href="guidelines.html" />
+ <index label="Overview" href="index.html"></index>
+ <ditafile label="DITA Source" href="dita.html"></ditafile>
+ <guidelines label="Writing Guidelines" href="guidelines.html"></guidelines>
+ <messages label="Documenting Messages" href="messages.html"></messages>
</manuals>
<integrate label="Other Products" href="integrate/" tab="resources">
- <index label="Overview" href="index.html"/>
- <uses label="What works with Derby?" href="index.html#uses"/>
- <products label="Product Writeups" href="index.html#products"/>
- <ddlutils href="db_ddlutils.html"/>
- <jpox href="JPOX_Derby.html"/>
- <geronimo href="JPetStoreGeronimo.html"/>
- <squirrel href="SQuirreL_Derby.html"/>
- <tomcat href="DerbyTomcat5512JPetStor.html"/>
- <torque href="db_torque.html"/>
- <websphere href="JPetStoreWebSphere.html"/>
- <misc href="misc.html"/>
+ <index label="Overview" href="index.html"></index>
+ <uses label="What works with Derby?" href="index.html#uses"></uses>
+ <products label="Product Writeups" href="index.html#products"></products>
+ <ddlutils href="db_ddlutils.html"></ddlutils>
+ <jpox href="JPOX_Derby.html"></jpox>
+ <geronimo href="JPetStoreGeronimo.html"></geronimo>
+ <squirrel href="SQuirreL_Derby.html"></squirrel>
+ <tomcat href="DerbyTomcat5512JPetStor.html"></tomcat>
+ <torque href="db_torque.html"></torque>
+ <websphere href="JPetStoreWebSphere.html"></websphere>
+ <misc href="misc.html"></misc>
</integrate>
<eclipse label="Eclipse Plug-ins" href="integrate/" tab="resources">
- <eclipse_old label="10.1 Core" href="derby_plugin.html"/>
- <eclipse_spec label="1.0 UI Functional Spec" href="func_spec_plugins.html"/>
- <eclipse_new label="10.1 Core and 1.1 UI" href="plugin_howto.html"/>
- <src_readme label="Building 1.1 UI" href="Readme.html" />
- <eclipse_present label="Derby Plug-ins Slides and Lab" href="plugin_slides.html"/>
- <eclipse_help label="10.1 Core and 1.1 UI Documentation" href="plugin_help/">
- <start label="Getting Started" href="start_toc.html" />
- <proj label="Creating an Eclipse Project" href="java_project.html" />
+ <eclipse_old label="10.1 Core" href="derby_plugin.html"></eclipse_old>
+ <eclipse_spec label="1.0 UI Functional Spec" href="func_spec_plugins.html"></eclipse_spec>
+ <eclipse_new label="10.1 Core and 1.1 UI" href="plugin_howto.html"></eclipse_new>
+ <src_readme label="Building 1.1 UI" href="Readme.html"></src_readme>
+ <eclipse_present label="Derby Plug-ins Slides and Lab" href="plugin_slides.html"></eclipse_present>
+ <eclipse_help label="10.1 Core and 1.1 UI Documentation" href="plugin_help/">
+ <start label="Getting Started" href="start_toc.html"></start>
+ <proj label="Creating an Eclipse Project" href="java_project.html"></proj>
<nature label="Derby Nature" href="">
- <nature_toc label="Adding or Removing" href="nature_toc.html"/>
- <add_nature label="Adding the Derby Nature" href="nature.html" />
- <remove_nature label="Removing the Derby Nature" href="remove_nature.html" />
+ <nature_toc label="Adding or Removing" href="nature_toc.html"></nature_toc>
+ <add_nature label="Adding the Derby Nature" href="nature.html"></add_nature>
+ <remove_nature label="Removing the Derby Nature" href="remove_nature.html"></remove_nature>
</nature>
<server label="Network Server" href="">
- <start_stop label="Starting and Stopping" href="server_toc.html"/>
- <start_server label="Starting the Server" href="start_server.html"/>
- <stop_server label="Stopping the Server" href="stop_server.html"/>
+ <start_stop label="Starting and Stopping" href="server_toc.html"></start_stop>
+ <start_server label="Starting the Server" href="start_server.html"></start_server>
+ <stop_server label="Stopping the Server" href="stop_server.html"></stop_server>
</server>
- <props label="Derby Properties" href="properties.html"/>
+ <props label="Derby Properties" href="properties.html"></props>
<ij label="ij" href="">
- <ij_toc label="Using ij" href="ij_toc.html"/>
- <ij_command label="SQL commands" href="ij.html"/>
- <ij_script label="SQL scripts" href="ij2.html"/>
+ <ij_toc label="Using ij" href="ij_toc.html"></ij_toc>
+ <ij_command label="SQL commands" href="ij.html"></ij_command>
+ <ij_script label="SQL scripts" href="ij2.html"></ij_script>
</ij>
- <java_app label="Building a Java App" href="derby_app.html"/>
- <sysinfo label="Running sysinfo" href="sysinfo.html"/>
- <derby_doc label="Derby Manuals" href="resources.html"/>
+ <java_app label="Building a Java App" href="derby_app.html"></java_app>
+ <sysinfo label="Running sysinfo" href="sysinfo.html"></sysinfo>
+ <derby_doc label="Derby Manuals" href="resources.html"></derby_doc>
</eclipse_help>
</eclipse>
<papers label="Papers" href="papers/" tab="resources">
- <index label="Overview" href="index.html"/>
- <fortune href="fortune_tut.html"/>
+ <index label="Overview" href="index.html"></index>
+ <fortune href="fortune_tut.html"></fortune>
<engine label="Derby Engine" tab="resources">
- <javadoc label="Javadoc">
- <engine label="Engine" href="http://db.apache.org/derby/javadoc/engine"/>
- <language label="Language" href="http://db.apache.org/derby/javadoc/language"/>
- <tools label="Tools" href="http://db.apache.org/derby/javadoc/tools"/>
- <api label="API" href="http://db.apache.org/derby/javadoc/publishedapi"/>
+ <javadoc label="Javadoc">
+ <engine label="Engine" href="http://db.apache.org/derby/javadoc/engine"></engine>
+ <language label="Language" href="http://db.apache.org/derby/javadoc/language"></language>
+ <tools label="Tools" href="http://db.apache.org/derby/javadoc/tools"></tools>
+ <api label="API" href="http://db.apache.org/derby/javadoc/publishedapi"></api>
</javadoc>
- <index label="Architecture" href="derby_arch.html"/>
- <index label="BTree" href="btree_package.html"/>
- <pformat label="Disk Page Format" href="pageformats.html"/>
- <misc label="How Things Work" href="derby_htw.html"/>
- <intersect label="Intersect & Except" href="Intersect-design.html"/>
- <jdbc label="JDBC" href="JDBCImplementation.html"/>
- <log label="Log Format" href="logformats.html"/>
- <recover label="Logging & Recovery" href="recovery.html"/>
- <optimizer label="Optimizer" href="optimizer.html"/>
- <types label="Type System" href="http://db.apache.org/derby/javadoc/engine/org/apache/derby/iapi/types/package-summary.html#package_description"/>
- <version label="Versioning" href="versionupgrade.html"/>
+ <index label="Architecture" href="derby_arch.html"></index>
+ <index label="BTree" href="btree_package.html"></index>
+ <pformat label="Disk Page Format" href="pageformats.html"></pformat>
+ <misc label="How Things Work" href="derby_htw.html"></misc>
+ <intersect label="Intersect & Except" href="Intersect-design.html"></intersect>
+ <jdbc label="JDBC" href="JDBCImplementation.html"></jdbc>
+ <log label="Log Format" href="logformats.html"></log>
+ <recover label="Logging & Recovery" href="recovery.html"></recover>
+ <optimizer label="Optimizer" href="optimizer.html"></optimizer>
+ <types label="Type System" href="http://db.apache.org/derby/javadoc/engine/org/apache/derby/iapi/types/package-summary.html#package_description"></types>
+ <version label="Versioning" href="versionupgrade.html"></version>
</engine>
<net_client label="Derby Network Client" tab="resources">
- <func_spec label="Functional Spec" href="DerbyClientSpec.html"/>
+ <func_spec label="Functional Spec" href="DerbyClientSpec.html"></func_spec>
</net_client>
<derbyTut label="Derby Tutorial" href="DerbyTut/">
- <index label="Overview" href="index.html"/>
- <install label="Step 1: Install Software" href="install_software.html"/>
- <ij_intro label="Step 2: ij Basics" href="ij_intro.html"/>
- <embed label="Step 3: Embedded Derby" href="embedded_intro.html"/>
- <ns label="Step 4: Derby Network Server" href="ns_intro.html"/>
+ <index label="Overview" href="index.html"></index>
+ <install label="Step 1: Install Software" href="install_software.html"></install>
+ <ij_intro label="Step 2: ij Basics" href="ij_intro.html"></ij_intro>
+ <embed label="Step 3: Embedded Derby" href="embedded_intro.html"></embed>
+ <ns label="Step 4: Derby Network Server" href="ns_intro.html"></ns>
</derbyTut>
<present label="Presentations" tab="resources">
- <apacheCon label="ApacheCon" href="ApacheCon.html"/>
- <oscon05 label="OSCON 2005" href="MiscPresentations.html#OSCON+2005"/>
- <colorado label="Colorado 2004" href="MiscPresentations.html#Colorado+Software+Summit+2004"/>
+ <apacheCon label="ApacheCon" href="ApacheCon.html"></apacheCon>
+ <oscon05 label="OSCON 2005" href="MiscPresentations.html#OSCON+2005"></oscon05>
+ <colorado label="Colorado 2004" href="MiscPresentations.html#Colorado+Software+Summit+2004"></colorado>
</present>
</papers>
@@ -160,7 +160,7 @@
<external-refs>
<db.apache.org href="http://db.apache.org/">
- <derby href="derby/"/>
+ <derby href="derby/"></derby>
</db.apache.org>
</external-refs>