Example Project File
Previous Topic  Next Topic 

The following is an example of a project file. 

 

 Items bolded are reserved words and are required to ensure the Markers Assistant can interpret an incoming project file.  

 

Sections have been assigned line numbers and color coded to aid identification.

 

------------ BEGIN PROJECT FILE -------------------

  1. Deakin University, School of Information Technology
  2. SIT104 WWW and Internet 
  3. Assignment 2 - Forms and JavaScript
  4. 13/10/2004
  5. COMMENTS
  6. A very good effort. : 0
  7. The order form was confusing, illogical and well beyond what was required. : 0
  8. You had no submit button for the person details form, so it could not submit and no validation occurs. : 0
  9. END COMMENTS
  10. PART A
  11. PROJECT FILE
  12. *.htm,*.html,*.doc
  13. OTHER FILES
  14. ass2.html
  15. AssignCoverSheetElectronic.doc
  16. submission.html
  17. END OTHER FILES
  18. MARKS
  19. HTML Form : 0 
  20.     Appropriate fonts and styles used : 5 
  21.     Product Order Form : 0 
  22.         Appropriate controls used : 5 
  23.         Appropriate labels included : 3 
  24.         Quantities can be entered for software items : 3 
  25.         Total for Order displayed : 2 
  26.         GST displayed for order : 2 
  27.         Grand Total for order displayed : 2 
  28.         Control layout adequate and logical : 3 
  29.     User Information Form : 0 
  30.         Appropriate Form Controls used : 5 
  31.         Appropriate Labels used : 3 
  32.         Examples of required formats supplied : 3 
  33.         All required Form Controls supplied : 3 
  34.         Control layout adequate and logical : 3 
  35.     HTML documented : 3 
  36.     Appropriate Form and Control names used : 5 
  37. JavaScript : 0 
  38.     Events and Form interaction : 0 
  39.         Totals calculated as user enters or changes order information : 3 
  40.         GST calculated as user enters or changes order information : 2 
  41.         Grand Total calculated as user enters or changes order information : 2 
  42.         Totals calculated correctly : 3 
  43.         Totals displayed formatted appropriately (rounded to 2 decimal places with $ sign) : 3 
  44.     Validation : 0 
  45.         All fields that are required are checked : 5 
  46.         Invalid numbers or quantities validated : 3 
  47.         User information appropriately validated (alpha only) : 3 
  48.         Phone and Fax validated : 3 
  49.         State, PostCode and Country validated : 3 
  50.         Email address validated : 3 
  51.         Validation reflects formats required and indicated : 3 
  52.         Appropriate error messages presented where errors detected : 5 
  53.     Structure and layout : 0 
  54.         Code appropriately commented : 3 
  55.         Code layout appropriate : 3 
  56.         Code utilises functions to do common tasks : 3 
  57. END MARKS
  58. END PART
  59. 0,0,100,0,1,1,0,1, Your Results,wells@deakin.edu.au,mail.deakin.edu.au,wells,C:\WINDOWS\explorer.exe,/exit,SIT104 WWW and Internet ,V:\Ass2\,V:\Ass2\Completed Projects\ass2-sit104-summary.csv,V:\Ass2\Completed Projects,H:\SIT104\Ass2\,sit104-all-ass2-commented.prj,15.000000,1,0,1,0,1 
  60. 37 
  61. 188 
  62. 12324356,rteeh@deakin.edu.au,Jason,JAN_WILLIAMSON,G 
  63. 1,1,0,1,1,5,1,1,0,1,1,5,1,1,3,1,1,3,1,1,2,1,1,2,1,1,2,1,1,3,1,1,0,1,1,5,1,1,3,0,1,3,1,1,3,1,1,3,0,1,3,1,1,5,1,1,0,1,1,0,1,1,3,1,1,2,1,1,2,1,1,3,1,1,3,1,1,0,1,1,5,0,1,3,1,1,1,1,1,1,1,1,1,1,1,3,1,1,1,1,1,3,1,1,0,1,1,3,1,1,3,1,1,3,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,0,81 
  64. 584848883,jrtmrcc@deakin.edu.au,Shang,FRANK_RUSSELL,G 
  65. 1,1,0,1,1,5,1,1,0,1,1,5,1,1,3,1,1,3,1,1,2,1,1,2,1,1,2,1,1,3,1,1,0,1,1,3,1,1,3,1,1,3,1,1,3,1,1,3,1,1,3,1,1,5,1,1,0,1,1,0,1,1,3,1,1,2,1,1,2,1,1,2,1,1,2,1,1,0,1,1,5,1,1,3,1,1,3,1,1,2,1,1,3,1,1,2,1,1,2,1,1,1,1,1,0,1,1,3,1,1,3,1,1,3,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,0,89 
  66. 754747377,jfetra@deakin.edu.au,Shang,TOM_FRAKE,G 
  67. 0,1,0,0,1,5,0,1,0,0,1,5,0,1,3,0,1,3,0,1,2,0,1,2,0,1,2,0,1,3,0,1,0,0,1,5,0,1,3,0,1,3,0,1,3,0,1,3,0,1,3,0,1,5,0,1,0,0,1,0,0,1,3,0,1,2,0,1,2,0,1,3,0,1,3,0,1,0,0,1,5,0,1,3,0,1,3,0,1,3,0,1,3,0,1,3,0,1,3,0,1,5,0,1,0,0,1,3,0,1,3,0,1,3,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,0,1,0,1,0,0 
  68. 4787437747,payrle@deakin.edu.au,Jason,PAUL_RICHARD,G 
  69. 0,1,0,1,0,5,1,0,0,1,0,5,1,0,3,1,0,3,1,0,2,1,0,2,1,0,2,1,0,3,1,0,0,1,0,5,1,0,3,1,0,3,1,0,3,1,0,3,1,0,3,1,0,5,0,1,0,1,0,0,1,0,3,1,0,2,1,0,2,1,0,3,1,0,3,1,0,0,1,0,5,1,0,3,1,0,3,1,0,3,1,0,3,1,0,3,1,0,3,1,0,5,1,0,0,1,0,3,1,0,3,1,0,3,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,0,0 
  70. I found some of your JavaScript code was sourced from another web site http://www.webmasterworld.com/forum91/2167.htm and is not referenced appropriately in the code nor in the report?? : -10 
  71. 47664764764,djbrrurl@deakin.edu.au,Jason,JASON_GURLOCK,B 
  72. 1,1,0,1,1,5,1,1,0,0,1,5,1,1,3,0,1,3,1,1,2,1,1,2,1,1,2,0,1,3,1,1,0,1,1,3,1,1,3,0,1,3,1,1,3,1,1,3,0,1,3,1,1,5,1,1,0,0,1,0,1,0,3,1,0,2,1,0,2,1,0,3,1,0,3,0,1,0,1,0,5,1,0,3,1,0,3,1,0,3,1,0,3,1,0,3,1,0,3,1,0,5,1,1,0,0,1,3,1,1,2,1,1,3,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,1,0,1,0,36 
  73. You had no submit button for the person details form, so it could not submit and no validation occurs. : 0 
  74. The order form was confusing, illogical and well beyond what was required. : 0 
  75. @@
  76. Fonts and styles of fonts help communicate the desired message by making it easier for the user to interpret the text within your web page. Using special fonts may results in different outcomes when viewed within a different browser. It is always advisable to use the common fonts such as Times Roman, Verdana, Arial, Sans Serif etc as these are supported by most browsers. It is also good practice to use bolding to identify specific information and where appropriate, colors to highlight certain information. Always use colors that can be easily read and when is doubt use a white background and black text.
  77. @@
  78. The specifications did not specify the types of controls you were to use and allowed you to explore various options based on the criteria laid down for each type of data you are collecting. The ordering of the software required you to supply the facilities for the user to enter a quantity. This could have been done by using a text box or a drop down list. Some students required the user to use a checkbox and enter a quantity of atleast one. This is not logical as a quantity of one implies the user wants to order the software so the checkbox is redundant.
  79. Using simple appropriate labels to identify the type of information the users is required to supply is very important. In most cases the label will be self evident but there are times where the label can mislead or confuse the user. For example if you are required to enter your phone number, you may label the input control: Phone : Does this mean home, office, order delivery phone number or the phone number of the orderer or recipient. Be specific to help the user and never assume the user knows what you want.
  80. The specification required you to supply the controls that enabled the user to enter a quantity for software item. Some students provided a drop down list of pre designated quantities. This is a solution is good if you know what is in stock, but with software stock is not required and the drop down list assumes the user never wants more than the quantities supplied. It is far better to provide the facilities for the user to order what they want, not what you determine.
  81. The specifications required you to provide a means of displaying a calculated Total for the items ordered. This should have been visible at all times and not via a popup dialog that is only shown when the order is updated. It is important to keep this type of information visible to the user.
  82. The specifications required you to provide a means of displaying a calculated GST the items ordered. This was 1/11th of the total price for each item. This should have been visible at all times and not via a popup dialog that is only shown when the order is updated. It is important to keep this type of information visible to the user.
  83. The specifications required you to provide a means of displaying a calculated Grand Total for the items ordered. This was calculated by adding the GST to the total but derivations were accepted. This should have been visible at all times and not via a popup dialog that is only shown when the order is updated. It is important to keep this type of information visible to the user.
  84. The layout of your form is important as it helps guide the user around your form and instructs them on the method for ordering the items. Poor layout can lead to incorrect orders and user frustration. The item description should come first followed by the price then the quantities or checkbox.
  85. The layout of your form is important as it helps guide the user around your form and instructs them on the method for ordering the items. Poor layout can lead to incorrect orders and user frustration. The item description should come first followed by the price then the quantities or checkbox.
  86. The specifications did not specify the types of controls you were to use and allowed you to explore various options based on the criteria laid down for each type of data you are collecting. User data is varied and there are opportunities to use all types of controls. Names, addresses, postcodes and so on require text boxes. Countries, States, Titles and so on may use drop down list boxes. The controls you use must reflect the clients specifications.
  87. Using simple appropriate labels to identify the type of information the users is required to supply is very important. In most cases the label will be self evident but there are times where the label can mislead or confuse the user. For example if you are required to enter your phone number, you may label the input control: Phone : Does this mean home, office, order delivery phone number or the phone number of the orderer or recipient. Be specific to help the user and never assume the user knows what you want.
  88. Ensure your examples reflect the actual validation requirements. With user details section of the form, some items required examples of the type of input that was required to ensure the user did not have to guess the type and format of the information. These should include: Phone, postcode, fax, email, credit card number, etc. Home Phone (##) ######## Email address (wells@deakiin.edu.au) Credit Card Number #### #### #### #### If you are validating information, then you must provide the desired format of this information. Do not expect the user to guess this format as many people use different formats. If the user has entered correct information but not in your format, it is frustrating for them to have to change it when you could have provided this guidance from the beginning.
  89. All information that was specified should have had the facilities for the user to enter it.
  90. The layout should have had the user information after the ordering of the products. It does not make sense to pay and give all your information before you go shopping. The layout of your form is important as it helps guide the user around your form and instructs them on the method for ordering the items. Poor layout can lead to incorrect orders and user frustration. The item description should come first followed by the price then the quantities or checkbox.
  91. The HTML should have adequate comments throughout to indicate the various sections of your form. This also included meta tags or information regarding the authors and other related information.
  92. It is important that the form and control names you use are logical and meaningful. These names are used within the form to indicate the type of information being collected, within the javascript to identify and manipulate the information and in the server side script that will receive and process this information. Vague, meaningless names complicate the programming and maintenance of the application.
  93. The HTML should have adequate comments throughout to indicate the various sections of your form. This also included meta tags or information regarding the authors and other related information.
  94. It is important that the form and control names you use are logical and meaningful. These names are used within the form to indicate the type of information being collected, within the javascript to identify and manipulate the information and in the server side script that will receive and process this information. Vague, meaningless names complicate the programming and maintenance of the application.
  95. JavaScript provides the tools to enable you to provide instant meaningful feedback to the user. When the user entered a quantity for a product within the order, it is a simple task to reflect the total for the order within a text or label control as desired. This should be done as the user makes changes to the order information and should not be as a consequence of selecting a Calculate button.
  96. JavaScript provides the tools to enable you to provide instant meaningful feedback to the user. When the user entered a quantity for a product within the order, it is a simple task to reflect the total for the order within a text or label control as desired. This should be done as the user makes changes to the order information and should not be as a consequence of selecting a Calculate button. The GST is calculated by taking 1/11th of the total for each product.
  97. JavaScript provides the tools to enable you to provide instant meaningful feedback to the user. When the user entered a quantity for a product within the order, it is a simple task to reflect the total for the order within a text or label control as desired. This should be done as the user makes changes to the order information and should not be as a consequence of selecting a Calculate button. The Grand Total is calculated by adding the Total for the order and the calculated GST value. Variations to this were accepted.
  98. @@
  99. The totals reflect an amount of money required to purchase the goods. Therefore the information displayed should reflect currency formats. The amounts should be rounded to 2 decimal places and a dollars sign either displayed via the label of inserted into the text at the beginning of the number. To even provide more detail a comma could be inserted where appropriate. $1,213.99
  100. @@
  101. Where there was a field that was required to complete the order, it must be checked for its presence and for the correct format. This should have be done when the order submit button was selected via the onSubmit event. Validating data via the onChange or OnBlur event can be acceptable but can also be frustrating tor the user.
  102. Where numbers were required such as in the quantity text field when ordering products, the number must be checked prior to calculating and adjusting the order. Non numeric data and negative numbers should be identified and where errors exist, a suitable, meaningful message presented to the user.
  103. User information must exist and include A-Z,a-z and characters '- and spaces. All other characters should be rejected and an appropriate, meaningful message displayed to the user explaining the errors.
  104. Phone and Fax information must exist where required and include 0-9 and characters - () + and spaces. All other characters should be rejected and an appropriate, meaningful message displayed to the user explaining the errors. Where a specific format is required, the format must be validated and an appropriate, meaningful message displayed to the user explaining the errors.
  105. State, PostCode and Country information must exist where required and include the required characters. All other characters should be rejected and an appropriate, meaningful message displayed to the user explaining the errors. Where a specific format is required, the format must be validated and an appropriate, meaningful message displayed to the user explaining the errors.
  106. Email address information must exist where required and include the required characters and format. All other characters should be rejected and an appropriate, meaningful message displayed to the user explaining the errors. Where a specific format is required, the format must be validated and an appropriate, meaningful message displayed to the user explaining the errors. There must be atleast two characters followed by a @ symbol, then more characters and a dot and either a 'com' string or more characters and so on until valid. Simply validation was accepted.
  107. Where you supplied a format for the information, the data should have been validated in the same format and an appropriate message displayed. If you did not provide an example format required then you cannot reflect the format indicated and you lost the marks. Some students displayed example data but validated and reported different formats.
  108. It is very important when communicating errors back to the user that these messages are clear, informative and guide the user so they can fix the errors. Supplying a statement saying "Error in phone number, incorrect format" does not tell the user what and where the errors is. A better message would be "Error in Phone number, the format required is (##) ######## where (##) is your area code and the ######## represent the 8 digits of your phone number.
  109. Email address information must exist where required and include the required characters and format. All other characters should be rejected and an appropriate, meaningful message displayed to the user explaining the errors. Where a specific format is required, the format must be validated and an appropriate, meaningful message displayed to the user explaining the errors. There must be atleast two characters followed by a @ symbol, then more characters and a dot and either a 'com' string or more characters and so on until valid. Simply validation was accepted.
  110. Your code should contain appropriate comments indicating what the functions do, the information they require and the output or result they produce. Within the functions, various areas of your code should also provide explanations as to the codes functionality.
  111. Code layout is very important as it makes the code easier to read and interpret. Generally each block of code is indented
  112. Where appropriate, functions should have been created to perform similar tasks. These functions could have checked whether a field existed, where a field is numeric, alpha, etc. Other functions to calculate and format information should also be used.

 

------------ END PROJECT FILE -------------------