diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4886f35b816..897d5de4301 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -292,31 +292,31 @@ The following describes what each tab displays on the **Current Panel**: Most commands given in the user guide utilise various parameters which are also known as prefixes. To add a prefix to your command, follow this format: `PREFIX/MESSAGE`. Their prefixes and their respective constraints are given in the table below. -| **Field** | **Prefix** | **Commands** |
**Description**
| -|:--------------------:|:----------:|:-----------------------------------------------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| NAME | `n/` | `add` `edit` `addtoconsult` `createconsult` `removefromconsult` `createsession` `takeattendance` `viewattendance` | The Name of a student. | -| PHONE | `p/` | `add` `edit` | The Phone number of a student. | -| EMAIL | `e/` | `add` `edit` | The Email of a student. | -| TELEGRAM_HANDLE | `th/` | `add` `edit` | The Telegram handle of a student. | -| TAG | `t/` | `add` `edit` | The Tag belonging to a student. | -| GRADED_TEST | `gt/` | `add` `edit` | The scores of respective graded tests. | -| READING_ASSESSMENT_1 | `ra1/` | `editgradedtest` | The score of Reading Assessment 1. | -| READING_ASSESSMENT_2 | `ra2/` | `editgradedtest` | The score of Reading Assessment 2. | -| MIDTERMS | `mt/` | `editgradedtest` | The score of a Midterms exam. | -| FINALS | `f/` | `editgradedtest` | The score of a Finals exam. | -| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The score of a Practical exam. | -| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The name of an Assignment. | -| GRADE | `g/` | `editgrade` | The grade of an Assignment. | -| COMMENT | `c/` | `editcomment` | The Comment of an Assignment. | -| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date. | -| TIME | `tt/` | `createconsult` | The Time. | -| SESSION | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Tutorial. | -| SESSION_REMARK | `r/` | `updatesessionremark` | The remarks of a Session. | -| ATTENDANCE_PRESENCE | `ap/` | `takeattendance` | The presence of a student. | -| TASK_NAME | `tn/` | `addtask` `viewtasks` | The name of a Task. | -| TASK_DESCRIPTION | `td/` | `addtask` `viewtasks` | The description of a Task. | -| TASK_PRIORITY | `tp/` | `addtask` `viewtasks` | The priority of a Task. | -| TASK_PROGRESS | `tprog/` | `addtask` `viewtasks` `updateprogress` | The progress of a Task. | +| **Field** | **Prefix** | **Commands** |
**Description**
| +|:--------------------:|:----------:|:-----------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NAME | `n/` | `add` `edit` `addtoconsult` `createconsult` `removefromconsult` `createsession` `takeattendance` `viewattendance` | The Name of a student. | +| PHONE | `p/` | `add` `edit` | The Phone number of a student. | +| EMAIL | `e/` | `add` `edit` | The Email of a student. | +| TELEGRAM_HANDLE | `th/` | `add` `edit` | The Telegram handle of a student. | +| TAG | `t/` | `add` `edit` | The Tag belonging to a student. | +| GRADED_TEST | `gt/` | `add` `edit` | The scores of respective graded tests. | +| READING_ASSESSMENT_1 | `ra1/` | `editgradedtest` | The score of Reading Assessment 1. | +| READING_ASSESSMENT_2 | `ra2/` | `editgradedtest` | The score of Reading Assessment 2. | +| MIDTERMS | `mt/` | `editgradedtest` | The score of a Midterms exam. | +| FINALS | `f/` | `editgradedtest` | The score of a Finals exam. | +| PRACTICAL_EXAM | `pe/` | `editgradedtest` | The score of a Practical exam. | +| ASSIGNMENT | `as/` | `deletecomment` `editcomment` `editgrade` | The name of an Assignment. | +| GRADE | `g/` | `editgrade` | The grade of an Assignment. | +| COMMENT | `c/` | `editcomment` | The Comment of an Assignment. | +| DATE | `d/` | `addtask` `viewtasks` `createconsult` | The Date. | +| TIME | `tt/` | `createconsult` | The Time. | +| SESSION | `s/` | `createsession` `deletesession` `takeattendance` `updatesessionremark` | The Session Number of a Tutorial. | +| SESSION_REMARK | `r/` | `updatesessionremark` | The remarks of a Session. | +| ATTENDANCE_PRESENCE | `ap/` | `takeattendance` | The presence of a student. | +| TASK_NAME | `tn/` | `addtask` `viewtasks` | The name of a Task. | +| TASK_DESCRIPTION | `td/` | `addtask` `viewtasks` | The description of a Task. | +| TASK_PRIORITY | `tp/` | `addtask` `viewtasks` | The priority of a Task. | +| TASK_PROGRESS | `tprog/` | `addtask` `viewtasks` `updateprogress` | The progress of a Task. | [Back to Table of Contents](#table-of-contents)