Your TA - User Guide

Adds a person (student) into the person list.

Alias: a and +
Format: add n/NAME m/MATRICULATION NUMBER p/PHONE_NUMBER e/EMAIL a/ADDRESS dp/[IMAGE PATH] [t/TAG]…​

Examples:

The application initially starts with default inputs as displayed in Figure 5 below.

Let’s try entering a command.

Command entered: add n/John Doe m/A0111111X p/98765432 e/johnd@example.com a/John street, block 123, #01-01 dp/C:\Users\Name\Desktop\John.jpg

Result: This will add 'John Doe' into the person list with his respective details (as seen in Figure 6).

Let’s try another command.

Command entered: add n/Betsy Crowe t/friend m/A1234567C e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal

Result: This will add 'Betsy Crowe' into the person list with her respective details (as seen in Figure 7).

Finds students whose names contain any of the given keywords or whose matriculation number corresponds to the given keyword and lists them as results.

Alias: f
Format: find KEYWORD [MORE_KEYWORDS]…​

Examples:

The application starts with the following as shown in Figure 8 below.

Let’s say you’re looking for a person with the name 'John'.

Command entered: find John

Result: The application searches for the keyword 'John' and returns 1 result (see Figure 9).

The next command shows how to search using multiple keywords.

Command entered: find Betsy Tim John

Result: The application searches for the keywords 'Betsy', 'Tim' and 'John' and returns 2 results (see Figure 10).

The next command shows how to search using matriculation number.

Command entered: find A0111111X

Result: The application searches for the person with the matriculation number as shown and returns 1 result (see Figure 11).

Displays a list of all persons in the application.

Alias: ls
Format: list

Example:

Command entered: list

Result: Application lists all persons who have been added up until this point (see Figure 12).

Edits an existing person (has already been added) in the application.

Alias: e
Format: edit INDEX [n/NAME] [m/MATRICULATION NUMBER] [p/PHONE] [e/EMAIL] [a/ADDRESS] [dp/IMAGE PATH] [t/TAG]…​

Examples:

Address book starts with the following as shown in Figure 13 below.

Say you wish to edit the details of 'Betsy Crowe'.

Command entered: edit 2 p/91234567 e/johndoe@example.com dp/C:\Users\Name\Desktop\betsy.jpg

Result: This changes the details of the person with index 2 (Betsy Crowe) and writes over her original saved details (Figure 14).

If you find that you’ve added someone with incorrect details, you can change the entry.

Command entered: edit 1 n/John Doeser

Result: This changes the details of the person with index 1 (originally John Doe) and updates his details (see Figure 15).

Sorts all entries found in the person list in alphabetical order based on name.

Alias: s
Format: sort

Adds to the participation marks of a person (student). The maximum limit for participation marks is 100 and the maximum amount that can be added per execution of the command is 100.
i.e. if someone has 90 marks and you add 20, the participation marks will be capped at 100.

If the marks are below 50, there will be a red frame surrounding the person’s profile picture. If the person has 50 or more marks, the colored frame around the user will change to green.

Format: markPart INDEX marks/DIGITS

Examples:

Command entered: list

Result: Lists all people in the application (see Figure 16).

Command entered: markPart 1 marks/50

Result: Adds 50 participation marks to the 1st person in Your TA (see Figure 17).

Command entered: find David

Result: Returns David as a result (see Figure 18).

Command entered: markPart 1 marks/70

Result: Adds 70 marks to the 1st person in the results of the find command, in this case, David.
Note that it has exceeded the cap of 100, hence the marks was set to 100 (see Figure 19).

Updates a person’s display picture in the application.

Format: updateDP INDEX dp/[IMAGE PATH]

Examples:

Command entered: list

Result: Lists all people in Your TA (see Figure 20).
We can see that Alex Yeoh has a display picture.

Command entered: updateDP 1 dp/

Result: Deletes the display picture of the 1st person, returning it back to the default profile picture (see Figure 21).

Command(s) entered: find Betsy, updateDP 1 dp/C:\Users\Betsy\Desktop\betsy.jpg

Result: Returns Betsy as a result and updates the display picture of the 1st person, in this case Betsy, to the picture specified in the dp/ field.

Deletes the specified person from the address book.

Alias: d and -
Format: delete INDEX

Examples:

Address book starts with the following as shown in Figure 22 below.

Command(s) entered: list, delete 2

Result: The 2nd person listed in the address book is deleted (see Figure 23).

Command(s) entered: find John, delete 1

Result: The 1st person listed in the person list, in this case, John is deleted (see Figure 24).

Selects the person identified by the index number used in the last person listing.

Alias: s
Format: select INDEX

Examples:

Your TA starts with the following as shown in Figure 25 below.

Command(s) entered: list, select 1

Result: Lists all people in address book and selects the 1st person (see Figure 26).

Command(s) entered: find Betsy, select 1

Result: The 1st person in the results of the find command is selected, in this case, Betsy is selected (see Figure 27).

Switches between the Person List tab and Todo List tab.

Alias: swt
Format: switchTab

Figure 29 below shows the result of entering command switchTab switching from Person List to Todo List and the display of command result.

Adds a task to the address book.

Alias: at
Format: addTask title/TITLE desc/TASK DESCRIPTION by/DEADLINE priority/PRIORITY

New tasks will be added into the To-do list and Calendar.

Examples:

Current date: 15-04-2018

The application initially starts with no tasks, as seen in Figure 30 below.

Command entered: addTask title/Grade Exams desc/Grade mid-terms by/20-04-2018 priority/2

Result: This will add a task, 'Grade mid-terms' into the todo list with the respective details (see Figure 31).

Command entered: addTask title/Submit Attendance desc/Submit tutorial attendance by/21-04-2018 priority/3

Result: This will add a task, 'Submit tutorial attendance' into the calendar and todo list with the respective details into the application (see Figure 32).

Edits a task in the todo list.

Alias: et
Format: editTask INDEX [title/TASK TITLE] [desc/TASK DESCRIPTION] [by/DEADLINE] [priority/PRIORITY]

The specified tasks will be edited in the Todo List and Calendar.

Examples:

Current date: 15-04-2018

The application initially starts with 2 tasks (see Figure 33).

Command entered: editTask 1 priority/1

Result: This edits the task at index 1, and change its priority to 1 (see Figure 34).

Command entered: editTask 2 by/23-04-2018

Result: This edits the task at index 2, and change its deadline to 23-04-2018 (see Figure 35).

Deletes a task in the todo list.

Alias: dt
Format: deleteTask INDEX

The specified indexed task will be deleted from the Todo List and Calendar.

Examples:

Current date: 15-04-2018

The application initially starts with 2 tasks as seen in Figure 36 below.

Command entered: deleteTask 1

Result: This will delete the task at index 1, as shown in Figure 37 below.

Shows a list of all tasks in application.

Alias: lt
Format: listTask

All the tasks stored in application will be listed in the Todo List.

Shows a list of tasks that have their deadlines in the current month.

Alias: lct
Format: listCurrentTask

Only the tasks due within current month will be listed in the Todo List.

Figure 38 below illustrates the change in tasks displayed after listCurrentTask is entered.

Sorts all entries displayed in Todo List in date order.

Alias: stt Format: sortTask

Lists all the commands that you have entered in reverse chronological order.

Alias: h
Format: history

Restores the address book to the state before the previous undoable command was executed.

Alias: u
Format: undo

Examples:

Address book starts with the following as shown in Figure 39 below.

Command(s) entered: delete 1, list, undo

Result: The delete 1 command will be reversed.
End result should look the same as Figure 39.

Command(s) entered: select 1, list, undo
Result: The undo command fails as there are no undoable commands executed previously.
End result should look the same as Figure 39.

Command(s) entered: delete 1, clear, undo, undo
Result: Both commands reversed.
End result should look the same as Figure 39.

Reverses the most recent undo command.

Alias: r
Format: redo

Examples:

The application starts with the same one in Figure 39.

Command(s) entered: delete 1, undo, redo

Result: The delete command is reversed, then reapplied (see Figure 40).

Command(s) entered: delete 1, redo

Result: The redo command fails as there are no undo commands executed previously.
End result should look the same as in Figure 39.

Command(s) entered: delete 1, clear, undo, redo

Result: clear command and delete command are reversed. clear command and delete command are subsequently reapplied (see Figure 41).

Clears all entries from the address book.
This command will also clear all the display picture images stored.

Alias: c
Format: clear

Extracts data from an xml formatted file and replaces the current stored data.

Format: import FILEPATH

Example:

Command entered:
import ~/download/NewData.xml

Exits the program.

Format: exit

The add command adds a person into the application.
This command has specific compulsory (must-have) and non-compulsory fields.

Compulsory fields:

Non-Compulsory fields:

Each individual field has a specific format requirement.
e.g the NAME field must only contain letters.

If the wrong format is detected, the application will prompt you of the correct input format in the results display panel right underneath the command input line.

As stated in section 8.2, certain commands (not all) can be undone.

Commands that cannot be undone: