Project

Profile

Help

Bug #4061

closed

Improve documentation for Saxon Java samples

Added by Debbie Lockett over 5 years ago. Updated about 5 years ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Sprint/Milestone:
-
Start date:
2018-12-06
Due date:
% Done:

100%

Estimated time:
Legacy ID:
Applies to branch:
9.7, 9.8, 9.9, trunk
Fix Committed on Branch:
9.7, 9.8, 9.9, trunk
Fixed in Maintenance Release:
Platforms:

Description

As raised on saxon-help list:

downloaded saxon-resources and followed http://www.saxonica.com/documentation/index.html#!samples/s9api

entering "java S9APIExamples" just leads to nothing, as there are only folders in samples directory.

Note that the Java samples are now subdivided for HE and EE, so firstly this should be he/S9APIExamples. Furthermore, there is no reference to the classes and jars required on the classpath. There is some general information about classpaths at about/gettingstarted/gettingstartedjava and about/installationjava/jarfiles, but it would be useful to also include it in this Samples section.

In fact, the S9APIExamples application also includes tests using JDOM2, XOM, and DOM4J, so the JAR files for these are also required on the classpath. Perhaps it would be better to put such tests in a separate sample application, so that running the main S9API examples is more straightforward.

Actions #1

Updated by Debbie Lockett about 5 years ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100
  • Applies to branch 9.7, trunk added
  • Fix Committed on Branch 9.7, 9.8, 9.9, trunk added

Decided not to make changes to the S9APIExamples sample application for current releases, but should move the tests which use the alternate object models to a separate application for Saxon 10.0. (New issue #4167 raised for this.)

The Java samples have been in separate he and ee directories since 9.7. The samples/s9api documentation page has been updated to reflect this, with added information about the external JAR files required.

Changes committed for 9.9, 9.8, and 9.7 (and trunk) documentation; and documentation updated online (XML and HTML versions).

Please register to edit this issue

Also available in: Atom PDF