Skip to content

Commit ba95807

Browse files
jensopetersenjensopetersen
committed
sections must have titles
1 parent 4aed803 commit ba95807

24 files changed

+276
-254
lines changed

‎data/ant-tasks.xml‎

Lines changed: 57 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -62,78 +62,79 @@
6262
<chapter>
6363
<title>Ant Tasks</title>
6464
<section>
65+
<title>Introduction</title>
6566
<para>eXist-db provides a library for the <ulink url="http://ant.apache.org">Ant</ulink>
6667
build tool to automate common tasks like backup/restore or importing a bunch of files.
6768
To use this library you need at least Ant 1.6. Ant 1.8.2 is included in the eXist-db
6869
v2.0 distribution (if you have installed the eXist-db source code). </para>
69-
<para>In your build file, import the eXist-db tasks as follows:</para>
70-
<example>
71-
<title>Import the Tasks</title>
72-
<programlisting>
73-
<markup><![CDATA[<typedef resource="org/exist/ant/antlib.xml" uri="http://exist-db.org/ant">
70+
<para>In your build file, import the eXist-db tasks as follows:</para>
71+
<example>
72+
<title>Import the Tasks</title>
73+
<programlisting>
74+
<markup><![CDATA[<typedef resource="org/exist/ant/antlib.xml" uri="http://exist-db.org/ant">
7475
<classpath refid="classpath.core"/>
7576
</typedef>]]></markup>
76-
</programlisting>
77-
</example>
78-
<para> The classpath has to be defined before as follows</para>
79-
<example>
80-
<title>Definition of Classpath</title>
81-
<programlisting>
82-
<markup><![CDATA[<path id="classpath.core">
77+
</programlisting>
78+
</example>
79+
<para> The classpath has to be defined before as follows</para>
80+
<example>
81+
<title>Definition of Classpath</title>
82+
<programlisting>
83+
<markup><![CDATA[<path id="classpath.core">
8384
<fileset dir="${server.dir}/lib/core">
8485
<include name="*.jar"/>
8586
</fileset>
8687
<pathelement path="${server.dir}/exist.jar"/>
8788
<pathelement path="${server.dir}/exist-optional.jar"/>
8889
</path>]]></markup>
89-
</programlisting>
90-
</example>
91-
<note>
92-
<para>For a working example have a look into the file <filename>webapp/xqts/build.xml
90+
</programlisting>
91+
</example>
92+
<note>
93+
<para>For a working example have a look into the file <filename>webapp/xqts/build.xml
9394
</filename>, which is used to prepare the database for running the xquery test
9495
suite.</para>
95-
</note>
96-
<para>All tasks share the following common attributes:</para>
97-
<variablelist>
98-
<varlistentry>
99-
<term>uri</term>
100-
<listitem>
101-
<para>An XMLDB URI specifying the database collection.</para>
102-
</listitem>
103-
</varlistentry>
104-
<varlistentry>
105-
<term>ssl</term>
106-
<listitem>
107-
<para>Use SSL encryption when communicating with the database (default: false).</para>
108-
</listitem>
109-
</varlistentry>
110-
<varlistentry>
111-
<term>initdb</term>
112-
<listitem>
113-
<para>Setting this option to "true" will automatically
96+
</note>
97+
<para>All tasks share the following common attributes:</para>
98+
<variablelist>
99+
<varlistentry>
100+
<term>uri</term>
101+
<listitem>
102+
<para>An XMLDB URI specifying the database collection.</para>
103+
</listitem>
104+
</varlistentry>
105+
<varlistentry>
106+
<term>ssl</term>
107+
<listitem>
108+
<para>Use SSL encryption when communicating with the database (default: false).</para>
109+
</listitem>
110+
</varlistentry>
111+
<varlistentry>
112+
<term>initdb</term>
113+
<listitem>
114+
<para>Setting this option to "true" will automatically
114115
initialize a database instance if the uri points to an
115116
embedded database.</para>
116-
</listitem>
117-
</varlistentry>
118-
<varlistentry>
119-
<term>user</term>
120-
<listitem>
121-
<para>The user to connect with (default: guest).</para>
122-
</listitem>
123-
</varlistentry>
124-
<varlistentry>
125-
<term>password</term>
126-
<listitem>
127-
<para>Password for the user (default: guest).</para>
128-
</listitem>
129-
</varlistentry>
130-
<varlistentry>
131-
<term>failonerror</term>
132-
<listitem>
133-
<para>Whether or not a error should stop the build execution</para>
134-
</listitem>
135-
</varlistentry>
136-
</variablelist>
117+
</listitem>
118+
</varlistentry>
119+
<varlistentry>
120+
<term>user</term>
121+
<listitem>
122+
<para>The user to connect with (default: guest).</para>
123+
</listitem>
124+
</varlistentry>
125+
<varlistentry>
126+
<term>password</term>
127+
<listitem>
128+
<para>Password for the user (default: guest).</para>
129+
</listitem>
130+
</varlistentry>
131+
<varlistentry>
132+
<term>failonerror</term>
133+
<listitem>
134+
<para>Whether or not a error should stop the build execution</para>
135+
</listitem>
136+
</varlistentry>
137+
</variablelist>
137138
</section>
138139
<section>
139140
<title>Storing Documents</title>

‎data/backup.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,12 @@
1717
<chapter>
1818
<title>Database Backup and Restore</title>
1919
<section>
20+
<title>Abstract</title>
2021
<abstract>
21-
<para>This section discusses eXist-db's database backup/restore procedures. eXist-db
22+
<para>This section discusses eXist-db's database backup/restore procedures. eXist-db
2223
provides different methods for creating backups, which will be explained
2324
below.</para>
24-
</abstract>
25+
</abstract>
2526
</section>
2627
<section>
2728
<title>Backup Format</title>

‎data/community.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<chapter>
1717
<title>eXist-db community</title>
1818
<section>
19+
<title>Introduction</title>
1920
<para>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eu metus dui. Fusce enim arcu, molestie nec
2021
laoreet a, tempus eu magna. Sed pharetra leo vitae tellus porttitor hendrerit. Fusce commodo nisi vel purus
2122
faucibus sit amet scelerisque mi ultricies. Phasellus massa ligula, tristique non dignissim ac, semper nec

‎data/debugger.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<chapter>
1616
<title>Debugger</title>
1717
<section>
18+
<title>Introduction</title>
1819
<para>Starting with eXist-db release 1.4 the database provides an facility to debug xquery code on the server.
1920
This document descibes how to build this extension, and how to configure your editor to work with the
2021
extension.</para>

‎data/development-starter.xml‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,33 @@
77
<chapter>
88
<title>Getting Started with Web Application Development</title>
99
<section>
10+
<title>Introduction</title>
1011
<para>Being much more than just an XML database, eXist-db provides a complete platform for
1112
the development of rich web applications based on XML and related technologies (XQuery,
1213
XForms, XSLT, XHTML...).</para>
13-
<para>Key components of this platform are:</para>
14-
<itemizedlist>
15-
<listitem>
16-
<para>a standardized packaging format for modular applications, allowing deployment
14+
<para>Key components of this platform are:</para>
15+
<itemizedlist>
16+
<listitem>
17+
<para>a standardized packaging format for modular applications, allowing deployment
1718
into any eXist-db instance</para>
18-
</listitem>
19-
<listitem>
20-
<para>a set of tools to create application packages, integrated into our XQuery IDE,
19+
</listitem>
20+
<listitem>
21+
<para>a set of tools to create application packages, integrated into our XQuery IDE,
2122
eXide</para>
22-
</listitem>
23-
<listitem>
24-
<para>an <ulink url="templating.xml">HTML templating framework</ulink> for a clean
23+
</listitem>
24+
<listitem>
25+
<para>an <ulink url="templating.xml">HTML templating framework</ulink> for a clean
2526
separation of HTML page content and application logic</para>
26-
</listitem>
27-
<listitem>
28-
<para>a tight integration with XForms for fast form development</para>
29-
</listitem>
30-
<listitem>
31-
<para>a clean approach for the deployment of RESTful services based on XQuery code
27+
</listitem>
28+
<listitem>
29+
<para>a tight integration with XForms for fast form development</para>
30+
</listitem>
31+
<listitem>
32+
<para>a clean approach for the deployment of RESTful services based on XQuery code
3233
annotations (RESTXQ)</para>
33-
</listitem>
34-
</itemizedlist>
35-
<para>This tutorial will demonstrate how to quickly prototype an application based on above
34+
</listitem>
35+
</itemizedlist>
36+
<para>This tutorial will demonstrate how to quickly prototype an application based on above
3637
components. Certainly there are many other ways to integrate eXist-db into your own
3738
application. This guide describes only one of the many possible approaches. However, we
3839
have found that taking the first steps is the most difficult part for new users, so we

‎data/devguide_indexes.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
<chapter id="ch01">
2323
<title>Developer's Guide to Modularized Indexes</title>
2424
<section>
25-
<para>This document has been reviewed for eXist-db 1.2.</para>
25+
<title>Note</title>
26+
<para>This document has been reviewed for eXist-db 1.2.</para>
2627
</section>
2728
<section>
2829
<title>The new modularized indexes</title>

‎data/devguide_manifesto.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
<chapter id="ch01">
1818
<title>eXist-db Developer Manifesto</title>
1919
<section>
20+
<title>Introduction</title>
2021
<para>This document lays out guidelines for developers that are either committing directly
2122
to the eXist-db code base via the projects GitHub repository or developing
2223
externally for later incorporation into eXist-db.</para>

‎data/extensions.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<chapter>
5555
<title>XQuery Extension Modules Documentation</title>
5656
<section id="module_intro">
57+
<title>Introduction</title>
5758
<para>eXist-db provides a pluggable module interface that allows extension modules to be easily
5859
developed in Java. These extension modules can provide additional XQuery functions through a
5960
custom namespace. The extension modules have full access to the eXist-db database, its internal API,

‎data/facts.xml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
21
<!-- $Id$ -->
32
<document xmlns:xi="http://www.w3.org/2001/XInclude">
43
<body>
54
<section title="Fact Sheet">
5+
<title>Fact Sheet</title>
66
<category name="System Requirements">
77
<topic name="Java Version">
88
<p>Java6 "Java SE 6"; development and testing is performed using Oracle's Java6 JVM, 32bit (x86) and 64bit (x64).</p>
@@ -42,7 +42,7 @@
4242
automatically.</p>
4343
</topic>
4444
<topic name="Query Engine">
45-
<p>eXist-db has its own, optimized <a href="xquery.xml">XQuery engine</a>,
45+
<p>eXist-db has its own, optimized <a href="xquery.xml">XQuery engine</a>,
4646
featuring an efficient, index-based query processing.</p>
4747
<p>Contrary to conventional implementations, eXist's query engine tries to avoid
4848
top-down or bottom-up tree traversals. Instead, it relies on fast path join
@@ -72,12 +72,13 @@
7272
APIs.</p>
7373
</topic>
7474
<topic name="Deployment">
75-
<p>eXist-db may be <a href="deployment.xml">deployed</a> as a stand-alone database
75+
<p>eXist-db may be <a href="deployment.xml">deployed</a> as a stand-alone database
7676
server, as an embedded Java library or as part of a web application (running
7777
in the servlet engine).</p>
7878
</topic>
7979
<topic name="Backup/Restore">
80-
<p><a href="backup.xml">Backup/restore</a> functionality is provided via Java
80+
<p>
81+
<a href="backup.xml">Backup/restore</a> functionality is provided via Java
8182
admin client or Ant scripts. The backup contains resources as readable XML.
8283
Allows full restore of a database including user/group permissions.</p>
8384
</topic>
@@ -133,7 +134,7 @@
133134
</category>
134135
<category name="Network Protocols">
135136
<topic name="HTTP/REST">
136-
<p>eXist-db offers a REST-style web service API for simple access via HTTP. This is
137+
<p>eXist-db offers a REST-style web service API for simple access via HTTP. This is
137138
in general the fastest way to access the database. Running in a servlet
138139
context, the REST functionality is provided through the EXistServlet. In
139140
stand-alone mode, the database has its own, built-in web server.</p>

‎data/ftlegacy.xml‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,54 @@
99
<chapter>
1010
<title>Legacy Full Text Index</title>
1111
<section>
12+
<title>Note</title>
1213
<note>
13-
<para>
14-
<span class="glyphicon glyphicon-warning-sign"/>
15-
<b>Important:</b>
16-
<span class="glyphicon glyphicon-warning-sign"/>
17-
<br/>The Legacy Full Text Index should not be used anymore. The functionaly
14+
<para>
15+
<span class="glyphicon glyphicon-warning-sign"/>
16+
<b>Important:</b>
17+
<span class="glyphicon glyphicon-warning-sign"/>
18+
<br/>The Legacy Full Text Index should not be used anymore. The functionaly
1819
will be removed from eXist-db in a future release, because it causes instability
1920
for the database. Please use the Lucene based fulltext index instead.
2021
</para>
21-
</note>
22-
23-
<para>This index is used to query for a sequence of separate "words" or tokens in a longer
22+
</note>
23+
<para>This index is used to query for a sequence of separate "words" or tokens in a longer
2424
stream of text. While building the index, the text is parsed into single tokens which
2525
are then stored in the index.</para>
26-
<important>
27-
<para>Historically, eXist has been creating a default full text index on all text nodes
26+
<important>
27+
<para>Historically, eXist has been creating a default full text index on all text nodes
2828
and attribute values. This is no longer the case! Creating default indexes on data
2929
which you may never use is too expensive, in particular, since eXist is now
3030
providing a wider range of different indexes which can be much better optimized than
3131
the default index and will offer superior performance.</para>
32-
</important>
33-
<para>Anyway, as for the other index types, you can configure the full text index in the
32+
</important>
33+
<para>Anyway, as for the other index types, you can configure the full text index in the
3434
collection configuration and we will try to keep the configuration of the new index
3535
backwards compatible. We thus recommend to create a collection configuration file,
3636
disable the default index-all behaviour and define some explicit full text indexes on
3737
your documents. The details of this process will be described below.</para>
38-
<para>The full text index is only used in combination with eXist's fulltext search
38+
<para>The full text index is only used in combination with eXist's fulltext search
3939
extensions. In particular, you can use the following eXist-specific operators and
4040
functions that apply a fulltext index:</para>
41-
<itemizedlist>
42-
<listitem>
43-
<para>Operators: <command>&amp;=</command> and <command>|=</command>
44-
</para>
45-
</listitem>
46-
<listitem>
47-
<para>Main Functions: <function>text:match-all()</function>,
41+
<itemizedlist>
42+
<listitem>
43+
<para>Operators: <command>&amp;=</command> and <command>|=</command>
44+
</para>
45+
</listitem>
46+
<listitem>
47+
<para>Main Functions: <function>text:match-all()</function>,
4848
<function>text:match-any()</function> and <function>near()</function>
49-
</para>
50-
</listitem>
51-
</itemizedlist>
52-
<note>
53-
<para>It is important to note that, if you have disabled full text indexing for certain
49+
</para>
50+
</listitem>
51+
</itemizedlist>
52+
<note>
53+
<para>It is important to note that, if you have disabled full text indexing for certain
5454
elements, these operators and functions will also be effectively disabled, and will
5555
not return matches. As a result, eXist will not return results for queries that
5656
normally would have results provided fulltext indexing was enabled. Note also that
5757
this is in direct contrast to the operation of range indexing, which does fallback
5858
to full searching of the document if no range index applies (see below).</para>
59-
</note>
59+
</note>
6060
</section>
6161
<section id="ftidxconf">
6262
<title>Full text index configuration</title>

0 commit comments

Comments
 (0)