Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge V0.5 milestone #131

Merged
merged 29 commits into from
Nov 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
a6ba592
add image icon, SLAP keyboard shortcuts and add list priority and lis…
ruiwen905 Nov 6, 2016
7e5043f
Edit UI: remove overdue panel and adjust weekly view panel
ruiwen905 Nov 6, 2016
ec0a76f
remove overdue list and change UI
ruiwen905 Nov 7, 2016
08abb4b
keyboard left and right shortcuts to change week selected in daily view
ruiwen905 Nov 7, 2016
0b0cf56
task card timestamp and remove overdue files
ruiwen905 Nov 7, 2016
04f0751
remove priority and archived details in task card and add overdue ima…
ruiwen905 Nov 7, 2016
ac0b32f
toggle esc to show cheatsheet
ruiwen905 Nov 7, 2016
47f40d6
Update README.md
qhng Nov 7, 2016
2decef5
StorageCommand Test and Docs update
ruiwen905 Nov 7, 2016
8809de4
Merge pull request #129 from CS2103AUG2016-T14-C2/V0.5rc-Ruiwen
qhng Nov 7, 2016
4c44077
UI screenshot
ruiwen905 Nov 7, 2016
1c01061
Fix lost import after merging
qhng Nov 7, 2016
464864b
Fix Help window SUT failing.
qhng Nov 7, 2016
8dca765
Fix hide index on sublists
qhng Nov 7, 2016
8b74ffb
update left right to ctrl-left and ctrl-right
ruiwen905 Nov 7, 2016
dbba5e5
Fix empty list showing a seemingly blank left panel
qhng Nov 7, 2016
15fda63
Merge branch 'V0.5rc-Ruiwen' of https://github.com/CS2103AUG2016-T14-…
qhng Nov 7, 2016
a71ec31
Update README.md
qhng Nov 7, 2016
8cde8f7
Update AboutUs.md
qhng Nov 7, 2016
24cc2b7
Update AboutUs.md
qhng Nov 7, 2016
3044c3b
Merge pull request #130 from CS2103AUG2016-T14-C2/V0.5-Integration-Te…
qhng Nov 7, 2016
7e5f6b1
Update UserGuide.md
qhng Nov 7, 2016
74cd929
Update UserGuide.md
qhng Nov 7, 2016
2710fc3
Update UserGuide.md
qhng Nov 7, 2016
5fda247
Update UserGuide.md
qhng Nov 7, 2016
f2cac1e
Update UserGuide.md
qhng Nov 7, 2016
65fdd0c
Collate updates
qhng Nov 7, 2016
095d1c8
Fix UI not displaying correctly
qhng Nov 7, 2016
180dd16
Update Ui screenshot
qhng Nov 7, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[![Build Status](https://travis-ci.org/CS2103AUG2016-T14-C2/main.svg?branch=master)](https://travis-ci.org/CS2103AUG2016-T14-C2/main)
[![Coverage Status](https://coveralls.io/repos/github/CS2103AUG2016-T14-C2/main/badge.svg?branch=master)](https://coveralls.io/github/CS2103AUG2016-T14-C2/main?branch=master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/91232e72b4c645dc9d988942651ca906)](https://www.codacy.com/app/xefrog/main?utm_source=github.com&utm_medium=referral&utm_content=CS2103AUG2016-T14-C2/main&utm_campaign=Badge_Grade)

# Savvy Tasker

Expand All @@ -22,6 +23,7 @@
* Some parts of this sample application were inspired by the excellent
[Java FX tutorial](http://code.makery.ch/library/javafx-8-tutorial/) by *Marco Jakob*.
* This is a sample project created by [SE-EDU](https://githubcom/se-edu/) initiative.
* [Natty](http://natty.joestelmach.com/) for parsing user input dates


#### Licence : [MIT](LICENSE)
63 changes: 63 additions & 0 deletions collated/docs/A0138431L.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# A0138431L
###### \DeveloperGuide.md
``` md
### UI component

<img src="images/UiClassDiagram.png" width="800"><br>

**API** : [`Ui.java`](../src/main/java/seedu/savvytasker/ui/Ui.java)

The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `TaskListPanel`, `UpcomingPanel`, `DailyPanel`, `FloatingPanel`,
`StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class
and they can be loaded using the `UiPartLoader`.

The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files
that are in the `src/main/resources/view` folder.<br>
For example, the layout of the [`MainWindow`](../src/main/java/seedu/savvytasker/ui/MainWindow.java) is specified in
[`MainWindow.fxml`](../src/main/resources/view/MainWindow.fxml)

The `UI` component,
* Executes user commands using the `Logic` component.
* Binds itself to some data in the `Model` so that the UI can auto-update when data in the `Model` change.
* Responds to events raised from various parts of the App and updates the UI accordingly.

The cursor will be focus to the `CommandBox` by default as the `CommandBox` carries out numerous keyboard shortcuts to make the app more user-friendly.

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

#### Command stack history
<kbd>UP</kbd>: Return last user input command in command box<br>
<kbd>DOWN</kbd>: Return (if any) next user input command in command box<br>
> Note that <kbd>DOWN</kbd> is only allowed after at least an <kbd>UP</kbd> is being entered


#### Week Selection
<kbd>Ctrl</kbd> + <kbd>LEFT</kbd>: Display previous week’s daily task list<br>
<kbd>Ctrl</kbd> + <kbd>RIGHT</kbd>: Display next week’s daily task list

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

## Keyboard Shortcuts

Key Codes | Function | Command Box Input
-------- | :-------- | :--------
<kbd>Esc</kbd> | Toggle to show/hide a list of keyboard shortcuts | -
<kbd>Ctrl</kbd> + <kbd>D</kbd> | [Clear](#clearing-all-entries--clear) all entries | `clear`
<kbd>Ctrl</kbd> + <kbd>Q</kbd> | [Exit](#exiting-the-program--exit) | `exit`
<kbd>Ctrl</kbd> + <kbd>L</kbd> | [List](#listing-all-tasks-list) all unmarked task by date, earliest task first | `list`
<kbd>Ctrl</kbd> + <kbd>A</kbd> | [List](#listing-all-tasks-list) archived tasks | `list archived`
<kbd>Ctrl</kbd> + <kbd>P</kbd> | [List](#listing-all-tasks-list) all unmarked task by priority level, high priority first | `list priorityLevel`
<kbd>Ctrl</kbd> + <kbd>I</kbd> | [List](#listing-all-tasks-list) all alias keys | `list alias`
<kbd>Ctrl</kbd> + <kbd>H</kbd> | [Help](#viewing-help--help) | `help`
<kbd>Ctrl</kbd> + <kbd>S</kbd> | Popups a directory chooser dialog box to choose a new filepath | `storage NEW_FILEPATH`
<kbd>Ctrl</kbd> + <kbd>Z</kbd> | [Undo](#undo-the-most-recent-operation--undo) | `undo`
<kbd>Ctrl</kbd> + <kbd>Y</kbd> | [Redo](#redo-the-most-recent-undo-operation--redo) | `redo`
<kbd>Ctrl</kbd> + <kbd>UP</kbd> | Return [last user input](#command-stack-history) command in command box | -
<kbd>Ctrl</kbd> + <kbd>DOWN</kbd> | Return (if any) [next user input](#command-stack-history) command in command box | -
<kbd>Ctrl</kbd> + <kbd>LEFT</kbd> | Displays [previous week’s](#week-selection) daily task list | -
<kbd>Ctrl</kbd> + <kbd>RIGHT</kbd> | Display [next week’s](#week-selection) daily task list | -
```
11 changes: 8 additions & 3 deletions collated/docs/A0139915W.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,17 @@ Format: `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/

#### Change storage location : `storage`
Changes the storage location of Savvy Tasker.<br>
Format: `storage PATH`
Format: `storage NEW_FILEPATH`

> Parameters | Description
> -------- | :--------
> PATH | `Mandatory` Specifies the path where Savvy Tasker's task list is saved at.
> <br>
> If the new storage location specified by `PATH` is not accessible by Savvy Tasker, no change will be made to the existing path.
> If the new storage location specified by `NEW_FILEPATH` is not accessible by Savvy Tasker, no change will be made to the existing path.

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

```
###### \UserGuide.md
Expand All @@ -198,9 +202,10 @@ Command | Format
[Help](#viewing-help--help) | `help`
[Modify](#modifies-a-task--modify) | `modify INDEX [t/TASK_NAME] [s/START_DATE] [e/END_DATE] [l/LOCATION] [p/PRIORITY_LEVEL] [r/RECURRING_TYPE] [n/NUMBER_OF_RECURRENCE] [c/CATEGORY] [d/DESCRIPTION]`<br>Example: `modify 2 t/Wednesday Weekly Milestone s/wed d/Project Meeting and Finalization`
[Mark](#mark-a-task-as-done--mark) | `mark INDEX [MORE_INDEX]`<br>Example: `mark 1 2 3`
[Storage](#change-storage-location--storage) | `storage PATH`<br>Example: `storage data/savvytasker.xml`
[Storage](#change-storage-location--storage) | `storage NEW_FILEPATH`<br>Example: `storage data/savvytasker.xml`
[Unmark](#unmark-a-task-as-done--unmark) | `unmark INDEX [MORE_INDEX]`<br>Example: `unmark 1 2 3`
[Undo](#undo-the-most-recent-operation--undo) | `undo`
[Redo](#redo-the-most-recent-undo-operation--redo) | `redo`
[Unalias](#unalias-a-keyword--unalias) | `unalias s/SHORT_KEYWORD`<br>Example: `unalias s/mss`

```
4 changes: 2 additions & 2 deletions collated/docs/A0139916U.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Format: `alias k/KEYWORD r/REPRESENTATION`

> Parameters | Description
> -------- | :--------
> KEYWORD | Specifies the keyword that will be replaced when met in a command, must be a single word
> REPRESENTATION | Specifies the text that will replace the keyword
> KEYWORD | Specifies the keyword that will be replaced when met in a command, must be a single word.
> REPRESENTATION | Specifies the text that will replace the keyword. Cannot contain slashes.

Examples:
* `alias k/pjm r/Project Meeting`<br>
Expand Down
7 changes: 0 additions & 7 deletions collated/main/A0097627N.md
Original file line number Diff line number Diff line change
Expand Up @@ -687,8 +687,6 @@

public static final String MESSAGE_REDO_ACKNOWLEDGEMENT = "Last command redone";

public RedoCommand() {}

@Override
public CommandResult execute() {
return new CommandResult(MESSAGE_REDO_ACKNOWLEDGEMENT);
Expand Down Expand Up @@ -899,8 +897,6 @@

public static final String MESSAGE_UNDO_ACKNOWLEDGEMENT = "Last command undone";

public UndoCommand() {}

@Override
public CommandResult execute() {
return new CommandResult(MESSAGE_UNDO_ACKNOWLEDGEMENT);
Expand Down Expand Up @@ -1070,7 +1066,4 @@
}
}
else if (command.canUndo()){
undoStack.push(command);
redoStack.clear();
}
```
Loading