Skip to content

Commit 6901801

Browse files
joewizduncdrum
authored andcommitted
Remove xml extension from internal article links
From author guidelines: “use the target's document name (without the .xml extension) as the link address.”
1 parent 0a6819c commit 6901801

File tree

20 files changed

+73
-72
lines changed

20 files changed

+73
-72
lines changed

src/main/xar-resources/data/backup/backup.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@
323323
<programlisting xlink:href="listings/listing-6.txt"/>
324324
<para>You can also subscribe to the notifications made available by the SanityReport
325325
MBean to be informed of sanity check results. Please consult eXist-db's <link
326-
xlink:href="jmx.xml">JMX documentation</link> on how to configure this.</para>
326+
xlink:href="jmx">JMX documentation</link> on how to configure this.</para>
327327
</sect3>
328328

329329
</sect2>

src/main/xar-resources/data/basic-installation/basic-installation.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131
</listitem>
132132
<listitem>
133133
<para>More advanced installation methods (like installing on a headless system) are
134-
described in the <link xlink:href="advanced-installation.xml#headless">Advanced
134+
described in the <link xlink:href="advanced-installation#headless">Advanced
135135
Installation</link> article. If you wish to compile and run exist from source
136136
please see the article on <link xlink:href="exist-building.xml">building
137137
eXist</link></para>
@@ -252,7 +252,7 @@
252252

253253
<note>
254254
<para>eXist-db can also be run as a background service. For more information see the
255-
<link xlink:href="advanced-installation.xml#headless">Advanced Installation</link>
255+
<link xlink:href="advanced-installation#headless">Advanced Installation</link>
256256
article.</para>
257257
</note>
258258

@@ -318,14 +318,14 @@
318318
<literal>bin/</literal> sub-directory. On Linux or Mac, enter
319319
<code>bin/startup.sh</code>, on Windows <code>bin\startup.bat</code>. More
320320
information about these start-up scripts in the <link
321-
xlink:href="advanced-installation.xml#headless">Advanced Installation</link>
321+
xlink:href="advanced-installation#headless">Advanced Installation</link>
322322
article.</para>
323323

324324
<note>
325325
<title>Having trouble?</title>
326326
<para>If you're having trouble launching eXist-db, see our articles on <link
327327
xlink:href="troubleshooting">Troubleshooting</link> and <link
328-
xlink:href="advanced-installation.xml#headless">Advanced
328+
xlink:href="advanced-installation#headless">Advanced
329329
Installation</link>.</para>
330330
</note>
331331
</sect2>
@@ -351,7 +351,7 @@
351351
</mediaobject>
352352
</informalfigure>
353353
<para>Seeing it? Congratulations! (Not seeing it? See our article on <link
354-
xlink:href="troubleshooting.xml">Troubleshooting</link>).</para>
354+
xlink:href="troubleshooting">Troubleshooting</link>).</para>
355355

356356
<para>All right, ready to dive in! Your local installation includes everything you need.
357357
Access is easy, through the applications on the <link xlink:href="{dashboard}/"

src/main/xar-resources/data/beginners-guide-to-xrx-v4/beginners-guide-to-xrx-v4.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<info>
66
<title>Creating CRUDS applications with XRX in eXist</title>
7-
<date>1Q18</date>
7+
<date>2Q19</date>
88
<keywordset>
99
<keyword>getting-started</keyword>
1010
<keyword>application-development</keyword>
@@ -235,7 +235,8 @@
235235
interchange of applications, the EXPath Community has created a specification
236236
for application metadata, called EXPath Packaging System. eXist supports and
237237
extends this module. This tutorial will not cover this file's structure, but you
238-
can learn more about this by reading <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml"/>. </para>
238+
can learn more about this by reading about the <link xlink:href="repo">Package
239+
Repository</link>. </para>
239240
</listitem>
240241
</orderedlist>
241242
<para>You are always free to change the names of the collection or the queries, but as
@@ -400,7 +401,7 @@
400401
also creates a Lucene full text index for all words in the term name, term
401402
definition and term publish-status-code. (By using the repo.xml Deployment
402403
Descriptor's "prepare" field, you can automate the installation of this
403-
collection.xconf file into the target location; see <link xlink:href="https://exist-db.org/exist/apps/doc/repo.xml#D1.4.10"/>.)</para>
404+
collection.xconf file into the target location; see <link xlink:href="repo#D1.4.10"/>.)</para>
404405
</sect2>
405406

406407
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -709,7 +710,7 @@
709710
<para>Create an XQuery module to centralize some of the common code and reduce
710711
duplication and then reference these functions in each of your queries. For
711712
example, you could put the HTML boilerplate into a style module. You could also
712-
explore eXist's HTML templating module; see <link xlink:href="https://exist-db.org/exist/apps/doc/templating.xml"/>.</para>
713+
explore eXist's <link xlink:href="templating">HTML templating module</link>.</para>
713714
</listitem>
714715
<listitem>
715716
<para>Change the <code>list-items.xq</code> to use HTML tables to view each
@@ -769,7 +770,7 @@
769770
<listitem>
770771
<para>Modify the collection configuration file for the
771772
<code>/db/apps/terms/data</code> collection to enable versioning when items are
772-
updated. See <link xlink:href="https://exist-db.org/exist/apps/doc/versioning.xml"/>.</para>
773+
updated. See <link xlink:href="versioning">Versioning Extensions</link>.</para>
773774
</listitem>
774775
</orderedlist>
775776
</sect1>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Application Server Configuration</title>
8-
<date>1Q18</date>
8+
<date>2Q19</date>
99
<keywordset>
1010
<keyword>operations</keyword>
1111
</keywordset>
@@ -423,7 +423,7 @@
423423
<title> <tag>db-connection</tag>/<tag>default-permissions</tag> element</title>
424424

425425
<para>Specifies the default permissions for all resources and collections in eXist
426-
(see <link xlink:href="security.xml"> User Authentication and Access
426+
(see <link xlink:href="security">User Authentication and Access
427427
Control</link>). When this is not configured, the default <literal>mod</literal>
428428
(similar to the Unix <code>chmod</code> command) is set to
429429
<literal>0775</literal> in the <literal>resources</literal> and
@@ -463,7 +463,7 @@
463463
workaround, which will be removed in the future. Please use the
464464
n-gram or full-text indexes for case-insensitive queries or - if
465465
that is impossible - specify a <link
466-
xlink:href="xquery.xml#collations">collation</link>.</para>
466+
xlink:href="xquery#collations">collation</link>.</para>
467467
</warning>
468468
</listitem>
469469
</varlistentry>
@@ -574,7 +574,7 @@
574574
<literal>class</literal> and <literal>id</literal>. The other attributes, as
575575
well as any nested elements, are specific to the index implementation. Detailed
576576
information is available in the article on <link
577-
xlink:href="indexing.xml#moduleconf">Configuring Database Indexes</link>.</para>
577+
xlink:href="indexing#moduleconf">Configuring Database Indexes</link>.</para>
578578
</sect3>
579579

580580
<sect3 xml:id="indexer-stopwords">
@@ -594,7 +594,7 @@
594594
<para>Configuring indexes via the default settings is <emphasis>not</emphasis>
595595
recommended. If you need a global collection configuration, store one for the
596596
root collection <literal>/db</literal>. For more information, see <link
597-
xlink:href="indexing.xml">Configuring Indexes</link>.</para>
597+
xlink:href="indexing">Configuring Indexes</link>.</para>
598598
</sect3>
599599
</sect2>
600600

@@ -735,7 +735,7 @@
735735
<para>The serializer is responsible for serializing XML documents or document fragments
736736
back into XML. This configuration element defines default settings for various
737737
parameters, which can also be specified programmatically. All settings can be
738-
overwritten by XQuery <link xlink:href="xquery.xml#serialization">serialization
738+
overwritten by XQuery <link xlink:href="xquery#serialization">serialization
739739
options</link>.</para>
740740
<sect3 xml:id="serializer-att">
741741
<title> <tag>serializer</tag> attributes</title>
@@ -821,7 +821,7 @@
821821
catalog files. Catalog files are used to locate DTDs, schemas and resolve external
822822
entities in general.</para>
823823
<para>Please refer to the corresponding documentation on <link
824-
xlink:href="validation.xml">XML Validation</link>.</para>
824+
xlink:href="validation">XML Validation</link>.</para>
825825
</sect2>
826826

827827
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
@@ -990,7 +990,7 @@
990990
which must point to the XQuery source code of the module, for instance:</para>
991991
<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>
992992
<para>For the <code>src</code> attribute, eXist understands the <link
993-
xlink:href="xquery.xml#module-system">same types of URIs</link> as in an
993+
xlink:href="xquery#module-system">same types of URIs</link> as in an
994994
ordinary XQuery import statement.</para>
995995
</sect3>
996996
</sect2>

src/main/xar-resources/data/dashboard/dashboard.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Dashboard</title>
8-
<date>1Q18</date>
8+
<date>2Q19</date>
99
<keywordset>
1010
<keyword>getting-started</keyword>
1111
</keywordset>
@@ -180,6 +180,6 @@
180180
<para>[To be completed...]</para>
181181
<para>Plugins are loaded and unloaded on demand via dojo's AMD loader. They are modular, self-contained units. To add a new plugin, you need to
182182
provide an HTML and a <literal>.js</literal> file, which defines a subclass of the base plugin class. The source code for the dashboard is
183-
available on <link xlink:href="http://github.com/eXist-db/dashboard">GitHub</link>.</para>
183+
available on <link xlink:href="https://github.com/eXist-db/dashboard">GitHub</link>.</para>
184184
</sect1>-->
185185
</article>

src/main/xar-resources/data/development-starter/development-starter.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Getting Started with Web Application Development</title>
8-
<date>1Q18</date>
8+
<date>2Q19</date>
99
<keywordset>
1010
<keyword>getting-started</keyword>
1111
<keyword>application-development</keyword>
@@ -30,7 +30,7 @@
3030
eXide.</para>
3131
</listitem>
3232
<listitem>
33-
<para>An <link xlink:href="templating.xml">HTML templating framework</link> for a clean
33+
<para>An <link xlink:href="templating">HTML templating framework</link> for a clean
3434
separation of HTML page content and application logic.</para>
3535
</listitem>
3636
<listitem>

src/main/xar-resources/data/extensions/extensions.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@
327327
<para>Various functions for <link
328328
xlink:href="http://www.opengeospatial.org/standards/gml">GML</link> geometries,
329329
whether indexed or not. More information about the design is available <link
330-
xlink:href="devguide_indexes.xml">here</link>.</para>
330+
xlink:href="devguide_indexes">Developer's Guide to Modularized Indexes</link>.</para>
331331
<itemizedlist>
332332
<listitem>
333333
<para>Creator: Pierrick Brihaye</para>

src/main/xar-resources/data/getting-help/getting-help.xml

Lines changed: 3 additions & 3 deletions
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>Getting Help</title>
6-
<date>1Q18</date>
6+
<date>2Q19</date>
77
<keywordset>
88
<keyword>getting-started</keyword>
99
</keywordset>
@@ -18,7 +18,7 @@
1818
<sect1 xml:id="community-support">
1919
<title>Community Support</title>
2020

21-
<para>Besides eXist-db's extensive <link xlink:href="documentation">documentation set</link>, eXist-db has a large and active community of users
21+
<para>Besides eXist-db's extensive <link xlink:href="documentation">documentation</link>, eXist-db has a large and active community of users
2222
and developers. The community uses mailing lists, chat, a wiki, and social media to get and give help, follow the latest developments and share
2323
tips and discoveries.</para>
2424
<para>The book, "eXist: a NoSQL Document Database and Application Platform" was published in 2014 and is available from <link xlink:href="http://shop.oreilly.com/product/0636920026525.do" condition="_blank">O'Reilly.com</link>.</para>
@@ -35,7 +35,7 @@
3535
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
3636
you can unsubscribe anytime.</para>
3737
<note>
38-
<para>Please <link xlink:href="getting-help-how-to-report.xml">consult this page</link> for tips how to best report issues.</para>
38+
<para>For reporting issues, please consult the <link xlink:href="getting-help-how-to-report">How to Report Issues</link> article.</para>
3939
</note>
4040
<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
4141
basic to advanced.</para>

src/main/xar-resources/data/incompatibilities/incompatibilities.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:xlink="http://www.w3.org/1999/xlink">
66
<info>
77
<title>Known Issues when upgrading</title>
8-
<date>4Q18</date>
8+
<date>2Q19</date>
99
<keywordset>
1010
<keyword>operations</keyword>
1111
</keywordset>
@@ -115,7 +115,7 @@
115115
<para>2.2 introduces a <emphasis>new range index module</emphasis>. Old index
116116
definitions will still work though as we made sure to keep backwards compatible.
117117
If you would like to upgrade to the new index, check its <link
118-
xlink:href="newrangeindex.xml">documentation</link>.</para>
118+
xlink:href="newrangeindex">documentation</link>.</para>
119119
</listitem>
120120
<listitem>
121121
<para>The XQuery engine has been updated to support the changed syntax for
@@ -267,7 +267,7 @@
267267
<para>The previous <literal>auto</literal> setting was apparently too
268268
confusing for new users who did not know what to do if eXist-db refused
269269
to store a document due to failing validation. If you are familiar with
270-
<link xlink:href="validation.xml">validation</link>, the use of catalog
270+
<link xlink:href="validation">validation</link>, the use of catalog
271271
files and the like, feel free to set the default back to
272272
<literal>auto</literal> or <literal>yes</literal>.</para>
273273
</listitem>
@@ -277,7 +277,7 @@
277277
<listitem>
278278
<para>eXist-db does no longer require Cocoon for viewing documentation and
279279
samples. Cocoon has been largely replaced by eXist-db's own <link
280-
xlink:href="urlrewrite.xml">URL rewriting and MVC
280+
xlink:href="urlrewrite">URL rewriting and MVC
281281
framework</link>.</para>
282282
<para>Consequently, we now limit Cocoon to one directory of the web
283283
application (<literal>webapp/cocoon</literal>) and moved all the Cocoon

src/main/xar-resources/data/indexing/indexing.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,35 +45,35 @@
4545
<code>fn:id()</code>. </para>
4646
</listitem>
4747
<listitem>
48-
<para> <emphasis> <link xlink:href="newrangeindex.xml">New Range Indexes</link>
48+
<para> <emphasis> <link xlink:href="newrangeindex">New Range Indexes</link>
4949
</emphasis>: A (rewritten) range index which provides superior performance on
5050
large data sets.</para>
5151
</listitem>
5252
<listitem>
53-
<para> <emphasis> <link xlink:href="lucene.xml">Full Text Indexes</link>
53+
<para> <emphasis> <link xlink:href="lucene">Full Text Indexes</link>
5454
</emphasis>: This full text indexing module features faster and customizable
5555
full text indexing by transparently integrating Lucene into the XQuery engine.
5656
Prefer this index over the Legacy Full Text Index. </para>
5757
</listitem>
5858
<listitem>
59-
<para> <emphasis> <link xlink:href="ngram.xml">NGram Indexes</link> </emphasis>:
59+
<para> <emphasis> <link xlink:href="ngram">NGram Indexes</link> </emphasis>:
6060
These map specific text nodes and attributes of the documents in a collection to
6161
splitted tokens of n-characters (where n = 3 by default). This is very efficient
6262
for exact substring searches and for queries on scripts (mostly non-European
6363
ones) which can not be easily split into whitespace separated tokens and are
6464
therefore a bad match for the Lucene full text index. </para>
6565
</listitem>
6666
<listitem>
67-
<para> <emphasis> <link xlink:href="oldrangeindex.xml">Legacy Range Indexes</link>
67+
<para> <emphasis> <link xlink:href="oldrangeindex">Legacy Range Indexes</link>
6868
</emphasis>: These map specific text nodes and attributes of documents in a
6969
collection to typed values.</para>
7070
</listitem>
7171
<listitem>
72-
<para> <emphasis> <link xlink:href="devguide_indexes.xml#spatial">Spatial
72+
<para> <emphasis> <link xlink:href="devguide_indexes#spatial">Spatial
7373
Indexes</link> (Experimental)</emphasis>: A working proof-of-concept index,
7474
which listens for spatial geometries described through the Geography Markup
7575
Language (GML). A detailed description of the implementation can be found in the
76-
<link xlink:href="devguide_indexes.xml#spatial">Developer's Guide to Modularized
76+
<link xlink:href="devguide_indexes#spatial">Developer's Guide to Modularized
7777
Indexes</link>.</para>
7878
</listitem>
7979
</orderedlist>

0 commit comments

Comments
 (0)