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

Week 7 #11

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
44 changes: 44 additions & 0 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ Format: `find KEYWORD [MORE_KEYWORDS]`
* Persons matching at least one keyword will be returned (i.e. `OR` search). e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
****




Examples:

* `find John` +
Expand Down Expand Up @@ -145,6 +148,47 @@ Format: `clear`
Exits the program. +
Format: `exit`


=== Find event/module/deadline [keywords]: `find`
User able to find module which matches any of the given keywords.

- The search is case insensitive. e.g tutorial will match Tutorial
- The order of the keywords does not matter. e.g. 3 Tutorial will match Tutorial 3
- Names containing part of the searched words will be matched e.g. tut will match Tutorial 4

Format: `find m/MODULE_CODE`

Return registered modules that match module

Format: `find d/Deadline`

Return matched deadline

=== Finishing a task : `done`
If the user is currently not viewing an event or is not viewing the event of interest, the following format will be used:
and bring the closest event to focus e.g. Tutorial 4 happening on Week 6, where the UI will prompt the user: “Which deadline do you wish to complete?”

Format: `done m/MODULE_CODE n/EVENT_NAME`

The following command can then be used (or be used instantly should the user already be viewing the event of interest):
and complete the first deadline on the list of deadlines for that event.

Format: `done 1`

=== Export: `export`
User could export all the module, event, and deadlines as a .ics file.

Format: `export [s/START_DATE] [e/END_DATE] [d/TARGET_DIRECTORY] f/FILENAME`










=== Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data. +
Expand Down