Skip to content

Commit

Permalink
update collate
Browse files Browse the repository at this point in the history
  • Loading branch information
antoniadevina committed Nov 7, 2016
1 parent 3591ef2 commit 059fb09
Show file tree
Hide file tree
Showing 12 changed files with 263 additions and 177 deletions.
12 changes: 6 additions & 6 deletions collated/docs/A0127686R.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A0127686R
###### \DeveloperGuide.md
###### /DeveloperGuide.md
``` md
## Appendix E : Product Survey

Expand Down Expand Up @@ -27,7 +27,7 @@
> Able to add new task(s) to personalised folder

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

Expand Down Expand Up @@ -57,7 +57,7 @@ Examples:
* `a CS2103 Lecture from/ Friday 2pm to/ Friday 4pm `

```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Finding a task or an event containing any keyword in their title: `find`
#### Shortcut : `f`
Expand Down Expand Up @@ -86,7 +86,7 @@ Finds a task of an event whose title contain any of the given keywords.<br>
Format: `find f/ EXACT PHRASE`

```
###### \UserGuide.md
###### /UserGuide.md
``` md
## Time Format
FlexiTrack support various timing input. Here are some examples!
Expand All @@ -111,8 +111,8 @@ next month 8am | Mar 01 08:00
#### Notes on FlexiTrack timing
1. FlexiTrack does support year. However, make sure that you also specify the hour of the timing
as FlexiTrack will choose timing over year when it is uncertain.
2. When you do not specify the exact timing, FlexiTrack will assign your task to be 7.59 for due
date and starting time, and 16.59 for ending time.
2. When you do not specify the exact timing, FlexiTrack will assign your task to be 8:00 for due
date and starting time, and 17:00 for ending time.

## FAQ

Expand Down
50 changes: 28 additions & 22 deletions collated/docs/A0127855W.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# A0127855W
###### \UserGuide.md
###### /DeveloperGuide.md
``` md

### Undo/Redo Implementation

Each undoable command has an execute() method and an executeUndo() method.

2 static Command stacks are maintained. One in the UndoCommand class (doneCommandStack) and the other in the RedoCommand class (undoneCommandStack). From application startup, whenever an undoable command is entered, the created command object is first populated with the data of whatever the command changes, before the execute() method is called. The changes are then applied and the entire command object is pushed into the doneCommandStack.

Subsequently, when the UndoCommand is entered, the last command entered is popped out of the doneCommandStack and the executeUndo() method is called. The command is then pushed into the undoneCommandStack.

When the RedoCommand is entered, the last command undone is popped out of the undoneCommand Stack and the execute() method is called, effectively reexecuting the undone command. The command is then pushed into the doneCommandStack to ensure that the we can undo and redo the same command over and over.

This method of implemeting the undo/redo functionality was chosen due to its simplicity of implementation, as well as the relatively light memory usage, especially when compared to the 'save entire state' method of implementation.

```
###### /UserGuide.md
``` md
#### Find free time slots: `gap`
#### Shortcut: `g`
Expand Down Expand Up @@ -32,7 +48,7 @@ Examples:
Deletes the 1st task/event in the results of the `find` command.

```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Clear the FlexiTrack : `clear`
#### Shortcut : `c`
Expand Down Expand Up @@ -60,7 +76,7 @@ Examples:
* `e 1 from/ today to/ tomorrow`<br>
Edits the start and end times of the specified event.
```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### List: `list`
#### Shortcut : `l`
Expand All @@ -76,50 +92,40 @@ Format: `list <filter>`

Examples:
* `list next month` <br>
Returns a list of next month's tasks and events

#### Select a particular task/event: `select`
#### Shortcut : `s`
Selects a particular task/event on the task/event list.<br>
Format: `select [index]`

> Select the taks/event at the specified `index`.
The index refers to the index number shown in the most recent listing.<br>
The index **must be a positive integer** 1, 2, 3, ...
* `block for cs2103 project from/ 5pm to/ 7pm`<br>
Returns a list of next month's tasks and events

#### Undo operations : `undo`
#### Shortcut : `un`
#### Shortcut : `ud`
Undo the previous operation.<br>
Format: `undo`

> The command will only undo commands entered during the current session of FlexiTrack
> Undo works for: add, delete, clear, mark, unmark, block.

#### Redo operations : `redo`
#### Shortcut : `re`
#### Shortcut : `rd`
Redo the previously undone operation.<br>
Format: `redo`

> The command will only redo commands undone during the current session of FlexiTrack

```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Exiting the program : `exit`
#### Shortcut : `q`
Exits the program.<br>
Format: `exit`

```
###### \UserGuide.md
###### /UserGuide.md
``` md
## Command Summary

Command | Shortcut | Format
-------- | ---- | :--------
Add task | a | `add [task title] <fr/ [number of recurrances] ty/ [day | week | month]> <by/ [deadline]>`
Add event | a | `add [event title] <fr/ [number of recurrances] ty/ [day | week | month]> from/ [starting time] to/ [ending time]`
Add task | a | `add [task title] <fr/ [number of recurrences] ty/ [daily | weekly | monthly]> <by/ [deadline]>`
Add event | a | `add [event title] <fr/ [number of recurrences] ty/ [daily | weekly | monthly]> from/ [starting time] to/ [ending time]`
Block | b | `block [description] from/ [starting time] to/ [ending time]`
Find time | g | `gap [number of hours] < [number of slots to find] >`
Delete | d | `delete [index]`
Expand All @@ -130,9 +136,9 @@ Unmark | u | `unmark [index]`
Find | f | `find [key words] < [key words] >`
List | l | `list <filter>`
Select | s | `select [index]`
Undo | un | `undo`
Undo | ud | `undo`
Redo | rd | `redo`
Change Storage Path| cs | `cs [path]`
Change Storage Path | cs | `cs [path]`
Exit | q | `exit`
Help | h | `help <command word>`
```
25 changes: 17 additions & 8 deletions collated/docs/A0138455Y.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# A0138455Y
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Block multiple time slot for an event : `block`
#### Shortcut : `b`
Expand All @@ -11,10 +11,21 @@ Format: `block [Description] from/ [starting time] to/ [ending time]`

Examples:
* `block for cs2103 project from/ 5pm to/ 7pm`<br>

```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Mark a task as complete : `mark`
#### Shortcut : `m`
Mark an existing task to complete and move it to the bottom of the list.<br>
Format: `mark [index]`

> Mark the task/event at the specified `index`.
The index refers to the index number shown in the most recent listing.<br>
The index **must be a positive integer** 1, 2, 3, ...

Examples:
* `mark 5`<br>

#### Mark a task as complete : `unmark`
#### Shortcut : `u`
Mark an existing task to complete and move it to the bottom of the list.<br>
Expand All @@ -26,9 +37,8 @@ Format: `unmark [index]`

Examples:
* `unmark 5`<br>

```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Specify storage location: `cs`
Specify the storage location where the program save the data. <br>
Expand All @@ -40,10 +50,9 @@ Examples:

Limitation: This feature Only allow user to change storage path within the FlexiTrack folder.

> [path] can only contains alphanumeric, forward slash '/' and underscore '_'.

> [path] can only contains alphanumeric or following special character '\', '/', '-', ':', '.', '_'.
```
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Viewing help : `help`
#### Shortcut : `h`
Expand Down
12 changes: 6 additions & 6 deletions collated/docs/A0147092E.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# A0147092E
###### \UserGuide.md
###### /UserGuide.md
``` md
#### Adding an recurring task: `add`
#### Shortcut : `a`
Adds a task(recursive) to the FlexiTrack.<br>
Format: `add [task title] fr/ [number of occurrence]
Format: `add [task title] fr/ [number of occurrence]`

Examples:
* `add Plan meet-up for assignment fr/ 5
* `add Watch DareDevil Season 1 EP fr/ 10
* `add Plan meet-up for assignment fr/ 5`
* `add Watch DareDevil Season 1 EP fr/ 10`

#### Adding an recurring task (with deadline): `add`
#### Shortcut : `a`
Adds a task(recursive) to the FlexiTrack.<br>
Format: `add [task title] fr/ [number of occurrence] ty/ [daily | weekly | monthly] from/ [starting time] to/ [ending time]`
Format: `add [task title] fr/ [number of occurrence] ty/ ["daily" | "weekly" | "monthly"] from/ [starting time] to/ [ending time]`

Examples:
* `add Submit PC1222 Labsheet fr/ 5 ty/ week by/ Tuesday 5pm`
Expand All @@ -22,7 +22,7 @@ Examples:
#### Adding an recurring event: `add`
#### Shortcut : `a`
Adds a event(recursive) to the FlexiTrack.<br>
Format: `add [event title] fr/ [number of occurrence] ty/ [daily | weekly | monthly] from/ [starting time] to/ [ending time]`
Format: `add [event title] fr/ [number of occurrence] ty/ ["daily" | "weekly" | "monthly"] from/ [starting time] to/ [ending time]`

Examples:
* `add attend PC1222 tutorial fr/ 5 ty/ weekly from/ Tuesday 5pm to/ Tuesday 6pm`
Expand Down
Loading

0 comments on commit 059fb09

Please sign in to comment.