Skip to content

Commit

Permalink
Update user and developer guides
Browse files Browse the repository at this point in the history
  • Loading branch information
l0g1cal committed Oct 31, 2016
1 parent 7d3f398 commit 9374877
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 7 deletions.
39 changes: 39 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -622,10 +622,49 @@ Use case ends
> * Program returns error message, saying that command was invalid<br>
Use case resumes at step 1.

* Command does not end with .xml.

> * Program returns error message, saying that command needs to end with .xml<br>
Use case resumes at step 1.

* Specified folder has not been created.

> * Program automatically creates the folder<br>
Use case ends.

* Specified folder has existing data.

> * User will be asked if user wants to overwrite the existing data.<br>
* If yes, use case resumes at step 2.
* If no, use case resumes at step 1.

<br></br>
### Use case: Load data from a specified file

**MSS**

1. User requests to load data from a file
2. Program loads data from the specified file
3. Program restarts itself to reflect loaded data<br>
Use case ends

**Extension**

* There is no file specified by user.

> * Program returns error message, saying that command was invalid<br>
Use case resumes at step 1.

* Command does not end with .xml.

> * Program returns error message, saying that command needs to end with .xml<br>
Use case resumes at step 1.

* Specified file has not been created.

> * Program automatically creates the file<br>
Use case ends.

<!-- @@author A0139930B -->

## Appendix C : Non Functional Requirements
Expand Down
16 changes: 9 additions & 7 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,19 +248,21 @@ Example:

<!-- @@author A0135793W -->

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

* Windows OS FILEPATH format example: `C:\\Users\\<username>\\Desktop\\CS2103 Tutorial`
* Mac OS FILEPATH format example: `/Users/<username>/Desktop/CS2103 Tutorial`
* 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>

Example:
* `save /Users/<username>/Desktop/CS2103 Tutorial`<br>
Saves TasKitty data into the folder CS2103 Tutorial.<br>
* `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.

<br>
Expand Down Expand Up @@ -305,7 +307,7 @@ Find | `find KEYWORDS...`
Edit | `edit INDEX [NEW_NAME] [NEW_DATE] [NEW_START_TIME] [NEW_END_TIME]`
Delete | `delete INDEX...`
Done | `done INDEX...`
Save | `save FILEPATH`
Path | `path FILEPATH`
Undo | `undo`
Help | `help`
Clear | `clear`
Expand Down

0 comments on commit 9374877

Please sign in to comment.