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/07/19 01:24:08 UTC
svn commit: r423288 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Tue Jul 18 16:24:08 2006
New Revision: 423288
URL: http://svn.apache.org/viewvc?rev=423288&view=rev
Log:
DERBY-1269 Clarified directory locations in the DITA instructions for building
the documentation.
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=423288&r1=423287&r2=423288&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Tue Jul 18 16:24:08 2006
@@ -161,12 +161,12 @@
<li>Install the JDK 1.4.2 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%</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>.
+<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>.
</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, <span class="codefrag">%DOC_ROOT%/lib</span>. The first time you build one of the manuals, Ant will extract the DITA Toolkit to the <span class="codefrag">%DOC_ROOT%/trunk/</span> directory. After extraction, the DITA Toolkit files should be located in <span class="codefrag">%DOC_ROOT%/trunk/DITA-OT1.1.2.1/</span>.</p>
+<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, <span class="codefrag">%DOC_ROOT%/trunk/lib</span>. The first time you build one of the manuals, Ant will extract the DITA Toolkit to the <span class="codefrag">%DOC_ROOT%/trunk/</span> directory. After extraction, the DITA Toolkit files should be located in <span class="codefrag">%DOC_ROOT%/trunk/DITA-OT1.1.2.1/</span>.</p>
</li>
<li>
@@ -228,7 +228,7 @@
</ol>
<p>Note that <span class="codefrag">monohtml</span> creates a single HTML file for each manual, 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%/out/</span> directory. If any of the software is not set up and configured correctly, the build will fail.</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>
<p>The following table lists the manual id's for each Derby manual:</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -475,7 +475,7 @@
<p>
-<em>Last Updated: April 14, 2006</em>
+<em>Last Updated: July 18, 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?rev=423288&r1=423287&r2=423288&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 Jul 18 16:24:08 2006
@@ -33,9 +33,9 @@
<p>To set up your environment for creating output from DITA-source:
</p>
<ol><li>Install the JDK 1.4.2 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%</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>.
+<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%/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>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>
<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
@@ -67,7 +67,7 @@
<source>ant <output_type>.<manual_id></source>The <code><output_type></code> is the format of the output you wish to create, either HTML or PDF. The <code><manual_id></code> is the id of the manual you wish to output. The id can be found as the name of the directory containing that manual's DITA source files in <code>%DOC_ROOT%/trunk/src/</code>. For example, to create PDF output for the <em>Getting Started with Derby</em> guide, enter the following command:<source>ant pdf.getstart</source> To create PDF or HTML output for ALL SIX manuals at once, simply enter the output type with no manual:<source>ant pdf</source>or<source>ant html</source>or<source>ant monohtml</source></li>
</ol>
<p>Note that <code>monohtml</code> creates a single HTML file for each manual, while <code>html</code> creates multiple HTML files with a navigation tree.</p>
-<p>The output files will be built by the ant file and placed in the <code>%DOC_ROOT%/out/</code> directory. If any of the software is not set up and configured correctly, the build will fail.</p> <p>The following table lists the manual id's for each Derby manual:</p>
+<p>The output files will be built by the ant file and placed in the <code>%DOC_ROOT%/trunk/out/</code> directory. If any of the software is not set up and configured correctly, the build will fail.</p> <p>The following table lists the manual id's for each Derby manual:</p>
<table>
<tr>
@@ -258,6 +258,6 @@
</section>
-<p><em>Last Updated: April 14, 2006</em></p>
+<p><em>Last Updated: July 18, 2006</em></p>
</body>
</document>