db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kahat...@apache.org
Subject svn commit: r1067138 - in /db/derby/site/trunk: build/site/manuals/dita.html src/documentation/content/xdocs/manuals/dita.xml
Date Fri, 04 Feb 2011 10:38:01 GMT
Author: kahatlen
Date: Fri Feb  4 10:38:01 2011
New Revision: 1067138

URL: http://svn.apache.org/viewvc?rev=1067138&view=rev
Log:
DERBY-4999: Docs build fails under C locale

Update build instructions to reflect that it's now OK to build the
docs even if the default encoding isn't UTF-8.

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?rev=1067138&r1=1067137&r2=1067138&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/dita.html (original)
+++ db/derby/site/trunk/build/site/manuals/dita.html Fri Feb  4 10:38:01 2011
@@ -264,19 +264,11 @@ set the
 <p>For PDF output: Make sure to include the <span class="codefrag">fop.jar</span>,
<span class="codefrag">avalon-framework-cvs-20020806.jar</span>, and <span
class="codefrag">batik.jar</span> files located in <span class="codefrag">%DOC_ROOT%/trunk/lib/</span>
in your <span class="codefrag">CLASSPATH</span> environment variable.</p>
 </li>
 
-<li>
-<p>
-On a UNIX system, make sure that your LANG environment variable is set
-to "en_US.UTF-8" rather than to "C" or "en_US.ISO8859-1". (On Windows,
-UTF-8 seems to be the default.)
-</p>
-</li>
-
 </ol>
 </div>
 
 
-<a name="N100B3"></a><a name="Locating+the+correct+DITA+file"></a>
+<a name="N100AF"></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>
@@ -310,7 +302,7 @@ Guidelines for writing Derby information
 </div> 
 
 
-<a name="N100EE"></a><a name="Editing+DITA+files"></a>
+<a name="N100EA"></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>
@@ -341,7 +333,7 @@ Guidelines for writing Derby information
 </div>
 
 
-<a name="N10126"></a><a name="Creating+output"></a>
+<a name="N10122"></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>
@@ -440,7 +432,7 @@ set up and configured correctly, the bui
 </table>
 </div>
 
-<a name="N101E4"></a><a name="DITA+file+names"></a>
+<a name="N101E0"></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>
@@ -448,7 +440,7 @@ set up and configured correctly, the bui
 </div>
 
 
-<a name="N101F3"></a><a name="Modifying+the+output+format"></a>
+<a name="N101EF"></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>
@@ -464,7 +456,7 @@ Please post feedback to the 
 </p>
 
 
-<a name="N1020C"></a><a name="Submitting+documentation+patches"></a>
+<a name="N10208"></a><a name="Submitting+documentation+patches"></a>
 <h2 class="boxed">Submitting documentation patches</h2>
 <div class="section">
 <p> 
@@ -704,7 +696,7 @@ easier.</li> 
 </div>
 
 
-<a name="N102FF"></a><a name="Committing+documentation+patches"></a>
+<a name="N102FB"></a><a name="Committing+documentation+patches"></a>
 <h2 class="boxed">Committing documentation patches</h2>
 <div class="section">
 <p>You must be a Derby committer to commit Derby patches.</p>

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?rev=1067138&r1=1067137&r2=1067138&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 Feb  4 10:38:01
2011
@@ -72,11 +72,6 @@ set the
 <code>ANT_OPTS</code> environment variable to <code>"-Xms100m -Xmx200m"</code>.
 </li>
 <li><p>For PDF output: Make sure to include the <code>fop.jar</code>,
<code>avalon-framework-cvs-20020806.jar</code>, and <code>batik.jar</code>
files located in <code>%DOC_ROOT%/trunk/lib/</code> in your <code>CLASSPATH</code>
environment variable.</p></li>
-<li><p>
-On a UNIX system, make sure that your LANG environment variable is set
-to "en_US.UTF-8" rather than to "C" or "en_US.ISO8859-1". (On Windows,
-UTF-8 seems to be the default.)
-</p></li>
 </ol>
 </section>
 



Mime
View raw message