You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Steve Rowe (JIRA)" <ji...@apache.org> on 2016/06/13 20:37:03 UTC
[jira] [Updated] (LUCENE-7338) Broken description section links
from documentation to javadocs
[ https://issues.apache.org/jira/browse/LUCENE-7338?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Steve Rowe updated LUCENE-7338:
-------------------------------
Attachment: LUCENE-7338.patch
I looked for other anchor names in Lucene/Solr source with regex {{#\[a-z0-9]+_}}, but didn't find anything other than the ones I'd already spotted ({{#package_description}} and {{#overview_description}}.
This patch fixes anchor names in the Lucene site's per-release {{index.xsl}} as well a few mentions in javadocs.
Committing shortly.
> Broken description section links from documentation to javadocs
> ---------------------------------------------------------------
>
> Key: LUCENE-7338
> URL: https://issues.apache.org/jira/browse/LUCENE-7338
> Project: Lucene - Core
> Issue Type: Bug
> Components: general/javadocs
> Reporter: Steve Rowe
> Attachments: LUCENE-7338.patch
>
>
> In Lucene's top-level documentation, there are links to Description sections in Javadocs, e.g. in the Getting Started section: to the Lucene demo; to an Introduction to Lucene's APIs; and to the Analysis overview.
> All of these links are anchored at {{#overview_description}} or {{#package_description}}, but it looks like Java8 switched how these anchors are named: in the 6.0.0, 6.0.1 and now the 6.1.0 RC1 javadocs, these anchors are named with dots rather than underscores: {{#overview.description}} and {{#package.description}}. As a result, the documentation links go to the right page, but the browser stays at the top of the page because it can't find the now-misnamed anchors.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org