Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update UG #164

Merged
merged 6 commits into from
Oct 27, 2023
Merged

Update UG #164

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ec17a9b
Modify user guide
NgChunMan Oct 25, 2023
ca878ef
Resolve merge conflict
NgChunMan Oct 26, 2023
8b7995c
Update user guide
NgChunMan Oct 26, 2023
6050e48
Update user guide
NgChunMan Oct 26, 2023
cfb4fba
Update user guide
NgChunMan Oct 27, 2023
1255619
Resolve merge conflict
NgChunMan Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 110 additions & 73 deletions docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,17 +130,17 @@ Acceptable values for each parameter:

- must be a non-empty string

`TASK_INDEX`:
- must be a valid index starts from 1

--------------------------------------------------------------------------------------------------------------------

# General Commands

### Viewing help : `help` (//TODO Update)
### Viewing help : `help`

Shows a message explaning how to access the help page.

// TODO Update
![help message](images/helpMessage.png)

Format: `help`

### Listing all users : `ls`
Expand Down Expand Up @@ -191,13 +191,13 @@ Specified path:

#### Output if command fails:

- Pop up message indicating either:
- Displays message indicating either:
- Invalid command format
- Invalid path

#### Output if command succeeds:

- Pop up message indicating successful creation together with information of created student
- Displays message indicating successful creation together with information of created student

#### To note:

Expand Down Expand Up @@ -228,13 +228,13 @@ Specified path:

#### Output if command fails:

- Pop up message indicating either:
- Displays message indicating either:
- Invalid command format
- No such target to delete

#### Output if command succeeds

- Pop up message indicating target successfully removed
- Displays message indicating target successfully removed

#### Examples:

Expand All @@ -247,60 +247,64 @@ Specified path:

### Move students into/out of the group: `mv`

Moves student from a group to another group
Moves student from one group to another group

Format `mv [StudentID] -source [source group] -dest [destination group]`
Format: `mv SPECIFIED_PATH SPECIFIED_PATH`

Acceptable values for each parameter:
StudentID:

- must be a 4 digits number follow with any letter
#### Acceptable values for each parameter:

source group:
SPECIFIED_PATH:

- must be a valid non-empty string starting with grp-
- must be a valid path to a student

destination group:
SPECIFIED_PATH:

- must be a valid non-empty string starting with grp-
- must be a valid path to a group

Output if command fails
#### Output if command fails

- pop up message indicate error when moving student with id 0123Y from grp-1 to grp-2
- Displays message indicating either:
- Invalid command format
- No such student to move
- Invalid destination path

Output if command succeeds
#### Output if command succeeds

- pop up message indicates successfully moving student with id 0123Y from grp-1 to grp-2
- Displays message to indicate the successful transfer of a student from one group to another group

Examples:
`mv 0123Y -source grp-1 -dest grp-2`
#### Examples:
- When user is at the root directory `~` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002:
- `mv grp-001/0123Y grp-002`

- This command will move a student with value id 0123Y within the groups or from Ungroup to Group.
- When user is at the group directory `~/grp-001` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002:
- `mv 0123Y ../grp-002`

### Create Group : `mkdir`

Creates a group consists of a maximum of five students
Creates a group consists of students

Format: `mkdir [groupId]`
Format: `mkdir PATH_TO_THE_GROUP`
Nid21cs marked this conversation as resolved.
Show resolved Hide resolved

Acceptable values for each parameter:
groupId:
#### Acceptable values for each parameter:

- groupId must be a non-empty string starting with grp-
PATH_TO_THE_GROUP:

Output if command fails
- must be a valid path to a group

- pop up message indicates error when creating new group
#### Output if command fails

Output if command succeeds
- Displays message indicating either:
- Invalid command format
- Invalid path to a group

- pop up message indicates group with specific groupId was created successfully.
#### Output if command succeeds

Examples:
`mkdir grp-1`
- Displays message indicating a group was created successfully

- This command will create a group with groupId which is a string called 1 and only consists the creator at that
instance of creating the group
#### Examples:

- When user is at the root directory `~` and keys in the following command, a group with groupId called grp-001 will be created
- `mkdir grp-001`

--------------------------------------------------------------------------------------------------------------------

Expand All @@ -318,13 +322,13 @@ Format: `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY`

#### Output if command fails:

- Pop up message indicating either:
- Displays message indicating either:
- Invalid command format
- Invalid path

#### Output if command succeeds

- Pop up message indicating todo task created successfully.
- Displays message indicating todo task created successfully.

#### Examples:

Expand All @@ -351,13 +355,13 @@ Format `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --al

#### Output if command fails:

- Pop up message indicating either:
- Displays message indicating either:
- Invalid command format
- Invalid path

#### Output if command succeeds

- Pop up message indicating deadline task created successfully.
- Displays message indicating deadline task created successfully.

#### Examples:

Expand All @@ -371,37 +375,63 @@ Format `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --al
for the task with description `Assignment 1`, will be allocated to all students in path `~/grp-001`.
- `deadline ~/grp-001 --desc Assignment 1 --datetime 2023-10-11 23:59 --all allStu`

### Mark/Unmark tasks as completed: `mark`
### Mark tasks as completed: `mark`

Marks specific tasks as done for each student/tutorial group
Marks the specified task as done for the student

Format: `mark -d [task] -level [student/group] -target [StudentID/groupId] `
Format: `mark TASK_INDEX`

Acceptable parameter should be:
task:
#### Acceptable parameter should be:

- must be a valid non empty String
taskIndex:

student:
- must be a valid index starts from 1

- String should be "student" or "group"
#### Output if command fails

StudentID:
- Displays message indicating either:
- Invalid command format
- Invalid task index
- The display panel is not showing task list

- must be a valid non empty String starting with
#### Output if command succeeds

Output if command fails
- Displays message indicating mark is done successfully as well as specific task that is marked

- pop up message saying mark is not done as well as specific task that is unchanged
#### Examples:

Output if command succeeds
- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can mark task by specifying the task index:
- `cat 0123Y`
- `mark 1`

- pop up message saying mark is done successfully as well as specific task that is marked
### Unmark completed task: `unmark`

Examples:
`mark -d Assignment 1 -level student -target 0123Y`
Unmarks the specified task for the student

Format: `unmark TASK_INDEX`

#### Acceptable parameter should be:

taskIndex:
Nid21cs marked this conversation as resolved.
Show resolved Hide resolved

- must be a valid index starts from 1

#### Output if command fails

- Displays message indicating either:
- Invalid command format
- Invalid task index
- The display panel is not showing task list

#### Output if command succeeds

- Displays message indicating unmark is done successfully as well as specific task that is unmarked

#### Examples:

- This command will mark 0123Y's Assignment 1 as done
- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can unmark task by specifying the task index:
- `cat 0123Y`
- `unmark 1`

### Search for Tasks: `find`

Expand Down Expand Up @@ -482,17 +512,24 @@ the data of your previous ProfBook home folder.

## Command summary

| Action | Format, Examples |
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Help** | `help` |
| **List** | `ls` |
| **Clear** | `clear` |
| **Exit** | `exit` |
| **Add** | `touch student -n [name] -id [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Group** | `mkdir [groupId]` <br> e.g., `mkdir grp-1` |
| **Delete** | `rm [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]` <br> e.g., `todo -desc ps1 -level student -target 0123Y` |
| **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`<br> e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` |
| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`<br> e.g.,`mark -d Assignment 1 -level student -target 0123Y` |
| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`<br> e.g.,`unmark -d Assignment 1 -level student -target 0123Y` |
| **Find** | `find [task]`<br> e.g., `find grade proposal` |
| Action | Format, Examples |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Help** | `help` |
| **List** | `ls` |
| **Clear** | `clear` |
| **Exit** | `exit` |
| **Add** | `touch student -n [name] -id [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Group** | `mkdir PATH_TO_THE_GROUP` <br> e.g., `mkdir grp-1` |
| **Delete** | `rm [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]` <br> e.g., `todo -desc ps1 -level student -target 0123Y` |
| **Add** | `touch student -n [name] -id [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Group** | `mkdir [groupId]` <br> e.g., `mkdir grp-001` |
| **Delete** | `rm [StudentId]` <br> e.g., `touch student -n Gary -id 1234Y` |
| **Create Todo** | `todo -desc [task] -level [student/group] -target [StudentID/group Id/tutorialId]` <br> e.g., `todo -desc ps1 -level student -target 0123Y` |
| **Create Deadline** | `deadline -desc [task] -level [student/group] -target [StudentID/groupId/tutorialId] -byDate[dd/MM/yyyy]`<br> e.g., `deadline -d grade proposal 1 -level group -target tut-1 -byDate 20/10/2023` |
| **Mark** | `mark -d [task] -level [student/group] -target [StudentID/groupId]`<br> e.g.,`mark -d Assignment 1 -level student -target 0123Y` |
| **Mark** | `unmark -d [task] -level [student/group] -target [StudentID/groupId]`<br> e.g.,`unmark -d Assignment 1 -level student -target 0123Y` |
| **Mark** | `mark TASK_INDEX`<br> e.g.,`mark 1` |
| **Unmark** | `unmark TASK_INDEX`<br> e.g.,`unmark 2` |
| **Find** | `find [task]`<br> e.g., `find grade proposal` |