Merge pull request #133 from ljo/master

Some outstanding documentation changes

Author: dizzzz

data/ant-tasks.xml

@@ -268,7 +268,7 @@
                 <varlistentry>
                     <term>collection</term>
                     <listitem>
-                        <para>The name of the subcollection which should be created.</para>
+                        <para>The name of the sub-collection which should be created.</para>
                     </listitem>
                 </varlistentry>
                 <varlistentry>
@@ -591,7 +591,7 @@
                     </listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term>subcollections</term>
+                    <term>sub-collections</term>
                     <listitem>
                         <para>If "true" all sub-collections of the specified collection
                       are extracted as well

data/atompub.xml

@@ -251,7 +251,7 @@ Location: http://example.org/edit/first-post.atom
       /atom/query/ and is run against the collection's feed document. This
       module is how both the Introspect and Topic modules are implemented. For
       example, if you want to generate a feed of all the feeds in all
-      subcollections, the following query could be sent:</para>
+      sub-collections, the following query could be sent:</para>
             <example>
                 <title>A Feed Query</title>
                 <programlisting>

data/devguide_log4j.xml

@@ -4,7 +4,7 @@
         <productname>eXist-db – Open Source Native XML Database</productname>
         <title>Developer's Guide - Log4J</title>
         <subject>Log4J Logging Guide</subject>
-        <date>November 2009</date>
+        <date>October 2016</date>
         <author>
             <firstname>Loren</firstname>
             <surname>Cahlander</surname>
@@ -698,4 +698,4 @@ logger.info( someObj );
                 intended setting) is small.</para>
         </section>
     </chapter>
-</book>
+</book>

data/devguide_xmlrpc.xml

@@ -972,7 +972,7 @@ sub process {
                             <varlistentry>
                                 <term>inclusive</term>
                                 <listitem>
-                                    <para>If set to <option>true</option>, the subcollections of the
+                                    <para>If set to <option>true</option>, the sub-collections of the
                                         specified collection will be included into the
                                     result.</para>
                                 </listitem>
@@ -1019,7 +1019,7 @@ sub process {
                             <varlistentry>
                                 <term>inclusive</term>
                                 <listitem>
-                                    <para>If set to<option>true</option>, subcollections of the
+                                    <para>If set to<option>true</option>, sub-collections of the
                                         specified collection will be included into the
                                     result.</para>
                                 </listitem>

data/indexing.xml

@@ -118,13 +118,13 @@
                 define the default global <emphasis>index creation policy</emphasis>.</para>
             <para> To configure a given collection - e.g. <filename>/db/foo</filename> - create a
                 file <filename>collection.xconf</filename> and store it as <filename>/db/system/config/db/foo/collection.xconf</filename>. Note the replication of
-                the <filename>/db/foo</filename> hierarchy inside <filename>/db/system/config/</filename>. Subcollections which do not have a <filename>collection.xconf</filename> file of their own will be governed by the
+                the <filename>/db/foo</filename> hierarchy inside <filename>/db/system/config/</filename>. Sub-collections which do not have a <filename>collection.xconf</filename> file of their own will be governed by the
                 configuration policy specified for the closest ancestor collection which does have
                 such a file, so you are not required to specify a configuration for every
                 collection. Note, however, that configuration settings do not cascade. If you choose
-                to deploy a <filename>collection.xconf</filename> file in a subcollection, you must
+                to deploy a <filename>collection.xconf</filename> file in a sub-collection, you must
                 specify in that file <emphasis>all</emphasis> the configuration options you wish to
-                have applied to that subcollection (and any lower-level subcollections without
+                have applied to that sub-collection (and any lower-level sub-collections without
                     <filename>collection.xconf</filename> files of their own). </para>
             <note>
                 <para>Due to backward compatibility concerns, the file does not have to be called

data/triggers.xml

@@ -164,7 +164,7 @@
             <para>To configure triggers for a given collection - for example:
                 <filename>/db/foo</filename> - create a new collection configuration file and store it in the system collection (i.e.:
                     <filename>/db/system/config/db/foo/collection.xconf</filename>). Note that
-                since subcollections will inherit the configuration policy of their parent
+                since sub-collections will inherit the configuration policy of their parent
                 collections, you are not required to specify a configuration for every collection.</para>
             <section>
                 <title>Configuration Structure and Syntax</title>

data/xacml-usage.xml

@@ -34,7 +34,7 @@
 				in the future, more indices might be defined in order to more efficiently restrict
 				the possible policies applicable to a request. This information may be important if
 				an administrator executes a query on the root or system collection that includes all
-				subcollections. </para>
+				sub-collections. </para>
             <para>By default, access control through XACML is disabled. To enable it, add
 				<synopsis>&lt;xacml enable="yes"/&gt;</synopsis> to
 				conf.xml. When XACML is enabled and no policies exist, it loads default policies.

data/xmldb.xml

@@ -116,8 +116,8 @@ return
                     <listitem>
                         <para>The <command moreinfo="none">collection()</command> function specifies
                             the collection of documents to be included in the query evaluation. By
-                            default, documents found in subcollections of the specified collection
-                            are also included. For example, suppose we have a collection <filename moreinfo="none">/db/test</filename> that includes two subcollections
+                            default, documents found in sub-collections of the specified collection
+                            are also included. For example, suppose we have a collection <filename moreinfo="none">/db/test</filename> that includes two sub-collections
                                 <filename moreinfo="none">/db/test/abc</filename> and <filename moreinfo="none">/db/test/def</filename>. In this case, the function
                             call <command moreinfo="none">collection('/db/test')</command> will
                             include all of the resources found in <filename moreinfo="none">/db/test</filename>, <filename moreinfo="none">/db/test/abc</filename> and <filename moreinfo="none">/db/test/def</filename>.</para>

data/xquery.xml

@@ -4,7 +4,7 @@
     <bookinfo>
         <productname>eXist-db – Open Source Native XML Database</productname>
         <title>XQuery in eXist-db</title>
-        <date>October 2012</date>
+        <date>September 2017</date>
         <orgname>The eXist-db Project</orgname>
     </bookinfo>
     <chapter>
@@ -730,6 +730,11 @@ return $w</synopsis>
 "Bäuerin" &lt; "Bier"</synopsis>
             <para>Which returns <option>true</option>. Note that if you use the default codepoint
                 collation instead, the comparison would evaluate to <option>false</option>.</para>
+	<para>You can also use java class specified collators. They should be subclassing <option>java.text.RuleBasedCollator</option>. It will be used like this:</para>
+        <synopsis language="xquery">for $w in ("das", "daß", "Buch", "Bücher", "Bauer", "Bäuerin", "Jagen", "Jäger") 
+order by $w collation "java:f.c.d.n.MyRuleBasedGermanCollator" 
+return $w</synopsis>
+        <para>The jar with the .class file(s) of the collator needs to be in <filename>${EXIST_HOME}/lib/user</filename></para>
             <note>
                 <para>eXist-db's range index is currently only usable with the default codepoint
                     collation. This means that comparisons using a different collation will not be
@@ -1028,4 +1033,4 @@ declare option output:media-type "application/json";</synopsis>
                 testing/debugging.</para>
         </section>
     </chapter>
-</book>
+</book>