From 1edf6a6800c8d62850831bf96e572cc82cf5bf81 Mon Sep 17 00:00:00 2001 From: Wen Jin Date: Fri, 16 Oct 2020 16:55:19 +0800 Subject: [PATCH 1/5] Update UG View Lesson --- docs/UserGuide.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index dcf34c2feb4..3eda801d768 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -45,6 +45,10 @@ By: `Team Serenity` Since: `Aug 2020` * [Deleting a question: `deleteQn`](#deleting-a-question-deleteqn) * [Marking a question as answered: `ansQn`](#marking-a-question-as-answered-ansqn) + + 4.5. [Utility](#ins45-utilityins) + + 4.5.2. [View an existing tutorial lesson: `viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) 5. [FAQ](#faq) @@ -318,6 +322,29 @@ Marks the specified question from the list of questions of a specified tutorial Outcome: +--- + +### 4.5 Utility + +#### 4.5.2. View an existing tutorial lesson: `viewlsn` +You can use this command to view the attendance, participation scores and questions of an existing tutorial group. You will also be able to execute tutorial lesson-related commands. + +**Format:** +`viewlsn grp/GROUP lsn/LESSON` + +**Example:** +Suppose you would like to view the details for tutorial group G04's **lesson 1-2**. You can perform the following steps. + +To view tutorial group G04's **lesson 1-2**: +1. Type `viewlsn grp/G04 lsn/1-2` into the *Command Box*. +2. Press `Enter` to execute. + +Outcome: +1. The *Result Display* will show a success message. +2. The *Data Display* will update and display the students' information for tutorial group G04's **lesson 1-2**. + +![Figure X. Outcome of a successful view lesson command](reference) + -------------------------------------------------------------------------------------------------------------------- ## FAQ From 4ac20079fcc013f09ccf20eb8a2480b218fd2833 Mon Sep 17 00:00:00 2001 From: Wen Jin Date: Fri, 16 Oct 2020 17:17:54 +0800 Subject: [PATCH 2/5] Update UG Question Addressing --- docs/UserGuide.md | 89 +++++++++++++++-------------------------------- 1 file changed, 28 insertions(+), 61 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3eda801d768..b9ebdfd26dc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -36,16 +36,12 @@ By: `Team Serenity` Since: `Aug 2020` * [Exporting of class participation grades to CSV: `exportCp`](#exporting-of-class-participation-grades-to-csv-exportcp) - 4.4 [Addressing Questions](#addressing-questions) + 4.4 [Question Addressing](#ins44-question-addressingins) - * [Adding a question: `addQn`](#adding-a-question-addqn) + 4.4.1 [Adding a question: `addQn`](#441-add-a-new-question-addqn) - * [Viewing all questions: `questions`](#viewing-all-questions-list) + 4.4.2 [Deleting a question: `deleteQn`](#442-delete-an-existing-question-delqn) - * [Deleting a question: `deleteQn`](#deleting-a-question-deleteqn) - - * [Marking a question as answered: `ansQn`](#marking-a-question-as-answered-ansqn) - 4.5. [Utility](#ins45-utilityins) 4.5.2. [View an existing tutorial lesson: `viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) @@ -255,72 +251,43 @@ Outcome: --- -### Addressing Questions - -#### Adding a question: `addQn` - -Adds a question to the list of questions of a specified tutorial group. - -##### Format: - -`addQn TUTORIAL_GROUP LESSON_NUMBER QUESTION_DESCRIPTION` - -##### Examples: -* `addQn G07 7-1 Could you elaborate on the marking scheme for OP1?` -* `addQn G07 7-1 What are the deadlines that students should take note of?` - -Outcome: - - -#### Viewing all questions: `questions` - -View a list of all the questions from a specified tutorial group. - -##### Format: - -`questions TUTORIAL_GROUP LESSON_NUMBER` - -##### Examples: -* `questions G07 7-1` -* `questions G10 5-2` - -Outcome: - +### 4.4. Question Addressing -#### Deleting a question: `deleteQn` +Need to keep track of all your students' questions during lessons quickly? This feature allows you to key in questions easily for future references. -Deletes the specific question from the list of questions of a specified tutorial group. +#### 4.4.1. Add a new question: `addqn` +You can use this command to add a question that was asked in a lesson, so that you can address the question at the end of the lesson. -##### Format: +**Format:** +`addqn qn/QUESTION` -`deleteQn TUTORIAL_GROUP LESSON_NUMBER INDEX` -* Deletes the question at the specified `INDEX`. -* The index refers to the index number shown in the displayed question list. -* The index **must be a positive integer** 1, 2, 3, …​ +**Example:** +When teaching group `G04` lesson `1-2`, a student ask a question, and you want to note it down. -##### Examples: -* `deleteQn G07 7-1 1` -* `deleteQn G10 5-2 3` +To add a question to group `G04` lesson `1-2`: +1. Navigate to view group `G04` lesson `1-2` via ![`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. +2. Type `addqn qn/What is the deadline for the report?` into the *Command Box*. +3. Press `Enter` to execute. Outcome: +1. The *Result Display* will show a success message. +#### 4.4.2. Delete an existing question: `delqn` +You can use this command to add a question that was asked in a tutorial lesson, so that you can address the question at the end of the lesson. -#### Marking a question as answered: `ansQn` - -Marks the specified question from the list of questions of a specified tutorial group as answered. - -##### Format: +**Format:** +`delqn INDEX` -`ansQn TUTORIAL_GROUP LESSON_NUMBER INDEX` -* Marks the question at the specified `INDEX` as answered. -* The index refers to the index number shown in the displayed question list. -* The index **must be a positive integer** 1, 2, 3, …​ +**Example:** +When teaching group `G04` lesson `1-2`, you answered one of the questions and wants to delete it from the list of questions. -##### Examples: -* `ansQn G07 7-1 1` -* `ansQn G10 5-2 3` +To delete a question from group `G04` lesson `1-2`: +1. Navigate to view group `G04` lesson `1-2` via ![`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. +2. Type `delqn 1` into the *Command Box*. +3. Press `Enter` to execute. Outcome: +1. The *Result Display* will show a success message. --- @@ -343,7 +310,7 @@ Outcome: 1. The *Result Display* will show a success message. 2. The *Data Display* will update and display the students' information for tutorial group G04's **lesson 1-2**. -![Figure X. Outcome of a successful view lesson command](reference) +![Figure X. Outcome of a successful `viewlsn` command](#) -------------------------------------------------------------------------------------------------------------------- From 2229ba789b7258dde1fb581f7087cfaf079976b7 Mon Sep 17 00:00:00 2001 From: Wen Jin Date: Fri, 16 Oct 2020 17:25:18 +0800 Subject: [PATCH 3/5] Update UG Question Addressing --- docs/UserGuide.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index b9ebdfd26dc..3bcc4470134 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -36,11 +36,11 @@ By: `Team Serenity` Since: `Aug 2020` * [Exporting of class participation grades to CSV: `exportCp`](#exporting-of-class-participation-grades-to-csv-exportcp) - 4.4 [Question Addressing](#ins44-question-addressingins) + 4.4. [Question Addressing](#ins44-question-addressingins) + + 4.4.1. [Adding a question: `addQn`](#441-add-a-new-question-addqn) - 4.4.1 [Adding a question: `addQn`](#441-add-a-new-question-addqn) - - 4.4.2 [Deleting a question: `deleteQn`](#442-delete-an-existing-question-delqn) + 4.4.2. [Deleting a question: `deleteQn`](#442-delete-an-existing-question-delqn) 4.5. [Utility](#ins45-utilityins) From 447729d97a28498c2390986dca15ab55b9dd2434 Mon Sep 17 00:00:00 2001 From: Wen Jin Date: Fri, 16 Oct 2020 17:26:34 +0800 Subject: [PATCH 4/5] Update UG Question Addressing hyperlinks --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3bcc4470134..93e40538f3c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -265,7 +265,7 @@ You can use this command to add a question that was asked in a lesson, so that y When teaching group `G04` lesson `1-2`, a student ask a question, and you want to note it down. To add a question to group `G04` lesson `1-2`: -1. Navigate to view group `G04` lesson `1-2` via ![`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. +1. Navigate to view group `G04` lesson `1-2` via [`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. 2. Type `addqn qn/What is the deadline for the report?` into the *Command Box*. 3. Press `Enter` to execute. @@ -282,7 +282,7 @@ You can use this command to add a question that was asked in a tutorial lesson, When teaching group `G04` lesson `1-2`, you answered one of the questions and wants to delete it from the list of questions. To delete a question from group `G04` lesson `1-2`: -1. Navigate to view group `G04` lesson `1-2` via ![`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. +1. Navigate to view group `G04` lesson `1-2` via [`viewlsn`](#452-view-an-existing-tutorial-lesson-viewlsn) command. 2. Type `delqn 1` into the *Command Box*. 3. Press `Enter` to execute. From eefdbbf77c4a29adcfda3a9c1c98b6ff32a11a6c Mon Sep 17 00:00:00 2001 From: Wen Jin Date: Sat, 17 Oct 2020 20:37:35 +0800 Subject: [PATCH 5/5] Markup examples --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 93e40538f3c..c2fc4f20791 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -300,15 +300,15 @@ You can use this command to view the attendance, participation scores and questi `viewlsn grp/GROUP lsn/LESSON` **Example:** -Suppose you would like to view the details for tutorial group G04's **lesson 1-2**. You can perform the following steps. +Suppose you would like to view the details for tutorial group `G04`'s lesson `1-2`. You can perform the following steps. -To view tutorial group G04's **lesson 1-2**: +To view tutorial group `G04`'s lesson `1-2`: 1. Type `viewlsn grp/G04 lsn/1-2` into the *Command Box*. 2. Press `Enter` to execute. Outcome: 1. The *Result Display* will show a success message. -2. The *Data Display* will update and display the students' information for tutorial group G04's **lesson 1-2**. +2. The *Data Display* will update and display the students' information for tutorial group `G04`'s lesson `1-2`. ![Figure X. Outcome of a successful `viewlsn` command](#)