Skip to content

Commit 306e267

Browse files
adamretteradamretter
authored
Merge pull request #153 from eXist-db/DP-tackling-old-news
Dp tackling old news
2 parents 4abfa3d + 8375ad0 commit 306e267

File tree

112 files changed

+160
-1235
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+160
-1235
lines changed

‎ISSUE_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:balloon: First off, thank you for contributing to eXist-db's documentation. :balloon:
2+
3+
### Where is the problem
4+
> For problems with a specific article or page, please state the name of the page at the beginning of the title line, like this `[XXX.xml] something isn't right with...` You can find the name of the docbook xml file in URI bar of your browser.
5+
6+
### What is the problem
7+
8+
9+
### Please provide the following
10+
* exist-db version: 3.6.0
11+
* documentation version: 0.6.1

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ Found an area of the documentation that needs to be improved? Please raise an [i
2222

2323
Our test-suite performs a validation check on all articles when you open a pull request. You can speed up the review process by running `mvn validate` locally before submitting a pull request.
2424

25+
Should you encounter documentation for features that are deprecated in the minimum eXist-db version mentioned [above](#dependencies), you can simply delete them. If you are unsure about this, please open an [issue](https://github.com/eXist-db/documentation/issues).
26+
2527
## Building from source
2628
1. Clone the repository to your system:
2729
```bash

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Setting admin user password...
105105
<para>After executing the installService.bat script, you should find eXist-db listed in the
106106
list of services currently registered with Windows:</para>
107107
<screenshot>
108-
<graphic fileref="resources/services.png"/>
108+
<graphic fileref="resources/images/services.png"/>
109109
</screenshot>
110110
<para>Once the service is registered, you can launch it via the service manager, as shown
111111
in the screenshot, or from the command line:</para>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
released.</para>
119119
<para>You can trigger the backup via the Dashboard:</para>
120120
<screenshot>
121-
<graphic fileref="resources/Backup.png"/>
121+
<graphic fileref="resources/images/Backup.png"/>
122122
</screenshot>
123123
<para>Clicking the <guibutton>Trigger</guibutton> button will schedule a single backup
124124
task. The server will wait for all running transactions to return before it executes
@@ -263,7 +263,7 @@
263263
<section id="consistency-check">
264264
<title>Emergency Export Tool</title>
265265
<screenshot>
266-
<graphic align="right" fileref="resources/exportgui.png"/>
266+
<graphic align="right" fileref="resources/images/exportgui.png"/>
267267
</screenshot>
268268
<para>eXist provides a graphical interface to the consistency check and backup
269269
utilities which can be used in case of an emergency, in particular if the
@@ -291,7 +291,7 @@
291291
eXist, you can use a JMX client to see the latest consistency check reports. The
292292
screenshot shows jconsole, which is included with the Java 5 and 6 JDKs.</para>
293293
<screenshot>
294-
<graphic fileref="resources/jconsole.png"/>
294+
<graphic fileref="resources/images/jconsole.png"/>
295295
</screenshot>
296296
<para>eXist also includes a command-line JMX client. Call it with parameter
297297
<parameter>-s</parameter> to see the latest consistency report:</para>
@@ -328,7 +328,7 @@
328328
stored. Note, however, that user data and permissions will only be exported
329329
if you backup the entire database.</para>
330330
<screenshot>
331-
<graphic fileref="resources/backup1.png"/>
331+
<graphic fileref="resources/images/backup1.png"/>
332332
</screenshot>
333333
</step>
334334
<step>
@@ -440,7 +440,7 @@
440440
directory you want restored. To restore the entire database, select the
441441
<filename>__contents__.xml</filename> from the <filename>db/</filename> directory.</para>
442442
<screenshot>
443-
<graphic fileref="resources/backup2.png"/>
443+
<graphic fileref="resources/images/backup2.png"/>
444444
</screenshot>
445445
<para>eXist 1.3 allows to directly select the ZIP archive of a
446446
backup.</para>
@@ -458,7 +458,7 @@
458458
<para>If the restore was accepted, a progress dialog box will display the
459459
restored files:</para>
460460
<screenshot>
461-
<graphic fileref="resources/backup3.png"/>
461+
<graphic fileref="resources/images/backup3.png"/>
462462
</screenshot>
463463
</step>
464464
</procedure>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ declare option exist:serialize "method=xhtml media-type=text/html indent=yes";
428428
<para>
429429
<inlinemediaobject>
430430
<imageobject>
431-
<imagedata fileref="resources/list-items-no-links.png" contentwidth="200"/>
431+
<imagedata fileref="resources/images/list-items-no-links.png" contentwidth="200"/>
432432
</imageobject>
433433
</inlinemediaobject>
434434
</para>
@@ -446,7 +446,7 @@ declare option exist:serialize "method=xhtml media-type=text/html indent=yes";
446446
<para>
447447
<inlinemediaobject>
448448
<imageobject>
449-
<imagedata fileref="resources/list-items-links.png" contentwidth="200"/>
449+
<imagedata fileref="resources/images/list-items-links.png" contentwidth="200"/>
450450
</imageobject>
451451
</inlinemediaobject>
452452
</para>
@@ -512,7 +512,7 @@ return
512512
<para>
513513
<inlinemediaobject>
514514
<imageobject>
515-
<imagedata fileref="resources/view-item.png" contentwidth="400"/>
515+
<imagedata fileref="resources/images/view-item.png" contentwidth="400"/>
516516
</imageobject>
517517
</inlinemediaobject>
518518
</para>
@@ -626,7 +626,7 @@ return
626626
<para>
627627
<inlinemediaobject>
628628
<imageobject>
629-
<imagedata fileref="resources/reindex-result.png" contentwidth="400"/> <!--typos in image-->
629+
<imagedata fileref="resources/images/reindex-result.png" contentwidth="400"/> <!--typos in image-->
630630
</imageobject>
631631
</inlinemediaobject>
632632
</para>
@@ -660,7 +660,7 @@ return
660660
<para>
661661
<inlinemediaobject>
662662
<imageobject>
663-
<imagedata fileref="resources/search.png" contentwidth="300"/>
663+
<imagedata fileref="resources/images/search.png" contentwidth="300"/>
664664
</imageobject>
665665
</inlinemediaobject>
666666
</para>
@@ -722,7 +722,7 @@ return
722722
<para>
723723
<inlinemediaobject>
724724
<imageobject>
725-
<imagedata fileref="resources/search-results.png" contentwidth="300"/><!--<a href="../index.html">App Home</a> missing from image-->
725+
<imagedata fileref="resources/images/search-results.png" contentwidth="300"/><!--<a href="../index.html">App Home</a> missing from image-->
726726
</imageobject>
727727
</inlinemediaobject>
728728
</para>
@@ -753,7 +753,7 @@ return
753753
<para>
754754
<inlinemediaobject>
755755
<imageobject>
756-
<imagedata fileref="resources/model-view-bindings.png" contentwidth="400"/>
756+
<imagedata fileref="resources/images/model-view-bindings.png" contentwidth="400"/>
757757
</imageobject>
758758
</inlinemediaobject>
759759
</para>
@@ -1207,7 +1207,7 @@ return
12071207
<para>
12081208
<inlinemediaobject>
12091209
<imageobject>
1210-
<imagedata fileref="resources/index.png" contentwidth="200"/>
1210+
<imagedata fileref="resources/images/index.png" contentwidth="200"/>
12111211
</imageobject>
12121212
</inlinemediaobject>
12131213
</para>

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<title>Login</title>
2929
<figure floatstyle="left">
3030
<title>Login as User admin</title>
31-
<graphic fileref="resources/dashboardLogin.png"/>
31+
<graphic fileref="resources/images/dashboardLogin.png"/>
3232
</figure>
3333
<para>To fully use the administration plugins, you need to be logged in as a dba user.
3434
You may access plugins as a non-dba user, but as soon as you want to apply changes,
@@ -41,7 +41,7 @@
4141
<title>Using the Package Manager</title>
4242
<figure floatstyle="left">
4343
<title>The Package Manager Icon</title>
44-
<graphic fileref="resources/dashboardPMIcon.png"/>
44+
<graphic fileref="resources/images/dashboardPMIcon.png"/>
4545
</figure>
4646
<para>The Package Manager lists all installed and available packages. If updates to
4747
installed packages are available, this is marked in red.</para>
@@ -53,7 +53,7 @@
5353
<title>Installing/Removing a Package</title>
5454
<figure floatstyle="left">
5555
<title>Installing an App</title>
56-
<graphic fileref="resources/dashboardInstallApp.png"/>
56+
<graphic fileref="resources/images/dashboardInstallApp.png"/>
5757
</figure>
5858
<para>To install an app from the public repository, move your mouse over the app. You
5959
should see an install button if the app is not currently installed, or a remove
@@ -63,7 +63,7 @@
6363
<title>Updating a Package</title>
6464
<figure floatstyle="left">
6565
<title>Available Updates to Installed Packages</title>
66-
<graphic fileref="resources/dashboardUp2dateApps.png"/>
66+
<graphic fileref="resources/images/dashboardUp2dateApps.png"/>
6767
</figure>
6868
<para>Updates to already installed packages appear with the currently installed and the available version number in red.
6969
Another note is displayed if a package requires a certain version of eXist-db.
@@ -76,7 +76,7 @@
7676
<title>Browser Caching</title>
7777
<figure floatstyle="left">
7878
<title>Clear your Cache Information </title>
79-
<graphic fileref="resources/dashboardUp2dateInfo.png"/>
79+
<graphic fileref="resources/images/dashboardUp2dateInfo.png"/>
8080
</figure>
8181
<para>Some apps like eXide or the Dashboard rely on JavaScript libraries. After an
8282
update, your browser may still use the old libraries, which may affect the
@@ -87,7 +87,7 @@
8787
<title>Installing an Older Version</title>
8888
<figure floatstyle="left">
8989
<title>Older Versions in Detailed View</title>
90-
<graphic fileref="resources/dashboardSelectVersion.png"/>
90+
<graphic fileref="resources/images/dashboardSelectVersion.png"/>
9191
</figure>
9292
<para>Sometimes you may want to go back to an older version of a package. To see all
9393
available versions, switch to the detail view, using the
@@ -99,7 +99,7 @@
9999
<title>Uploading Your Own Packages</title>
100100
<figure floatstyle="left">
101101
<title>Upload Your Own Application to eXist-db</title>
102-
<graphic fileref="resources/dashboardLoadOwnApps.png"/>
102+
<graphic fileref="resources/images/dashboardLoadOwnApps.png"/>
103103
</figure>
104104
<para>Instead of installing from the public repository, you can also upload a
105105
package to the server from your local disk. The package has to be in

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@
8282
<title>Deployment Editor Dialog</title>
8383
<mediaobject>
8484
<imageobject>
85-
<imagedata fileref="resources/new-application-screen.png" scale="75%"/>
85+
<imagedata fileref="resources/images/new-application-screen.png" scale="75%"/>
8686
</imageobject>
8787
</mediaobject>
8888
</figure>
@@ -159,7 +159,7 @@
159159
<title>Open Document Dialog after generating application </title>
160160
<mediaobject>
161161
<imageobject>
162-
<imagedata fileref="resources/new-application-completed.png"/>
162+
<imagedata fileref="resources/images/new-application-completed.png"/>
163163
</imageobject>
164164
</mediaobject>
165165
</figure>
@@ -169,7 +169,7 @@
169169
<title>Run Dialog</title>
170170
<mediaobject>
171171
<imageobject>
172-
<imagedata fileref="resources/new-application-run.png"/>
172+
<imagedata fileref="resources/images/new-application-run.png"/>
173173
</imageobject>
174174
</mediaobject>
175175
</figure>
@@ -184,7 +184,7 @@
184184
<title>The Default Start Page of the Application</title>
185185
<mediaobject>
186186
<imageobject>
187-
<imagedata fileref="resources/new-application-home.png"/>
187+
<imagedata fileref="resources/images/new-application-home.png"/>
188188
</imageobject>
189189
</mediaobject>
190190
</figure>
@@ -295,7 +295,7 @@
295295
<title>Processing Flow</title>
296296
<mediaobject>
297297
<imageobject>
298-
<imagedata fileref="resources/Templating.png"/>
298+
<imagedata fileref="resources/images/Templating.png"/>
299299
</imageobject>
300300
</mediaobject>
301301
</figure>
@@ -405,7 +405,7 @@
405405
<title>Synchronize Dialog</title>
406406
<mediaobject>
407407
<imageobject>
408-
<imagedata fileref="resources/sync-dialog.png"/>
408+
<imagedata fileref="resources/images/sync-dialog.png"/>
409409
</imageobject>
410410
</mediaobject>
411411
</figure>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3080,7 +3080,7 @@
30803080
some default fulltext indexing. Let's close the upload window and quit the interactive client.</para>
30813081
<para>Let's look our our GML file looks like on GML Viewer, a free viewer provided by <ulink url="http://www.snowflakesoftware.co.uk/products/gmlviewer/index.htm">Snowflake software</ulink> :</para>
30823082
<screenshot>
3083-
<graphic fileref="resources/port-talbot.jpg"/>
3083+
<graphic fileref="resources/images/port-talbot.jpg"/>
30843084
</screenshot>
30853085
<para>If you want to have a look at the spatial index HSQLDB, which, if you are using the default data-dir, is in <filename>${EXIST_HOME}/webapp/WEB-INF/data/spatial_index.*</filename> there is a dedicated script file in <filename>${EXIST_HOME}/extensions/indexes/spatial/</filename>.
30863086
to launch HSQL's GUI client: Use either <filename>hsql.bat</filename> or <filename>hsql.sh [data-dir]</filename> (you only need to supply data-dir if it is not the default one).</para>
@@ -3138,7 +3138,7 @@
31383138
<para>So, 3 degrees West, 51 deegrees North... we must be indeed northern of Brittany, i.e. in south-western Great-Britain.</para>
31393139
<para>Let's see what our polygon looks like:</para>
31403140
<screenshot>
3141-
<graphic fileref="resources/rectangle.jpg"/>
3141+
<graphic fileref="resources/images/rectangle.jpg"/>
31423142
</screenshot>
31433143
<para>Now, we continue doing something more practical:</para>
31443144
<programlisting format="linespecific"><![CDATA[
@@ -3174,7 +3174,7 @@
31743174
<para>... retuns 755 <sgmltag>gml:Polygon</sgmltag> (one less) in just about 470 ms.</para>
31753175
<para>The result of our first intersection query looks like this:</para>
31763176
<screenshot>
3177-
<graphic fileref="resources/intersection.jpg"/>
3177+
<graphic fileref="resources/images/intersection.jpg"/>
31783178
</screenshot>
31793179
<para>Let's try another type of spatial query:</para>
31803180
<programlisting format="linespecific"><![CDATA[
@@ -3193,7 +3193,7 @@
31933193
]]></programlisting>
31943194
<para>It returns 598 <sgmltag>gml:Polygon</sgmltag>s in just a little bit more than 400 ms. Here is what they look like:</para>
31953195
<screenshot>
3196-
<graphic fileref="resources/within.jpg"/>
3196+
<graphic fileref="resources/images/within.jpg"/>
31973197
</screenshot>
31983198
<para>The last query of this session is just to demonstrate some interesting capabilities of the spatial functions:</para>
31993199
<programlisting format="linespecific"><![CDATA[
@@ -3213,7 +3213,7 @@
32133213
]]></programlisting>
32143214
<para>See the (not so) rounded corners of our 500 metres buffer over Port-Talbot :</para>
32153215
<screenshot>
3216-
<graphic fileref="resources/buffer.jpg"/>
3216+
<graphic fileref="resources/images/buffer.jpg"/>
32173217
</screenshot>
32183218
</section>
32193219
<section>

0 commit comments

Comments
 (0)