JDK-4034096 : stddoclet: Add support for HTML keywords via META tag for class names
  • Type: Enhancement
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.1,1.4.0
  • Priority: P5
  • Status: Resolved
  • Resolution: Fixed
  • OS: generic,solaris_2.5.1
  • CPU: generic
  • Submitted: 1997-02-24
  • Updated: 2014-05-05
  • Resolved: 2002-04-25
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
1.4.1 hopperFixed
Related Reports
Duplicate :  
JDK-4638103 - stddoclet: Automatically add useful info in tags
Relates :  
JDK-4137321 - i18n: javadoc should generate META charset tag for cross-platform viewing
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.
Comments
CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: hopper FIXED IN: hopper INTEGRATED IN: hopper
14-06-2004
SUGGESTED FIX Need to think about what the option should look like. Could add an option (and allow multiple uses of it): -meta "name" "content" But this doesn't specify which page it is to appear on, nor does it allow for the class name to change according to the page. NEEDS MORE THOUGHT... In any case, it would insert a <META> tag to the <HEAD> section of each overview, package, class and interface file. It should contain the name (package, class, interface), both shortened and fully-qualified. (The overview could contain the title of the document.) For example, for the Button class: <HEAD> <META NAME="KeyWords" CONTENT="Button, java.awt.Button"> </HEAD> ------------- Suggested fix from Bruce Miller. Bruce added the following to jdk/1.1/docs/api/packages.html (which later got overwritten): <META name="description" content="Sun Microsystems Java Platform v1.1.6 Core API Specification -- Index of packages"> <META name="keywords" content="JDK, Java Development Kit, Developer Kit, 1.1, 1.1.6, Java Platform, Core API specification, package index, packages, java., applet, awt, beans, io, lang, math, net, rmi, security, sgl, text, util">
11-06-2004
PUBLIC COMMENTS
10-06-2004
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. doug.kramer@Eng 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. doug.kramer@Eng 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 ------- dkramer@eng-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). doug.kramer@Eng 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. ###@###.### 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 ###@###.### 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 ###@###.### 2002-11-21
22-04-2002