Integrating IntelliJ IDEA - Revision history

CG at 09:15, 25 July 2022

2022-07-25T09:15:34Z

CG: Text replacement - "db:pre(" to "db:get("

2022-07-20T11:33:18Z

Text replacement - "db:pre(" to "db:get("

CG: Text replacement - "db:open" to "db:pre"

2022-07-19T18:54:41Z

Text replacement - "db:open" to "db:pre"

CG: Text replacement - "[http://basex.org/" to "[https://basex.org/"

2020-07-02T10:51:25Z

Text replacement - "[http://basex.org/" to "[https://basex.org/"

Sabine Teubner at 09:13, 21 August 2019

2019-08-21T09:13:32Z

Sabine Teubner at 09:03, 21 August 2019

2019-08-21T09:03:53Z

Sabine Teubner at 10:15, 7 May 2019

2019-05-07T10:15:50Z

Sabine Teubner at 10:15, 7 May 2019

2019-05-07T10:15:37Z

Sabine Teubner at 09:45, 7 May 2019

2019-05-07T09:45:11Z

Sabine Teubner at 08:37, 7 May 2019

2019-05-07T08:37:29Z

@@ Line 73: / Line 73: @@
 ** <code>Database port = 1984</code>
 ** <code>Username = admin</code>
-** <code>Password = admin</code>
+** <code>Password = ...</code>
 ** If you tick the check box ''Create a standalone instance'', the fields ''Hostname'', ''Database port'', ''Username'', and ''Password'' remain empty.
 [[File:Intellij-new-query-processor.png]]
@@ Line 167: / Line 167: @@
 ** <code>Database name = factbook</code>
 ** <code>Username = admin</code>
-** <code>Password = admin</code>
+** <code>Password = ...</code>
 * Select ''Apply'', then ''OK'' and your BaseX {{code|factbook}} database is ready to query.

@@ Line 83: / Line 83: @@
 '''Create a Query File'''
 * In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''File'' or by selecting ''New''→''File'' from the File menu. Enter a file name and click ''OK''.
-* Type in your query, e.g. <code>db:pre("factbook")</code>, and save your file.
+* Type in your query, e.g. <code>db:get("factbook")</code>, and save your file.
 '''Create a New Configuration'''

@@ Line 83: / Line 83: @@
 '''Create a Query File'''
 * In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''File'' or by selecting ''New''→''File'' from the File menu. Enter a file name and click ''OK''.
-* Type in your query, e.g. <code>db:open("factbook")</code>, and save your file.
+* Type in your query, e.g. <code>db:pre("factbook")</code>, and save your file.
 '''Create a New Configuration'''

@@ Line 11: / Line 11: @@
 * Install either version of IntelliJ IDEA: [https://www.jetbrains.com/idea/#chooseYourEdition the Community or Ultimate edition].
-* Download your favorite [http://basex.org/download BaseX distribution] (JAR, ZIP, EXE).
+* Download your favorite [https://basex.org/download BaseX distribution] (JAR, ZIP, EXE).
 * Start BaseX (see [[Startup]]).
 * Create a BaseX database (see [[Databases]]).

@@ Line 103: / Line 103: @@
 ==Conclusion==
 The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML, code completion and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX.
 The plugin contains some minor flaws regarding the use of functions declared in user-defined modules. Such functions are not included in the code completion list and marked as unknown in the code. However, query execution in the BaseX backend works fine nonetheless.

@@ Line 67: / Line 67: @@
 * In the ''Manage Query Processors'' dialog, click on the {{Code|+}} button.
 * In the ''New Query Processor Instance'' dialog, set the following preferences:
-** <code>Name = BaseX</code> (optional; if you leave this field blank, <code>[Implementation] [Version]</code> will be used as name)
+** <code>Description = BaseX</code> (optional; if you leave this field blank, <code>[Implementation] [Version]</code> will be used as description)
 ** <code>Implementation = BaseX</code> (should be preset!)
 ** <code>JAR File = BaseX.jar</code> (name and location of the JAR file may differ depending on your BaseX distribution and version)
@@ Line 103: / Line 103: @@
 ==Conclusion==
-The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX.
+The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML, code completion and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX.
-The plugin contains some minor flaws regarding the static binding of BaseX namespaces. A few namespaces are marked as unknown in the code, however, query execution in the BaseX backend works fine in spite of them. Also, the IntelliJ ''Find Usages'' and ''Go To'' options did not work as expected in some cases, especially with regard to functions and across modules. The plugin does not yet include a code completion feature.
+The plugin contains some minor flaws regarding the use of functions declared in user-defined modules. Such functions are not included in the code completion list and marked as unknown in the code. However, query execution in the BaseX backend works fine nonetheless.
 =XQuery Support Plugin=

@@ Line 3: / Line 3: @@
 * The [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin] by Reece H. Dunn.
 * The [https://plugins.jetbrains.com/plugin/7262-xquery-support XQuery Support] plugin by Grzegorz Ligas.
-* Both plugins offer support for XQuery 3.1 and can be run as a client or standalone instance. Please note, that the two plugins are mutually exclusive and cannot be activated at the same time in IntelliJ.
+* Both plugins offer support for XQuery 3.1 and can be run as a client or standalone instance. Please note that the two plugins are mutually exclusive and cannot be activated at the same time in IntelliJ.
 * '''Note:''' BaseX itself is a highly compliant XQuery 3.1 processor. We strongly encourage you to use the [[Graphical_User_Interface#Text_Editor|XML editor]] integrated into the BaseX GUI to edit and query your XML data!<br/><br/>

@@ Line 18: / Line 18: @@
 This section focuses on Reece H. Dunn's [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin].
 ==Installation==
@@ Line 106: / Line 100: @@
 * If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
 * Click the ''Run'' button to execute your query.
 =XQuery Support Plugin=
@@ Line 200: / Line 202: @@
 * Now, the configuration should be set and the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
 [[File:Intellij-run-button.png]]
 '''Execute Your Query'''
 * If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
 * Click the ''Run'' button to execute your query.

@@ Line 23: / Line 23: @@
 The plugin contains some minor flaws regarding the static binding of BaseX namespaces. A few namespaces are marked as unknown in the code, however, query execution in the BaseX backend works fine in spite of them. Also, the IntelliJ ''Find Usages'' and ''Go To'' options did not work as expected in some cases, especially with regard to functions and across modules. The plugin does not yet include a code completion feature.
-Usage of functions from imported or declared namespaces that do not exist in the namespace might not be marked as unknown. To highlight invalid functions, you may enable the ''XPath and XQuery > XPST: XPath static errors > XPST0017: Undefined function'' inspection in the ''Editor > Inspections'' section.
+Note that the usage of functions from imported or declared namespaces that do not exist in the namespace might not be marked as unknown. To highlight invalid functions, you may enable the ''XPath and XQuery > XPST: XPath static errors > XPST0017: Undefined function'' inspection in the ''Editor > Inspections'' section.
 ==Installation==