fixup! WIP Rebrand eXist-db to Elemental

Author: adamretter

.github/ISSUE_TEMPLATE.md

@@ -5,21 +5,20 @@ To be able to better understand you problem or suggestion, please add as much in
 Please fill in the following sections:
 
 ### What is the problem
-> Describe exactly what you see (e.g. an output of an XQuery) 
+> Describe exactly what you see (e.g. the output of an XQuery) 
 
 ### What did you expect
-> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-3/).
+> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-31/).
 
 ### Describe how to reproduce or add a test
-> Describe how we can can reproduce the problem.
+> Describe how we can reproduce the problem.
 
-> 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)
+> 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`.
 
 ### Context information
-Please always add the following information
-- eXist-db version + Git Revision hash e.g. eXist-db 3.0 /  acd0c14 
-- Java version (e.g. Java8u121)
-- Operating system (Windows 7, Linux, MacOs)
-- 32 or 64 bit
-- How is eXist-db installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
-- Any custom changes in e.g. conf.xml
+Please always add the following information:
+- Elemental version + Git Revision hash e.g. Elemental 6.3.1 / 31fc2c1 
+- Java version (e.g. Java 8u121)
+- Operating system (Windows 11, Linux, macOS)
+- How is Elemental installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
+- Any custom config changes in e.g. conf.xml

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,13 +1,13 @@
 ---
 name: Bug report
-about: Thank you for reporting your issue and helping us to improve!
+about: Thank you for helping us to improve Elemental by reporting a bug.
 title: "[BUG]"
 labels: ''
 assignees: ''
 
 ---
 
-> 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. 
+> 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.
 
 
 **Describe the bug**
@@ -17,29 +17,30 @@ A clear and concise description of what the bug is.
 A clear and concise description of what you expected to happen.
 
 **To Reproduce**
-> 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)
+> 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`.
 
-```Xquery
+```xquery
 xquery version "3.1";
 
 module namespace t="http://exist-db.org/xquery/test";
 
 declare namespace test="http://exist-db.org/xquery/xqsuite";
 
-<!--  replace root with your data -->
+(: Replace root with your data :)
 declare variable $t:XML := document {
-<root/>
+    <root/>
 };
 
-<!--  replace index config if needed -->
-declare variable $t:xconf :=
+(: Replace index config if needed :)
+declare variable $t:xconf := document {
     <collection xmlns="http://exist-db.org/collection-config/1.0">
-    <index xmlns:xs="http://www.w3.org/2001/XMLSchema">
-        <fulltext default="none" attributes="false"/>
-    </index>
-</collection>;
+        <index xmlns:xs="http://www.w3.org/2001/XMLSchema">
+            <fulltext default="none" attributes="false"/>
+        </index>
+    </collection>
+};
 
-<!--  collections and indexes can be configured here  -->
+(: Collections and Indexes can be configured here :)
 declare
     %test:setUp
 function t:setup() {
@@ -60,33 +61,33 @@ function t:tearDown() {
     xmldb:remove("/db/system/config/db/test")
 };
 
-<-- Adjust to your reported issue -->
+(: Adjust to your reported issue :)
 declare
-    %test:assertTrue
-function t:test() {
+    %test:assertEquals(1)
+function t:test-1() {
     let $test-data := collection('/db/test')
     for $result in $test-data//root
     return
-       count($result) eq 1
+       count($result)
 };
 ```
 
-If the above isn't working, please tell us the exact steps you took when you encountered the problem:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+If the above isn't working, please tell us the exact steps you took when you encountered the problem, e.g.
+1. Go to ...
+2. Click on ...
+3. Scroll down to ...
+4. Results in the error ...
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
 **Context (please always complete the following information)**
-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:**
 
- - Build: [eXist-6.1.0]
- - Java: [1.8.0_352]
- - OS: [Mac OS X 12.6.2]
+* Version: [Elemental 6.3.1]
+* Java: [1.8.0_352]
+* OS: [macOS X 12.6.2]
 
 **Additional context**
-- How is eXist-db installed? [e.g. JAR installer, DMG, … ]
-- Any custom changes in e.g. `conf.xml`?
+
+* How is Elemental installed? [e.g. JAR installer, DMG, … ]
+* Any custom changes in e.g. `conf.xml`?

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,19 +1,19 @@
-Thank you for your contribution to eXist-db! 
+Thank you for contributing to Elemental! 
 
-To help the community judge your pull request (PR), please include the following:
+To help the community judge your PR (Pull Request), please include the following:
 
-- A (short) description of the content of changes.
-- 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/).
-- 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.
+- A (short) description of the content of your changes.
+- 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/).
+- 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`.
 
-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. 
+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. 
 
-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`.
+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`.
 
 ------
 
 ### Description:
 
 ### Reference:
 
-### Type of tests:
+### Tests:

.github/opencollective.yml

@@ -164,7 +164,7 @@
         - minDiskSpace:
             The amount of disk space (in megabytes) which should be available for
             the database to continue operations. If free disk space goes below
-            the configured limit, eXist-db will flush all buffers to disk and
+            the configured limit, Elemental will flush all buffers to disk and
             switch to read-only mode in order to prevent potential data loss. 
             Set the limit large enough to allow all pending operations to 
             complete. Set to -1 to disable. The default is 1 gigabyte.

exist-ant/src/test/resources-filtered/conf.xml

@@ -738,7 +738,7 @@ throws PermissionDeniedException, EXistException, XPathException
                 throw xpe;
             }
             // We ought to do this for now until Dannes can say it works. /ljo
-            //throw new XPathException(s, ErrorCodes.XQST0009, "The eXist-db XQuery implementation does not support the Schema Import Feature quite yet.");
+            //throw new XPathException(s, ErrorCodes.XQST0009, "The XQuery implementation does not support the Schema Import Feature quite yet.");
         }
     )
     ;

exist-core/src/main/antlr/org/exist/xquery/parser/XQueryTree.g

@@ -85,7 +85,9 @@
 import static org.exist.util.FileUtils.humanSize;
 
 /**
- * Main frame of the eXist GUI
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
+ *
+ * Main frame of the Elemental Java Admin client GUI
  */
 public class ClientFrame extends JFrame implements WindowFocusListener, KeyListener, ActionListener, MouseListener {
 
@@ -130,7 +132,7 @@ public class ClientFrame extends JFrame implements WindowFocusListener, KeyListe
     /**
      * Constructor.
      *
-     * @param client Existdb client
+     * @param client Elemental client
      * @param path Database connection URL.
      * @param properties Configuration items.
      * @throws java.awt.HeadlessException Environment  does not support a keyboard, display, or mouse.
@@ -143,7 +145,7 @@ public ClientFrame(final InteractiveClient client, final XmldbURI path, final Pr
         this.processRunnable = new ProcessRunnable();
         this.processThread = client.newClientThread("process", processRunnable);
 
-        this.setIconImage(InteractiveClient.getExistIcon(getClass()).getImage());
+        this.setIconImage(InteractiveClient.getElementalIcon(getClass()).getImage());
 
         setupComponents();
         addWindowListener(new WindowAdapter() {
@@ -1724,7 +1726,7 @@ protected static Properties getLoginData(final Properties props) {
 
         final ConnectionDialog connectionDialog = new ConnectionDialog(null, true, defaultConnectionSettings, Boolean.parseBoolean(props.getProperty(InteractiveClient.LOCAL_MODE, InteractiveClient.LOCAL_MODE_DEFAULT)), Boolean.parseBoolean(props.getProperty(InteractiveClient.NO_EMBED_MODE, InteractiveClient.NO_EMBED_MODE_DEFAULT)));
 
-        connectionDialog.setTitle(SystemProperties.getInstance().getSystemProperty("product-name", "eXist-db") + " " + SystemProperties.getInstance().getSystemProperty("product-version", "unknown") + " Database Login");
+        connectionDialog.setTitle(SystemProperties.getInstance().getSystemProperty("product-name", "Elemental") + " " + SystemProperties.getInstance().getSystemProperty("product-version", "unknown") + " Database Login");
 
         connectionDialog.addDialogCompleteWithResponseCallback(connection -> {
             properties.setProperty(InteractiveClient.USER, connection.getUsername());

exist-core/src/main/java/org/exist/client/ClientFrame.java

@@ -72,7 +72,7 @@ public ConnectionDialog(final java.awt.Frame parent, final boolean modal, final
         this.defaultConnectionSettings = defaultConnectionSettings;
         this.config = Paths.get(defaultConnectionSettings.getConfiguration());
         this.disableEmbeddedConnectionType = disableEmbeddedConnectionType;
-        this.setIconImage(InteractiveClient.getExistIcon(getClass()).getImage());
+        this.setIconImage(InteractiveClient.getElementalIcon(getClass()).getImage());
         initComponents();
 
         if (disableEmbeddedConnectionType) {
@@ -240,7 +240,7 @@ protected final void paintTabBorder(final java.awt.Graphics g, final int tabPlac
         setDefaultCloseOperation(javax.swing.WindowConstants.DISPOSE_ON_CLOSE);
         setTitle("Database Connection");
 
-        lblExistLogo.setIcon(InteractiveClient.getExistIcon(getClass()));
+        lblExistLogo.setIcon(InteractiveClient.getElementalIcon(getClass()));
 
         lblUsername.setText(getLabelText("LoginPanel.2"));
 

exist-core/src/main/java/org/exist/client/ConnectionDialog.java

@@ -25,8 +25,6 @@
 import java.awt.Cursor;
 import java.awt.Dimension;
 import java.awt.Toolkit;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
 import java.awt.event.KeyEvent;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
@@ -75,8 +73,9 @@
 import org.xmldb.api.base.XMLDBException;
 import org.xmldb.api.modules.XMLResource;
 
-import static java.nio.charset.StandardCharsets.UTF_8;
-
+/**
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
+ */
 class DocumentView extends JFrame {
 
     private static final long serialVersionUID = 1L;
@@ -101,7 +100,7 @@ public DocumentView(InteractiveClient client, XmldbURI resourceName, Resource re
         this.resourceName = resourceName;
         this.resource = resource;
         this.client = client;
-        this.setIconImage(InteractiveClient.getExistIcon(getClass()).getImage());
+        this.setIconImage(InteractiveClient.getElementalIcon(getClass()).getImage());
         this.collection = client.getCollection();
         this.properties = properties;
         getContentPane().setLayout(new BorderLayout());

exist-core/src/main/java/org/exist/client/DocumentView.java

@@ -33,8 +33,6 @@
 import javax.swing.table.TableCellRenderer;
 import javax.swing.table.TableColumn;
 import java.awt.*;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.awt.event.WindowListener;
@@ -43,9 +41,7 @@
 /**
  * Dialog for viewing and editing Indexes in the Admin Client 
  * 
- * @author <a href="mailto:[email protected]">Adam Retter</a>
- * @serial 2006-03-12
- * @version 1.0
+ * @author <a href="mailto:[email protected]">Adam Retter</a>
  */
 class IndexDialog extends JFrame {
 
@@ -77,7 +73,7 @@ public IndexDialog(String title, InteractiveClient client)
 	{
 		super(title);
 		this.client = client;
-        this.setIconImage(InteractiveClient.getExistIcon(getClass()).getImage());		
+        this.setIconImage(InteractiveClient.getElementalIcon(getClass()).getImage());
 		//capture the frame's close event
 		final WindowListener windowListener = new WindowAdapter()
 		{