Merge pull request #278 from eXist-db/style-fixes

duncdrum · web-flow · commit 0e9a1c33fd67 · 2018-11-19T12:14:37.000+01:00
Style fixes
diff --git a/src/main/xar-resources/data/lucene/listings/listing-10.txt b/src/main/xar-resources/data/lucene/listings/listing-10.txt
@@ -0,0 +1 @@
+<p>He loves <placeName>Paris</placeName>.</p>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-15.txt b/src/main/xar-resources/data/lucene/listings/listing-15.txt
@@ -0,0 +1 @@
+<text match="//SPEECH/*"/>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-16.txt b/src/main/xar-resources/data/lucene/listings/listing-16.txt
@@ -0,0 +1 @@
+<size><width>12</width><height>8</height></size>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-17.txt b/src/main/xar-resources/data/lucene/listings/listing-17.txt
@@ -0,0 +1 @@
+<p>This is <b>un</b>clear.</p>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-18.txt b/src/main/xar-resources/data/lucene/listings/listing-18.txt
@@ -0,0 +1 @@
+<inline qname="b"/>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-21.txt b/src/main/xar-resources/data/lucene/listings/listing-21.txt
@@ -0,0 +1 @@
+<ignore qname="note"/>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-26.txt b/src/main/xar-resources/data/lucene/listings/listing-26.txt
@@ -1,2 +1,3 @@
 for $sect in /book//section[ft:query(., "ngram")] | /book//section[ft:query(title, "ngram")]
-		order by ft:score($sect) descending return $sect
+order by ft:score($sect) descending 
+return $sect
diff --git a/src/main/xar-resources/data/lucene/listings/listing-27.xml b/src/main/xar-resources/data/lucene/listings/listing-27.xml
@@ -1,3 +1,3 @@
 <text qname="@val">
-		       <match-sibling-attr qname="att" value="writtenForm" boost="25"/>
-		  </text>
+    <match-sibling-attr boost="25" qname="att" value="writtenForm"/>
+</text>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-28.xml b/src/main/xar-resources/data/lucene/listings/listing-28.xml
@@ -1,3 +1,3 @@
 <text qname="feat">
-		       <has-attr qname="xml:lang" boost="0"/>
-		       </text>
+    <has-attr boost="0" qname="xml:lang"/>
+</text>
diff --git a/src/main/xar-resources/data/lucene/listings/listing-33.txt b/src/main/xar-resources/data/lucene/listings/listing-33.txt
@@ -0,0 +1 @@
+<text field="title" qname="title" analyzer="en"/>
diff --git a/src/main/xar-resources/data/lucene/lucene.xml b/src/main/xar-resources/data/lucene/lucene.xml
@@ -74,8 +74,8 @@
         (<code>match="..."</code>, see below). </para>
 
     <para>It is important make sure to <emphasis>choose the right context</emphasis> for an index, which has to be the same as in your query. To
-      better understand this, let's have a look at how the index creation is handled by eXist-db and Lucene. For example:</para>
-    <programlisting language="xml">&lt;text qname="SPEECH"/&gt;</programlisting>
+      better understand this, let's have a look at how the index creation is handled by eXist-db and Lucene. For example:
+      <tag>text qname="SPEECH"</tag></para>
     <para>This creates an index on <tag>SPEECH</tag> only. What is passed to Lucene is the string value of <tag>SPEECH</tag>, which also includes the
       text of all its descendant text nodes (<emphasis>except</emphasis> those filtered out by an optional <tag>ignore</tag>). </para>
     <para>Consider the fragment:</para>
@@ -99,7 +99,7 @@
 
     <para>Let's use a different example to illustrate this. Assume you have a document with encoded place names:</para>
 
-    <programlisting language="xml">&lt;p&gt;He loves &lt;placeName&gt;Paris&lt;/placeName&gt;.&lt;/p&gt;</programlisting>
+    <programlisting language="xml" xlink:href="listings/listing-10.txt"/>
     <para>For a general query you probably want to search through all paragraphs. However, you may also want to provide an advanced search option,
       which allows the user to restrict his/her queries to place names. To make this possible, simply define an index on <tag>placeName</tag>
       <emphasis>as well</emphasis>:</para>
@@ -120,10 +120,16 @@
         element:</para>
       <programlisting language="xml" xlink:href="listings/listing-14.txt"/>
       <para>As a shortcut, you can use a <literal>match</literal> attribute with a wildcard:</para>
-      <programlisting language="xml">&lt;text match="//SPEECH/*"/&gt;</programlisting>
+      <programlisting language="xml" xlink:href="listings/listing-15.txt"/>
       <para>This will create a separate index on each child element of SPEECH it encounters. Please note that the argument to match is a simple path
-        pattern, not a full XPath expression. For the time being, it only allows <code>/</code> and <code>//</code> to denote child or descendant steps;
-        the wildcard <code>*</code> to match an arbitrary element, plus matching a single attribute's value, e.g. <code>foo[@bar = 'xyz']</code></para>
+        pattern, not a full XPath expression. For the time being, it only allows:</para>
+      <itemizedlist>
+        <listitem><para><code>/</code> and <code>//</code> to denote child or descendant steps,</para></listitem>
+        <listitem>
+          <para><code>*</code> wildcard selector to match an arbitrary element,</para>
+        </listitem>
+        <listitem><para>matching a single attribute's value, e.g. <code>foo[@bar = 'xyz']</code></para></listitem>
+      </itemizedlist>
       <para>As explained above, you have to figure out which parts of your document will likely be interesting as context for a full text query. The
         full text index works best if the context isn't too narrow. For example, if you have a document structure with section <tag>div</tag>s,
         headings and paragraphs, you would probably want to create an index on the <tag>div</tag>s and maybe on the headings, so the user can
@@ -145,16 +151,16 @@
 
         <para>By default, eXist-db's indexer assumes that element boundaries break on a word or token. For example, if you have an element:</para>
 
-        <programlisting language="xml">&lt;size&gt;&lt;width&gt;12&lt;/width&gt;&lt;height&gt;8&lt;/height&gt;&lt;/size&gt;</programlisting>
+        <programlisting language="xml" xlink:href="listings/listing-16.txt"/>
         <para>You want <code>12</code> and <code>8</code> to be indexed as separate tokens, even though there's no whitespace between the elements.
           eXist-db will pass the content of the two elements to Lucene as separate strings and Lucene will see two tokens (instead of just
             <code>128</code>).</para>
         <para>However, you usually <emphasis>don't</emphasis> want this behaviour for mixed content nodes. For example:</para>
 
-        <programlisting language="xml">&lt;p&gt;This is &lt;b&gt;un&lt;/b&gt;clear.&lt;/p&gt;</programlisting>
+        <programlisting language="xml" xlink:href="listings/listing-17.txt"/>
         <para>In this case, you want <code>unclear</code> to be indexed as a single word. This can be done by telling eXist-db which nodes are inline
           nodes. The example configuration above uses:</para>
-        <programlisting language="xml">&lt;inline qname="b"/&gt;</programlisting>
+        <programlisting language="xml" xlink:href="listings/listing-18.txt"/>
         <para>The <tag>inline</tag> option can both be specified globally or per-index:</para>
         <programlisting language="xml" xlink:href="listings/listing-19.xml"/>
       </sect3>
@@ -166,7 +172,7 @@
 
         <programlisting language="xml" xlink:href="listings/listing-20.xml"/>
         <para>Use an <tag>ignore</tag> element in the collection configuration to have eXist-db ignore the note:</para>
-        <programlisting language="xml">&lt;ignore qname="note"/&gt;</programlisting>
+        <programlisting language="xml" xlink:href="listings/listing-21.txt"/>
         <para>Basically, <tag>ignore</tag> simply allows you to hide a chunk of text before Lucene sees it.</para>
         <para>Like the <tag>inline</tag> tag, <tag>ignore</tag> may appear both globally or within a single index definition.</para>
         <para>The <tag>ignore</tag> only applies to descendants of an indexed element. You can still create another index on the ignored element
@@ -292,7 +298,7 @@
 
       <para>Sometimes you want to define different Lucene indexes on the <emphasis>same set of elements</emphasis>, for instance to use a different
         analyzer. eXist-db allows to name a certain index using the <literal>field</literal> attribute:</para>
-      <programlisting language="xquery">&lt;text field="title" qname="title" analyzer="en"/&gt;</programlisting>
+      <programlisting language="xquery" xlink:href="listings/listing-33.txt"/>
       <para>Such an index is called <emphasis>named index</emphasis>. See <xref linkend="query-a-named-index"/> on how to query these indexes.</para>
     </sect2>
   </sect1>
@@ -352,7 +358,7 @@
           </term>
           <listitem>
             <para>Defines a single term to be searched in the index. If the root query element contains a sequence of term elements, wrap them in
-                <code>&lt;bool&gt;&lt;/bool&gt;</code> and they will be combined as in a boolean "or" query. For example: </para>
+              <tag>bool/</tag> and they will be combined as in a boolean "or" query. For example: </para>
             <programlisting language="xquery" xlink:href="listings/listing-38.txt"/>
             <para>This finds all <tag>SPEECH</tag> elements containing either <code>nation</code> or <code>miserable</code> or both.</para>
           </listitem>
@@ -519,4 +525,4 @@
       document, you need to delete the old fields first though. This can be done using the <literal>ft:remove-index</literal> function:</para>
     <programlisting language="xquery">ft:remove-index("/db/demo/test.xml")</programlisting>
   </sect1>
-</article>
+</article>
diff --git a/src/main/xar-resources/data/webdav/listings/listing-2.txt b/src/main/xar-resources/data/webdav/listings/listing-2.txt
@@ -1,3 +1,3 @@
-    # webdav tweaks for davfs2
-    wrapper.java.additional.7=-Dorg.exist.webdav.PROPFIND_METHOD_XML_SIZE=EXACT
-    wrapper.java.additional.8=-Dorg.exist.webdav.GET_METHOD_XML_SIZE=EXACT 
+# webdav tweaks for davfs2
+wrapper.java.additional.7=-Dorg.exist.webdav.PROPFIND_METHOD_XML_SIZE=EXACT
+wrapper.java.additional.8=-Dorg.exist.webdav.GET_METHOD_XML_SIZE=EXACT 
diff --git a/src/main/xar-resources/data/webdav/webdav.xml b/src/main/xar-resources/data/webdav/webdav.xml
@@ -3,7 +3,7 @@
         schematypens="http://purl.oclc.org/dsdl/schematron"?><article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
   <info>
     <title>WebDAV</title>
-    <date>4Q2018</date>
+    <date>4Q18</date>
     <keywordset>
       <keyword>getting-started</keyword>
       <keyword>interfaces</keyword>
@@ -168,33 +168,28 @@
     
     <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
     
-    <sect2>
+    <sect2 xml:id="davfs2">
       <title>davfs2</title>
-      <para>Recent eXist versions present by default, through WebDAV, the size of XML documents as a multiple of internal pagesize. 
-        This approximated size is not managed correctly by davfs2. You can list XML files (<code>ls -l</code>) but you cannot 
-        view or edit them. All other file types (plain text files, images, etc) are working as expected with davfs2.   
-      </para>
-      <para>The following message is found in davfs2 logs (syslog/journalctl) :              
-        <errortext>Could not read response body: connection was closed by server</errortext>
+      <para>By default, non-XML files (plain text files, images, etc) are working as expected with davfs2.
+        Because eXist-db reports the size of XML documents as a multiple of the internal pagesize, you can list XML files 
+        (<code>ls -l</code>) but you cannot view or edit them. The davfs2 logs (syslog/journalctl) contain:              
+        <literal>Could not read response body: connection was closed by server</literal>
       </para>
       <para>
-        In order to access XML files stored in eXist from
-        a mounted directory in a filesystem thanks to dafvs2, you have to add the following additional Java parameters 
-        when starting eXist : </para>
-      
+        In order to access XML files stored in eXist from a mounted directory in a filesystem via dafvs2, 
+        have to add the following additional Java parameters when starting eXist:</para>    
       <itemizedlist>
         <listitem><para><literal>org.exist.webdav.PROPFIND_METHOD_XML_SIZE=EXACT</literal></para></listitem>
         <listitem><para><literal>org.exist.webdav.GET_METHOD_XML_SIZE=EXACT</literal></para></listitem>
-      </itemizedlist>
-      
-      <para>Please note that if eXist is installed as a service (systemd) the configuration has to be done in <filename>/tools/yajsw/conf/wrapper.conf</filename></para>
+      </itemizedlist>   
+      <para>If eXist is installed as a service (systemd) the configuration has to be done in <literal>/tools/yajsw/conf/wrapper.conf</literal></para>
       
       <programlisting xlink:href="listings/listing-2.txt"/>
       
-      <note><para><literal>NULL</literal> and <literal>APPROXIMATE</literal> values work for Oxygen and Cadaver but only <literal>EXACT</literal> can be used if davfs2 is needed.</para></note>   
+      <warning><para><literal>NULL</literal> and <literal>APPROXIMATE</literal> values work for Oxygen and Cadaver but only <literal>EXACT</literal> can be used with davfs2.</para></warning>   
       
-      <para>These changes won't be taken into account if you do not uninstall the service <emphasis role="bold">before</emphasis> 
-        modifying <filename>wrapper.conf</filename>. The service must then be reinstalled :                     
+      <para>You must first uninstall the service <emphasis role="bold">before</emphasis> 
+        modifying <literal>wrapper.conf</literal>, for changes to be applied when reinstalling:                     
       </para>
       
       <orderedlist>
@@ -214,7 +209,7 @@
         </listitem>
       </orderedlist>
       
-      <note><para>Tested on davfs2 1.4.7 on RHEL7.5 and 1.5.4 on Arch Linux.</para></note>
+      <note><title>Linux</title><para>Tested on davfs2 1.4.7 on RHEL7.5 and 1.5.4 on Arch Linux.</para></note>
       
     </sect2>
     
@@ -293,4 +288,4 @@
       functional when it is accessed via a reverse proxy and a resource's path is altered (aliased)
       with it. </para>
   </sect1>
-</article>
+</article>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<p>He loves <placeName>Paris</placeName>.</p>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<size><width>12</width><height>8</height></size>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<text field="title" qname="title" analyzer="en"/>`