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/03/24 23:40:06 UTC
svn commit: r388669 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Fri Mar 24 14:40:05 2006
New Revision: 388669
URL: http://svn.apache.org/viewcvs?rev=388669&view=rev
Log:
DERBY-1150 Jeff Levitt's patch adds a new section on editing DITA files.
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=388669&r1=388668&r2=388669&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Fri Mar 24 14:40:05 2006
@@ -299,6 +299,9 @@
<a href="#Setting+up+your+environment">Setting up your environment</a>
</li>
<li>
+<a href="#Editing+DITA+files">Editing DITA files</a>
+</li>
+<li>
<a href="#Creating+output">Creating output</a>
</li>
<li>
@@ -378,8 +381,37 @@
</ol>
</div>
+<a name="N1008C"></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>
+<p>There are many different XML editors available at various costs and some for no cost at all. Make sure to read the licenses for any XML editor you use to modify Derby DITA documentation. Some XML editors include:</p>
+<ul>
+
+<li>
+<a class="external" href="http://www.ptc.com/appserver/mkt/products/home.jsp?k=3593">Arbortext Editor</a>
+</li>
+
+<li>
+<a class="external" href="http://www.oxygenxml.com">oXygen</a>
+</li>
+
+<li>
+<a class="external" href="http://xmlbuddy.com/">XML Buddy</a> (an <a class="external" href="http://www.eclipse.org/">Eclipse</a> plugin)</li>
+
+<li>
+<a class="external" href="http://www.altova.com">Altova XML Spy</a>
+</li>
+
+</ul>
+<p>
+To learn more about DITA, how to create or edit DITA files, and find more XML editors that support DITA, go to:</p>
+<pre class="code">
+<a class="external" href="http://dita.xml.org/">http://dita.xml.org/</a>
+</pre>
+</div>
-<a name="N1008C"></a><a name="Creating+output"></a>
+<a name="N100BD"></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>
@@ -452,7 +484,7 @@
</table>
</div>
-<a name="N10134"></a><a name="DITA+file+names"></a>
+<a name="N10165"></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>
@@ -460,7 +492,7 @@
</div>
-<a name="N10143"></a><a name="Modifying+the+output+format"></a>
+<a name="N10174"></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>
@@ -479,7 +511,7 @@
-<a name="N10160"></a><a name="Submitting+documentation+patches"></a>
+<a name="N10191"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
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=388669&r1=388668&r2=388669&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 Fri Mar 24 14:40:05 2006
@@ -40,7 +40,19 @@
</ol>
</section>
-
+<section>
+<title>Editing DITA files</title>
+<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>
+<p>There are many different XML editors available at various costs and some for no cost at all. Make sure to read the licenses for any XML editor you use to modify Derby DITA documentation. Some XML editors include:</p>
+<ul>
+<li><a href="http://www.ptc.com/appserver/mkt/products/home.jsp?k=3593">Arbortext Editor</a></li>
+<li><a href="http://www.oxygenxml.com">oXygen</a></li>
+<li><a href="http://xmlbuddy.com/">XML Buddy</a> (an <a href="http://www.eclipse.org/">Eclipse</a> plugin)</li>
+<li><a href="http://www.altova.com">Altova XML Spy</a></li>
+</ul>
+<p>
+To learn more about DITA, how to create or edit DITA files, and find more XML editors that support DITA, go to:</p><source><a href="http://dita.xml.org/">http://dita.xml.org/</a></source>
+</section>
<section>
<title>Creating output</title>
<p>To create output from the DITA source files:</p>