RFR: JDK-8248863: Add search landing page to API documentation [v3]

liach duke at openjdk.java.net
Thu Apr 21 03:35:26 UTC 2022


On Tue, 19 Apr 2022 21:04:04 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> This is the second of two PRs to enhance JavaDoc search, it is based on the first one (#8185).
>> 
>> It adds a standalone search page (search.html) along with its own script file (search-page.js). This PR is very similar to the last prototype I uploaded and demoed, the changes are mostly tweaks to the markup, style sheets and text. 
>> 
>> JDK API docs rendered with this patch can be viewed and tested here (top-level files only, updated on April 20th):
>> http://cr.openjdk.java.net/~hannesw/8248863/api.02/
>> http://cr.openjdk.java.net/~hannesw/8248863/api.02/search.html
>
> Hannes Wallnöfer has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Use different max results values for popup and page search
>  - Fix search link height

Looks good now.
For 2, I was thinking about if we have ambiguous terms for input, like `abstract`, `exact` where there are multiple best-match, we might want to go to landing page than to the top result when pressing enter. But that's optional.

In addition, I didn't notice the **SEARCH** text that led to the search page at first. Since it leads to the search page itself, would it make sense to merged the "Go to search page" with that text (which does not preserve current text in search bar) when there's something typed in the search bar?

-------------

PR: https://git.openjdk.java.net/jdk/pull/8226


More information about the javadoc-dev mailing list