Project

Profile

Help

Actions
Send by e-mail Copy link

Bug #5947

closed

Review the XQuery extensions documentation

Added by Debbie Lockett about 1 year ago. Updated about 1 year ago.

Status:
Closed
Priority:
Low
Assignee:
Debbie Lockett
Category:
Documentation
Sprint/Milestone:
-
Start date:
2023-03-31
Due date:
% Done:

0%

Estimated time:
Legacy ID:
Applies to branch:
10, 11, 12, trunk
Fix Committed on Branch:
Fixed in Maintenance Release:
Platforms:

Description

The "Using XQuery" section of the documentation contains subsections on Extensibility and Extensions. These sections could definitely be improved.

Firstly there is duplication of information about XQuery extensions on these pages, which is confusing.

Also the information is out of date:

  • declare option saxon:default is still listed, though it was dropped in Saxon 9.6.
  • declare option saxon:allow-cycles is listed, though it was effectively dropped from Saxon 9.8 when support for XQuery 1.0 was removed. (Referring to the implementation in XQueryParser.parseOptionDeclaration, reveals that it is ignored, with a warning "Value of saxon:allow-cycles is ignored".)

We should also clarify which Saxon edition these extensions are available in. Referring to the implementations in XQueryParser it looks like:

  • declare option saxon:output is available in all editions
  • declare option saxon:memo-function requires PE or EE
  • the saxon:validate-type pragma requires EE
Actions
Copy link
 #1

Updated by Debbie Lockett about 1 year ago

Additionally, from Saxon 11.2 a syntax extension for XQuery FLWOR expressions is provided: a new trace clause can be used to assist diagnostics.

This is documented in the Changes section (https://www.saxonica.com/documentation12/index.html#!changes/extensions/11-11.1), but not documented elsewhere (not in either "Using XQuery" or "Extensions").

(It doesn't look like this has been included in the 4.0 proposal so far.)

Actions
Copy link
 #2

Updated by Debbie Lockett about 1 year ago

Changes committed on saxon10, saxon11, saxon12, and main branches:

  • Tidied up the "Using XQuery" section ("Extensibility" and "Extensions" subsections)
  • Updated content to remove saxon:default, and saxon:allow-cycles
  • Added note in changes/extensions/9.7-9.8 to clarify that saxon:allow-cycles is now ignored

Furthermore, on the saxon11, saxon12 and main branches:

  • I have actually moved the details about XQuery extensions from "Using XQuery" to "Extensions", since I think that's a better place for them.
  • Added documentation for the FLWOR expression trace clause extension at extensions/xquery-syntax/trace

I am not intending to update the documentation for older versions of Saxon (9.9 and 9.8) though.

Actions
Copy link
 #3

Updated by Debbie Lockett about 1 year ago

  • Status changed from New to Closed
  • Applies to branch 10, 11, 12, trunk added

Documentation updated online for Saxon 10, 11 and 12 (XML and HTML versions).

Please register to edit this issue

Actions
Send by e-mail Copy link

Also available in: Atom PDF