Quick Start: XQuery for jEdit — Setup & First Queries

Lightweight XML Editing: Using XQuery Effectively in jEdit

Why choose jEdit for XML and XQuery

jEdit is a lightweight, extensible text editor well suited for XML editing when you want speed, low resource use, and full control. Combined with XQuery — a concise, powerful language for querying and transforming XML — jEdit becomes a capable environment for ad-hoc XML processing, quick transformations, and development workflows that don’t require a full IDE.

Essential plugins and setup

• Plugin Manager: Install via Plugins → Plugin Manager.
• XML/DTD/RELAX NG support: Install the XML plugin (provides folding, tag matching, and validation helpers).
• XQuery support: Install the ScriptShell or Console plugin to run external tools; use the External Tools plugin to call an XQuery processor like Saxon or BaseX.
• Filetype and syntax highlighting: Ensure XML and XQuery files use correct modes (Edit → Global Options → File Types).
• Auto-indent and tag completion: Use the XML plugin’s options and the Sidekick plugin for structure navigation.

Choosing an XQuery processor

• Saxon HE: Widely used, supports XQuery 3.1 (use Saxon-HE jar).
• BaseX: Lightweight XML database with a fast XQuery engine and a REST API.
• eXist-db: If you need a full XML database and web application support.

Install the chosen processor locally (download the jar or server), then configure jEdit’s External Tools or Console to run queries against your current buffer or selected text.

Running XQuery from jEdit

1. Save your XML file and XQuery script in the project folder.
2. Configure an External Tool command, for example (Saxon HE):

   Code
   Copy CodeCopied
   java -jar /path/to/saxon-he.jar -s:\({file} -q:\){project-dir}/query.xq -o:${project-dir}/output.xml 

3. Bind the tool to a keyboard shortcut for quick runs.
4. Alternatively, pipe selected XML to BaseX or Saxon via Console for iterative testing.

Useful workflows and tips

• Ad-hoc transformations: Keep small .xq scripts in a queries/ folder and invoke them against open files.
• Selected-text querying: Configure a command that reads from clipboard or selection so you can run queries on fragments without saving.
• Reusable modules: Store common XQuery functions in a modules/ directory and import them using module namespace URIs (adjust file paths in your processor’s module path).
• Error handling: Direct processor stderr to a jEdit console buffer to see line numbers and stack traces; enable XML validation to catch well-formedness issues before running queries.
• Pretty-printing output: Pipe results through an XML formatter (e.g., xmllint –format) or use Saxon’s serialization options to get readable output.
• Version control: Use Git integration plugins or run git from Console to track query and XML changes.

Short examples

• Run a simple query (Saxon example):

  Code
  Copy CodeCopied
  java -jar saxon-he.jar -s:books.xml -q:count-books.xq -o:result.xml 

  count-books.xq:

  Code
  Copy CodeCopied
  count(/catalog/book) 

• Import a module:

  Code
  Copy CodeCopied
  module namespace utils = “http://example.com/utils”; import module namespace utils = “http://example.com/utils” at “modules/utils.xqm”; 

When to move beyond jEdit

Use jEdit + XQuery when you need a fast, low-overhead editor for editing XML and running queries. Move to BaseX, eXist-db, or an IDE when you need integrated debugging, large-scale database features, or heavy project management support.

Quick checklist before running queries

• Save files (or configure selection-based commands).
• Ensure your XQuery processor is installed and reachable.
• Set module paths and working directory.
• Redirect stderr to view errors.
• Validate XML if queries fail unexpectedly.

Keep jEdit lightweight by limiting plugins to essentials and scripting your common XQuery commands — this yields a nimble, effective XML editing and querying setup.