From 91da3599c7a7148502a96e43715d8b9ed19f0243 Mon Sep 17 00:00:00 2001 From: ldinghan Date: Sun, 12 Nov 2023 10:43:43 +0800 Subject: [PATCH] Categorise command summary commands --- docs/UserGuide.md | 64 +++++++++++++++++++++++++++++++++------ docs/stylesheets/main.css | 2 +- 2 files changed, 56 insertions(+), 10 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a2f1207666d..1e69f8fae0a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -1740,37 +1740,83 @@ Format: `deleteconsult CONSULTATION_INDEX` ## Command summary +### General commands +| **Action** | **Format** |
**Examples**
| +|:------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Help** | `help` | `help` | +| **Switch Tabs** | `tab TAB_INDEX` | `tab 4` | +| **Exit** | `exit` | `exit` | +| **Clear** | `clear` | `clear` | + + +
+ +### Student commands +| **Action** | **Format** |
**Examples**
| +|:------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| +| **Add Student** | `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TESTS]` | `add n/James Ho p/12345678 e/jamesho@u.nus.edu th/james03 t/friend t/colleague gt/default` | +| **List Students** | `list` | `list` | +| **Edit Student** | `edit STUDENT_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [th/TELGRAM_HANDLE] [t/TAG]…[gt/GRADEDTEST]` | `edit 2 n/James Lee e/jameslee@u.nus.edu gt/default` | +| **Find Student** | `find KEYWORD [MORE_KEYWORDS]` | `find John`
`find alex david` | +| **Delete Student** | `delete STUDENT_INDEX` | `delete 3` | + +
+ +### Task commands | **Action** | **Format** |
**Examples**
| |:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| -| **Help** | `help` | `help` | -| **Switch Tabs** | `tab TAB_INDEX` | `tab 4` | -| **Exit** | `exit` | `exit` | -| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL th/TELEGRAM_HANDLE [t/TAG]…​ [gt/GRADED_TESTS]` | `add n/James Ho p/12345678 e/jamesho@u.nus.edu th/james03 t/friend t/colleague gt/default` | -| **List** | `list` | `list` | -| **Edit** | `edit STUDENT_INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [th/TELGRAM_HANDLE] [t/TAG]…[gt/GRADEDTEST]` | `edit 2 n/James Lee e/jameslee@u.nus.edu gt/default` | -| **Find** | `find KEYWORD [MORE_KEYWORDS]` | `find John`
`find alex david` | -| **Delete** | `delete STUDENT_INDEX` | `delete 3` | -| **Clear** | `clear` | `clear` | | **Add Task** | `addtask tn/TASK_NAME td/TASK_DESCRIPTION d/DUE_DATE tp/TASK_PRIORITY` | `addtask tn/Prepare Lecture slides d/30/09/2023 tp/high`,
`addtask tn/Read Chapter 5` | | **View Tasks** | `viewtasks [tn/TASK_NAME] / [td/TASK_DESCRIPTION] / [d/DUE_DATE] / [tp/TASK_PRIORITY] /
[tprog/TASK_PROGRESS]` | `viewtasks`,
`viewtasks tp/high`,
`viewtasks d/30/09/2023` | | **Update Progress** | `updateprogress TASK_INDEX tprog/NEW_PROGRESS` | `updateprogress 1 tprog/pending`,
`updateprogress 3 tprog/done` | | **Delete Task** | `deletetask TASK_INDEX` | `deletetask 3`,
`deletetask 2` | + +
+ +### Attendance commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **Take Attendance** | `takeattendance n/STUDENT_NAME s/SESSION p/PRESENCE` | `takeattendance n/John Doe s/5 present`,
`takeattendance n/Foo Bar s/2 absent` | | **View Attendance** | `viewattendance [n/STUDENT_NAME]…` | `viewattendance`,
`viewattendance n/Rayan`,
`viewattendance n/Jayson n/Resley` | + +
+ +### Assignment commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **View Assignments** | `viewassignments STUDENT_INDEX` | `viewassignments 1`,
`viewassignments 2` | | **Edit Grade** | `editgrade STUDENT_INDEX as/ASSIGNMENT g/GRADE` | `editgrade 1 as/Functional Expressionism g/1200`,
`editgrade 2 as/Rune Reading g/1000` | | **Delete Grade** | `deletegrade STUDENT_INDEX as/ASSIGNMENT` | `deletegrade 1 as/Functional Expressionism`,
`deletegrade 2 as/Rune Reading` | | **Edit Comment** | `editcomment STUDENT_INDEX as/ASSIGNMENT c/COMMENT` | `editcomment 1 as/Functional Expressionism c/Decent`,
`editcomment 2 as/Rune Reading c/Great` | | **Delete Comment** | `deletecomment STUDENT_INDEX as/ASSIGNMENT` | `deletecomment 1 as/Functional Expressionism`,
`deletecomment 2 as/Rune Reading` | + +
+ +### Graded Test commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **Edit Graded Test** | `editgradedtest STUDENT_INDEX [ra1/READING_ASSESSMENT_1] [ra2/READING_ASSESSMENT_2] [mt/MIDTERMS] [f/FINALS] [pe/PRACTICALEXAM]` | `editgradedtest 1 ra1/90 ra2/80 mt/85 f/88 pe/95`,
`editgradedtest 2 ra1/88 ra2/92 mt/78 f/80 pe/89` | + +
+ +### Session commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **Create Session** | `createsession s/SESSION_NUMBER n/STUDENT_NAME…` | `createsession s/4 n/Betsy Crower n/David Li` | | **Update Session Remark** | `updatesessionremark s/SESSION_NUMBER r/REMARK` | `updatesessionremark s/2 r/Teach Essence of Recursion`,
`updatesessionremark s/4 r/Taught streams and metacircular evalutator` | | **Delete Session** | `deletesession s/SESSION_NUMBER` | `deletesession s/1`,
`deletesession s/4` | + + +
+ +### Consultation commands +| **Action** | **Format** |
**Examples**
| +|:----------------------------:|:--------------------------------------------------------------------------------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------| | **Create Consultation** | `createconsult d/DATE tt/TIME n/STUDENT_NAME…` | `createconsult d/30/10/2023 tt/12:30 n/Alex Yeoh`,
`createconsult d/30/09/2023 tt/15:30 n/Alex Yeoh n/Betsy Crower n/David Li` | | **Add To Consultation** | `addtoconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `addtoconsult 2 n/Betsy Crower`,
`addtoconsult 1 n/David Li n/Roy Balakrishnan` | | **Remove From Consultation** | `removefromconsult CONSULTATION_INDEX n/STUDENT_NAME…` | `removefromconsult 2 n/Betsy Crower` | | **Delete Consultation** | `deleteconsult CONSULTATION_INDEX` | `deleteconsult 1` | +
[Back to Table of Contents](#table-of-contents) diff --git a/docs/stylesheets/main.css b/docs/stylesheets/main.css index 8e35687121f..204040053da 100644 --- a/docs/stylesheets/main.css +++ b/docs/stylesheets/main.css @@ -166,7 +166,7 @@ h6 { } .hljs.inline.no-lang, -.li .code { +li code { color: #A46AFF; /* GUI purple */ }