Merge pull request #190 from RnardHa/UGDG

User Guide

docs/DeveloperGuide.adoc

@@ -446,9 +446,40 @@ This feature can only be performed by users that have `ASSIGN_PERMISSION` permis
 
 // end::permission
 
-// tag::project
+
+// tag::keyboardshortcuts[]
+=== Command Shortcuts
+
+With various keyboard combinations user will be able to invoke commands' keyword.
+
+==== Current Implementation
+
+Keyboard shortcuts in OASIS is implemented in the KeyEvent handler within the `CommandBox` class.
+
+When key combination is pressed, the text in the Command Box will be replaced with the corresponding command word.
+
+==== Aspect: Logic & UI
+
+Within the `CommandBox` class, there is KeyEvent handler method which will detect keyboard strokes. If the key pressed is a valid 
+combination, then the text in the command box will be replaced with the text corresponding to one of the existing commands.
+
+==== Design Consideration
+
+Current Implementation: Use the KeyEvent handler in the `CommandBox` class.
+
+** Pros: It is easy and simple to implement.
+
+** Cons: As the number of commands increases over time, there will not be 
+enough key combination to accommodate all the commands. 
+
+
+// tag::keyboardshortcuts[]
+
+
+// tag::assignment[]
 === Assignment Management
-Assignment management is an important feature in company management system. As such there are four critical features of assignment management. These features are `addassignment`, `listassignment`, `deleteassignment` and `assignassignment`.
+Assignment management is an important feature in company management system. As such there are four critical features of assignment management. These features are `addassignment`, 
+`listassignments`, `deleteassignment` and `editassignment`.
 
 These commands could only be executed by user with the appropriate permission.
 
@@ -459,7 +490,7 @@ Model of the assignment has been created. `Assignment` will store information su
 
 The following diagram shows the class added to reflect the model `Assignment`:
 
-image::ProjectModel.PNG[width="450"]
+image::AssignmentModel.PNG[width="450"]
 
 ===== Aspect: Storage
 Add `XmlSerializableAssignmentList` and `XmlAdaptAssignment` class to Storage component. `XmlAdaptAssignment` will then have the element for assignment name, assignment author and assignment description.
@@ -524,7 +555,7 @@ Step 4. The system lists the assignments.
 ** Pros: Fast and efficient retrieval of information, even when the amount of data is massive.
 ** Cons: Separated system needs to be set up to store information. Additional cost.
 
-// end::project
+// end::assignment[]
 
 // tag::archive[]
 === View deleted employee archive feature

docs/UserGuide.adoc

@@ -90,6 +90,12 @@ Format: `history`
 Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and next input respectively in the command box.
 ====
 
+=== Navigate between the list pickers : `active / archive / assignment`
+
+Pick desired list within the system.
+
+Format: `active / archive / assignment`
+
 === Adding an employee: `add`
 
 Adds an employee into the system.
@@ -157,15 +163,49 @@ Examples:
 
 Adds an assignment into the system.
 
-Format: `addassignment -an ASSIGNMENT_NAME -au AUTHOR -d DESCRIPTION`
+Format: `addassignment -an ASSIGNMENT_NAME -au AUTHOR -de DESCRIPTION`
 
 ****
 * To use this command, you must be logged in with "ADD_ASSIGNMENT" permissions.
 ****
 Examples:
 
-* `addassignment -an KRYPTONE -au Jhonny English -d Data encription application.`
-* `addassignment -n IRobot -au Tom Smith -d Autonomous robotic vacuum cleaner which has intelligent programming.`
+* `addassignment -an KRYPTONE -au Jhonny English -de Data encription application.`
+* `addassignment -n IRobot -au Tom Smith -de Autonomous robotic vacuum cleaner which has intelligent programming.`
+
+=== List all assignments :  `listassignments`
+
+Displays a list of assignments that are in the system.
+
+Format: `listassignments`
+
+=== Removing an assignment : `deleteassignmnet`
+
+Removes an assignment from the system.
+
+Format: `deleteassignment INDEX`
+
+****
+* To use this command, you must be logged in and have the "DELETE_ASSIGNMENT" permission.
+****
+
+Examples:
+
+* `deleteassignment 3`
+
+=== Edit assignment details : `editassignment`
+
+Changes assignment details (such as description).
+
+Format: `editassignment INDEX [-an ASSIGNMENT NAME] [-au AUTHOR] [-de DESCRIPTION]`
+
+****
+* To use this command, you must be logged in and have the "EDIT_ASSIGNMENT" permission.
+* Edit the assignment at the specified INDEX. The index refers to the number shown in the displayed assignment list.
+The index must be a positive integer 1, 2, 3, …​
+* At least one of the optional fields must be provided.
+* Existing values will be updated to the input values.
+****
 
 === Apply for leave : `leaveapply`
 
@@ -507,22 +547,6 @@ View income summary for the month.
 
 Format: `summary`
 
-=== Listing all assignments: `listassignment`
-
-Shows a list of all assignments in the system.
-
-Format: `listassignment`
-
-=== Removing an assignment: `deleteassignment`
-
-Removes an assignment from the system.
-
-Format: `deleteassignment INDEX`
-
-****
-* To use this command, you must be logged in with "DELETE_ASSIGNMENT" permissions.
-****
-
 == FAQ
 
 *Q*: What if I lose my password? +
@@ -541,6 +565,7 @@ Format: `deleteassignment INDEX`
  |Help|help|help
  |History|history|history
  |List all employees|list|list
+ |List all assignments|listassignments|listassignments
  |Edit details of the currently logged in user|myself|myself -p 99900999 -e a@b.com -a Somewhere over the rainbow
  |Sort employee display list| sort -CRITERIA| sort -df
  |Select an employee|select INDEX | select 1
@@ -580,3 +605,10 @@ Format: `deleteassignment INDEX`
  |Edit an assignment|EDIT_ASSIGNMENT|editassignment INDEX [-an ASSIGNMENT NAME] [-au AUTHOR] [-de DESCRIPTION]| editassignment 1 -an OASIS v2.0 -au MARY GOSLOW
 |=========================================================
 
+== Keyboard Shortcuts
+
+[width="100%",options="header"]
+|=========================================================
+|Command|Key
+|
+|=========================================================

src/main/java/seedu/address/logic/commands/ListAssignmentCommand.java

@@ -13,7 +13,7 @@
  */
 public class ListAssignmentCommand extends Command {
 
-    public static final String COMMAND_WORD = "listassignment";
+    public static final String COMMAND_WORD = "listassignments";
 
     public static final String MESSAGE_SUCCESS = "Listed all assignments";
 

src/main/java/seedu/address/model/project/ProjectName.java

@@ -9,7 +9,7 @@
  */
 public class ProjectName {
 
-    public static final String MESSAGE_PROJECT_NAME_CONSTRAINTS = "Assignment names should not be blank";
+    public static final String MESSAGE_PROJECT_NAME_CONSTRAINTS = "Assignment name should not be blank";
 
     /*
      * The first character of the project name must not be a whitespace,