Skip to content

Commit f3e5e2f

Browse files
duncdrumduncdrum
committedJan 24, 2020
ignore(various): cosmetic edits, typos, etc
·
6.1.65.1.0
1 parent a16bb81 commit f3e5e2f

File tree

9 files changed

+67
-74
lines changed

9 files changed

+67
-74
lines changed
 

‎src/main/xar-resources/data/advanced-installation/advanced-installation.xml

+3-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<info>
1010
<title>Advanced Installation Methods</title>
11-
<date>4Q19</date>
11+
<date>1Q20</date>
1212
<keywordset>
1313
<keyword>installation</keyword>
1414
<keyword>operations</keyword>
@@ -99,7 +99,7 @@
9999
<para>Once this file is stored in this location, you need to update permissions.
100100
Give ownership of this file to the exist user by using the following commands:</para>
101101
<programlisting xlink:href="listings/listing-5.txt"/>
102-
<para>Below is a list of common commands to interact with the newly created and configured service:</para>
102+
<para>Below is a list of common commands to interact with the newly created and configured service:</para>
103103
<itemizedlist>
104104
<listitem>
105105
<para><code>sudo systemctl start exist-db.service</code> - Enter command to start eXist-db</para>
@@ -162,8 +162,7 @@
162162
<varlistentry>
163163
<term> <code>client.sh</code> (Unix) / <code>client.bat</code> (Windows)</term>
164164
<listitem>
165-
<para>Launches the <link xlink:href="java-admin-client">Java Admin
166-
Client</link>.</para>
165+
<para>Use one of these scripts to launch the <link xlink:href="java-admin-client">Java Admin Client</link>.</para>
167166
</listitem>
168167
</varlistentry>
169168
</variablelist>

‎src/main/xar-resources/data/ant-tasks/ant-tasks.xml

+24-25
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<info>
1010
<title>Ant Tasks</title>
11-
<date>2Q19</date>
11+
<date>1Q20</date>
1212
<keywordset>
1313
<keyword>operations</keyword>
1414
</keywordset>
@@ -254,13 +254,13 @@
254254
<varlistentry>
255255
<term><code>resources</code></term>
256256
<listitem>
257-
<para>If <code>true</code> lists resources</para>
257+
<para>If <code>true</code> return a list of resources.</para>
258258
</listitem>
259259
</varlistentry>
260260
<varlistentry>
261261
<term><code>collections</code></term>
262262
<listitem>
263-
<para>If <code>true</code> lists collections</para>
263+
<para>If <code>true</code> return a list of collections.</para>
264264
</listitem>
265265
</varlistentry>
266266
<varlistentry>
@@ -293,25 +293,25 @@
293293
<varlistentry>
294294
<term><code>resource</code></term>
295295
<listitem>
296-
<para>The name of the resource to copy.</para>
296+
<para>Takes the name of the resource to copy.</para>
297297
</listitem>
298298
</varlistentry>
299299
<varlistentry>
300300
<term><code>collection</code></term>
301301
<listitem>
302-
<para>The name of the collection to copy.</para>
302+
<para>Takes the name of the collection to copy.</para>
303303
</listitem>
304304
</varlistentry>
305305
<varlistentry>
306306
<term><code>destination</code></term>
307307
<listitem>
308-
<para>The name of the destination collection to copy to.</para>
308+
<para>Takes the name of the destination collection to copy to.</para>
309309
</listitem>
310310
</varlistentry>
311311
<varlistentry>
312312
<term><code>name</code></term>
313313
<listitem>
314-
<para>The new name of the resource or collection.</para>
314+
<para>Takes the new name of the resource or collection.</para>
315315
</listitem>
316316
</varlistentry>
317317
</variablelist>
@@ -331,25 +331,25 @@
331331
<varlistentry>
332332
<term><code>resource</code></term>
333333
<listitem>
334-
<para>The name of the resource to move.</para>
334+
<para>Takes the name of the resource to move.</para>
335335
</listitem>
336336
</varlistentry>
337337
<varlistentry>
338338
<term><code>collection</code></term>
339339
<listitem>
340-
<para>The name of the collection to move.</para>
340+
<para>Takes the name of the collection to move.</para>
341341
</listitem>
342342
</varlistentry>
343343
<varlistentry>
344344
<term><code>destination</code></term>
345345
<listitem>
346-
<para>The name of the destination collection to move to.</para>
346+
<para>Takes the name of the destination collection to move to.</para>
347347
</listitem>
348348
</varlistentry>
349349
<varlistentry>
350350
<term><code>name</code></term>
351351
<listitem>
352-
<para>The new name of the resource or collection.</para>
352+
<para>Takes the new name of the resource or collection.</para>
353353
</listitem>
354354
</varlistentry>
355355
</variablelist>
@@ -368,7 +368,7 @@
368368
<varlistentry>
369369
<term><code>query</code></term>
370370
<listitem>
371-
<para>The XPath expression to process.</para>
371+
<para>Takes the XPath expression to process.</para>
372372
</listitem>
373373
</varlistentry>
374374
<varlistentry>
@@ -422,13 +422,13 @@
422422
<varlistentry>
423423
<term><code>query</code></term>
424424
<listitem>
425-
<para>The full query to process.</para>
425+
<para>Takes the full query that should be processed.</para>
426426
</listitem>
427427
</varlistentry>
428428
<varlistentry>
429429
<term><code>queryUri</code></term>
430430
<listitem>
431-
<para>The query to process, specified as a URI.</para>
431+
<para>Takes the query to process, specified as a URI.</para>
432432
</listitem>
433433
</varlistentry>
434434
<varlistentry>
@@ -441,8 +441,7 @@
441441
<varlistentry>
442442
<term><code>destfile</code></term>
443443
<listitem>
444-
<para>Write the results of the query to this destination file. Care should be
445-
taken to get a well-formed document (one root tag!).</para>
444+
<para>Write the results of the query to this destination file. Care should be taken to get a well-formed document (one root tag!).</para>
446445
</listitem>
447446
</varlistentry>
448447
<varlistentry>
@@ -628,13 +627,13 @@
628627
<varlistentry>
629628
<term><code>resource</code></term>
630629
<listitem>
631-
<para>Name of the resource to lock.</para>
630+
<para>Takes the name of the resource to lock.</para>
632631
</listitem>
633632
</varlistentry>
634633
<varlistentry>
635634
<term><code>name</code></term>
636635
<listitem>
637-
<para>Name of the user to lock the resource for.</para>
636+
<para>Takes the name of the user to lock the resource for.</para>
638637
</listitem>
639638
</varlistentry>
640639
</variablelist>
@@ -652,7 +651,7 @@
652651
<varlistentry>
653652
<term><code>name</code></term>
654653
<listitem>
655-
<para>Name of the new user.</para>
654+
<para>Takes the username of the new user.</para>
656655
</listitem>
657656
</varlistentry>
658657
<varlistentry>
@@ -664,7 +663,7 @@
664663
<varlistentry>
665664
<term><code>secret</code></term>
666665
<listitem>
667-
<para>The password for the new user.</para>
666+
<para>Takes the password for the new user.</para>
668667
</listitem>
669668
</varlistentry>
670669
<varlistentry>
@@ -689,7 +688,7 @@
689688
<varlistentry>
690689
<term><code>name</code></term>
691690
<listitem>
692-
<para>Name of the user to remove.</para>
691+
<para>Takes the username of the user to remove.</para>
693692
</listitem>
694693
</varlistentry>
695694
</variablelist>
@@ -708,13 +707,13 @@
708707
<varlistentry>
709708
<term><code>name</code></term>
710709
<listitem>
711-
<para>Name of the user to change the password for.</para>
710+
<para>Takes the username of the user to change the password for.</para>
712711
</listitem>
713712
</varlistentry>
714713
<varlistentry>
715714
<term><code>secret</code></term>
716715
<listitem>
717-
<para>The new password.</para>
716+
<para>Takes the new password for the user.</para>
718717
</listitem>
719718
</varlistentry>
720719
</variablelist>
@@ -732,7 +731,7 @@
732731
<varlistentry>
733732
<term><code>name</code></term>
734733
<listitem>
735-
<para>Name of the new group.</para>
734+
<para>Takes thename of the new group.</para>
736735
</listitem>
737736
</varlistentry>
738737
</variablelist>
@@ -750,7 +749,7 @@
750749
<varlistentry>
751750
<term><code>name</code></term>
752751
<listitem>
753-
<para>Name of the group to remove.</para>
752+
<para>Takes the groupname of the group to remove.</para>
754753
</listitem>
755754
</varlistentry>
756755
</variablelist>

‎src/main/xar-resources/data/configuration/configuration.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -987,7 +987,7 @@
987987
<programlisting language="xquery">import module namespace file="http://exist-db.org/xquery/file";</programlisting>
988988
<para>Instead of providing a Java class, one can also specify a <code>src</code> URI
989989
which must point to the XQuery source code of the module, for instance:</para>
990-
<programlisting language="xml"><![CDATA[&amp;lt;module uri="http://exist-db.org/xquery/kwic" src="resource:org/exist/xquery/lib/kwic.xql"/&amp;gt;]]></programlisting>
990+
<programlisting language="xml" xlink:href="listings/listing-10.txt"/>
991991
<para>For the <code>src</code> attribute, eXist understands the <link
992992
xlink:href="xquery#module-system">same types of URIs</link> as in an
993993
ordinary XQuery import statement.</para>

‎src/main/xar-resources/data/configuration/listings/listing-10.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<module uri="http://exist-db.org/xquery/kwic" src="resource:org/exist/xquery/lib/kwic.xql"/>

‎src/main/xar-resources/data/deployment/deployment.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
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">
44
<info>
55
<title>Database Deployment</title>
6-
<date>2Q19</date>
6+
<date>1Q20</date>
77
<keywordset>
88
<keyword>operations</keyword>
99
<keyword>java-development</keyword>
@@ -285,13 +285,13 @@
285285
<varlistentry>
286286
<term> <code>user</code> </term>
287287
<listitem>
288-
<para>The username of the default user.</para>
288+
<para>Takes the username of the default user.</para>
289289
</listitem>
290290
</varlistentry>
291291
<varlistentry>
292292
<term> <code>password</code> </term>
293293
<listitem>
294-
<para>The password of the default user.</para>
294+
<para>Takes the password of the default user.</para>
295295
</listitem>
296296
</varlistentry>
297297
</variablelist>

‎src/main/xar-resources/data/devguide_indexes/devguide_indexes.xml

+2-4
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@
2222

2323
<sect1 xml:id="intro">
2424
<title>Introduction</title>
25-
26-
2725
<para>eXist ships with four index types based on this mechanism:</para>
2826
<variablelist>
2927
<varlistentry>
@@ -336,8 +334,8 @@
336334
<programlisting>public String getDataDir()</programlisting>
337335
<para>Returns the directory in which this <literal>Index</literal> operates. Usually
338336
defined by <literal>configure()</literal> which itself receives eXist's
339-
configuration settings. <note><para>There might be some <literal>Index</literal>es for
340-
which the concept of data directory isn't accurate.</para></note></para>
337+
configuration settings.</para> <note><para>There might be some <literal>Index</literal>es for
338+
which the concept of data directory isn't accurate.</para></note>
341339
<programlisting>public void configure(BrokerPool pool, String dataDir, Element config)</programlisting>
342340
<para>Its minimal implementation retains the
343341
<literal>org.exist.storage.BrokerPool</literal>, the data directory and the

‎src/main/xar-resources/data/documentation/documentation.xml

+5-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
xmlns:xlink="http://www.w3.org/1999/xlink">
44
<info>
55
<title>Documentation</title>
6-
<date>2Q19</date>
6+
<date>1Q20</date>
77
<keywordset>
88
<keyword>getting-started</keyword>
99
</keywordset>
@@ -45,7 +45,7 @@
4545
<varlistentry>
4646
<term> <link xlink:href="getting-help">Getting Help</link> </term>
4747
<listitem>
48-
<para>Where to go for help and advice.</para>
48+
<para>How to get in touch with the eXist-db community for help and advice.</para>
4949
</listitem>
5050
</varlistentry>
5151
<varlistentry>
@@ -261,7 +261,7 @@
261261
<varlistentry>
262262
<term> <link xlink:href="xinclude">XInclude Support</link> </term>
263263
<listitem>
264-
<para>How to use XInclude in eXist-db.</para>
264+
<para>How XML inclusion (XInclude) processing works in eXist-db.</para>
265265
</listitem>
266266
</varlistentry>
267267
<varlistentry>
@@ -301,14 +301,13 @@
301301
<varlistentry>
302302
<term> <link xlink:href="scheduler">Scheduler Module</link> </term>
303303
<listitem>
304-
<para>How to regularly schedule jobs.</para>
304+
<para>How to use eXist-db job scheduling system to regularly execute tasks.</para>
305305
</listitem>
306306
</varlistentry>
307307
<varlistentry>
308308
<term> <link xlink:href="security">Security</link> </term>
309309
<listitem>
310-
<para>When you get serious writing applications, you need to be aware of the
311-
security model of eXist-db.</para>
310+
<para>When you get serious writing applications, you need to be aware of the security model of eXist-db.</para>
312311
</listitem>
313312
</varlistentry>
314313
<varlistentry>

‎src/main/xar-resources/data/jmx/jmx.xml

+26-30
Original file line numberDiff line numberDiff line change
@@ -72,43 +72,43 @@
7272
<itemizedlist>
7373
<listitem>
7474
<para>Unix/Linux:</para>
75-
<programlisting>$EXIST_HOME/bin/jmxclient.sh &lt;params&gt;</programlisting>
75+
<programlisting>$EXIST_HOME/bin/jmxclient.sh <tag>params</tag></programlisting>
7676
</listitem>
7777
<listitem>
7878
<para>Windows:</para>
79-
<programlisting>$EXIST_HOME\bin\jmxclient.bat &lt;params&gt;</programlisting>
79+
<programlisting>$EXIST_HOME\bin\jmxclient.bat <tag>params</tag></programlisting>
8080
</listitem>
8181
</itemizedlist>
8282
<para>This accepts the following command-line parameters:</para>
8383
<variablelist spacing="normal">
8484
<varlistentry>
85-
<term><code>-a, --address &lt;argument&gt;</code></term>
85+
<term><code>-a, --address</code> <tag>argument</tag></term>
8686
<listitem>
87-
<para>RMI address of the server.</para>
87+
<para>The Remote Method Invocation (RMI) address of the server.</para>
8888
</listitem>
8989
</varlistentry>
9090
<varlistentry>
9191
<term><code>-c, --cache</code></term>
9292
<listitem>
93-
<para>displays server statistics on cache and memory usage.</para>
93+
<para>Displays server statistics on cache and memory usage.</para>
9494
</listitem>
9595
</varlistentry>
9696
<varlistentry>
9797
<term><code>-d, --db</code></term>
9898
<listitem>
99-
<para>display general info about the db instance.</para>
99+
<para>Display general info about the db instance.</para>
100100
</listitem>
101101
</varlistentry>
102102
<varlistentry>
103103
<term><code>-h, --help</code></term>
104104
<listitem>
105-
<para>print help on command line options and exit.</para>
105+
<para>Print help on command line options and exit.</para>
106106
</listitem>
107107
</varlistentry>
108108
<varlistentry>
109-
<term><code>-i, --instance &lt;argument&gt;</code></term>
109+
<term><code>-i, --instance</code> <tag>argument</tag></term>
110110
<listitem>
111-
<para>the ID of the database instance to connect to</para>
111+
<para>The ID of the database instance to connect to.</para>
112112
</listitem>
113113
</varlistentry>
114114
<varlistentry>
@@ -123,27 +123,25 @@
123123
<varlistentry>
124124
<term><code>-m, --memory</code></term>
125125
<listitem>
126-
<para>display info on free and total memory. Can be combined with other
127-
parameters.</para>
126+
<para>Display info on free and total memory. Can be combined with other parameters.</para>
128127
</listitem>
129128
</varlistentry>
130129
<varlistentry>
131-
<term><code>-p, --port &lt;argument&gt;</code></term>
130+
<term><code>-p, --port</code> <tag>argument</tag></term>
132131
<listitem>
133-
<para>RMI port of the server</para>
132+
<para>The Remote Method Invocation (RMI) port of the server.</para>
134133
</listitem>
135134
</varlistentry>
136135
<varlistentry>
137136
<term><code>-s, --report</code></term>
138137
<listitem>
139-
<para>Retrieves the most recent sanity/consistency check report</para>
138+
<para>Retrieves the most recent sanity/consistency check report.</para>
140139
</listitem>
141140
</varlistentry>
142141
<varlistentry>
143-
<term><code>-w, --wait &lt;argument&gt;</code></term>
142+
<term><code>-w, --wait</code> <tag>argument</tag></term>
144143
<listitem>
145-
<para> while displaying server statistics: keep retrieving statistics, but
146-
wait the specified number of seconds between calls.</para>
144+
<para> while displaying server statistics: keep retrieving statistics, but wait the specified number of seconds between calls.</para>
147145
</listitem>
148146
</varlistentry>
149147
</variablelist>
@@ -178,46 +176,44 @@
178176
<varlistentry>
179177
<term><code>instances</code></term>
180178
<listitem>
181-
<para>general information about the db instance, active db broker objects
182-
etc.</para>
179+
<para>general information about the db instance, active db broker objects etc.</para>
183180
</listitem>
184181
</varlistentry>
185182
<varlistentry>
186183
<term><code>disk</code></term>
187184
<listitem>
188-
<para>current hard disk usage of the database files</para>
185+
<para>Contains current hard disk usage of the database files.</para>
189186
</listitem>
190187
</varlistentry>
191188
<varlistentry>
192189
<term><code>system</code></term>
193190
<listitem>
194-
<para>system information: eXist version ...</para>
191+
<para>Contains system information: eXist version ...</para>
195192
</listitem>
196193
</varlistentry>
197194
<varlistentry>
198195
<term><code>caches</code></term>
199196
<listitem>
200-
<para>statistics on eXist's internal caches</para>
197+
<para>Contains statistics on eXist's internal caches.</para>
201198
</listitem>
202199
</varlistentry>
203200
<varlistentry>
204201
<term><code>locking</code></term>
205202
<listitem>
206-
<para>information on collection and resource locks currently being held by
207-
operations</para>
203+
<para>Contains current information on collection and resource locks of running operations.</para>
208204
</listitem>
209205
</varlistentry>
210206
<varlistentry>
211207
<term><code>sanity</code></term>
212208
<listitem>
213-
<para>feedback from the latest sanity check or ping request (see
214-
below)</para>
209+
<para>Feedback from the latest sanity check or ping request (see
210+
below).</para>
215211
</listitem>
216212
</varlistentry>
217213
<varlistentry>
218214
<term><code>all</code></term>
219215
<listitem>
220-
<para>dumps all known JMX objects in eXist's namespace</para>
216+
<para>Dumps all known JMX objects in eXist's namespace.</para>
221217
</listitem>
222218
</varlistentry>
223219
</variablelist>
@@ -241,10 +237,10 @@
241237
<programlisting>http://localhost:8080/exist/status?operation=ping&amp;t=2000</programlisting>
242238
<para>If the ping returns within the specified timeout, the servlet returns the
243239
attributes of the SanityReport JMX bean, which will include an element
244-
<code>&lt;jmx:Status&gt;PING_OK&lt;/jmx:Status&gt;</code>:</para>
240+
<tag>jmx:Status</tag><code>PING_OK</code><tag>/jmx:Status</tag>:</para>
245241
<programlisting language="xml" xlink:href="listings/listing-10.xml"/>
246242
<para>If the ping takes longer than the timeout, you'll instead find an element
247-
<code>&lt;jmx:error&gt;</code> in the returned XML. In this case, additional
243+
<tag>jmx:error</tag> in the returned XML. In this case, additional
248244
information on running queries, memory consumption and database locks will be
249245
provided:</para>
250246
<programlisting language="xml" xlink:href="listings/listing-11.xml"/>
@@ -253,4 +249,4 @@
253249
</sect2>
254250

255251
</sect1>
256-
</article>
252+
</article>

‎src/main/xar-resources/data/repo/repo.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,8 @@
189189
<varlistentry>
190190
<term><code>semver-max</code></term>
191191
<listitem>
192-
<para>Maximum version allowed.</para>
192+
<para>Defines a maximum version according to the
193+
<code>semver</code> scheme.</para>
193194
</listitem>
194195
</varlistentry>
195196
</variablelist>

0 commit comments

Comments
 (0)
Please sign in to comment.