Documentation Plan for 6.0 NetBeans Module Development Tutorials

The following is a list of documentation being written by the docs group for the NetBeans Platform, for NetBeans module development in general. Also included are gaps in our documentation, gaps in code samples, and things that NetBeans engineers can do to make the life of newbies to their APIs more manageable.

APISupport Wizards

• To support NetBeans module developers, whenever a new API is being developed, we need an APISupport wizard to accompany it.
• For the same reasons, we need at least two samples covering the use cases of each API.

Top APIs That Need Code Samples

• Generic Scripting Framework (Tor)
• Schliemann (Hanz)
• Lexer API (Mila)
• New Java Editor Infrastructure (Jan Lahoda)
• Database Explorer API (Andrei)
• Editor Hints (?)
• Refactoring (?)

Tutorials That Need To Be Reviewed

• Everything in the list below, depending on the developer in question. For example:
  • Standa: Code Snippet Tutorial & Common Palette API Tutorial
  • Petr Hejl: Server Skeleton Tutorial

List of Tutorials

The following are needed in the NetBeans Platform area (if there is no link, it doesn't exist, and needs to be created):

Must Have

• NetBeans Platform Quick Start (i.e., HTML Editor tutorial)
• NetBeans Module Development Quick Start (i.e., Google Toolbar tutorial)
• NetBeans Paint Application Tutorial
• NetBeans Feed Reader Tutorial
• Update Center Tutorial

Should Have

• Visual Library API Tutorial
• Code Snippet Tutorial
• Common Palette API Tutorial
• PovRay Tutorial series (by Tim, covering many topics, inc. Lookup and Nodes)
• Selection series (4 tutorials by Tim, covering node-related topics)
• System Properties Tutorial (introductory Nodes tutorial)
• Project Sample Tutorial
• File Template Tutorial
• JavaHelp Tutorial
• Options Window Extension Tutorial
• NetBeans Module as Web Service Client Tutorial
• Retouche
• XML Editor Extension Tutorial
• Command Line API Tutorial
• Schliemann Tutorial
• Lexer Tutorial (updated from Syntax Highlighting tutorial)
• NetBeans Runtime Container
• Testing For NetBeans Module Tutorial (This should include JUnit, NBJunit, Jemmy, Insane and XTest.)
• Database Explorer API Tutorial
• XML Multiview API Tutorial
• Profiling NetBeans Modules and Applications Tutorial
• NetBeans Platform as Application Client Tutorial
• Login Tutorial
• Editor Hints Tutorial
• Refactoring Tutorial
• TreeTableView Tutorial
• Project Type Extension Tutorial
• Porting a Swing Application to the NetBeans Platform Tutorial

Nice To Have

• Error Annotation Tutorial
• Server Skeleton Tutorial
• Code Completion Tutorial
• Hyperlink Tutorial
• Web Framework Extension Tutorial
• Custom GUI Editor (for a file type which uses CloneableOpenSupport)

Key

• 'must have': P1
• 'should have': P2
• 'nice to have': P3 the topics are already covered in the "Rich Client Programming" book and/or the topic is deemed to be a corner case

Attachments

smile.png

955 bytes