Skip to content

Commit 50bb4f5

Browse files
committed
[refactor] Rebrand eXist-db to Elemental
1 parent a86a2df commit 50bb4f5

File tree

485 files changed

+18145
-5438
lines changed

Some content is hidden

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

485 files changed

+18145
-5438
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@ To be able to better understand you problem or suggestion, please add as much in
55
Please fill in the following sections:
66

77
### What is the problem
8-
> Describe exactly what you see (e.g. an output of an XQuery)
8+
> Describe exactly what you see (e.g. the output of an XQuery)
99
1010
### What did you expect
11-
> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-3/).
11+
> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-31/).
1212
1313
### Describe how to reproduce or add a test
14-
> Describe how we can can reproduce the problem.
14+
> Describe how we can reproduce the problem.
1515
16-
> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) (XQuery - Run as Test)
16+
> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via `XQuery` > `Run as Test`.
1717
1818
### Context information
19-
Please always add the following information
20-
- eXist-db version + Git Revision hash e.g. eXist-db 3.0 / acd0c14
21-
- Java version (e.g. Java8u121)
22-
- Operating system (Windows 7, Linux, MacOs)
23-
- 32 or 64 bit
24-
- How is eXist-db installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
25-
- Any custom changes in e.g. conf.xml
19+
Please always add the following information:
20+
- Elemental version + Git Revision hash e.g. Elemental 6.3.1 / 31fc2c1
21+
- Java version (e.g. Java 8u121)
22+
- Operating system (Windows 11, Linux, macOS)
23+
- How is Elemental installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
24+
- Any custom config changes in e.g. conf.xml
Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
name: Bug report
3-
about: Thank you for reporting your issue and helping us to improve!
3+
about: Thank you for helping us to improve Elemental by reporting a bug.
44
title: "[BUG]"
55
labels: ''
66
assignees: ''
77

88
---
99

10-
> To be able to better understand you problem, please add as much information as possible to this ticket. Always test your bugs against the latest stable release of exist. We cannot provide support for older versions here on GitHub. If the version of eXist that is experiencing the issue is more than 1 major version behind the most recent release, please consider posting a question on our mailing list.
10+
> To be able to better understand you problem, please add as much information as possible to this ticket. Please also test your bugs against the latest stable release of Elemental to check whether it has already been fixed.
1111
1212

1313
**Describe the bug**
@@ -17,29 +17,30 @@ A clear and concise description of what the bug is.
1717
A clear and concise description of what you expected to happen.
1818

1919
**To Reproduce**
20-
> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) (XQuery - Run as Test)
20+
> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) `XQuery` > `Run as Test`.
2121
22-
```Xquery
22+
```xquery
2323
xquery version "3.1";
2424
2525
module namespace t="http://exist-db.org/xquery/test";
2626
2727
declare namespace test="http://exist-db.org/xquery/xqsuite";
2828
29-
<!-- replace root with your data -->
29+
(: Replace root with your data :)
3030
declare variable $t:XML := document {
31-
<root/>
31+
<root/>
3232
};
3333
34-
<!-- replace index config if needed -->
35-
declare variable $t:xconf :=
34+
(: Replace index config if needed :)
35+
declare variable $t:xconf := document {
3636
<collection xmlns="http://exist-db.org/collection-config/1.0">
37-
<index xmlns:xs="http://www.w3.org/2001/XMLSchema">
38-
<fulltext default="none" attributes="false"/>
39-
</index>
40-
</collection>;
37+
<index xmlns:xs="http://www.w3.org/2001/XMLSchema">
38+
<fulltext default="none" attributes="false"/>
39+
</index>
40+
</collection>
41+
};
4142
42-
<!-- collections and indexes can be configured here -->
43+
(: Collections and Indexes can be configured here :)
4344
declare
4445
%test:setUp
4546
function t:setup() {
@@ -60,33 +61,33 @@ function t:tearDown() {
6061
xmldb:remove("/db/system/config/db/test")
6162
};
6263
63-
<-- Adjust to your reported issue -->
64+
(: Adjust to your reported issue :)
6465
declare
65-
%test:assertTrue
66-
function t:test() {
66+
%test:assertEquals(1)
67+
function t:test-1() {
6768
let $test-data := collection('/db/test')
6869
for $result in $test-data//root
6970
return
70-
count($result) eq 1
71+
count($result)
7172
};
7273
```
7374

74-
If the above isn't working, please tell us the exact steps you took when you encountered the problem:
75-
1. Go to '...'
76-
2. Click on '....'
77-
3. Scroll down to '....'
78-
4. See error
75+
If the above isn't working, please tell us the exact steps you took when you encountered the problem, e.g.
76+
1. Go to ...
77+
2. Click on ...
78+
3. Scroll down to ...
79+
4. Results in the error ...
7980

8081
**Screenshots**
8182
If applicable, add screenshots to help explain your problem.
8283

8384
**Context (please always complete the following information)**
84-
One option is to use [xst](https://www.npmjs.com/package/@existdb/xst), and copy and paste the output produced by running `xst info` here:**
8585

86-
- Build: [eXist-6.1.0]
87-
- Java: [1.8.0_352]
88-
- OS: [Mac OS X 12.6.2]
86+
* Version: [Elemental 6.3.1]
87+
* Java: [1.8.0_352]
88+
* OS: [macOS X 12.6.2]
8989

9090
**Additional context**
91-
- How is eXist-db installed? [e.g. JAR installer, DMG, … ]
92-
- Any custom changes in e.g. `conf.xml`?
91+
92+
* How is Elemental installed? [e.g. JAR installer, DMG, … ]
93+
* Any custom changes in e.g. `conf.xml`?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
Thank you for your contribution to eXist-db!
1+
Thank you for contributing to Elemental!
22

3-
To help the community judge your pull request (PR), please include the following:
3+
To help the community judge your PR (Pull Request), please include the following:
44

5-
- A (short) description of the content of changes.
6-
- A context reference to a [Github Issue](https://github.com/evolvedbinary/elemental/issues), a message in the [eXist-open mailinglist](http://exist-open.markmail.org), or a [specification](https://www.w3.org/TR/xquery-31/).
7-
- Tests. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via XQuery > Run as Test.
5+
- A (short) description of the content of your changes.
6+
- A context reference to a [Github Issue](https://github.com/evolvedbinary/elemental/issues), a message in the [Elemental users mailing list](https://groups.google.com/u/1/a/elemental.xyz/g/users), or a [specification](https://www.w3.org/TR/xquery-31/).
7+
- Tests. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via `XQuery` > `Run as Test`.
88

9-
Your PR will be tested using [GitHub Actions](https://github.com/evolvedbinary/elemental/actions) against a number of operating systems and environments. The build status is visible in the PR.
9+
Your PR will be tested using [CircleCI](https://github.com/evolvedbinary/elemental/actions) against a number of operating systems and environments. The build status is visible in the PR.
1010

11-
To detect errors in your PR before submitting it, please run eXist's full test suite on your own system via `mvn -V clean verify`.
11+
To detect errors in your PR before submitting it, please run Elemental's full test suite on your own system via `mvn -V clean site`.
1212

1313
------
1414

1515
### Description:
1616

1717
### Reference:
1818

19-
### Type of tests:
19+
### Tests:

.github/opencollective.yml

Lines changed: 0 additions & 17 deletions
This file was deleted.

.idea/runConfigurations/Java_Admin_Client.xml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/runConfigurations/Jetty_Server.xml

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/runConfigurations/Local_Jetty_Server.xml

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

BUILD.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Building eXist-db from Source
1+
# Building Elemental from Source Code
22

3-
eXist-db itself is written in Java 8. The build system is [Apache Maven](http://maven.apache.org/). If you're not familiar with Git, we recommend [this excellent online interactive tutorial](http://try.github.io).
3+
Elemental itself is written in Java 8. The build system is [Apache Maven](http://maven.apache.org/). If you're not familiar with Git, we recommend [this excellent online interactive tutorial](http://try.github.io).
44

5-
To build eXist-db:
5+
To build Elemental:
66

77
- Checkout the Git Repository
8-
- Execute a Maven to compile eXist-db
8+
- Execute a Maven to compile Elemental
99

1010
```bash
1111
$ git clone https://github.com/evolvedbinary/elemental.git
@@ -14,14 +14,14 @@ $ git checkout gold
1414
$ mvn -DskipTests package
1515
```
1616

17-
From here, you now have a compiled version of eXist-db in the `exist-distribution/target` folder that you may use just as you would an installed version of eXist-db. An installer is also build and present uin `exist-installer/target` for easy installation elsewhere.
17+
From here, you now have a compiled version of Elemental in the `exist-distribution/target` folder that you may use just as you would an installed version of Elemental. An installer is also build and present in `exist-installer/target` for easy installation elsewhere.
1818

1919
Useful build switches:
2020
- `-Ddocker=true` : builds the docker image
2121
- `-DskipTests` : skips running tests
2222
- `-Ddependency-check.skip=true` : skips validating dependencies
2323

24-
Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml "How to build eXist").
24+
Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml "How to build eXist-db").
2525

2626
**NOTE:**
2727
In the above example, we switched the current (checked-out) branch from `main` to `gold`.

0 commit comments

Comments
 (0)