这篇文章较短的顶部是我想要做的。第二部分是到目前为止所做的。它真的很长，但你应该能够从这里的顶部看到我在做什么。如果您对更多细节感兴趣，只需查看注释即可。
我正在构建一个使用 NetBeans 平台作为起点的应用程序。以前的版本使用 JavaHelp 来获取最终用户文档。在编写所有新文档时，我可以继续练习，但是如果有关它的使用信息，我会发现缺乏。
我已经弄清楚了如何创建新的 HelpSet 和 XML 到 HTML 的关系。我可以在新文档中提交代码并应用屏幕截图，但感觉非常手动，我想知道是否有任何插件或工具可以方便创建？
做一些 Google-foo 我发现了几篇关于这个主题的帖子，但大多数都与 2003 年相关，现在已经死胡同了。使用 JavaHelp 是否已过时？下面我将概述我为寻找相同事物的人们所做的任何教育，也许有人可以指出我这样做的方式效率低下。
这不是一个糟糕的方法，但是必须为我上传的每个文件在两个 XML 文件中添加行，然后每次都必须指向一个长代码 URL，这对于快速写出这些东西感觉很麻烦。
谢谢阅读。
编辑：我确实有一个问题。我不知道如何更改 JavaHelp 的初始登录页面。现在它说“这列出了 IDE 加载的所有文档，单击左侧阅读它”。这对我的最终用户没有任何意义。
另外，我不知道如何更改左侧主题的顺序。现在它们似乎没有任何有用的顺序。我想按字母顺序排列，或将它们按某种有用的顺序排列。
在 Netbeans 中，右键单击模块 New->Other 单击 Module Development 选择 JavaHelp Help Set。这将在模块下创建一个新包。它将遵循模块的命名约定，并在末尾附加一个 .docs。EG org.netbeans.newmodule.docs。
在此它将创建 6 个文件：
package-info.java (package info file)
<modulename>-about.html (As seen HTML help file)
<modulename>-map.xml (creates a connection to the HTML pages (E.G about) to a target, used in making links & building the hierarchy for the table of contents)
<modulename>-toc.xml (Table of contents XML)
<modulename>-hs.xml (Specifies the Table of contents view & javax control, & index)
<modulename>-idx.xml (Controls the index)
第一个 HTML 文件是初始信息页面。这是最终用户将阅读的帮助文件。它只是特定格式的常规 HTML。
<modulename>-about.html
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<html>
<head>
<title>About Module</title>
<link rel="stylesheet" href="nbdocs:/org/netbeans/modules/usersguide/ide.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<h2>About Module</h2>
<p>
<!-- TODO describe your module, add more pages... -->
</p>
</body>
</html>
<!--
Tip: to create a link which will open in an external web browser, try:
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.netbeans.org/">
<param name="text" value="<html><u>http://www.netbeans.org/</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
To create a link to a help set from another module, you need to know the code name base and path, e.g.:
<a href="nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/configure/configure_options.html">Using the Options Window</a>
(This link will behave sanely if that module is disabled or missing.)
-->
任何内容都可以添加到<body>文档的部分。到目前为止，我使用过简单的内联 CSS，并且使用<FONT>标签一直有效。它还链接到外部 CSS 文件，所以我认为这也可以。您可以通过指定路径链接到其他帮助文件。路径将始终以nbdocs:/<yorumodulepath>
例如：Any event added here will show up on the <a href="nbdocs:/com/mymodule/mod1/start/docs/start-about.html">start page</a>
如果图像与 javahelp 在同一个源包中，则可以相对链接。
例如：<img src="startPageLogo.png">
XML 文件很重要，因为它们设置了帮助文档的结构。
<modulename>-map.xml
此文件将 HTML 文件链接到 nbdocs 文件。这将允许您在 HTML 文件中创建指向其他帮助文件位置的链接，并使其正确打开和关闭 JavaHelp 树。结构似乎是：<mapID target="<com.yoruproject.modname" url="<htmlfilename/.html"/>
例如
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 2.0//EN" "http://java.sun.com/products/javahelp/map_2_0.dtd">
<map version="2.0">
<mapID target="com.mymodule.mod1.start.about" url="start-about.html"/>
<mapID target="com.mymodule.mod1.start.calevents" url="start-calevents.html"/>
<mapID target="com.mymodule.mod1.start.backupreminder" url="start-backupreminder.html"/>
</map>
<modulename>-toc.xml
此文件控制 JavaHelp 左侧的结构，用户可以使用该结构深入了解帮助文档的不同区域。格式如下：
<toc version="2.0">
<tocitem text="Top Category">
<tocitem text="SubItem" target="com.mymod.mod1.start.about"/>
<tocitem text="SubCategory">
<tocitem text="SubCategoryItem1" target="com.mymod.mod1.start.backupreminder"/>
<tocitem text="SubCategory2" target="com.mymod.mod1.start.about">
<tocitem text="SubCategoryItem2" target="com.mymod.mod1.start.classifyreminder"/>
</tocitem>
</tocitem>
</tocitem>
</toc>
这是一个完整文件的示例：
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 2.0//EN" "http://java.sun.com/products/javahelp/toc_2_0.dtd">
<toc version="2.0">
<tocitem text="Start Page">
<tocitem text="Getting Started" target="com.mymodule.mod1.start.about"/>
<tocitem text="Calendar Events" target="com.mymodule.mod1.start.calevents"/>
<tocitem text="Notification Pane">
<tocitem text="Backup Reminders" target="com.mymodule.mod1.start.backupreminder"/>
<tocitem text="New Classification Downloads" target="com.mymodule.mod1.start.backupreminder"/>
</tocitem>
</tocitem>
</toc>
<modulename>-hs.xml
我还没有弄乱这个文件。它似乎概述了目录的位置、索引的 IDX 文件和 SearchView 文件（这是默认的 Java 位置）。
<?xml version="1.0" encoding="UTF-8"?>
<!--
To change this template, choose Tools | Templates
and open the template in the editor.
-->
<!DOCTYPE helpset PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN" "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
<helpset version="2.0">
<title>HMSStart Help</title>
<maps>
<homeID>com.mymodule.mod1.start.about</homeID>
<mapref location="start-map.xml"/>
</maps>
<view mergetype="javax.help.AppendMerge">
<name>TOC</name>
<label>Table of Contents</label>
<type>javax.help.TOCView</type>
<data>start-toc.xml</data>
</view>
<view mergetype="javax.help.AppendMerge">
<name>Index</name>
<label>Index</label>
<type>javax.help.IndexView</type>
<data>start-idx.xml</data>
</view>
<view>
<name>Search</name>
<label>Search</label>
<type>javax.help.SearchView</type>
<data engine="com.sun.java.help.search.DefaultSearchEngine">JavaHelpSearch</data>
</view>
</helpset>