Project

Profile

Help

Bug #4484

Documentation of fn:collection()

Added by Michael Kay 10 months ago. Updated 5 months ago.

Status:
In Progress
Priority:
Low
Category:
Documentation
Sprint/Milestone:
-
Start date:
2020-03-19
Due date:
% Done:

100%

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

Description

The status section of the documentation for fn:collection() (in the Function Library chapter) refers to the old CollectionURIResolver interface, which is deprecated in 9.9 and withdrawn in 10.0. It should be updated to refer to the new CollectionFinder.

History

#1 Updated by Debbie Lockett 10 months ago

  • Status changed from New to Resolved

Committed updates to Function Library documentation for fn:collection() and fn:uri-collection(). Plus further related edits under sourcedocs/collections and extensibility/config-extend/uri-resolution/collection-uri-resolver. In particular, "Writing your own Collection Finder" is moved to a subsection of "Collections" (i.e. sourcedocs/collections/user-collections).

#2 Updated by Debbie Lockett 10 months ago

  • Status changed from Resolved to In Progress

Online 10 documentation (XML and HTML versions) updated.

I need to make the relevant changes in 9.9 too.

#3 Updated by Debbie Lockett 10 months ago

  • Status changed from In Progress to Closed
  • Fix Committed on Branch 10, 9.9 added

Relevant content changes also now made and committed in 9.9 documentation, for the following pages:

  • extensibility/config-extend/uri-resolution/collection-uri-resolver
  • functions/fn/collection, uri-collection
  • sourcedocs/collections

(I didn't bother with the subsection changes in sourcedocs/collections for the 9.9 branch. Section restructuring is a bit disruptive.)

Online 9.9 documentation (XML and HTML versions) updated, so now marking as closed.

#4 Updated by Debbie Lockett 10 months ago

  • Assignee changed from Michael Kay to Debbie Lockett
  • % Done changed from 0 to 100

#5 Updated by Michael Kay 10 months ago

  • Status changed from Closed to In Progress

One more: I notice that the last section in http://www.saxonica.com/documentation/index.html#!sourcedocs/collections says

On the .NET product there is another way to use a collection URI (provided that you use the API rather than the command line): you can register a collection using the Processor.RegisterCollection method on the Saxon.Api.Processor class.

In fact the Java product now also has Collection.registerCollection() - though for some reason it's not exposed at the s9api Processor level. This only works if the standard CollectionFinder is used. Also, I see, it isn't tested - I'll add a unit test.

#6 Updated by Debbie Lockett 5 months ago

Mike, re #note-5 - for Java, are you referring to the method Configuration.registerCollection() or StandardCollectionFinder.registerCollection()? Is the comment about only working with the standard CollectionFinder only relevant to Java, or to .NET too? i.e. is changing to the following correct?

When using the API rather than the command line, another way to use a collection URI is to register the collection. On the .NET platform, you can register a collection using the Processor.RegisterCollection method on the Saxon.Api.Processor class. On Java, you can use StandardCollectionFinder.registerCollection(); this only works if the standard CollectionFinder is used.

Please register to edit this issue

Also available in: Atom PDF