---

Documentation Plan for the NetBeans IDE 6.5 for PHP.

May - September 2008

-- Main.BarbaraMityashina - 30 May 2008

Table of Contents

• Introduction
• Documentation deliverables
• Documents to be maintained
• Documents to be created
• Detailed documentation schedule

Introduction

The NetBeans 6.5 IDE for PHP is intended for developing, debugging, and deploying PHP projects. This plan describes the documentation deliverables for the NetBeans 6.5 IDE for PHP.

Documentation deliverables

• Online help

• Configuration documents
  • Configuring the environment for PHP development in Windows - maintained
  • Configuring the environment for PHP development in Linux - maintained
  • Configuring the environment for PHP development in Solaris - maintained
  • Configuring the environment for PHP development in MacOS - maintained
• MySQL database tools - new
• Setting Up a PHP Project - maintained

• Editor
  • NetBeans IDE for PHP Editor: Brief Overview - maintained
  • Debugging PHP Code in NetBeans - new
  • Creating, maintaining, and running unit tests on PHP projects in NetBeans

• NetBeans IDE general features
  • Using CVS in NetBeans - new

• Create a Wish List Application in 8 Steps Tutorial - maintained

• Related technologies tutorials and how-to's
  • Using the JMaki Technology in PHP Development in NetBeans - new
  • Using Javascript in PHP Development in NetBeans - new

• Developing an Extension to Facebook using NetBeans IDE for PHP - new

Documents To Be Maintained

Document name	Sections to be updated	Sections to be added	Planned start date	Due date	Completed	Status	Comments
Configuring the environment in Windows		Vista	June 09				Barbara: No updates required. I checked - XAMPP lite installtion procedure works for Vista
Configuring the environment in Linux	Specifying the Document Root for the Apache2 HTTP Server: Avoid creating a virtual host		June 09				Barbara: Not done
Configuring the environment in Solaris		Section about Solaris itself, not SXDE	June 09				Barbara: Not done
Setting Up a PHP Project		Setting up Configurations: local server/ remote server/ command line	August 18		29.07.08	Ready	Run configurations and sources location have been described for projects with/without existing sources _
Create a Wish List Application in 8 Steps Tutorial	Lesson 1: Creating a Sample Database with Test Data; Adding a lesson devoted to deploying the application on a remote server		August 18			Ready

Documents To Be Created

Document name	Priority	Source code	Dependencies	Planned Start Date	Due Date	Completed	Status	Comments
Intro to using PHP in NB	1						In progress, inherited from Geertjan and Lloyd
Example of importing existing project: MediaWiki	2?						In progress	The import itself is quite easy but not sure how to present it
PHP Frameworks in NetBeans IDE	2?			July 28	August 11		In progress, blog posted	May be more appropriate as an article or article plus blog post rather than web doc
SaaS in PHP: Yahoo News Service	3?	N/A	SaaS Plugin for PHP			Draft ready for review	On staging server
Using the JMaki Technology in PHP Development in NetBeans	2	Updated Wish List Application	None	June 09				Barbara: Not done
Deploying a PHP Application on a Remote Web Server Using the NetBeans IDE	2	None	None	June 09		29.07.08	Ready
Creating a MySQL Database on a Remote Server	2	N/A	None	July 14		29.07.08	Ready
Debugging PHP Code in NetBeans	1	Updated Wish List Application	Debugger	July 14			Ready
Creating, maintaining, and running unit tests on PHP projects in NetBeans	3	Updated Wish List Application	Unit test tool	TBD				Barbara: Not done because the functionality has not been developed yet
Using Javascript in PHP Development in NetBeans	1	???	None	July 14				Barbara: Not done
Online help	1	N/A	UI, ID's set by the engineers		August 31		Ready

JMaki

JMaki is a plugin that simplifies and speeds up the PHP development process. The document shall cover the following activities:

• Installing and setting up the JMaki plugin
• Using the JMaki palette in PHP development
  • Examples and how-to's TBD

Debugging

The document shall cover the following cases:

• Debugging within one PHP code block
• Debugging several PHP code blocks
• Debugging PHP code with Javascript inclusions
• Included files

UnitTests

The document shall cover the following topics:

• General concepts of unit testing
• Creating unit tests
• Maintaining unit test

Facebook

TBD

OnlineHelp

• Draft 1 (by Milestone 2, June 30, 2008)
• Final (by Online help hand-off, August 18, 2008)

The following topics will be included:

• Using the IDE Online Help
• Configuring the environment
• Setting up a PHP project
• Setting up configurations: local server, remote server, command line
• Editing a PHP source file in the IDE editor
  • Syntax Highlighting
  • Navigator
  • Code Folding
  • Smart Indent
  • Formatting
  • Bracket Completion
  • Code Completion
  • Parameter Hints
  • Go to declaration
• Debugging a PHP project
• Running a PHP project from the IDE in various configurations