Project

Profile

Help

Bug #6121

closed

Search field in static HTML Javadoc pages returns results whose links all 404.

Added by Martin Honnen 9 months ago. Updated 4 months ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Sprint/Milestone:
-
Start date:
2023-07-07
Due date:
% Done:

100%

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

Description

In Google Chrome, when I browse https://www.saxonica.com/html/documentation12/javadoc/index.html and use the Search field for e.g. ResourceResolver, various options are shown in a dropdown list e.g. net.sf.saxon.lib.ResourceResolver, but when clicking an entry in the list I am taken to e.g. https://www.saxonica.com/html/documentation12/javadoc/undefined/net/sf/saxon/lib/ResourceResolver.html which gives a 404.

The undefined/ part doesn't seem to belong there in the URL so if I remove that I get the documentation I am looking for.

In the long run it is rather tedious to first get a 404 to have to edit the URL so I hope you can fix the documentation to produce a directly workable link/URL.

Actions #1

Updated by Norm Tovey-Walsh 9 months ago

In Google Chrome, when I browse
https://www.saxonica.com/html/documentation12/javadoc/index.html and use the Search field for
e.g. ResourceResolver, various options are shown in a dropdown list e.g.
net.sf.saxon.lib.ResourceResolver, but when clicking an entry in the list I am taken to e.g.
https://www.saxonica.com/html/documentation12/javadoc/undefined/net/sf/saxon/lib/ResourceResolver.html which
gives a 404.

The undefined/ part doesn't seem to belong there in the URL so if I remove that I get the
documentation I am looking for.

In the long run it is rather tedious to first get a 404 to have to edit the URL so I hope you can
fix the documentation to produce a directly workable link/URL.

Indeed. I don’t think that’s our code. I think that’s just the output
from JavaDoc. I wonder what bit we’ve got configured incorrectly…

Be seeing you,
norm

--
Norm Tovey-Walsh
Saxonica

Actions #2

Updated by Michael Kay 8 months ago

  • Assignee set to Debbie Lockett
Actions #3

Updated by Norm Tovey-Walsh 5 months ago

  • Assignee changed from Debbie Lockett to Matt Patterson

This does look broken. Unclear how it's supposed to work. Will see what we can do.

Actions #4

Updated by Matt Patterson 5 months ago

Having investigated, it seems like this is due to a bug in Javadoc, starting with the version shipped with JDK 9, and possibly fixed with JDK 12.

I need to verify this is the (or the only) problem, but if it is, the problem seems to lie in a single JavaScript file used by Javadoc’s search, which we should be able to patch without having to update to a more recent JDK.

Actions #5

Updated by Matt Patterson 5 months ago

  • Subject changed from Search field in https://www.saxonica.com/html/documentation12/javadoc/index.html produces 404 to Search field in static HTML Javadoc pages returns results whose links all 404.
  • Applies to branch 10, 11, 12 added

After more digging and checking I can verify that our problem is that we're using a version of Javadoc (tied to the JDK version we're using) that generates broken search links for code/projects which do not use Java 9+ modules.

As a result, the Saxon 10 and Saxon 11 javadoc all have the same problem.

This was fixed by the OpenJDK project for JDK 12, and has been backported to JDK 11.0.17+, so we can upgrade to a more recent JDK 11 and fix this.

Actions #6

Updated by Matt Patterson 5 months ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

Debbie regenerated the Javadoc using a recent JDK 11 version and the fixed version of the search.js has been deployed for the 10, 11, and 12 Javadoc static HTML, and we have verified the fix. You may need to clear your browser cache if you have loaded the static Javadoc recently.

Actions #7

Updated by Martin Honnen 5 months ago

Thanks for the fix, Matt (and Debbie), works great.

Actions #8

Updated by O'Neil Delpratt 4 months ago

  • Status changed from Resolved to Closed
  • Fixed in Maintenance Release 12.4 added

Please register to edit this issue

Also available in: Atom PDF