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/02/23 23:31:30 UTC
svn commit: r380252 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Thu Feb 23 14:31:27 2006
New Revision: 380252
URL: http://svn.apache.org/viewcvs?rev=380252&view=rev
Log:
DERBY-710 : Updated step 4 in the "Setting up your enviroment" section in
site/trunk/build/site/manuals/dita.html with a recommendation to set
ANT_OPTS="-Xms100m -Xmx200m" if you run out of memory on DITA doc build.
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/viewcvs/db/derby/site/trunk/build/site/manuals/dita.html?rev=380252&r1=380251&r2=380252&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Thu Feb 23 14:31:27 2006
@@ -318,7 +318,8 @@
<p>
-Currently each Derby manual is sourced in an XML implementation called the Darwin Information Typing Architecture, or DITA. The original HTML source for the Derby documenation was converted to DITA to create an easy solution for requirements such as creating PDF outputs or single HTML files for each manual (See the
+Starting with Derby 10.1,
+each Derby manual is sourced in an XML implementation called the Darwin Information Typing Architecture, or DITA. The original HTML source for the Derby documenation was converted to DITA to create an easy solution for requirements such as creating PDF outputs or single HTML files for each manual (See the
<a class="external" href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-dev/200410.mbox/%3c200410071315.32497.Joel.Rosi-Schwartz@Etish.org%3e">Derby
documentation in PDF format</a> thread).
</p>
@@ -367,6 +368,9 @@
<li>
<p>Install Apache Ant, and make sure to follow the <a class="external" href="http://ant.apache.org/manual/index.html">instructions</a> for setting your environment variables.</p>
+If you encounter problems with running out of memory on the doc build,
+set the
+<span class="codefrag">ANT_OPTS</span> environment variable to <span class="codefrag">"-Xms100m -Xmx200m"</span>.
</li>
<li>
@@ -378,7 +382,7 @@
</div>
-<a name="N10085"></a><a name="Creating+output"></a>
+<a name="N1008C"></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>
@@ -451,7 +455,7 @@
</table>
</div>
-<a name="N1012D"></a><a name="DITA+file+names"></a>
+<a name="N10134"></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>
@@ -459,7 +463,7 @@
</div>
-<a name="N1013C"></a><a name="Modifying+the+output+format"></a>
+<a name="N10143"></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>
@@ -478,7 +482,7 @@
-<a name="N10159"></a><a name="Submitting+documentation+patches"></a>
+<a name="N10160"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -639,7 +643,7 @@
<p>
-<em>Last Updated: July 31, 2005</em>
+<em>Last Updated: February 23, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml?rev=380252&r1=380251&r2=380252&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 Thu Feb 23 14:31:27 2006
@@ -7,7 +7,8 @@
<body>
<p>
-Currently each Derby manual is sourced in an XML implementation called the Darwin Information Typing Architecture, or DITA. The original HTML source for the Derby documenation was converted to DITA to create an easy solution for requirements such as creating PDF outputs or single HTML files for each manual (See the
+Starting with Derby 10.1,
+each Derby manual is sourced in an XML implementation called the Darwin Information Typing Architecture, or DITA. The original HTML source for the Derby documenation was converted to DITA to create an easy solution for requirements such as creating PDF outputs or single HTML files for each manual (See the
<a href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-dev/200410.mbox/%3c200410071315.32497.Joel.Rosi-Schwartz@Etish.org%3e">Derby
documentation in PDF format</a> thread).
</p>
@@ -30,7 +31,11 @@
<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%</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%/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>
-<li><p>Install Apache Ant, and make sure to follow the <a href="http://ant.apache.org/manual/index.html">instructions</a> for setting your environment variables.</p></li>
+<li><p>Install Apache Ant, and make sure to follow the <a href="http://ant.apache.org/manual/index.html">instructions</a> for setting your environment variables.</p>
+If you encounter problems with running out of memory on the doc build,
+set the
+<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>
</ol>
@@ -236,6 +241,6 @@
</section>
-<p><em>Last Updated: July 31, 2005</em></p>
+<p><em>Last Updated: February 23, 2006</em></p>
</body>
</document>