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 ka...@apache.org on 2010/03/02 19:51:47 UTC
svn commit: r918148 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: kahatlen
Date: Tue Mar 2 18:51:46 2010
New Revision: 918148
URL: http://svn.apache.org/viewvc?rev=918148&view=rev
Log:
DERBY-4556: "DITA-sourced documentation" page on Derby site needs edits
Various small changes suggested by Kim Haase.
Modified:
db/derby/site/trunk/build/site/manuals/dita.html
db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
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?rev=918148&r1=918147&r2=918148&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Tue Mar 2 18:51:46 2010
@@ -216,11 +216,10 @@
<li>
<p>
-<a class="external" href="http://ant.apache.org/">Apache Ant Version 1.6.2</a>
-</p>
+<a class="external" href="http://ant.apache.org/">Apache Ant</a> version 1.6.2 or later</p>
</li>
-<li>Any JDK 1.4.2. Java's reference implementation is at <a class="external" href="http://java.sun.com/j2se/">http://java.sun.com/j2se/</a>.</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> Set up your subversion configuration file according to
the <a class="external" href="http://www.apache.org/dev/version-control.html#https-svn">ASF
@@ -243,7 +242,7 @@
<p>To set up your environment for creating output from DITA-source:
</p>
<ol>
-<li>Install the JDK 1.4.2 implementation.</li>
+<li>Install the JDK 1.4.2 or later implementation.</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>.
@@ -265,11 +264,19 @@
<p>For PDF output: Make sure to include the <span class="codefrag">fop.jar</span>, <span class="codefrag">avalon-framework-cvs-20020806.jar</span>, and <span class="codefrag">batik.jar</span> files located in <span class="codefrag">%DOC_ROOT%/trunk/lib/</span> in your <span class="codefrag">CLASSPATH</span> environment variable.</p>
</li>
+<li>
+<p>
+On a UNIX system, make sure that your LANG environment variable is set
+to "en_US.UTF-8" rather than to "C" or "en_US.ISO8859-1". (On Windows,
+UTF-8 seems to be the default.)
+</p>
+</li>
+
</ol>
</div>
-<a name="N100AE"></a><a name="Locating+the+correct+DITA+file"></a>
+<a name="N100B3"></a><a name="Locating+the+correct+DITA+file"></a>
<h2 class="boxed">Locating the correct DITA file</h2>
<div class="section">
<p>The simpliest way to determine the name of the file that contains the information that you want to update is to:</p>
@@ -303,7 +310,7 @@
</div>
-<a name="N100E9"></a><a name="Editing+DITA+files"></a>
+<a name="N100EE"></a><a name="Editing+DITA+files"></a>
<h2 class="boxed">Editing DITA files</h2>
<div class="section">
<p>DITA is an XML specification. You can edit DITA files in any text editor, but XML editors allow you to insert and modifiy tags easily while conforming to the DITA DTD and schemas. It is HIGHLY recommended that you use an XML editor to avoid errors in tagging.</p>
@@ -334,7 +341,7 @@
</div>
-<a name="N10121"></a><a name="Creating+output"></a>
+<a name="N10126"></a><a name="Creating+output"></a>
<h2 class="boxed">Creating output</h2>
<div class="section">
<p>To create output from the DITA source files:</p>
@@ -429,18 +436,11 @@
<td colspan="1" rowspan="1">Tuning Derby</td>
</tr>
-
-<tr>
-
-<td colspan="1" rowspan="1">workingwithderby</td>
- <td colspan="1" rowspan="1">Working with Derby</td>
-
-</tr>
</table>
</div>
-<a name="N101EC"></a><a name="DITA+file+names"></a>
+<a name="N101E4"></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>
@@ -448,12 +448,12 @@
</div>
-<a name="N101FB"></a><a name="Modifying+the+output+format"></a>
+<a name="N101F3"></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>
<p>
-You are invited to submit your modified xsl files to <span class="codefrag">derby-dev</span>. If you wish to use a modified xsl file, just replace the version of the file in the toolkit with the new one. Jeff Levitt submitted an xsl file for improving the PDF output <a class="external" href="http://mail-archives.apache.org/mod_mbox/db-derby-dev/200503.mbox/%3c20050318002420.86369.qmail@web81602.mail.yahoo.com%3e">here</a>.
+You are invited to submit your modified xsl files to <span class="codefrag">derby-dev</span>. If you wish to use a modified xsl file, just replace the version of the file in the toolkit with the new one.
</p>
</div>
@@ -464,7 +464,7 @@
</p>
-<a name="N10218"></a><a name="Submitting+documentation+patches"></a>
+<a name="N1020C"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -704,7 +704,7 @@
</div>
-<a name="N1030B"></a><a name="Committing+documentation+patches"></a>
+<a name="N102FF"></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>
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?rev=918148&r1=918147&r2=918148&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Tue Mar 2 18:51:46 2010
@@ -41,8 +41,8 @@
Note that the <code>https</code> is required (not <code>http</code>) if you will
be committing changes.
</li>
-<li><p><a href="http://ant.apache.org/">Apache Ant Version 1.6.2</a></p></li>
-<li>Any JDK 1.4.2. Java's reference implementation is at <a href="http://java.sun.com/j2se/">http://java.sun.com/j2se/</a>.</li>
+<li><p><a href="http://ant.apache.org/">Apache Ant</a> version 1.6.2 or later</p></li>
+<li>Any JDK 1.4.2 or later. Java's reference implementation is at <a href="http://java.sun.com/javase/">http://java.sun.com/javase/</a>.</li>
<li> Set up your subversion configuration file according to
the <a href="http://www.apache.org/dev/version-control.html#https-svn">ASF
instructions</a>.
@@ -62,7 +62,7 @@
<p>To set up your environment for creating output from DITA-source:
</p>
-<ol><li>Install the JDK 1.4.2 implementation.</li>
+<ol><li>Install the JDK 1.4.2 or later implementation.</li>
<li><p>Extract the DITA source files, Apache FOP, and the <code>build.xml</code> file from svn using the command described above. We will call the extraction home directory <code>%DOC_ROOT%/trunk</code>. For example, after extracting, the <em>Getting Started with Derby</em> DITA files would be located in <code>%DOC_ROOT%/trunk/src/getstart/</code>.
</p></li>
<li><p>Place the downloaded DITA-OT1.1.2.1_bin-ASL.zip file into the lib directory where you have checked out the DITA source files, <code>%DOC_ROOT%/trunk/lib</code>. The first time you build one of the manuals, Ant will extract the DITA Toolkit to the <code>%DOC_ROOT%/trunk/</code> directory. After extraction, the DITA Toolkit files should be located in <code>%DOC_ROOT%/trunk/DITA-OT1.1.2.1/</code>.</p></li>
@@ -72,6 +72,11 @@
<code>ANT_OPTS</code> environment variable to <code>"-Xms100m -Xmx200m"</code>.
</li>
<li><p>For PDF output: Make sure to include the <code>fop.jar</code>, <code>avalon-framework-cvs-20020806.jar</code>, and <code>batik.jar</code> files located in <code>%DOC_ROOT%/trunk/lib/</code> in your <code>CLASSPATH</code> environment variable.</p></li>
+<li><p>
+On a UNIX system, make sure that your LANG environment variable is set
+to "en_US.UTF-8" rather than to "C" or "en_US.ISO8859-1". (On Windows,
+UTF-8 seems to be the default.)
+</p></li>
</ol>
</section>
@@ -173,10 +178,6 @@
<td>tuning</td>
<td>Tuning Derby</td>
</tr>
- <tr>
- <td>workingwithderby</td>
- <td>Working with Derby</td>
- </tr>
</table>
</section>
<section><title>DITA file names</title>
@@ -187,7 +188,7 @@
<section><title>Modifying the output format</title>
<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 <code>dita2fo_shell.xsl</code> file.</p>
<p>
-You are invited to submit your modified xsl files to <code>derby-dev</code>. If you wish to use a modified xsl file, just replace the version of the file in the toolkit with the new one. Jeff Levitt submitted an xsl file for improving the PDF output <a href="http://mail-archives.apache.org/mod_mbox/db-derby-dev/200503.mbox/%3c20050318002420.86369.qmail@web81602.mail.yahoo.com%3e">here</a>.
+You are invited to submit your modified xsl files to <code>derby-dev</code>. If you wish to use a modified xsl file, just replace the version of the file in the toolkit with the new one.
</p>
</section>