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/04/14 22:13:28 UTC
svn commit: r394182 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Fri Apr 14 13:13:23 2006
New Revision: 394182
URL: http://svn.apache.org/viewcvs?rev=394182&view=rev
Log:
Updated the web site page that describes how to build the Derby DITA docs,
manuals/dita.html:
(1) It pointed to the 1.1.2.1 DITA Toolkit download, but said 1.2.1.1. This
will likely cause confusion because DITA 1.2 was released this month, but we
need to continue using 1.1.2.1 until the new release is verified.
(2) Added a link to the DITA Toolkit project at SourceForge.
(3) The .dita and .ditamap file types should have svn:eol-style=native entries
in ~/.subversion/config .
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=394182&r1=394181&r2=394182&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Fri Apr 14 13:13:23 2006
@@ -131,7 +131,8 @@
<ul>
<li>
-<p>The binary download of the <a class="external" href="http://prdownloads.sourceforge.net/dita-ot/DITA-OT1.1.2.1_bin-ASL.zip?download">DITA Toolkit</a> Version 1.2.1.1 from SourceForge. Use ONLY this version.</p>
+<p>The binary download of the <a class="external" href="http://prdownloads.sourceforge.net/dita-ot/DITA-OT1.1.2.1_bin-ASL.zip?download">DITA Toolkit</a> Version 1.1.2.1
+from <a class="external" href="http://sourceforge.net/projects/dita-ot">SourceForge</a>. Use ONLY this version.</p>
</li>
<li>
@@ -147,6 +148,12 @@
<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>Update your <a class="external" href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a> file with these entries:
+<pre class="code">*.dita = svn:eol-style=native
+*.ditamap = svn:eol-style=native</pre>
+
+</li>
+
</ul>
<p>To set up your environment for creating output from DITA-source:
</p>
@@ -177,7 +184,7 @@
</ol>
</div>
-<a name="N1008C"></a><a name="Editing+DITA+files"></a>
+<a name="N1009B"></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>
@@ -207,7 +214,7 @@
</pre>
</div>
-<a name="N100BD"></a><a name="Creating+output"></a>
+<a name="N100CC"></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>
@@ -280,7 +287,7 @@
</table>
</div>
-<a name="N10165"></a><a name="DITA+file+names"></a>
+<a name="N10174"></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>
@@ -288,7 +295,7 @@
</div>
-<a name="N10174"></a><a name="Modifying+the+output+format"></a>
+<a name="N10183"></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>
@@ -307,7 +314,7 @@
-<a name="N10191"></a><a name="Submitting+documentation+patches"></a>
+<a name="N101A0"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -468,7 +475,7 @@
<p>
-<em>Last Updated: February 23, 2006</em>
+<em>Last Updated: April 14, 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=394182&r1=394181&r2=394182&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 Apr 14 13:13:23 2006
@@ -19,10 +19,15 @@
<p>
Requirements:</p>
<ul>
-<li><p>The binary download of the <a href="http://prdownloads.sourceforge.net/dita-ot/DITA-OT1.1.2.1_bin-ASL.zip?download">DITA Toolkit</a> Version 1.2.1.1 from SourceForge. Use ONLY this version.</p></li>
+<li><p>The binary download of the <a href="http://prdownloads.sourceforge.net/dita-ot/DITA-OT1.1.2.1_bin-ASL.zip?download">DITA Toolkit</a> Version 1.1.2.1
+from <a href="http://sourceforge.net/projects/dita-ot">SourceForge</a>. Use ONLY this version.</p></li>
<li><p>Derby's DITA source files, Apache FOP, and the <code>build.xml</code> file used with ant to build the output. These can ALL be extracted at once using svn: </p><source>svn checkout https://svn.apache.org/repos/asf/db/derby/docs/trunk/</source></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>Update your <a href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a> file with these entries:
+<source>*.dita = svn:eol-style=native
+*.ditamap = svn:eol-style=native</source>
+</li>
</ul>
<p>To set up your environment for creating output from DITA-source:
@@ -253,6 +258,6 @@
</section>
-<p><em>Last Updated: February 23, 2006</em></p>
+<p><em>Last Updated: April 14, 2006</em></p>
</body>
</document>