Project

Profile

Help

Feature #4694

Documentation for s9api Step, Predicate, etc.

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

Status:
New
Priority:
Low
Assignee:
Category:
Documentation
Sprint/Milestone:
-
Start date:
2020-08-25
Due date:
% Done:

0%

Estimated time:
Legacy ID:
Applies to branch:
10
Fix Committed on Branch:
Fixed in Maintenance Release:

Description

It would be good to add more in the documentation about the s9api interface mechanisms for navigating XML documents using Java Streams (which was new in 9.9). i.e. the s9api classes Step, Predicate, etc. (These are also going to be available in the .NET API in Saxon 10.)

There is a good section of information in the change log, under 9.9 changes in the S9API interface (see "Navigating XML Documents Using s9api" at http://www.saxonica.com/documentation/index.html#!changes/s9api/9.8-9.9); but information only in the change log can easily get buried. There is a brief mention under xpath-api/xdm-values, and the javadoc comments are also fairly good (e.g. they provide a few examples); but further details, and examples, in another section of the documentation would be useful for new users.

History

#1 Updated by Michael Kay about 1 month ago

Yes, indeed - especially we need more prominence for this, and more examples. I've been wondering where it should go: I think we really need a chapter devoted to the Java API, and probably another devoted to the .NET API (perhaps they can be single-sourced?), which should perhaps pull in information from some of the other chapters. The overall structure has become a bit fossilised. And it could do with much better navigation aids.

Please register to edit this issue

Also available in: Atom PDF