我想做的是这篇文章的较短的顶部。第二部分是到目前为止已完成的工作。这确实很长，但是您应该可以从这里看到我在做什么。如果您想了解更多详细信息，只需检查注释。
我正在使用NetBeans平台作为起点来构建应用程序。以前的版本使用JavaHelp作为最终用户文档。在撰写所有新文档时，我会继续练习，但我发现如果使用中的信息不足，我会觉得很匮乏。
我已经足够了解如何创建新的HelpSet和XML到HTML的关系。我可以在新文档中编写代码并应用屏幕截图，但是感觉非常手动，我想知道是否有任何插件或工具可以促进创建？
在做一些Google-foo时，我发现了有关该主题的几篇文章，但是大多数与2003年有关，现在已经死胡同了。使用JavaHelp过期了吗？
在下面，我概述了我为寻找相同事物的人们所做的一切，也许有人可以指出我这样做的效率低下。
这不是一个糟糕的方法，但是对于我上传的每个文件，都必须在两个XML文件中添加行，然后每次都必须指向一个较长的代码URL，这对于将这些内容快速写出来感到很麻烦。
谢谢阅读。
编辑：我确实有一个问题。我不知道如何更改JavaHelp的初始登录页面。现在它说：“这列出了IDE加载的所有文档，请单击左侧以通读它”。这对我的最终用户没有任何意义。
另外，我不知道如何更改左侧主题的顺序。目前，它们似乎没有任何有用的顺序。我想按字母顺序排列，或将它们按某种有用的顺序排列。
在Netbeans中，右键单击模块New-> Other，然后单击模块开发，然后选择JavaHelp帮助集。这将在模块下创建一个新包。它将遵循模块的命名约定，并将.docs附加到末尾。例如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>
最佳答案
第一个问题是什么？当前的过程是否太费力？我认为如果您一次提出一个明确的问题，会更容易获得帮助。无论如何，这里有一些技巧可能会有所帮助。
据我所知，Sun JavaHelp的开发已经停止。您可能需要尝试Oracle Help。它与JavaHelp非常相似，但维护起来更为积极。
有一些商业创作工具可以帮助您避免产生JavaHelp（或Oracle Help）麻烦。例子：
Helen：仅JavaHelp的工具，其最新版本于2012年4月发布（因此JavaHelp永远不会消失...）
WebWorks ePublisher：除了JavaHelp之外还可以生成更多帮助格式的工具
其他选项是免费的基于XML的文档框架DocBook和DITA，它们都提供了样式表（请参见here和here），这些样式表可以从XML来源生成JavaHelp（我认为，为了使此功能也可以用，它几乎不需要Oracle帮助）。
还有其他（非JavaHelp）替代方法。例如，DocBook还提供了基于Web的帮助格式：WebHelp。也许您会发现这很有趣。
关于java - 使用JavaHelp作为基于NetBeans的应用程序，工具或插件上的最终用户文档，可以使其变得更容易？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/9994373/