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/07 23:27:07 UTC
svn commit: r472306 - in /db/derby/site/trunk: build/site/
build/site/manuals/ src/documentation/content/xdocs/
src/documentation/content/xdocs/manuals/
Author: jta
Date: Tue Nov 7 14:27:06 2006
New Revision: 472306
URL: http://svn.apache.org/viewvc?view=rev&rev=472306
Log:
DERBY-1980 More updates to the new writing guidelines on the web site, plus
plus the addition of an FAQ page.
Patch derby1980_7.diff contributed by Laura Stewart <sc...@gmail.com>.
Added:
db/derby/site/trunk/build/site/manuals/docsfaq.html (with props)
db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.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/build/site/manuals/messages.html
db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml
db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml
db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/build/site/linkmap.html (original)
+++ db/derby/site/trunk/build/site/linkmap.html Tue Nov 7 14:27:06 2006
@@ -125,6 +125,9 @@
<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>
<div onclick="SwitchMenu('menu_1.6', 'skin/')" id="menu_1.6Title" class="menutitle">Other Products</div>
<div id="menu_1.6" class="menuitemgroup">
@@ -491,6 +494,12 @@
<ul>
<li>
<a href="manuals/messages.html">Documenting Messages</a> _________________________ <em>messages</em>
+</li>
+</ul>
+
+<ul>
+<li>
+<a href="manuals/docsfaq.html">Writing FAQs</a> _________________________ <em>docsfaq</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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Tue Nov 7 14:27:06 2006
@@ -74,6 +74,9 @@
<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>
<div class="searchbox">
<hr>
@@ -335,12 +338,19 @@
<td colspan="1" rowspan="1">tuning</td>
<td colspan="1" rowspan="1">Tuning Derby</td>
-</tr>
+</tr>
+
+<tr>
+
+<td colspan="1" rowspan="1">workingwithderby</td>
+ <td colspan="1" rowspan="1">Working with Derby</td>
+
+</tr>
</table>
</div>
-<a name="N101BF"></a><a name="DITA+file+names"></a>
+<a name="N101CC"></a><a name="DITA+file+names"></a>
<h2 class="boxed">DITA file names</h2>
<div class="section">
<p>Dita files are named to provide a sense of what type of topic they contain as well as to which manual they belong. All DITA topics are classified as either concepts, tasks, or reference material. Thus, every file begins with either a "c", "t", or "r". In addition, the letters that appear immediately after this first one provide a shorthand id for the manual. For example, the <span class="codefrag">Getting Started with Derby</span> manual uses "gs", so a reference topic DITA file in that manual will start with "rgs". Subsequent letters in the file name may provide hints at the topic's section within the manual, as well as numbers distinguishing it from other DITA files.</p>
@@ -348,7 +358,7 @@
</div>
-<a name="N101CE"></a><a name="Modifying+the+output+format"></a>
+<a name="N101DB"></a><a name="Modifying+the+output+format"></a>
<h2 class="boxed">Modifying the output format</h2>
<div class="section">
<p>You may wish to modify the output created by the DITA Toolkit to fix organization, formatting, links, indexing, etc. To do this, you will have to modify the xsl files distributed with the DITA Toolkit. The instructions for which files to modify and how are included within the Toolkit documentation. To modify the PDF output, it is recommended that you make changes only to the <span class="codefrag">dita2fo_shell.xsl</span> file.</p>
@@ -367,7 +377,7 @@
-<a name="N101EB"></a><a name="Submitting+documentation+patches"></a>
+<a name="N101F8"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -540,7 +550,7 @@
</div>
-<a name="N10294"></a><a name="Committing+documentation+patches"></a>
+<a name="N102A1"></a><a name="Committing+documentation+patches"></a>
<h2 class="boxed">Committing documentation patches</h2>
<div class="section">
<ol>
Added: db/derby/site/trunk/build/site/manuals/docsfaq.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/docsfaq.html?view=auto&rev=472306
==============================================================================
--- db/derby/site/trunk/build/site/manuals/docsfaq.html (added)
+++ db/derby/site/trunk/build/site/manuals/docsfaq.html Tue Nov 7 14:27:06 2006
@@ -0,0 +1,167 @@
+<!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: Writing FAQs</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="menuitem">
+<a href="../manuals/messages.html">Documenting Messages</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Writing FAQs</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: Writing FAQs</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Semi-colon+use+at+the+end+of+statements+and+commands">Semi-colon use at the end of statements and commands</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="Semi-colon+use+at+the+end+of+statements+and+commands"></a>
+<h2 class="boxed">Semi-colon use at the end of statements and commands</h2>
+<div class="section">
+<p>
+The semi-colon should only be included if the documentation is showing the
+example statement as the statement would be issued in ij. For example:
+</p>
+<pre class="code">
+ ij> connect 'mydb';
+ ij> select * from t1;
+</pre>
+<p>If the example is just an example of how to use the syntax for a Derby
+SQL statement, the semi-colon should not be used. For example:
+<br>
+
+</p>
+<pre class="code">
+ select * from t1
+</pre>
+<p>This issue was discussed on derby-dev in August 2006
+<br>
+
+<a class="external" href="http://www.nabble.com/Documentation-Style-Issue---semi-colon-at-the-end-of-SQL-statement-examples-tf2141831.html#a5913071">Documentation Style Issue - semi-colon at the end of SQL statement examples</a>
+
+</p>
+</div>
+
+
+<p>
+
+<br>
+Please post feedback to the
+<a href="../derby_mail.html">derby-dev</a> mail list.
+</p>
+
+
+<p>
+<em>Last Updated: November 7, 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/docsfaq.html">derby-user@db.apache.org</a>
+</div>
+</div>
+</body>
+</html>
Propchange: db/derby/site/trunk/build/site/manuals/docsfaq.html
------------------------------------------------------------------------------
svn:eol-style = native
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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/build/site/manuals/guidelines.html (original)
+++ db/derby/site/trunk/build/site/manuals/guidelines.html Tue Nov 7 14:27:06 2006
@@ -74,6 +74,9 @@
<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>
<div class="searchbox">
<hr>
@@ -104,10 +107,16 @@
<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">Tagging examples</a>
+<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>
@@ -119,8 +128,8 @@
</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
+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>
@@ -164,12 +173,163 @@
<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
-\trunk\templates directory.
+<strong>\trunk\templates</strong> directory.
</p>
</div>
-<a name="N1003A"></a><a name="Understanding+DITA+tags"></a>
+<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 <pre class="code">rreffunc</pre>, 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
+ <pre class="code">cdevlocks</pre>. The end of the filename <pre class="code">shared</pre>
+ 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="N1012E"></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>
@@ -180,7 +340,7 @@
<li>Textual tags: external links, inline examples, notes</li>
</ul>
-<p>The next section describes these tags and provides tagging examples.
+<p>The next 2 sections describe these tags and provides tagging examples.
</p>
<p>
If you have questions about DITA tagging,
@@ -189,10 +349,10 @@
</div>
-<a name="N10057"></a><a name="Tagging+examples"></a>
-<h2 class="boxed">Tagging examples</h2>
+<a name="N1014B"></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 tags to use for the most common
+<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">
@@ -318,6 +478,63 @@
</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="N10260"></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>
@@ -361,42 +578,6 @@
<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
@@ -428,7 +609,8 @@
</div>
-<a name="N101BB"></a><a name="Indexing+guidelines"></a>
+
+<a name="N102D1"></a><a name="Indexing+guidelines"></a>
<h2 class="boxed">Indexing guidelines</h2>
<div class="section">
<p>
@@ -597,7 +779,7 @@
</div>
-<a name="N10261"></a><a name="Customizing+tables+in+the+Derby+documentation"></a>
+<a name="N10377"></a><a name="Customizing+tables+in+the+Derby+documentation"></a>
<h2 class="boxed">Customizing tables in the Derby documentation</h2>
<div class="section">
<p>
@@ -640,6 +822,7 @@
</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>
@@ -653,7 +836,7 @@
<p>
-<em>Last Updated: November 2, 2006</em>
+<em>Last Updated: November 7, 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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/build/site/manuals/index.html (original)
+++ db/derby/site/trunk/build/site/manuals/index.html Tue Nov 7 14:27:06 2006
@@ -74,6 +74,9 @@
<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>
<div class="searchbox">
<hr>
@@ -134,7 +137,16 @@
<li>
<p>
<em>Getting Started with Derby</em>:
- introduces Derby to new users.
+ Introduces Derby to new users.
+ </p>
+
+</li>
+
+<li>
+<p>
+<em>Working with Derby</em>:
+ A self-study guide that includes hands-on activities which demonstrate
+ how to use Derby in embedded and client-server configurations.
</p>
</li>
@@ -142,7 +154,7 @@
<li>
<p>
<em>Derby Reference Manual</em>:
- provides reference information,
+ Provides reference information,
including SQL syntax and descriptions of the system catalogs.
</p>
</li>
@@ -150,7 +162,7 @@
<li>
<p>
<em>Derby Developer's Guide</em>:
- describes how to use JDBC to access Derby databases.
+ Describes how to use JDBC to access Derby databases.
It is intended for developers building Derby applications.
</p>
@@ -159,7 +171,7 @@
<li>
<p>
<em>Tuning Derby</em>:
- explains how to set properties to configure and tune Derby.
+ Explains how to set properties to configure and tune Derby.
It also provides performance tuning tips.
</p>
@@ -168,36 +180,27 @@
<li>
<p>
<em>Derby Server and Administration Guide</em>:
- describes how to use the Derby Network Server and how
+ Describes how to use the Derby Network Server and how
to perform administrative tasks such as backing up databases.
</p>
</li>
<li>
-<p>The <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>Working with Derby</em>:
- demonstrates how to use Derby in embedded and client-server configurations.
- </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>
+
</ul>
</div>
-<a name="N10054"></a><a name="latest"></a>
+<a name="N10053"></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
@@ -328,7 +331,7 @@
</div>
-<a name="N101A3"></a><a name="docs_10.2"></a>
+<a name="N101A2"></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.
@@ -458,7 +461,7 @@
</div>
-<a name="N102F2"></a><a name="docs_10.1"></a>
+<a name="N102F1"></a><a name="docs_10.1"></a>
<h2 class="boxed">10.1 Manuals</h2>
<div class="section">
<p>
@@ -549,7 +552,7 @@
</div>
-<a name="N103CD"></a><a name="docs_10.0"></a>
+<a name="N103CC"></a><a name="docs_10.0"></a>
<h2 class="boxed">10.0 Manuals</h2>
<div class="section">
<p>
@@ -642,7 +645,7 @@
-<a name="N10479"></a><a name="doc_issues"></a>
+<a name="N10478"></a><a name="doc_issues"></a>
<h2 class="boxed">Reporting Documentation Issues</h2>
<div class="section">
<p>
@@ -653,7 +656,7 @@
<p>
-<em>Last Updated: October 6, 2006</em>
+<em>Last Updated: November 7, 2006</em>
</p>
</div>
Modified: 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=diff&rev=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/build/site/manuals/messages.html (original)
+++ db/derby/site/trunk/build/site/manuals/messages.html Tue Nov 7 14:27:06 2006
@@ -74,6 +74,9 @@
<div class="menupage">
<div class="menupagetitle">Documenting Messages</div>
</div>
+<div class="menuitem">
+<a href="../manuals/docsfaq.html">Writing FAQs</a>
+</div>
</div>
<div class="searchbox">
<hr>
@@ -100,7 +103,7 @@
<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>.
+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. Valid friendly names are:
</p>
@@ -135,9 +138,9 @@
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>
+<p>A 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 rrefexcept71493.dita.
+messages. That topic is <strong>rrefexcept71493.dita</strong>.
</p>
@@ -148,7 +151,7 @@
<p>
-<em>Last Updated: November 2, 2006</em>
+<em>Last Updated: November 7, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml?view=diff&rev=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Tue Nov 7 14:27:06 2006
@@ -139,7 +139,11 @@
<tr>
<td>tuning</td>
<td>Tuning Derby</td>
- </tr>
+ </tr>
+ <tr>
+ <td>workingwithderby</td>
+ <td>Working with Derby</td>
+ </tr>
</table>
</section>
<section><title>DITA file names</title>
Added: db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml?view=auto&rev=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml (added)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml Tue Nov 7 14:27:06 2006
@@ -0,0 +1,55 @@
+<?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: Writing FAQs</title>
+ </header>
+ <body>
+<section>
+<title>Semi-colon use at the end of statements and commands</title>
+<p>
+The semi-colon should only be included if the documentation is showing the
+example statement as the statement would be issued in ij. For example:
+</p>
+<source>
+ ij> connect 'mydb';
+ ij> select * from t1;
+</source>
+<p>If the example is just an example of how to use the syntax for a Derby
+SQL statement, the semi-colon should not be used. For example:
+<br></br>
+</p>
+<source>
+ select * from t1
+</source>
+<p>This issue was discussed on derby-dev in August 2006
+<br></br>
+<a href="http://www.nabble.com/Documentation-Style-Issue---semi-colon-at-the-end-of-SQL-statement-examples-tf2141831.html#a5913071">Documentation Style Issue - semi-colon at the end of SQL statement examples</a>
+</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: November 7, 2006</em></p>
+</body>
+</document>
Propchange: db/derby/site/trunk/src/documentation/content/xdocs/manuals/docsfaq.xml
------------------------------------------------------------------------------
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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/guidelines.xml Tue Nov 7 14:27:06 2006
@@ -22,8 +22,8 @@
</header>
<body>
<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
+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>
@@ -60,18 +60,116 @@
<title>New topics: Using a template to create a new topic</title>
<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
-\trunk\templates directory.
+<strong>\trunk\templates</strong> directory.
</p>
</section>
<section>
+<title>New topics: Selecting the best filename</title>
+<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>
+ <tr>
+ <th colspan="1">Abbreviation</th>
+ <th>Derby Manual</th>
+ </tr>
+<tr>
+ <td>admin</td>
+ <td>Derby Server and Administration Guide</td>
+ </tr>
+<tr>
+ <td>dev</td>
+ <td>Derby Developer's Guide</td>
+ </tr>
+ <tr>
+ <td>gs</td>
+ <td>Getting Started with Derby</td>
+ </tr>
+<tr>
+ <td>ref</td>
+ <td>Derby Reference Manual</td>
+ </tr>
+<tr>
+ <td>tools</td>
+ <td>Derby Tools and Utilities Guide</td>
+ </tr>
+<tr>
+ <td>tuning</td>
+ <td>Tuning Derby</td>
+ </tr>
+ <tr>
+ <td>wwd</td>
+ <td>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>
+ <tr>
+ <td><strong>Information in the topic</strong></td>
+ <td><strong>Sample filename</strong></td>
+ <td><strong>Comments</strong></td>
+ </tr>
+
+ <tr>
+ <td>A new function, ROUND, is being documented in the Reference Manual
+ </td>
+ <td>rreffuncround</td>
+ <td>If all functions start with <source>rreffunc</source>, 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>
+ <br></br>
+ </td>
+ </tr>
+
+ <tr>
+ <td>The exclusive lock, is being documented in the Developers Guide
+ </td>
+ <td>cdevlocksshared</td>
+ <td>Because this is a concept topic in the
+ developers guide about locks, the beginning of the topic filename is
+ <source>cdevlocks</source>. The end of the filename <source>shared</source>
+ indicates the specific type of locks that the topic describes.
+ <br></br>
+ <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>
+ <br></br>
+ </td>
+ </tr>
+
+ <tr>
+ <td>A new utility, abc, is being documented in the Tools and Utilities Guide
+ </td>
+ <td>ttoolsabcstarting</td>
+ <td>This topic is a task that describes how to start the abc utility.
+ <br></br>
+ <br></br>
+ </td>
+ </tr>
+ </table>
+</section>
+
+<section>
<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>The next 2 sections describe these tags and provides tagging examples.
</p>
<p>
If you have questions about DITA tagging,
@@ -80,8 +178,8 @@
</section>
<section>
-<title>Tagging examples</title>
-<p>The following table lists the proper tags to use for the most common
+<title>Tagging examples - structural tags</title>
+<p>The following table lists the proper structural tags to use for the most common
features within the Derby topics.
</p>
@@ -180,6 +278,52 @@
</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>
+
+</table>
+</section>
+
+<section>
+<title>Tagging examples - textual tags</title>
+<p>The following table lists the proper textual 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>Links to external sites</strong></td>
<td><![CDATA[<xref>]]></td>
@@ -212,36 +356,6 @@
</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
@@ -267,6 +381,7 @@
</table>
</section>
+
<section>
<title>Indexing guidelines</title>
<p><strong>What to index? </strong>You should index general and specific terms.
@@ -443,6 +558,7 @@
<![CDATA[</thead>]]><br></br>
</p>
<p>Valid settings for the align attribute are: left, right, center, justify.
+<br></br>
Valid settings for the valign attribute are: top, middle, bottom.
</p>
</section>
@@ -452,6 +568,6 @@
<a href="../derby_mail.html">derby-dev</a> mail list.
</p>
-<p><em>Last Updated: November 2, 2006</em></p>
+<p><em>Last Updated: November 7, 2006</em></p>
</body>
</document>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml?view=diff&rev=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/index.xml Tue Nov 7 14:27:06 2006
@@ -15,7 +15,7 @@
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">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd" >
<document>
<header>
<title>Apache Derby: Documentation</title>
@@ -32,40 +32,39 @@
<ul>
<li><p><em>Getting Started with Derby</em>:
- introduces Derby to new users.
+ Introduces Derby to new users.
+ </p>
+ </li>
+ <li><p><em>Working with Derby</em>:
+ 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,
+ 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.
+ 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 set properties to configure and tune Derby.
+ Explains how to set properties to configure and tune Derby.
It also provides performance tuning tips.
</p>
</li>
<li><p><em>Derby Server and Administration Guide</em>:
- describes how to use the Derby Network Server and how
+ Describes how to use the Derby Network Server and how
to perform administrative tasks such as backing up databases.
</p>
</li>
- <li><p>The <em>Derby Tools and Utilities Guide</em> explains the
- ins and outs of
- <code>ij</code>,
- <code>dblook</code> and
- <code>sysinfo</code>,
- and describes bulk export and import.
+ <li><p><em>Derby Tools and Utilities Guide</em>:
+ Explains the ins and outs of <code>ij</code>, <code>dblook</code> and
+ <code>sysinfo</code>, and describes bulk export and import.
</p>
</li>
- <li><p><em>Working with Derby</em>:
- demonstrates how to use Derby in embedded and client-server configurations.
- </p>
- </li>
+
</ul>
</section>
@@ -136,24 +135,24 @@
<th colspan="2">Brazilian Portuguese</th>
</tr>
<tr>
- <td><em>Introdução ao Derby</em></td>
+ <td><em>Introdução ao Derby</em></td>
<td> [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/getstart/getstartderby.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/getstart/pt_BR/getstart-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/getstart/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/getstart/">HTML Páginas</a>]
</td>
</tr>
<tr>
- <td><em>Manual de Referência do Derby</em></td>
+ <td><em>Manual de Referência do Derby</em></td>
<td>[<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/ref/refderby.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/ref/pt_BR/ref-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/ref/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/ref/">HTML Páginas</a>]
</td>
</tr>
<tr>
- <td><em>Guia do Servidor e Administração do Derby</em></td>
+ <td><em>Guia do Servidor e Administração do Derby</em></td>
<td>[<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/adminguide/derbyadmin.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/adminguide/pt_BR/adminguide-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/adminguide/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/dev/pt_BR/adminguide/">HTML Páginas</a>]
</td>
</tr>
</table>
@@ -226,24 +225,24 @@
<th colspan="2">Brazilian Portuguese</th>
</tr>
<tr>
- <td><em>Introdução ao Derby</em></td>
+ <td><em>Introdução ao Derby</em></td>
<td> [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/getstart/getstartderby.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/getstart/pt_BR/getstart-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/getstart/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/getstart/">HTML Páginas</a>]
</td>
</tr>
<tr>
- <td><em>Manual de Referência do Derby</em></td>
+ <td><em>Manual de Referência do Derby</em></td>
<td>[<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/ref/refderby.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/ref/pt_BR/ref-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/ref/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/ref/">HTML Páginas</a>]
</td>
</tr>
<tr>
- <td><em>Guia do Servidor e Administração do Derby</em></td>
+ <td><em>Guia do Servidor e Administração do Derby</em></td>
<td>[<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/adminguide/derbyadmin.pdf">PDF</a>]
[<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/adminguide/pt_BR/adminguide-single.html">HTML Livro</a>]
- [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/adminguide/">HTML Páginas</a>]
+ [<a class="fork" href="http://db.apache.org/derby/docs/10.2/pt_BR/adminguide/">HTML Páginas</a>]
</td>
</tr>
</table>
@@ -391,6 +390,6 @@
</section>
-<p><em>Last Updated: October 6, 2006</em></p>
+<p><em>Last Updated: November 7, 2006</em></p>
</body>
</document>
Modified: 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=diff&rev=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml Tue Nov 7 14:27:06 2006
@@ -25,7 +25,7 @@
<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>.
+the xml descriptors file that is located in <code>..java/engine/org/apache/derby/loc/messages.xml</code>.
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>
@@ -45,9 +45,9 @@
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>
+<p>A utility takes the content of the <code>..java/engine/org/apache/derby/loc/messages.xml</code>
file, and updates the topic in the Derby Reference Manual that lists all of the
-messages. That topic is rrefexcept71493.dita.
+messages. That topic is <strong>rrefexcept71493.dita</strong>.
</p>
<p>
@@ -55,6 +55,6 @@
<a href="../derby_mail.html">derby-dev</a> mail list.
</p>
-<p><em>Last Updated: November 2, 2006</em></p>
+<p><em>Last Updated: November 7, 2006</em></p>
</body>
</document>
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=472306&r1=472305&r2=472306
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/site.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/site.xml Tue Nov 7 14:27:06 2006
@@ -55,6 +55,7 @@
<ditafile label="DITA Source" href="dita.html"></ditafile>
<guidelines label="Writing Guidelines" href="guidelines.html"></guidelines>
<messages label="Documenting Messages" href="messages.html"></messages>
+ <docsfaq label="Writing FAQs" href="docsfaq.html"></docsfaq>
</manuals>
<integrate label="Other Products" href="integrate/" tab="resources">