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/12/05 00:24:14 UTC
svn commit: r482408 - in /db/derby/site/trunk: build/site/manuals/dita.html
src/documentation/content/xdocs/manuals/dita.xml
Author: jta
Date: Mon Dec 4 15:24:12 2006
New Revision: 482408
URL: http://svn.apache.org/viewvc?view=rev&rev=482408
Log:
Web site DITA instructions: Improved commit instructions based on feedback
from Laura Stewart, Andrew McIntyre, Yip Ng, and Myrna van Lunteren.
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=482408&r1=482407&r2=482408
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Mon Dec 4 15:24:12 2006
@@ -152,7 +152,10 @@
<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 https://svn.apache.org/repos/asf/db/derby/docs/trunk/</pre>
+<pre class="code">
+<a class="external" href="http://svnbook.red-bean.com/en/1.1/re04.html">svn checkout</a> https://svn.apache.org/repos/asf/db/derby/docs/trunk/</pre>
+Note that the <span class="codefrag">https</span> is required (not <span class="codefrag">http</span>) if you will
+be committing changes.
</li>
<li>
@@ -163,9 +166,20 @@
<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:
+<li> Set up your subversion configuration file according to
+ the <a class="external" href="http://www.apache.org/dev/version-control.html#https-svn">ASF
+ instructions</a>.
+ Apache provides an
+ <a class="external" href="http://www.apache.org/dev/svn-eol-style.txt">initial
+ configuration file</a> file that sets properties, such as
+ line endings, for various file types
+ (more information is in the
+ <a class="external" href="http://svnbook.red-bean.com/en/1.1/ch07.html">subversion
+ documentation</a>).
+ Add these DITA file types to your configuration file:
<pre class="code">*.dita = svn:eol-style=native
-*.ditamap = svn:eol-style=native</pre>
+*.ditamap = svn:eol-style=native
+*.out = svn:eol-style=native</pre>
</li>
@@ -199,7 +213,7 @@
</div>
-<a name="N1009C"></a><a name="Locating+the+correct+DITA+file"></a>
+<a name="N100AE"></a><a name="Locating+the+correct+DITA+file"></a>
<h2 class="boxed">Locating the correct DITA file</h2>
<div class="section">
<p>The simpliest way to determine the name of the file that contains the information that you want to update is to:</p>
@@ -233,7 +247,7 @@
</div>
-<a name="N100D7"></a><a name="Editing+DITA+files"></a>
+<a name="N100E9"></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>
@@ -264,7 +278,7 @@
</div>
-<a name="N1010F"></a><a name="Creating+output"></a>
+<a name="N10121"></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>
@@ -350,7 +364,7 @@
</table>
</div>
-<a name="N101CC"></a><a name="DITA+file+names"></a>
+<a name="N101DE"></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>
@@ -358,7 +372,7 @@
</div>
-<a name="N101DB"></a><a name="Modifying+the+output+format"></a>
+<a name="N101ED"></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>
@@ -377,7 +391,7 @@
-<a name="N101F8"></a><a name="Submitting+documentation+patches"></a>
+<a name="N1020A"></a><a name="Submitting+documentation+patches"></a>
<h2 class="boxed">Submitting documentation patches</h2>
<div class="section">
<p>
@@ -550,7 +564,7 @@
</div>
-<a name="N102A1"></a><a name="Committing+documentation+patches"></a>
+<a name="N102B3"></a><a name="Committing+documentation+patches"></a>
<h2 class="boxed">Committing documentation patches</h2>
<div class="section">
<ol>
@@ -562,10 +576,11 @@
<ul>
<li>Don't forget to update your
- <a class="external" href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a>
- file with these entries:
+ <a class="external" href="http://www.apache.org/dev/version-control.html#https-svn">subversion
+ configuration file</a> with these entries:
<pre class="code">*.dita = svn:eol-style=native
-*.ditamap = svn:eol-style=native</pre>
+*.ditamap = svn:eol-style=native
+*.out = svn:eol-style=native</pre>
</li>
@@ -579,29 +594,17 @@
level, so download the patch to the trunk of your working copy.
</li>
-<li> If your machine is a different architecture from the machine on which
- the patch was created, convert the file:
- <ul>
-
-<li>
-<span class="codefrag">dos2unix</span> converts the file from Windows format to
- UNIX.</li>
-
-<li>
-<span class="codefrag">unix2dos</span> converts the file from UNIX format to
- Windows.</li>
-
-</ul>
-
-</li>
-
-<li>Apply the patch:
-<pre class="code">patch -p0 < patch.diff</pre>
+<li>Apply the patch using the GNU
+ <a class="external" href="http://en.wikipedia.org/wiki/Patch_(Unix)"><span class="codefrag">patch</span></a>
+ command:
+<pre class="code">
+<a class="external" href="http://linux.about.com/od/commands/l/blcmdl1_patch.htm">patch -p0</a> < patch.diff</pre>
</li>
-<li>Check modifications with '<span class="codefrag">svn status</span>' and
- add any files that need it:
+<li>Check modifications with the
+ <a class="external" href="http://svnbook.red-bean.com/en/1.1/re26.html"><span class="codefrag">svn status</span></a>
+ command and add any files that need it:
<pre class="code">svn add <em>filename</em>
</pre>
@@ -612,14 +615,42 @@
to verify the doc build succeeds.
</li>
-<li>Commit the changes. </li>
+<li>Commit the changes using the
+ <a class="external" href="http://svnbook.red-bean.com/en/1.1/re06.html"><span class="codefrag">svn
+ commit</span></a> command. Sample commit syntax is shown below for
+ changes made to the Developer's guide:
+<pre class="code">svn commit src/devguide
+svn commit --message "DERBY-1622: Add documentation for encrypting databases using encryptionKey connection attribute." src/devguide
+svn commit --file /tmp/derby-1622.txt src/devguide
+</pre>
+ The first command, without the
+ <span class="codefrag">--message</span> or <span class="codefrag">--file</span> arguments,
+ will pull up the editor defined by the
+ <a class="external" href="http://svnbook.red-bean.com/en/1.1/ch07.html">subversion
+ <span class="codefrag">editor-cmd</span> property or the
+ <span class="codefrag">SVN_EDITOR</span> environment variable</a>.
+ The <span class="codefrag">--message</span> argument lets you enter the log message on
+ the command line, and the
+ <span class="codefrag">--file</span> argument lets you set the log message from a file.
+ Please include the following information in the log message:
+ <ul>
+
+<li>DERBY Jira issue.</li>
+
+<li>Description of the change.</li>
+
+<li>Name of the patch contributor if you didn't author this change.</li>
+
+</ul>
+
+</li>
</ol>
</div>
<p>
-<em>Last Updated: October 27, 2006</em>
+<em>Last Updated: December 4, 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=482408&r1=482407&r2=482408
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/dita.xml Mon Dec 4 15:24:12 2006
@@ -37,12 +37,26 @@
<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.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>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><a href="http://svnbook.red-bean.com/en/1.1/re04.html">svn checkout</a> https://svn.apache.org/repos/asf/db/derby/docs/trunk/</source>
+Note that the <code>https</code> is required (not <code>http</code>) if you will
+be committing changes.
+</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:
+<li> Set up your subversion configuration file according to
+ the <a href="http://www.apache.org/dev/version-control.html#https-svn">ASF
+ instructions</a>.
+ Apache provides an
+ <a href="http://www.apache.org/dev/svn-eol-style.txt">initial
+ configuration file</a> file that sets properties, such as
+ line endings, for various file types
+ (more information is in the
+ <a href="http://svnbook.red-bean.com/en/1.1/ch07.html">subversion
+ documentation</a>).
+ Add these DITA file types to your configuration file:
<source>*.dita = svn:eol-style=native
-*.ditamap = svn:eol-style=native</source>
+*.ditamap = svn:eol-style=native
+*.out = svn:eol-style=native</source>
</li>
</ul>
@@ -306,10 +320,11 @@
section.
<ul>
<li>Don't forget to update your
- <a href="http://www.apache.org/dev/svn-eol-style.txt">~/.subversion/config</a>
- file with these entries:
+ <a href="http://www.apache.org/dev/version-control.html#https-svn">subversion
+ configuration file</a> with these entries:
<source>*.dita = svn:eol-style=native
-*.ditamap = svn:eol-style=native</source>
+*.ditamap = svn:eol-style=native
+*.out = svn:eol-style=native</source>
</li>
</ul>
</li>
@@ -318,31 +333,48 @@
patches</a> tell contributors to create patches at the trunk
level, so download the patch to the trunk of your working copy.
</li>
- <li> If your machine is a different architecture from the machine on which
- the patch was created, convert the file:
- <ul>
- <li> <code>dos2unix</code> converts the file from Windows format to
- UNIX.</li>
- <li> <code>unix2dos</code> converts the file from UNIX format to
- Windows.</li>
- </ul>
- </li>
- <li>Apply the patch:
-<source>patch -p0 < patch.diff</source>
+ <li>Apply the patch using the GNU
+ <a href="http://en.wikipedia.org/wiki/Patch_(Unix)"><code>patch</code></a>
+ command:
+<source><a href="http://linux.about.com/od/commands/l/blcmdl1_patch.htm">patch -p0</a> < patch.diff</source>
</li>
- <li>Check modifications with '<code>svn status</code>' and
- add any files that need it:
+ <li>Check modifications with the
+ <a href="http://svnbook.red-bean.com/en/1.1/re26.html"><code>svn status</code></a>
+ command and add any files that need it:
<source>svn add <em>filename</em></source>
</li>
<li>Follow the instructions in the
<a href="#Creating+output">Creating output</a> section
to verify the doc build succeeds.
</li>
- <li>Commit the changes. </li>
+ <li>Commit the changes using the
+ <a href="http://svnbook.red-bean.com/en/1.1/re06.html"><code>svn
+ commit</code></a> command. Sample commit syntax is shown below for
+ changes made to the Developer's guide:
+<source>svn commit src/devguide
+svn commit --message "DERBY-1622: Add documentation for encrypting databases using encryptionKey connection attribute." src/devguide
+svn commit --file /tmp/derby-1622.txt src/devguide
+</source>
+ The first command, without the
+ <code>--message</code> or <code>--file</code> arguments,
+ will pull up the editor defined by the
+ <a href="http://svnbook.red-bean.com/en/1.1/ch07.html">subversion
+ <code>editor-cmd</code> property or the
+ <code>SVN_EDITOR</code> environment variable</a>.
+ The <code>--message</code> argument lets you enter the log message on
+ the command line, and the
+ <code>--file</code> argument lets you set the log message from a file.
+ Please include the following information in the log message:
+ <ul>
+ <li>DERBY Jira issue.</li>
+ <li>Description of the change.</li>
+ <li>Name of the patch contributor if you didn't author this change.</li>
+ </ul>
+ </li>
</ol>
</section>
-<p><em>Last Updated: October 27, 2006</em></p>
+<p><em>Last Updated: December 4, 2006</em></p>
</body>
</document>