You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@db.apache.org by rh...@apache.org on 2014/05/30 21:24:30 UTC
svn commit: r910612 - /websites/production/db/content/derby/manuals/dita.html
Author: rhillegas
Date: Fri May 30 19:24:30 2014
New Revision: 910612
Log:
DERBY-6592: Commit generated content for derby-6592-02-aa-ditaInstructionsCleanup.diff.
Modified:
websites/production/db/content/derby/manuals/dita.html
Modified: websites/production/db/content/derby/manuals/dita.html
==============================================================================
--- websites/production/db/content/derby/manuals/dita.html (original)
+++ websites/production/db/content/derby/manuals/dita.html Fri May 30 19:24:30 2014
@@ -234,10 +234,10 @@ be committing changes.
<li>
<p>
-<a class="external" href="http://ant.apache.org/">Apache Ant</a> version 1.6.2 or later</p>
+<a class="external" href="http://ant.apache.org/">Apache Ant</a> version 1.9.2 or later</p>
</li>
-<li>Any JDK 1.4.2 or later. Java's reference implementation is at <a class="external" href="http://java.sun.com/javase/">http://java.sun.com/javase/</a>.</li>
+<li>Any JDK at level Java 6 or later. Java's reference implementation is at <a class="external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a>.</li>
<li> Set up your subversion configuration file according to
the <a class="external" href="http://www.apache.org/dev/version-control.html#https-svn">ASF
@@ -259,7 +259,7 @@ be committing changes.
<p>To set up your environment for creating output from DITA-source:
</p>
<ol>
-<li>Install the JDK 1.4.2 or later implementation.</li>
+<li>Install the JDK for Java 6 or later.</li>
<li>
<p>Extract the DITA source files, Apache FOP, and the <span class="codefrag">build.xml</span> file from svn using the command described above. We will call the extraction home directory <span class="codefrag">%DOC_ROOT%/trunk</span>. For example, after extracting, the <em>Getting Started with Derby</em> DITA files would be located in <span class="codefrag">%DOC_ROOT%/trunk/src/getstart/</span>.
@@ -361,7 +361,7 @@ Guidelines for writing Derby information
<li>Enter the desired <span class="codefrag">ant</span> command on the command line using the following syntax:
<pre class="code">ant <output_type>.<manual_id></pre>
The <span class="codefrag"><output_type></span> is the format of the output you wish to create.
-The options are HTML, PDF, or monohtml. The <span class="codefrag"><manual_id></span> is
+The options are HTML or PDF. The <span class="codefrag"><manual_id></span> is
the id of the manual that you want to output. The id is the same as the name
of the directory containing that manual's DITA source files in
<span class="codefrag">%DOC_ROOT%/trunk/src/</span>. A list of the ids are shown in the table
@@ -373,21 +373,15 @@ below. For example, to create PDF output
</ol>
<p>
-To create PDF or HTML output for ALL SIX manuals at once, specify the output
+To create PDF or HTML output for ALL manuals at once, specify the output
type with no manual. For example:</p>
<pre class="code">ant pdf</pre>
<p>or</p>
<pre class="code">ant html</pre>
-<p>or</p>
-<pre class="code">ant monohtml</pre>
-<p>To create all three output formats for just one manual, enter the manual
-with no type. For example, the command shown below builds PDF, HTML, and MONOHTML
+<p>To create both formats for just one manual, enter the manual
+with no type. For example, the command shown below builds PDF and HTM
for the <em>Getting Started with Derby</em> guide:</p>
<pre class="code">ant getstart</pre>
-<p>
-<strong>Note:</strong> <span class="codefrag">monohtml</span> creates a single HTML file for
-the manual you specify, while <span class="codefrag">html</span> creates multiple HTML files
-with a navigation tree.</p>
<p>The output files will be built by the ant file and placed in the
<span class="codefrag">%DOC_ROOT%/trunk/out/</span> directory. If any of the software is not
set up and configured correctly, the build will fail.</p>
@@ -434,6 +428,13 @@ set up and configured correctly, the bui
<tr>
+<td colspan="1" rowspan="1">security</td>
+ <td colspan="1" rowspan="1">Derby Security Guide</td>
+
+</tr>
+
+<tr>
+
<td colspan="1" rowspan="1">tools</td>
<td colspan="1" rowspan="1">Derby Tools and Utilities Guide</td>
@@ -449,7 +450,7 @@ set up and configured correctly, the bui
</table>
</div>
-<a name="N101E0"></a><a name="DITA+file+names"></a>
+<a name="N101DB"></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>
@@ -457,7 +458,7 @@ set up and configured correctly, the bui
</div>
-<a name="N101EF"></a><a name="Modifying+the+output+format"></a>
+<a name="N101EA"></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>
@@ -473,7 +474,7 @@ Please post feedback to the
</p>
-<a name="N10208"></a><a name="Submitting+documentation+patches"></a>
+<a name="N10203"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -713,7 +714,7 @@ easier.</li>
</div>
-<a name="N102FB"></a><a name="Committing+documentation+patches"></a>
+<a name="N102F6"></a><a name="Committing+documentation+patches"></a>
<h2 class="boxed">Committing documentation patches</h2>
<div class="section">
<p>You must be a Derby committer to commit Derby patches.</p>
@@ -857,7 +858,7 @@ remove the check from "Patch Available".
<p>
-<em>Last Updated: March 19, 2007</em>
+<em>Last Updated: May 30, 2014</em>
</p>
</div>