|
Quick Lists
|
|
Bug ID:
|
4034096
|
|
Votes
|
1
|
|
Synopsis
|
stddoclet: Add support for HTML keywords via META tag for class names
|
|
Category
|
doclet:tbd
|
|
Reported Against
|
1.1
, merlin-rc1
|
|
Release Fixed
|
1.4.1(hopper)
|
|
State
|
10-Fix Delivered,
request for enhancement
|
|
Priority:
|
5-Very Low
|
|
Related Bugs
|
4137321
,
4638103
|
|
Submit Date
|
24-FEB-1997
|
|
Description
|
The <META NAME="Keywords" CONTENT="keyword1,keyword2,..."> HTML markup creates a
list of keywords that can be accessed using the search feature of certain
browsers and other software tools. It also is used by most Internet search
engines.
By adding an option to specify the <META> tag to javadoc's generated HTML, it
may be possible to search and index the API documentation more efficiently than
at present. Of course, there will need to be some thought put into what the
CONTENT parameter should contain.
Using the other forms of the META tag in the <HEAD></HEAD> section may be
beneficial, as well.
|
|
Work Around
|
N/A
|
|
Evaluation
|
If JavaHelp takes advantage of META tags, we should definitely include this.
If not, we should consider whether it's useful for NetHelp and WinHelp.
It probably is worth doing, especially if it speeds up searches for anyone.
xxxxx@xxxxx 1997-10-07
Eduardo Pelegri-Llopart says:
The keywords in JavaHelp are generated by the authoring tool: the
javahelp doclet for the case when we generate the javahelp data
from javadoc. Since we don't look at the javadoc-generated pages,
a <META> tag would not help us.
I wrote up a suggested fix of including just the class name, both
abbreviated and fully-qualified. This would be useful to someone
writing an search applet to search through the API.
xxxxx@xxxxx 1998-04-06
> Email to Bruce Miller in Martin Hardee's group: (Sept 3, 1998)
> We had an RFE against javadoc to include meta tags, but
> with the little research we did could not find any rules about
> what to put there or reason to do so. We could add this
> in 1.2.1 if you give some justification to the RFE.
> If you send me the justification, I'll re-open the RFE
> and add it to it.
Reply by Bruce Miller:
You could just use the tags that I have added to the current pages. The
reason/justification is that they will help your standings in some search
engines, may help in others, and will hurt in none of them.
Further info can be found at:
http://searchenginewatch.internet.com/webmasters/meta.html
-------
xxxxx@xxxxx -1998-09-03
If we add this, it must work for third parties who run javadoc.
See the "Suggested Fix" for the exact <META> tags.
It would probably be better to have a command-line option
than for javadoc to auto-generate these tags. Something like:
javadoc -meta "NAME=\"Keywords\" CONTENT=\"keyword1,keyword2\""
though it also needs to specify on which pages this option
applies to, and the keywords need to be variables (so the
class changes from page to page, for instance).
xxxxx@xxxxx 1998-12-15
If we can get this into 1.4.1, then the Sun search results will
be much more useful, and we can add a Search link to
the generated API docs.
xxxxx@xxxxx 2002-04-02
The Sun <META> tag guidelines are at:
http://www.sun.com/smrc/web/specs/metaguides.html
It seems the best thing would be to add keywords:
For class p1.C1
<META NAME="keywords" CONTENT="p1.C1,C1 class">"
For package p1
<META NAME="keywords" CONTENT="p1 package">"
For Overview
<META NAME="keywords" CONTENT="Overview,Sample Packages">
Fixed in hopper
xxxxx@xxxxx 2002-04-22
Also see the follow-up RFE integrated in 1.4.2:
4764726 stddoclet: Add member names as meta keyword tags to improve API search
xxxxx@xxxxx 2002-11-21
|
|
Comments
|
Submitted On 25-OCT-2001
davidtribble
It would also be very nice if javadoc supported tags of the format:
{@meta name="content"}
Such tags would only be allowed in the javadoc comment preceding the class
definition in a given source file, and would end up being placed in the <head>
portion of the generated HTML file.
My suggested syntax above is similar to the existing syntax for '{@link}'
tags, so it shouldn't be too surprising for programmers.
PLEASE NOTE: JDK6 is formerly known as Project Mustang
|
|
|
|
