db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject svn commit: r160060 - in incubator/derby/site/trunk: build/site/integrate/misc.html build/site/manuals/dita.html src/documentation/content/xdocs/integrate/misc.xml src/documentation/content/xdocs/manuals/dita.xml
Date Mon, 04 Apr 2005 17:14:53 GMT
Author: jta
Date: Mon Apr  4 10:14:52 2005
New Revision: 160060

URL: http://svn.apache.org/viewcvs?view=rev&rev=160060
Log:
Applied Jeff Levitt's dita.xml patch for DERBY-193,
and added Kevin Foster's posted link to DB2 Everyplace article.

Modified:
    incubator/derby/site/trunk/build/site/integrate/misc.html
    incubator/derby/site/trunk/build/site/manuals/dita.html
    incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/misc.xml
    incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml

Modified: incubator/derby/site/trunk/build/site/integrate/misc.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/build/site/integrate/misc.html?view=diff&r1=160059&r2=160060
==============================================================================
--- incubator/derby/site/trunk/build/site/integrate/misc.html (original)
+++ incubator/derby/site/trunk/build/site/integrate/misc.html Mon Apr  4 10:14:52 2005
@@ -275,6 +275,8 @@
    <td colspan="1" rowspan="1"> IBM </td>
    <td colspan="1" rowspan="1"> DB2 Everyplace is a data synchronization solution that
supports
    <a class="external" href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-user/200501.mbox/%3cOF68A2C6FA.B98D50DE-ON07256F91.004FFD24-07256F91.0052617B@us.ibm.com%3e">Derby</a>.
+   An IBM developerWorks article
+   <a class="external" href="http://www.ibm.com/developerworks/db2/library/techarticle/dm-0503stumpf/">shows
how to replicate between Derby and other databases</a>.
    </td>
 
 </tr>
@@ -539,7 +541,7 @@
 </div>
 
 
-<a name="N1032F"></a><a name="Wish+List"></a>
+<a name="N10333"></a><a name="Wish+List"></a>
 <h2 class="boxed">Wish List</h2>
 <div class="section">
 <p>
@@ -560,7 +562,7 @@
 </div>
 
 
-<a name="N1034B"></a><a name="Products+by+Type"></a>
+<a name="N1034F"></a><a name="Products+by+Type"></a>
 <h2 class="boxed">Products by Type</h2>
 <div class="section">
 <p>
@@ -730,7 +732,7 @@
 
 
 <p>
-<em>Last Updated: March 15, 2005</em>
+<em>Last Updated: April 4, 2005</em>
 </p>
 
 </div>

Modified: incubator/derby/site/trunk/build/site/manuals/dita.html
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/build/site/manuals/dita.html?view=diff&r1=160059&r2=160060
==============================================================================
--- incubator/derby/site/trunk/build/site/manuals/dita.html (original)
+++ incubator/derby/site/trunk/build/site/manuals/dita.html Mon Apr  4 10:14:52 2005
@@ -202,8 +202,14 @@
 <a href="#Creating+output">Creating output</a>
 </li>
 <li>
+<a href="#DITA+file+names">DITA file names</a>
+</li>
+<li>
 <a href="#Modifying+the+output+format">Modifying the output format</a>
 </li>
+<li>
+<a href="#Submitting+documentation+patches">Submitting documentation patches</a>
+</li>
 </ul>
 </div> 
 
@@ -225,12 +231,12 @@
 <ul>
 
 <li>
-<p>The <a class="external" href="http://sourceforge.net/projects/dita-ot/">DITA
Toolkit</a> Version 1.0 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.0.0-bin.zip?download">DITA
Toolkit</a> Version 1.0 from SourceForge. Use ONLY this version.</p>
 </li>
 
 <li>
 <p>Derby's DITA source files, Apache FOP, and the <span class="codefrag">build.xml</span>
file used with ant to build the output.  These can ALL be extracted at once using svn: </p>
-<pre class="code">svn checkout http://svn.apache.org/repos/asf/incubator/derby/docs/trunk/</pre>
+<pre class="code">svn checkout https://svn.apache.org/repos/asf/incubator/derby/docs/trunk/</pre>
 </li>
 
 <li>
@@ -319,7 +325,7 @@
 
 <tr> 
          
-<td colspan="1" rowspan="1">refguide</td>
+<td colspan="1" rowspan="1">ref</td>
          <td colspan="1" rowspan="1">Derby Reference Manual</td>
    
 </tr> 
@@ -341,8 +347,15 @@
 </table>
 </div>
 
+<a name="N1011D"></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>
+<p>It is suggested that any new DITA files that you may add follow this naming scheme
to maintain organization of the files.</p>
+</div>
+
 
-<a name="N1011D"></a><a name="Modifying+the+output+format"></a>
+<a name="N1012C"></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>
@@ -361,10 +374,165 @@
 
 
 
+<a name="N10149"></a><a name="Submitting+documentation+patches"></a>
+<h2 class="boxed">Submitting documentation patches</h2>
+<div class="section">
+<p> 
+
+<strong>Guidelines</strong>
+
+</p>
+<p>
+If you would like to participate directly in any Derby development (including documentation
changes), 
+be sure to read the guidelines found <a href="http://incubator.apache.org/derby/derby_comm.html#Contribute+Code+or+Documentation">here</a>.
+</p>
+<p> 
+
+<strong>Use 'svn diff' for patches, not 'cvs diff'</strong>
+
+</p>
+<p> 
+The Apache DB Project recommends using
+<a class="external" href="http://db.apache.org/source.html">cvs diff</a>
+output for creating patches,
+but Derby uses <span class="codefrag">svn</span>,
+so use '<span class="codefrag">svn diff</span>' instead.
+</p>
+<p> 
+
+<strong>How to create a patch</strong>
+
+</p>
+<ol>
+
+
+<li> 
+
+
+<p>
+Sync up your local svn copy with any changes checked into the server:
+</p>
+
+
+<pre class="code">
+cd &lt;my_derby_loc&gt;/trunk
+svn update
+</pre>
+
+
+</li> 
+
+
+<li> 
+
+<p>
+Make your changes. If you are adding a new file, add it using svn.
+The example below shows adding a file named <span class="codefrag">cgsnewditafile.dita</span>
to the <span class="codefrag">Getting Started Guide</span>:
+</p>
+
+
+<pre class="code">
+svn add src/getstart/cgsnewditafile.dita 
+svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
+</pre>
+
+
+<p>Remember to add a topicref for the new file to the ditamap where you want it to
appear in the manual. 
+</p>
+
+</li> 
+
+
+<li> 
+
+<p>
+Test your changes by running <span class="codefrag">ant</span> to create output
in both HTML and PDF.  Make sure no new errors or build failures result from your changes,
and check that the output looks correct.
+</p> 
+
+</li> 
+
+<li> 
+
+<p> 
+Make the patch.
+</p> 
+
+<pre class="code">
+svn diff &gt; xyz.diff
+</pre>
+
+
+</li>
+
+
+<li> 
+
+
+<p> 
+Post the patch to the <a href="derby_mail.html">derby-dev</a> mail list
+or attach it to the Jira issue.
+</p> 
+
+
+<p> 
+Include the following information with your post:
+</p> 
+
+     
+<ul>
+
+ 
+<li>Which manuals are affected by your changes, and whether you tested them for successful
building.</li>
+     
+<li> For a feature, bug fix, or large overhaul of the documentation, a description
of the detailed functionality or reasons for the changes documented is essential.
+     </li>
+
+     
+</ul>
+
+</li>
+
+
+</ol>
+<p> 
+
+<strong>Enigmail tips for sending and saving patches</strong>
+
+</p>
+<p>
+If you use Enigmail to send a patch to the
+<a href="derby_mail.html">derby-dev</a> mail list be aware that, 
+by default,
+Enigmail handles Mozilla's <em>text=flowed</em> formatting 
+by replacing leading spaces with a tilde ("~") character (see
+<a class="external" href="http://enigmail.mozdev.org/troubles.html#flowed">
+http://enigmail.mozdev.org/troubles.html#flowed</a>).
+To send a patch in-line using Enigmail,
+turn off the <em>Allow flowed text</em> setting:
+</p>
+<pre class="code">
+     Enigmail -&gt; Preferences -&gt; Sending -&gt; Allow flowed text (RFC 2646)
+</pre>
+<p>
+If you use Enigmail to save a patch submitted to the
+<a href="derby_mail.html">derby-dev</a> mail list,
+you may need to decrypt and save that decrypted email if it was signed using
+gnuPG because
+lines that begin with a dash get escaped with "- " (see
+<a class="external" href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</a>).
+To extract the text in Enigmail without the escape characters,
+first decrypt the email, then save the decrypted message:
+</p>
+<pre class="code">
+     Enigmail -&gt; Decrypt/verify
+     Enigmail -&gt; Save decrypted message
+</pre>
+</div>
+
 
 
 <p>
-<em>Last Updated: March 21, 2005</em>
+<em>Last Updated: April 1, 2005</em>
 </p>
 
 </div>

Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/misc.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/misc.xml?view=diff&r1=160059&r2=160060
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/misc.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/integrate/misc.xml Mon Apr
 4 10:14:52 2005
@@ -86,6 +86,8 @@
    <td> IBM </td>
    <td> DB2 Everyplace is a data synchronization solution that supports
    <a href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-user/200501.mbox/%3cOF68A2C6FA.B98D50DE-ON07256F91.004FFD24-07256F91.0052617B@us.ibm.com%3e">Derby</a>.
+   An IBM developerWorks article
+   <a href="http://www.ibm.com/developerworks/db2/library/techarticle/dm-0503stumpf/">shows
how to replicate between Derby and other databases</a>.
    </td>
 </tr>
 
@@ -414,6 +416,6 @@
 
 </section>
 
-<p><em>Last Updated: March 15, 2005</em></p>
+<p><em>Last Updated: April 4, 2005</em></p>
 </body>
 </document>

Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml
URL: http://svn.apache.org/viewcvs/incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml?view=diff&r1=160059&r2=160060
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Mon Apr  4
10:14:52 2005
@@ -18,8 +18,8 @@
 <p>
 Requirements:</p>
 <ul>
-<li><p>The <a href="http://sourceforge.net/projects/dita-ot/">DITA Toolkit</a>
Version 1.0 from SourceForge. 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 http://svn.apache.org/repos/asf/incubator/derby/docs/trunk/</source></li>
+<li><p>The binary download of the <a href="http://prdownloads.sourceforge.net/dita-ot/DITA-OT1.0.0-bin.zip?download">DITA
Toolkit</a> Version 1.0 from SourceForge. 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/incubator/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>
 </ul>
@@ -66,7 +66,7 @@
          <td>Derby Developer's Guide</td>
    </tr> 
 <tr> 
-         <td>refguide</td>
+         <td>ref</td>
          <td>Derby Reference Manual</td>
    </tr> 
 <tr> 
@@ -78,7 +78,10 @@
          <td>Tuning Derby</td>
    </tr> 
 </table>
-
+</section>
+<section><title>DITA file names</title>
+<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 <code>Getting Started with Derby</code> 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>
+<p>It is suggested that any new DITA files that you may add follow this naming scheme
to maintain organization of the files.</p>
 </section>
 
 <section><title>Modifying the output format</title>
@@ -97,8 +100,141 @@
 </p>
 
 
+<section>
+<title>Submitting documentation patches</title>
+
+<p> 
+<strong>Guidelines</strong>
+</p> 
+<p>
+If you would like to participate directly in any Derby development (including documentation
changes), 
+be sure to read the guidelines found <a href="http://incubator.apache.org/derby/derby_comm.html#Contribute+Code+or+Documentation">here</a>.
+</p>
+
+
+<p> 
+<strong>Use 'svn diff' for patches, not 'cvs diff'</strong>
+</p> 
+
+<p> 
+The Apache DB Project recommends using
+<a href="http://db.apache.org/source.html">cvs diff</a>
+output for creating patches,
+but Derby uses <code>svn</code>,
+so use '<code>svn diff</code>' instead.
+</p> 
+
+<p> 
+<strong>How to create a patch</strong>
+</p> 
+
+<ol>
+
+<li> 
+
+<p>
+Sync up your local svn copy with any changes checked into the server:
+</p>
+
+<source>
+cd &lt;my_derby_loc&gt;/trunk
+svn update
+</source>
+
+</li> 
+
+<li> 
+<p>
+Make your changes. If you are adding a new file, add it using svn.
+The example below shows adding a file named <code>cgsnewditafile.dita</code>
to the <code>Getting Started Guide</code>:
+</p>
+
+<source>
+svn add src/getstart/cgsnewditafile.dita 
+svn propset svn:eol-style native src/getstart/cgsnewditafile.dita
+</source>
+
+<p>Remember to add a topicref for the new file to the ditamap where you want it to
appear in the manual. 
+</p>
+</li> 
+
+<li> 
+<p>
+Test your changes by running <code>ant</code> to create output in both HTML and
PDF.  Make sure no new errors or build failures result from your changes, and check that the
output looks correct.
+</p> 
+</li> 
+<li> 
+<p> 
+Make the patch.
+</p> 
+<source>
+svn diff &gt; xyz.diff
+</source>
+
+</li>
+
+<li> 
+
+<p> 
+Post the patch to the <a href="derby_mail.html">derby-dev</a> mail list
+or attach it to the Jira issue.
+</p> 
+
+<p> 
+Include the following information with your post:
+</p> 
+
+     <ul>
+
+ <li>Which manuals are affected by your changes, and whether you tested them for successful
building.</li>
+     <li> For a feature, bug fix, or large overhaul of the documentation, a description
of the detailed functionality or reasons for the changes documented is essential.
+     </li>
+
+     </ul>
+</li>
+
+</ol>
+
+
+<p> 
+<strong>Enigmail tips for sending and saving patches</strong>
+</p> 
+
+<p>
+If you use Enigmail to send a patch to the
+<a href="derby_mail.html">derby-dev</a> mail list be aware that, 
+by default,
+Enigmail handles Mozilla's <em>text=flowed</em> formatting 
+by replacing leading spaces with a tilde ("~") character (see
+<a href="http://enigmail.mozdev.org/troubles.html#flowed">
+http://enigmail.mozdev.org/troubles.html#flowed</a>).
+To send a patch in-line using Enigmail,
+turn off the <em>Allow flowed text</em> setting:
+</p>
+
+<source>
+     Enigmail -&gt; Preferences -&gt; Sending -&gt; Allow flowed text (RFC 2646)
+</source>
+
+<p>
+If you use Enigmail to save a patch submitted to the
+<a href="derby_mail.html">derby-dev</a> mail list,
+you may need to decrypt and save that decrypted email if it was signed using
+gnuPG because
+lines that begin with a dash get escaped with "- " (see
+<a href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</a>).
+To extract the text in Enigmail without the escape characters,
+first decrypt the email, then save the decrypted message:
+</p>
+
+<source>
+     Enigmail -&gt; Decrypt/verify
+     Enigmail -&gt; Save decrypted message
+</source>
+
+</section>
 
 
-<p><em>Last Updated: March 21, 2005</em></p>
+<p><em>Last Updated: April 1, 2005</em></p>
 </body>
 </document>



Mime
View raw message