Add a User Guide

ChangGittyHub · Feb 20, 2023 · 194a891 · 194a891
1 parent 00f8f83
commit 194a891
Show file tree

Hide file tree

Showing 15 changed files with 234 additions and 126 deletions.
diff --git a/build.gradle b/build.gradle
@@ -12,7 +12,7 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
-    String javaFxVersion = '11'
+    String javaFxVersion = '11.0.2'
 
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'win'
     implementation group: 'org.openjfx', name: 'javafx-base', version: javaFxVersion, classifier: 'mac'

diff --git a/data/duke.txt b/data/duke.txt
@@ -1,5 +1,6 @@
-T | 1 | 0 | lol
-D | 0 | 1 | deadline buy food | 2022-12-22 | Yum
-T | 0 | 0 |  shit
-T | 0 | 0 |  eat shit
-D | 1 | 0 | deadline pass shit | 2023-02-12
+T | 1 | 1 |  Brush teeth | food
+D | 1 | 1 | Submit CS2103T | 2023-02-12 | finally
+E | 0 | 1 |  Music festival  | 2023-12-22 | 2023-12-23 | again
+T | 0 | 0 |  work
+T | 0 | 0 |  task
+D | 0 | 0 | task | 2023-12-22
diff --git a/docs/README.md b/docs/README.md
@@ -1,174 +1,226 @@
-# User Guide
+# User Guide for `Duuk`
+Muahahahh this is Duuk, Duke's evil twin brother. He might be evil but he is ironically good at whatever tasks you throw at him. A chatbot is what he is! Surprisingly, he makes himself useful by helping to make your life more organised.
 
-## Features 
+## Features
 
-### Feature-ABC
+## Installation <a name="installation"></a>
+
+1. Download the JAR file.
+2. Open the JAR file by typing the command `java -jar duke.jar` on your command line interface (CLI). Make sure that on the CLI, you are in the same directory (folder) that contains the downloaded JAR file.
+3. Proceed to start a chat session with Prof Duke through the graphical user interface (GUI)!
+
+### Feature - Add a task
+
+Add a task to be recorded.
+
+### Feature - Delete a task
+
+Delete an existing task.
+
+### Feature - List
+
+Displays all tasks that are recorded.
+
+### Feature - Tag
+
+Tag an existing task with a '#' prefix along with the description.
+
+### Feature - Find
+
+Find all tasks that include the keyword.
+
+### Feature - Mark
 
-Description of the feature.
+Record a task as done.
 
-### Feature-XYZ
+### Feature - Unmark
+
+Record a task as undone.
 
-Description of the feature.
 
 ## Usage
 
-### `Keyword` - Describe action
+### `todo` - Add a todo task to the list
 
-Describe the action and its outcome.
+Adds a todo task to the list
 
-Example of usage: 
+Example of usage:
 
-`keyword (optional arguments)`
+`todo task`
 
 Expected outcome:
 
-Description of the outcome.
+A todo task will be saved and the following output will be displayed:
 
 ```
-expected output
+WHAT A BOTHER! Whatever...I've added this task:
+    [T][] task
+Boy now you have 1 tasks in the list.
 ```
-# User Guide for `/* ask duuk */`
-Muahahahh this is Duuk, Duke's evil twin brother. He might be evil but he is ironically good at whatever tasks you throw at him. A chatbot is what he is! Surprisingly he helps make your life more organised.
 
-## Table of Contents
+### `deadline` - Add a deadline task to the list
 
-1. [Installation](#installation)
-1. [Features](#features)
-1. [Usage](#usage)
-    1. [Add task](#add-task)
-    1. [Delete task](#delete-task)
-    1. [List tasks](#list-tasks)
-    1. [Mark task](#mark-task)
-    1. [Unmark task](#unmark-task)
-    1. [Find tasks](#find-tasks)
-    1. [Undo](#undo)
-    1. [Exit chat session](#exit)
-1. [Frequently Asked Questions (FAQ)](#faq)
+Adds a deadline task to the list
 
+Example of usage:
 
-## Installation <a name="installation"></a>
+`deadline task /by 2023-03-11`
 
-1. Download the JAR file [here](https://github.com/ChangGittyHub/ip/releases/download/v0.2/duke.jar).
-2. Open the command line interface (CLI) and navigate to the directory containing the downloaded JAR file.
-3. Type `java -jar duke.jar` on your command line interface (CLI). 
-4. Make sure that on the CLI, you are in the same directory (folder) that contains the downloaded JAR file. 
-5. Start a chat session with /* ask-prof-duke */ through the graphical user interface (GUI).
-If all goes well, your app should look like this:<br>
-<img width="612" alt="showcase" src="https://user-images.githubusercontent.com/87931905/219394138-73503f76-dbf7-47e4-8712-e11a2d536eff.png">
+Expected outcome:
 
+A task with a due date will be record and the following output will be displayed:
 
-## Features <a name="features"></a>
-1. **Add task**: Add a new task to be recorded.
-1. **Delete task**: Delete an existing task.
-1. **List tasks**: List all tasks that are currently recorded.
-1. **Mark task**: Record a task as complete.
-1. **Unmark task**: Record a task as incomplete.
-1. **Find tasks**: Find a task by title.
-1. **Undo**: Undo the previous command executed.
-1. **Exit**: End the current chat session.
+```
+WHAT A BOTHER! Whatever...I've added this task:
+    [D][] task (11 March 2023)
+Boy now you have 1 tasks in the list.
+```
 
+### `event` - Adds an event to the list
 
+Adds an event with a start date and an end date to the list
 
-## Usage <a name="usage"></a>
+Example of usage:
 
-### Add task <a name="add-task"></a>
-Add a task that can be any of the three supported types: Todo, Deadline, Event.
-The command for adding each task type is given as follows:
+`event task /from 2023-02-17 /to 2023-02-25`
 
-| Task Type | Command                                                            | Example of usage                                            |
-|-----------|--------------------------------------------------------------------|-------------------------------------------------------------|
-| Todo      | `todo <task title>`                                                | `todo go shopping`                                          |
-| Deadline  | `deadline <task title> /by <YYYY-M-d> <HHmm>`                      | `deadline do homework /by 2023-2-15 1500`                   |
-| Event     | `event <task title> /from <YYYY-M-d> <HHmm> /to <YYYY-M-d> <HHmm>` | `event career fair /from 2023-2-10 1200 /to 2023-2-11 1700` |
+Expected outcome:
 
+An event task will be saved and the following output will be displayed:
 
-### Delete task <a name="delete-task"></a>
-Delete a task of a provided task number in the task list.<br>(can be displayed by `list` command. See next section on **List tasks**.)
+```
+WHAT A BOTHER! Whatever...I've added this task:
+    [E][] task (17 February 2023 to 25 February 2023)
+Boy now you have 1 tasks in the list.
+```
+
+### `delete` - Deletes a task
+
+Deletes the task at a given index.
 
-**Command:** `delete <task number>`
+Example of usage:
 
+```
+todo task
+delete 1
+```
 
-### List tasks <a name="list-tasks"></a>
-Display all tasks that are currently recorded in the task list for the current session.
+Expected outcome:
 
-**Command:** `list`
+The task will be deleted and the following output will be displayed:
 
-**Expected outcome**:
 ```
-Here are the tasks in your list:
-1. [T][ ] do calculus assignment
-2. [D][ ] write up user guide for cs2103T ip (by: 17 Feb 2023 2359)
-3. [E][X] christmas party @ ben's (from: 25 Dec 2023 1800 to: 26 Dec 2023 0200)
+FINE. I've removed this task
+    [T][] task
+Boy you are not bad yourself...you have 0 tasks in the list.   
 ```
 
+### `mark` - Mark a task as done
 
-### Mark task <a name="mark-task"></a>
-Record a task of a given task number in the task list as completed.
+Marks the task at a given index as done.
 
-**Command:** `mark <task number>`
+Example of usage:
 
+```
+todo task
+mark 1
+```
 
-### Unmark task <a name="unmark-task"></a>
-Record a task of a given task number in the task list as not completed.
+Expected outcome:
 
-**Command:** `unmark <task number>`
+The task will be marked as done and the following output will be displayed:
 
+```
+MARK MY WORDS...and this task:
+    [T][X] task
+```
 
-### Find tasks <a name="find-tasks"></a>
-Find a task by title. A list of tasks containing the search query specified will be returned.<br>
+### `unmark` - Marks a task as not done
 
-****Note: This search query is case-insensitive.***
+Marks the task at a given index as not done.
 
-**Command:** `find <search query>`
+Example of usage:
 
-**Example of usage:** `find homework`
+```
+todo task
+mark 1
+unmark 1
+```
+
+Expected outcome:
+
+The task will be marked as not done and the following output will be displayed:
 
-**Expected outcome:**
 ```
-Here are the matching tasks in your list:
-[T][ ] math homework
-[T][X] science homework
+MARK MY WORDS...and this task:
+    [T][X] task
+    
+Make up your mind! I will unmark just this once
+    [T][ ] task
 ```
 
+### `list` - Lists all tasks
 
-### Undo <a name="undo"></a>
-Undo the previous command executed.
+Displays all the tasks being tracked.
 
-**Command:** `undo`
+Example of usage:
 
+```
+todo task A
+deadline task B /by 2023-03-25
+event task C /from 2023-03-23 /to 2023-03-28
+```
 
-### Exit chat session <a name="exit"></a>
-End the current chat session. The GUI will close within 3 seconds of executing the `bye` command. The updated list of tasks will be saved in the local storage.
+Expected outcome:
 
-**Command:** `bye`
+The following output will be displayed:
 
+```
+Here are the tasks in your list:
+1. [T][ ] task A
+2. [D][ ] task B (25 March 2023)
+3. [E][ ] task C (23 March 2023 to 28 March 2023)
+```
 
-## Frequently Asked Questions (FAQ) <a name="faq"></a>
+### `tag` - Lists all tasks on a given date
 
-> **I'm unsure of the task number of the task I want to delete/mark/unmark. How can I obtain that?**<br>
+Tag a task with a '#' prefix along with the description.
 
-*You can execute the `list` command to list all the tasks in order of their task number. Search through your desired task and its corresponding task number. For example, if your desired task is "do calculus assignment" and the output of the `list` command is given as follows:*<br>
+Example of usage:
 
 ```
-Here are the tasks in your list:
-1. [T][ ] do calculus assignment
-2. [D][ ] write up user guide for cs2103T ip (by: 17 Feb 2023 2359)
-3. [E][X] christmas party @ ben's (from: 25 Dec 2023 1800 to: 26 Dec 2023 0200)
+tag 1 fun
 ```
 
-*then the corresponding task number you are looking for is 1.*<br><br>
+Expected outcome:
 
+The following output will be displayed:
 
-> **I can't seem to save my changes made to the task list from the previous session. What is happening?**<br>
+```
+You want me to what? Tag? Fine.
+1. [D][] task A #fun (20 February 2023)
+```
 
-*You have probably closed the GUI through the ❌ button on the top left of the app window, force quit or pressing Ctrl+C in your CLI, rather than ending the chat session through the `bye` command. At the moment, the app is only able to save your changes upon exiting the chat session through the `bye` command.*<br><br>
+### `find` - Finds tasks by a search keyword
 
+Displays all the tasks matching a given keyword
 
-> **Help! I'm unable to open the app and nothing happens after double clicling the JAR file...**<br>
+Example of usage:
 
-*You should run the app's JAR file through the command `java -jar duke.txt` on your CLI.*<br><br>
+```
+todo I
+todo am
+todo a
+todo happy
+todo man
 
+find man
+```
 
-> **I'm still unable to open the app's JAR file after running the command `java -jar duke.txt` on my CLI! I keep getting this error: `Error: Unable to access jarfile duke.jar`.**<br>
+Expected outcome:
 
-*Before running the command, make sure that on the CLI, you are in the same directory (folder) that contains the downloaded JAR file.*<br><br>
+The following output will be displayed.
+```
+I dug out the WHOLE BEDROOM and found want you wanted NOW LEAVE:
+1. [T][ ] man
+```
diff --git a/docs/Ui.png b/docs/Ui.png
diff --git a/src/main/java/command/AddCommand.java b/src/main/java/command/AddCommand.java
@@ -29,7 +29,7 @@ public AddCommand(Task newTask) {
     @Override
     public String execute(Ui ui, Tasklist list, Storage storage) {
         list.add(this.newTask);
-        return ui.getAddReply(this.newTask);
+        return ui.getAddReply(this.newTask, list.size());
     }
 
 }
diff --git a/src/main/java/duke/Parser.java b/src/main/java/duke/Parser.java
@@ -71,8 +71,7 @@ public Command parseCommand() throws DukeException {
             if (startIndex >= input.length()) {
                 throw new DukeException("Fill in the description of a deadline.");
             }
-            int detailIndex = input.lastIndexOf("deadline");
-            String taskFullDetails = input.substring(detailIndex);
+            String taskFullDetails = input.substring(startIndex);
             String[] splitDetails = taskFullDetails.split("/by ");
             if (splitDetails.length < 2) {
                 throw new DukeException("Please specify the deadline.");
@@ -86,8 +85,7 @@ public Command parseCommand() throws DukeException {
             if (startIndex >= input.length()) {
                 throw new DukeException("Fill in the description for this event .");
             }
-            int detailIndex = input.lastIndexOf("event");
-            String taskFullDetails = input.substring(detailIndex);
+            String taskFullDetails = input.substring(startIndex);
             String[] splitDescriptionAndDuration = taskFullDetails.split("/from");
             String[] splitStartAndEnd = splitDescriptionAndDuration[1].split("/to");
             if (splitDescriptionAndDuration.length < 2) {
@@ -126,4 +124,9 @@ public static LocalDate parseFile(String date) throws DukeException {
         }
     }
 
+    public static String getPrettierDate(LocalDate date) {
+        DateTimeFormatter formatter = DateTimeFormatter.ofPattern("dd MMMM yyyy");
+        return date.format(formatter);
+    }
+
 }