| // |
| // 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. |
| // |
| |
| = Is there a standard way to provide user documentation for my module? |
| :page-layout: wikidev |
| :page-tags: wiki, devfaq, needsreview |
| :jbake-status: published |
| :keywords: Apache NetBeans wiki DevFaqJavaHelp |
| :description: Apache NetBeans wiki DevFaqJavaHelp |
| :toc: left |
| :toc-title: |
| :page-syntax: true |
| :page-wikidevsection: _development_issues_module_basics_and_classpath_issues_and_information_about_rcpplatform_application_configuration |
| :page-position: 21 |
| |
| include::front::partial$database.adoc[] |
| |
| Yes. See the link:{apidoclink}org-netbeans-modules-javahelp/overview-summary.html[JavaHelp Integration API] |
| which describes how to include JavaHelp documentation in a module under *Help > Contents*; |
| and you can provide rich context help |
| rather easily, linking into the same documentation. |
| |
| There is an IDE wizard for creating a help set for your module. |
| |
| Applies to: NetBeans 5.x, 6.x |
| Platforms: all |
