Normalize intra-app links, esp fundocs

joewiz · duncdrum · commit 24019d45146c · 2019-07-31T15:04:20.000+02:00
and miscellaneous catches
diff --git a/src/main/xar-resources/data/author-reference/author-reference.xml b/src/main/xar-resources/data/author-reference/author-reference.xml
@@ -589,7 +589,7 @@ but does not because its too simple)</programlisting>
                         <para>A <tag>tag</tag> element surrounds its content with &lt; and &gt; and
                             formats it like code. Meant to make life easier:
                             <code><![CDATA[<tag>xxx</tag>]]></code> is the shorter version of
-                            <code><![CDATA[<code>&lt;xxx&gt;</code>]]></code>.</para>
+                            <code><![CDATA[<code><xxx></code>]]></code>.</para>
                     </listitem>
                 </varlistentry>
 
@@ -649,7 +649,7 @@ but does not because its too simple)</programlisting>
                             use the <tag>link</tag> element. However, use the target's document name
                             (without the <code>.xml</code> extension) as the link address. For
                             instance,
-                            <code><![CDATA[&amp;lt;link xlink:href="documentation"&amp;gt;]]></code>
+                            <tag>link xlink:href="documentation"</tag>
                             links to the <link xlink:href="documentation">documentation home
                             page</link>.</para>
                     </listitem>
diff --git a/src/main/xar-resources/data/beginners-guide-to-xrx-v4/beginners-guide-to-xrx-v4.xml b/src/main/xar-resources/data/beginners-guide-to-xrx-v4/beginners-guide-to-xrx-v4.xml
@@ -101,7 +101,7 @@
             <para>This example will use the following terms and concepts:</para>
             <para> <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 client (web browser), REST is
+                combination of XForms, REST, and XQuery. The term was <link xlink:href="https://web.archive.org/web/20171224124316/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: (1) it
                 does not require users to translate data into Java or .Net objects, and (2) it does
diff --git a/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml b/src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml
@@ -1260,7 +1260,7 @@
                 operates in the <literal>http://exist-db.org/xquery/spatial</literal> namespace
                 (whose default prefix is <literal>spatial</literal>).</para>
             <para>The functions signatures are documented together with the functions themselves in
-                <link xlink:href="https://demo.exist-db.org/xquery/functions.xq">this page</link>.
+                <link xlink:href="{${fundocs.pkg.abbrev}}">the XQuery function documentation</link>.
                 Here we will only look at their <literal>eval()</literal> methods.</para>
             <para>The first functions set we will describe is
                 <literal>org.exist.xquery.modules.spatial.FunSpatialSearch</literal>, which performs
diff --git a/src/main/xar-resources/data/extensions/extensions.xml b/src/main/xar-resources/data/extensions/extensions.xml
@@ -42,7 +42,7 @@
             <para>eXist-db will require a restart to load any new modules added. </para>
         </note>
         <para>Once a Module is configured and loaded eXist-db will display the module and its
-            function definitions as part of the <link xlink:href="{fundocs}">function library</link>
+            function definitions as part of the <link xlink:href="{${fundocs.pkg.abbrev}}">function library</link>
             page or through <literal>util:decribe-function()</literal>.</para>
     </sect1>
 
diff --git a/src/main/xar-resources/data/getting-help/getting-help.xml b/src/main/xar-resources/data/getting-help/getting-help.xml
@@ -34,12 +34,13 @@
       primary forum for asking questions and getting help. Finding the answer to a question can sometimes be as simple as <link xlink:href="https://exist-open.markmail.org/" condition="_blank">searching the mailing list's archives</link>. Whether you have a
       question that you can't find the answer to, or you just want to join the discussion, <link xlink:href="https://lists.sourceforge.net/lists/listinfo/exist-open" condition="_blank">subscribe to the mailing list</link>. It's free and
       you can unsubscribe anytime.</para>
+    <para>You can also search the <link xlink:href="https://stackoverflow.com/questions/tagged/exist-db" condition="_blank">exist-db tag on Stackoverflow</link> for questions and answers.</para>
     <note>
       <para>For reporting issues, please consult the <link xlink:href="getting-help-how-to-report">How to Report Issues</link> article.</para>
     </note>
     <para>Besides exist-open, there is a mailing list dedicated solely to the XQuery language: the <link xlink:href="http://x-query.com/mailman/listinfo/talk">xquery-talk mailing list</link>. It's a great place to ask questions about XQuery, from
       basic to advanced.</para>
-    <para>Also, there are numerous excellent resources for learning XQuery, including the <link xlink:href="http://en.wikibooks.org/wiki/XQuery" condition="_blank">XQuery wikibook</link> and Priscilla Walmsley's <link xlink:href="http://shop.oreilly.com/product/9780596006341.do" condition="_blank">XQuery book</link>.</para>
+    <para>See our list of resources for <link xlink:href="learning-xquery">learning XQuery</link>.</para>
     <para>Follow <link xlink:href="https://twitter.com/#!/existdb" condition="_blank">@existdb</link> on Twitter for news and announcements about
       eXist-db. Use the <link xlink:href="https://twitter.com/#!/search?q=%23existdb" condition="_blank">#existdb</link> hash tag (note: no dash in
       #existdb). </para>
diff --git a/src/main/xar-resources/data/incompatibilities/incompatibilities.xml b/src/main/xar-resources/data/incompatibilities/incompatibilities.xml
@@ -123,7 +123,7 @@
                     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 <link
-                    xlink:href="{fundocs}/view.html?uri=http://www.w3.org/2005/xpath-functions/map&amp;location=java:org.exist.xquery.functions.map.MapModule"
+                    xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://www.w3.org/2005/xpath-functions/map"
                     >available</link>.</para>
             </listitem>
             <listitem>
diff --git a/src/main/xar-resources/data/learning-xquery/learning-xquery.xml b/src/main/xar-resources/data/learning-xquery/learning-xquery.xml
@@ -25,18 +25,18 @@
         <para>XQuery is unique in the development stack: It replaces both SQL and the traditional
             software layers that convert SQL into presentation formats such as HTML, PDF and ePub.
             XQuery can both retrieve information from your database and format it for presentation. </para>
-        <para>Learning how to select basic data from an XML document can be learned in just a few
+        <para>Learning how to select basic data from an XML document can be accomplished in just a few
             hours, especially if you are already familiar with SQL and other functional programming
-            languages. Learning how to create custom XQuery functions, how to design XQuery modules
+            languages. Learning how to create custom XQuery functions, how to design XQuery modules,
             and how to execute unit tests on XQuery takes considerably longer.</para>
 
         <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
-
+        
         <sect2 xml:id="learning-example">
             <title>Learning by Example</title>
 
             <para>Many people find that they learn a new language best by reading and trying small
-                examples of code. One of the ideal locations for this is the <link condition="_blank" xlink:href="http://en.wikibooks.org/wiki/XQuery#Beginning_Examples">XQuery Wikibook
+                examples of code. One of the ideal locations for this is the <link condition="_blank" xlink:href="https://en.wikibooks.org/wiki/XQuery#Beginning_Examples">XQuery Wikibook
                 Beginning Examples</link>. These examples are all designed and tested to work with
                 eXist. Please let us know if there are specific examples you would like to
                 see.</para>
@@ -56,12 +56,12 @@
         <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
 
         <sect2 xml:id="learning-flowr">
-            <title>Learning FLOWR statements</title>
+            <title>Learning FLWOR statements</title>
 
-            <para>Iteration in XQuery uses parallel programming statements called FLOWR (For, Let,
-                Order by, Where, Return). Each loop of a FLOWR statement is performed in a separate
+            <para>Iteration in XQuery uses parallel programming statements called FLWOR (For, Let,
+                Where, Order by, Return). Each loop of a FLWOR statement is performed in a separate
                 thread of execution. As a result you cannot use the output of any computation in a
-                FLOWR loop as input for the next iteration. This concept can be difficult to learn
+                FLWOR loop as input for the next iteration. This concept can be difficult to learn
                 if you have never used parallel programming systems.</para>
         </sect2>
 
@@ -133,6 +133,21 @@
                 in a drop-down list. As you continue to type or select a function the parameters and
                 types are also shown. This becomes an important time-saver!</para>
         </sect2>
+        
+        <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+        
+        <sect2 xml:id="other-resources">
+            <title>Other Resources</title>
+            
+            <para>See Priscilla Walmsley's book, <link
+                xlink:href="http://shop.oreilly.com/product/0636920035589.do" condition="_blank"
+                    >XQuery</link> on the XQuery language, Adam Retter and Erik Siegel's book, <link
+                    xlink:href="http://shop.oreilly.com/product/0636920026525.do"
+                    condition="_blank">eXist: a NoSQL Document Database and Application
+                    Platform</link>, on XQuery application development, and the <link
+                    xlink:href="https://github.com/joewiz/learn-xquery" condition="_blank">Learning
+                    XQuery</link> list.</para>
+        </sect2>
 
     </sect1>
 
diff --git a/src/main/xar-resources/data/scheduler/scheduler.xml b/src/main/xar-resources/data/scheduler/scheduler.xml
@@ -45,7 +45,7 @@
                         </para>
                     </note>
                     <para>There is an XQuery library module, <link condition="_blank"
-                        xlink:href="https://www.exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/scheduler&amp;location=java:org.exist.xquery.modules.scheduler.SchedulerModule&amp;details=true"
+                        xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/scheduler"
                         >Scheduler Module</link>, which provides functions for scheduling jobs and
                         managing jobs scheduled for execution. The scheduler XQuery library module
                         is activated by uncommenting the following in eXist-db's
diff --git a/src/main/xar-resources/data/security/security.xml b/src/main/xar-resources/data/security/security.xml
@@ -21,7 +21,7 @@
         models.</para>
     <para>As well as the mechanisms described in this article, you should also note the presence of
         the <link
-        xlink:href="http://www.exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/securitymanager&amp;location=java:org.exist.xquery.functions.securitymanager.SecurityManagerModule&amp;details=true"
+            xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/securitymanager"
         >Security Manager XQuery library module</link>, which enables you to perform many user and
         security related tasks programmatically from XQuery.</para>
 
@@ -87,7 +87,7 @@
             <listitem>
                 <para>Change the password programmatically, for instance from within eXide, by using
                     the <code>sm:passwd()</code> function of the <link
-                    xlink:href="http://www.exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/securitymanager&amp;location=java:org.exist.xquery.functions.securitymanager.SecurityManagerModule&amp;details=true"
+                        xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/securitymanager"
                     >Security Manager XQuery library module</link>.</para>
             </listitem>
         </itemizedlist>
@@ -137,7 +137,7 @@
             <listitem>
                 <para>Create a user programmatically, for instance from within eXide, by using the
                     <code>sm:create-account()</code> function of the <link
-                    xlink:href="http://www.exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/securitymanager&amp;location=java:org.exist.xquery.functions.securitymanager.SecurityManagerModule&amp;details=true"
+                        xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/securitymanager"
                     >Security Manager XQuery library module</link>.</para>
             </listitem>
         </itemizedlist>
@@ -300,7 +300,7 @@
                     <listitem>
                         <para>Do it programmatically, for instance from within eXide, by using the
                             one of the functions of the <link
-                            xlink:href="http://www.exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/securitymanager&amp;location=java:org.exist.xquery.functions.securitymanager.SecurityManagerModule&amp;details=true"
+                                xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/securitymanager"
                             >Security Manager XQuery library module</link>.</para>
                     </listitem>
                 </itemizedlist>
diff --git a/src/main/xar-resources/data/xmldb/xmldb.xml b/src/main/xar-resources/data/xmldb/xmldb.xml
@@ -4,7 +4,7 @@
 <article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
   <info>
     <title>The xmldb module</title>
-    <date>1Q18</date>
+    <date>2Q19</date>
     <keywordset>
       <keyword>application-development</keyword>
     </keywordset>
@@ -14,7 +14,7 @@
 
   <para>The xmldb module (<literal>http://exist-db.org/xquery/xmldb</literal> function namespace)
     contains functions for manipulating database contents. The full list of functions and their
-    documentation can be found in the <link xlink:href="/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/xmldb&amp;location=java:org.exist.xquery.functions.xmldb.XMLDBModule">Function Documentation Library</link>. This article handles some of the highlights and main
+    documentation can be found in the <link xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/xmldb">Function Documentation Library</link>. This article handles some of the highlights and main
     uses for this module.</para>
 
   <!-- ================================================================== -->
diff --git a/src/main/xar-resources/data/xquery/xquery.xml b/src/main/xar-resources/data/xquery/xquery.xml
@@ -33,7 +33,7 @@
             Operators 3.1"</link>, with the exception of certain <link
             xlink:href="#unsupported-features">unsupported features and functions</link>. For
             complete documentation on functions in eXist-db, see <link condition="_blank"
-            xlink:href="/exist/apps/fundocs">XQuery Function Documentation</link>.</para>
+            xlink:href="{${fundocs.pkg.abbrev}}">XQuery Function Documentation</link>.</para>
         <para>eXist-db's XQuery implementation has been tested against the official <link
             condition="_blank" xlink:href="https://dev.w3.org/2006/xquery-test-suite/">XML Query Test
             Suite (XQTS)</link>. An updated test suite runner to test conformance against the
@@ -74,7 +74,7 @@
                         xlink:href="https://www.w3.org/TR/xquery/#id-conform-optional-features"
                         >optional</link> in the XQuery specification). Instead, eXist-db provides a
                         <link condition="_blank"
-                        xlink:href="/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/validation"
+                        xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/validation"
                         >validation module</link> containing extension functions to perform XML
                         validation.</para>
                 </listitem>
@@ -222,7 +222,7 @@
         <title>Function Library</title>
 
         <para>A complete list of XQuery functions supported by eXist-db can be found in the <link
-            condition="_blank" xlink:href="/exist/apps/fundocs">XQuery Function
+            condition="_blank" xlink:href="{${fundocs.pkg.abbrev}}">XQuery Function
             Documentation</link>. </para>
         <para>Each module's documentation is generated from a different sources, depending on
             whether the module is implemented in Java or XQuery. For modules implemented in Java,
@@ -931,9 +931,9 @@
                 >RESTXQ</link>, an EXQuery community effort to develop a clean approach for the
                 deployment of RESTful services based on XQuery code annotations. This is in addition
                 to eXist-db's native function libraries for performing HTTP <link
-                xlink:href="/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/request"
+                xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/request"
                 >requests</link> and <link
-                xlink:href="/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/response"
+                xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/response"
                 >responses</link>.</para>
         </sect2>
 
@@ -943,7 +943,7 @@
                 Module</link>, an EXPath community specification and module for performing
                 compression. This is in addition to eXist-db's native function libraries for
                 performing <link
-                xlink:href="/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/compression"
+                xlink:href="{${fundocs.pkg.abbrev}}/view.html?uri=http://exist-db.org/xquery/compression"
                 >compression</link>.</para>
         </sect2>
     </sect1>
diff --git a/src/main/xar-resources/templates/page.html b/src/main/xar-resources/templates/page.html
@@ -54,11 +54,10 @@
             <li class="nav-item dropdown" id="documentation">
               <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Documentation</a>
               <div class="dropdown-menu">
-                  <a class="dropdown-item" href="documentation.xml">Documentation</a>
-                  <a class="dropdown-item" href="author-reference.xml">Author Guidelines</a>
-                  <a class="dropdown-item" href="getting-help.xml">Get Support</a>
-                <div class="dropdown-divider"></div>
-                  <a class="dropdown-item" href="{${fundocs.pkg.abbrev}}/index.html">XQuery Functions</a>
+                <a class="dropdown-item" href="documentation">Documentation</a>
+                <a class="dropdown-item" href="{${fundocs.pkg.abbrev}}/index.html">Function Library</a>
+                <a class="dropdown-item" href="https://exist-db.org/exist/apps/wiki/blogs/eXist/">News &amp; Articles</a>
+                <a class="dropdown-item" href="https://en.wikibooks.org/wiki/XQuery">XQuery Wikibook</a>
                 <div class="dropdown-divider"></div>
                   <a class="dropdown-item" href="getting-help.xml">Getting Help</a>
               </div>
