db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r441371 - in /db/derby/site/trunk: build/site/manuals/dita.html src/documentation/content/xdocs/manuals/dita.xml
Date Fri, 08 Sep 2006 04:24:17 GMT
Author: jta
Date: Thu Sep  7 21:24:16 2006
New Revision: 441371

URL: http://svn.apache.org/viewvc?view=rev&rev=441371
Log:
Updated the DITA instructions on the web site to show how to output html, pdf, and monohtml
for
just one manual.

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?view=diff&rev=441371&r1=441370&r2=441371
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Thu Sep  7 21:24:16 2006
@@ -226,7 +226,13 @@
 <li>From a command line, navigate to <span class="codefrag">%DOC_ROOT%/trunk/</span>.</li>
 
 <li>Enter the desired <span class="codefrag">ant</span> command on the
command line using the following syntax:
-<pre class="code">ant &lt;output_type&gt;.&lt;manual_id&gt;</pre>The
<span class="codefrag">&lt;output_type&gt;</span> is the format of the
output you wish to create, either HTML or PDF.  The <span class="codefrag">&lt;manual_id&gt;</span>
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 <span class="codefrag">%DOC_ROOT%/trunk/src/</span>.
 For example, to create PDF output for the <em>Getting Started with Derby</em>
guide, enter the following command:<pre class="code">ant pdf.getstart</pre> To
create PDF or HTML output for ALL SIX manuals at once, simply enter the output type with no
manual:<pre class="code">ant pdf</pre>or<pre class="code">ant html</pre>or<pre
class="code">ant monohtml</pre>
+<pre class="code">ant &lt;output_type&gt;.&lt;manual_id&gt;</pre>
+The <span class="codefrag">&lt;output_type&gt;</span> is the format of
the output you wish to create, either HTML or PDF.  The <span class="codefrag">&lt;manual_id&gt;</span>
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 <span class="codefrag">%DOC_ROOT%/trunk/src/</span>.
 For example, to create PDF output for the <em>Getting Started with Derby</em>
guide, enter the following command:<pre class="code">ant pdf.getstart</pre> To
create PDF or HTML output for ALL SIX manuals at once, simply enter the output type with no
manual:<pre class="code">ant pdf</pre>or<pre class="code">ant html</pre>or<pre
class="code">ant monohtml</pre>
+To create PDF and HTML for just one manual, enter the manual with no type.
+For example, the command shown below builds all three
+for the <em>Getting Started with Derby</em> guide:
+<pre class="code">ant getstart</pre>
+
 </li>
 
 </ol>
@@ -290,7 +296,7 @@
 </table>
 </div>
 
-<a name="N10175"></a><a name="DITA+file+names"></a>
+<a name="N1017D"></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>
@@ -298,7 +304,7 @@
 </div>
 
 
-<a name="N10184"></a><a name="Modifying+the+output+format"></a>
+<a name="N1018C"></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>
@@ -317,7 +323,7 @@
 
 
 
-<a name="N101A1"></a><a name="Submitting+documentation+patches"></a>
+<a name="N101A9"></a><a name="Submitting+documentation+patches"></a>
 <h2 class="boxed">Submitting documentation patches</h2>
 <div class="section">
 <p> 
@@ -490,7 +496,7 @@
 </div>
 
 
-<a name="N1024A"></a><a name="Committing+documentation+patches"></a>
+<a name="N10252"></a><a name="Committing+documentation+patches"></a>
 <h2 class="boxed">Committing documentation patches</h2>
 <div class="section">
 <ol>
@@ -559,7 +565,7 @@
 
 
 <p>
-<em>Last Updated: August 23, 2006</em>
+<em>Last Updated: September 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=441371&r1=441370&r2=441371
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Thu Sep  7 21:24:16
2006
@@ -80,8 +80,15 @@
 <ol>
 <li>From a command line, navigate to <code>%DOC_ROOT%/trunk/</code>.</li>
 <li>Enter the desired <code>ant</code> command on the command line using
the following syntax:
-<source>ant &lt;output_type&gt;.&lt;manual_id&gt;</source>The
<code>&lt;output_type&gt;</code> is the format of the output you wish
to create, either HTML or PDF.  The <code>&lt;manual_id&gt;</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>
+<source>ant &lt;output_type&gt;.&lt;manual_id&gt;</source>
+The <code>&lt;output_type&gt;</code> is the format of the output you
wish to create, either HTML or PDF.  The <code>&lt;manual_id&gt;</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>
+To create PDF and HTML for just one manual, enter the manual with no type.
+For example, the command shown below builds all three
+for the <em>Getting Started with Derby</em> guide:
+<source>ant getstart</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%/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>
@@ -315,6 +322,6 @@
 
 </section>
 
-<p><em>Last Updated: August 23, 2006</em></p>
+<p><em>Last Updated: September 7, 2006</em></p>
 </body>
 </document>



Mime
View raw message