Skip to content

Commit

Permalink
Update collate files
Browse files Browse the repository at this point in the history
  • Loading branch information
yamidark committed Nov 7, 2016
1 parent 5961678 commit d82c0d9
Show file tree
Hide file tree
Showing 14 changed files with 3,258 additions and 2,154 deletions.
258 changes: 142 additions & 116 deletions collated/docs/A0130853L.md

Large diffs are not rendered by default.

27 changes: 13 additions & 14 deletions collated/docs/A0135793W.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A0135793W
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md
### Use case: Save data to a specified folder

Expand Down Expand Up @@ -60,7 +60,7 @@ Use case ends
Use case ends.

```
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md
#### Jia Wern: `iCal`

Expand All @@ -80,34 +80,33 @@ Use case ends
* Has no way to mark an item as done.
* Has no automatic way to block of timings. An actual event has to be created and deleted should the event is not happening anymore.
```
###### /UserGuide.md
###### \UserGuide.md
``` md
#### Edit task details: `edit`
* Format: `edit <index> [name] [datetime] `<br><br>
Edits a todo, deadline or event already inside the task manager using the index of the task.<br>
* Format: `edit INDEX [NEW_NAME] [NEW_DATE] [NEW_START_TIME] [NEW_END_TIME]`
Format depends on the type of task being edited. For deadlines, you can edit only the date by keying in the new date only<br>

> Edits a task at the specified `INDEX` under the todos `t`, deadlines `d` or events `e` section. The `INDEX` refers to the category and index number shown in the most recent listing. eg. `t1` `d2` `e3` <br>
If no or an invalid category was listed, the app will default to todo format `t`. eg. `1` and `+1` becomes `t1` <br><br>
> Format depends on the type of task being edited. When only 1 `TIME` is provided, it is treated as `END_TIME` for both deadline and event.<br><br>
> Note that you can enter the `view` command before the `edit` command, to view the list of tasks and events and edit the specified task accordingly. Alternatively, you can use the [`find`](#find-tasks-find) command to narrow down the displayed list of tasks and events.
<img src="images/EditCallout1.png" width="900"><br>

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

#### Save/Load data: `path`
Saves data to a specified folder.<br>
Format: `path FILEPATH.`
Format: `path <filepath>.xml`

* Windows OS FILEPATH format example: `C:\\Users\\<username>\\Desktop\\CS2103 Tutorial\\TasKitty.xml`
* Mac OS FILEPATH format example: `/Users/<username>/Desktop/CS2103 Tutorial/TasKitty.xml`

TasKitty must end with a .xml extension.<br>
TasKitty will save any other FILEPATH format in the same directory as TasKitty.<br>
TasKitty will automatically create the folder if the folder is not present.<br>
TasKitty can load data from an existing .xml file if TasKitty is empty.<br>
> TasKitty must end with a .xml extension.<br>
> TasKitty will save any other FILEPATH format in the same directory as TasKitty.<br>
> TasKitty will automatically create the folder if the folder is not present.<br>
> TasKitty can load data from an existing .xml file if TasKitty is empty.<br>

Example:

* `path /Users/<username>/Desktop/CS2103 Tutorial/TasKitty.xml`<br>
Saves TasKitty data into the folder CS2103 Tutorial with TasKitty.xml as the filename.<br>
If folder CS2103 Tutorial is not present, TasKitty will create the folder.
Expand Down
126 changes: 78 additions & 48 deletions collated/docs/A0139052L.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A0139052L
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md

**API** : [`Logic.java`](../src/main/java/seedu/taskitty/logic/Logic.java)<br>
Expand All @@ -17,88 +17,107 @@ The result of the command execution is encapsulated as a `CommandResult` object
</p>
<br></br>

Figure 7 above shows the Sequence Diagram for interactions within the `Logic` component and with the Model for the `execute("delete d1")` API call.<br>
> Note that commands that affects the `TaskManager` inside of `Model` will store the command information after successful execution (before execution for ClearCommand) , while other commands does not need to store any command information.<br>
Figure 7 above shows the general Sequence Diagram for interactions within the `Logic` component and with the `Model` for general commands such as `execute("delete d1")` API call shown.<br>
> Note that commands that affects the `TaskManager` inside of `Model` will store the command information after successful execution (before execution for `ClearCommand`) , while other commands does not need to store any command information (e.g `ViewCommand`).<br>

<p align="center">
<img src="images/DeleteTaskSDforLogicHelp.png" width="800"><br>

<em>Fig. 8 Delete Task Sequence Diagram for Logic HelpCommand</em>
<em>Fig. 8 Show Help Window Sequence Diagram for Logic HelpCommand</em>
</p>
<br></br>

Figure 7 above shows the Sequence Diagram for interactions within the `Logic` component, where the Command directly posts an Event to the `EventsCenter` for the `execute("help")` API call.<br>
Figure 8 above shows the Sequence Diagram for interactions within the `Logic` component, where the Command directly posts an Event to the `EventsCenter` for the `execute("help")` API call.<br>

<p align="center">
<img src="images/DeleteTaskSDforLogicPath.png" width="800"><br>

<em>Fig. 9 Set new File Path Sequence Diagram for Logic PathCommand</em>
</p>
<br></br>

Figure 9 above shows the Sequence Diagram for interactions within the `Logic` component and with the `Storage`, and directly posts an Event to the `EventsCenter` for the `execute("path temp.xml")` API call.<br>
```
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md
* The given alphabet is invalid (not `t`, `d`, or `e`)
2b. The given alphabet is invalid (not `t`, `d`, or `e`)

> * Program defaults to the todo list<br>
> 2b1. Program defaults to the todo list<br>
Use case resumes at step 3

* No alphabet is given
2c. No alphabet is given

> * Program defaults to the todo list<br>
> 2c1. Program defaults to the todo list<br>
Use case resumes at step 3

* Changes made are invalid
3a. Changes made are invalid

> * Program returns error message (similar to error messages when creating a new task), depending on type of error<br>
> 3a1. Program returns error message (similar to error messages when creating a new task), depending on type of error<br>
Use case resumes at step 2

<br></br>
```
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md

* The given index of any provided is invalid
2a. First number is greater than second number provided for a range of index

> * Program returns an error message, stating all invalid indexes that were provided<br>
> 2a1. Program returns an error message, stating that an invalid format was given<br>
Use case resumes at step 2

* Duplicate index was provided
2b. The given index of any provided is invalid

> * Program returns an error message, stating all indexes provided that has duplicates<br>
> 2b1. Program returns an error message, stating all invalid indexes that were provided<br>
Use case resumes at step 2

2c. Duplicate index was provided

* The given alphabet of any provided index is invalid (not `t`, `d`, or `e`)
> 2c1. Program returns an error message, stating all indexes provided that has duplicates<br>
Use case resumes at step 2

> * Program defaults to the default alphabet(`t`) for that index<br>
2d. The given alphabet of any provided index is invalid (not `t`, `d`, or `e`)

> 2d1. Program defaults to the default alphabet(`t`) for that index<br>
Use case resumes at step 3

* No alphabet is given for any provided index
3a. No alphabet is given for any provided index

> * Program defaults to the default alphabet(`t`) for that index<br>
> 3a1. Program defaults to the default alphabet(`t`) for that index<br>
Use case resumes at step 3

<br></br>
```
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md

* The given index of any provided is invalid
2a. First number is greater than second number provided for a range of index

> * Program returns an error message, stating all invalid indexes that were provided<br>
> 2a1. Program returns an error message, stating that an invalid format was given<br>
Use case resumes at step 2

* Duplicate index was provided
2b. The given index of any provided is invalid

> * Program returns an error message, stating all indexes provided that has duplicates<br>
> 2b1. Program returns an error message, stating all invalid indexes that were provided<br>
Use case resumes at step 2

2c. Duplicate index was provided

* The given index of any provided is for a task that is already marked done
> 2c1. Program returns an error message, stating all indexes provided that has duplicates<br>
Use case resumes at step 2

2d. The given index of any provided is for a task that is already marked done

> * Program returns an error message, stating all indexes of tasks provided that were already marked done<br>
> 2d1. Program returns an error message, stating all indexes of tasks provided that were already marked done<br>
Use case resumes at step 2

* The given alphabet of any provided index is invalid (not `t`, `d`, or `e`)
2e. The given alphabet of any provided index is invalid (not `t`, `d`, or `e`)

> * Program defaults to the default alphabet(`t`) for that index<br>
> 2e1. Program defaults to the default alphabet(`t`) for that index<br>
Use case resumes at step 3

* No alphabet is given for any provided index
2f. No alphabet is given for any provided index

> * Program defaults to the default alphabet(`t`) for that index<br>
> 2f1. Program defaults to the default alphabet(`t`) for that index<br>
Use case resumes at step 3

<br></br>
Expand Down Expand Up @@ -135,7 +154,7 @@ Use case ends

<br></br>
```
###### /DeveloperGuide.md
###### \DeveloperGuide.md
``` md
#### Jun An: `Wunderlist`

Expand All @@ -159,60 +178,71 @@ Use case ends
* Has limited functionalities(eg. Limited number of tasks and limited file sizes) for free versions, requires subscription fee to unlock all functionalities.

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

* `view`<br>
`delete t1 d1 e1`<br>
Deletes the 1st task under the each section as shown by the `view` command.<br>


Before:<br>
<p align= "center">
<img src="images/UIdeleteMultipleBefore.png" width="900"><br>
Figure 19: Before Delete Multiple Command

After:<br>
<p align= "center">
<img src="images/UIdeleteMultipleAfter.png" width="900"><br>
Figure 20: After Delete Multiple Command

```
###### /UserGuide.md
###### \UserGuide.md
``` md
* `view all`<br>
`done t1 t2 t3`<br>
Marks the 1st 3 task under the todo section shown by the `view all` command as completed.<br>

* `view all`<br>
`done t1-3`<br>
Marks the 1st 3 tasks under the todo section shown by the `view all` command as completed.<br>

Before:<br>
<p align= "center">
<img src="images/UIdoneMultipleBefore.png" width="900"><br>
Figure 23: Before Done Multiple Command

After:<br>
<p align= "center">
<img src="images/UIdoneMultipleAfter.png" width="900"><br>
Figure 24: After Done Multiple Command

```
###### /UserGuide.md
###### \UserGuide.md
``` md
#### Redo previous undone action: `redo`
Redoes the last undoned action.<br>

Format: `redo`<br>
Shortcut key: `Ctrl + Shift + Y`

The previous undone version will be restored.<br>
User can keep redoing multiple undone actions until we reach the latest version.<br>
The previous undo will be restored.<br>
You can redo as many times until the latest change.<br>

Example:

* `redo`<br>
Redoes the last deleted item.<br>

Before:<br>
<p align= "center">
<img src="images/UIundoAfter.png" width="900"><br>
Figure 27: Before Redo Command

After:<br>
<p align= "center">
<img src="images/UIredoAfter.png" width="900"><br>
Figure 28: After Redo Command

<br>

> Note that for undo and redo, you are only able to undo/redo commands that changes the task manager. eg. add, delete
Commands that do not affect the task manager cannot be undone/redone. eg. view, help <br>

>If you have undone actions and you enter a new valid command that is undoable, previous undone actions that were not redone will be lost.<br>

>Note that undoing/redoing does not change the view status back to the one before undoing/redoing, it will stay at the current status until you enter a different command that changes the view status.
<img src="images/UndoCallout.png" width="900"><br>

<br>
```
Loading

0 comments on commit d82c0d9

Please sign in to comment.