Skip to content

Commit

Permalink
Collate to check
Browse files Browse the repository at this point in the history
  • Loading branch information
jamos-tay committed Nov 6, 2016
1 parent 07f475f commit d2f551d
Show file tree
Hide file tree
Showing 11 changed files with 466 additions and 300 deletions.
90 changes: 68 additions & 22 deletions collated/docs/A0139046E.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,42 +115,88 @@ Use case ends.
>3a1. ToDoIt shows an error message <br>
Use case ends

```
###### \DeveloperGuide.md
``` md

#### Use case: Favorite

**MSS**

1. User requests to favorite a command
2. ToDoIt adds the favorited command into the presets panel <br>
Use case ends.

**Extensions**

1a. Invalid command to favorite

> 1a1. ToDoIt shows an error message <br>
Use case ends

#### Use case: Unfavorite

**MSS**

1. User requests to unfavorite a command
2. ToDoIt removes the unfavorited command from the presets panel <br>
Use case ends.

**Extensions**

1a. The given index is invalid

> 1a1. ToDoIt shows an error message <br>
Use case ends.

#### Use case: Undo/Redo

**MSS**

1. User requests to undo/redo to the previous state
2. ToDoIt moves current state to the previous state <br>
Use case ends.

**Extensions**

1a. The user uses `undo` more than 10 times consecutively

> 1a1. ToDoIt shows an error message that he has reached the maximum undo limit <br>
Use case ends.

#### Use case: Filepath

**MSS**

1. User requests to change the filepath
2. ToDoIt copies his current task data in the current file to the desired file path
Use case ends.

**Extensions**

1a. Filepath is not a valid .xml file

> 1a1. ToDoIt shows an error message <br>
Use case ends

```
###### \UserGuide.md
``` md
---

### Editing a task: `edit`
You never know when things change. Life is unpredictable. ToDoIt knows this, and allows you to adapt to the erratic changes you may have in your schedule. Modify your tasks with a simple command.<br>
You will never know when things might change. Life is unpredictable. ToDoIt knows this, and lets you adapt to the erratic changes you may have in your schedule. Modify your tasks with a simple command.<br>
Format: `edit INDEX [n/TASK_NAME] [d/DATE_TIME] [l/LENGTH] [r/RECUR] [p/PRIORITY] [i/INFORMATION] [t/TAG]...`

**Options**
> 1. `n/` Name: The new name of the task.
> 1. `d/` Date and time: Specifies the start date and time of a task. Please refer to the Date Specifications section for what formats are accepted.
> 1. `n/` Name: Edits the name of the task.
> 2. `d/` Date and time: Edits the start date and time of a task. Please refer to the Date Specifications section for what formats are accepted.
```
###### \UserGuide.md
``` md
> 5. `a/` Autoschedule: If flag is specified, the task will be automatically scheduled to a free slot. If a time, date and length is specified, this flag is ignored.
> 6. `i/` Information: Information to be tagged to this task. Put any extra details you want here.
> 7. `t/` Tags: Specifies tags that are tagged to this task. Tags allow you to group tasks logically by assigning them a similar tag.

**Notes**
> * This edits the task at the specified `INDEX`. <br>
The index refers to the index number shown in the most recent listing.<br>
The index **must be a positive integer** `1`, `2`, `3`, ... <br>
> * Replaces the current task data with the specified task data.<br>
> * When editing a task's date and time, if only the date or the time is specified, then only the date or the time will be edited. For example, including `d/6th Oct` a task on 5th Oct 2pm will change the date to 6th Oct 2pm.<br>
> * For more information regarding the options, refer to `add` command.

**Example**
> * Your boss just changed the date of a meeting on the 3rd October to the 2nd. Simply find your meeting task, then run the following command: <br>
> `find meeting`<br>
`edit 1 d/2nd Oct`

---

### Rescheduling a task: `reschedule`
ToDoIt does not expect you to be the perfect worker. Sometimes you are too busy or tired to do a task. If you are not feeling up to it right now, simply reschedule it for another day.<br>
ToDoIt does not expect you to be the perfect worker. When you do not feel up to the task right now, simply reschedule it to another time.<br>
Format: `reschedule INDEX INTERVAL`

**Notes**
Expand Down
28 changes: 15 additions & 13 deletions collated/docs/A0139121R.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Use case ends.
```
###### \DeveloperGuide.md
``` md

#### Use case: Find task

**MSS**
Expand Down Expand Up @@ -70,7 +71,7 @@ Use case ends.

3a. The given time frame or specified order is invalid

>ToDoIt shows an error message <br>
>3a1. ToDoIt shows an error message <br>
Use case ends

```
Expand All @@ -87,32 +88,33 @@ ToDoIt compiles your tasks for the day efficiently with a simple line of text. T
```
###### \UserGuide.md
``` md
> 6. `a/` Autoschedule: If flag is specified, the task will be automatically scheduled to a free slot. If a time, date and length is specified, this flag is ignored.
> 7. `i/` Information: Information to be tagged to this task. Put any extra details you want here.
> 8. `t/` Tags: Specifies tags that are tagged to this task. Tags allow you to group tasks logically by assigning them a similar tag.
> 6. `i/` Information: Information to be tagged to this task. Put any extra details you want here.
> 7. `t/` Tags: Specifies tags for this task. Tags allow you to group tasks logically by assigning them a similar tag.

**Notes**
> * A task can be dated (has time, date, length), or floating. A floating task is one without any specified date, time and length which can be done at a flexible timing.<br>
> * If a task is dated (d/ option specified) but length is not specified, the duration defaults to 1 hour.<br>
> * Tasks can have any number of tags (including 0). Simply repeat the t/ option (e.g. `t/work t/school t/CS2103`).

> * Tasks can have any number of tags (including 0). Simply repeat the t/ option (e.g. `t/work t/school t/CS2103`).<br>
> * End date and time should not be used in conjunction with length.

**Example**
> * You have a CS2101 Lecture weekly, starting from 7th Oct at 2pm. However, the lecture is webcasted so you don't always have to attend, thus making it low priority. You simply have to run: <br>
> `add CS2101 Lecture h/7th Oct 2pm l/2hr r/1w p/low t/got-webcast` <br>
> This will add a CS2101 Lecture task which recurs every week starting with 2pm on 7th Oct, marks it as low priority and tags it with the `got-webcast` tag.
> `add CS2101 Lecture h/7th Oct 2pm l/2hr r/1w p/low t/webcast` <br>
> This will add a CS2101 Lecture task which recurs every week starting with 2pm on 7th Oct, marks it as low priority and tags it with the `webcast` tag.

```
###### \UserGuide.md
``` md

### Listing tasks : `list`
ToDoIt displays your tasks easily with a simple command. The tasks to list can be customized to your liking simply with a few keywords.<br>
Format: `list [ds/DATE_START] [ds/DATE_END] [s/SORT_BY] [df/DONE_STATUS] [rev/]`
Format: `list [ds/DATE_START] [de/DATE_END] [s/SORT_BY] [df/DONE_STATUS] [rev/]`

**Options**
> 1. `ds/` Date start: If a start date is specified, program will only display tasks after this date. If the option is used without a specified date, it will use today's date.
> 2. `de/` Date end: If an end date is specified, program will only display tasks before this date. If the option is used without a specified date, , it will use today's date.
> 3. `s/` Sort by: Sorts the tasks in the order specified (`date`, `time`, `alphabetical`, `priority`).
> 4. `df/` Done tasks: If this flag is specified, tasks that are marked done will be shown. The available done flags are "done", "not done" and "all".
> 3. `s/` Sort by: Sorts the tasks in the order specified (`date` and `time`, `alphabetical`, `priority`).
> 4. `df/` Done status: Use this flag to specify, by done status, which tasks to show. The available done flags are "done", "not done" and "all".
> 5. `rev/` Reverse: If this flag is specified, tasks will be listed in reverse order after sorting.

**Notes**
Expand All @@ -132,10 +134,10 @@ ToDoIt searches and finds the tasks you need, while filtering out the clutter. K
Format: `find KEYWORD [MORE_KEYWORDS] [s/SCOPE]...`

**Options**
> 1. `s/` Scope: If you only want to search a task's specific attribute, specify which attributes you want to search here (`name` : name, `tag` : tag, `information` : information). By default, it searches in all three areas.
> 1. `s/` Scope: If you only want to search a task's name or description, specify which attributes you want to search here (`name` : name, `tag` : tag, `information` : information). By default, it searches in all three areas if no attribute is specified.

**Notes**
> * The search is not case sensitive. e.g `stuff` will match `Stuff`<br>
> * The search is not case sensitive. e.g `stuff` will match `STUFF`<br>
> * The order of the keywords does not matter. e.g. `Do stuff` will match `Stuff do`<br>
> * Only full words will be matched e.g. `Work` will not match `Workout`<br>
> * Tasks matching at least one keyword will be returned (i.e. `OR` search).<br>
Expand Down
69 changes: 66 additions & 3 deletions collated/docs/A0139947L.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,76 @@ Fantastical | 1. Simple interface with little to no distractions<br><br>2. Built
```
###### \UserGuide.md
``` md
### Viewing help : `help`
Format: `help`

The help command links you to our User Guide to provide you with detailed explaination on how to use ToDoIt.

**Notes**
> * Help is also shown if you enter an incorrect command e.g. `abcd`
```
###### \UserGuide.md
``` md
> 3. `l/` Length: Specifies the length of time. Defaults to 1 hour if time and date are specified, but length is not specified. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval. This parameter should not be used together with `de/`.
> 4. `r/` Recur: Specifies an interval for recurring task, if any. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval.
> 5. `p/` Priority: Specifies the priority of a task (`veryhigh`, `high`, `medium` `low`, `verylow`). You may also use `vh`, `h`, `m`, `l` or `vl` for their respective priorities.
```
###### \UserGuide.md
``` md
> 2. `l/` Length: Specifies the length of time. Defaults to 1 hour if time and date are specified, but length is not specified. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval.
> 3. `r/` Recur: Specifies an interval for recurring task, if any. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval.
> 4. `p/` Priority: Specifies the priority of a task (`veryhigh`, `high`, `medium` `low`, `verylow`). You may also use `vh`, `h`, `m`, `l` or `vl` for their respective priorities.
> 3. `l/` Length: Edits the length of time. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval.
> 4. `r/` Recur: Edits the interval for recurring task, if any. Use a number followed by a time interval (`m`, `h`, `d`, `w`, for minutes, hours, days, weeks respectively), e.g. `6d`, `1w`. You may also use `hr`, `hrs`, `day`, `days`, `week` and `weeks` for their respective interval.
> 5. `p/` Priority: Edits the priority of a task (`veryhigh`, `high`, `medium` `low`, `verylow`). You may also use `vh`, `h`, `m`, `l` or `vl` for their respective priorities.
```
###### \UserGuide.md
``` md

### Taking in different aliases:
ToDoIt also takes in different aliases for both time and priority. Instead of typing the respective command, it also recognises the aliases in the tables below.

The aliases below work for `add`, `edit`, `reschedule`, or any command that requires the input or change or time/date/priority.

Command (Date & Time) | Aliases
-------- | :-----------
m (minutes) | min, mins
h (hours) | hr, hrs
d (days) | day, days
w (weeks) | week, weeks

Command (Priority) | Aliases
-------- | :-----------
veryhigh | vh
high | h
medium | m
low | l
verylow | vl

---

### Exiting the program: `exit`
ToDoIt is sad to see you go.<br>
Format: `exit`
```
###### \UserGuide.md
``` md

## Command Summary

Command | Format
-------- | :--------
Add | `add TASK_NAME [d/DATE_TIME de/END_DATE_TIME l/LENGTH] [r/RECUR] [p/PRIORITY] [a/] [i/INFORMATION] [t/TAG]...`
Edit | `edit INDEX [n/TASK_NAME] [d/DATE_TIME] [l/LENGTH] [r/RECUR] [p/PRIORITY] [i/INFORMATION] [t/TAG]...`
Clear | `clear`
Delete | `delete INDEX`
Done | `done INDEX`
Undone | `undone INDEX`
List | `list [ds/DATE_START] [ds/DATE_END] [s/SORT_BY] [df/] [rev/]`
Reschedule | `reschedule INDEX INTERVAL`
Find | `find KEYWORD [MORE_KEYWORDS] [s/SCOPE]...`
Undo | `undo`
Redo | `redo`
Filepath | `filepath FILEPATH`
Favorite | `favorite c/COMMAND` (add a favorite)<br>`favorite INDEX` (select a favorite)
Unfavorite | `unfavorite INDEX`
Help | `help`
Exit | `exit`
```
2 changes: 1 addition & 1 deletion collated/docs/A0140155U.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Format: `done INDEX`
---

### Mark a task as undone : `undone`
Thought you were done, but actually there was one little thing that you forgot to do? No worries, we have all been there. Use this simple command to mark done tasks as not done. Do not worry, ToDoIt will not mock you.<br>
Thought you were done, but there is one little thing that you forgot to do? No worries, we have all been there. Use this simple command to mark done tasks as not done. <br>
Format: `undone INDEX`

**Notes**
Expand Down
2 changes: 1 addition & 1 deletion collated/main/A0139046E.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class EditCommand extends Command {

public static final String MESSAGE_USAGE = COMMAND_WORD
+ ": Edits the task identified by the index number used in the last task listing.\n"
+ "Parameters: INDEX (must be a positive integer) [n/NAME] [h/TIME d/DATE l/LENGTH] [r/RECUR] [p/PRIORITY] [i/INFORMATION] [t/TAG]...\n"
+ "Parameters: INDEX (must be a positive integer) [n/NAME] [d/DATE,TIME l/LENGTH] [r/RECUR] [p/PRIORITY] [i/INFORMATION] [t/TAG]...\n"
+ "Example: " + COMMAND_WORD + " 1 d/next thurs 2pm";

public static final String MESSAGE_EDIT_TASK_SUCCESS = "Edited Task: %1$s";
Expand Down
Loading

0 comments on commit d2f551d

Please sign in to comment.