Skip to content

Commit 4aed803

Browse files
committed
if something is not in a section, it will not be found (except for titles); all chapters have titles
1 parent 1af3d74 commit 4aed803

26 files changed

+109
-62
lines changed

data/ant-tasks.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@
6161
</bookinfo>
6262
<chapter>
6363
<title>Ant Tasks</title>
64-
<para>eXist-db provides a library for the <ulink url="http://ant.apache.org">Ant</ulink>
64+
<section>
65+
<para>eXist-db provides a library for the <ulink url="http://ant.apache.org">Ant</ulink>
6566
build tool to automate common tasks like backup/restore or importing a bunch of files.
6667
To use this library you need at least Ant 1.6. Ant 1.8.2 is included in the eXist-db
6768
v2.0 distribution (if you have installed the eXist-db source code). </para>
@@ -133,6 +134,7 @@
133134
</listitem>
134135
</varlistentry>
135136
</variablelist>
137+
</section>
136138
<section>
137139
<title>Storing Documents</title>
138140
<para>The store task uploads and stores the specified documents into
@@ -1075,4 +1077,4 @@ installed">
10751077
<para> You can find this Ant script under the samples/ant directory.</para>
10761078
</section>
10771079
</chapter>
1078-
</book>
1080+
</book>

data/backup.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
21
<!-- $Id$ -->
32
<book>
43
<bookinfo>
@@ -17,11 +16,13 @@
1716
</bookinfo>
1817
<chapter>
1918
<title>Database Backup and Restore</title>
20-
<abstract>
19+
<section>
20+
<abstract>
2121
<para>This section discusses eXist-db's database backup/restore procedures. eXist-db
2222
provides different methods for creating backups, which will be explained
2323
below.</para>
2424
</abstract>
25+
</section>
2526
<section>
2627
<title>Backup Format</title>
2728
<para>During backup, eXist-db exports the contents of its database (as standard XML files)

data/community.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@
1515
</bookinfo>
1616
<chapter>
1717
<title>eXist-db community</title>
18-
<para>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eu metus dui. Fusce enim arcu, molestie nec
18+
<section>
19+
<para>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eu metus dui. Fusce enim arcu, molestie nec
1920
laoreet a, tempus eu magna. Sed pharetra leo vitae tellus porttitor hendrerit. Fusce commodo nisi vel purus
2021
faucibus sit amet scelerisque mi ultricies. Phasellus massa ligula, tristique non dignissim ac, semper nec
2122
erat. Mauris accumsan cursus accumsan. Quisque molestie velit eu nibh fringilla viverra mattis quam
2223
faucibus. Aenean et ultricies lectus. Ut eu felis purus. Etiam mi magna, vestibulum nec commodo sed, varius
2324
vitae lacus.</para>
25+
</section>
2426
<section>
2527
<title>General</title>
2628
<table class="general">

data/debugger.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414
</bookinfo>
1515
<chapter>
1616
<title>Debugger</title>
17-
<para>Starting with eXist-db release 1.4 the database provides an facility to debug xquery code on the server.
17+
<section>
18+
<para>Starting with eXist-db release 1.4 the database provides an facility to debug xquery code on the server.
1819
This document descibes how to build this extension, and how to configure your editor to work with the
1920
extension.</para>
21+
</section>
2022
<section>
2123
<title>Compile</title>
2224
<para>The following steps are required to enable the debugger interface: <procedure>

data/development-starter.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
21
<book>
32
<bookinfo>
43
<productname>eXist-db – Open Source Native XML Database</productname>
@@ -7,7 +6,8 @@
76
</bookinfo>
87
<chapter>
98
<title>Getting Started with Web Application Development</title>
10-
<para>Being much more than just an XML database, eXist-db provides a complete platform for
9+
<section>
10+
<para>Being much more than just an XML database, eXist-db provides a complete platform for
1111
the development of rich web applications based on XML and related technologies (XQuery,
1212
XForms, XSLT, XHTML...).</para>
1313
<para>Key components of this platform are:</para>
@@ -37,6 +37,7 @@
3737
application. This guide describes only one of the many possible approaches. However, we
3838
have found that taking the first steps is the most difficult part for new users, so we
3939
tried to make it as simple as possible.</para>
40+
</section>
4041
<section>
4142
<title>The Packaging</title>
4243
<para>eXist-db 2.0 builds on the concept of self-contained, modular applications which
@@ -412,4 +413,4 @@
412413
dialog.</para>
413414
</section>
414415
</chapter>
415-
</book>
416+
</book>

data/devguide_indexes.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121
</bookinfo>
2222
<chapter id="ch01">
2323
<title>Developer's Guide to Modularized Indexes</title>
24-
<para>This document has been reviewed for eXist-db 1.2.</para>
24+
<section>
25+
<para>This document has been reviewed for eXist-db 1.2.</para>
26+
</section>
2527
<section>
2628
<title>The new modularized indexes</title>
2729
<section>

data/devguide_manifesto.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
</bookinfo>
1717
<chapter id="ch01">
1818
<title>eXist-db Developer Manifesto</title>
19-
<para>This document lays out guidelines for developers that are either committing directly
19+
<section>
20+
<para>This document lays out guidelines for developers that are either committing directly
2021
to the eXist-db code base via the projects GitHub repository or developing
2122
externally for later incorporation into eXist-db.</para>
23+
</section>
2224
<section>
2325
<title>Communication</title>
2426
<para>Communication between developers and within Open Source projects can be a hard

data/extensions.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,25 @@
5353
</bookinfo>
5454
<chapter>
5555
<title>XQuery Extension Modules Documentation</title>
56-
<para>eXist-db provides a pluggable module interface that allows extension modules to be easily
56+
<section id="module_intro">
57+
<para>eXist-db provides a pluggable module interface that allows extension modules to be easily
5758
developed in Java. These extension modules can provide additional XQuery functions through a
5859
custom namespace. The extension modules have full access to the eXist-db database, its internal API,
5960
the context of the executing XQuery and the HTTP Session (if appropriate).</para>
60-
<para>The source code for extension modules should be placed in their own folder inside
61+
<para>The source code for extension modules should be placed in their own folder inside
6162
<filename>$EXIST_HOME/extensions/modules/src/org/exist/xquery/modules</filename>. They may
6263
then be compiled in place using either <command>$EXIST_HOME/build.sh
6364
extension-modules</command> or <command>%EXIST_HOME%\build.bat extension-modules</command>
6465
depending on the platform.</para>
65-
<para>Modules associated to modularized indexes should be placed in the
66+
<para>Modules associated to modularized indexes should be placed in the
6667
<filename>$EXIST_HOME/extensions/indexes/*/xquery/modules/*</filename> hierarchy. They will
6768
be compiled automatically by the standard build targets or as indicated above.</para>
68-
<para>eXist-db must also be told which modules to load, this is done in
69+
<para>eXist-db must also be told which modules to load, this is done in
6970
<filename>conf.xml</filename> and the Class name and Namespace for each module is listed
7071
below. Note – eXist-db will require a restart to load any new modules added. Once a Module is configured
7172
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
7273
<command>util:decribe-function()</command>.</para>
74+
</section>
7375
<section id="module_example">
7476
<title>Example Module</title>
7577
<para>Demonstrates the simplest example of an Extension module with a single function. A good

data/ftlegacy.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
<orgname>The eXist Project</orgname>
88
</bookinfo>
99
<chapter>
10-
<note>
10+
<title>Legacy Full Text Index</title>
11+
<section>
12+
<note>
1113
<para>
1214
<span class="glyphicon glyphicon-warning-sign"/>
1315
<b>Important:</b>
@@ -17,7 +19,7 @@
1719
for the database. Please use the Lucene based fulltext index instead.
1820
</para>
1921
</note>
20-
<title>Legacy Full Text Index</title>
22+
2123
<para>This index is used to query for a sequence of separate "words" or tokens in a longer
2224
stream of text. While building the index, the text is parsed into single tokens which
2325
are then stored in the index.</para>
@@ -55,6 +57,7 @@
5557
this is in direct contrast to the operation of range indexing, which does fallback
5658
to full searching of the document if no range index applies (see below).</para>
5759
</note>
60+
</section>
5861
<section id="ftidxconf">
5962
<title>Full text index configuration</title>
6063
<para>The <emphasis>fulltext index</emphasis> is defined by the

data/getting-help-how-to-report.xml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@
1616
</bookinfo>
1717
<chapter>
1818
<title>Getting Help: How to report issues</title>
19-
<para>When a (potential) bug is reported, please include as much of the information as described below. When
19+
<section>
20+
<para>When a (potential) bug is reported, please include as much of the information as described below. When
2021
more information is provided, it is more easy for the developers to understand and reproduce the issue,
2122
which means that the issue can be picked-up and solved much faster.</para>
22-
<chapter>
23+
</section>
24+
<section>
2325
<title>General information</title>
2426
<note>
2527
<para>When reporting a (suspected) bug please make the report as complete as possible: <itemizedlist>
@@ -46,8 +48,8 @@
4648
</itemizedlist>
4749
</para>
4850
</note>
49-
</chapter>
50-
<chapter>
51+
</section>
52+
<section>
5153
<title>XQuery specific</title>
5254
<note>
5355
<para>When reporting a potential <b>XQuery</b> bug please: <itemizedlist>
@@ -72,6 +74,6 @@
7274
</note>
7375
<para>Bugs can also be reported on the <ulink url="https://github.com/eXist-db/exist/issues/">Bug Tracker</ulink>
7476
where data and log files can be attached.</para>
75-
</chapter>
77+
</section>
7678
</chapter>
7779
</book>

0 commit comments

Comments
 (0)