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 bp...@apache.org on 2009/12/31 20:10:25 UTC
svn commit: r894926 - in /db/derby/docs/trunk/src/tools: ctools1004764.dita
derbytools.ditamap rtoolsijlocale.dita
Author: bpendleton
Date: Thu Dec 31 19:10:25 2009
New Revision: 894926
URL: http://svn.apache.org/viewvc?rev=894926&view=rev
Log:
DERBY-4482: derby.ui.locale property not documented
This change adds documentation to the Derby Tools Guide for the derby.ui.locale
property, which can be used to specify the session locale when running one
of the Derby tools (such as ij or dblook). The documentation is patterned
after the similar derby.ui.codeset property. Some high-level information
and a pointer to the new page is added to the About locales page in the
Tools Guide.
Added:
db/derby/docs/trunk/src/tools/rtoolsijlocale.dita (with props)
Modified:
db/derby/docs/trunk/src/tools/ctools1004764.dita
db/derby/docs/trunk/src/tools/derbytools.ditamap
Modified: db/derby/docs/trunk/src/tools/ctools1004764.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctools1004764.dita?rev=894926&r1=894925&r2=894926&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctools1004764.dita (original)
+++ db/derby/docs/trunk/src/tools/ctools1004764.dita Thu Dec 31 19:10:25 2009
@@ -34,9 +34,14 @@
<p>This is the territory associated
with your database when it is created. By default, this is the same as the <xref href="ctools1004764.dita#ctools1004764/rtoolsijtools91283">java system locale</xref>. The database territory determines
the language of database errors.</p></li>
-<li><i id="rtoolsijtools74061"><codeph>ij</codeph> or <codeph>dblook</codeph> Session locale</i>
-<p>This locale is associated
-with your <codeph>ij</codeph> or <codeph>dblook</codeph> session. This locale determines
-the localized display format for numbers, dates, times, and timestamps. </p></li>
+<li><i id="rtoolsijtools74061">Tools Session locale</i>
+ <p>This locale is associated with your session,
+ when using <ph conref="../conrefs.dita#prod/productshortname"></ph>
+ tools such as <codeph>ij</codeph> or <codeph>dblook</codeph>.
+ This locale determines the language of messages, as well as
+the localized display format for numbers, dates, times, and timestamps.
+You can use the
+<codeph><xref href="rtoolsijlocale.dita#rtoolsijlocale">derby.ui.locale</xref></codeph>
+property to specify the session locale that should be used.</p></li>
</ul></p>
</conbody></concept>
Modified: db/derby/docs/trunk/src/tools/derbytools.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/derbytools.ditamap?rev=894926&r1=894925&r2=894926&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/derbytools.ditamap (original)
+++ db/derby/docs/trunk/src/tools/derbytools.ditamap Thu Dec 31 19:10:25 2009
@@ -231,6 +231,8 @@
<topicref href="rtoolsijproprefuser.dita" navtitle="ij.user property"></topicref>
<topicref href="rtoolsijpropref97949.dita" navtitle="derby.ui.codeset property">
</topicref>
+<topicref href="rtoolsijlocale.dita" navtitle="derby.ui.locale property">
+</topicref>
</topicref>
<topicref collection-type="family" href="rtoolsijcomref25570.dita" navtitle="ij commands and errors reference">
<topicref href="ctoolsijcomref23268.dita" navtitle="ij commands">
Added: db/derby/docs/trunk/src/tools/rtoolsijlocale.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijlocale.dita?rev=894926&view=auto
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijlocale.dita (added)
+++ db/derby/docs/trunk/src/tools/rtoolsijlocale.dita Thu Dec 31 19:10:25 2009
@@ -0,0 +1,121 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rtoolsijlocale" xml:lang="en-us">
+<title>derby.ui.locale property</title>
+<prolog><metadata>
+<keywords><indexterm>derby.ui.locale (tool property)</indexterm><indexterm>Internationalization
+features<indexterm>locale</indexterm></indexterm></keywords>
+</metadata></prolog>
+<refbody>
+ <section><title>Function</title>
+ <p>Set this property to a supported locale name when using one of the
+ <ph conref="../conrefs.dita#prod/productshortname"></ph> tools,
+ if you want another locale than the system default locale.
+ The locale determines the localized display format for numbers,
+ dates, times and timestamps, as well as the language of the
+ messages from the
+ <ph conref="../conrefs.dita#prod/productshortname"></ph> tools.
+ Note that some pages in the
+ <ph conref="../conrefs.dita#prod/productshortname"></ph>
+ documentation guides refer to a "locale" as a "territory".
+</p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>derby.ui.locale=<b><i>derbyval</i></b></b></codeblock> <p>where <i>derbyval</i> is
+ a supported locale name, in the form <i>ll_CC</i>, where <i>ll</i>
+ is the two-letter language code, and <i>CC</i> is the two-letter
+ country code; for example, ja_JP.</p> </refsyn>
+<example><title>Example</title> <p>The following command specifies to run <codeph>ij</codeph> using
+the Japanese territory (<i>derby.ui.locale=ja_JP</i>) using Japanese Latin
+Kanji mixed encoding (<i>codeset=Cp939</i>): </p>
+<codeblock><b>java -Dderby.ui.locale=ja_JP -Dderby.ui.codeset=Cp939
+ -Dij.protocol=jdbc:derby:
+ org.apache.derby.tools.ij</b></codeblock>
+<p>Language codes consist of a pair of lowercase letters that
+ conform to ISO-639.
+ <table frame="all">
+<title>Sample Language Codes</title>
+<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="50*"/>
+<colspec colname="2" colnum="2" colwidth="50*"/>
+<thead>
+<row>
+<entry align="left" colname="1" valign="bottom">Language Code </entry>
+<entry align="left" colname="2" valign="bottom">Description </entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">de</entry>
+<entry colname="2">German </entry>
+</row>
+<row>
+<entry colname="1">en</entry>
+<entry colname="2">English </entry>
+</row>
+<row>
+<entry colname="1">es</entry>
+<entry colname="2">Spanish </entry>
+</row>
+<row>
+<entry colname="1">ja</entry>
+<entry colname="2">Japanese </entry>
+</row>
+</tbody>
+</tgroup>
+</table></p> <p>To see a full list of ISO-639 codes, go to <xref format="html"
+href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt" scope="external"><i>http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</i></xref
+>.</p>
+<p>Country codes consist of two uppercase letters that conform to ISO-3166.
+ <table frame="all"><title>Sample Country Codes</title>
+<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="50*"/>
+<colspec colname="2" colnum="2" colwidth="50*"/>
+<thead>
+<row>
+<entry align="left" colname="1" valign="bottom">Country Code</entry>
+<entry align="left" colname="2" valign="bottom">Description </entry>
+</row>
+</thead>
+<tbody>
+<row>
+<entry colname="1">DE</entry>
+<entry colname="2">Germany </entry>
+</row>
+<row>
+<entry colname="1">US</entry>
+<entry colname="2">United States </entry>
+</row>
+<row>
+<entry colname="1">ES</entry>
+<entry colname="2">Spain</entry>
+</row>
+<row>
+<entry colname="1">MX</entry>
+<entry colname="2">Mexico</entry>
+</row>
+<row>
+<entry colname="1">JP</entry>
+<entry colname="2">Japan </entry>
+</row>
+</tbody>
+</tgroup>
+</table></p> <p>A copy of ISO-3166 can be found at <xref format="html" href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html"
+scope="external"><i>http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</i></xref>.</p>
+</example>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/tools/rtoolsijlocale.dita
------------------------------------------------------------------------------
svn:eol-style = native