[jira] Issue Comment Edited: (LUCENE-1444) Broken javadocs->site docs links

["Steven Rowe (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LUCENE-1444?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12646666#action_12646666 ] 

steve_rowe edited comment on LUCENE-1444 at 11/11/08 1:05 PM:
---------------------------------------------------------------

After generating the site with Forrest and then copying over the generated javadocs, I found that the MemoryIndex javadoc link to queryparsersyntax.html had two too few go-up-one-level path elements.  Also, I had forgotten to change the sidebar link to the All javadocs to include the new "all" path element, in src/site/src/documentation/content/xdocs/site.xml.

This version fixes these two issues.

      was (Author: steve_rowe):
    After generating the site with Forrest and then copying over the generated javadocs, I found that the MemoryIndex javadoc link to queryparsersyntax.html had two too few go-up-one-level path elements.  Also, I had forgetten to change the sidebar link to the All javadocs to include the new "all" path element, in src/site/src/documentation/content/xdocs/site.xml.

This version fixes these two issues.
  
> Broken javadocs->site docs links
> --------------------------------
>
>                 Key: LUCENE-1444
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1444
>             Project: Lucene - Java
>          Issue Type: Bug
>          Components: Javadocs
>    Affects Versions: 2.4
>            Reporter: Steven Rowe
>            Priority: Minor
>             Fix For: 2.9
>
>         Attachments: LUCENE-1444.patch, LUCENE-1444.patch
>
>
> See the java-dev mailing list discussion: [http://www.nabble.com/Broken-javadocs-%3Esite-docs-links-to20369092.html].
> When the Lucene Java website transitioned to versioning some of the documentation, links from some javadocs were not modified to follow the resources.  I found broken links to gettingstarted.html and queryparsersyntax.html.  Here is one example, to gettingstarted.html (the link text is "demo"): 
> [http://lucene.apache.org/java/2_4_0/api/org/apache/lucene/document/package-summary.html]
> The attached patch converts absolute URLs from javadocs to versioned docs to be relative, and modifies the "javadocs-all" target in build.xml to add a path element named "all", so that both versions of the javadocs (all: core+contrib; and separated: core, contribs) can use the same relative URLs.  Adding a path element to the "javadocs-all" target is necessary because currently the "all" javadocs have one fewer path element than the separated javadocs.
> I left as-is one absolute URL, in the o.a.l.index.SegmentInfos javadocs, to fileformats.html, because SegmentInfos is a package-private class, and the javadocs targets in build.xml only generate javadocs for public classes.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org