Project Documentation

We are going to Build below html form, instate of using traditional way we are now going to learn Advance Documentation structure. 

Author Master
Author Name:
Author Degree:
Author Speciality:
Author DOB:
	Author Name	Author Degree	Speciality	Date Of Birth
	Dharmaraj	M.Tech	Open Source Product	23/06/1985
	Raj Panigrahi	MCA	Analyst Designer	02/06/1987

This form will allow: 

• Inserting data into the AuthorMaster
• Updating data already exiting in the AuthorMaster
• Viewing of data available in AuthorMaster
• Deleting data from AuthorMaster

File Include
PHP	dosql.php	Performs the insert,delete and update operations
JavaScript	N/A
J-Query	N/A
CSS	N/A

Function Declared
PHP	N/A
JavaScript	setEditMode(),setMode(),setDelMode(),chkBlanks()

Form Details
Form Name	frmAuthMast
Form Title	Author Master
Bound To	bookdb.AuthorMaster

Data Fields
Object	Label	Name	Id	Bound To
Hidden	N/A	hidAuthId	N/A	N/A
Hidden	N/A	hidMode	N/A	N/A
Hidden	N/A	hidSelDel	N/A	N/A
Label	Author Name	N/A	N/A	N/A
Label	Author Degree	N/A	N/A	N/A
Label	Specialit	N/A	N/A	N/A
Label	Date Of Birth	N/A	N/A	N/A
Text Box	AuthorId	txtAuthId	N/A	AuthorMaster.AuthorID
Text Box	AuthorName	txtAuthName	N/A	AuthorMaster.AuthorName
Text Box	AuthorDegree	txtAuthDegree	N/A	AuthorMaster.AuthorDegree
Text Box	Speciality	txtSpeciality	N/A	AuthorMaster.Speciality
Text Box	DOB	txtDOB	N/A	AuthorMaster.DOB
CheckBox	N/A	chk<AuthorID>	N/A	(AuthorMaster.AuthorID)'s value

Data Controls
Object	Object	Label	Id	Action
Buttone	Save	cmdSubmit	N/A	JavaScript:onSubmit()
Buttone	Cancel	cmdReset	N/A	JavaScript:setEditMode()
Buttone	Delete	cmdDelete	N/A	JavaScript:setDelMode()

1.Commented Statement provide a description and purpose of the file. 

/* 
Date :- 13/02/2011 
Author :- Dharmaraj Panigrahi 
File Name :- AuthorMaster.php 
Purpose :- This page provides an interface to manage author details.

It allows 
Adding new Author Details.
Viewing Author Details.
Updating and existing Author's Details.
Deleting and existing Authors's Details.
*/

2.Common PHP Variablse
/*
A Variable named $author holding the name of the programmer who designed/coded the page.
*/
$author = 'Dharmaraj Panigrahi';

3.PHP Variable bound to Database Connection
$user = "root";
$pwd = "pass";
$db = "bookdb";
$host = "localhost";

4.PHP Code block to establish a Database Connection
mysql_connect($user,$pwd,$host) or die("Connection Failed");
mysql_select_db($db) or die("Could not select the database");

5.The code block taht display the actual HTML page begins

6.Body Section

7.Script tag holding under the body section

7.1.JavaScript function to set contents of form fields.
function setEditMode(AuthorID,AuthorName,AuthorDegreee,Speciality,DOB)
{
.....
}//end of setEditMode function

7.2.JavaScript function to Clear the form fields.
function setMode()
{
.....
}//end of setMode() function

7.3.JavaScript function to Prepare the form to delete selected record.
function setDelMode()
{
.....
}//end of setDelMode() function

7.4.JavaScript function to Delete a string of data retrived.
function formDeleteValues(hidden)
{
.....
}//end of formDeleteValues() function

7.5.JavaScript function to Varifay form fields are not left empty.
function chkBlanks()
{
.....
}//end of chkBlanks() function

7.6.Script tag end.

8.Form Section holding Data and control objects begins.

9.Parent Table begins.

10.PHP Code bloce to retrive records from AuthorMaster table.

11.Second Chield table to ost the tabular layout(GRID), to display/control data captured begins.

12.Second Child table->First Row:
Columns to hold the header row along with the Delete button.

13.PHP Code block to populate data in the tabular layout using a loop.

14.Second Chield table -> Second Row:
Columns to set data and assign colors to odd and even rows.

15.Loop and the Second Child table ends.

16.The mysql connection is closed and the parent table ends.

17.Form to host Data and control objects ends.

18.HTML code block along with BODY section rendering the actual page ends.

To be continued.....