| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
| <head> |
| <title>JavaHelp Help Set Wizard: Location</title> |
| <link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/> |
| </head> |
| |
| <body> |
| <p><a id="org.netbeans.modules.apisupport.project.ui.wizard.javahelp.JavaHelpPanel" name="org.netbeans.modules.apisupport.project.ui.wizard.javahelp.JavaHelpPanel"></a></p> |
| <div id="NBCSH1858"><!-- infolevel="all" infotype="General" --><a id="sthref239" name="sthref239"></a> |
| <h1>JavaHelp Help Set Wizard: Location</h1> |
| <a name="BEGIN" id="BEGIN"></a> |
| <p>A JavaHelp help set provides help files that explain the features and functionality of your module. |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG3149"> |
| <param name="text" value="<html><u>More</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| <p>You open the JavaHelp help set wizard by right-clicking a module project, choosing New > Other and selecting JavaHelp help set from the Module Development category.</p> |
| <p>In the Location page, you are shown which files will be created for you:</p> |
| |
| <table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0"> |
| <col width="24%" /> |
| <col width="*" /> |
| <thead> |
| <tr align="left" valign="top"> |
| <th align="left" valign="bottom" id="r1c1-t16">Element</th> |
| <th align="left" valign="bottom" id="r1c2-t16">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr align="left" valign="top"> |
| <td align="left" id="r2c1-t16" headers="r1c1-t16">-about</td> |
| <td align="left" headers="r2c1-t16 r1c2-t16">A sample HTML file that is registered in the <code dir="ltr">idx.xml</code> file, <code dir="ltr">map.xml</code> file, and <code dir="ltr">toc.xml</code> file.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r3c1-t16" headers="r1c1-t16"> |
| <p>-hs.xml</p> |
| </td> |
| <td align="left" headers="r3c1-t16 r1c2-t16">Helpset file.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r4c1-t16" headers="r1c1-t16"> |
| <p>-idx.xml</p> |
| </td> |
| <td align="left" headers="r4c1-t16 r1c2-t16">Index file. Using the map ID created in the <code dir="ltr">map.xml</code> file, you add items to the <code dir="ltr">idx.xml</code> file, with the name of the topic that you want displayed in the index.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r5c1-t16" headers="r1c1-t16"> |
| <p>-map.xml</p> |
| </td> |
| <td align="left" headers="r5c1-t16 r1c2-t16">Map file. Each HTML file must be registered in the map file. The map ID that you create for the HTML file is used in the <code dir="ltr">toc.xm</code>l file and <code dir="ltr">idx.xml</code> file.</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r6c1-t16" headers="r1c1-t16"> |
| <p>-toc.html</p> |
| </td> |
| <td align="left" headers="r6c1-t16 r1c2-t16">Table of contents file. Using the map ID created in the <code dir="ltr">map.xml</code> file, you add items to the <code dir="ltr">toc.xml</code> file, with the name of the topic that you want displayed in the table of contents</td> |
| </tr> |
| <tr align="left" valign="top"> |
| <td align="left" id="r7c1-t16" headers="r1c1-t16"> |
| <p>-helpset.xml</p> |
| </td> |
| <td align="left" headers="r7c1-t16 r1c2-t16">The reference file that is registered in the <code dir="ltr">layer.xml</code> file. <a href="NBDAG3062">More</a></td> |
| </tr> |
| </tbody> |
| </table> |
| <br /> |
| <!-- --> |
| <p><b>Note</b>: Each of the names above is prefixed by the name of the project. For example, if the project name is <code dir="ltr">myproject</code>, the files above would be <code dir="ltr">myproject-about.html</code>, <code dir="ltr">myproject-hs.xml</code>, etc.</p> |
| <a id="NBCSH1864" name="NBCSH1864"></a> |
| <hr><p><b>Related Topics</b></p> |
| <p><i>Developing Applications with NetBeans IDE</i>, |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG3071"> |
| <param name="text" value="<html><u>"About NetBeans Platform and Module Development"</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| <p><i>Developing Applications with NetBeans IDE</i>, |
| <object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer"> |
| <param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG3059"> |
| <param name="text" value="<html><u>"About the NetBeans Platform"</u></html>"> |
| <param name="textFontSize" value="medium"> |
| <param name="textColor" value="blue"> |
| </object> |
| </p> |
| |
| <!-- --> |
| <!-- Start Footer --> |
| |
| |
| <table summary="" cellspacing="0" cellpadding="0" width="100%"> |
| <tr> |
| <td align="left" width="86%"><a href="legal_notice.htm"> |
| Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a> |
| </td> |
| </tr> |
| </table> |
| <!-- --> |
| </body> |
| </html> |
