netbeans.apache.org/src/old_content/content/tutorials/68/docs-plan.adoc

// 
//     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.
//

= NetBeans 5.0 FCS Status of Docs Deliverables for NetBeans Plug-in Modules
:jbake-type: platform_tutorial
:jbake-tags: tutorials 
:jbake-status: published
:syntax: true
:source-highlighter: pygments
:toc: left
:toc-title:
:icons: font
:experimental:
:description: NetBeans 5.0 FCS Status of Docs Deliverables for NetBeans Plug-in Modules - Apache NetBeans
:keywords: Apache NetBeans Platform, Platform Tutorials, NetBeans 5.0 FCS Status of Docs Deliverables for NetBeans Plug-in Modules

link:mailto:dev@netbeans.apache.org?subject=Feedback:%20NetBeans%20IDE%20Docs%20Plan%20for%20NetBeans%20Modules[Feedback]

Below are all the deliverables for developer docs which the docs department was aware of when planning docs for rich-client application developers and plug-in module developers. All deliverables marked *P1* or *P2* were the deliverables to which the docs department commited itself for FCS. All the other deliverables were "nice to have", but no more than that.

Explanation of the statuses at time of FCS:

* *Planned* means writing has not started, and the related sample -- if any -- has not been put together, but that the basic idea of the deliverable in question is clear and that developers have been identified for help, if necessary.
* *Started* means that the sample for the deliverable -- if any -- is being put together and the deliverable has begun to be written but neither have reached a point where they are solid enough to be reviewed.
* *First draft* means that the deliverable is available for public consumption -- the steps in the deliverable provide the technical result (i.e., the plug-in works) although there are probably various issues to be solved; there is no conceptual information; the sample code may or may not be attached to the tutorial; the full 4.next features aren't covered.
* *Final draft* means that all the 4.next functionality (or, whatever is available at the time) is included in the deliverable, that it includes complete conceptual information, that it has had editorial reviews and technical reviews. Until Frozen status, small tweaks can be added, as well as additional functionality that was added late, but no more.
* *Frozen* means frozen, i.e., absolutely no more changes. Next changes to be added will be part of the next release cycle.
|===

|*Deliverables* |*Priority & Goal of Deliverable* |*Status on 02/01/06 (i.e., FCS)* 

|*_Tutorials_* 

||--- Quick Start Guide |*P1.* A quick start tutorial for developers interested in developing plug-in extensions for IDE. The tutorial shows how to create, install, modify, and reload a simple NB plug-in that adds a menu item and a toolbar button to the IDE. |Frozen:
link:https://netbeans.apache.org/tutorials/quickstart-nbm.html[NetBeans IDE 5.0 Plug-in Module Quick Start Guide]

||--- RCP FeedReader tutorial |*P1.* Platform-specific issues, such as branding. |Frozen (content):
Final draft (format): Work being done on adding a template for formatting & consistency.
link:https://netbeans.apache.org/tutorials/nbm-feedreader.html[NetBeans IDE 5.0 FeedReader Tutorial]

Frozen: 
link:https://netbeans.apache.org/tutorials/nbm-paintapp.html[NetBeans IDE 5.0 Rich-Client Application Quick Start Guide]

 

||--- Helpset Tutorial |*P2.* A tutorial that shows how to create your plug-in's help system, integrate it into the standard NB help system, and share it with others. |Frozen:
Removed this tutorial, because there is now a wizard and help topics that support this scenario. 

||--- Anagram Game Plug-in Tutorial |*P2.* A tutorial that demonstrates the ~TopComponent class of the Windows API. The tutorial shows how to create a plug-in extension that embeds an anagram game in the IDE. |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-windowsapi.html[NetBeans Anagram Game Module Tutorial]

||--- Project Sample Tutorial |*P2.* A tutorial that shows how to insert your own project samples into the IDE's New Project wizard and how to share them with others. |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-projectsamples.html[NetBeans Project Sample Module Tutorial]

||--- Server Skeleton Tutorial |*P2.* A tutorial that demonstrates the org.netbeans.modules.j2ee.deployment.plugins.api package of the J2EE Server API. The tutorial shows how to build the framework of a server plug-in. Placeholders are provided for your own server-specific implementations. |Frozen for 4.1, but needs to be updated to 5.0:
link:https://netbeans.apache.org/tutorials/nbm-server-plugin.html[NetBeans Server-Skeleton Plug-in Tutorial]

||--- System Properties Tutorial |*P2.* A tutorial that demonstrates the org.openide.nodes package of the Nodes API. The tutorial shows how to create a plug-in extension that lets you add, modify, and delete system properties from inside the IDE. |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-nodesapi.html[NetBeans System Properties Module Tutorial]

||--- Data Object Tutorial |*P2.* How to create a data object, open it in the IDE, provide cc and syntax highlighting. Manifest file will be used, because it is quite simple. |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-filetype.html[NetBeans DataLoader Module Tutorial]

First draft:
link:https://netbeans.apache.org/tutorials/nbm-mfsyntax.html[NetBeans Manifest File Syntax Highlighting Module Tutorial]

Started:
NetBeans Code Folding Module Tutorial

Planned:
NetBeans Code Indentation Module Tutorial

Planned:
NetBeans Code Completion Module Tutorial

 

||--- Tag Handler Tutorial |*P3.* A tutorial that demonstrates the ~CookieAction class of the Nodes API. The tutorial shows how to create a plug-in extension that adds a popup menu item to the Source Editor for XML files. When you choose the new popup menu item, the XML file's tags are printed to the Output window. |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-taghandler.html[NetBeans Editor Extension Module Tutorial]

||--- File Templates Tutorial |*P3.* How to create and integrate file templates (not including how to create file template wizard) |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-filetemplates.html[NetBeans File Template Module Tutorial]

||--- Wizard Tutorial |*P3.* How to create and integrate wizards for files or projects |First draft:
I blogged about the Wizard API and the Wizard wizard a lot (and people have been using and referring to them), but I haven't put a tutorial together yet. 

||--- Project Templates Tutorial |*P3.* How the IDE recognizes your own project type so that it can be opened in the IDE; how to add a new project type to the New Project wizard; how to use the New Project wizard to create your own project type |Frozen:
Removed this tutorial, because there is now a wizard and help topics that support this scenario. 

||--- Web Framework Tutorial |*P4.* How to include your own web framework in the IDE, in the same way as Struts and JSF in 4.next. |First draft:
I blogged about how to add a web framework's libraries to the Frameworks panel in web applications. But, this hasn't been put into a tutorial yet. 

|*_Conceptual Docs_* 

||--- Glossary |*P1.* Glossary |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-glossary.html[Basic Terms for NetBeans Plug-in Module Development]

||--- Introduction to NB APIs |*P1.* Present the most common APIs and provide basic explanations, with references to Javadoc and related tutorials |Frozen:
link:https://netbeans.apache.org/tutorials/nbm-idioms.html[Introduction to the NetBeans Idioms and Infrastructure]

||--- Plug-in Extension Diagram |*P3.* Provide a diagram, some kind of visual overview, of which parts of the IDE can be extended by means of plug-ins. |Planned 

|*_Online Helpset_* 

||--- Context sensitive help |*P1.* All u.i. has a help file |Frozen 

||--- Built-in help |*P1.* Complete helpset for plug-in developers |Frozen 
|===