cornercorner
FeaturesPluginsDocs & SupportCommunityPartners

NB61PHPDocPlan

Documentation Plan for the NetBeans 6.0 IDE PHP Plugin and for the PHP Support in the NetBeans 6.1 IDE.

December 2007 - April 2008

-- Main.BarbaraMityashina - 06 Dec 2007

Table of Contents

  • Introduction
  • Documents to be published
  • Documentation scope
  • Detailed documentation schedule

Introduction

The PHP plugin is intended for developing, deploying, and debugging PHP project in the Netbeans 6.1 IDE. This plan describes the documentation deliverables for the PHP support of the NetBeans 6.1. IDE.

1. Documents To Be Published

Document name Priority Planned Start Date Due Date Completed Location Comments
NetBeans 6.0 PHP Plugin editor reference manual 1 Dec 13, 07 Jan 08, 08 Jan 08, 08 http://php.netbeans.org/docs/editorguide.html Published
Getting Started with the NB 6.1 PHP Support, Draft 1 1 Jan 08, 08 Apr 07, 08 After PHP 6.1 Beta (JavaOne) - the main landing page for docs will be: http://www.netbeans.org/kb/61/php/index.html (TBD) Postponed due to updates in the User Interface
Getting Started with the NB 6.1 PHP Support, Draft 2 1 Feb 04. 08 Apr 07, 08 After PHP 6.1 Beta (JavaOne) - the main landing page for docs will be: http://www.netbeans.org/kb/61/php/index.html (TBD)
Getting Started with the NB 6.1 PHP Support, Final 1 March 03, 08 Apr 07, 08 After PHP 6.1 Beta (JavaOne) - the main landing page for docs will be: http://www.netbeans.org/kb/61/php/index.html (TBD)
Online Help for NB 6.1 PHP Support, Draft 1 1 March 03, 08
Online Help for NB 6.1 PHP Support, Final 1 March 31, 08
"Create a Wish List" Tutorial 2 Apr 07, 08 After PHP 6.1 Beta (JavaOne) - the main landing page for docs will be: http://www.netbeans.org/kb/61/php/index.html (TBD)
JMaki Plugin Tutorial 2 After PHP 6.1 Beta (JavaOne) - the main landing page for docs will be: http://www.netbeans.org/kb/61/php/index.html (TBD)


1.1 Related Published Documents

PHP PLugin Home Page

2. Documentation Scope

2.1 The documents altogether shall cover the following activities and functions:

  • Required software
  • Customizing the environment
  • Downloading and installing the PHP Plugin
  • Configuring the PHP Plugin
  • Configuring Web Servers
  • Configuring the database
  • Setting up a PHP project
  • Configuring File Access
  • Specifying script parameters
  • For running scripts on the server
  • For running scripts from the command line
  • Specifying parameters for the PHP interpreter
  • Coding in the PHP Plugin editor. For the NetBeans 6.1 IDE the editor includes the following functionality:
  • Navigation
  • Highlighting
  • Syntax
    • Matches (planned)
  • Semantic (planned)
    • Occurrences of elements (planned)
  • Formatting
  • Automatic formatting ("Smart Indent")
  • Folding code
  • Code completion
  • Bracket completion
  • Code templates
  • Recognition of unused code (planned)
  • Error detection (planned)
  • Parameter hints
  • Debugging a PHP project in the PHP Plugin
  • Troubleshooting

2.2 JMaki Tutorial

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

  • Required software
  • Configuring the environment
  • Downloading and installing the JMaki plugin
  • Using the JMaki palette in PHP development

2.3 "Create a Wish List" Tutorial

The tutorial shall teach a user to create a simple PHP application through practicing the following steps:

  • Installing and configuring the required software
  • Configuring the IDE
  • The Web server profile
  • The database
  • Writing the application code deriving advantages from using the features of the editor

The tutorial will consists of 7 lessons:

  • Lesson 1
  • Tutorial requirements
  • Configuring the environment
  • Web server
  • XDebug
  • PHP engine
  • Checking the environment settings for consistency
  • (Installing) and configuring the PHP plugin/support
  • Lesson 2
  • Installing and configuring MySQL
  • Specifying MySQL support in the PHP configuration file
  • Creating a sample database
  • Database structure: 2 tables
  • Database contents: 2 wishers and 4 wishes
  • Lesson 3: Creating a Wish list application
  • General overview
  • A page flow diagram
  • Lesson 4: Developing the basic functionality, part I
  • "View the wish list of a person"
  • Main page (index.php)
  • editWishList.php
  • "Create new user"
  • Main page (index.php)
  • createNewWisher.php
  • Lesson 5: Developing the basic functionality, part II
  • "Edit my wish list"
  • Main page (index.php)
  • editWishList.php
  • addWish.php
  • editWish.php
  • "Create new wish list"
  • Lesson 5: Security issues - adding session support
  • Lesson 6: Improving the appearance of the application using the CSS technology
  • Lesson 7: Using the Ajax technology by integrating Jmaki

3. Detailed documentation schedule

3.1 NetBeans 6.0 PHP Plugin Editor Reference Manual

Feature Name Description Engineers' Review Editor's review Due Date Comments
Syntax Highlighting Highlighting PHP syntax constructions in files within a PHP project. Dec 27 - 29 Dec 29 – Jan 07 Jan 08 Contact person: Filip Kozlov PHP code is required
Navigator Allows users to easily orientate in a file with PHP source code as well as to perform some basic actions Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Code Folding Selective hiding and displaying sections of a currently-edited file with PHP source code. Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Formatting Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Smart Indent Automatic formatting Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Code completion Allows the user to type a few characters and then get a list of context-sensitive proposals to complete the typed text. Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Bracket Completion Automatic adding or removing paired quotes, parentheses, braces, and brackets during the process of coding. Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Code Templates Enables using an abbreviation instead of a short reusable piece of source code (code snippet). Dec 27 - 29 Dec 29 – Jan 07 Jan 08
Parameter Hints Shows info about the formal parameters of a function or a method in the context where the function/method is called. Dec 27 - 29 Dec 29 – Jan 07 Jan 08


3.2 Getting Started with the NB 6.1 PHP Support

3.2.1 Draft 1 (by Milestone 1, January 21, 2008)
Postponed till milestone 2 due to changes in the User Interface

Doc Type Feature Name Engineers' Review Editor's Review Due Date Comments
Required Software Integrated PHP Interpreter Jan 19 - 22 Jan 22 - 25 Jan 28
Customizing the Environment Configuring the local WEb server Jan 19 - 22 Jan 22 - 25 Jan 28
Coding in the PHP Editor Formatting Jan 19 - 22 Jan 22 - 25 Jan 28
Bracket Completion Jan 19 - 22 Jan 22 - 25 Jan 28


3.2.2 Draft 2 (by Milestone 2, March 03, 2008)

Doc Type Feature Name Engineers' Review Editor's Review Due Date Comments
Required Software CoolStacks: SAMP, WAMP, LAMP, MAMP Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 See the document delivered by Frank Jennings
Customizing the Environment CoolStacks: SAMP, WAMP, LAMP, MAMP Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 See the document delivered by Frank Jennings
Solaris (link) Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Contact person: Frank Jennings
Configuring the PHP support Remote server: 1) FTP and SVN protocols Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
2) Specifying parameters for scripts run on the server Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Specifying parameters for scripts executed in the command line Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Coding in the PHP Plugin Editor Code completion: PHP functions and variables Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
Error Detection (Showing messages about errors detected by the parser that starts in the background when the user stops typing) Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
Code Templates Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
Semantic Highlighting Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
Active Code Block Highlighting Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03
Code Folding Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Navigator Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Parameter Hints Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Code Completion for Comments Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Marking Occurrences of Variables and Methods Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Pair Matching Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Running a PHP Project Web server profile: Specifying parameters for scripts run on the server Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Running a PHP Project Command line: Specifying parameters for scripts executed in the command line Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Priority 3
Debugging a PHP Project Feb 21 – 25 (26) Feb 26 – 29 (March 03) March 03 Contact person: Filip Kozlov


3.3 Online Help for the NB 6.1 PHP Support

3.3.1 Draft 1 (by Milestone 2, March 03, 2008)

The following topics will be included:

  • Using the IDE Online Help
  • Getting Ready
  • Required Software
  • Configuring the Environment
  • Web Server Profiles
  • Working With NetBeans PHP
  • Creating a new PHP project
  • Importing an existing PHP application
  • Editing a PHP source file in the IDE editor
  • Syntax Highlighting
  • Navigator
  • Code Folding
  • Smart Indent
  • Formatting
  • Bracket Completion
  • Code Completion
  • Parameter Hints
  • Running a PHP project from the IDE

3.3.2 Final (by Code freeze, March 31, 2008)

3.4 "Create a Wish List" Tutorial

3.4.1 Draft 1 (by Milestone 2, March 03, 2008)

  • The application source code
  • Sections:
  • Configuring the environment
  • Creating and editing the project

3.4.2 Draft 2 (by April 07, 2008)

  • Working with the database
  • Page design

3.4.3 Final - by April 07, 2008

3.5 JMaki Plugin Tutorial

Priority 2

Retrieved from "http://wiki.netbeans.org/NB61PHPDocPlan"