Skip to content

Commit c7975f3

Browse files
joewizjoewiz
committed
Prepare v0.4.8
As proposed in #96: - Adopt conventions for app name and version properties - Add release notes describing which articles had improvements and what those improvements were (drawn from commit history) so users know what to look out for - Add github repo as repo website link - Revise note shown during upgrade to indicate it is only a concern for eXist 2.x users - Improve README
1 parent 51e8b24 commit c7975f3

File tree

6 files changed

+45
-26
lines changed

6 files changed

+45
-26
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
build/
22
expath-pkg.xml
33
*.xpr
4+
local.build.properties

‎README.md‎

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
1-
eXist-db / documentation
2-
=============
1+
eXist-db Documentation
2+
======================
33

4-
This is the (official) documentation project for the eXist-db Natice XML database.
4+
This repository contains the official documentation for the eXist-db Native XML database and the application for browsing it.
55

6-
The documentation is deployed as an XAR file. The XAR file is built with "ant":
6+
## Resources
77

8-
```
9-
ant
10-
Buildfile: /Users/myhome/GitHub/documentation/build.xml
8+
- Browse the latest release of the documentation at http://exist-db.org/exist/apps/doc/.
9+
- The documentation app is included by default in the eXist-db installer. Just go to your eXist server's Dashboard and select Documentation.
10+
- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at <http://exist-db.org/exist/apps/public-repo/>.
1111

12-
xar:
13-
[copy] Copying 1 file to /Users/myhome/GitHub/documentation
14-
[zip] Building zip: /Users/myhome/GitHub/documentation/build/doc-0.3.3.xar
12+
## Building from source
1513

16-
all:
17-
18-
BUILD SUCCESSFUL
19-
Total time: 1 second
20-
```
21-
22-
Contributions are very welcome using the GitHub Pull Request mechanism.
23-
24-
The documentation is accessible via http://exist-db.org/exist/apps/doc/ ; A pre-built version can be obtained via the eXist-db package manager or via the public App Repository http://exist-db.org/exist/apps/public-repo/
14+
- Dependencies: Apache Ant, eXist 2.2+
15+
- Clone the repository to your system
16+
- From the command line, call `ant`
17+
- An EXPath Application Package (.xar file) is deposited in the `build` directory
18+
- Install this file via the Dashboard > Package Manager.
2519

20+
Find an area of the documentation that needs to be improved? Please raise an issue and submit a pull request!

‎build.properties‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#
2+
# Don't directly modify this file. Instead, copy it to local.build.properties and
3+
# edit that.
4+
#
5+
6+
project.name=doc
7+
project.version=0.4.8

‎build.xml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<project default="all" name="eXist-db Documentation">
33
<property file="local.build.properties"/>
44
<property file="build.properties"/>
5-
<property name="project.app" value="doc"/>
6-
<property name="project.version" value="0.4.7"/>
75
<property name="build" value="build"/>
86
<property name="data" value="data"/>
97
<property name="server.url" value="http://demo.exist-db.org/exist/apps/public-repo/public/"/>
@@ -23,10 +21,11 @@
2321
<mkdir dir="${build}"/>
2422
<copy file="expath-pkg.xml.tmpl" tofile="expath-pkg.xml" filtering="true" overwrite="true">
2523
<filterset>
24+
<filter token="project.name" value="${project.name}"/>
2625
<filter token="project.version" value="${project.version}"/>
2726
</filterset>
2827
</copy>
29-
<zip basedir="." destfile="${build}/${project.app}-${project.version}${git.commit}.xar">
28+
<zip basedir="." destfile="${build}/${project.name}-${project.version}${git.commit}.xar">
3029
<exclude name="${build}/*"/>
3130
<exclude name=".git*"/>
3231
<exclude name="*.tmpl"/>
@@ -37,7 +36,7 @@
3736
<input message="Enter password:" addproperty="server.pass" defaultvalue="">
3837
<handler type="secure"/>
3938
</input>
40-
<property name="xar" value="${project.app}-${project.version}${git.commit}.xar"/>
39+
<property name="xar" value="${project.name}-${project.version}${git.commit}.xar"/>
4140
<exec executable="curl">
4241
<arg line="-T ${build}/${xar} -u admin:${server.pass} ${server.url}/${xar}"/>
4342
</exec>

‎expath-pkg.xml.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<package xmlns="http://expath.org/ns/pkg" name="http://exist-db.org/apps/doc" abbrev="doc" version="@project.version@" spec="1.0">
2+
<package xmlns="http://expath.org/ns/pkg" name="http://exist-db.org/apps/doc" abbrev="@project.name@" version="@project.version@" spec="1.0">
33
<title>eXist-db Documentation</title>
44
<dependency package="http://exist-db.org/apps/shared" semver-min="0.4.0"/>
55
</package>

‎repo.xml‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<repo:description>eXist 2.0 documentation application.</repo:description>
44
<repo:author>Joe Wicentowski</repo:author>
55
<repo:author>Wolfgang Meier</repo:author>
6-
<repo:website/>
6+
<repo:website>https://github.com/eXist-db/documentation</repo:website>
77
<repo:status>alpha</repo:status>
88
<repo:license>GNU-LGPL</repo:license>
99
<repo:copyright>true</repo:copyright>
@@ -12,6 +12,23 @@
1212
<repo:prepare>pre-install.xql</repo:prepare>
1313
<repo:finish/>
1414
<repo:permissions user="admin" password="" group="dba" mode="rw-rw-r--"/>
15-
<note>When upgrading, please make sure you also updated the shared-resources package to > 0.4.0.</note>
15+
<note>Note for users of eXist 2.x: When upgrading, please make sure you also updated the shared-resources package to > 0.4.0.</note>
16+
<changelog>
17+
<change version="0.4.7">
18+
<ul xmlns="http://www.w3.org/1999/xhtml">
19+
<li>No release notes prepared for this or any earlier versions.</li>
20+
</ul>
21+
</change>
22+
<change version="0.4.8">
23+
<ul xmlns="http://www.w3.org/1999/xhtml">
24+
<li>[New Range Index]: Added full documentation for "conditional indexes," a new feature for limiting indexed values to elements meeting certain child attribute criteria.</li>
25+
<li>[Quick Start]: Added a workaround for those with Saxon installed as a JRE extension; improved description of macOS first run &amp; default data directory location.</li>
26+
<li>[Upgrading]: Added new section on how to upgrade to eXist 3.0 and important changes in this release.</li>
27+
<li>[XQSuite]: Added descriptions of %test:stats and %test:assertXPath annotations.</li>
28+
<li>[Lucene]: Fixed WhitespaceAnalyzer classname and the version of Lucene.</li>
29+
<li>Across the board: Fixed name of macOS (was Mac OS X); reviewed mentions of v2.0 and updated where appropriate to match current release</li>
30+
</ul>
31+
</change>
32+
</changelog>
1633
<deployed>2013-05-26T15:18:37.268+02:00</deployed>
1734
</repo:meta>

0 commit comments

Comments
 (0)