aoqi@0: /* aoqi@0: * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.tools.doclets.formats.html; aoqi@0: aoqi@0: import java.io.*; aoqi@0: aoqi@0: import com.sun.tools.doclets.formats.html.markup.*; aoqi@0: import com.sun.tools.doclets.internal.toolkit.*; aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*; aoqi@0: aoqi@0: /** aoqi@0: * Generate the Help File for the generated API documentation. The help file aoqi@0: * contents are helpful for browsing the generated documentation. aoqi@0: * aoqi@0: *

This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @author Atul M Dambalkar aoqi@0: */ aoqi@0: public class HelpWriter extends HtmlDocletWriter { aoqi@0: aoqi@0: /** aoqi@0: * Constructor to construct HelpWriter object. aoqi@0: * @param filename File to be generated. aoqi@0: */ aoqi@0: public HelpWriter(ConfigurationImpl configuration, aoqi@0: DocPath filename) throws IOException { aoqi@0: super(configuration, filename); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Construct the HelpWriter object and then use it to generate the help aoqi@0: * file. The name of the generated file is "help-doc.html". The help file aoqi@0: * will get generated if and only if "-helpfile" and "-nohelp" is not used aoqi@0: * on the command line. aoqi@0: * @throws DocletAbortException aoqi@0: */ aoqi@0: public static void generate(ConfigurationImpl configuration) { aoqi@0: HelpWriter helpgen; aoqi@0: DocPath filename = DocPath.empty; aoqi@0: try { aoqi@0: filename = DocPaths.HELP_DOC; aoqi@0: helpgen = new HelpWriter(configuration, filename); aoqi@0: helpgen.generateHelpFile(); aoqi@0: helpgen.close(); aoqi@0: } catch (IOException exc) { aoqi@0: configuration.standardmessage.error( aoqi@0: "doclet.exception_encountered", aoqi@0: exc.toString(), filename); aoqi@0: throw new DocletAbortException(exc); aoqi@0: } aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Generate the help file contents. aoqi@0: */ aoqi@0: protected void generateHelpFile() throws IOException { aoqi@0: String title = configuration.getText("doclet.Window_Help_title"); aoqi@0: Content body = getBody(true, getWindowTitle(title)); aoqi@0: addTop(body); aoqi@0: addNavLinks(true, body); aoqi@0: addHelpFileContents(body); aoqi@0: addNavLinks(false, body); aoqi@0: addBottom(body); aoqi@0: printHtmlDocument(null, true, body); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Add the help file contents from the resource file to the content tree. While adding the aoqi@0: * help file contents it also keeps track of user options. If "-notree" aoqi@0: * is used, then the "overview-tree.html" will not get added and hence aoqi@0: * help information also will not get added. aoqi@0: * aoqi@0: * @param contentTree the content tree to which the help file contents will be added aoqi@0: */ aoqi@0: protected void addHelpFileContents(Content contentTree) { aoqi@0: Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, false, HtmlStyle.title, aoqi@0: getResource("doclet.Help_line_1")); aoqi@0: Content div = HtmlTree.DIV(HtmlStyle.header, heading); aoqi@0: Content line2 = HtmlTree.DIV(HtmlStyle.subTitle, aoqi@0: getResource("doclet.Help_line_2")); aoqi@0: div.addContent(line2); aoqi@0: contentTree.addContent(div); aoqi@0: HtmlTree ul = new HtmlTree(HtmlTag.UL); aoqi@0: ul.addStyle(HtmlStyle.blockList); aoqi@0: if (configuration.createoverview) { aoqi@0: Content overviewHeading = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Overview")); aoqi@0: Content liOverview = HtmlTree.LI(HtmlStyle.blockList, overviewHeading); aoqi@0: Content line3 = getResource("doclet.Help_line_3", aoqi@0: getHyperLink(DocPaths.OVERVIEW_SUMMARY, aoqi@0: configuration.getText("doclet.Overview"))); aoqi@0: Content overviewPara = HtmlTree.P(line3); aoqi@0: liOverview.addContent(overviewPara); aoqi@0: ul.addContent(liOverview); aoqi@0: } aoqi@0: Content packageHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Package")); aoqi@0: Content liPackage = HtmlTree.LI(HtmlStyle.blockList, packageHead); aoqi@0: Content line4 = getResource("doclet.Help_line_4"); aoqi@0: Content packagePara = HtmlTree.P(line4); aoqi@0: liPackage.addContent(packagePara); aoqi@0: HtmlTree ulPackage = new HtmlTree(HtmlTag.UL); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Interfaces_Italic"))); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Classes"))); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Enums"))); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Exceptions"))); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Errors"))); aoqi@0: ulPackage.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.AnnotationTypes"))); aoqi@0: liPackage.addContent(ulPackage); aoqi@0: ul.addContent(liPackage); aoqi@0: Content classHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_5")); aoqi@0: Content liClass = HtmlTree.LI(HtmlStyle.blockList, classHead); aoqi@0: Content line6 = getResource("doclet.Help_line_6"); aoqi@0: Content classPara = HtmlTree.P(line6); aoqi@0: liClass.addContent(classPara); aoqi@0: HtmlTree ul1 = new HtmlTree(HtmlTag.UL); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_7"))); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_8"))); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_9"))); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_10"))); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_11"))); aoqi@0: ul1.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_12"))); aoqi@0: liClass.addContent(ul1); aoqi@0: HtmlTree ul2 = new HtmlTree(HtmlTag.UL); aoqi@0: ul2.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Nested_Class_Summary"))); aoqi@0: ul2.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Field_Summary"))); aoqi@0: ul2.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Constructor_Summary"))); aoqi@0: ul2.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Method_Summary"))); aoqi@0: liClass.addContent(ul2); aoqi@0: HtmlTree ul3 = new HtmlTree(HtmlTag.UL); aoqi@0: ul3.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Field_Detail"))); aoqi@0: ul3.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Constructor_Detail"))); aoqi@0: ul3.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Method_Detail"))); aoqi@0: liClass.addContent(ul3); aoqi@0: Content line13 = getResource("doclet.Help_line_13"); aoqi@0: Content para = HtmlTree.P(line13); aoqi@0: liClass.addContent(para); aoqi@0: ul.addContent(liClass); aoqi@0: //Annotation Types aoqi@0: Content aHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.AnnotationType")); aoqi@0: Content liAnnotation = HtmlTree.LI(HtmlStyle.blockList, aHead); aoqi@0: Content aline1 = getResource("doclet.Help_annotation_type_line_1"); aoqi@0: Content aPara = HtmlTree.P(aline1); aoqi@0: liAnnotation.addContent(aPara); aoqi@0: HtmlTree aul = new HtmlTree(HtmlTag.UL); aoqi@0: aul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_annotation_type_line_2"))); aoqi@0: aul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_annotation_type_line_3"))); aoqi@0: aul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Annotation_Type_Required_Member_Summary"))); aoqi@0: aul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Annotation_Type_Optional_Member_Summary"))); aoqi@0: aul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Annotation_Type_Member_Detail"))); aoqi@0: liAnnotation.addContent(aul); aoqi@0: ul.addContent(liAnnotation); aoqi@0: //Enums aoqi@0: Content enumHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Enum")); aoqi@0: Content liEnum = HtmlTree.LI(HtmlStyle.blockList, enumHead); aoqi@0: Content eline1 = getResource("doclet.Help_enum_line_1"); aoqi@0: Content enumPara = HtmlTree.P(eline1); aoqi@0: liEnum.addContent(enumPara); aoqi@0: HtmlTree eul = new HtmlTree(HtmlTag.UL); aoqi@0: eul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_enum_line_2"))); aoqi@0: eul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_enum_line_3"))); aoqi@0: eul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Enum_Constant_Summary"))); aoqi@0: eul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Enum_Constant_Detail"))); aoqi@0: liEnum.addContent(eul); aoqi@0: ul.addContent(liEnum); aoqi@0: if (configuration.classuse) { aoqi@0: Content useHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_14")); aoqi@0: Content liUse = HtmlTree.LI(HtmlStyle.blockList, useHead); aoqi@0: Content line15 = getResource("doclet.Help_line_15"); aoqi@0: Content usePara = HtmlTree.P(line15); aoqi@0: liUse.addContent(usePara); aoqi@0: ul.addContent(liUse); aoqi@0: } aoqi@0: if (configuration.createtree) { aoqi@0: Content treeHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_16")); aoqi@0: Content liTree = HtmlTree.LI(HtmlStyle.blockList, treeHead); aoqi@0: Content line17 = getResource("doclet.Help_line_17_with_tree_link", aoqi@0: getHyperLink(DocPaths.OVERVIEW_TREE, aoqi@0: configuration.getText("doclet.Class_Hierarchy")), aoqi@0: HtmlTree.CODE(new StringContent("java.lang.Object"))); aoqi@0: Content treePara = HtmlTree.P(line17); aoqi@0: liTree.addContent(treePara); aoqi@0: HtmlTree tul = new HtmlTree(HtmlTag.UL); aoqi@0: tul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_18"))); aoqi@0: tul.addContent(HtmlTree.LI( aoqi@0: getResource("doclet.Help_line_19"))); aoqi@0: liTree.addContent(tul); aoqi@0: ul.addContent(liTree); aoqi@0: } aoqi@0: if (!(configuration.nodeprecatedlist || aoqi@0: configuration.nodeprecated)) { aoqi@0: Content dHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Deprecated_API")); aoqi@0: Content liDeprecated = HtmlTree.LI(HtmlStyle.blockList, dHead); aoqi@0: Content line20 = getResource("doclet.Help_line_20_with_deprecated_api_link", aoqi@0: getHyperLink(DocPaths.DEPRECATED_LIST, aoqi@0: configuration.getText("doclet.Deprecated_API"))); aoqi@0: Content dPara = HtmlTree.P(line20); aoqi@0: liDeprecated.addContent(dPara); aoqi@0: ul.addContent(liDeprecated); aoqi@0: } aoqi@0: if (configuration.createindex) { aoqi@0: Content indexlink; aoqi@0: if (configuration.splitindex) { aoqi@0: indexlink = getHyperLink(DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1)), aoqi@0: configuration.getText("doclet.Index")); aoqi@0: } else { aoqi@0: indexlink = getHyperLink(DocPaths.INDEX_ALL, aoqi@0: configuration.getText("doclet.Index")); aoqi@0: } aoqi@0: Content indexHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_21")); aoqi@0: Content liIndex = HtmlTree.LI(HtmlStyle.blockList, indexHead); aoqi@0: Content line22 = getResource("doclet.Help_line_22", indexlink); aoqi@0: Content indexPara = HtmlTree.P(line22); aoqi@0: liIndex.addContent(indexPara); aoqi@0: ul.addContent(liIndex); aoqi@0: } aoqi@0: Content prevHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_23")); aoqi@0: Content liPrev = HtmlTree.LI(HtmlStyle.blockList, prevHead); aoqi@0: Content line24 = getResource("doclet.Help_line_24"); aoqi@0: Content prevPara = HtmlTree.P(line24); aoqi@0: liPrev.addContent(prevPara); aoqi@0: ul.addContent(liPrev); aoqi@0: Content frameHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Help_line_25")); aoqi@0: Content liFrame = HtmlTree.LI(HtmlStyle.blockList, frameHead); aoqi@0: Content line26 = getResource("doclet.Help_line_26"); aoqi@0: Content framePara = HtmlTree.P(line26); aoqi@0: liFrame.addContent(framePara); aoqi@0: ul.addContent(liFrame); aoqi@0: Content allclassesHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.All_Classes")); aoqi@0: Content liAllClasses = HtmlTree.LI(HtmlStyle.blockList, allclassesHead); aoqi@0: Content line27 = getResource("doclet.Help_line_27", aoqi@0: getHyperLink(DocPaths.ALLCLASSES_NOFRAME, aoqi@0: configuration.getText("doclet.All_Classes"))); aoqi@0: Content allclassesPara = HtmlTree.P(line27); aoqi@0: liAllClasses.addContent(allclassesPara); aoqi@0: ul.addContent(liAllClasses); aoqi@0: Content sHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Serialized_Form")); aoqi@0: Content liSerial = HtmlTree.LI(HtmlStyle.blockList, sHead); aoqi@0: Content line28 = getResource("doclet.Help_line_28"); aoqi@0: Content serialPara = HtmlTree.P(line28); aoqi@0: liSerial.addContent(serialPara); aoqi@0: ul.addContent(liSerial); aoqi@0: Content constHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, aoqi@0: getResource("doclet.Constants_Summary")); aoqi@0: Content liConst = HtmlTree.LI(HtmlStyle.blockList, constHead); aoqi@0: Content line29 = getResource("doclet.Help_line_29", aoqi@0: getHyperLink(DocPaths.CONSTANT_VALUES, aoqi@0: configuration.getText("doclet.Constants_Summary"))); aoqi@0: Content constPara = HtmlTree.P(line29); aoqi@0: liConst.addContent(constPara); aoqi@0: ul.addContent(liConst); aoqi@0: Content divContent = HtmlTree.DIV(HtmlStyle.contentContainer, ul); aoqi@0: Content line30 = HtmlTree.SPAN(HtmlStyle.emphasizedPhrase, getResource("doclet.Help_line_30")); aoqi@0: divContent.addContent(line30); aoqi@0: contentTree.addContent(divContent); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Get the help label. aoqi@0: * aoqi@0: * @return a content tree for the help label aoqi@0: */ aoqi@0: @Override aoqi@0: protected Content getNavLinkHelp() { aoqi@0: Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, helpLabel); aoqi@0: return li; aoqi@0: } aoqi@0: }