diff --git a/.gitignore b/.gitignore index 073cf5f0..4afa3d8d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ build/ expath-pkg.xml *.xpr +local.build.properties \ No newline at end of file diff --git a/README.md b/README.md index fa2c6d96..0d43f274 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,20 @@ -eXist-db / documentation -============= +eXist-db Documentation +====================== -This is the (official) documentation project for the eXist-db Natice XML database. +This repository contains the official documentation for the eXist-db Native XML database and the application for browsing it. -The documentation is deployed as an XAR file. The XAR file is built with "ant": +## Resources -``` -ant -Buildfile: /Users/myhome/GitHub/documentation/build.xml +- Browse the latest release of the documentation at http://exist-db.org/exist/apps/doc/. +- The documentation app is included by default in the eXist-db installer. Just go to your eXist server's Dashboard and select Documentation. +- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at . -xar: - [copy] Copying 1 file to /Users/myhome/GitHub/documentation - [zip] Building zip: /Users/myhome/GitHub/documentation/build/doc-0.3.3.xar +## Building from source -all: - -BUILD SUCCESSFUL -Total time: 1 second -``` - -Contributions are very welcome using the GitHub Pull Request mechanism. - -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/ +- Dependencies: Apache Ant, eXist 2.2+ +- Clone the repository to your system +- From the command line, call `ant` +- An EXPath Application Package (.xar file) is deposited in the `build` directory +- Install this file via the Dashboard > Package Manager. +Find an area of the documentation that needs to be improved? Please raise an issue and submit a pull request! diff --git a/build.properties b/build.properties new file mode 100644 index 00000000..c82bb40f --- /dev/null +++ b/build.properties @@ -0,0 +1,7 @@ +# +# Don't directly modify this file. Instead, copy it to local.build.properties and +# edit that. +# + +project.name=doc +project.version=0.4.8 diff --git a/build.xml b/build.xml index d3097cff..c870174e 100755 --- a/build.xml +++ b/build.xml @@ -2,8 +2,6 @@ - - @@ -23,10 +21,11 @@ + - + @@ -37,7 +36,7 @@ - + diff --git a/expath-pkg.xml.tmpl b/expath-pkg.xml.tmpl index 7854118c..c95dec92 100755 --- a/expath-pkg.xml.tmpl +++ b/expath-pkg.xml.tmpl @@ -1,5 +1,5 @@ - + eXist-db Documentation diff --git a/repo.xml b/repo.xml index 2cdbc9db..1f8e1c83 100755 --- a/repo.xml +++ b/repo.xml @@ -3,7 +3,7 @@ eXist 2.0 documentation application. Joe Wicentowski Wolfgang Meier - + https://github.com/eXist-db/documentation alpha GNU-LGPL true @@ -12,6 +12,23 @@ pre-install.xql - When upgrading, please make sure you also updated the shared-resources package to > 0.4.0. + Note for users of eXist 2.x: When upgrading, please make sure you also updated the shared-resources package to > 0.4.0. + + +
    +
  • No release notes prepared for this or any earlier versions.
  • +
+
+ +
    +
  • [New Range Index]: Added full documentation for "conditional indexes," a new feature for limiting indexed values to elements meeting certain child attribute criteria.
  • +
  • [Quick Start]: Added a workaround for those with Saxon installed as a JRE extension; improved description of macOS first run & default data directory location.
  • +
  • [Upgrading]: Added new section on how to upgrade to eXist 3.0 and important changes in this release.
  • +
  • [XQSuite]: Added descriptions of %test:stats and %test:assertXPath annotations.
  • +
  • [Lucene]: Fixed WhitespaceAnalyzer classname and the version of Lucene.
  • +
  • Across the board: Fixed name of macOS (was Mac OS X); reviewed mentions of v2.0 and updated where appropriate to match current release
  • +
+
+
2013-05-26T15:18:37.268+02:00