Merge pull request #188 from eriksiegel/develop

Documentation refactoring upto 20180103

Author: duncdrum

pom.xml

@@ -81,13 +81,15 @@
                 <filtering>true</filtering>
                 <includes>
                     <include>templates/**</include>
+                    <include>data/**</include>
                 </includes>
             </resource>
             <resource>
                 <directory>src/main/xar-resources</directory>
                 <filtering>false</filtering>
                 <excludes>
                     <exclude>templates/**</exclude>
+                    <exclude>data/**</exclude>
                 </excludes>
             </resource>
         </resources>

src/main/xar-resources/data/author-reference/author-reference.xml

@@ -67,9 +67,7 @@
                         have <link xlink:href="http://exist-db.org">eXist</link>
                         running on your local system. By default eXist runs on
                         port <code>8080</code> so that when you set your web
-                        browser to <link
-                            xlink:href="http://localhost:8080/exist/"
-                            >http://localhost:8080/exist/</link> you should see
+                        browser to <link xlink:href="http://localhost:8080/exist/">http://localhost:8080/exist/</link> you should see
                         the eXist homepage come up.</para>
           <para>You can also run this tutorial on a remote eXist server. If you
                         are doing this, you must replace the server name
@@ -120,9 +118,7 @@
                 <emphasis role="bold">XRX</emphasis> is the name of the web
                 application architecture that we are introducing in this guide.
                 The term XRX comes from the combination of XForms, REST, and
-                XQuery. The term was <link
-                    xlink:href="http://archive.oreilly.com/pub/post/xrx_a_simple_elegant_disruptiv_1.html"
-                    >coined</link> by Dan McCreary. XForms are used in the
+                XQuery. The term was <link xlink:href="http://archive.oreilly.com/pub/post/xrx_a_simple_elegant_disruptiv_1.html">coined</link> by Dan McCreary. XForms are used in the
                 client (web browser), REST is the interface between the client
                 and the server, and XQuery is the server language. Two of the
                 most significant advantages of XRX over other architectures are:
@@ -174,9 +170,7 @@
                 SOAP interface testing tools are required. All you need to test
                 your web services is a web browser. For example, the home page
                 of the test application under the default configuration will be
-                    <link
-                    xlink:href="http://localhost:8080/exist/apps/term/index.html"
-                    >http://localhost:8080/exist/apps/term/index.html</link>.</para>
+                    <link xlink:href="http://localhost:8080/exist/apps/term/index.html">http://localhost:8080/exist/apps/term/index.html</link>.</para>
       <para>Several additional terms and concepts are helpful in understanding the XRX approach:</para>
       <para>
         <emphasis role="bold">WebDAV</emphasis> is a protocol for transferring files, and we use eXist's WebDAV interface to move files to and from
@@ -210,8 +204,7 @@
       <listitem>
         <para>
                     <emphasis role="bold">Apps</emphasis>: XRX applications
-                    should be stored within the <emphasis role="bold"
-                        >/db/apps</emphasis> parent collection. </para>
+                    should be stored within the <emphasis role="bold">/db/apps</emphasis> parent collection. </para>
       </listitem>
       <listitem>
         <para>
@@ -277,9 +270,7 @@
                     has created a specification for application metadata, called
                     EXPath Packaging System. eXist supports and extends this
                     module. This tutorial will not cover this file's structure,
-                    but you can learn more about this by reading <link
-                        xlink:href="https://exist-db.org/exist/apps/doc/repo.xml"
-                    />. </para>
+                    but you can learn more about this by reading <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml"/>. </para>
       </listitem>
     </orderedlist>
     <para>You are always free to change the names of the collection or the
@@ -446,9 +437,7 @@
                 publish-status-code. (By using the repo.xml Deployment
                 Descriptor's "prepare" field, you can automate the installation
                 of this collection.xconf file into the target location; see
-                    <link
-                    xlink:href="https://exist-db.org/exist/apps/doc/repo.xml#D1.4.10"
-                />.)</para>
+                    <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml#D1.4.10"/>.)</para>
     </sect2>
 
     <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -648,9 +637,7 @@
                 The last control is the <tag>xf:select1</tag> control that
                 allows the user to select one value from a list of values. (For
                 a complete discussion of the XForms controls we suggest you use
-                the XForms Wikibook at <link
-                    xlink:href="http://en.wikibooks.org/wiki/XForms"
-                    >http://en.wikibooks.org/wiki/XForms</link>. The Input Form
+                the XForms Wikibook at <link xlink:href="http://en.wikibooks.org/wiki/XForms">http://en.wikibooks.org/wiki/XForms</link>. The Input Form
                 Controls section goes through each of the controls in the XForms
                 specification. In addition to the standard controls there are
                 other controls that can also be integrated directly into XForms,
@@ -778,9 +765,7 @@
                     reduce duplication and then reference these functions in
                     each of your queries. For example, you could put the HTML
                     boilerplate into a style module. You could also explore
-                    eXist's HTML templating module; see <link
-                        xlink:href="https://exist-db.org/exist/apps/doc/templating.xml"
-                    />.</para>
+                    eXist's HTML templating module; see <link xlink:href="https://exist-db.org/exist/apps/doc/templating.xml"/>.</para>
       </listitem>
       <listitem>
         <para>Change the <code>list-items.xq</code> to use HTML tables to view each item.</para>
@@ -832,9 +817,7 @@
       <listitem>
         <para>Modify the collection configuration file for the
                         <code>/db/apps/terms/data</code> collection to enable
-                    versioning when items are updated. See <link
-                        xlink:href="https://exist-db.org/exist/apps/doc/versioning.xml"
-                    />.</para>
+                    versioning when items are updated. See <link xlink:href="https://exist-db.org/exist/apps/doc/versioning.xml"/>.</para>
       </listitem>
     </orderedlist>
   </sect1>

src/main/xar-resources/data/beginners-guide-to-xrx-v4/beginners-guide-to-xrx-v4.xml

@@ -1,6 +1,6 @@
 <term>
-    <id></id>
-    <term-name></term-name>
-    <definition></definition>
-    <publish-status-code></publish-status-code>
+    <id/>
+    <term-name/>
+    <definition/>
+    <publish-status-code/>
 </term>

src/main/xar-resources/data/beginners-guide-to-xrx-v4/listings/listing-13.xml

@@ -6,8 +6,8 @@
         <h2>Search Terms</h2>
         <form method="GET" action="search.xq">
             <label for="q">Search:</label>
-            <input type="text" value="" id="q" name="q" size="30" />
-            <input type="submit" value="Search" />
+            <input type="text" value="" id="q" name="q" size="30"/>
+            <input type="submit" value="Search"/>
         </form>
     </body>
 </html>

src/main/xar-resources/data/beginners-guide-to-xrx-v4/listings/listing-9.xml

@@ -1,3 +1,3 @@
 content:get-metadata($binary as xs:base64Binary) as document-node()
 content:get-metadata-and-content($binary as xs:base64Binary) as document-node()
-content:stream-content($binary as xs:base64Binary, $paths as xs:string*, $callback as function, $namespaces as element()?, $userData as item()*) as empty-sequence()
+content:stream-content($binary as xs:base64Binary, $paths as xs:string*, $callback as function, $namespaces as element()?, $userData as item()*) as empty-sequence()

src/main/xar-resources/data/contentextraction/listings/listing-3.txt

@@ -64,7 +64,7 @@
         </section>
         <section id="all-documentation">
             <title>All Documentation</title>
-            <para>Besides these articles, you can search eXist-db's XQuery <ulink url="{fundocs}/index.html">function module library</ulink>.</para>
+            <para>Besides these articles, you can search eXist-db's XQuery <ulink url="{${fundocs.pkg.abbrev}}/index.html">function module library</ulink>.</para>
             <section id="getting-started">
                 <title>Getting Started</title>
                 <table class="documentation">

src/main/xar-resources/data/db4-versions/documentation-db4.xml

@@ -69,7 +69,7 @@
             <para>eXist-db must also be told which modules to load, this is done in
         <filename>conf.xml</filename> and the Class name and Namespace for each module is listed
       below. Note – eXist-db will require a restart to load any new modules added. Once a Module is configured
-      and loaded eXist-db will display the module and its function definitions as part of the <ulink url="{fundocs}">function library</ulink> page or through
+      and loaded eXist-db will display the module and its function definitions as part of the <ulink url="{${fundocs.pkg.abbrev}}">function library</ulink> page or through
         <command>util:decribe-function()</command>.</para>
         </section>
         <section id="module_example">

src/main/xar-resources/data/db4-versions/extensions-db4.xml

@@ -40,7 +40,7 @@
             <para>The XQuery engine has been updated to support the changed syntax for <emphasis>maps in XQuery 3.1</emphasis>. The query parser will still accept the
                 old syntax for map constructors though (<code>map { x:= "y"}</code> instead of <code>map { x: "y" }</code> in XQuery 3.1), so old
                 code should run without modifications. All map module functions from XQuery 3.1 are 
-                <ulink url="{fundocs}/view.html?uri=http://www.w3.org/2005/xpath-functions/map&amp;location=java:org.exist.xquery.functions.map.MapModule">available</ulink>.</para>
+                <ulink url="{${fundocs.pkg.abbrev}}/view.html?uri=http://www.w3.org/2005/xpath-functions/map&amp;location=java:org.exist.xquery.functions.map.MapModule">available</ulink>.</para>
             <para>The signatures for some <emphasis>higher-order utility functions</emphasis> like fn:filter, fn:fold-left and fn:fold-right have changed as well. Please review your
                 use of those functions. Also, fn:map is now called fn:for-each, though the old name is still accepted.</para>
             <para>The bundled Lucene has been upgraded from 3.6.1

src/main/xar-resources/data/db4-versions/incompatibilities-db4.xml

@@ -142,7 +142,7 @@
                     <listitem>
                         <para>Jing</para>
                     </listitem>
-                </itemizedlist>Each of these options are discussed in the following sections. Consult the <ulink url="{fundocs}/view.html?uri=http://exist-db.org/xquery/validation">XQuery Function Documentation</ulink> for detailed functions
+                </itemizedlist>Each of these options are discussed in the following sections. Consult the <ulink url="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/validation">XQuery Function Documentation</ulink> for detailed functions
                 descriptions.</para>
             <section>
                 <title>JAXP</title>

src/main/xar-resources/data/db4-versions/validation-db4.xml

@@ -130,7 +130,7 @@
                             currently not support the <ulink url="http://www.w3.org/TR/xquery/#id-schema-import-feature">schema import</ulink> and 
                             <ulink url="http://www.w3.org/TR/xquery/#id-schema-validation-feature">schema validation features</ulink>
                             defined as <ulink url="http://www.w3.org/TR/xquery/#id-conform-optional-features">optional</ulink> 
-                            in the XQuery specification. eXist-db provides <ulink url="{fundocs}/view.html?uri=http://exist-db.org/xquery/validation&amp;location=java:org.exist.xquery.functions.validation.ValidationModule">extension functions</ulink> 
+                            in the XQuery specification. eXist-db provides <ulink url="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/validation&amp;location=java:org.exist.xquery.functions.validation.ValidationModule">extension functions</ulink> 
                             to perform XML validation. The database does not
                             store type information along with the nodes. It therefore cannot know
                             the typed value of a node and has to assume