diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc index 751106d9126f..5e013e21902c 100755 --- a/docs/DeveloperGuide.adoc +++ b/docs/DeveloperGuide.adoc @@ -152,7 +152,7 @@ image::LogicClassDiagram.png[width="800"] The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `delete 1`. .Component interactions for `delete 1` command -image::SDforDeletePerson.png[width="800"] +image::SDforDeleteCard.png[width="800"] The sections below give more details of each component. @@ -192,7 +192,7 @@ link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`] Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute("delete 1")` API call. .Interactions Inside the Logic Component for the `delete 1` Command -image::DeletePersonSdForLogic.png[width="800"] +image::DeleteCardSdForLogic.png[width="800"] [[Design-Model]] === Model component diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index f5cf3687da30..e87213d393af 100755 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -232,16 +232,19 @@ After memorising the content of the flashcards, it is helpful to test how much i ==== Test flashcards in a folder : `test` -This command begins a test session, where the display area enters a fullscreen (see figure below). - -Format: `test FOLDER_INDEX` +This command begins a test session, where the display area enters a fullscreen (see Figure 1 below). +.A successful test command will display a test session page image::startTestSessionPage.png[width="790"] +Format: `test` + +[NOTE] +This command is only considered valid when inside the folder to be tested and is not already inside a test session. + ==== -* Only questions and -hints are presented and users are required to either input an attempt or the command to reveal the answer within 20 seconds. -* When the 20 seconds is up before the question is answered, this attempt will be marked as wrong. +* Only questions and hints are presented and users are required to either input an attempt or enter the command to +reveal the answer. * Internally, flashcards in a folder are queued to be displayed one by one in the order of lowest existing score to highest existing score. * The next card will only be presented when the next command is carried out. ==== @@ -249,14 +252,21 @@ hints are presented and users are required to either input an attempt or the com Examples: -* `test 1` + -Starts a session by displaying a flashcard (both question and hint) from the 1st folder where 20 seconds is given to each card to be answered. +* `test` + +Starts a session by displaying a flashcard (both question and hint) from the current folder. **Hint toggle on / off feature** `Coming in v2.0` When extra help is needed and familiarity with the content is not yet established hints can be toggled on during a test session when a ‘-hint’ is added on at the end of the test command. Hint will be displayed along with the question when the card is presented. -Format: `test FOLDER_INDEX [-hint]` +Format: `test [-hint]` + +**Timer feature** `Coming in v2.0` + +If you are preparing for an exam that will require you to recall information quickly within the limited time given. +This timer feature is just right for you! You will be given only 20 seconds to answer each question. If the 20 seconds is up before the question is answered, this attempt will be marked as wrong. + +Format: `test [-timer]` ==== Keying in answer to a flashcard: `ans` @@ -269,7 +279,15 @@ shows if it is correct or wrong. * Answer matching is case insensitive. ==== +If the answer has been submitted successfully and it is wrong, you will see the following page (see Figure 2). + +.Wrong Answer page +image::WrongAnswerPage.png[width="790"] +If the answer has been submitted successfully and it is correct, you will see the following page (see Figure 3). + +.Correct Answer page +image::CorrectAnswerPage.png[width="790"] Format: `ans ANSWER` @@ -284,7 +302,8 @@ displayed in an active test session. ==== Reveal answer to a flashcard : `reveal` -Immediately reveals the correct answer. The user will not need enter any response or wait the full 20 seconds before being presented the correct answer. +Immediately reveals the correct answer. The user will not need attempt any answer before being presented the correct +answer. Format: `reveal` @@ -298,7 +317,11 @@ This command is only considered valid if a card question is currently being disp ==== Go to next flashcard : `next` -Presents the next lowest score flashcard in this current test session and the 20 seconds starts running again before the answer is revealed. +Presents the next lowest score flashcard in this current test session. Upon a successful next command, you will see a + similar page below (see Figure 4). + +.Next card question displayed upon a successful next command +image::NextCommandPage.png[width="790"] Format: `next` @@ -424,7 +447,7 @@ questions displayed. The user is required to key in an answer for each question. |`addfolder FOLDER_NAME` | Creates a new flashcard folder with the specified name. |`deletefolder FOLDER_INDEX` | Removes the flashcard folder specified by index. |`report` | Displays user performance on the right panel for the current folder. -|`test FOLDER_INDEX` | This command begins a test session, where the display area enters a fullscreen. +|`test` | This command begins a test session, where the display area enters a fullscreen. |`ans ANSWER` | Enter answer for a flashcard. |`reveal` | Immediately reveals the correct answer. |`next` | Presents the next lowest score flashcard in this current test session. diff --git a/docs/diagrams/HighLevelSequenceDiagrams.pptx b/docs/diagrams/HighLevelSequenceDiagrams.pptx index 38332090a79a..e83c5f0c34e1 100644 Binary files a/docs/diagrams/HighLevelSequenceDiagrams.pptx and b/docs/diagrams/HighLevelSequenceDiagrams.pptx differ diff --git a/docs/diagrams/LogicComponentClassDiagram.pptx b/docs/diagrams/LogicComponentClassDiagram.pptx index 6fcc1136a5bb..b9f81b0171e3 100644 Binary files a/docs/diagrams/LogicComponentClassDiagram.pptx and b/docs/diagrams/LogicComponentClassDiagram.pptx differ diff --git a/docs/images/CorrectAnswerPage.png b/docs/images/CorrectAnswerPage.png new file mode 100755 index 000000000000..778e581279f3 Binary files /dev/null and b/docs/images/CorrectAnswerPage.png differ diff --git a/docs/images/DeleteCardSdForLogic.png b/docs/images/DeleteCardSdForLogic.png new file mode 100755 index 000000000000..8993301ed956 Binary files /dev/null and b/docs/images/DeleteCardSdForLogic.png differ diff --git a/docs/images/DeletePersonSdForLogic.png b/docs/images/DeletePersonSdForLogic.png deleted file mode 100644 index 0462b9b7be6e..000000000000 Binary files a/docs/images/DeletePersonSdForLogic.png and /dev/null differ diff --git a/docs/images/LogicClassDiagram.png b/docs/images/LogicClassDiagram.png old mode 100644 new mode 100755 index f4ecf65b3193..3660616142df Binary files a/docs/images/LogicClassDiagram.png and b/docs/images/LogicClassDiagram.png differ diff --git a/docs/images/NextCommandPage.png b/docs/images/NextCommandPage.png new file mode 100755 index 000000000000..ed3266e88e30 Binary files /dev/null and b/docs/images/NextCommandPage.png differ diff --git a/docs/images/SDForDeleteCard.png b/docs/images/SDForDeleteCard.png new file mode 100755 index 000000000000..20dd45291d2e Binary files /dev/null and b/docs/images/SDForDeleteCard.png differ diff --git a/docs/images/SDforDeletePerson.png b/docs/images/SDforDeletePerson.png deleted file mode 100644 index ae171fda7622..000000000000 Binary files a/docs/images/SDforDeletePerson.png and /dev/null differ diff --git a/docs/images/WrongAnswerPage.png b/docs/images/WrongAnswerPage.png new file mode 100755 index 000000000000..dd1b5133b35c Binary files /dev/null and b/docs/images/WrongAnswerPage.png differ