この投稿の短い上部セクションは、私がやろうとしていることです。2番目の部分はこれまでに行われたことです。本当に長いですが、ここの一番上の部分から私が何をしているのかを見ることができるはずです。詳細に興味がある場合は、メモを確認してください。
NetBeansプラットフォームを出発点として使用してアプリケーションを構築しています。以前のバージョンでは、エンドユーザーのドキュメントにJavaHelpを使用していました。すべての新しいドキュメントを作成しているので、練習を続けても問題ありませんが、その使用に関する情報が不足していることに気づいています。
新しいHelpSetとXMLとHTMLの関係を作成する方法を十分に理解しました。新しいドキュメントにコードを渡してスクリーンショットを適用することはできますが、非常に手作業であると感じます。作成を容易にするプラグインやツールはありますか？
Google-fooを実行すると、このトピックに関するいくつかの投稿が見つかりましたが、ほとんどは2003年に関連しており、現在は行き止まりになっています。JavaHelpの使用は古くなっていますか？以下に、同じことを探している人々の啓蒙のために私が行ったことの概要を示します。おそらく、誰かが私がこれを行っている方法の非効率性を指摘することができます。
これはひどいアプローチではありませんが、アップロードするファイルごとに2つのXMLファイルに行を追加する必要があり、そのたびにポイントする必要のある長いコードURLがあると、このようなものをすばやく書き出すのが面倒になります。
読んでくれてありがとう。
編集：私が問題を抱えていることが1つあります。JavaHelpの最初のランディングページを変更する方法がわかりません。現在、「IDEにロードされているすべてのドキュメントが一覧表示されます。左をクリックして読み進めてください」と表示されます。それは私のエンドユーザーにとって何の意味もありません。
また、左側のトピックの順序を変更する方法がわかりません。現在、それらは有用な順序ではないようです。アルファベット順、またはある種の便利な順序に並べたいと思います。
Netbeansで、モジュールを右クリックします。[新規]-> [その他]をクリックして、[モジュール開発]をクリックし、[JavaHelpヘルプセット]を選択します。これにより、モジュールの下に新しいパッケージが作成されます。モジュールの命名規則に従い、最後に.docsを追加します。EGorg.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>